blob: 49149ccf22f83b78a37221322d0ea77d9df2dbd1 [file] [log] [blame]
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001*options.txt* For Vim version 7.3. Last change: 2010 Nov 16
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 Moolenaar293ee4d2004-12-09 21:34:53 +0000153The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
154security reasons.
155
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000157at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158"set all" probably does not fit on the screen, causing Vim to give the
159|more-prompt|.
160
161 *option-backslash*
162To include white space in a string option value it has to be preceded with a
163backslash. To include a backslash you have to use two. Effectively this
164means that the number of backslashes in an option value is halved (rounded
165down).
166A few examples: >
167 :set tags=tags\ /usr/tags results in "tags /usr/tags"
168 :set tags=tags\\,file results in "tags\,file"
169 :set tags=tags\\\ file results in "tags\ file"
170
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000171The "|" character separates a ":set" command from a following command. To
172include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173'titlestring' option to "hi|there": >
174 :set titlestring=hi\|there
175This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
176 :set titlestring=hi|set iconstring=there
177
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000178Similarly, the double quote character starts a comment. To include the '"' in
179the option value, use '\"' instead. This example sets the 'titlestring'
180option to 'hi "there"': >
181 :set titlestring=hi\ \"there\"
182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000183For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184precise: For options that expect a file name (those where environment
185variables are expanded) a backslash before a normal file name character is not
186removed. But a backslash before a special character (space, backslash, comma,
187etc.) is used like explained above.
188There is one special situation, when the value starts with "\\": >
189 :set dir=\\machine\path results in "\\machine\path"
190 :set dir=\\\\machine\\path results in "\\machine\path"
191 :set dir=\\path\\file results in "\\path\file" (wrong!)
192For the first one the start is kept, but for the second one the backslashes
193are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000194halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195result which is probably not what you want. Avoid it.
196
197 *add-option-flags* *remove-option-flags*
198 *E539* *E550* *E551* *E552*
199Some options are a list of flags. When you want to add a flag to such an
200option, without changing the existing ones, you can do it like this: >
201 :set guioptions+=a
202Remove a flag from an option like this: >
203 :set guioptions-=a
204This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000205Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
207doesn't appear.
208
209 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000210Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211environment variable exists the '$' and the following environment variable
212name is replaced with its value. If it does not exist the '$' and the name
213are not modified. Any non-id character (not a letter, digit or '_') may
214follow the environment variable name. That character and what follows is
215appended to the value of the environment variable. Examples: >
216 :set term=$TERM.new
217 :set path=/usr/$INCLUDE,$HOME/include,.
218When adding or removing a string from an option with ":set opt-=val" or ":set
219opt+=val" the expansion is done before the adding or removing.
220
221
222Handling of local options *local-options*
223
224Some of the options only apply to a window or buffer. Each window or buffer
225has its own copy of this option, thus can each have their own value. This
226allows you to set 'list' in one window but not in another. And set
227'shiftwidth' to 3 in one buffer and 4 in another.
228
229The following explains what happens to these local options in specific
230situations. You don't really need to know all of this, since Vim mostly uses
231the option values you would expect. Unfortunately, doing what the user
232expects is a bit complicated...
233
234When splitting a window, the local options are copied to the new window. Thus
235right after the split the contents of the two windows look the same.
236
237When editing a new buffer, its local option values must be initialized. Since
238the local options of the current buffer might be specifically for that buffer,
239these are not used. Instead, for each buffer-local option there also is a
240global value, which is used for new buffers. With ":set" both the local and
241global value is changed. With "setlocal" only the local value is changed,
242thus this value is not used when editing a new buffer.
243
244When editing a buffer that has been edited before, the last used window
245options are used again. If this buffer has been edited in this window, the
246values from back then are used. Otherwise the values from the window where
247the buffer was edited last are used.
248
249It's possible to set a local window option specifically for a type of buffer.
250When you edit another buffer in the same window, you don't want to keep
251using these local window options. Therefore Vim keeps a global value of the
252local window options, which is used when editing another buffer. Each window
253has its own copy of these values. Thus these are local to the window, but
254global to all buffers in the window. With this you can do: >
255 :e one
256 :set list
257 :e two
258Now the 'list' option will also be set in "two", since with the ":set list"
259command you have also set the global value. >
260 :set nolist
261 :e one
262 :setlocal list
263 :e two
264Now the 'list' option is not set, because ":set nolist" resets the global
265value, ":setlocal list" only changes the local value and ":e two" gets the
266global value. Note that if you do this next: >
267 :e one
268You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000269"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270
271 *:setl* *:setlocal*
272:setl[ocal] ... Like ":set" but set only the value local to the
273 current buffer or window. Not all options have a
274 local value. If the option does not have a local
275 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200276 With the "all" argument: display local values for all
277 local options.
278 Without argument: Display local values for all local
279 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000281 local value. For a global/local boolean option, when
282 the global value is being used, "--" is displayed
283 before the option name.
284 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285 shown (but that might change in the future).
286 {not in Vi}
287
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000288:setl[ocal] {option}< Set the local value of {option} to its global value by
289 copying the value.
290 {not in Vi}
291
292:se[t] {option}< Set the local value of {option} to its global value by
293 making it empty. Only makes sense for |global-local|
294 options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 {not in Vi}
296
297 *:setg* *:setglobal*
298:setg[lobal] ... Like ":set" but set only the global value for a local
299 option without changing the local value.
300 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200301 With the "all" argument: display global values for all
302 local options.
303 Without argument: display global values for all local
304 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000305 {not in Vi}
306
307For buffer-local and window-local options:
308 Command global value local value ~
309 :set option=value set set
310 :setlocal option=value - set
311:setglobal option=value set -
312 :set option? - display
313 :setlocal option? - display
314:setglobal option? display -
315
316
317Global options with a local value *global-local*
318
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000319Options are global when you mostly use one value for all buffers and windows.
320For some global options it's useful to sometimes have a different local value.
321You can set the local value with ":setlocal". That buffer or window will then
322use the local value, while other buffers and windows continue using the global
323value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324
325For example, you have two windows, both on C source code. They use the global
326'makeprg' option. If you do this in one of the two windows: >
327 :set makeprg=gmake
328then the other window will switch to the same value. There is no need to set
329the 'makeprg' option in the other C source window too.
330However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000331another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000332files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333 :setlocal makeprg=perlmake
334You can switch back to using the global value by making the local value empty: >
335 :setlocal makeprg=
336This only works for a string option. For a boolean option you need to use the
337"<" flag, like this: >
338 :setlocal autoread<
339Note that for non-boolean options using "<" copies the global value to the
340local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000341when the global value changes later). You can also use: >
342 :set path<
343This will make the local value of 'path' empty, so that the global value is
344used. Thus it does the same as: >
345 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346Note: In the future more global options can be made global-local. Using
347":setlocal" on a global option might work differently then.
348
349
350Setting the filetype
351
352:setf[iletype] {filetype} *:setf* *:setfiletype*
353 Set the 'filetype' option to {filetype}, but only if
354 not done yet in a sequence of (nested) autocommands.
355 This is short for: >
356 :if !did_filetype()
357 : setlocal filetype={filetype}
358 :endif
359< This command is used in a filetype.vim file to avoid
360 setting the 'filetype' option twice, causing different
361 settings and syntax files to be loaded.
362 {not in Vi}
363
364:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
365:opt[ions] Open a window for viewing and setting all options.
366 Options are grouped by function.
367 Offers short help for each option. Hit <CR> on the
368 short help to open a help window with more help for
369 the option.
370 Modify the value of the option and hit <CR> on the
371 "set" line to set the new value. For window and
372 buffer specific options, the last accessed window is
373 used to set the option value in, unless this is a help
374 window, in which case the window below help window is
375 used (skipping the option-window).
376 {not available when compiled without the |+eval| or
377 |+autocmd| features}
378
379 *$HOME*
380Using "~" is like using "$HOME", but it is only recognized at the start of an
381option and after a space or comma.
382
383On Unix systems "~user" can be used too. It is replaced by the home directory
384of user "user". Example: >
385 :set path=~mool/include,/usr/include,.
386
387On Unix systems the form "${HOME}" can be used too. The name between {} can
388contain non-id characters then. Note that if you want to use this for the
389"gf" command, you need to add the '{' and '}' characters to 'isfname'.
390
391NOTE: expanding environment variables and "~/" is only done with the ":set"
392command, not when assigning a value to an option with ":let".
393
394
395Note the maximum length of an expanded option is limited. How much depends on
396the system, mostly it is something like 256 or 1024 characters.
397
398 *:fix* *:fixdel*
399:fix[del] Set the value of 't_kD':
400 't_kb' is 't_kD' becomes ~
401 CTRL-? CTRL-H
402 not CTRL-? CTRL-?
403
404 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
405
406 If your delete key terminal code is wrong, but the
407 code for backspace is alright, you can put this in
408 your .vimrc: >
409 :fixdel
410< This works no matter what the actual code for
411 backspace is.
412
413 If the backspace key terminal code is wrong you can
414 use this: >
415 :if &term == "termname"
416 : set t_kb=^V<BS>
417 : fixdel
418 :endif
419< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000420 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421 with your terminal name.
422
423 If your <Delete> key sends a strange key sequence (not
424 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
425 :if &term == "termname"
426 : set t_kD=^V<Delete>
427 :endif
428< Where "^V" is CTRL-V and "<Delete>" is the delete key
429 (don't type eight characters!). Replace "termname"
430 with your terminal name.
431
432 *Linux-backspace*
433 Note about Linux: By default the backspace key
434 produces CTRL-?, which is wrong. You can fix it by
435 putting this line in your rc.local: >
436 echo "keycode 14 = BackSpace" | loadkeys
437<
438 *NetBSD-backspace*
439 Note about NetBSD: If your backspace doesn't produce
440 the right code, try this: >
441 xmodmap -e "keycode 22 = BackSpace"
442< If this works, add this in your .Xmodmap file: >
443 keysym 22 = BackSpace
444< You need to restart for this to take effect.
445
446==============================================================================
4472. Automatically setting options *auto-setting*
448
449Besides changing options with the ":set" command, there are three alternatives
450to set options automatically for one or more files:
451
4521. When starting Vim initializations are read from various places. See
453 |initialization|. Most of them are performed for all editing sessions,
454 and some of them depend on the directory where Vim is started.
455 You can create an initialization file with |:mkvimrc|, |:mkview| and
456 |:mksession|.
4572. If you start editing a new file, the automatic commands are executed.
458 This can be used to set options for files matching a particular pattern and
459 many other things. See |autocommand|.
4603. If you start editing a new file, and the 'modeline' option is on, a
461 number of lines at the beginning and end of the file are checked for
462 modelines. This is explained here.
463
464 *modeline* *vim:* *vi:* *ex:* *E520*
465There are two forms of modelines. The first form:
466 [text]{white}{vi:|vim:|ex:}[white]{options}
467
468[text] any text or empty
469{white} at least one blank character (<Space> or <Tab>)
470{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
471[white] optional white space
472{options} a list of option settings, separated with white space or ':',
473 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000474 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000476Example:
477 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478
479The second form (this is compatible with some versions of Vi):
480
481 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
482
483[text] any text or empty
484{white} at least one blank character (<Space> or <Tab>)
485{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
486[white] optional white space
487se[t] the string "set " or "se " (note the space)
488{options} a list of options, separated with white space, which is the
489 argument for a ":set" command
490: a colon
491[text] any text or empty
492
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000493Example:
494 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495
496The white space before {vi:|vim:|ex:} is required. This minimizes the chance
497that a normal word like "lex:" is caught. There is one exception: "vi:" and
498"vim:" can also be at the start of the line (for compatibility with version
4993.0). Using "ex:" at the start of the line will be ignored (this could be
500short for "example:").
501
502 *modeline-local*
503The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000504buffer and window that contain the file. Although it's possible to set global
505options from a modeline, this is unusual. If you have two windows open and
506the files in it set the same global option to a different value, the result
507depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000509When editing a file that was already loaded, only the window-local options
510from the modeline are used. Thus if you manually changed a buffer-local
511option after opening the file, it won't be changed if you edit the same buffer
512in another window. But window-local options will be set.
513
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514 *modeline-version*
515If the modeline is only to be used for some versions of Vim, the version
516number can be specified where "vim:" is used:
517 vim{vers}: version {vers} or later
518 vim<{vers}: version before {vers}
519 vim={vers}: version {vers}
520 vim>{vers}: version after {vers}
521{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000522For example, to use a modeline only for Vim 6.0 and later:
523 /* vim600: set foldmethod=marker: */ ~
524To use a modeline for Vim before version 5.7:
525 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526There can be no blanks between "vim" and the ":".
527
528
529The number of lines that are checked can be set with the 'modelines' option.
530If 'modeline' is off or 'modelines' is 0 no lines are checked.
531
532Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000533like:
534 /* vi:ts=4: */ ~
535will give an error message for the trailing "*/". This line is OK:
536 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538If an error is detected the rest of the line is skipped.
539
540If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000541backslash in front of the ':' will be removed. Example:
542 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543This sets the 'dir' option to "c:\tmp". Only a single backslash before the
544':' is removed. Thus to include "\:" you have to specify "\\:".
545
546No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000547might create a Trojan horse text file with modelines). And not all options
548can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000549|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000550causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
551are wrapped unexpectedly. So disable modelines before editing untrusted text.
552The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553
554Hint: If you would like to do something else than setting an option, you could
555define an autocommand that checks the file for a specific string. For
556example: >
557 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
558And define a function SetVar() that does something with the line containing
559"VAR".
560
561==============================================================================
5623. Options summary *option-summary*
563
564In the list below all the options are mentioned with their full name and with
565an abbreviation if there is one. Both forms may be used.
566
567In this document when a boolean option is "set" that means that ":set option"
568is entered. When an option is "reset", ":set nooption" is used.
569
570For some options there are two default values: The "Vim default", which is
571used when 'compatible' is not set, and the "Vi default", which is used when
572'compatible' is set.
573
574Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000575are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576different value in each window. For example the 'list' option can be set in
577one window and reset in another for the same text, giving both types of view
578at the same time. There are a few options that are specific to a certain
579file. These can have a different value for each file or buffer. For example
580the 'textwidth' option can be 78 for a normal text file and 0 for a C
581program.
582
583 global one option for all buffers and windows
584 local to window each window has its own copy of this option
585 local to buffer each buffer has its own copy of this option
586
587When creating a new window the option values from the currently active window
588are used as a default value for the window-specific options. For the
589buffer-specific options this depends on the 's' and 'S' flags in the
590'cpoptions' option. If 's' is included (which is the default) the values for
591buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000592first entered. If 'S' is present the options are copied each time the buffer
593is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594present, the options are copied from the currently active buffer when the
595buffer is created.
596
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000597Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000599Not all options are supported in all versions. This depends on the supported
600features and sometimes on the system. A remark about this is in curly braces
601below. When an option is not supported it may still be set without getting an
602error, this is called a hidden option. You can't get the value of a hidden
603option though, it is not stored.
604
605To test if option "foo" can be used with ":set" use something like this: >
606 if exists('&foo')
607This also returns true for a hidden option. To test if option "foo" is really
608supported use something like this: >
609 if exists('+foo')
610<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 *E355*
612A jump table for the options with a short description can be found at |Q_op|.
613
614 *'aleph'* *'al'* *aleph* *Aleph*
615'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
616 global
617 {not in Vi}
618 {only available when compiled with the |+rightleft|
619 feature}
620 The ASCII code for the first letter of the Hebrew alphabet. The
621 routine that maps the keyboard in Hebrew mode, both in Insert mode
622 (when hkmap is set) and on the command-line (when hitting CTRL-_)
623 outputs the Hebrew characters in the range [aleph..aleph+26].
624 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
625 See |rileft.txt|.
626
627 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
628'allowrevins' 'ari' boolean (default off)
629 global
630 {not in Vi}
631 {only available when compiled with the |+rightleft|
632 feature}
633 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
634 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
635 into reverse Insert mode, and don't know how to get out. See
636 'revins'.
637 NOTE: This option is reset when 'compatible' is set.
638
639 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
640'altkeymap' 'akm' boolean (default off)
641 global
642 {not in Vi}
643 {only available when compiled with the |+farsi|
644 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000645 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 the keyboard map between Farsi and English, when 'allowrevins' set.
647
Bram Moolenaar582fd852005-03-28 20:58:01 +0000648 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 is useful to start the Vim in native mode i.e. English (left-to-right
650 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000651 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
653 *'ambiwidth'* *'ambw'*
654'ambiwidth' 'ambw' string (default: "single")
655 global
656 {not in Vi}
657 {only available when compiled with the |+multi_byte|
658 feature}
659 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
660 Tells Vim what to do with characters with East Asian Width Class
661 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
662 letters, Cyrillic letters).
663
664 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000665 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 expected by most users.
667 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200668 *E834* *E835*
669 The value "double" cannot be used if 'listchars' or 'fillchars'
670 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000671
672 There are a number of CJK fonts for which the width of glyphs for
673 those characters are solely based on how many octets they take in
674 legacy/traditional CJK encodings. In those encodings, Euro,
675 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000676 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000678 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679 Vim is running inside a terminal (emulators) that uses a CJK font
680 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
681 this option should be set to "double" to match the width perceived
682 by Vim with the width of glyphs in the font. Perhaps it also has
683 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
684 when the system locale is set to one of CJK locales. See Unicode
685 Standard Annex #11 (http://www.unicode.org/reports/tr11).
686
687 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
688'antialias' 'anti' boolean (default: off)
689 global
690 {not in Vi}
691 {only available when compiled with GUI enabled
692 on Mac OS X}
693 This option only has an effect in the GUI version of Vim on Mac OS X
694 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
695 which can be easier to read at certain sizes on certain displays.
696 Setting this option can sometimes cause problems if 'guifont' is set
697 to its default (empty string).
698
699 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
700'autochdir' 'acd' boolean (default off)
701 global
702 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200703 {only available when compiled with it, use
704 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000705 When on, Vim will change the current working directory whenever you
706 open a file, switch buffers, delete a buffer or open/close a window.
707 It will change to the directory containing the file which was opened
708 or selected.
709 This option is provided for backward compatibility with the Vim
710 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000711 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712
713 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
714'arabic' 'arab' boolean (default off)
715 local to window
716 {not in Vi}
717 {only available when compiled with the |+arabic|
718 feature}
719 This option can be set to start editing Arabic text.
720 Setting this option will:
721 - Set the 'rightleft' option, unless 'termbidi' is set.
722 - Set the 'arabicshape' option, unless 'termbidi' is set.
723 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
724 between typing English and Arabic key mapping.
725 - Set the 'delcombine' option
726 Note that 'encoding' must be "utf-8" for working with Arabic text.
727
728 Resetting this option will:
729 - Reset the 'rightleft' option.
730 - Disable the use of 'keymap' (without changing its value).
731 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
732 option.
733 Also see |arabic.txt|.
734
735 *'arabicshape'* *'arshape'*
736 *'noarabicshape'* *'noarshape'*
737'arabicshape' 'arshape' boolean (default on)
738 global
739 {not in Vi}
740 {only available when compiled with the |+arabic|
741 feature}
742 When on and 'termbidi' is off, the required visual character
743 corrections that need to take place for displaying the Arabic language
744 take affect. Shaping, in essence, gets enabled; the term is a broad
745 one which encompasses:
746 a) the changing/morphing of characters based on their location
747 within a word (initial, medial, final and stand-alone).
748 b) the enabling of the ability to compose characters
749 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100750 When disabled the display shows each character's true stand-alone
751 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 Arabic is a complex language which requires other settings, for
753 further details see |arabic.txt|.
754
755 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
756'autoindent' 'ai' boolean (default off)
757 local to buffer
758 Copy indent from current line when starting a new line (typing <CR>
759 in Insert mode or when using the "o" or "O" command). If you do not
760 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000761 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
762 to another line has the same effect, unless the 'I' flag is included
763 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000764 When autoindent is on, formatting (with the "gq" command or when you
765 reach 'textwidth' in Insert mode) uses the indentation of the first
766 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 When 'smartindent' or 'cindent' is on the indent is changed in
768 a different way.
769 The 'autoindent' option is reset when the 'paste' option is set.
770 {small difference from Vi: After the indent is deleted when typing
771 <Esc> or <CR>, the cursor position when moving up or down is after the
772 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
773
774 *'autoread'* *'ar'* *'noautoread'* *'noar'*
775'autoread' 'ar' boolean (default off)
776 global or local to buffer |global-local|
777 {not in Vi}
778 When a file has been detected to have been changed outside of Vim and
779 it has not been changed inside of Vim, automatically read it again.
780 When the file has been deleted this is not done. |timestamp|
781 If this option has a local value, use this command to switch back to
782 using the global value: >
783 :set autoread<
784<
785 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
786'autowrite' 'aw' boolean (default off)
787 global
788 Write the contents of the file, if it has been modified, on each
789 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000790 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
792 Note that for some commands the 'autowrite' option is not used, see
793 'autowriteall' for that.
794
795 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
796'autowriteall' 'awa' boolean (default off)
797 global
798 {not in Vi}
799 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
800 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
801 Setting this option also implies that Vim behaves like 'autowrite' has
802 been set.
803
804 *'background'* *'bg'*
805'background' 'bg' string (default "dark" or "light")
806 global
807 {not in Vi}
808 When set to "dark", Vim will try to use colors that look good on a
809 dark background. When set to "light", Vim will try to use colors that
810 look good on a light background. Any other value is illegal.
811 Vim tries to set the default value according to the terminal used.
812 This will not always be correct.
813 Setting this option does not change the background color, it tells Vim
814 what the background color looks like. For changing the background
815 color, see |:hi-normal|.
816
817 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000818 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000819 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100820 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821 setting 'background' will cause the color scheme to be reloaded. If
822 the color scheme adjusts to the value of 'background' this will work.
823 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100824 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
826 When setting 'background' to the default value with: >
827 :set background&
828< Vim will guess the value. In the GUI this should work correctly,
829 in other cases Vim might not be able to guess the right value.
830
831 When starting the GUI, the default value for 'background' will be
832 "light". When the value is not set in the .gvimrc, and Vim detects
833 that the background is actually quite dark, 'background' is set to
834 "dark". But this happens only AFTER the .gvimrc file has been read
835 (because the window needs to be opened to find the actual background
836 color). To get around this, force the GUI window to be opened by
837 putting a ":gui" command in the .gvimrc file, before where the value
838 of 'background' is used (e.g., before ":syntax on").
839 Normally this option would be set in the .vimrc file. Possibly
840 depending on the terminal name. Example: >
841 :if &term == "pcterm"
842 : set background=dark
843 :endif
844< When this option is set, the default settings for the highlight groups
845 will change. To use other settings, place ":highlight" commands AFTER
846 the setting of the 'background' option.
847 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
848 to select the colors for syntax highlighting. After changing this
849 option, you must load syntax.vim again to see the result. This can be
850 done with ":syntax on".
851
852 *'backspace'* *'bs'*
853'backspace' 'bs' string (default "")
854 global
855 {not in Vi}
856 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
857 mode. This is a list of items, separated by commas. Each item allows
858 a way to backspace over something:
859 value effect ~
860 indent allow backspacing over autoindent
861 eol allow backspacing over line breaks (join lines)
862 start allow backspacing over the start of insert; CTRL-W and CTRL-U
863 stop once at the start of insert.
864
865 When the value is empty, Vi compatible backspacing is used.
866
867 For backwards compatibility with version 5.4 and earlier:
868 value effect ~
869 0 same as ":set backspace=" (Vi compatible)
870 1 same as ":set backspace=indent,eol"
871 2 same as ":set backspace=indent,eol,start"
872
873 See |:fixdel| if your <BS> or <Del> key does not do what you want.
874 NOTE: This option is set to "" when 'compatible' is set.
875
876 *'backup'* *'bk'* *'nobackup'* *'nobk'*
877'backup' 'bk' boolean (default off)
878 global
879 {not in Vi}
880 Make a backup before overwriting a file. Leave it around after the
881 file has been successfully written. If you do not want to keep the
882 backup file, but you do want a backup while the file is being
883 written, reset this option and set the 'writebackup' option (this is
884 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000885 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886 |backup-table| for more explanations.
887 When the 'backupskip' pattern matches, a backup is not made anyway.
888 When 'patchmode' is set, the backup may be renamed to become the
889 oldest version of a file.
890 NOTE: This option is reset when 'compatible' is set.
891
892 *'backupcopy'* *'bkc'*
893'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
894 global
895 {not in Vi}
896 When writing a file and a backup is made, this option tells how it's
897 done. This is a comma separated list of words.
898
899 The main values are:
900 "yes" make a copy of the file and overwrite the original one
901 "no" rename the file and write a new one
902 "auto" one of the previous, what works best
903
904 Extra values that can be combined with the ones above are:
905 "breaksymlink" always break symlinks when writing
906 "breakhardlink" always break hardlinks when writing
907
908 Making a copy and overwriting the original file:
909 - Takes extra time to copy the file.
910 + When the file has special attributes, is a (hard/symbolic) link or
911 has a resource fork, all this is preserved.
912 - When the file is a link the backup will have the name of the link,
913 not of the real file.
914
915 Renaming the file and writing a new one:
916 + It's fast.
917 - Sometimes not all attributes of the file can be copied to the new
918 file.
919 - When the file is a link the new file will not be a link.
920
921 The "auto" value is the middle way: When Vim sees that renaming file
922 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000923 the file is not a link) that is used. When problems are expected, a
924 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925
926 The "breaksymlink" and "breakhardlink" values can be used in
927 combination with any of "yes", "no" and "auto". When included, they
928 force Vim to always break either symbolic or hard links by doing
929 exactly what the "no" option does, renaming the original file to
930 become the backup and writing a new file in its place. This can be
931 useful for example in source trees where all the files are symbolic or
932 hard links and any changes should stay in the local source tree, not
933 be propagated back to the original source.
934 *crontab*
935 One situation where "no" and "auto" will cause problems: A program
936 that opens a file, invokes Vim to edit that file, and then tests if
937 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000938 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 example.
940
941 When a copy is made, the original file is truncated and then filled
942 with the new text. This means that protection bits, owner and
943 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000944 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945 group of the backup is set to the group of the original file. If this
946 fails, the protection bits for the group are made the same as for
947 others.
948
949 When the file is renamed this is the other way around: The backup has
950 the same attributes of the original file, and the newly written file
951 is owned by the current user. When the file was a (hard/symbolic)
952 link, the new file will not! That's why the "auto" value doesn't
953 rename when the file is a link. The owner and group of the newly
954 written file will be set to the same ones as the original file, but
955 the system may refuse to do this. In that case the "auto" value will
956 again not rename the file.
957
958 *'backupdir'* *'bdir'*
959'backupdir' 'bdir' string (default for Amiga: ".,t:",
960 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
961 for Unix: ".,~/tmp,~/")
962 global
963 {not in Vi}
964 List of directories for the backup file, separated with commas.
965 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100966 where this is possible. The directory must exist, Vim will not
967 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968 - Empty means that no backup file will be created ('patchmode' is
969 impossible!). Writing may fail because of this.
970 - A directory "." means to put the backup file in the same directory
971 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000972 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000973 put the backup file relative to where the edited file is. The
974 leading "." is replaced with the path name of the edited file.
975 ("." inside a directory name has no special meaning).
976 - Spaces after the comma are ignored, other spaces are considered part
977 of the directory name. To have a space at the start of a directory
978 name, precede it with a backslash.
979 - To include a comma in a directory name precede it with a backslash.
980 - A directory name may end in an '/'.
981 - Environment variables are expanded |:set_env|.
982 - Careful with '\' characters, type one before a space, type two to
983 get one in the option (see |option-backslash|), for example: >
984 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
985< - For backwards compatibility with Vim version 3.0 a '>' at the start
986 of the option is removed.
987 See also 'backup' and 'writebackup' options.
988 If you want to hide your backup files on Unix, consider this value: >
989 :set backupdir=./.backup,~/.backup,.,/tmp
990< You must create a ".backup" directory in each directory and in your
991 home directory for this to work properly.
992 The use of |:set+=| and |:set-=| is preferred when adding or removing
993 directories from the list. This avoids problems when a future version
994 uses another default.
995 This option cannot be set from a |modeline| or in the |sandbox|, for
996 security reasons.
997
998 *'backupext'* *'bex'* *E589*
999'backupext' 'bex' string (default "~", for VMS: "_")
1000 global
1001 {not in Vi}
1002 String which is appended to a file name to make the name of the
1003 backup file. The default is quite unusual, because this avoids
1004 accidentally overwriting existing files with a backup file. You might
1005 prefer using ".bak", but make sure that you don't have files with
1006 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001007 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001009 If you like to keep a lot of backups, you could use a BufWritePre
1010 autocommand to change 'backupext' just before writing the file to
1011 include a timestamp. >
1012 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1013< Use 'backupdir' to put the backup in a different directory.
1014
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015 *'backupskip'* *'bsk'*
1016'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1017 global
1018 {not in Vi}
1019 {not available when compiled without the |+wildignore|
1020 feature}
1021 A list of file patterns. When one of the patterns matches with the
1022 name of the file which is written, no backup file is created. Both
1023 the specified file name and the full path name of the file are used.
1024 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1025 Watch out for special characters, see |option-backslash|.
1026 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001027 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001028
1029 Note that environment variables are not expanded. If you want to use
1030 $HOME you must expand it explicitly, e.g.: >
1031 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1032
1033< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001034 backup would be made by renaming the original file crontab won't see
1035 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036
1037 *'balloondelay'* *'bdlay'*
1038'balloondelay' 'bdlay' number (default: 600)
1039 global
1040 {not in Vi}
1041 {only available when compiled with the |+balloon_eval|
1042 feature}
1043 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1044
1045 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1046'ballooneval' 'beval' boolean (default off)
1047 global
1048 {not in Vi}
1049 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001050 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051 Switch on the |balloon-eval| functionality.
1052
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001053 *'balloonexpr'* *'bexpr'*
1054'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001055 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001056 {not in Vi}
1057 {only available when compiled with the |+balloon_eval|
1058 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001059 Expression for text to show in evaluation balloon. It is only used
1060 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001061
1062 v:beval_bufnr number of the buffer in which balloon is going to show
1063 v:beval_winnr number of the window
1064 v:beval_lnum line number
1065 v:beval_col column number (byte index)
1066 v:beval_text word under or after the mouse pointer
1067
1068 The evaluation of the expression must not have side effects!
1069 Example: >
1070 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001071 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001072 \', column ' . v:beval_col .
1073 \ ' of file ' . bufname(v:beval_bufnr) .
1074 \ ' on word "' . v:beval_text . '"'
1075 endfunction
1076 set bexpr=MyBalloonExpr()
1077 set ballooneval
1078<
1079 NOTE: The balloon is displayed only if the cursor is on a text
1080 character. If the result of evaluating 'balloonexpr' is not empty,
1081 Vim does not try to send a message to an external debugger (Netbeans
1082 or Sun Workshop).
1083
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001084 The expression may be evaluated in the |sandbox|, see
1085 |sandbox-option|.
1086
1087 It is not allowed to change text or jump to another window while
1088 evaluating 'balloonexpr' |textlock|.
1089
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001090 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001091 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001092< When they are supported "\n" characters will start a new line. If the
1093 expression evaluates to a |List| this is equal to using each List item
1094 as a string and putting "\n" in between them.
1095
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1097'binary' 'bin' boolean (default off)
1098 local to buffer
1099 {not in Vi}
1100 This option should be set before editing a binary file. You can also
1101 use the |-b| Vim argument. When this option is switched on a few
1102 options will be changed (also when it already was on):
1103 'textwidth' will be set to 0
1104 'wrapmargin' will be set to 0
1105 'modeline' will be off
1106 'expandtab' will be off
1107 Also, 'fileformat' and 'fileformats' options will not be used, the
1108 file is read and written like 'fileformat' was "unix" (a single <NL>
1109 separates lines).
1110 The 'fileencoding' and 'fileencodings' options will not be used, the
1111 file is read without conversion.
1112 NOTE: When you start editing a(nother) file while the 'bin' option is
1113 on, settings from autocommands may change the settings again (e.g.,
1114 'textwidth'), causing trouble when editing. You might want to set
1115 'bin' again when the file has been loaded.
1116 The previous values of these options are remembered and restored when
1117 'bin' is switched from on to off. Each buffer has its own set of
1118 saved option values.
1119 To edit a file with 'binary' set you can use the |++bin| argument.
1120 This avoids you have to do ":set bin", which would have effect for all
1121 files you edit.
1122 When writing a file the <EOL> for the last line is only written if
1123 there was one in the original file (normally Vim appends an <EOL> to
1124 the last line if there is none; this would make the file longer). See
1125 the 'endofline' option.
1126
1127 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1128'bioskey' 'biosk' boolean (default on)
1129 global
1130 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001131 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132 better to detect CTRL-C, but only works for the console. When using a
1133 terminal over a serial port reset this option.
1134 Also see |'conskey'|.
1135
1136 *'bomb'* *'nobomb'*
1137'bomb' boolean (default off)
1138 local to buffer
1139 {not in Vi}
1140 {only available when compiled with the |+multi_byte|
1141 feature}
1142 When writing a file and the following conditions are met, a BOM (Byte
1143 Order Mark) is prepended to the file:
1144 - this option is on
1145 - the 'binary' option is off
1146 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1147 endian variants.
1148 Some applications use the BOM to recognize the encoding of the file.
1149 Often used for UCS-2 files on MS-Windows. For other applications it
1150 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001151 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1153 check for the presence of the BOM is done and 'bomb' set accordingly.
1154 Unless 'binary' is set, it is removed from the first line, so that you
1155 don't see it when editing. When you don't change the options, the BOM
1156 will be restored when writing the file.
1157
1158 *'breakat'* *'brk'*
1159'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1160 global
1161 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001162 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 feature}
1164 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001165 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1166 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167
1168 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001169'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001171 {not in Vi} {only for Motif, Athena, GTK, Mac and
1172 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001174 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001175 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176 buffer Use the directory of the related buffer.
1177 current Use the current directory.
1178 {path} Use the specified directory
1179
1180 *'bufhidden'* *'bh'*
1181'bufhidden' 'bh' string (default: "")
1182 local to buffer
1183 {not in Vi}
1184 {not available when compiled without the |+quickfix|
1185 feature}
1186 This option specifies what happens when a buffer is no longer
1187 displayed in a window:
1188 <empty> follow the global 'hidden' option
1189 hide hide the buffer (don't unload it), also when 'hidden'
1190 is not set
1191 unload unload the buffer, also when 'hidden' is set or using
1192 |:hide|
1193 delete delete the buffer from the buffer list, also when
1194 'hidden' is set or using |:hide|, like using
1195 |:bdelete|
1196 wipe wipe out the buffer from the buffer list, also when
1197 'hidden' is set or using |:hide|, like using
1198 |:bwipeout|
1199
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001200 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1201 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202 This option is used together with 'buftype' and 'swapfile' to specify
1203 special kinds of buffers. See |special-buffers|.
1204
1205 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1206'buflisted' 'bl' boolean (default: on)
1207 local to buffer
1208 {not in Vi}
1209 When this option is set, the buffer shows up in the buffer list. If
1210 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1211 This option is reset by Vim for buffers that are only used to remember
1212 a file name or marks. Vim sets it when starting to edit a buffer.
1213 But not when moving to a buffer with ":buffer".
1214
1215 *'buftype'* *'bt'* *E382*
1216'buftype' 'bt' string (default: "")
1217 local to buffer
1218 {not in Vi}
1219 {not available when compiled without the |+quickfix|
1220 feature}
1221 The value of this option specifies the type of a buffer:
1222 <empty> normal buffer
1223 nofile buffer which is not related to a file and will not be
1224 written
1225 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001226 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001227 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001228 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001230 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231 help help buffer (you are not supposed to set this
1232 manually)
1233
1234 This option is used together with 'bufhidden' and 'swapfile' to
1235 specify special kinds of buffers. See |special-buffers|.
1236
1237 Be careful with changing this option, it can have many side effects!
1238
Bram Moolenaar280f1262006-01-30 00:14:18 +00001239 A "quickfix" buffer is only used for the error list and the location
1240 list. This value is set by the |:cwindow| and |:lwindow| commands and
1241 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242
1243 "nofile" and "nowrite" buffers are similar:
1244 both: The buffer is not to be written to disk, ":w" doesn't
1245 work (":w filename" does work though).
1246 both: The buffer is never considered to be |'modified'|.
1247 There is no warning when the changes will be lost, for
1248 example when you quit Vim.
1249 both: A swap file is only created when using too much memory
1250 (when 'swapfile' has been reset there is never a swap
1251 file).
1252 nofile only: The buffer name is fixed, it is not handled like a
1253 file name. It is not modified in response to a |:cd|
1254 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001255 *E676*
1256 "acwrite" implies that the buffer name is not related to a file, like
1257 "nofile", but it will be written. Thus, in contrast to "nofile" and
1258 "nowrite", ":w" does work and a modified buffer can't be abandoned
1259 without saving. For writing there must be matching |BufWriteCmd|,
1260 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261
1262 *'casemap'* *'cmp'*
1263'casemap' 'cmp' string (default: "internal,keepascii")
1264 global
1265 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001266 {only available when compiled with the |+multi_byte|
1267 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268 Specifies details about changing the case of letters. It may contain
1269 these words, separated by a comma:
1270 internal Use internal case mapping functions, the current
1271 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001272 matters when 'encoding' is a Unicode encoding,
1273 "latin1" or "iso-8859-15". When "internal" is
1274 omitted, the towupper() and towlower() system library
1275 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1277 case mapping, the current locale is not effective.
1278 This probably only matters for Turkish.
1279
1280 *'cdpath'* *'cd'* *E344* *E346*
1281'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1282 global
1283 {not in Vi}
1284 {not available when compiled without the
1285 |+file_in_path| feature}
1286 This is a list of directories which will be searched when using the
1287 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001288 for has a relative path, not an absolute part starting with "/", "./"
1289 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 The 'cdpath' option's value has the same form and semantics as
1291 |'path'|. Also see |file-searching|.
1292 The default value is taken from $CDPATH, with a "," prepended to look
1293 in the current directory first.
1294 If the default value taken from $CDPATH is not what you want, include
1295 a modified version of the following command in your vimrc file to
1296 override it: >
1297 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1298< This option cannot be set from a |modeline| or in the |sandbox|, for
1299 security reasons.
1300 (parts of 'cdpath' can be passed to the shell to expand file names).
1301
1302 *'cedit'*
1303'cedit' string (Vi default: "", Vim default: CTRL-F)
1304 global
1305 {not in Vi}
1306 {not available when compiled without the |+vertsplit|
1307 feature}
1308 The key used in Command-line Mode to open the command-line window.
1309 The default is CTRL-F when 'compatible' is off.
1310 Only non-printable keys are allowed.
1311 The key can be specified as a single character, but it is difficult to
1312 type. The preferred way is to use the <> notation. Examples: >
1313 :set cedit=<C-Y>
1314 :set cedit=<Esc>
1315< |Nvi| also has this option, but it only uses the first character.
1316 See |cmdwin|.
1317
1318 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1319'charconvert' 'ccv' string (default "")
1320 global
1321 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001322 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 {not in Vi}
1324 An expression that is used for character encoding conversion. It is
1325 evaluated when a file that is to be read or has been written has a
1326 different encoding from what is desired.
1327 'charconvert' is not used when the internal iconv() function is
1328 supported and is able to do the conversion. Using iconv() is
1329 preferred, because it is much faster.
1330 'charconvert' is not used when reading stdin |--|, because there is no
1331 file to convert from. You will have to save the text in a file first.
1332 The expression must return zero or an empty string for success,
1333 non-zero for failure.
1334 The possible encoding names encountered are in 'encoding'.
1335 Additionally, names given in 'fileencodings' and 'fileencoding' are
1336 used.
1337 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1338 is done internally by Vim, 'charconvert' is not used for this.
1339 'charconvert' is also used to convert the viminfo file, if the 'c'
1340 flag is present in 'viminfo'. Also used for Unicode conversion.
1341 Example: >
1342 set charconvert=CharConvert()
1343 fun CharConvert()
1344 system("recode "
1345 \ . v:charconvert_from . ".." . v:charconvert_to
1346 \ . " <" . v:fname_in . " >" v:fname_out)
1347 return v:shell_error
1348 endfun
1349< The related Vim variables are:
1350 v:charconvert_from name of the current encoding
1351 v:charconvert_to name of the desired encoding
1352 v:fname_in name of the input file
1353 v:fname_out name of the output file
1354 Note that v:fname_in and v:fname_out will never be the same.
1355 Note that v:charconvert_from and v:charconvert_to may be different
1356 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1357 Encryption is not done by Vim when using 'charconvert'. If you want
1358 to encrypt the file after conversion, 'charconvert' should take care
1359 of this.
1360 This option cannot be set from a |modeline| or in the |sandbox|, for
1361 security reasons.
1362
1363 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1364'cindent' 'cin' boolean (default off)
1365 local to buffer
1366 {not in Vi}
1367 {not available when compiled without the |+cindent|
1368 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001369 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370 that trigger reindenting in insert mode and 'cinoptions' to set your
1371 preferred indent style.
1372 If 'indentexpr' is not empty, it overrules 'cindent'.
1373 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1374 the "=" operator indents using this algorithm rather than calling an
1375 external program.
1376 See |C-indenting|.
1377 When you don't like the way 'cindent' works, try the 'smartindent'
1378 option or 'indentexpr'.
1379 This option is not used when 'paste' is set.
1380 NOTE: This option is reset when 'compatible' is set.
1381
1382 *'cinkeys'* *'cink'*
1383'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1384 local to buffer
1385 {not in Vi}
1386 {not available when compiled without the |+cindent|
1387 feature}
1388 A list of keys that, when typed in Insert mode, cause reindenting of
1389 the current line. Only used if 'cindent' is on and 'indentexpr' is
1390 empty.
1391 For the format of this option see |cinkeys-format|.
1392 See |C-indenting|.
1393
1394 *'cinoptions'* *'cino'*
1395'cinoptions' 'cino' string (default "")
1396 local to buffer
1397 {not in Vi}
1398 {not available when compiled without the |+cindent|
1399 feature}
1400 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1401 program. See |cinoptions-values| for the values of this option, and
1402 |C-indenting| for info on C indenting in general.
1403
1404
1405 *'cinwords'* *'cinw'*
1406'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1407 local to buffer
1408 {not in Vi}
1409 {not available when compiled without both the
1410 |+cindent| and the |+smartindent| features}
1411 These keywords start an extra indent in the next line when
1412 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1413 an appropriate place (inside {}).
1414 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1415 matter, include the keyword both the uppercase and lowercase:
1416 "if,If,IF".
1417
1418 *'clipboard'* *'cb'*
1419'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1420 for X-windows, "" otherwise)
1421 global
1422 {not in Vi}
1423 {only in GUI versions or when the |+xterm_clipboard|
1424 feature is included}
1425 This option is a list of comma separated names.
1426 These names are recognized:
1427
1428 unnamed When included, Vim will use the clipboard register '*'
1429 for all yank, delete, change and put operations which
1430 would normally go to the unnamed register. When a
1431 register is explicitly specified, it will always be
1432 used regardless of whether "unnamed" is in 'clipboard'
1433 or not. The clipboard register can always be
1434 explicitly accessed using the "* notation. Also see
1435 |gui-clipboard|.
1436
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001437 unnamedplus A variant of "unnamed" flag which uses the clipboard
1438 register '+' (|quoteplus|) instead of register '*' for
1439 all operations except yank. Yank shall copy the text
1440 into register '+' and also into '*' when "unnamed" is
1441 included.
1442 Only available with the |+x11| feature.
1443 Availability can be checked with: >
1444 if has('unnamedplus')
1445<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446 autoselect Works like the 'a' flag in 'guioptions': If present,
1447 then whenever Visual mode is started, or the Visual
1448 area extended, Vim tries to become the owner of the
1449 windowing system's global selection or put the
1450 selected text on the clipboard used by the selection
1451 register "*. See |guioptions_a| and |quotestar| for
1452 details. When the GUI is active, the 'a' flag in
1453 'guioptions' is used, when the GUI is not active, this
1454 "autoselect" flag is used.
1455 Also applies to the modeless selection.
1456
1457 autoselectml Like "autoselect", but for the modeless selection
1458 only. Compare to the 'A' flag in 'guioptions'.
1459
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001460 html When the clipboard contains HTML, use this when
1461 pasting. When putting text on the clipboard, mark it
1462 as HTML. This works to copy rendered HTML from
1463 Firefox, paste it as raw HTML in Vim, select the HTML
1464 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001465 You probably want to add this only temporarily,
1466 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001467 Only supported for GTK version 2 and later.
1468 Only available with the |+multi_byte| feature.
1469
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470 exclude:{pattern}
1471 Defines a pattern that is matched against the name of
1472 the terminal 'term'. If there is a match, no
1473 connection will be made to the X server. This is
1474 useful in this situation:
1475 - Running Vim in a console.
1476 - $DISPLAY is set to start applications on another
1477 display.
1478 - You do not want to connect to the X server in the
1479 console, but do want this in a terminal emulator.
1480 To never connect to the X server use: >
1481 exclude:.*
1482< This has the same effect as using the |-X| argument.
1483 Note that when there is no connection to the X server
1484 the window title won't be restored and the clipboard
1485 cannot be accessed.
1486 The value of 'magic' is ignored, {pattern} is
1487 interpreted as if 'magic' was on.
1488 The rest of the option value will be used for
1489 {pattern}, this must be the last entry.
1490
1491 *'cmdheight'* *'ch'*
1492'cmdheight' 'ch' number (default 1)
1493 global
1494 {not in Vi}
1495 Number of screen lines to use for the command-line. Helps avoiding
1496 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001497 The value of this option is stored with the tab page, so that each tab
1498 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499
1500 *'cmdwinheight'* *'cwh'*
1501'cmdwinheight' 'cwh' number (default 7)
1502 global
1503 {not in Vi}
1504 {not available when compiled without the |+vertsplit|
1505 feature}
1506 Number of screen lines to use for the command-line window. |cmdwin|
1507
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001508 *'colorcolumn'* *'cc'*
1509'colorcolumn' 'cc' string (default "")
1510 local to window
1511 {not in Vi}
1512 {not available when compiled without the |+syntax|
1513 feature}
1514 'colorcolumn' is a comma separated list of screen columns that are
1515 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1516 text. Will make screen redrawing slower.
1517 The screen column can be an absolute number, or a number preceded with
1518 '+' or '-', which is added to or subtracted from 'textwidth'. >
1519
1520 :set cc=+1 " highlight column after 'textwidth'
1521 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1522 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1523<
1524 When 'textwidth' is zero then the items with '-' and '+' are not used.
1525 A maximum of 256 columns are highlighted.
1526
Bram Moolenaar071d4272004-06-13 20:20:40 +00001527 *'columns'* *'co'* *E594*
1528'columns' 'co' number (default 80 or terminal width)
1529 global
1530 {not in Vi}
1531 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001532 initialization and does not have to be set by hand. Also see
1533 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001534 When Vim is running in the GUI or in a resizable window, setting this
1535 option will cause the window size to be changed. When you only want
1536 to use the size for the GUI, put the command in your |gvimrc| file.
1537 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001538 number of columns of the display, the display may be messed up. For
1539 the GUI it is always possible and Vim limits the number of columns to
1540 what fits on the screen. You can use this command to get the widest
1541 window possible: >
1542 :set columns=9999
1543< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544
1545 *'comments'* *'com'* *E524* *E525*
1546'comments' 'com' string (default
1547 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1548 local to buffer
1549 {not in Vi}
1550 {not available when compiled without the |+comments|
1551 feature}
1552 A comma separated list of strings that can start a comment line. See
1553 |format-comments|. See |option-backslash| about using backslashes to
1554 insert a space.
1555
1556 *'commentstring'* *'cms'* *E537*
1557'commentstring' 'cms' string (default "/*%s*/")
1558 local to buffer
1559 {not in Vi}
1560 {not available when compiled without the |+folding|
1561 feature}
1562 A template for a comment. The "%s" in the value is replaced with the
1563 comment text. Currently only used to add markers for folding, see
1564 |fold-marker|.
1565
1566 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001567'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1568 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569 global
1570 {not in Vi}
1571 This option has the effect of making Vim either more Vi-compatible, or
1572 make Vim behave in a more useful way.
1573 This is a special kind of option, because when it's set or reset,
1574 other options are also changed as a side effect. CAREFUL: Setting or
1575 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001576 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577 set this option in your vimrc file, you should probably put it at the
1578 very start.
1579 By default this option is on and the Vi defaults are used for the
1580 options. This default was chosen for those people who want to use Vim
1581 just like Vi, and don't even (want to) know about the 'compatible'
1582 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001583 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001584 this option is switched off, and all options that have not been
1585 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001586 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001587 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001588 happen for the system-wide vimrc or gvimrc file, nor for a file given
1589 with the |-u| argument). Also see |compatible-default| and
1590 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591 You can also set this option with the "-C" argument, and reset it with
1592 "-N". See |-C| and |-N|.
1593 Switching this option off makes the Vim defaults be used for options
1594 that have a different Vi and Vim default value. See the options
1595 marked with a '+' below. Other options are not modified.
1596 At the moment this option is set, several other options will be set
1597 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001598 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 editing.
1600 See also 'cpoptions'.
1601
1602 option + set value effect ~
1603
1604 'allowrevins' off no CTRL-_ command
1605 'backupcopy' Unix: "yes" backup file is a copy
1606 others: "auto" copy or rename backup file
1607 'backspace' "" normal backspace
1608 'backup' off no backup file
1609 'cindent' off no C code indentation
1610 'cedit' + "" no key to open the |cmdwin|
1611 'cpoptions' + (all flags) Vi-compatible flags
1612 'cscopetag' off don't use cscope for ":tag"
1613 'cscopetagorder' 0 see |cscopetagorder|
1614 'cscopeverbose' off see |cscopeverbose|
1615 'digraph' off no digraphs
1616 'esckeys' + off no <Esc>-keys in Insert mode
1617 'expandtab' off tabs not expanded to spaces
1618 'fileformats' + "" no automatic file format detection,
1619 "dos,unix" except for DOS, Windows and OS/2
1620 'formatoptions' + "vt" Vi compatible formatting
1621 'gdefault' off no default 'g' flag for ":s"
1622 'history' + 0 no commandline history
1623 'hkmap' off no Hebrew keyboard mapping
1624 'hkmapp' off no phonetic Hebrew keyboard mapping
1625 'hlsearch' off no highlighting of search matches
1626 'incsearch' off no incremental searching
1627 'indentexpr' "" no indenting by expression
1628 'insertmode' off do not start in Insert mode
1629 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1630 characters and '_'
1631 'joinspaces' on insert 2 spaces after period
1632 'modeline' + off no modelines
1633 'more' + off no pauses in listings
1634 'revins' off no reverse insert
1635 'ruler' off no ruler
1636 'scrolljump' 1 no jump scroll
1637 'scrolloff' 0 no scroll offset
1638 'shiftround' off indent not rounded to shiftwidth
1639 'shortmess' + "" no shortening of messages
1640 'showcmd' + off command characters not shown
1641 'showmode' + off current mode not shown
1642 'smartcase' off no automatic ignore case switch
1643 'smartindent' off no smart indentation
1644 'smarttab' off no smart tab size
1645 'softtabstop' 0 tabs are always 'tabstop' positions
1646 'startofline' on goto startofline with some commands
1647 'tagrelative' + off tag file names are not relative
1648 'textauto' + off no automatic textmode detection
1649 'textwidth' 0 no automatic line wrap
1650 'tildeop' off tilde is not an operator
1651 'ttimeout' off no terminal timeout
1652 'whichwrap' + "" left-right movements don't wrap
1653 'wildchar' + CTRL-E only when the current value is <Tab>
1654 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001655 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656
1657 *'complete'* *'cpt'* *E535*
1658'complete' 'cpt' string (default: ".,w,b,u,t,i")
1659 local to buffer
1660 {not in Vi}
1661 This option specifies how keyword completion |ins-completion| works
1662 when CTRL-P or CTRL-N are used. It is also used for whole-line
1663 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1664 and the places to scan. It is a comma separated list of flags:
1665 . scan the current buffer ('wrapscan' is ignored)
1666 w scan buffers from other windows
1667 b scan other loaded buffers that are in the buffer list
1668 u scan the unloaded buffers that are in the buffer list
1669 U scan the buffers that are not in the buffer list
1670 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001671 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672 k{dict} scan the file {dict}. Several "k" flags can be given,
1673 patterns are valid too. For example: >
1674 :set cpt=k/usr/dict/*,k~/spanish
1675< s scan the files given with the 'thesaurus' option
1676 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1677 are valid too.
1678 i scan current and included files
1679 d scan current and included files for defined name or macro
1680 |i_CTRL-X_CTRL-D|
1681 ] tag completion
1682 t same as "]"
1683
1684 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1685 not executed, this may lead to unexpected completions from some files
1686 (gzipped files for example). Unloaded buffers are not scanned for
1687 whole-line completion.
1688
1689 The default is ".,w,b,u,t,i", which means to scan:
1690 1. the current buffer
1691 2. buffers in other windows
1692 3. other loaded buffers
1693 4. unloaded buffers
1694 5. tags
1695 6. included files
1696
1697 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001698 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1699 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001701 *'completefunc'* *'cfu'*
1702'completefunc' 'cfu' string (default: empty)
1703 local to buffer
1704 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001705 {not available when compiled without the |+eval|
1706 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001707 This option specifies a function to be used for Insert mode completion
1708 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001709 See |complete-functions| for an explanation of how the function is
1710 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001711 This option cannot be set from a |modeline| or in the |sandbox|, for
1712 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001713
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001714 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001715'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001716 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001717 {not available when compiled without the
1718 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001719 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001720 A comma separated list of options for Insert mode completion
1721 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001722
1723 menu Use a popup menu to show the possible completions. The
1724 menu is only shown when there is more than one match and
1725 sufficient colors are available. |ins-completion-menu|
1726
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001727 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001728 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001729 match, e.g., what file it comes from.
1730
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001731 longest Only insert the longest common text of the matches. If
1732 the menu is displayed you can use CTRL-L to add more
1733 characters. Whether case is ignored depends on the kind
1734 of completion. For buffer text the 'ignorecase' option is
1735 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001736
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001737 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001738 completion in the preview window. Only works in
1739 combination with "menu" or "menuone".
1740
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001741
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001742 *'concealcursor'* *'cocu'*
1743'concealcursor' 'cocu' string (default: "")
1744 local to window
1745 {not in Vi}
1746 {not available when compiled without the |+conceal|
1747 feature}
1748 Sets the modes in which text in the cursor line can also be concealed.
1749 When the current mode is listed then concealing happens just like in
1750 other lines.
1751 n Normal mode
1752 v Visual mode
1753 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001754 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001755
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001756 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001757 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001758 are moving around text is concealed, but when starting to insert text
1759 or selecting a Visual area the concealed text is displayed, so that
1760 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001761 Keep in mind that the cursor position is not always where it's
1762 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001763
1764
1765'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001766 number (default 0)
1767 local to window
1768 {not in Vi}
1769 {not available when compiled without the |+conceal|
1770 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001771 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1772 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001773
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001774 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001775 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001776 1 Each block of concealed text is replaced with one
1777 character. If the syntax item does not have a custom
1778 replacement character defined (see |:syn-cchar|) the
1779 character defined in 'listchars' is used (default is a
1780 space).
1781 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001782 2 Concealed text is completely hidden unless it has a
1783 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001784 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001785 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001786
Bram Moolenaara7781e02010-07-19 20:13:22 +02001787 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001788 edit and copy the text. This can be changed with the 'concealcursor'
1789 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001790
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1792'confirm' 'cf' boolean (default off)
1793 global
1794 {not in Vi}
1795 When 'confirm' is on, certain operations that would normally
1796 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1797 instead raise a |dialog| asking if you wish to save the current
1798 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1799 If 'confirm' is off you can still activate confirmation for one
1800 command only (this is most useful in mappings) with the |:confirm|
1801 command.
1802 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1803
1804 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1805'conskey' 'consk' boolean (default off)
1806 global
1807 {not in Vi} {only for MS-DOS}
1808 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001809 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810 three methods of console input are available:
1811 'conskey' 'bioskey' action ~
1812 on on or off direct console input
1813 off on BIOS
1814 off off STDIN
1815
1816 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1817'copyindent' 'ci' boolean (default off)
1818 local to buffer
1819 {not in Vi}
1820 Copy the structure of the existing lines indent when autoindenting a
1821 new line. Normally the new indent is reconstructed by a series of
1822 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1823 in which case only spaces are used). Enabling this option makes the
1824 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001825 existing line. 'expandtab' has no effect on these characters, a Tab
1826 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001827 line, the remaining space is filled in the normal manner.
1828 NOTE: 'copyindent' is reset when 'compatible' is set.
1829 Also see 'preserveindent'.
1830
1831 *'cpoptions'* *'cpo'*
1832'cpoptions' 'cpo' string (Vim default: "aABceFs",
1833 Vi default: all flags)
1834 global
1835 {not in Vi}
1836 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001837 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 not being vi-compatible is mostly or sometimes preferred.
1839 'cpoptions' stands for "compatible-options".
1840 Commas can be added for readability.
1841 To avoid problems with flags that are added in the future, use the
1842 "+=" and "-=" feature of ":set" |add-option-flags|.
1843 NOTE: This option is set to the Vi default value when 'compatible' is
1844 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001845 NOTE: This option is set to the POSIX default value at startup when
1846 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001847 variable exists |posix|. This means Vim tries to behave like the
1848 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849
1850 contains behavior ~
1851 *cpo-a*
1852 a When included, a ":read" command with a file name
1853 argument will set the alternate file name for the
1854 current window.
1855 *cpo-A*
1856 A When included, a ":write" command with a file name
1857 argument will set the alternate file name for the
1858 current window.
1859 *cpo-b*
1860 b "\|" in a ":map" command is recognized as the end of
1861 the map command. The '\' is included in the mapping,
1862 the text after the '|' is interpreted as the next
1863 command. Use a CTRL-V instead of a backslash to
1864 include the '|' in the mapping. Applies to all
1865 mapping, abbreviation, menu and autocmd commands.
1866 See also |map_bar|.
1867 *cpo-B*
1868 B A backslash has no special meaning in mappings,
1869 abbreviations and the "to" part of the menu commands.
1870 Remove this flag to be able to use a backslash like a
1871 CTRL-V. For example, the command ":map X \<Esc>"
1872 results in X being mapped to:
1873 'B' included: "\^[" (^[ is a real <Esc>)
1874 'B' excluded: "<Esc>" (5 characters)
1875 ('<' excluded in both cases)
1876 *cpo-c*
1877 c Searching continues at the end of any match at the
1878 cursor position, but not further than the start of the
1879 next line. When not present searching continues
1880 one character from the cursor position. With 'c'
1881 "abababababab" only gets three matches when repeating
1882 "/abab", without 'c' there are five matches.
1883 *cpo-C*
1884 C Do not concatenate sourced lines that start with a
1885 backslash. See |line-continuation|.
1886 *cpo-d*
1887 d Using "./" in the 'tags' option doesn't mean to use
1888 the tags file relative to the current file, but the
1889 tags file in the current directory.
1890 *cpo-D*
1891 D Can't use CTRL-K to enter a digraph after Normal mode
1892 commands with a character argument, like |r|, |f| and
1893 |t|.
1894 *cpo-e*
1895 e When executing a register with ":@r", always add a
1896 <CR> to the last line, also when the register is not
1897 linewise. If this flag is not present, the register
1898 is not linewise and the last line does not end in a
1899 <CR>, then the last line is put on the command-line
1900 and can be edited before hitting <CR>.
1901 *cpo-E*
1902 E It is an error when using "y", "d", "c", "g~", "gu" or
1903 "gU" on an Empty region. The operators only work when
1904 at least one character is to be operate on. Example:
1905 This makes "y0" fail in the first column.
1906 *cpo-f*
1907 f When included, a ":read" command with a file name
1908 argument will set the file name for the current buffer,
1909 if the current buffer doesn't have a file name yet.
1910 *cpo-F*
1911 F When included, a ":write" command with a file name
1912 argument will set the file name for the current
1913 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001914 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001915 *cpo-g*
1916 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001917 *cpo-H*
1918 H When using "I" on a line with only blanks, insert
1919 before the last blank. Without this flag insert after
1920 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001921 *cpo-i*
1922 i When included, interrupting the reading of a file will
1923 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001924 *cpo-I*
1925 I When moving the cursor up or down just after inserting
1926 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927 *cpo-j*
1928 j When joining lines, only add two spaces after a '.',
1929 not after '!' or '?'. Also see 'joinspaces'.
1930 *cpo-J*
1931 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001932 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 white space.
1934 *cpo-k*
1935 k Disable the recognition of raw key codes in
1936 mappings, abbreviations, and the "to" part of menu
1937 commands. For example, if <Key> sends ^[OA (where ^[
1938 is <Esc>), the command ":map X ^[OA" results in X
1939 being mapped to:
1940 'k' included: "^[OA" (3 characters)
1941 'k' excluded: "<Key>" (one key code)
1942 Also see the '<' flag below.
1943 *cpo-K*
1944 K Don't wait for a key code to complete when it is
1945 halfway a mapping. This breaks mapping <F1><F1> when
1946 only part of the second <F1> has been read. It
1947 enables cancelling the mapping by typing <F1><Esc>.
1948 *cpo-l*
1949 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001950 literally, only "\]", "\^", "\-" and "\\" are special.
1951 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1953 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001954 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955 *cpo-L*
1956 L When the 'list' option is set, 'wrapmargin',
1957 'textwidth', 'softtabstop' and Virtual Replace mode
1958 (see |gR|) count a <Tab> as two characters, instead of
1959 the normal behavior of a <Tab>.
1960 *cpo-m*
1961 m When included, a showmatch will always wait half a
1962 second. When not included, a showmatch will wait half
1963 a second or until a character is typed. |'showmatch'|
1964 *cpo-M*
1965 M When excluded, "%" matching will take backslashes into
1966 account. Thus in "( \( )" and "\( ( \)" the outer
1967 parenthesis match. When included "%" ignores
1968 backslashes, which is Vi compatible.
1969 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001970 n When included, the column used for 'number' and
1971 'relativenumber' will also be used for text of wrapped
1972 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973 *cpo-o*
1974 o Line offset to search command is not remembered for
1975 next search.
1976 *cpo-O*
1977 O Don't complain if a file is being overwritten, even
1978 when it didn't exist when editing it. This is a
1979 protection against a file unexpectedly created by
1980 someone else. Vi didn't complain about this.
1981 *cpo-p*
1982 p Vi compatible Lisp indenting. When not present, a
1983 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001984 *cpo-P*
1985 P When included, a ":write" command that appends to a
1986 file will set the file name for the current buffer, if
1987 the current buffer doesn't have a file name yet and
1988 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001989 *cpo-q*
1990 q When joining multiple lines leave the cursor at the
1991 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992 *cpo-r*
1993 r Redo ("." command) uses "/" to repeat a search
1994 command, instead of the actually used search string.
1995 *cpo-R*
1996 R Remove marks from filtered lines. Without this flag
1997 marks are kept like |:keepmarks| was used.
1998 *cpo-s*
1999 s Set buffer options when entering the buffer for the
2000 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002001 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002 set when the buffer is created.
2003 *cpo-S*
2004 S Set buffer options always when entering a buffer
2005 (except 'readonly', 'fileformat', 'filetype' and
2006 'syntax'). This is the (most) Vi compatible setting.
2007 The options are set to the values in the current
2008 buffer. When you change an option and go to another
2009 buffer, the value is copied. Effectively makes the
2010 buffer options global to all buffers.
2011
2012 's' 'S' copy buffer options
2013 no no when buffer created
2014 yes no when buffer first entered (default)
2015 X yes each time when buffer entered (vi comp.)
2016 *cpo-t*
2017 t Search pattern for the tag command is remembered for
2018 "n" command. Otherwise Vim only puts the pattern in
2019 the history for search pattern, but doesn't change the
2020 last used search pattern.
2021 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002022 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 *cpo-v*
2024 v Backspaced characters remain visible on the screen in
2025 Insert mode. Without this flag the characters are
2026 erased from the screen right away. With this flag the
2027 screen newly typed text overwrites backspaced
2028 characters.
2029 *cpo-w*
2030 w When using "cw" on a blank character, only change one
2031 character and not all blanks until the start of the
2032 next word.
2033 *cpo-W*
2034 W Don't overwrite a readonly file. When omitted, ":w!"
2035 overwrites a readonly file, if possible.
2036 *cpo-x*
2037 x <Esc> on the command-line executes the command-line.
2038 The default in Vim is to abandon the command-line,
2039 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002040 *cpo-X*
2041 X When using a count with "R" the replaced text is
2042 deleted only once. Also when repeating "R" with "."
2043 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 *cpo-y*
2045 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002046 *cpo-Z*
2047 Z When using "w!" while the 'readonly' option is set,
2048 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 *cpo-!*
2050 ! When redoing a filter command, use the last used
2051 external command, whatever it was. Otherwise the last
2052 used -filter- command is used.
2053 *cpo-$*
2054 $ When making a change to one line, don't redisplay the
2055 line, but put a '$' at the end of the changed text.
2056 The changed text will be overwritten when you type the
2057 new text. The line is redisplayed if you type any
2058 command that moves the cursor from the insertion
2059 point.
2060 *cpo-%*
2061 % Vi-compatible matching is done for the "%" command.
2062 Does not recognize "#if", "#endif", etc.
2063 Does not recognize "/*" and "*/".
2064 Parens inside single and double quotes are also
2065 counted, causing a string that contains a paren to
2066 disturb the matching. For example, in a line like
2067 "if (strcmp("foo(", s))" the first paren does not
2068 match the last one. When this flag is not included,
2069 parens inside single and double quotes are treated
2070 specially. When matching a paren outside of quotes,
2071 everything inside quotes is ignored. When matching a
2072 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002073 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002074 This flag is also used for other features, such as
2075 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002076 *cpo--*
2077 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002078 it would go above the first line or below the last
2079 line. Without it the cursor moves to the first or
2080 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002081 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002082 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002083 *cpo-+*
2084 + When included, a ":write file" command will reset the
2085 'modified' flag of the buffer, even though the buffer
2086 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002087 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002088 * Use ":*" in the same way as ":@". When not included,
2089 ":*" is an alias for ":'<,'>", select the Visual area.
2090 *cpo-<*
2091 < Disable the recognition of special key codes in |<>|
2092 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002093 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 ":map X <Tab>" results in X being mapped to:
2095 '<' included: "<Tab>" (5 characters)
2096 '<' excluded: "^I" (^I is a real <Tab>)
2097 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002098 *cpo->*
2099 > When appending to a register, put a line break before
2100 the appended text.
2101
2102 POSIX flags. These are not included in the Vi default value, except
2103 when $VIM_POSIX was set on startup. |posix|
2104
2105 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002106 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002107 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002108 *cpo-&*
2109 & When ":preserve" was used keep the swap file when
2110 exiting normally while this buffer is still loaded.
2111 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002112 *cpo-\*
2113 \ Backslash in a [] range in a search pattern is taken
2114 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002115 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2116 '\' excluded: "/[ \-]" finds <Space> and '-'
2117 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002118 *cpo-/*
2119 / When "%" is used as the replacement string in a |:s|
2120 command, use the previous replacement string. |:s%|
2121 *cpo-{*
2122 { The |{| and |}| commands also stop at a "{" character
2123 at the start of a line.
2124 *cpo-.*
2125 . The ":chdir" and ":cd" commands fail if the current
2126 buffer is modified, unless ! is used. Vim doesn't
2127 need this, since it remembers the full path of an
2128 opened file.
2129 *cpo-bar*
2130 | The value of the $LINES and $COLUMNS environment
2131 variables overrule the terminal size values obtained
2132 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002133
Bram Moolenaar071d4272004-06-13 20:20:40 +00002134
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002135 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002136'cryptmethod' string (default "zip")
2137 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002138 {not in Vi}
2139 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002140 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002141 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002142 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002143 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002144 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002145 or later, files can NOT be read by Vim 7.2 and older.
2146 This adds a "seed" to the file, every time you write
2147 the file the encrypted bytes will be different.
2148
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002149 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002150 to the detected method of the file being read. Thus if you write it
2151 without changing 'cryptmethod' the same method will be used.
2152 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002153 explicitly write it, you don't get a warning unless there are other
2154 modifications. Also see |:X|.
2155
2156 When setting the global value to an empty string, it will end up with
2157 the value "zip". When setting the local value to an empty string the
2158 buffer will use the global value.
2159
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002160 When a new encryption method is added in a later version of Vim, and
2161 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002162 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002163
2164
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165 *'cscopepathcomp'* *'cspc'*
2166'cscopepathcomp' 'cspc' number (default 0)
2167 global
2168 {not available when compiled without the |+cscope|
2169 feature}
2170 {not in Vi}
2171 Determines how many components of the path to show in a list of tags.
2172 See |cscopepathcomp|.
2173
2174 *'cscopeprg'* *'csprg'*
2175'cscopeprg' 'csprg' string (default "cscope")
2176 global
2177 {not available when compiled without the |+cscope|
2178 feature}
2179 {not in Vi}
2180 Specifies the command to execute cscope. See |cscopeprg|.
2181 This option cannot be set from a |modeline| or in the |sandbox|, for
2182 security reasons.
2183
2184 *'cscopequickfix'* *'csqf'*
2185'cscopequickfix' 'csqf' string (default "")
2186 global
2187 {not available when compiled without the |+cscope|
2188 or |+quickfix| features}
2189 {not in Vi}
2190 Specifies whether to use quickfix window to show cscope results.
2191 See |cscopequickfix|.
2192
2193 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2194'cscopetag' 'cst' boolean (default off)
2195 global
2196 {not available when compiled without the |+cscope|
2197 feature}
2198 {not in Vi}
2199 Use cscope for tag commands. See |cscope-options|.
2200 NOTE: This option is reset when 'compatible' is set.
2201
2202 *'cscopetagorder'* *'csto'*
2203'cscopetagorder' 'csto' number (default 0)
2204 global
2205 {not available when compiled without the |+cscope|
2206 feature}
2207 {not in Vi}
2208 Determines the order in which ":cstag" performs a search. See
2209 |cscopetagorder|.
2210 NOTE: This option is set to 0 when 'compatible' is set.
2211
2212 *'cscopeverbose'* *'csverb'*
2213 *'nocscopeverbose'* *'nocsverb'*
2214'cscopeverbose' 'csverb' boolean (default off)
2215 global
2216 {not available when compiled without the |+cscope|
2217 feature}
2218 {not in Vi}
2219 Give messages when adding a cscope database. See |cscopeverbose|.
2220 NOTE: This option is reset when 'compatible' is set.
2221
Bram Moolenaar860cae12010-06-05 23:22:07 +02002222 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2223'cursorbind' 'crb' boolean (default off)
2224 local to window
2225 {not in Vi}
2226 {not available when compiled without the |+cursorbind|
2227 feature}
2228 When this option is set, as the cursor in the current
2229 window moves other cursorbound windows (windows that also have
2230 this option set) move their cursors to the corresponding line and
2231 column. This option is useful for viewing the
2232 differences between two versions of a file (see 'diff'); in diff mode,
2233 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002234 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002235
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002236
2237 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2238'cursorcolumn' 'cuc' boolean (default off)
2239 local to window
2240 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002241 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002242 feature}
2243 Highlight the screen column of the cursor with CursorColumn
2244 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2245 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002246 If you only want the highlighting in the current window you can use
2247 these autocommands: >
2248 au WinLeave * set nocursorline nocursorcolumn
2249 au WinEnter * set cursorline cursorcolumn
2250<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002251
2252 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2253'cursorline' 'cul' boolean (default off)
2254 local to window
2255 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002256 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002257 feature}
2258 Highlight the screen line of the cursor with CursorLine
2259 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2260 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002261 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002262 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002263
2264
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 *'debug'*
2266'debug' string (default "")
2267 global
2268 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002269 These values can be used:
2270 msg Error messages that would otherwise be omitted will be given
2271 anyway.
2272 throw Error messages that would otherwise be omitted will be given
2273 anyway and also throw an exception and set |v:errmsg|.
2274 beep A message will be given when otherwise only a beep would be
2275 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002276 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002277 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2278 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279
2280 *'define'* *'def'*
2281'define' 'def' string (default "^\s*#\s*define")
2282 global or local to buffer |global-local|
2283 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002284 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 pattern, just like for the "/" command. This option is used for the
2286 commands like "[i" and "[d" |include-search|. The 'isident' option is
2287 used to recognize the defined name after the match:
2288 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2289 See |option-backslash| about inserting backslashes to include a space
2290 or backslash.
2291 The default value is for C programs. For C++ this value would be
2292 useful, to include const type declarations: >
2293 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2294< When using the ":set" command, you need to double the backslashes!
2295
2296 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2297'delcombine' 'deco' boolean (default off)
2298 global
2299 {not in Vi}
2300 {only available when compiled with the |+multi_byte|
2301 feature}
2302 If editing Unicode and this option is set, backspace and Normal mode
2303 "x" delete each combining character on its own. When it is off (the
2304 default) the character along with its combining characters are
2305 deleted.
2306 Note: When 'delcombine' is set "xx" may work different from "2x"!
2307
2308 This is useful for Arabic, Hebrew and many other languages where one
2309 may have combining characters overtop of base characters, and want
2310 to remove only the combining ones.
2311
2312 *'dictionary'* *'dict'*
2313'dictionary' 'dict' string (default "")
2314 global or local to buffer |global-local|
2315 {not in Vi}
2316 List of file names, separated by commas, that are used to lookup words
2317 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2318 contain a list of words. This can be one word per line, or several
2319 words per line, separated by non-keyword characters (white space is
2320 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002321 When this option is empty, or an entry "spell" is present, spell
2322 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002323 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002324 after a comma are ignored, otherwise spaces are included in the file
2325 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002326 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327 Where to find a list of words?
2328 - On FreeBSD, there is the file "/usr/share/dict/words".
2329 - In the Simtel archive, look in the "msdos/linguist" directory.
2330 - In "miscfiles" of the GNU collection.
2331 The use of |:set+=| and |:set-=| is preferred when adding or removing
2332 directories from the list. This avoids problems when a future version
2333 uses another default.
2334 Backticks cannot be used in this option for security reasons.
2335
2336 *'diff'* *'nodiff'*
2337'diff' boolean (default off)
2338 local to window
2339 {not in Vi}
2340 {not available when compiled without the |+diff|
2341 feature}
2342 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002343 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002344
2345 *'dex'* *'diffexpr'*
2346'diffexpr' 'dex' string (default "")
2347 global
2348 {not in Vi}
2349 {not available when compiled without the |+diff|
2350 feature}
2351 Expression which is evaluated to obtain an ed-style diff file from two
2352 versions of a file. See |diff-diffexpr|.
2353 This option cannot be set from a |modeline| or in the |sandbox|, for
2354 security reasons.
2355
2356 *'dip'* *'diffopt'*
2357'diffopt' 'dip' string (default "filler")
2358 global
2359 {not in Vi}
2360 {not available when compiled without the |+diff|
2361 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002362 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 All are optional. Items must be separated by a comma.
2364
2365 filler Show filler lines, to keep the text
2366 synchronized with a window that has inserted
2367 lines at the same position. Mostly useful
2368 when windows are side-by-side and 'scrollbind'
2369 is set.
2370
2371 context:{n} Use a context of {n} lines between a change
2372 and a fold that contains unchanged lines.
2373 When omitted a context of six lines is used.
2374 See |fold-diff|.
2375
2376 icase Ignore changes in case of text. "a" and "A"
2377 are considered the same. Adds the "-i" flag
2378 to the "diff" command if 'diffexpr' is empty.
2379
2380 iwhite Ignore changes in amount of white space. Adds
2381 the "-b" flag to the "diff" command if
2382 'diffexpr' is empty. Check the documentation
2383 of the "diff" command for what this does
2384 exactly. It should ignore adding trailing
2385 white space, but not leading white space.
2386
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002387 horizontal Start diff mode with horizontal splits (unless
2388 explicitly specified otherwise).
2389
2390 vertical Start diff mode with vertical splits (unless
2391 explicitly specified otherwise).
2392
2393 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2394 starting diff mode. Without this 2 is used.
2395
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396 Examples: >
2397
2398 :set diffopt=filler,context:4
2399 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002400 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401<
2402 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2403'digraph' 'dg' boolean (default off)
2404 global
2405 {not in Vi}
2406 {not available when compiled without the |+digraphs|
2407 feature}
2408 Enable the entering of digraphs in Insert mode with {char1} <BS>
2409 {char2}. See |digraphs|.
2410 NOTE: This option is reset when 'compatible' is set.
2411
2412 *'directory'* *'dir'*
2413'directory' 'dir' string (default for Amiga: ".,t:",
2414 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2415 for Unix: ".,~/tmp,/var/tmp,/tmp")
2416 global
2417 List of directory names for the swap file, separated with commas.
2418 - The swap file will be created in the first directory where this is
2419 possible.
2420 - Empty means that no swap file will be used (recovery is
2421 impossible!).
2422 - A directory "." means to put the swap file in the same directory as
2423 the edited file. On Unix, a dot is prepended to the file name, so
2424 it doesn't show in a directory listing. On MS-Windows the "hidden"
2425 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002426 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002427 put the swap file relative to where the edited file is. The leading
2428 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002429 - For Unix and Win32, if a directory ends in two path separators "//"
2430 or "\\", the swap file name will be built from the complete path to
2431 the file with all path separators substituted to percent '%' signs.
2432 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002433 On Win32, when a separating comma is following, you must use "//",
2434 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435 - Spaces after the comma are ignored, other spaces are considered part
2436 of the directory name. To have a space at the start of a directory
2437 name, precede it with a backslash.
2438 - To include a comma in a directory name precede it with a backslash.
2439 - A directory name may end in an ':' or '/'.
2440 - Environment variables are expanded |:set_env|.
2441 - Careful with '\' characters, type one before a space, type two to
2442 get one in the option (see |option-backslash|), for example: >
2443 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2444< - For backwards compatibility with Vim version 3.0 a '>' at the start
2445 of the option is removed.
2446 Using "." first in the list is recommended. This means that editing
2447 the same file twice will result in a warning. Using "/tmp" on Unix is
2448 discouraged: When the system crashes you lose the swap file.
2449 "/var/tmp" is often not cleared when rebooting, thus is a better
2450 choice than "/tmp". But it can contain a lot of files, your swap
2451 files get lost in the crowd. That is why a "tmp" directory in your
2452 home directory is tried first.
2453 The use of |:set+=| and |:set-=| is preferred when adding or removing
2454 directories from the list. This avoids problems when a future version
2455 uses another default.
2456 This option cannot be set from a |modeline| or in the |sandbox|, for
2457 security reasons.
2458 {Vi: directory to put temp file in, defaults to "/tmp"}
2459
2460 *'display'* *'dy'*
2461'display' 'dy' string (default "")
2462 global
2463 {not in Vi}
2464 Change the way text is displayed. This is comma separated list of
2465 flags:
2466 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002467 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 last line that doesn't fit is replaced with "@" lines.
2469 uhex Show unprintable characters hexadecimal as <xx>
2470 instead of using ^C and ~C.
2471
2472 *'eadirection'* *'ead'*
2473'eadirection' 'ead' string (default "both")
2474 global
2475 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002476 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002477 feature}
2478 Tells when the 'equalalways' option applies:
2479 ver vertically, width of windows is not affected
2480 hor horizontally, height of windows is not affected
2481 both width and height of windows is affected
2482
2483 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2484'edcompatible' 'ed' boolean (default off)
2485 global
2486 Makes the 'g' and 'c' flags of the ":substitute" command to be
2487 toggled each time the flag is given. See |complex-change|. See
2488 also 'gdefault' option.
2489 Switching this option on is discouraged!
2490
2491 *'encoding'* *'enc'* *E543*
2492'encoding' 'enc' string (default: "latin1" or value from $LANG)
2493 global
2494 {only available when compiled with the |+multi_byte|
2495 feature}
2496 {not in Vi}
2497 Sets the character encoding used inside Vim. It applies to text in
2498 the buffers, registers, Strings in expressions, text stored in the
2499 viminfo file, etc. It sets the kind of characters which Vim can work
2500 with. See |encoding-names| for the possible values.
2501
2502 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002503 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002505 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506
Bram Moolenaar865242e2010-07-14 21:12:05 +02002507 This option cannot be set from a |modeline|. It would most likely
2508 corrupt the text.
2509
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2511 "utf-8". Although care has been taken to allow different values of
2512 'encoding', "utf-8" is the natural choice for the environment and
2513 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002514 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 versions, and to avoid changing the encoding of newly created files
2516 without your knowledge (in case 'fileencodings' is empty).
2517
2518 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002519 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520 iconv() or as specified with 'charconvert'.
2521
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002522 If you need to know whether 'encoding' is a multi-byte encoding, you
2523 can use: >
2524 if has("multi_byte_encoding")
2525<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526 Normally 'encoding' will be equal to your current locale. This will
2527 be the default if Vim recognizes your environment settings. If
2528 'encoding' is not set to the current locale, 'termencoding' must be
2529 set to convert typed and displayed text. See |encoding-table|.
2530
2531 When you set this option, it fires the |EncodingChanged| autocommand
2532 event so that you can set up fonts if necessary.
2533
2534 When the option is set, the value is converted to lowercase. Thus
2535 you can set it with uppercase values too. Underscores are translated
2536 to '-' signs.
2537 When the encoding is recognized, it is changed to the standard name.
2538 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2539 "iso-8859-2" and "utf8" becomes "utf-8".
2540
2541 Note: "latin1" is also used when the encoding could not be detected.
2542 This only works when editing files in the same encoding! When the
2543 actual character set is not latin1, make sure 'fileencoding' and
2544 'fileencodings' are empty. When conversion is needed, switch to using
2545 utf-8.
2546
2547 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2548 You don't notice this while editing, but it does matter for the
2549 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2550 setting 'encoding' to one of these values instead of utf-8 only has
2551 effect for encoding used for files when 'fileencoding' is empty.
2552
Bram Moolenaar661b1822005-07-28 22:36:45 +00002553 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2554 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555
2556 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2557'endofline' 'eol' boolean (default on)
2558 local to buffer
2559 {not in Vi}
2560 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002561 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562 option is automatically set when starting to edit a new file, unless
2563 the file does not have an <EOL> for the last line in the file, in
2564 which case it is reset. Normally you don't have to set or reset this
2565 option. When 'binary' is off the value is not used when writing the
2566 file. When 'binary' is on it is used to remember the presence of a
2567 <EOL> for the last line in the file, so that when you write the file
2568 the situation from the original file can be kept. But you can change
2569 it if you want to.
2570
2571 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2572'equalalways' 'ea' boolean (default on)
2573 global
2574 {not in Vi}
2575 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002576 splitting or closing a window. This also happens the moment the
2577 option is switched on. When off, splitting a window will reduce the
2578 size of the current window and leave the other windows the same. When
2579 closing a window the extra lines are given to the window next to it
2580 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 When mixing vertically and horizontally split windows, a minimal size
2582 is computed and some windows may be larger if there is room. The
2583 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002584 Changing the height and width of a window can be avoided by setting
2585 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002586 If a window size is specified when creating a new window sizes are
2587 currently not equalized (it's complicated, but may be implemented in
2588 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589
2590 *'equalprg'* *'ep'*
2591'equalprg' 'ep' string (default "")
2592 global or local to buffer |global-local|
2593 {not in Vi}
2594 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002595 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002596 or 'indentexpr'. When Vim was compiled without internal formatting,
2597 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002598 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002599 about including spaces and backslashes.
2600 This option cannot be set from a |modeline| or in the |sandbox|, for
2601 security reasons.
2602
2603 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2604'errorbells' 'eb' boolean (default off)
2605 global
2606 Ring the bell (beep or screen flash) for error messages. This only
2607 makes a difference for error messages, the bell will be used always
2608 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002609 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002610 screen flash or do nothing.
2611
2612 *'errorfile'* *'ef'*
2613'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2614 others: "errors.err")
2615 global
2616 {not in Vi}
2617 {not available when compiled without the |+quickfix|
2618 feature}
2619 Name of the errorfile for the QuickFix mode (see |:cf|).
2620 When the "-q" command-line argument is used, 'errorfile' is set to the
2621 following argument. See |-q|.
2622 NOT used for the ":make" command. See 'makeef' for that.
2623 Environment variables are expanded |:set_env|.
2624 See |option-backslash| about including spaces and backslashes.
2625 This option cannot be set from a |modeline| or in the |sandbox|, for
2626 security reasons.
2627
2628 *'errorformat'* *'efm'*
2629'errorformat' 'efm' string (default is very long)
2630 global or local to buffer |global-local|
2631 {not in Vi}
2632 {not available when compiled without the |+quickfix|
2633 feature}
2634 Scanf-like description of the format for the lines in the error file
2635 (see |errorformat|).
2636
2637 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2638'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2639 global
2640 {not in Vi}
2641 Function keys that start with an <Esc> are recognized in Insert
2642 mode. When this option is off, the cursor and function keys cannot be
2643 used in Insert mode if they start with an <Esc>. The advantage of
2644 this is that the single <Esc> is recognized immediately, instead of
2645 after one second. Instead of resetting this option, you might want to
2646 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2647 when 'esckeys' is off, you can still map anything, but the cursor keys
2648 won't work by default.
2649 NOTE: This option is set to the Vi default value when 'compatible' is
2650 set and to the Vim default value when 'compatible' is reset.
2651
2652 *'eventignore'* *'ei'*
2653'eventignore' 'ei' string (default "")
2654 global
2655 {not in Vi}
2656 {not available when compiled without the |+autocmd|
2657 feature}
2658 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002659 When set to "all" or when "all" is one of the items, all autocommand
2660 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 Otherwise this is a comma separated list of event names. Example: >
2662 :set ei=WinEnter,WinLeave
2663<
2664 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2665'expandtab' 'et' boolean (default off)
2666 local to buffer
2667 {not in Vi}
2668 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002669 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2671 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2672 NOTE: This option is reset when 'compatible' is set.
2673
2674 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2675'exrc' 'ex' boolean (default off)
2676 global
2677 {not in Vi}
2678 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2679 directory. If you switch this option on you should also consider
2680 setting the 'secure' option (see |initialization|). Using a local
2681 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2682 also see |.vimrc| and |gui-init|.
2683 This option cannot be set from a |modeline| or in the |sandbox|, for
2684 security reasons.
2685
2686 *'fileencoding'* *'fenc'* *E213*
2687'fileencoding' 'fenc' string (default: "")
2688 local to buffer
2689 {only available when compiled with the |+multi_byte|
2690 feature}
2691 {not in Vi}
2692 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002693
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002695 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696 When 'fileencoding' is empty, the same value as 'encoding' will be
2697 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002698 Conversion will also be done when 'encoding' and 'fileencoding' are
2699 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2700 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002702 'encoding' is "utf-8" or another Unicode encoding, conversion
2703 is most likely done in a way that the reverse conversion
2704 results in the same text. When 'encoding' is not "utf-8" some
2705 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002706
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707 See 'encoding' for the possible values. Additionally, values may be
2708 specified that can be handled by the converter, see
2709 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002710
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 When reading a file 'fileencoding' will be set from 'fileencodings'.
2712 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002713 'fileencoding', use the |++enc| argument. One exception: when
2714 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002715 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002716
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2718 When the option is set, the value is converted to lowercase. Thus
2719 you can set it with uppercase values too. '_' characters are
2720 replaced with '-'. If a name is recognized from the list for
2721 'encoding', it is replaced by the standard name. For example
2722 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002723
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 When this option is set, after starting to edit a file, the 'modified'
2725 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002726
2727 Keep in mind that changing 'fenc' from a modeline happens
2728 AFTER the text has been read, thus it applies to when the file will be
2729 written. If you do set 'fenc' in a modeline, you might want to set
2730 'nomodified' to avoid not being able to ":q".
2731
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732 This option can not be changed when 'modifiable' is off.
2733
2734 *'fe'*
2735 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002736 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737 old short name was 'fe', which is no longer used.
2738
2739 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002740'fileencodings' 'fencs' string (default: "ucs-bom",
2741 "ucs-bom,utf-8,default,latin1" when
2742 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743 global
2744 {only available when compiled with the |+multi_byte|
2745 feature}
2746 {not in Vi}
2747 This is a list of character encodings considered when starting to edit
2748 an existing file. When a file is read, Vim tries to use the first
2749 mentioned character encoding. If an error is detected, the next one
2750 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002751 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 an empty string, which means the value of 'encoding' is used.
2753 WARNING: Conversion can cause loss of information! When
2754 'encoding' is "utf-8" (or one of the other Unicode variants)
2755 conversion is most likely done in a way that the reverse
2756 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002757 "utf-8" some non-ASCII characters may be lost! You can use
2758 the |++bad| argument to specify what is done with characters
2759 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760 For an empty file or a file with only ASCII characters most encodings
2761 will work and the first entry of 'fileencodings' will be used (except
2762 "ucs-bom", which requires the BOM to be present). If you prefer
2763 another encoding use an BufReadPost autocommand event to test if your
2764 preferred encoding is to be used. Example: >
2765 au BufReadPost * if search('\S', 'w') == 0 |
2766 \ set fenc=iso-2022-jp | endif
2767< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2768 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002769 When the |++enc| argument is used then the value of 'fileencodings' is
2770 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002771 Note that 'fileencodings' is not used for a new file, the global value
2772 of 'fileencoding' is used instead. You can set it with: >
2773 :setglobal fenc=iso-8859-2
2774< This means that a non-existing file may get a different encoding than
2775 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776 The special value "ucs-bom" can be used to check for a Unicode BOM
2777 (Byte Order Mark) at the start of the file. It must not be preceded
2778 by "utf-8" or another Unicode encoding for this to work properly.
2779 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2780 because Vim cannot detect an error, thus the encoding is always
2781 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002782 The special value "default" can be used for the encoding from the
2783 environment. This is the default value for 'encoding'. It is useful
2784 when 'encoding' is set to "utf-8" and your environment uses a
2785 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002786 When 'encoding' is "utf-8" and a file contains an illegal byte
2787 sequence it won't be recognized as UTF-8. You can use the |8g8|
2788 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 WRONG VALUES: WHAT'S WRONG:
2790 latin1,utf-8 "latin1" will always be used
2791 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2792 file
2793 cp1250,latin1 "cp1250" will always be used
2794 If 'fileencodings' is empty, 'fileencoding' is not modified.
2795 See 'fileencoding' for the possible values.
2796 Setting this option does not have an effect until the next time a file
2797 is read.
2798
2799 *'fileformat'* *'ff'*
2800'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2801 Unix default: "unix",
2802 Macintosh default: "mac")
2803 local to buffer
2804 {not in Vi}
2805 This gives the <EOL> of the current buffer, which is used for
2806 reading/writing the buffer from/to a file:
2807 dos <CR> <NL>
2808 unix <NL>
2809 mac <CR>
2810 When "dos" is used, CTRL-Z at the end of a file is ignored.
2811 See |file-formats| and |file-read|.
2812 For the character encoding of the file see 'fileencoding'.
2813 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2814 works like it was set to "unix'.
2815 This option is set automatically when starting to edit a file and
2816 'fileformats' is not empty and 'binary' is off.
2817 When this option is set, after starting to edit a file, the 'modified'
2818 option is set, because the file would be different when written.
2819 This option can not be changed when 'modifiable' is off.
2820 For backwards compatibility: When this option is set to "dos",
2821 'textmode' is set, otherwise 'textmode' is reset.
2822
2823 *'fileformats'* *'ffs'*
2824'fileformats' 'ffs' string (default:
2825 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2826 Vim Unix: "unix,dos",
2827 Vim Mac: "mac,unix,dos",
2828 Vi Cygwin: "unix,dos",
2829 Vi others: "")
2830 global
2831 {not in Vi}
2832 This gives the end-of-line (<EOL>) formats that will be tried when
2833 starting to edit a new buffer and when reading a file into an existing
2834 buffer:
2835 - When empty, the format defined with 'fileformat' will be used
2836 always. It is not set automatically.
2837 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002838 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 'fileformats' name will be used when a file is read into an existing
2840 buffer, no matter what 'fileformat' for that buffer is set to.
2841 - When more than one name is present, separated by commas, automatic
2842 <EOL> detection will be done when reading a file. When starting to
2843 edit a file, a check is done for the <EOL>:
2844 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2845 'fileformat' is set to "dos".
2846 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002847 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002849 3. If 'fileformat' has not yet been set, and if 'fileformats'
2850 includes "mac", 'fileformat' is set to "mac".
2851 This means that "mac" is only chosen when:
2852 "unix" is not present or no <NL> is found in the file, and
2853 "dos" is not present or no <CR><NL> is found in the file.
2854 Except: if "unix" was chosen, but there is a <CR> before
2855 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002856 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857 4. If 'fileformat' is still not set, the first name from
2858 'fileformats' is used.
2859 When reading a file into an existing buffer, the same is done, but
2860 this happens like 'fileformat' has been set appropriately for that
2861 file only, the option is not changed.
2862 When 'binary' is set, the value of 'fileformats' is not used.
2863
2864 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2865 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2866 done:
2867 - When 'fileformats' is empty, there is no automatic detection. Dos
2868 format will be used.
2869 - When 'fileformats' is set to one or more names, automatic detection
2870 is done. This is based on the first <NL> in the file: If there is a
2871 <CR> in front of it, Dos format is used, otherwise Unix format is
2872 used.
2873 Also see |file-formats|.
2874 For backwards compatibility: When this option is set to an empty
2875 string or one format (no comma is included), 'textauto' is reset,
2876 otherwise 'textauto' is set.
2877 NOTE: This option is set to the Vi default value when 'compatible' is
2878 set and to the Vim default value when 'compatible' is reset.
2879
2880 *'filetype'* *'ft'*
2881'filetype' 'ft' string (default: "")
2882 local to buffer
2883 {not in Vi}
2884 {not available when compiled without the |+autocmd|
2885 feature}
2886 When this option is set, the FileType autocommand event is triggered.
2887 All autocommands that match with the value of this option will be
2888 executed. Thus the value of 'filetype' is used in place of the file
2889 name.
2890 Otherwise this option does not always reflect the current file type.
2891 This option is normally set when the file type is detected. To enable
2892 this use the ":filetype on" command. |:filetype|
2893 Setting this option to a different value is most useful in a modeline,
2894 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002895 Example, for in an IDL file:
2896 /* vim: set filetype=idl : */ ~
2897 |FileType| |filetypes|
2898 When a dot appears in the value then this separates two filetype
2899 names. Example:
2900 /* vim: set filetype=c.doxygen : */ ~
2901 This will use the "c" filetype first, then the "doxygen" filetype.
2902 This works both for filetype plugins and for syntax files. More than
2903 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 Do not confuse this option with 'osfiletype', which is for the file
2905 type that is actually stored with the file.
2906 This option is not copied to another buffer, independent of the 's' or
2907 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002908 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909
2910 *'fillchars'* *'fcs'*
2911'fillchars' 'fcs' string (default "vert:|,fold:-")
2912 global
2913 {not in Vi}
2914 {not available when compiled without the |+windows|
2915 and |+folding| features}
2916 Characters to fill the statuslines and vertical separators.
2917 It is a comma separated list of items:
2918
2919 item default Used for ~
2920 stl:c ' ' or '^' statusline of the current window
2921 stlnc:c ' ' or '-' statusline of the non-current windows
2922 vert:c '|' vertical separators |:vsplit|
2923 fold:c '-' filling 'foldtext'
2924 diff:c '-' deleted lines of the 'diff' option
2925
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002926 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927 "stlnc" the space will be used when there is highlighting, '^' or '-'
2928 otherwise.
2929
2930 Example: >
2931 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2932< This is similar to the default, except that these characters will also
2933 be used when there is highlighting.
2934
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002935 for "stl" and "stlnc" only single-byte values are supported.
2936
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937 The highlighting used for these items:
2938 item highlight group ~
2939 stl:c StatusLine |hl-StatusLine|
2940 stlnc:c StatusLineNC |hl-StatusLineNC|
2941 vert:c VertSplit |hl-VertSplit|
2942 fold:c Folded |hl-Folded|
2943 diff:c DiffDelete |hl-DiffDelete|
2944
2945 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2946'fkmap' 'fk' boolean (default off) *E198*
2947 global
2948 {not in Vi}
2949 {only available when compiled with the |+rightleft|
2950 feature}
2951 When on, the keyboard is mapped for the Farsi character set.
2952 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002953 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954
2955 *'foldclose'* *'fcl'*
2956'foldclose' 'fcl' string (default "")
2957 global
2958 {not in Vi}
2959 {not available when compiled without the |+folding|
2960 feature}
2961 When set to "all", a fold is closed when the cursor isn't in it and
2962 its level is higher than 'foldlevel'. Useful if you want folds to
2963 automatically close when moving out of them.
2964
2965 *'foldcolumn'* *'fdc'*
2966'foldcolumn' 'fdc' number (default 0)
2967 local to window
2968 {not in Vi}
2969 {not available when compiled without the |+folding|
2970 feature}
2971 When non-zero, a column with the specified width is shown at the side
2972 of the window which indicates open and closed folds. The maximum
2973 value is 12.
2974 See |folding|.
2975
2976 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2977'foldenable' 'fen' boolean (default on)
2978 local to window
2979 {not in Vi}
2980 {not available when compiled without the |+folding|
2981 feature}
2982 When off, all folds are open. This option can be used to quickly
2983 switch between showing all text unfolded and viewing the text with
2984 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002985 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 'foldenable' is off.
2987 This option is set by commands that create a new fold or close a fold.
2988 See |folding|.
2989
2990 *'foldexpr'* *'fde'*
2991'foldexpr' 'fde' string (default: "0")
2992 local to window
2993 {not in Vi}
2994 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02002995 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002997 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002998
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002999 The expression may be evaluated in the |sandbox|, see
3000 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003001 This option can't be set from a |modeline| when the 'diff' option is
3002 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003003
3004 It is not allowed to change text or jump to another window while
3005 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006
3007 *'foldignore'* *'fdi'*
3008'foldignore' 'fdi' string (default: "#")
3009 local to window
3010 {not in Vi}
3011 {not available when compiled without the |+folding|
3012 feature}
3013 Used only when 'foldmethod' is "indent". Lines starting with
3014 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003015 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 The default "#" works well for C programs. See |fold-indent|.
3017
3018 *'foldlevel'* *'fdl'*
3019'foldlevel' 'fdl' number (default: 0)
3020 local to window
3021 {not in Vi}
3022 {not available when compiled without the |+folding|
3023 feature}
3024 Sets the fold level: Folds with a higher level will be closed.
3025 Setting this option to zero will close all folds. Higher numbers will
3026 close fewer folds.
3027 This option is set by commands like |zm|, |zM| and |zR|.
3028 See |fold-foldlevel|.
3029
3030 *'foldlevelstart'* *'fdls'*
3031'foldlevelstart' 'fdls' number (default: -1)
3032 global
3033 {not in Vi}
3034 {not available when compiled without the |+folding|
3035 feature}
3036 Sets 'foldlevel' when starting to edit another buffer in a window.
3037 Useful to always start editing with all folds closed (value zero),
3038 some folds closed (one) or no folds closed (99).
3039 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003040 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 ignores this option and closes all folds.
3042 It is also done before BufReadPre autocommands, to allow an autocmd to
3043 overrule the 'foldlevel' value for specific files.
3044 When the value is negative, it is not used.
3045
3046 *'foldmarker'* *'fmr'* *E536*
3047'foldmarker' 'fmr' string (default: "{{{,}}}")
3048 local to window
3049 {not in Vi}
3050 {not available when compiled without the |+folding|
3051 feature}
3052 The start and end marker used when 'foldmethod' is "marker". There
3053 must be one comma, which separates the start and end marker. The
3054 marker is a literal string (a regular expression would be too slow).
3055 See |fold-marker|.
3056
3057 *'foldmethod'* *'fdm'*
3058'foldmethod' 'fdm' string (default: "manual")
3059 local to window
3060 {not in Vi}
3061 {not available when compiled without the |+folding|
3062 feature}
3063 The kind of folding used for the current window. Possible values:
3064 |fold-manual| manual Folds are created manually.
3065 |fold-indent| indent Lines with equal indent form a fold.
3066 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3067 |fold-marker| marker Markers are used to specify folds.
3068 |fold-syntax| syntax Syntax highlighting items specify folds.
3069 |fold-diff| diff Fold text that is not changed.
3070
3071 *'foldminlines'* *'fml'*
3072'foldminlines' 'fml' number (default: 1)
3073 local to window
3074 {not in Vi}
3075 {not available when compiled without the |+folding|
3076 feature}
3077 Sets the minimum number of screen lines for a fold to be displayed
3078 closed. Also for manually closed folds.
3079 Note that this only has an effect of what is displayed. After using
3080 "zc" to close a fold, which is displayed open because it's smaller
3081 than 'foldminlines', a following "zc" may close a containing fold.
3082
3083 *'foldnestmax'* *'fdn'*
3084'foldnestmax' 'fdn' number (default: 20)
3085 local to window
3086 {not in Vi}
3087 {not available when compiled without the |+folding|
3088 feature}
3089 Sets the maximum nesting of folds for the "indent" and "syntax"
3090 methods. This avoids that too many folds will be created. Using more
3091 than 20 doesn't work, because the internal limit is 20.
3092
3093 *'foldopen'* *'fdo'*
3094'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3095 search,tag,undo")
3096 global
3097 {not in Vi}
3098 {not available when compiled without the |+folding|
3099 feature}
3100 Specifies for which type of commands folds will be opened, if the
3101 command moves the cursor into a closed fold. It is a comma separated
3102 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003103 NOTE: When the command is part of a mapping this option is not used.
3104 Add the |zv| command to the mapping to get the same effect.
3105 (rationale: the mapping may want to control opening folds itself)
3106
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 item commands ~
3108 all any
3109 block "(", "{", "[[", "[{", etc.
3110 hor horizontal movements: "l", "w", "fx", etc.
3111 insert any command in Insert mode
3112 jump far jumps: "G", "gg", etc.
3113 mark jumping to a mark: "'m", CTRL-O, etc.
3114 percent "%"
3115 quickfix ":cn", ":crew", ":make", etc.
3116 search search for a pattern: "/", "n", "*", "gd", etc.
3117 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003118 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119 tag jumping to a tag: ":ta", CTRL-T, etc.
3120 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 When a movement command is used for an operator (e.g., "dl" or "y%")
3122 this option is not used. This means the operator will include the
3123 whole closed fold.
3124 Note that vertical movements are not here, because it would make it
3125 very difficult to move onto a closed fold.
3126 In insert mode the folds containing the cursor will always be open
3127 when text is inserted.
3128 To close folds you can re-apply 'foldlevel' with the |zx| command or
3129 set the 'foldclose' option to "all".
3130
3131 *'foldtext'* *'fdt'*
3132'foldtext' 'fdt' string (default: "foldtext()")
3133 local to window
3134 {not in Vi}
3135 {not available when compiled without the |+folding|
3136 feature}
3137 An expression which is used to specify the text displayed for a closed
3138 fold. See |fold-foldtext|.
3139
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003140 The expression may be evaluated in the |sandbox|, see
3141 |sandbox-option|.
3142
3143 It is not allowed to change text or jump to another window while
3144 evaluating 'foldtext' |textlock|.
3145
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 *'formatoptions'* *'fo'*
3147'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3148 local to buffer
3149 {not in Vi}
3150 This is a sequence of letters which describes how automatic
3151 formatting is to be done. See |fo-table|. When the 'paste' option is
3152 on, no formatting is done (like 'formatoptions' is empty). Commas can
3153 be inserted for readability.
3154 To avoid problems with flags that are added in the future, use the
3155 "+=" and "-=" feature of ":set" |add-option-flags|.
3156 NOTE: This option is set to the Vi default value when 'compatible' is
3157 set and to the Vim default value when 'compatible' is reset.
3158
Bram Moolenaar86b68352004-12-27 21:59:20 +00003159 *'formatlistpat'* *'flp'*
3160'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3161 local to buffer
3162 {not in Vi}
3163 A pattern that is used to recognize a list header. This is used for
3164 the "n" flag in 'formatoptions'.
3165 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003166 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003167 while still checking more characters. There must be a character
3168 following the pattern, when it matches the whole line it is handled
3169 like there is no match.
3170 The default recognizes a number, followed by an optional punctuation
3171 character and white space.
3172
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 *'formatprg'* *'fp'*
3174'formatprg' 'fp' string (default "")
3175 global
3176 {not in Vi}
3177 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003178 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003180 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003181 If the 'formatexpr' option is not empty it will be used instead.
3182 Otherwise, if 'formatprg' option is an empty string, the internal
3183 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003184 Environment variables are expanded |:set_env|. See |option-backslash|
3185 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003186 The expression may be evaluated in the |sandbox|, see
3187 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003189 *'formatexpr'* *'fex'*
3190'formatexpr' 'fex' string (default "")
3191 local to buffer
3192 {not in Vi}
3193 {not available when compiled without the |+eval|
3194 feature}
3195 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003196 operator or automatic formatting (see 'formatoptions'). When this
3197 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003198
3199 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003200 The |v:count| variable holds the number of lines to be formatted.
3201 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003202 inserted if the expression is being evaluated due to
3203 automatic formatting. This can be empty. Don't insert
3204 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003205
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003206 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003207 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003208< This will invoke the mylang#Format() function in the
3209 autoload/mylang.vim file in 'runtimepath'. |autoload|
3210
3211 The expression is also evaluated when 'textwidth' is set and adding
3212 text beyond that limit. This happens under the same conditions as
3213 when internal formatting is used. Make sure the cursor is kept in the
3214 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003215 return "i" or "R" in this situation.
3216
3217 When the expression evaluates to non-zero Vim will fall back to using
3218 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003219
3220 The expression may be evaluated in the |sandbox|, see
3221 |sandbox-option|.
3222
3223 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003224'fsync' 'fs' boolean (default on)
3225 global
3226 {not in Vi}
3227 When on, the library function fsync() will be called after writing a
3228 file. This will flush a file to disk, ensuring that it is safely
3229 written even on filesystems which do metadata-only journaling. This
3230 will force the harddrive to spin up on Linux systems running in laptop
3231 mode, so it may be undesirable in some situations. Be warned that
3232 turning this off increases the chances of data loss after a crash. On
3233 systems without an fsync() implementation, this variable is always
3234 off.
3235 Also see 'swapsync' for controlling fsync() on swap files.
3236
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3238'gdefault' 'gd' boolean (default off)
3239 global
3240 {not in Vi}
3241 When on, the ":substitute" flag 'g' is default on. This means that
3242 all matches in a line are substituted instead of one. When a 'g' flag
3243 is given to a ":substitute" command, this will toggle the substitution
3244 of all or one match. See |complex-change|.
3245
3246 command 'gdefault' on 'gdefault' off ~
3247 :s/// subst. all subst. one
3248 :s///g subst. one subst. all
3249 :s///gg subst. all subst. one
3250
3251 NOTE: This option is reset when 'compatible' is set.
3252
3253 *'grepformat'* *'gfm'*
3254'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3255 global
3256 {not in Vi}
3257 Format to recognize for the ":grep" command output.
3258 This is a scanf-like string that uses the same format as the
3259 'errorformat' option: see |errorformat|.
3260
3261 *'grepprg'* *'gp'*
3262'grepprg' 'gp' string (default "grep -n ",
3263 Unix: "grep -n $* /dev/null",
3264 Win32: "findstr /n" or "grep -n",
3265 VMS: "SEARCH/NUMBERS ")
3266 global or local to buffer |global-local|
3267 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003268 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 and '#' characters, which are expanded like when used in a command-
3270 line. The placeholder "$*" is allowed to specify where the arguments
3271 will be included. Environment variables are expanded |:set_env|. See
3272 |option-backslash| about including spaces and backslashes.
3273 When your "grep" accepts the "-H" argument, use this to make ":grep"
3274 also work well with a single file: >
3275 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003276< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003277 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3278 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003279 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 apply equally to 'grepprg'.
3281 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3282 otherwise it's "grep -n".
3283 This option cannot be set from a |modeline| or in the |sandbox|, for
3284 security reasons.
3285
3286 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3287'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3288 ve:ver35-Cursor,
3289 o:hor50-Cursor,
3290 i-ci:ver25-Cursor/lCursor,
3291 r-cr:hor20-Cursor/lCursor,
3292 sm:block-Cursor
3293 -blinkwait175-blinkoff150-blinkon175",
3294 for MS-DOS and Win32 console:
3295 "n-v-c:block,o:hor50,i-ci:hor15,
3296 r-cr:hor30,sm:block")
3297 global
3298 {not in Vi}
3299 {only available when compiled with GUI enabled, and
3300 for MS-DOS and Win32 console}
3301 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003302 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 the height of the cursor can be changed. This can be done by
3304 specifying a block cursor, or a percentage for a vertical or
3305 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003306 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003308 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 mode-list and an argument-list:
3310 mode-list:argument-list,mode-list:argument-list,..
3311 The mode-list is a dash separated list of these modes:
3312 n Normal mode
3313 v Visual mode
3314 ve Visual mode with 'selection' "exclusive" (same as 'v',
3315 if not specified)
3316 o Operator-pending mode
3317 i Insert mode
3318 r Replace mode
3319 c Command-line Normal (append) mode
3320 ci Command-line Insert mode
3321 cr Command-line Replace mode
3322 sm showmatch in Insert mode
3323 a all modes
3324 The argument-list is a dash separated list of these arguments:
3325 hor{N} horizontal bar, {N} percent of the character height
3326 ver{N} vertical bar, {N} percent of the character width
3327 block block cursor, fills the whole character
3328 [only one of the above three should be present]
3329 blinkwait{N} *cursor-blinking*
3330 blinkon{N}
3331 blinkoff{N}
3332 blink times for cursor: blinkwait is the delay before
3333 the cursor starts blinking, blinkon is the time that
3334 the cursor is shown and blinkoff is the time that the
3335 cursor is not shown. The times are in msec. When one
3336 of the numbers is zero, there is no blinking. The
3337 default is: "blinkwait700-blinkon400-blinkoff250".
3338 These numbers are used for a missing entry. This
3339 means that blinking is enabled by default. To switch
3340 blinking off you can use "blinkon0". The cursor only
3341 blinks when Vim is waiting for input, not while
3342 executing a command.
3343 To make the cursor blink in an xterm, see
3344 |xterm-blink|.
3345 {group-name}
3346 a highlight group name, that sets the color and font
3347 for the cursor
3348 {group-name}/{group-name}
3349 Two highlight group names, the first is used when
3350 no language mappings are used, the other when they
3351 are. |language-mapping|
3352
3353 Examples of parts:
3354 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3355 block cursor with colors from the "nCursor"
3356 highlight group
3357 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3358 In Insert and Command-line Insert mode, use a
3359 30% vertical bar cursor with colors from the
3360 "iCursor" highlight group. Blink a bit
3361 faster.
3362
3363 The 'a' mode is different. It will set the given argument-list for
3364 all modes. It does not reset anything to defaults. This can be used
3365 to do a common setting for all modes. For example, to switch off
3366 blinking: "a:blinkon0"
3367
3368 Examples of cursor highlighting: >
3369 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3370 :highlight Cursor gui=NONE guifg=bg guibg=fg
3371<
3372 *'guifont'* *'gfn'*
3373 *E235* *E596* *E610* *E611*
3374'guifont' 'gfn' string (default "")
3375 global
3376 {not in Vi}
3377 {only available when compiled with GUI enabled}
3378 This is a list of fonts which will be used for the GUI version of Vim.
3379 In its simplest form the value is just one font name. When
3380 the font cannot be found you will get an error message. To try other
3381 font names a list can be specified, font names separated with commas.
3382 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003383
Bram Moolenaar05159a02005-02-26 23:04:13 +00003384 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3385 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003386
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387 Spaces after a comma are ignored. To include a comma in a font name
3388 precede it with a backslash. Setting an option requires an extra
3389 backslash before a space and a backslash. See also
3390 |option-backslash|. For example: >
3391 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003392< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003394
3395 If none of the fonts can be loaded, Vim will keep the current setting.
3396 If an empty font list is given, Vim will try using other resource
3397 settings (for X, it will use the Vim.font resource), and finally it
3398 will try some builtin default which should always be there ("7x13" in
3399 the case of X). The font names given should be "normal" fonts. Vim
3400 will try to find the related bold and italic fonts.
3401
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003402 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003403 :set guifont=*
3404< will bring up a font requester, where you can pick the font you want.
3405
3406 The font name depends on the GUI used. See |setting-guifont| for a
3407 way to set 'guifont' for various systems.
3408
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 For the GTK+ 2 GUI the font name looks like this: >
3410 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003411< That's all. XLFDs are not used. For Chinese this is reported to work
3412 well: >
3413 if has("gui_gtk2")
3414 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3415 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3416 endif
3417<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003418 For Mac OSX you can use something like this: >
3419 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003420< Also see 'macatsui', it can help fix display problems.
3421 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003422 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003423 width). An exception is GTK 2: all fonts are accepted, but
3424 mono-spaced fonts look best.
3425
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 To preview a font on X11, you might be able to use the "xfontsel"
3427 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003428
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 For the Win32 GUI *E244* *E245*
3430 - takes these options in the font name:
3431 hXX - height is XX (points, can be floating-point)
3432 wXX - width is XX (points, can be floating-point)
3433 b - bold
3434 i - italic
3435 u - underline
3436 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003437 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3439 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3440 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003441 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003442
3443 Use a ':' to separate the options.
3444 - A '_' can be used in the place of a space, so you don't need to use
3445 backslashes to escape the spaces.
3446 - Examples: >
3447 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3448 :set guifont=Andale_Mono:h7.5:w4.5
3449< See also |font-sizes|.
3450
3451 *'guifontset'* *'gfs'*
3452 *E250* *E252* *E234* *E597* *E598*
3453'guifontset' 'gfs' string (default "")
3454 global
3455 {not in Vi}
3456 {only available when compiled with GUI enabled and
3457 with the |+xfontset| feature}
3458 {not available in the GTK+ 2 GUI}
3459 When not empty, specifies two (or more) fonts to be used. The first
3460 one for normal English, the second one for your special language. See
3461 |xfontset|.
3462 Setting this option also means that all font names will be handled as
3463 a fontset name. Also the ones used for the "font" argument of the
3464 |:highlight| command.
3465 The fonts must match with the current locale. If fonts for the
3466 character sets that the current locale uses are not included, setting
3467 'guifontset' will fail.
3468 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3469 the comma-separated names are alternative names, one of which will be
3470 used. In 'guifontset' the whole string is one fontset name,
3471 including the commas. It is not possible to specify alternative
3472 fontset names.
3473 This example works on many X11 systems: >
3474 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3475<
3476 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3477'guifontwide' 'gfw' string (default "")
3478 global
3479 {not in Vi}
3480 {only available when compiled with GUI enabled}
3481 When not empty, specifies a comma-separated list of fonts to be used
3482 for double-width characters. The first font that can be loaded is
3483 used.
3484 Note: The size of these fonts must be exactly twice as wide as the one
3485 specified with 'guifont' and the same height.
3486
3487 All GUI versions but GTK+ 2:
3488
3489 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3490 'guifontset' is empty or invalid.
3491 When 'guifont' is set and a valid font is found in it and
3492 'guifontwide' is empty Vim will attempt to find a matching
3493 double-width font and set 'guifontwide' to it.
3494
3495 GTK+ 2 GUI only: *guifontwide_gtk2*
3496
3497 If set and valid, 'guifontwide' is always used for double width
3498 characters, even if 'encoding' is not set to "utf-8".
3499 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003500 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 font for characters not available in 'guifont'. Thus you do not need
3502 to set 'guifontwide' at all unless you want to override the choice
3503 made by Pango/Xft.
3504
3505 *'guiheadroom'* *'ghr'*
3506'guiheadroom' 'ghr' number (default 50)
3507 global
3508 {not in Vi} {only for GTK and X11 GUI}
3509 The number of pixels subtracted from the screen height when fitting
3510 the GUI window on the screen. Set this before the GUI is started,
3511 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003512 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 lines will be left for window decorations and other items on the
3514 screen. Set it to a negative value to allow windows taller than the
3515 screen.
3516
3517 *'guioptions'* *'go'*
3518'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003519 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 global
3521 {not in Vi}
3522 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003523 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524 sequence of letters which describes what components and options of the
3525 GUI should be used.
3526 To avoid problems with flags that are added in the future, use the
3527 "+=" and "-=" feature of ":set" |add-option-flags|.
3528
3529 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003530 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531 'a' Autoselect: If present, then whenever VISUAL mode is started,
3532 or the Visual area extended, Vim tries to become the owner of
3533 the windowing system's global selection. This means that the
3534 Visually highlighted text is available for pasting into other
3535 applications as well as into Vim itself. When the Visual mode
3536 ends, possibly due to an operation on the text, or when an
3537 application wants to paste the selection, the highlighted text
3538 is automatically yanked into the "* selection register.
3539 Thus the selection is still available for pasting into other
3540 applications after the VISUAL mode has ended.
3541 If not present, then Vim won't become the owner of the
3542 windowing system's global selection unless explicitly told to
3543 by a yank or delete operation for the "* register.
3544 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003545 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003546 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 applies to the modeless selection.
3548
3549 'guioptions' autoselect Visual autoselect modeless ~
3550 "" - -
3551 "a" yes yes
3552 "A" - yes
3553 "aA" yes yes
3554
Bram Moolenaar02467872007-05-06 13:22:01 +00003555 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 'c' Use console dialogs instead of popup dialogs for simple
3557 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003558 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003559 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003560 'guitablabel' can be used to change the text in the labels.
3561 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003562 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003563 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003564 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003565 'f' Foreground: Don't use fork() to detach the GUI from the shell
3566 where it was started. Use this for programs that wait for the
3567 editor to finish (e.g., an e-mail program). Alternatively you
3568 can use "gvim -f" or ":gui -f" to start the GUI in the
3569 foreground. |gui-fork|
3570 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003571 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003572 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3574 corner of the window. It's black&white on non-GTK, because of
3575 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003576 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003578 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003579 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003581 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 file is sourced the system menu has already been loaded; the
3583 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003584 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 'g' Grey menu items: Make menu items that are not active grey. If
3586 'g' is not included inactive menu items are not shown at all.
3587 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003588 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 't' Include tearoff menu items. Currently only works for Win32,
3590 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003591 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003592 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003593 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003594 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003596 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597 'R' Right-hand scrollbar is present when there is a vertically
3598 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003599 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003601 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 'L' Left-hand scrollbar is present when there is a vertically
3603 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003604 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3606 the longest visible line, or on the cursor line if the 'h'
3607 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003608 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609 'h' Limit horizontal scrollbar size to the length of the cursor
3610 line. Reduces computations. |gui-horiz-scroll|
3611
3612 And yes, you may even have scrollbars on the left AND the right if
3613 you really want to :-). See |gui-scrollbars| for more information.
3614
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003615 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 'v' Use a vertical button layout for dialogs. When not included,
3617 a horizontal layout is preferred, but when it doesn't fit a
3618 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003619 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620 'p' Use Pointer callbacks for X11 GUI. This is required for some
3621 window managers. If the cursor is not blinking or hollow at
3622 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003623 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003625 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003626 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627
Bram Moolenaar02467872007-05-06 13:22:01 +00003628
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629 *'guipty'* *'noguipty'*
3630'guipty' boolean (default on)
3631 global
3632 {not in Vi}
3633 {only available when compiled with GUI enabled}
3634 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3635 I/O to/from shell commands. See |gui-pty|.
3636
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003637 *'guitablabel'* *'gtl'*
3638'guitablabel' 'gtl' string (default empty)
3639 global
3640 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003641 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003642 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003643 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003644 pages line. When empty and when the result is empty Vim will use a
3645 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003646
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003647 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003648 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003649
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003650 Only used when the GUI tab pages line is displayed. 'e' must be
3651 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3652 used.
3653
Bram Moolenaar57657d82006-04-21 22:12:41 +00003654 *'guitabtooltip'* *'gtt'*
3655'guitabtooltip' 'gtt' string (default empty)
3656 global
3657 {not in Vi}
3658 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003659 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003660 When nonempty describes the text to use in a tooltip for the GUI tab
3661 pages line. When empty Vim will use a default tooltip.
3662 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003663 You can include a line break. Simplest method is to use |:let|: >
3664 :let &guitabtooltip = "line one\nline two"
3665<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003666
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 *'helpfile'* *'hf'*
3668'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3669 (others) "$VIMRUNTIME/doc/help.txt")
3670 global
3671 {not in Vi}
3672 Name of the main help file. All distributed help files should be
3673 placed together in one directory. Additionally, all "doc" directories
3674 in 'runtimepath' will be used.
3675 Environment variables are expanded |:set_env|. For example:
3676 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003677 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678 spaces and backslashes.
3679 This option cannot be set from a |modeline| or in the |sandbox|, for
3680 security reasons.
3681
3682 *'helpheight'* *'hh'*
3683'helpheight' 'hh' number (default 20)
3684 global
3685 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003686 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 feature}
3688 Minimal initial height of the help window when it is opened with the
3689 ":help" command. The initial height of the help window is half of the
3690 current window, or (when the 'ea' option is on) the same as other
3691 windows. When the height is less than 'helpheight', the height is
3692 set to 'helpheight'. Set to zero to disable.
3693
3694 *'helplang'* *'hlg'*
3695'helplang' 'hlg' string (default: messages language or empty)
3696 global
3697 {only available when compiled with the |+multi_lang|
3698 feature}
3699 {not in Vi}
3700 Comma separated list of languages. Vim will use the first language
3701 for which the desired help can be found. The English help will always
3702 be used as a last resort. You can add "en" to prefer English over
3703 another language, but that will only find tags that exist in that
3704 language and not in the English help.
3705 Example: >
3706 :set helplang=de,it
3707< This will first search German, then Italian and finally English help
3708 files.
3709 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3710 try to find the tag in the current language before using this option.
3711 See |help-translated|.
3712
3713 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3714'hidden' 'hid' boolean (default off)
3715 global
3716 {not in Vi}
3717 When off a buffer is unloaded when it is |abandon|ed. When on a
3718 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3719 displayed in another window, it does not become hidden, of course.
3720 The commands that move through the buffer list sometimes make a buffer
3721 hidden although the 'hidden' option is off: When the buffer is
3722 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003723 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003724 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 This option is set for one command with ":hide {command}" |:hide|.
3726 WARNING: It's easy to forget that you have changes in hidden buffers.
3727 Think twice when using ":q!" or ":qa!".
3728
3729 *'highlight'* *'hl'*
3730'highlight' 'hl' string (default (as a single string):
3731 "8:SpecialKey,@:NonText,d:Directory,
3732 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3733 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003734 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3736 f:Folded,F:FoldColumn,A:DiffAdd,
3737 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003738 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003739 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003740 +:Pmenu,=:PmenuSel,
3741 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 global
3743 {not in Vi}
3744 This option can be used to set highlighting mode for various
3745 occasions. It is a comma separated list of character pairs. The
3746 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003747 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3749 |hl-NonText| @ '~' and '@' at the end of the window and
3750 characters from 'showbreak'
3751 |hl-Directory| d directories in CTRL-D listing and other special
3752 things in listings
3753 |hl-ErrorMsg| e error messages
3754 h (obsolete, ignored)
3755 |hl-IncSearch| i 'incsearch' highlighting
3756 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3757 |hl-MoreMsg| m |more-prompt|
3758 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003759 |hl-LineNr| n line number for ":number" and ":#" commands, and
3760 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003761 |hl-Question| r |hit-enter| prompt and yes/no questions
3762 |hl-StatusLine| s status line of current window |status-line|
3763 |hl-StatusLineNC| S status lines of not-current windows
3764 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3765 |hl-VertSplit| c column used to separate vertically split windows
3766 |hl-Visual| v Visual mode
3767 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3768 Selection" Only X11 Gui's |gui-x11| and
3769 |xterm-clipboard|.
3770 |hl-WarningMsg| w warning messages
3771 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3772 |hl-Folded| f line used for closed folds
3773 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003774 |hl-DiffAdd| A added line in diff mode
3775 |hl-DiffChange| C changed line in diff mode
3776 |hl-DiffDelete| D deleted line in diff mode
3777 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003779 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003780 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003781 |hl-SpellRare| R rare word |spell|
3782 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003783 |hl-Conceal| - the placeholders used for concealed characters
3784 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003785 |hl-Pmenu| + popup menu normal line
3786 |hl-PmenuSel| = popup menu normal line
3787 |hl-PmenuSbar| x popup menu scrollbar
3788 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789
3790 The display modes are:
3791 r reverse (termcap entry "mr" and "me")
3792 i italic (termcap entry "ZH" and "ZR")
3793 b bold (termcap entry "md" and "me")
3794 s standout (termcap entry "so" and "se")
3795 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003796 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 n no highlighting
3798 - no highlighting
3799 : use a highlight group
3800 The default is used for occasions that are not included.
3801 If you want to change what the display modes do, see |dos-colors|
3802 for an example.
3803 When using the ':' display mode, this must be followed by the name of
3804 a highlight group. A highlight group can be used to define any type
3805 of highlighting, including using color. See |:highlight| on how to
3806 define one. The default uses a different group for each occasion.
3807 See |highlight-default| for the default highlight groups.
3808
3809 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3810'hlsearch' 'hls' boolean (default off)
3811 global
3812 {not in Vi}
3813 {not available when compiled without the
3814 |+extra_search| feature}
3815 When there is a previous search pattern, highlight all its matches.
3816 The type of highlighting used can be set with the 'l' occasion in the
3817 'highlight' option. This uses the "Search" highlight group by
3818 default. Note that only the matching text is highlighted, any offsets
3819 are not applied.
3820 See also: 'incsearch' and |:match|.
3821 When you get bored looking at the highlighted matches, you can turn it
3822 off with |:nohlsearch|. As soon as you use a search command, the
3823 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003824 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 When the search pattern can match an end-of-line, Vim will try to
3826 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003827 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003829 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 NOTE: This option is reset when 'compatible' is set.
3831
3832 *'history'* *'hi'*
3833'history' 'hi' number (Vim default: 20, Vi default: 0)
3834 global
3835 {not in Vi}
3836 A history of ":" commands, and a history of previous search patterns
3837 are remembered. This option decides how many entries may be stored in
3838 each of these histories (see |cmdline-editing|).
3839 NOTE: This option is set to the Vi default value when 'compatible' is
3840 set and to the Vim default value when 'compatible' is reset.
3841
3842 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3843'hkmap' 'hk' boolean (default off)
3844 global
3845 {not in Vi}
3846 {only available when compiled with the |+rightleft|
3847 feature}
3848 When on, the keyboard is mapped for the Hebrew character set.
3849 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3850 toggle this option. See |rileft.txt|.
3851 NOTE: This option is reset when 'compatible' is set.
3852
3853 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3854'hkmapp' 'hkp' boolean (default off)
3855 global
3856 {not in Vi}
3857 {only available when compiled with the |+rightleft|
3858 feature}
3859 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3860 This is useful if you have a non-Hebrew keyboard.
3861 See |rileft.txt|.
3862 NOTE: This option is reset when 'compatible' is set.
3863
3864 *'icon'* *'noicon'*
3865'icon' boolean (default off, on when title can be restored)
3866 global
3867 {not in Vi}
3868 {not available when compiled without the |+title|
3869 feature}
3870 When on, the icon text of the window will be set to the value of
3871 'iconstring' (if it is not empty), or to the name of the file
3872 currently being edited. Only the last part of the name is used.
3873 Overridden by the 'iconstring' option.
3874 Only works if the terminal supports setting window icons (currently
3875 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3876 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3877 builtin termcap).
3878 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003879 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 X11.
3881
3882 *'iconstring'*
3883'iconstring' string (default "")
3884 global
3885 {not in Vi}
3886 {not available when compiled without the |+title|
3887 feature}
3888 When this option is not empty, it will be used for the icon text of
3889 the window. This happens only when the 'icon' option is on.
3890 Only works if the terminal supports setting window icon text
3891 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3892 Does not work for MS Windows.
3893 When Vim was compiled with HAVE_X11 defined, the original icon will be
3894 restored if possible |X11|.
3895 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003896 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 'titlestring' for example settings.
3898 {not available when compiled without the |+statusline| feature}
3899
3900 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3901'ignorecase' 'ic' boolean (default off)
3902 global
3903 Ignore case in search patterns. Also used when searching in the tags
3904 file.
3905 Also see 'smartcase'.
3906 Can be overruled by using "\c" or "\C" in the pattern, see
3907 |/ignorecase|.
3908
3909 *'imactivatekey'* *'imak'*
3910'imactivatekey' 'imak' string (default "")
3911 global
3912 {not in Vi}
3913 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003914 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 Specifies the key that your Input Method in X-Windows uses for
3916 activation. When this is specified correctly, vim can fully control
3917 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3918 You can't use this option to change the activation key, the option
3919 tells Vim what the key is.
3920 Format:
3921 [MODIFIER_FLAG-]KEY_STRING
3922
3923 These characters can be used for MODIFIER_FLAG (case is ignored):
3924 S Shift key
3925 L Lock key
3926 C Control key
3927 1 Mod1 key
3928 2 Mod2 key
3929 3 Mod3 key
3930 4 Mod4 key
3931 5 Mod5 key
3932 Combinations are allowed, for example "S-C-space" or "SC-space" are
3933 both shift+ctrl+space.
3934 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3935
3936 Example: >
3937 :set imactivatekey=S-space
3938< "S-space" means shift+space. This is the activation key for kinput2 +
3939 canna (Japanese), and ami (Korean).
3940
3941 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3942'imcmdline' 'imc' boolean (default off)
3943 global
3944 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003945 {only available when compiled with the |+xim|,
3946 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947 When set the Input Method is always on when starting to edit a command
3948 line, unless entering a search pattern (see 'imsearch' for that).
3949 Setting this option is useful when your input method allows entering
3950 English characters directly, e.g., when it's used to type accented
3951 characters with dead keys.
3952
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003953 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3955 global
3956 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003957 {only available when compiled with the |+xim|,
3958 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 When set the Input Method is never used. This is useful to disable
3960 the IM when it doesn't work properly.
3961 Currently this option is on by default for SGI/IRIX machines. This
3962 may change in later releases.
3963
3964 *'iminsert'* *'imi'*
3965'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3966 local to buffer
3967 {not in Vi}
3968 Specifies whether :lmap or an Input Method (IM) is to be used in
3969 Insert mode. Valid values:
3970 0 :lmap is off and IM is off
3971 1 :lmap is ON and IM is off
3972 2 :lmap is off and IM is ON
3973 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3974 or |global-ime|.
3975 To always reset the option to zero when leaving Insert mode with <Esc>
3976 this can be used: >
3977 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3978< This makes :lmap and IM turn off automatically when leaving Insert
3979 mode.
3980 Note that this option changes when using CTRL-^ in Insert mode
3981 |i_CTRL-^|.
3982 The value is set to 1 when setting 'keymap' to a valid keymap name.
3983 It is also used for the argument of commands like "r" and "f".
3984 The value 0 may not work correctly with Athena and Motif with some XIM
3985 methods. Use 'imdisable' to disable XIM then.
3986
3987 *'imsearch'* *'ims'*
3988'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3989 local to buffer
3990 {not in Vi}
3991 Specifies whether :lmap or an Input Method (IM) is to be used when
3992 entering a search pattern. Valid values:
3993 -1 the value of 'iminsert' is used, makes it look like
3994 'iminsert' is also used when typing a search pattern
3995 0 :lmap is off and IM is off
3996 1 :lmap is ON and IM is off
3997 2 :lmap is off and IM is ON
3998 Note that this option changes when using CTRL-^ in Command-line mode
3999 |c_CTRL-^|.
4000 The value is set to 1 when it is not -1 and setting the 'keymap'
4001 option to a valid keymap name.
4002 The value 0 may not work correctly with Athena and Motif with some XIM
4003 methods. Use 'imdisable' to disable XIM then.
4004
4005 *'include'* *'inc'*
4006'include' 'inc' string (default "^\s*#\s*include")
4007 global or local to buffer |global-local|
4008 {not in Vi}
4009 {not available when compiled without the
4010 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004011 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 pattern, just like for the "/" command (See |pattern|). The default
4013 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004014 "]I", "[d", etc.
4015 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004016 comes after the matched pattern. But if "\zs" appears in the pattern
4017 then the text matched from "\zs" to the end, or until "\ze" if it
4018 appears, is used as the file name. Use this to include characters
4019 that are not in 'isfname', such as a space. You can then use
4020 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004021 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022
4023 *'includeexpr'* *'inex'*
4024'includeexpr' 'inex' string (default "")
4025 local to buffer
4026 {not in Vi}
4027 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004028 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004030 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 :set includeexpr=substitute(v:fname,'\\.','/','g')
4032< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004033
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004035 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 Also used for |<cfile>|.
4037
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004038 The expression may be evaluated in the |sandbox|, see
4039 |sandbox-option|.
4040
4041 It is not allowed to change text or jump to another window while
4042 evaluating 'includeexpr' |textlock|.
4043
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4045'incsearch' 'is' boolean (default off)
4046 global
4047 {not in Vi}
4048 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004049 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004050 While typing a search command, show where the pattern, as it was typed
4051 so far, matches. The matched string is highlighted. If the pattern
4052 is invalid or not found, nothing is shown. The screen will be updated
4053 often, this is only useful on fast terminals.
4054 Note that the match will be shown, but the cursor will return to its
4055 original position when no match is found and when pressing <Esc>. You
4056 still need to finish the search command with <Enter> to move the
4057 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004058 When compiled with the |+reltime| feature Vim only searches for about
4059 half a second. With a complicated pattern and/or a lot of text the
4060 match may not be found. This is to avoid that Vim hangs while you
4061 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004062 The highlighting can be set with the 'i' flag in 'highlight'.
4063 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004064 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004065 to the command line. If 'ignorecase' and 'smartcase' are set and the
4066 command line has no uppercase characters, the added character is
4067 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004068 CTRL-R CTRL-W can be used to add the word at the end of the current
4069 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070 NOTE: This option is reset when 'compatible' is set.
4071
4072 *'indentexpr'* *'inde'*
4073'indentexpr' 'inde' string (default "")
4074 local to buffer
4075 {not in Vi}
4076 {not available when compiled without the |+cindent|
4077 or |+eval| features}
4078 Expression which is evaluated to obtain the proper indent for a line.
4079 It is used when a new line is created, for the |=| operator and
4080 in Insert mode as specified with the 'indentkeys' option.
4081 When this option is not empty, it overrules the 'cindent' and
4082 'smartindent' indenting.
4083 When 'paste' is set this option is not used for indenting.
4084 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004085 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004086 when the expression is evaluated (but it may be moved around).
4087 The expression must return the number of spaces worth of indent. It
4088 can return "-1" to keep the current indent (this means 'autoindent' is
4089 used for the indent).
4090 Functions useful for computing the indent are |indent()|, |cindent()|
4091 and |lispindent()|.
4092 The evaluation of the expression must not have side effects! It must
4093 not change the text, jump to another window, etc. Afterwards the
4094 cursor position is always restored, thus the cursor may be moved.
4095 Normally this option would be set to call a function: >
4096 :set indentexpr=GetMyIndent()
4097< Error messages will be suppressed, unless the 'debug' option contains
4098 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004099 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100 NOTE: This option is made empty when 'compatible' is set.
4101
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004102 The expression may be evaluated in the |sandbox|, see
4103 |sandbox-option|.
4104
4105 It is not allowed to change text or jump to another window while
4106 evaluating 'indentexpr' |textlock|.
4107
4108
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 *'indentkeys'* *'indk'*
4110'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4111 local to buffer
4112 {not in Vi}
4113 {not available when compiled without the |+cindent|
4114 feature}
4115 A list of keys that, when typed in Insert mode, cause reindenting of
4116 the current line. Only happens if 'indentexpr' isn't empty.
4117 The format is identical to 'cinkeys', see |indentkeys-format|.
4118 See |C-indenting| and |indent-expression|.
4119
4120 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4121'infercase' 'inf' boolean (default off)
4122 local to buffer
4123 {not in Vi}
4124 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004125 'ignorecase' is also on, the case of the match is adjusted depending
4126 on the typed text. If the typed text contains a lowercase letter
4127 where the match has an upper case letter, the completed part is made
4128 lowercase. If the typed text has no lowercase letters and the match
4129 has a lowercase letter where the typed text has an uppercase letter,
4130 and there is a letter before it, the completed part is made uppercase.
4131 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132
4133 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4134'insertmode' 'im' boolean (default off)
4135 global
4136 {not in Vi}
4137 Makes Vim work in a way that Insert mode is the default mode. Useful
4138 if you want to use Vim as a modeless editor. Used for |evim|.
4139 These Insert mode commands will be useful:
4140 - Use the cursor keys to move around.
4141 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4142 this is a mapping, it is executed as if 'insertmode' was off.
4143 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004145 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4146 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147
4148 These items change when 'insertmode' is set:
4149 - when starting to edit of a file, Vim goes to Insert mode.
4150 - <Esc> in Insert mode is a no-op and beeps.
4151 - <Esc> in Normal mode makes Vim go to Insert mode.
4152 - CTRL-L in Insert mode is a command, it is not inserted.
4153 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4154 However, when <Esc> is used inside a mapping, it behaves like
4155 'insertmode' was not set. This was done to be able to use the same
4156 mappings with 'insertmode' set or not set.
4157 When executing commands with |:normal| 'insertmode' is not used.
4158
4159 NOTE: This option is reset when 'compatible' is set.
4160
4161 *'isfname'* *'isf'*
4162'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4163 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4164 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4165 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4166 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4167 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4168 global
4169 {not in Vi}
4170 The characters specified by this option are included in file names and
4171 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004172 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 Multi-byte characters 256 and above are always included, only the
4174 characters up to 255 are specified with this option.
4175 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004176 Think twice before adding white space to this option. Although a
4177 space may appear inside a file name, the effect will be that Vim
4178 doesn't know where a file name starts or ends when doing completion.
4179 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180
4181 Note that on systems using a backslash as path separator, Vim tries to
4182 do its best to make it work as you would expect. That is a bit
4183 tricky, since Vi originally used the backslash to escape special
4184 characters. Vim will not remove a backslash in front of a normal file
4185 name character on these systems, but it will on Unix and alikes. The
4186 '&' and '^' are not included by default, because these are special for
4187 cmd.exe.
4188
4189 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004190 Each part can be a single character number or a range. A range is two
4191 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 decimal number between 0 and 255 or the ASCII character itself (does
4193 not work for digits). Example:
4194 "_,-,128-140,#-43" (include '_' and '-' and the range
4195 128 to 140 and '#' to 43)
4196 If a part starts with '^', the following character number or range
4197 will be excluded from the option. The option is interpreted from left
4198 to right. Put the excluded character after the range where it is
4199 included. To include '^' itself use it as the last character of the
4200 option or the end of a range. Example:
4201 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4202 If the character is '@', all characters where isalpha() returns TRUE
4203 are included. Normally these are the characters a to z and A to Z,
4204 plus accented characters. To include '@' itself use "@-@". Examples:
4205 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004206 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 "a-z,A-Z,@-@" All letters plus the '@' character.
4208 A comma can be included by using it where a character number is
4209 expected. Example:
4210 "48-57,,,_" Digits, comma and underscore.
4211 A comma can be excluded by prepending a '^'. Example:
4212 " -~,^,,9" All characters from space to '~', excluding
4213 comma, plus <Tab>.
4214 See |option-backslash| about including spaces and backslashes.
4215
4216 *'isident'* *'isi'*
4217'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4218 "@,48-57,_,128-167,224-235"
4219 otherwise: "@,48-57,_,192-255")
4220 global
4221 {not in Vi}
4222 The characters given by this option are included in identifiers.
4223 Identifiers are used in recognizing environment variables and after a
4224 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004225 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226 option.
4227 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004228 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4230
4231 *'iskeyword'* *'isk'*
4232'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4233 "@,48-57,_,128-167,224-235"
4234 otherwise: "@,48-57,_,192-255"
4235 Vi default: "@,48-57,_")
4236 local to buffer
4237 {not in Vi}
4238 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004239 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 'isfname' for a description of the format of this option. For C
4241 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4242 For a help file it is set to all non-blank printable characters except
4243 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4244 command).
4245 When the 'lisp' option is on the '-' character is always included.
4246 NOTE: This option is set to the Vi default value when 'compatible' is
4247 set and to the Vim default value when 'compatible' is reset.
4248
4249 *'isprint'* *'isp'*
4250'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4251 "@,~-255"; otherwise: "@,161-255")
4252 global
4253 {not in Vi}
4254 The characters given by this option are displayed directly on the
4255 screen. It is also used for "\p" in a |pattern|. The characters from
4256 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4257 even when they are not included in 'isprint' or excluded. See
4258 'isfname' for a description of the format of this option.
4259
4260 Non-printable characters are displayed with two characters:
4261 0 - 31 "^@" - "^_"
4262 32 - 126 always single characters
4263 127 "^?"
4264 128 - 159 "~@" - "~_"
4265 160 - 254 "| " - "|~"
4266 255 "~?"
4267 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4268 displayed as <xx>, with the hexadecimal value of the byte.
4269 When 'display' contains "uhex" all unprintable characters are
4270 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004271 The SpecialKey highlighting will be used for unprintable characters.
4272 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273
4274 Multi-byte characters 256 and above are always included, only the
4275 characters up to 255 are specified with this option. When a character
4276 is printable but it is not available in the current font, a
4277 replacement character will be shown.
4278 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4279 There is no option to specify these characters.
4280
4281 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4282'joinspaces' 'js' boolean (default on)
4283 global
4284 {not in Vi}
4285 Insert two spaces after a '.', '?' and '!' with a join command.
4286 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4287 Otherwise only one space is inserted.
4288 NOTE: This option is set when 'compatible' is set.
4289
4290 *'key'*
4291'key' string (default "")
4292 local to buffer
4293 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004294 {only available when compiled with the |+cryptv|
4295 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004297 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 Careful: Do not set the key value by hand, someone might see the typed
4299 key. Use the |:X| command. But you can make 'key' empty: >
4300 :set key=
4301< It is not possible to get the value of this option with ":set key" or
4302 "echo &key". This is to avoid showing it to someone who shouldn't
4303 know. It also means you cannot see it yourself once you have set it,
4304 be careful not to make a typing error!
4305
4306 *'keymap'* *'kmp'* *E544*
4307'keymap' 'kmp' string (default "")
4308 local to buffer
4309 {not in Vi}
4310 {only available when compiled with the |+keymap|
4311 feature}
4312 Name of a keyboard mapping. See |mbyte-keymap|.
4313 Setting this option to a valid keymap name has the side effect of
4314 setting 'iminsert' to one, so that the keymap becomes effective.
4315 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004316 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317
4318 *'keymodel'* *'km'*
4319'keymodel' 'km' string (default "")
4320 global
4321 {not in Vi}
4322 List of comma separated words, which enable special things that keys
4323 can do. These values can be used:
4324 startsel Using a shifted special key starts selection (either
4325 Select mode or Visual mode, depending on "key" being
4326 present in 'selectmode').
4327 stopsel Using a not-shifted special key stops selection.
4328 Special keys in this context are the cursor keys, <End>, <Home>,
4329 <PageUp> and <PageDown>.
4330 The 'keymodel' option is set by the |:behave| command.
4331
4332 *'keywordprg'* *'kp'*
4333'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4334 OS/2: "view /", VMS: "help")
4335 global or local to buffer |global-local|
4336 {not in Vi}
4337 Program to use for the |K| command. Environment variables are
4338 expanded |:set_env|. ":help" may be used to access the Vim internal
4339 help. (Note that previously setting the global option to the empty
4340 value did this, which is now deprecated.)
4341 When "man" is used, Vim will automatically translate a count for the
4342 "K" command to a section number. Also for "man -s", in which case the
4343 "-s" is removed when there is no count.
4344 See |option-backslash| about including spaces and backslashes.
4345 Example: >
4346 :set keywordprg=man\ -s
4347< This option cannot be set from a |modeline| or in the |sandbox|, for
4348 security reasons.
4349
4350 *'langmap'* *'lmap'* *E357* *E358*
4351'langmap' 'lmap' string (default "")
4352 global
4353 {not in Vi}
4354 {only available when compiled with the |+langmap|
4355 feature}
4356 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004357 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 inserted directly. When in command mode the 'langmap' option takes
4359 care of translating these special characters to the original meaning
4360 of the key. This means you don't have to change the keyboard mode to
4361 be able to execute Normal mode commands.
4362 This is the opposite of the 'keymap' option, where characters are
4363 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004365 Example (for Greek, in UTF-8): *greek* >
4366 :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 +00004367< Example (exchanges meaning of z and y for commands): >
4368 :set langmap=zy,yz,ZY,YZ
4369<
4370 The 'langmap' option is a list of parts, separated with commas. Each
4371 part can be in one of two forms:
4372 1. A list of pairs. Each pair is a "from" character immediately
4373 followed by the "to" character. Examples: "aA", "aAbBcC".
4374 2. A list of "from" characters, a semi-colon and a list of "to"
4375 characters. Example: "abc;ABC"
4376 Example: "aA,fgh;FGH,cCdDeE"
4377 Special characters need to be preceded with a backslash. These are
4378 ";", ',' and backslash itself.
4379
4380 This will allow you to activate vim actions without having to switch
4381 back and forth between the languages. Your language characters will
4382 be understood as normal vim English characters (according to the
4383 langmap mappings) in the following cases:
4384 o Normal/Visual mode (commands, buffer/register names, user mappings)
4385 o Insert/Replace Mode: Register names after CTRL-R
4386 o Insert/Replace Mode: Mappings
4387 Characters entered in Command-line mode will NOT be affected by
4388 this option. Note that this option can be changed at any time
4389 allowing to switch between mappings for different languages/encodings.
4390 Use a mapping to avoid having to type it each time!
4391
4392 *'langmenu'* *'lm'*
4393'langmenu' 'lm' string (default "")
4394 global
4395 {not in Vi}
4396 {only available when compiled with the |+menu| and
4397 |+multi_lang| features}
4398 Language to use for menu translation. Tells which file is loaded
4399 from the "lang" directory in 'runtimepath': >
4400 "lang/menu_" . &langmenu . ".vim"
4401< (without the spaces). For example, to always use the Dutch menus, no
4402 matter what $LANG is set to: >
4403 :set langmenu=nl_NL.ISO_8859-1
4404< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004405 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 If your $LANG is set to a non-English language but you do want to use
4407 the English menus: >
4408 :set langmenu=none
4409< This option must be set before loading menus, switching on filetype
4410 detection or syntax highlighting. Once the menus are defined setting
4411 this option has no effect. But you could do this: >
4412 :source $VIMRUNTIME/delmenu.vim
4413 :set langmenu=de_DE.ISO_8859-1
4414 :source $VIMRUNTIME/menu.vim
4415< Warning: This deletes all menus that you defined yourself!
4416
4417 *'laststatus'* *'ls'*
4418'laststatus' 'ls' number (default 1)
4419 global
4420 {not in Vi}
4421 The value of this option influences when the last window will have a
4422 status line:
4423 0: never
4424 1: only if there are at least two windows
4425 2: always
4426 The screen looks nicer with a status line if you have several
4427 windows, but it takes another screen line. |status-line|
4428
4429 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4430'lazyredraw' 'lz' boolean (default off)
4431 global
4432 {not in Vi}
4433 When this option is set, the screen will not be redrawn while
4434 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004435 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 update use |:redraw|.
4437
4438 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4439'linebreak' 'lbr' boolean (default off)
4440 local to window
4441 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004442 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 feature}
4444 If on Vim will wrap long lines at a character in 'breakat' rather
4445 than at the last character that fits on the screen. Unlike
4446 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4447 it only affects the way the file is displayed, not its contents. The
4448 value of 'showbreak' is used to put in front of wrapped lines.
4449 This option is not used when the 'wrap' option is off or 'list' is on.
4450 Note that <Tab> characters after an <EOL> are mostly not displayed
4451 with the right amount of white space.
4452
4453 *'lines'* *E593*
4454'lines' number (default 24 or terminal height)
4455 global
4456 Number of lines of the Vim window.
4457 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004458 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459 When Vim is running in the GUI or in a resizable window, setting this
4460 option will cause the window size to be changed. When you only want
4461 to use the size for the GUI, put the command in your |gvimrc| file.
4462 Vim limits the number of lines to what fits on the screen. You can
4463 use this command to get the tallest window possible: >
4464 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004465< Minimum value is 2, maximum value is 1000.
4466 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004467 When you set this option and Vim is unable to change the physical
4468 number of lines of the display, the display may be messed up.
4469
4470 *'linespace'* *'lsp'*
4471'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4472 global
4473 {not in Vi}
4474 {only in the GUI}
4475 Number of pixel lines inserted between characters. Useful if the font
4476 uses the full character cell height, making lines touch each other.
4477 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004478 With some fonts there can be too much room between lines (to have
4479 space for ascents and descents). Then it makes sense to set
4480 'linespace' to a negative value. This may cause display problems
4481 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482
4483 *'lisp'* *'nolisp'*
4484'lisp' boolean (default off)
4485 local to buffer
4486 {not available when compiled without the |+lispindent|
4487 feature}
4488 Lisp mode: When <Enter> is typed in insert mode set the indent for
4489 the next line to Lisp standards (well, sort of). Also happens with
4490 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4491 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4492 better. Also see 'lispwords'.
4493 The '-' character is included in keyword characters. Redefines the
4494 "=" operator to use this same indentation algorithm rather than
4495 calling an external program if 'equalprg' is empty.
4496 This option is not used when 'paste' is set.
4497 {Vi: Does it a little bit differently}
4498
4499 *'lispwords'* *'lw'*
4500'lispwords' 'lw' string (default is very long)
4501 global
4502 {not in Vi}
4503 {not available when compiled without the |+lispindent|
4504 feature}
4505 Comma separated list of words that influence the Lisp indenting.
4506 |'lisp'|
4507
4508 *'list'* *'nolist'*
4509'list' boolean (default off)
4510 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004511 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4512 line. Useful to see the difference between tabs and spaces and for
4513 trailing blanks. Further changed by the 'listchars' option.
4514
4515 The cursor is displayed at the start of the space a Tab character
4516 occupies, not at the end as usual in Normal mode. To get this cursor
4517 position while displaying Tabs with spaces, use: >
4518 :set list lcs=tab\ \
4519<
4520 Note that list mode will also affect formatting (set with 'textwidth'
4521 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 changing the way tabs are displayed.
4523
4524 *'listchars'* *'lcs'*
4525'listchars' 'lcs' string (default "eol:$")
4526 global
4527 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004528 Strings to use in 'list' mode and for the |:list| command. It is a
4529 comma separated list of string settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 eol:c Character to show at the end of each line. When
4531 omitted, there is no extra character at the end of the
4532 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004533 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004535 fill the space that the tab normally occupies.
4536 "tab:>-" will show a tab that takes four spaces as
4537 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004538 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 trailing spaces are blank.
4540 extends:c Character to show in the last column, when 'wrap' is
4541 off and the line continues beyond the right of the
4542 screen.
4543 precedes:c Character to show in the first column, when 'wrap'
4544 is off and there is text preceding the character
4545 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004546 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004547 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004548 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004549 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004551 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004553 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554
4555 Examples: >
4556 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004557 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 :set lcs=extends:>,precedes:<
4559< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004560 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004561 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562
4563 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4564'loadplugins' 'lpl' boolean (default on)
4565 global
4566 {not in Vi}
4567 When on the plugin scripts are loaded when starting up |load-plugins|.
4568 This option can be reset in your |vimrc| file to disable the loading
4569 of plugins.
4570 Note that using the "-u NONE" and "--noplugin" command line arguments
4571 reset this option. |-u| |--noplugin|
4572
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004573 *'macatsui'* *'nomacatsui'*
4574'macatsui' boolean (default on)
4575 global
4576 {only available in Mac GUI version}
4577 This is a workaround for when drawing doesn't work properly. When set
4578 and compiled with multi-byte support ATSUI text drawing is used. When
4579 not set ATSUI text drawing is not used. Switch this option off when
4580 you experience drawing problems. In a future version the problems may
4581 be solved and this option becomes obsolete. Therefore use this method
4582 to unset it: >
4583 if exists('&macatsui')
4584 set nomacatsui
4585 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004586< Another option to check if you have drawing problems is
4587 'termencoding'.
4588
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 *'magic'* *'nomagic'*
4590'magic' boolean (default on)
4591 global
4592 Changes the special characters that can be used in search patterns.
4593 See |pattern|.
4594 NOTE: To avoid portability problems with using patterns, always keep
4595 this option at the default "on". Only switch it off when working with
4596 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004597 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598
4599 *'makeef'* *'mef'*
4600'makeef' 'mef' string (default: "")
4601 global
4602 {not in Vi}
4603 {not available when compiled without the |+quickfix|
4604 feature}
4605 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4606 and the |:grep| command.
4607 When it is empty, an internally generated temp file will be used.
4608 When "##" is included, it is replaced by a number to make the name
4609 unique. This makes sure that the ":make" command doesn't overwrite an
4610 existing file.
4611 NOT used for the ":cf" command. See 'errorfile' for that.
4612 Environment variables are expanded |:set_env|.
4613 See |option-backslash| about including spaces and backslashes.
4614 This option cannot be set from a |modeline| or in the |sandbox|, for
4615 security reasons.
4616
4617 *'makeprg'* *'mp'*
4618'makeprg' 'mp' string (default "make", VMS: "MMS")
4619 global or local to buffer |global-local|
4620 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004621 Program to use for the ":make" command. See |:make_makeprg|.
4622 This option may contain '%' and '#' characters, which are expanded to
4623 the current and alternate file name. |:_%| |:_#|
4624 Environment variables are expanded |:set_env|. See |option-backslash|
4625 about including spaces and backslashes.
4626 Note that a '|' must be escaped twice: once for ":set" and once for
4627 the interpretation of a command. When you use a filter called
4628 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 :set makeprg=gmake\ \\\|\ myfilter
4630< The placeholder "$*" can be given (even multiple times) to specify
4631 where the arguments will be included, for example: >
4632 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4633< This option cannot be set from a |modeline| or in the |sandbox|, for
4634 security reasons.
4635
4636 *'matchpairs'* *'mps'*
4637'matchpairs' 'mps' string (default "(:),{:},[:]")
4638 local to buffer
4639 {not in Vi}
4640 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004641 other. Currently only single byte character pairs are allowed, and
4642 they must be different. The characters must be separated by a colon.
4643 The pairs must be separated by a comma. Example for including '<' and
4644 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645 :set mps+=<:>
4646
4647< A more exotic example, to jump between the '=' and ';' in an
4648 assignment, useful for languages like C and Java: >
4649 :au FileType c,cpp,java set mps+==:;
4650
4651< For a more advanced way of using "%", see the matchit.vim plugin in
4652 the $VIMRUNTIME/macros directory. |add-local-help|
4653
4654 *'matchtime'* *'mat'*
4655'matchtime' 'mat' number (default 5)
4656 global
4657 {not in Vi}{in Nvi}
4658 Tenths of a second to show the matching paren, when 'showmatch' is
4659 set. Note that this is not in milliseconds, like other options that
4660 set a time. This is to be compatible with Nvi.
4661
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004662 *'maxcombine'* *'mco'*
4663'maxcombine' 'mco' number (default 2)
4664 global
4665 {not in Vi}
4666 {only available when compiled with the |+multi_byte|
4667 feature}
4668 The maximum number of combining characters supported for displaying.
4669 Only used when 'encoding' is "utf-8".
4670 The default is OK for most languages. Hebrew may require 4.
4671 Maximum value is 6.
4672 Even when this option is set to 2 you can still edit text with more
4673 combining characters, you just can't see them. Use |g8| or |ga|.
4674 See |mbyte-combining|.
4675
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 *'maxfuncdepth'* *'mfd'*
4677'maxfuncdepth' 'mfd' number (default 100)
4678 global
4679 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004680 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004681 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 Maximum depth of function calls for user functions. This normally
4683 catches endless recursion. When using a recursive function with
4684 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4685 more memory, there is the danger of failing when memory is exhausted.
4686 See also |:function|.
4687
4688 *'maxmapdepth'* *'mmd'* *E223*
4689'maxmapdepth' 'mmd' number (default 1000)
4690 global
4691 {not in Vi}
4692 Maximum number of times a mapping is done without resulting in a
4693 character to be used. This normally catches endless mappings, like
4694 ":map x y" with ":map y x". It still does not catch ":map g wg",
4695 because the 'w' is used before the next mapping is done. See also
4696 |key-mapping|.
4697
4698 *'maxmem'* *'mm'*
4699'maxmem' 'mm' number (default between 256 to 5120 (system
4700 dependent) or half the amount of memory
4701 available)
4702 global
4703 {not in Vi}
4704 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4705 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004706 other memory to be freed. The maximum usable value is about 2000000.
4707 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004708
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004709 *'maxmempattern'* *'mmp'*
4710'maxmempattern' 'mmp' number (default 1000)
4711 global
4712 {not in Vi}
4713 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004714 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004715 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004716 When Vim runs into the limit it gives an error message and mostly
4717 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004718 Running into the limit often means that the pattern is very
4719 inefficient or too complex. This may already happen with the pattern
4720 "\(.\)*" on a very long line. ".*" works much better.
4721 Vim may run out of memory before hitting the 'maxmempattern' limit.
4722
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 *'maxmemtot'* *'mmt'*
4724'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4725 dependent) or half the amount of memory
4726 available)
4727 global
4728 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004729 Maximum amount of memory in Kbyte to use for all buffers together.
4730 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4731 without a limit. On 64 bit machines higher values might work. But
4732 hey, do you really need more than 2 Gbyte for text editing?
4733 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734
4735 *'menuitems'* *'mis'*
4736'menuitems' 'mis' number (default 25)
4737 global
4738 {not in Vi}
4739 {not available when compiled without the |+menu|
4740 feature}
4741 Maximum number of items to use in a menu. Used for menus that are
4742 generated from a list of items, e.g., the Buffers menu. Changing this
4743 option has no direct effect, the menu must be refreshed first.
4744
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004745 *'mkspellmem'* *'msm'*
4746'mkspellmem' 'msm' string (default "460000,2000,500")
4747 global
4748 {not in Vi}
4749 {not available when compiled without the |+syntax|
4750 feature}
4751 Parameters for |:mkspell|. This tunes when to start compressing the
4752 word tree. Compression can be slow when there are many words, but
4753 it's needed to avoid running out of memory. The amount of memory used
4754 per word depends very much on how similar the words are, that's why
4755 this tuning is complicated.
4756
4757 There are three numbers, separated by commas:
4758 {start},{inc},{added}
4759
4760 For most languages the uncompressed word tree fits in memory. {start}
4761 gives the amount of memory in Kbyte that can be used before any
4762 compression is done. It should be a bit smaller than the amount of
4763 memory that is available to Vim.
4764
4765 When going over the {start} limit the {inc} number specifies the
4766 amount of memory in Kbyte that can be allocated before another
4767 compression is done. A low number means compression is done after
4768 less words are added, which is slow. A high number means more memory
4769 will be allocated.
4770
4771 After doing compression, {added} times 1024 words can be added before
4772 the {inc} limit is ignored and compression is done when any extra
4773 amount of memory is needed. A low number means there is a smaller
4774 chance of hitting the {inc} limit, less memory is used but it's
4775 slower.
4776
4777 The languages for which these numbers are important are Italian and
4778 Hungarian. The default works for when you have about 512 Mbyte. If
4779 you have 1 Gbyte you could use: >
4780 :set mkspellmem=900000,3000,800
4781< If you have less than 512 Mbyte |:mkspell| may fail for some
4782 languages, no matter what you set 'mkspellmem' to.
4783
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004785'modeline' 'ml' boolean (Vim default: on (off for root),
4786 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787 local to buffer
4788 *'modelines'* *'mls'*
4789'modelines' 'mls' number (default 5)
4790 global
4791 {not in Vi}
4792 If 'modeline' is on 'modelines' gives the number of lines that is
4793 checked for set commands. If 'modeline' is off or 'modelines' is zero
4794 no lines are checked. See |modeline|.
4795 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4796 set and to the Vim default value when 'compatible' is reset.
4797
4798 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4799'modifiable' 'ma' boolean (default on)
4800 local to buffer
4801 {not in Vi} *E21*
4802 When off the buffer contents cannot be changed. The 'fileformat' and
4803 'fileencoding' options also can't be changed.
4804 Can be reset with the |-M| command line argument.
4805
4806 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4807'modified' 'mod' boolean (default off)
4808 local to buffer
4809 {not in Vi}
4810 When on, the buffer is considered to be modified. This option is set
4811 when:
4812 1. A change was made to the text since it was last written. Using the
4813 |undo| command to go back to the original text will reset the
4814 option. But undoing changes that were made before writing the
4815 buffer will set the option again, since the text is different from
4816 when it was written.
4817 2. 'fileformat' or 'fileencoding' is different from its original
4818 value. The original value is set when the buffer is read or
4819 written. A ":set nomodified" command also resets the original
4820 values to the current values and the 'modified' option will be
4821 reset.
4822 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4823 will be ignored.
4824
4825 *'more'* *'nomore'*
4826'more' boolean (Vim default: on, Vi default: off)
4827 global
4828 {not in Vi}
4829 When on, listings pause when the whole screen is filled. You will get
4830 the |more-prompt|. When this option is off there are no pauses, the
4831 listing continues until finished.
4832 NOTE: This option is set to the Vi default value when 'compatible' is
4833 set and to the Vim default value when 'compatible' is reset.
4834
4835 *'mouse'* *E538*
4836'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4837 global
4838 {not in Vi}
4839 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004840 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4841 sysmouse and Linux console with gpm). For using the mouse in the
4842 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843 The mouse can be enabled for different modes:
4844 n Normal mode
4845 v Visual mode
4846 i Insert mode
4847 c Command-line mode
4848 h all previous modes when editing a help file
4849 a all previous modes
4850 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 Normally you would enable the mouse in all four modes with: >
4852 :set mouse=a
4853< When the mouse is not enabled, the GUI will still use the mouse for
4854 modeless selection. This doesn't move the text cursor.
4855
4856 See |mouse-using|. Also see |'clipboard'|.
4857
4858 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004859 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 the mouse buttons can still be used by keeping the shift key pressed.
4861 Also see the 'clipboard' option.
4862
4863 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4864'mousefocus' 'mousef' boolean (default off)
4865 global
4866 {not in Vi}
4867 {only works in the GUI}
4868 The window that the mouse pointer is on is automatically activated.
4869 When changing the window layout or window focus in another way, the
4870 mouse pointer is moved to the window with keyboard focus. Off is the
4871 default because it makes using the pull down menus a little goofy, as
4872 a pointer transit may activate a window unintentionally.
4873
4874 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4875'mousehide' 'mh' boolean (default on)
4876 global
4877 {not in Vi}
4878 {only works in the GUI}
4879 When on, the mouse pointer is hidden when characters are typed.
4880 The mouse pointer is restored when the mouse is moved.
4881
4882 *'mousemodel'* *'mousem'*
4883'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4884 global
4885 {not in Vi}
4886 Sets the model to use for the mouse. The name mostly specifies what
4887 the right mouse button is used for:
4888 extend Right mouse button extends a selection. This works
4889 like in an xterm.
4890 popup Right mouse button pops up a menu. The shifted left
4891 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004892 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893 popup_setpos Like "popup", but the cursor will be moved to the
4894 position where the mouse was clicked, and thus the
4895 selected operation will act upon the clicked object.
4896 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004897 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898 course, that right clicking outside a selection will
4899 end Visual mode.
4900 Overview of what button does what for each model:
4901 mouse extend popup(_setpos) ~
4902 left click place cursor place cursor
4903 left drag start selection start selection
4904 shift-left search word extend selection
4905 right click extend selection popup menu (place cursor)
4906 right drag extend selection -
4907 middle click paste paste
4908
4909 In the "popup" model the right mouse button produces a pop-up menu.
4910 You need to define this first, see |popup-menu|.
4911
4912 Note that you can further refine the meaning of buttons with mappings.
4913 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4914 selection (because that's handled in the GUI code directly).
4915
4916 The 'mousemodel' option is set by the |:behave| command.
4917
4918 *'mouseshape'* *'mouses'* *E547*
4919'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004920 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921 global
4922 {not in Vi}
4923 {only available when compiled with the |+mouseshape|
4924 feature}
4925 This option tells Vim what the mouse pointer should look like in
4926 different modes. The option is a comma separated list of parts, much
4927 like used for 'guicursor'. Each part consist of a mode/location-list
4928 and an argument-list:
4929 mode-list:shape,mode-list:shape,..
4930 The mode-list is a dash separated list of these modes/locations:
4931 In a normal window: ~
4932 n Normal mode
4933 v Visual mode
4934 ve Visual mode with 'selection' "exclusive" (same as 'v',
4935 if not specified)
4936 o Operator-pending mode
4937 i Insert mode
4938 r Replace mode
4939
4940 Others: ~
4941 c appending to the command-line
4942 ci inserting in the command-line
4943 cr replacing in the command-line
4944 m at the 'Hit ENTER' or 'More' prompts
4945 ml idem, but cursor in the last line
4946 e any mode, pointer below last window
4947 s any mode, pointer on a status line
4948 sd any mode, while dragging a status line
4949 vs any mode, pointer on a vertical separator line
4950 vd any mode, while dragging a vertical separator line
4951 a everywhere
4952
4953 The shape is one of the following:
4954 avail name looks like ~
4955 w x arrow Normal mouse pointer
4956 w x blank no pointer at all (use with care!)
4957 w x beam I-beam
4958 w x updown up-down sizing arrows
4959 w x leftright left-right sizing arrows
4960 w x busy The system's usual busy pointer
4961 w x no The system's usual 'no input' pointer
4962 x udsizing indicates up-down resizing
4963 x lrsizing indicates left-right resizing
4964 x crosshair like a big thin +
4965 x hand1 black hand
4966 x hand2 white hand
4967 x pencil what you write with
4968 x question big ?
4969 x rightup-arrow arrow pointing right-up
4970 w x up-arrow arrow pointing up
4971 x <number> any X11 pointer number (see X11/cursorfont.h)
4972
4973 The "avail" column contains a 'w' if the shape is available for Win32,
4974 x for X11.
4975 Any modes not specified or shapes not available use the normal mouse
4976 pointer.
4977
4978 Example: >
4979 :set mouseshape=s:udsizing,m:no
4980< will make the mouse turn to a sizing arrow over the status lines and
4981 indicate no input when the hit-enter prompt is displayed (since
4982 clicking the mouse has no effect in this state.)
4983
4984 *'mousetime'* *'mouset'*
4985'mousetime' 'mouset' number (default 500)
4986 global
4987 {not in Vi}
4988 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4989 time in msec between two mouse clicks for the second click to be
4990 recognized as a multi click.
4991
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004992 *'mzquantum'* *'mzq'*
4993'mzquantum' 'mzq' number (default 100)
4994 global
4995 {not in Vi}
4996 {not available when compiled without the |+mzscheme|
4997 feature}
4998 The number of milliseconds between polls for MzScheme threads.
4999 Negative or zero value means no thread scheduling.
5000
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 *'nrformats'* *'nf'*
5002'nrformats' 'nf' string (default "octal,hex")
5003 local to buffer
5004 {not in Vi}
5005 This defines what bases Vim will consider for numbers when using the
5006 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5007 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005008 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02005010 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005011 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005013 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005014 considered to be hexadecimal. Example: Using CTRL-X on
5015 "0x100" results in "0x0ff".
5016 Numbers which simply begin with a digit in the range 1-9 are always
5017 considered decimal. This also happens for numbers that are not
5018 recognized as octal or hex.
5019
5020 *'number'* *'nu'* *'nonumber'* *'nonu'*
5021'number' 'nu' boolean (default off)
5022 local to window
5023 Print the line number in front of each line. When the 'n' option is
5024 excluded from 'cpoptions' a wrapped line will not use the column of
5025 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005026 The 'numberwidth' option can be used to set the room used for the line
5027 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005028 When a long, wrapped line doesn't start with the first character, '-'
5029 characters are put before the number.
5030 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005031 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005032
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005033 *'numberwidth'* *'nuw'*
5034'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5035 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005036 {not in Vi}
5037 {only available when compiled with the |+linebreak|
5038 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005039 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005040 when the 'number' or 'relativenumber' option is set or printing lines
5041 with a line number. Since one space is always between the number and
5042 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005043 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005044 fit the highest line number in the buffer respectively the number of
5045 rows in the window, depending on whether 'number' or 'relativenumber'
5046 is set. Thus with the Vim default of 4 there is room for a line number
5047 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005048 The minimum value is 1, the maximum value is 10.
5049 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5050
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005051 *'omnifunc'* *'ofu'*
5052'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005053 local to buffer
5054 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005055 {not available when compiled without the |+eval|
5056 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005057 This option specifies a function to be used for Insert mode omni
5058 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005059 See |complete-functions| for an explanation of how the function is
5060 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005061 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005062 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005063
5064
Bram Moolenaar02467872007-05-06 13:22:01 +00005065 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005066'opendevice' 'odev' boolean (default off)
5067 global
5068 {not in Vi}
5069 {only for MS-DOS, MS-Windows and OS/2}
5070 Enable reading and writing from devices. This may get Vim stuck on a
5071 device that can be opened but doesn't actually do the I/O. Therefore
5072 it is off by default.
5073 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5074 result in editing a device.
5075
5076
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005077 *'operatorfunc'* *'opfunc'*
5078'operatorfunc' 'opfunc' string (default: empty)
5079 global
5080 {not in Vi}
5081 This option specifies a function to be called by the |g@| operator.
5082 See |:map-operator| for more info and an example.
5083
5084 This option cannot be set from a |modeline| or in the |sandbox|, for
5085 security reasons.
5086
5087
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 *'osfiletype'* *'oft'* *E366*
5089'osfiletype' 'oft' string (RISC-OS default: "Text",
5090 others default: "")
5091 local to buffer
5092 {not in Vi}
5093 {only available when compiled with the |+osfiletype|
5094 feature}
5095 Some operating systems store extra information about files besides
5096 name, datestamp and permissions. This option contains the extra
5097 information, the nature of which will vary between systems.
5098 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005099 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 It can affect the pattern matching of the automatic commands.
5101 |autocmd-osfiletypes|
5102
5103 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005104'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105 global
5106 Specifies the nroff macros that separate paragraphs. These are pairs
5107 of two letters (see |object-motions|).
5108
5109 *'paste'* *'nopaste'*
5110'paste' boolean (default off)
5111 global
5112 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005113 Put Vim in Paste mode. This is useful if you want to cut or copy
5114 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115 unexpected effects.
5116 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005117 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118 knows about pasting and will mostly do the right thing without 'paste'
5119 being set. The same is true for a terminal where Vim handles the
5120 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005121 This option is reset when starting the GUI. Thus if you set it in
5122 your .vimrc it will work in a terminal, but not in the GUI. Setting
5123 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5124 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125 When the 'paste' option is switched on (also when it was already on):
5126 - mapping in Insert mode and Command-line mode is disabled
5127 - abbreviations are disabled
5128 - 'textwidth' is set to 0
5129 - 'wrapmargin' is set to 0
5130 - 'autoindent' is reset
5131 - 'smartindent' is reset
5132 - 'softtabstop' is set to 0
5133 - 'revins' is reset
5134 - 'ruler' is reset
5135 - 'showmatch' is reset
5136 - 'formatoptions' is used like it is empty
5137 These options keep their value, but their effect is disabled:
5138 - 'lisp'
5139 - 'indentexpr'
5140 - 'cindent'
5141 NOTE: When you start editing another file while the 'paste' option is
5142 on, settings from the modelines or autocommands may change the
5143 settings again, causing trouble when pasting text. You might want to
5144 set the 'paste' option again.
5145 When the 'paste' option is reset the mentioned options are restored to
5146 the value before the moment 'paste' was switched from off to on.
5147 Resetting 'paste' before ever setting it does not have any effect.
5148 Since mapping doesn't work while 'paste' is active, you need to use
5149 the 'pastetoggle' option to toggle the 'paste' option with some key.
5150
5151 *'pastetoggle'* *'pt'*
5152'pastetoggle' 'pt' string (default "")
5153 global
5154 {not in Vi}
5155 When non-empty, specifies the key sequence that toggles the 'paste'
5156 option. This is like specifying a mapping: >
5157 :map {keys} :set invpaste<CR>
5158< Where {keys} is the value of 'pastetoggle'.
5159 The difference is that it will work even when 'paste' is set.
5160 'pastetoggle' works in Insert mode and Normal mode, but not in
5161 Command-line mode.
5162 Mappings are checked first, thus overrule 'pastetoggle'. However,
5163 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5164 this: >
5165 :map <F10> :set paste<CR>
5166 :map <F11> :set nopaste<CR>
5167 :imap <F10> <C-O>:set paste<CR>
5168 :imap <F11> <nop>
5169 :set pastetoggle=<F11>
5170< This will make <F10> start paste mode and <F11> stop paste mode.
5171 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5172 mode everything is inserted literally, except the 'pastetoggle' key
5173 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005174 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175
5176 *'pex'* *'patchexpr'*
5177'patchexpr' 'pex' string (default "")
5178 global
5179 {not in Vi}
5180 {not available when compiled without the |+diff|
5181 feature}
5182 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005183 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184
5185 *'patchmode'* *'pm'* *E206*
5186'patchmode' 'pm' string (default "")
5187 global
5188 {not in Vi}
5189 When non-empty the oldest version of a file is kept. This can be used
5190 to keep the original version of a file if you are changing files in a
5191 source distribution. Only the first time that a file is written a
5192 copy of the original file will be kept. The name of the copy is the
5193 name of the original file with the string in the 'patchmode' option
5194 appended. This option should start with a dot. Use a string like
5195 ".org". 'backupdir' must not be empty for this to work (Detail: The
5196 backup file is renamed to the patchmode file after the new file has
5197 been successfully written, that's why it must be possible to write a
5198 backup file). If there was no file to be backed up, an empty file is
5199 created.
5200 When the 'backupskip' pattern matches, a patchmode file is not made.
5201 Using 'patchmode' for compressed files appends the extension at the
5202 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5203 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005204 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205
5206 *'path'* *'pa'* *E343* *E345* *E347*
5207'path' 'pa' string (default on Unix: ".,/usr/include,,"
5208 on OS/2: ".,/emx/include,,"
5209 other systems: ".,,")
5210 global or local to buffer |global-local|
5211 {not in Vi}
5212 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005213 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5214 provided that the file being searched for has a relative path (not
5215 starting with "/", "./" or "../"). The directories in the 'path'
5216 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 - Use commas to separate directory names: >
5218 :set path=.,/usr/local/include,/usr/include
5219< - Spaces can also be used to separate directory names (for backwards
5220 compatibility with version 3.0). To have a space in a directory
5221 name, precede it with an extra backslash, and escape the space: >
5222 :set path=.,/dir/with\\\ space
5223< - To include a comma in a directory name precede it with an extra
5224 backslash: >
5225 :set path=.,/dir/with\\,comma
5226< - To search relative to the directory of the current file, use: >
5227 :set path=.
5228< - To search in the current directory use an empty string between two
5229 commas: >
5230 :set path=,,
5231< - A directory name may end in a ':' or '/'.
5232 - Environment variables are expanded |:set_env|.
5233 - When using |netrw.vim| URLs can be used. For example, adding
5234 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005235 - Search upwards and downwards in a directory tree using "*", "**" and
5236 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 {not available when compiled without the |+path_extra| feature}
5238 - Careful with '\' characters, type two to get one in the option: >
5239 :set path=.,c:\\include
5240< Or just use '/' instead: >
5241 :set path=.,c:/include
5242< Don't forget "." or files won't even be found in the same directory as
5243 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005244 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 it is something like 256 or 1024 characters.
5246 You can check if all the include files are found, using the value of
5247 'path', see |:checkpath|.
5248 The use of |:set+=| and |:set-=| is preferred when adding or removing
5249 directories from the list. This avoids problems when a future version
5250 uses another default. To remove the current directory use: >
5251 :set path-=
5252< To add the current directory use: >
5253 :set path+=
5254< To use an environment variable, you probably need to replace the
5255 separator. Here is an example to append $INCL, in which directory
5256 names are separated with a semi-colon: >
5257 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5258< Replace the ';' with a ':' or whatever separator is used. Note that
5259 this doesn't work when $INCL contains a comma or white space.
5260
5261 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5262'preserveindent' 'pi' boolean (default off)
5263 local to buffer
5264 {not in Vi}
5265 When changing the indent of the current line, preserve as much of the
5266 indent structure as possible. Normally the indent is replaced by a
5267 series of tabs followed by spaces as required (unless |'expandtab'| is
5268 enabled, in which case only spaces are used). Enabling this option
5269 means the indent will preserve as many existing characters as possible
5270 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005271 'expandtab' does not apply to the preserved white space, a Tab remains
5272 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005273 NOTE: When using ">>" multiple times the resulting indent is a mix of
5274 tabs and spaces. You might not like this.
5275 NOTE: 'preserveindent' is reset when 'compatible' is set.
5276 Also see 'copyindent'.
5277 Use |:retab| to clean up white space.
5278
5279 *'previewheight'* *'pvh'*
5280'previewheight' 'pvh' number (default 12)
5281 global
5282 {not in Vi}
5283 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005284 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 Default height for a preview window. Used for |:ptag| and associated
5286 commands. Used for |CTRL-W_}| when no count is given.
5287
5288 *'previewwindow'* *'nopreviewwindow'*
5289 *'pvw'* *'nopvw'* *E590*
5290'previewwindow' 'pvw' boolean (default off)
5291 local to window
5292 {not in Vi}
5293 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005294 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005295 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005296 set. It's normally not set directly, but by using one of the commands
5297 |:ptag|, |:pedit|, etc.
5298
5299 *'printdevice'* *'pdev'*
5300'printdevice' 'pdev' string (default empty)
5301 global
5302 {not in Vi}
5303 {only available when compiled with the |+printer|
5304 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005305 The name of the printer to be used for |:hardcopy|.
5306 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005307 This option cannot be set from a |modeline| or in the |sandbox|, for
5308 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309
Bram Moolenaar8299df92004-07-10 09:47:34 +00005310 *'printencoding'* *'penc'*
5311'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312 global
5313 {not in Vi}
5314 {only available when compiled with the |+printer|
5315 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005316 Sets the character encoding used when printing.
5317 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318
5319 *'printexpr'* *'pexpr'*
5320'printexpr' 'pexpr' String (default: see below)
5321 global
5322 {not in Vi}
5323 {only available when compiled with the |+printer|
5324 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005325 Expression used to print the PostScript produced with |:hardcopy|.
5326 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327
Bram Moolenaar8299df92004-07-10 09:47:34 +00005328 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005329'printfont' 'pfn' string (default "courier")
5330 global
5331 {not in Vi}
5332 {only available when compiled with the |+printer|
5333 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005334 The name of the font that will be used for |:hardcopy|.
5335 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005336
5337 *'printheader'* *'pheader'*
5338'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
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 format of the header produced in |:hardcopy| output.
5344 See |pheader-option|.
5345
5346 *'printmbcharset'* *'pmbcs'*
5347'printmbcharset' 'pmbcs' string (default "")
5348 global
5349 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005350 {only available when compiled with the |+printer|,
5351 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005352 The CJK character set to be used for CJK output from |:hardcopy|.
5353 See |pmbcs-option|.
5354
5355 *'printmbfont'* *'pmbfn'*
5356'printmbfont' 'pmbfn' string (default "")
5357 global
5358 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005359 {only available when compiled with the |+printer|,
5360 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005361 List of font names to be used for CJK output from |:hardcopy|.
5362 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363
5364 *'printoptions'* *'popt'*
5365'printoptions' 'popt' string (default "")
5366 global
5367 {not in Vi}
5368 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005369 List of items that control the format of the output of |:hardcopy|.
5370 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005372 *'prompt'* *'noprompt'*
5373'prompt' boolean (default on)
5374 global
5375 When on a ":" prompt is used in Ex mode.
5376
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005377 *'pumheight'* *'ph'*
5378'pumheight' 'ph' number (default 0)
5379 global
5380 {not available when compiled without the
5381 |+insert_expand| feature}
5382 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005383 Determines the maximum number of items to show in the popup menu for
5384 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005385 |ins-completion-menu|.
5386
5387
Bram Moolenaar677ee682005-01-27 14:41:15 +00005388 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005389'quoteescape' 'qe' string (default "\")
5390 local to buffer
5391 {not in Vi}
5392 The characters that are used to escape quotes in a string. Used for
5393 objects like a', a" and a` |a'|.
5394 When one of the characters in this option is found inside a string,
5395 the following character will be skipped. The default value makes the
5396 text "foo\"bar\\" considered to be one string.
5397
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5399'readonly' 'ro' boolean (default off)
5400 local to buffer
5401 If on, writes fail unless you use a '!'. Protects you from
5402 accidentally overwriting a file. Default on when Vim is started
5403 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005404 When using ":w!" the 'readonly' option is reset for the current
5405 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005407 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005409 *'redrawtime'* *'rdt'*
5410'redrawtime' 'rdt' number (default 2000)
5411 global
5412 {not in Vi}
5413 {only available when compiled with the |+reltime|
5414 feature}
5415 The time in milliseconds for redrawing the display. This applies to
5416 searching for patterns for 'hlsearch' and |:match| highlighting.
5417 When redrawing takes more than this many milliseconds no further
5418 matches will be highlighted. This is used to avoid that Vim hangs
5419 when using a very complicated pattern.
5420
Bram Moolenaar64486672010-05-16 15:46:46 +02005421 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5422'relativenumber' 'rnu' boolean (default off)
5423 local to window
5424 {not in Vi}
5425 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005426 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005427 precede some vertical motion commands (e.g. j k + -) with, without
5428 having to calculate it yourself. Especially useful in combination with
5429 other commands (e.g. y d c < > gq gw =).
5430 When the 'n' option is excluded from 'cpoptions' a wrapped
5431 line will not use the column of line numbers (this is the default when
5432 'compatible' isn't set).
5433 The 'numberwidth' option can be used to set the room used for the line
5434 number.
5435 When a long, wrapped line doesn't start with the first character, '-'
5436 characters are put before the number.
5437 See |hl-LineNr| for the highlighting used for the number.
5438 When setting this option, 'number' is reset.
5439
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 *'remap'* *'noremap'*
5441'remap' boolean (default on)
5442 global
5443 Allows for mappings to work recursively. If you do not want this for
5444 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005445 NOTE: To avoid portability problems with Vim scripts, always keep
5446 this option at the default "on". Only switch it off when working with
5447 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448
5449 *'report'*
5450'report' number (default 2)
5451 global
5452 Threshold for reporting number of lines changed. When the number of
5453 changed lines is more than 'report' a message will be given for most
5454 ":" commands. If you want it always, set 'report' to 0.
5455 For the ":substitute" command the number of substitutions is used
5456 instead of the number of lines.
5457
5458 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5459'restorescreen' 'rs' boolean (default on)
5460 global
5461 {not in Vi} {only in Windows 95/NT console version}
5462 When set, the screen contents is restored when exiting Vim. This also
5463 happens when executing external commands.
5464
5465 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5466 options in your .vimrc. To disable restoring:
5467 set t_ti= t_te=
5468 To enable restoring (for an xterm):
5469 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5470 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5471
5472 *'revins'* *'ri'* *'norevins'* *'nori'*
5473'revins' 'ri' boolean (default off)
5474 global
5475 {not in Vi}
5476 {only available when compiled with the |+rightleft|
5477 feature}
5478 Inserting characters in Insert mode will work backwards. See "typing
5479 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5480 command in Insert mode, when 'allowrevins' is set.
5481 NOTE: This option is reset when 'compatible' or 'paste' is set.
5482
5483 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5484'rightleft' 'rl' boolean (default off)
5485 local to window
5486 {not in Vi}
5487 {only available when compiled with the |+rightleft|
5488 feature}
5489 When on, display orientation becomes right-to-left, i.e., characters
5490 that are stored in the file appear from the right to the left.
5491 Using this option, it is possible to edit files for languages that
5492 are written from the right to the left such as Hebrew and Arabic.
5493 This option is per window, so it is possible to edit mixed files
5494 simultaneously, or to view the same file in both ways (this is
5495 useful whenever you have a mixed text file with both right-to-left
5496 and left-to-right strings so that both sets are displayed properly
5497 in different windows). Also see |rileft.txt|.
5498
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005499 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005500'rightleftcmd' 'rlc' string (default "search")
5501 local to window
5502 {not in Vi}
5503 {only available when compiled with the |+rightleft|
5504 feature}
5505 Each word in this option enables the command line editing to work in
5506 right-to-left mode for a group of commands:
5507
5508 search "/" and "?" commands
5509
5510 This is useful for languages such as Hebrew, Arabic and Farsi.
5511 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5512
5513 *'ruler'* *'ru'* *'noruler'* *'noru'*
5514'ruler' 'ru' boolean (default off)
5515 global
5516 {not in Vi}
5517 {not available when compiled without the
5518 |+cmdline_info| feature}
5519 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005520 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521 text in the file is shown on the far right:
5522 Top first line is visible
5523 Bot last line is visible
5524 All first and last line are visible
5525 45% relative position in the file
5526 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005527 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005529 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530 this option takes precedence over 'ruler' and 'rulerformat'
5531 If the number of characters displayed is different from the number of
5532 bytes in the text (e.g., for a TAB or a multi-byte character), both
5533 the text column (byte number) and the screen column are shown,
5534 separated with a dash.
5535 For an empty line "0-1" is shown.
5536 For an empty buffer the line number will also be zero: "0,0-1".
5537 This option is reset when the 'paste' option is set.
5538 If you don't want to see the ruler all the time but want to know where
5539 you are, use "g CTRL-G" |g_CTRL-G|.
5540 NOTE: This option is reset when 'compatible' is set.
5541
5542 *'rulerformat'* *'ruf'*
5543'rulerformat' 'ruf' string (default empty)
5544 global
5545 {not in Vi}
5546 {not available when compiled without the |+statusline|
5547 feature}
5548 When this option is not empty, it determines the content of the ruler
5549 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005550 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 The default ruler width is 17 characters. To make the ruler 15
5552 characters wide, put "%15(" at the start and "%)" at the end.
5553 Example: >
5554 :set rulerformat=%15(%c%V\ %p%%%)
5555<
5556 *'runtimepath'* *'rtp'* *vimfiles*
5557'runtimepath' 'rtp' string (default:
5558 Unix: "$HOME/.vim,
5559 $VIM/vimfiles,
5560 $VIMRUNTIME,
5561 $VIM/vimfiles/after,
5562 $HOME/.vim/after"
5563 Amiga: "home:vimfiles,
5564 $VIM/vimfiles,
5565 $VIMRUNTIME,
5566 $VIM/vimfiles/after,
5567 home:vimfiles/after"
5568 PC, OS/2: "$HOME/vimfiles,
5569 $VIM/vimfiles,
5570 $VIMRUNTIME,
5571 $VIM/vimfiles/after,
5572 $HOME/vimfiles/after"
5573 Macintosh: "$VIM:vimfiles,
5574 $VIMRUNTIME,
5575 $VIM:vimfiles:after"
5576 RISC-OS: "Choices:vimfiles,
5577 $VIMRUNTIME,
5578 Choices:vimfiles/after"
5579 VMS: "sys$login:vimfiles,
5580 $VIM/vimfiles,
5581 $VIMRUNTIME,
5582 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005583 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005584 global
5585 {not in Vi}
5586 This is a list of directories which will be searched for runtime
5587 files:
5588 filetype.vim filetypes by file name |new-filetype|
5589 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005590 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 colors/ color scheme files |:colorscheme|
5592 compiler/ compiler files |:compiler|
5593 doc/ documentation |write-local-help|
5594 ftplugin/ filetype plugins |write-filetype-plugin|
5595 indent/ indent scripts |indent-expression|
5596 keymap/ key mapping files |mbyte-keymap|
5597 lang/ menu translations |:menutrans|
5598 menu.vim GUI menus |menu.vim|
5599 plugin/ plugin scripts |write-plugin|
5600 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005601 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602 syntax/ syntax files |mysyntaxfile|
5603 tutor/ files for vimtutor |tutor|
5604
5605 And any other file searched for with the |:runtime| command.
5606
5607 The defaults for most systems are setup to search five locations:
5608 1. In your home directory, for your personal preferences.
5609 2. In a system-wide Vim directory, for preferences from the system
5610 administrator.
5611 3. In $VIMRUNTIME, for files distributed with Vim.
5612 *after-directory*
5613 4. In the "after" directory in the system-wide Vim directory. This is
5614 for the system administrator to overrule or add to the distributed
5615 defaults (rarely needed)
5616 5. In the "after" directory in your home directory. This is for
5617 personal preferences to overrule or add to the distributed defaults
5618 or system-wide settings (rarely needed).
5619
5620 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5621 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005622 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623 wildcards.
5624 See |:runtime|.
5625 Example: >
5626 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5627< This will use the directory "~/vimruntime" first (containing your
5628 personal Vim runtime files), then "/mygroup/vim" (shared between a
5629 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5630 files).
5631 You probably should always include $VIMRUNTIME somewhere, to use the
5632 distributed runtime files. You can put a directory before $VIMRUNTIME
5633 to find files which replace a distributed runtime files. You can put
5634 a directory after $VIMRUNTIME to find files which add to distributed
5635 runtime files.
5636 This option cannot be set from a |modeline| or in the |sandbox|, for
5637 security reasons.
5638
5639 *'scroll'* *'scr'*
5640'scroll' 'scr' number (default: half the window height)
5641 local to window
5642 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5643 set to half the number of lines in the window when the window size
5644 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005645 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5647 the number of screen lines instead of file lines, makes a difference
5648 when lines wrap}
5649
5650 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5651'scrollbind' 'scb' boolean (default off)
5652 local to window
5653 {not in Vi}
5654 {not available when compiled without the |+scrollbind|
5655 feature}
5656 See also |scroll-binding|. When this option is set, the current
5657 window scrolls as other scrollbind windows (windows that also have
5658 this option set) scroll. This option is useful for viewing the
5659 differences between two versions of a file, see 'diff'.
5660 See |'scrollopt'| for options that determine how this option should be
5661 interpreted.
5662 This option is mostly reset when splitting a window to edit another
5663 file. This means that ":split | edit file" results in two windows
5664 with scroll-binding, but ":split file" does not.
5665
5666 *'scrolljump'* *'sj'*
5667'scrolljump' 'sj' number (default 1)
5668 global
5669 {not in Vi}
5670 Minimal number of lines to scroll when the cursor gets off the
5671 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5672 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005673 When set to a negative number from -1 to -100 this is used as the
5674 percentage of the window height. Thus -50 scrolls half the window
5675 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 NOTE: This option is set to 1 when 'compatible' is set.
5677
5678 *'scrolloff'* *'so'*
5679'scrolloff' 'so' number (default 0)
5680 global
5681 {not in Vi}
5682 Minimal number of screen lines to keep above and below the cursor.
5683 This will make some context visible around where you are working. If
5684 you set it to a very large value (999) the cursor line will always be
5685 in the middle of the window (except at the start or end of the file or
5686 when long lines wrap).
5687 For scrolling horizontally see 'sidescrolloff'.
5688 NOTE: This option is set to 0 when 'compatible' is set.
5689
5690 *'scrollopt'* *'sbo'*
5691'scrollopt' 'sbo' string (default "ver,jump")
5692 global
5693 {not available when compiled without the |+scrollbind|
5694 feature}
5695 {not in Vi}
5696 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005697 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5698 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 The following words are available:
5700 ver Bind vertical scrolling for 'scrollbind' windows
5701 hor Bind horizontal scrolling for 'scrollbind' windows
5702 jump Applies to the offset between two windows for vertical
5703 scrolling. This offset is the difference in the first
5704 displayed line of the bound windows. When moving
5705 around in a window, another 'scrollbind' window may
5706 reach a position before the start or after the end of
5707 the buffer. The offset is not changed though, when
5708 moving back the 'scrollbind' window will try to scroll
5709 to the desired position when possible.
5710 When now making that window the current one, two
5711 things can be done with the relative offset:
5712 1. When "jump" is not included, the relative offset is
5713 adjusted for the scroll position in the new current
5714 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005715 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 2. When "jump" is included, the other windows are
5717 scrolled to keep the same relative offset. When
5718 going back to the other window, it still uses the
5719 same relative offset.
5720 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005721 When 'diff' mode is active there always is vertical scroll binding,
5722 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723
5724 *'sections'* *'sect'*
5725'sections' 'sect' string (default "SHNHH HUnhsh")
5726 global
5727 Specifies the nroff macros that separate sections. These are pairs of
5728 two letters (See |object-motions|). The default makes a section start
5729 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5730
5731 *'secure'* *'nosecure'* *E523*
5732'secure' boolean (default off)
5733 global
5734 {not in Vi}
5735 When on, ":autocmd", shell and write commands are not allowed in
5736 ".vimrc" and ".exrc" in the current directory and map commands are
5737 displayed. Switch it off only if you know that you will not run into
5738 problems, or when the 'exrc' option is off. On Unix this option is
5739 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005740 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741 'secure' at the end of your ~/.vimrc then.
5742 This option cannot be set from a |modeline| or in the |sandbox|, for
5743 security reasons.
5744
5745 *'selection'* *'sel'*
5746'selection' 'sel' string (default "inclusive")
5747 global
5748 {not in Vi}
5749 This option defines the behavior of the selection. It is only used
5750 in Visual and Select mode.
5751 Possible values:
5752 value past line inclusive ~
5753 old no yes
5754 inclusive yes yes
5755 exclusive yes no
5756 "past line" means that the cursor is allowed to be positioned one
5757 character past the line.
5758 "inclusive" means that the last character of the selection is included
5759 in an operation. For example, when "x" is used to delete the
5760 selection.
5761 Note that when "exclusive" is used and selecting from the end
5762 backwards, you cannot include the last character of a line, when
5763 starting in Normal mode and 'virtualedit' empty.
5764
5765 The 'selection' option is set by the |:behave| command.
5766
5767 *'selectmode'* *'slm'*
5768'selectmode' 'slm' string (default "")
5769 global
5770 {not in Vi}
5771 This is a comma separated list of words, which specifies when to start
5772 Select mode instead of Visual mode, when a selection is started.
5773 Possible values:
5774 mouse when using the mouse
5775 key when using shifted special keys
5776 cmd when using "v", "V" or CTRL-V
5777 See |Select-mode|.
5778 The 'selectmode' option is set by the |:behave| command.
5779
5780 *'sessionoptions'* *'ssop'*
5781'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005782 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 global
5784 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005785 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005786 feature}
5787 Changes the effect of the |:mksession| command. It is a comma
5788 separated list of words. Each word enables saving and restoring
5789 something:
5790 word save and restore ~
5791 blank empty windows
5792 buffers hidden and unloaded buffers, not just those in windows
5793 curdir the current directory
5794 folds manually created folds, opened/closed folds and local
5795 fold options
5796 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005797 and contain at least one lowercase letter. Only
5798 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005799 help the help window
5800 localoptions options and mappings local to a window or buffer (not
5801 global values for local options)
5802 options all options and mappings (also global values for local
5803 options)
5804 resize size of the Vim window: 'lines' and 'columns'
5805 sesdir the directory in which the session file is located
5806 will become the current directory (useful with
5807 projects accessed over a network from different
5808 systems)
5809 slash backslashes in file names replaced with forward
5810 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005811 tabpages all tab pages; without this only the current tab page
5812 is restored, so that you can make a session for each
5813 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814 unix with Unix end-of-line format (single <NL>), even when
5815 on Windows or DOS
5816 winpos position of the whole Vim window
5817 winsize window sizes
5818
5819 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005820 When neither "curdir" nor "sesdir" is included, file names are stored
5821 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822 "slash" and "unix" are useful on Windows when sharing session files
5823 with Unix. The Unix version of Vim cannot source dos format scripts,
5824 but the Windows version of Vim can source unix format scripts.
5825
5826 *'shell'* *'sh'* *E91*
5827'shell' 'sh' string (default $SHELL or "sh",
5828 MS-DOS and Win32: "command.com" or
5829 "cmd.exe", OS/2: "cmd")
5830 global
5831 Name of the shell to use for ! and :! commands. When changing the
5832 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5833 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005834 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835 See |option-backslash| about including spaces and backslashes.
5836 Environment variables are expanded |:set_env|.
5837 If the name of the shell contains a space, you might need to enclose
5838 it in quotes. Example: >
5839 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5840< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005841 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005842 "-f" is not inside the quotes, because it is not part of the command
5843 name. And Vim automagically recognizes the backslashes that are path
5844 separators.
5845 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5846 variable to change the way external commands are executed. See the
5847 libc.inf file of DJGPP.
5848 Under MS-Windows, when the executable ends in ".com" it must be
5849 included. Thus setting the shell to "command.com" or "4dos.com"
5850 works, but "command" and "4dos" do not work for all commands (e.g.,
5851 filtering).
5852 For unknown reasons, when using "4dos.com" the current directory is
5853 changed to "C:\". To avoid this set 'shell' like this: >
5854 :set shell=command.com\ /c\ 4dos
5855< This option cannot be set from a |modeline| or in the |sandbox|, for
5856 security reasons.
5857
5858 *'shellcmdflag'* *'shcf'*
5859'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5860 does not contain "sh" somewhere: "/c")
5861 global
5862 {not in Vi}
5863 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5864 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5865 systems, the default is set according to the value of 'shell', to
5866 reduce the need to set this option by the user. It's not used for
5867 OS/2 (EMX figures this out itself). See |option-backslash| about
5868 including spaces and backslashes. See |dos-shell|.
5869 This option cannot be set from a |modeline| or in the |sandbox|, for
5870 security reasons.
5871
5872 *'shellpipe'* *'sp'*
5873'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5874 global
5875 {not in Vi}
5876 {not available when compiled without the |+quickfix|
5877 feature}
5878 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005879 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 including spaces and backslashes.
5881 The name of the temporary file can be represented by "%s" if necessary
5882 (the file name is appended automatically if no %s appears in the value
5883 of this option).
5884 For the Amiga and MS-DOS the default is ">". The output is directly
5885 saved in a file and not echoed to the screen.
5886 For Unix the default it "| tee". The stdout of the compiler is saved
5887 in a file and echoed to the screen. If the 'shell' option is "csh" or
5888 "tcsh" after initializations, the default becomes "|& tee". If the
5889 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005890 "2>&1| tee". This means that stderr is also included. Before using
5891 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005892 The initialization of this option is done after reading the ".vimrc"
5893 and the other initializations, so that when the 'shell' option is set
5894 there, the 'shellpipe' option changes automatically, unless it was
5895 explicitly set before.
5896 When 'shellpipe' is set to an empty string, no redirection of the
5897 ":make" output will be done. This is useful if you use a 'makeprg'
5898 that writes to 'makeef' by itself. If you want no piping, but do
5899 want to include the 'makeef', set 'shellpipe' to a single space.
5900 Don't forget to precede the space with a backslash: ":set sp=\ ".
5901 In the future pipes may be used for filtering and this option will
5902 become obsolete (at least for Unix).
5903 This option cannot be set from a |modeline| or in the |sandbox|, for
5904 security reasons.
5905
5906 *'shellquote'* *'shq'*
5907'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5908 contains "sh" somewhere: "\"")
5909 global
5910 {not in Vi}
5911 Quoting character(s), put around the command passed to the shell, for
5912 the "!" and ":!" commands. The redirection is kept outside of the
5913 quoting. See 'shellxquote' to include the redirection. It's
5914 probably not useful to set both options.
5915 This is an empty string by default. Only known to be useful for
5916 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5917 or bash, where it should be "\"". The default is adjusted according
5918 the value of 'shell', to reduce the need to set this option by the
5919 user. See |dos-shell|.
5920 This option cannot be set from a |modeline| or in the |sandbox|, for
5921 security reasons.
5922
5923 *'shellredir'* *'srr'*
5924'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5925 global
5926 {not in Vi}
5927 String to be used to put the output of a filter command in a temporary
5928 file. See also |:!|. See |option-backslash| about including spaces
5929 and backslashes.
5930 The name of the temporary file can be represented by "%s" if necessary
5931 (the file name is appended automatically if no %s appears in the value
5932 of this option).
5933 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5934 or "zsh" during initializations, the default becomes ">&". If the
5935 'shell' option is "sh", "ksh" or "bash" the default becomes
5936 ">%s 2>&1". This means that stderr is also included.
5937 For Win32, the Unix checks are done and additionally "cmd" is checked
5938 for, which makes the default ">%s 2>&1". Also, the same names with
5939 ".exe" appended are checked for.
5940 The initialization of this option is done after reading the ".vimrc"
5941 and the other initializations, so that when the 'shell' option is set
5942 there, the 'shellredir' option changes automatically unless it was
5943 explicitly set before.
5944 In the future pipes may be used for filtering and this option will
5945 become obsolete (at least for Unix).
5946 This option cannot be set from a |modeline| or in the |sandbox|, for
5947 security reasons.
5948
5949 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5950'shellslash' 'ssl' boolean (default off)
5951 global
5952 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5953 When set, a forward slash is used when expanding file names. This is
5954 useful when a Unix-like shell is used instead of command.com or
5955 cmd.exe. Backward slashes can still be typed, but they are changed to
5956 forward slashes by Vim.
5957 Note that setting or resetting this option has no effect for some
5958 existing file names, thus this option needs to be set before opening
5959 any file for best results. This might change in the future.
5960 'shellslash' only works when a backslash can be used as a path
5961 separator. To test if this is so use: >
5962 if exists('+shellslash')
5963<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005964 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5965'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5966 global
5967 {not in Vi}
5968 When on, use temp files for shell commands. When off use a pipe.
5969 When using a pipe is not possible temp files are used anyway.
5970 Currently a pipe is only supported on Unix. You can check it with: >
5971 :if has("filterpipe")
5972< The advantage of using a pipe is that nobody can read the temp file
5973 and the 'shell' command does not need to support redirection.
5974 The advantage of using a temp file is that the file type and encoding
5975 can be detected.
5976 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5977 |FilterWritePost| autocommands event are not triggered when
5978 'shelltemp' is off.
5979
Bram Moolenaar071d4272004-06-13 20:20:40 +00005980 *'shelltype'* *'st'*
5981'shelltype' 'st' number (default 0)
5982 global
5983 {not in Vi} {only for the Amiga}
5984 On the Amiga this option influences the way how the commands work
5985 which use a shell.
5986 0 and 1: always use the shell
5987 2 and 3: use the shell only to filter lines
5988 4 and 5: use shell only for ':sh' command
5989 When not using the shell, the command is executed directly.
5990
5991 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5992 1 and 3: use "shell cmd" to start external commands
5993
5994 *'shellxquote'* *'sxq'*
5995'shellxquote' 'sxq' string (default: "";
5996 for Win32, when 'shell' contains "sh"
5997 somewhere: "\""
5998 for Unix, when using system(): "\"")
5999 global
6000 {not in Vi}
6001 Quoting character(s), put around the command passed to the shell, for
6002 the "!" and ":!" commands. Includes the redirection. See
6003 'shellquote' to exclude the redirection. It's probably not useful
6004 to set both options.
6005 This is an empty string by default. Known to be useful for
6006 third-party shells when using the Win32 version, such as the MKS Korn
6007 Shell or bash, where it should be "\"". The default is adjusted
6008 according the value of 'shell', to reduce the need to set this option
6009 by the user. See |dos-shell|.
6010 This option cannot be set from a |modeline| or in the |sandbox|, for
6011 security reasons.
6012
6013 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6014'shiftround' 'sr' boolean (default off)
6015 global
6016 {not in Vi}
6017 Round indent to multiple of 'shiftwidth'. Applies to > and <
6018 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6019 a multiple of 'shiftwidth' (this is Vi compatible).
6020 NOTE: This option is reset when 'compatible' is set.
6021
6022 *'shiftwidth'* *'sw'*
6023'shiftwidth' 'sw' number (default 8)
6024 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006025 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006026 |'cindent'|, |>>|, |<<|, etc.
6027
6028 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006029'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6030 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 global
6032 {not in Vi}
6033 This option helps to avoid all the |hit-enter| prompts caused by file
6034 messages, for example with CTRL-G, and to avoid some other messages.
6035 It is a list of flags:
6036 flag meaning when present ~
6037 f use "(3 of 5)" instead of "(file 3 of 5)"
6038 i use "[noeol]" instead of "[Incomplete last line]"
6039 l use "999L, 888C" instead of "999 lines, 888 characters"
6040 m use "[+]" instead of "[Modified]"
6041 n use "[New]" instead of "[New File]"
6042 r use "[RO]" instead of "[readonly]"
6043 w use "[w]" instead of "written" for file write message
6044 and "[a]" instead of "appended" for ':w >> file' command
6045 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6046 "[unix format]" and "[mac]" instead of "[mac format]".
6047 a all of the above abbreviations
6048
6049 o overwrite message for writing a file with subsequent message
6050 for reading a file (useful for ":wn" or when 'autowrite' on)
6051 O message for reading a file overwrites any previous message.
6052 Also for quickfix message (e.g., ":cn").
6053 s don't give "search hit BOTTOM, continuing at TOP" or "search
6054 hit TOP, continuing at BOTTOM" messages
6055 t truncate file message at the start if it is too long to fit
6056 on the command-line, "<" will appear in the left most column.
6057 Ignored in Ex mode.
6058 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006059 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006060 Ignored in Ex mode.
6061 W don't give "written" or "[w]" when writing a file
6062 A don't give the "ATTENTION" message when an existing swap file
6063 is found.
6064 I don't give the intro message when starting Vim |:intro|.
6065
6066 This gives you the opportunity to avoid that a change between buffers
6067 requires you to hit <Enter>, but still gives as useful a message as
6068 possible for the space available. To get the whole message that you
6069 would have got with 'shm' empty, use ":file!"
6070 Useful values:
6071 shm= No abbreviation of message.
6072 shm=a Abbreviation, but no loss of information.
6073 shm=at Abbreviation, and truncate message when necessary.
6074
6075 NOTE: This option is set to the Vi default value when 'compatible' is
6076 set and to the Vim default value when 'compatible' is reset.
6077
6078 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6079'shortname' 'sn' boolean (default off)
6080 local to buffer
6081 {not in Vi, not in MS-DOS versions}
6082 Filenames are assumed to be 8 characters plus one extension of 3
6083 characters. Multiple dots in file names are not allowed. When this
6084 option is on, dots in file names are replaced with underscores when
6085 adding an extension (".~" or ".swp"). This option is not available
6086 for MS-DOS, because then it would always be on. This option is useful
6087 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6088 or crossdos. When running the Win32 GUI version under Win32s, this
6089 option is always on by default.
6090
6091 *'showbreak'* *'sbr'* *E595*
6092'showbreak' 'sbr' string (default "")
6093 global
6094 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006095 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 feature}
6097 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006098 values are "> " or "+++ ": >
6099 :set showbreak=>\
6100< Note the backslash to escape the trailing space. It's easier like
6101 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006102 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006103< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 comma (in a future version the comma might be used to separate the
6105 part that is shown at the end and at the start of a line).
6106 The characters are highlighted according to the '@' flag in
6107 'highlight'.
6108 Note that tabs after the showbreak will be displayed differently.
6109 If you want the 'showbreak' to appear in between line numbers, add the
6110 "n" flag to 'cpoptions'.
6111
6112 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6113'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6114 off)
6115 global
6116 {not in Vi}
6117 {not available when compiled without the
6118 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006119 Show (partial) command in the last line of the screen. Set this
6120 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 In Visual mode the size of the selected area is shown:
6122 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006123 If the number of bytes is different it is also displayed: "2-6"
6124 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006126 - When selecting a block, the size in screen characters:
6127 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 NOTE: This option is set to the Vi default value when 'compatible' is
6129 set and to the Vim default value when 'compatible' is reset.
6130
6131 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6132'showfulltag' 'sft' boolean (default off)
6133 global
6134 {not in Vi}
6135 When completing a word in insert mode (see |ins-completion|) from the
6136 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006137 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 matched a C function, you can see a template for what arguments are
6139 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006140 Note that this doesn't work well together with having "longest" in
6141 'completeopt', because the completion from the search pattern may not
6142 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143
6144 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6145'showmatch' 'sm' boolean (default off)
6146 global
6147 When a bracket is inserted, briefly jump to the matching one. The
6148 jump is only done if the match can be seen on the screen. The time to
6149 show the match can be set with 'matchtime'.
6150 A Beep is given if there is no match (no matter if the match can be
6151 seen or not). This option is reset when the 'paste' option is set.
6152 When the 'm' flag is not included in 'cpoptions', typing a character
6153 will immediately move the cursor back to where it belongs.
6154 See the "sm" field in 'guicursor' for setting the cursor shape and
6155 blinking when showing the match.
6156 The 'matchpairs' option can be used to specify the characters to show
6157 matches for. 'rightleft' and 'revins' are used to look for opposite
6158 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006159 Also see the matchparen plugin for highlighting the match when moving
6160 around |pi_paren.txt|.
6161 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162
6163 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6164'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6165 global
6166 If in Insert, Replace or Visual mode put a message on the last line.
6167 Use the 'M' flag in 'highlight' to set the type of highlighting for
6168 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006169 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170 doesn't mean XIM is really active, especially when 'imactivatekey' is
6171 not set.
6172 NOTE: This option is set to the Vi default value when 'compatible' is
6173 set and to the Vim default value when 'compatible' is reset.
6174
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006175 *'showtabline'* *'stal'*
6176'showtabline' 'stal' number (default 1)
6177 global
6178 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006179 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006180 feature}
6181 The value of this option specifies when the line with tab page labels
6182 will be displayed:
6183 0: never
6184 1: only if there are at least two tab pages
6185 2: always
6186 This is both for the GUI and non-GUI implementation of the tab pages
6187 line.
6188 See |tab-page| for more information about tab pages.
6189
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 *'sidescroll'* *'ss'*
6191'sidescroll' 'ss' number (default 0)
6192 global
6193 {not in Vi}
6194 The minimal number of columns to scroll horizontally. Used only when
6195 the 'wrap' option is off and the cursor is moved off of the screen.
6196 When it is zero the cursor will be put in the middle of the screen.
6197 When using a slow terminal set it to a large number or 0. When using
6198 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6199 commands.
6200
6201 *'sidescrolloff'* *'siso'*
6202'sidescrolloff' 'siso' number (default 0)
6203 global
6204 {not in Vi}
6205 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006206 right of the cursor if 'nowrap' is set. Setting this option to a
6207 value greater than 0 while having |'sidescroll'| also at a non-zero
6208 value makes some context visible in the line you are scrolling in
6209 horizontally (except at beginning of the line). Setting this option
6210 to a large value (like 999) has the effect of keeping the cursor
6211 horizontally centered in the window, as long as one does not come too
6212 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 NOTE: This option is set to 0 when 'compatible' is set.
6214
6215 Example: Try this together with 'sidescroll' and 'listchars' as
6216 in the following example to never allow the cursor to move
6217 onto the "extends" character:
6218
6219 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6220 :set sidescrolloff=1
6221
6222
6223 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6224'smartcase' 'scs' boolean (default off)
6225 global
6226 {not in Vi}
6227 Override the 'ignorecase' option if the search pattern contains upper
6228 case characters. Only used when the search pattern is typed and
6229 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006230 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6232 recalling the search pattern from history and hitting <Enter>.
6233 NOTE: This option is reset when 'compatible' is set.
6234
6235 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6236'smartindent' 'si' boolean (default off)
6237 local to buffer
6238 {not in Vi}
6239 {not available when compiled without the
6240 |+smartindent| feature}
6241 Do smart autoindenting when starting a new line. Works for C-like
6242 programs, but can also be used for other languages. 'cindent' does
6243 something like this, works better in most cases, but is more strict,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006244 see |C-indenting|. When 'cindent' is on or 'smartindent' is set,
6245 setting 'si' has no effect. 'indentexpr' is a more advanced
6246 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 Normally 'autoindent' should also be on when using 'smartindent'.
6248 An indent is automatically inserted:
6249 - After a line ending in '{'.
6250 - After a line starting with a keyword from 'cinwords'.
6251 - Before a line starting with '}' (only with the "O" command).
6252 When typing '}' as the first character in a new line, that line is
6253 given the same indent as the matching '{'.
6254 When typing '#' as the first character in a new line, the indent for
6255 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006256 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6258 When using the ">>" command, lines starting with '#' are not shifted
6259 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006260 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 is set smart indenting is disabled.
6262
6263 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6264'smarttab' 'sta' boolean (default off)
6265 global
6266 {not in Vi}
6267 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006268 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6269 <BS> will delete a 'shiftwidth' worth of space at the start of the
6270 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006271 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006272 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6273 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006274 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006275 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006276 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006277 NOTE: This option is reset when 'compatible' is set.
6278
6279 *'softtabstop'* *'sts'*
6280'softtabstop' 'sts' number (default 0)
6281 local to buffer
6282 {not in Vi}
6283 Number of spaces that a <Tab> counts for while performing editing
6284 operations, like inserting a <Tab> or using <BS>. It "feels" like
6285 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6286 used. This is useful to keep the 'ts' setting at its standard value
6287 of 8, while being able to edit like it is set to 'sts'. However,
6288 commands like "x" still work on the actual characters.
6289 When 'sts' is zero, this feature is off.
6290 'softtabstop' is set to 0 when the 'paste' option is set.
6291 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6292 spaces is minimized by using <Tab>s.
6293 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6294 set.
6295 NOTE: This option is set to 0 when 'compatible' is set.
6296
Bram Moolenaar217ad922005-03-20 22:37:15 +00006297 *'spell'* *'nospell'*
6298'spell' boolean (default off)
6299 local to window
6300 {not in Vi}
6301 {not available when compiled without the |+syntax|
6302 feature}
6303 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006304 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006305
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006306 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006307'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006308 local to buffer
6309 {not in Vi}
6310 {not available when compiled without the |+syntax|
6311 feature}
6312 Pattern to locate the end of a sentence. The following word will be
6313 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006314 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006315 When this check is not wanted make this option empty.
6316 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006317 Be careful with special characters, see |option-backslash| about
6318 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006319 To set this option automatically depending on the language, see
6320 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006321
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006322 *'spellfile'* *'spf'*
6323'spellfile' 'spf' string (default empty)
6324 local to buffer
6325 {not in Vi}
6326 {not available when compiled without the |+syntax|
6327 feature}
6328 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006329 commands. It must end in ".{encoding}.add". You need to include the
6330 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006331 *E765*
6332 It may also be a comma separated list of names. A count before the
6333 |zg| and |zw| commands can be used to access each. This allows using
6334 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006335 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006336 you: Using the first directory in 'runtimepath' that is writable. If
6337 there is no "spell" directory yet it will be created. For the file
6338 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006339 ignoring the region.
6340 The resulting ".spl" file will be used for spell checking, it does not
6341 have to appear in 'spelllang'.
6342 Normally one file is used for all regions, but you can add the region
6343 name if you want to. However, it will then only be used when
6344 'spellfile' is set to it, for entries in 'spelllang' only files
6345 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006346 This option cannot be set from a |modeline| or in the |sandbox|, for
6347 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006348
Bram Moolenaar217ad922005-03-20 22:37:15 +00006349 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006350'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006351 local to buffer
6352 {not in Vi}
6353 {not available when compiled without the |+syntax|
6354 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006355 A comma separated list of word list names. When the 'spell' option is
6356 on spellchecking will be done for these languages. Example: >
6357 set spelllang=en_us,nl,medical
6358< This means US English, Dutch and medical words are recognized. Words
6359 that are not recognized will be highlighted.
6360 The word list name must not include a comma or dot. Using a dash is
6361 recommended to separate the two letter language name from a
6362 specification. Thus "en-rare" is used for rare English words.
6363 A region name must come last and have the form "_xx", where "xx" is
6364 the two-letter, lower case region name. You can use more than one
6365 region by listing them: "en_us,en_ca" supports both US and Canadian
6366 English, but not words specific for Australia, New Zealand or Great
6367 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006368 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006369 As a special case the name of a .spl file can be given as-is. The
6370 first "_xx" in the name is removed and used as the region name
6371 (_xx is an underscore, two letters and followed by a non-letter).
6372 This is mainly for testing purposes. You must make sure the correct
6373 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006374 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006375 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6376 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006377 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006378
Bram Moolenaar98692072006-02-04 00:57:42 +00006379 If the |spellfile.vim| plugin is active and you use a language name
6380 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6381 will ask you if you want to download the file.
6382
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006383 After this option has been set successfully, Vim will source the files
6384 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006385 up to the first comma, dot or underscore.
6386 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006387
6388
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006389 *'spellsuggest'* *'sps'*
6390'spellsuggest' 'sps' string (default "best")
6391 global
6392 {not in Vi}
6393 {not available when compiled without the |+syntax|
6394 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006395 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006396 the |spellsuggest()| function. This is a comma-separated list of
6397 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006398
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006399 best Internal method that works best for English. Finds
6400 changes like "fast" and uses a bit of sound-a-like
6401 scoring to improve the ordering.
6402
6403 double Internal method that uses two methods and mixes the
6404 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006405 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006406 word. That only works when the language specifies
6407 sound folding. Can be slow and doesn't always give
6408 better results.
6409
6410 fast Internal method that only checks for simple changes:
6411 character inserts/deletes/swaps. Works well for
6412 simple typing mistakes.
6413
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006414 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006415 Not used for |spellsuggest()|. The number of
6416 suggestions is never more than the value of 'lines'
6417 minus two.
6418
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006419 file:{filename} Read file {filename}, which must have two columns,
6420 separated by a slash. The first column contains the
6421 bad word, the second column the suggested good word.
6422 Example:
6423 theribal/terrible ~
6424 Use this for common mistakes that do not appear at the
6425 top of the suggestion list with the internal methods.
6426 Lines without a slash are ignored, use this for
6427 comments.
6428 The file is used for all languages.
6429
6430 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6431 trouble with spaces. |v:val| holds the badly spelled
6432 word. The expression must evaluate to a List of
6433 Lists, each with a suggestion and a score.
6434 Example:
6435 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006436 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006437 internal methods use. A lower score is better.
6438 This may invoke |spellsuggest()| if you temporarily
6439 set 'spellsuggest' to exclude the "expr:" part.
6440 Errors are silently ignored, unless you set the
6441 'verbose' option to a non-zero value.
6442
6443 Only one of "best", "double" or "fast" may be used. The others may
6444 appear several times in any order. Example: >
6445 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6446<
6447 This option cannot be set from a |modeline| or in the |sandbox|, for
6448 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006449
6450
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6452'splitbelow' 'sb' boolean (default off)
6453 global
6454 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006455 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456 feature}
6457 When on, splitting a window will put the new window below the current
6458 one. |:split|
6459
6460 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6461'splitright' 'spr' boolean (default off)
6462 global
6463 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006464 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 feature}
6466 When on, splitting a window will put the new window right of the
6467 current one. |:vsplit|
6468
6469 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6470'startofline' 'sol' boolean (default on)
6471 global
6472 {not in Vi}
6473 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006474 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006475 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006476 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006477 with a linewise operator, with "%" with a count and to buffer changing
6478 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6479 only has a line number, e.g., ":25" or ":+".
6480 In case of buffer changing commands the cursor is placed at the column
6481 where it was the last time the buffer was edited.
6482 NOTE: This option is set when 'compatible' is set.
6483
6484 *'statusline'* *'stl'* *E540* *E541* *E542*
6485'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006486 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 {not in Vi}
6488 {not available when compiled without the |+statusline|
6489 feature}
6490 When nonempty, this option determines the content of the status line.
6491 Also see |status-line|.
6492
6493 The option consists of printf style '%' items interspersed with
6494 normal text. Each status line item is of the form:
6495 %-0{minwid}.{maxwid}{item}
6496 All fields except the {item} is optional. A single percent sign can
6497 be given as "%%". Up to 80 items can be specified.
6498
Bram Moolenaar238a5642006-02-21 22:12:05 +00006499 When the option starts with "%!" then it is used as an expression,
6500 evaluated and the result is used as the option value. Example: >
6501 :set statusline=%!MyStatusLine()
6502< The result can contain %{} items that will be evaluated too.
6503
6504 When there is error while evaluating the option then it will be made
6505 empty to avoid further errors. Otherwise screen updating would loop.
6506
Bram Moolenaar071d4272004-06-13 20:20:40 +00006507 Note that the only effect of 'ruler' when this option is set (and
6508 'laststatus' is 2) is controlling the output of |CTRL-G|.
6509
6510 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006511 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006513 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514 minwid Minimum width of the item, padding as set by '-' & '0'.
6515 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006516 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517 on the left for text items. Numeric items will be
6518 shifted down to maxwid-2 digits followed by '>'number
6519 where number is the amount of missing digits, much like
6520 an exponential notation.
6521 item A one letter code as described below.
6522
6523 Following is a description of the possible statusline items. The
6524 second character in "item" is the type:
6525 N for number
6526 S for string
6527 F for flags as described below
6528 - not applicable
6529
6530 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006531 f S Path to the file in the buffer, as typed or relative to current
6532 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533 F S Full path to the file in the buffer.
6534 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006535 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006537 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006539 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006541 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006542 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006543 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6545 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006546 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006547 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6548 being used: "<keymap>"
6549 n N Buffer number.
6550 b N Value of byte under cursor.
6551 B N As above, in hexadecimal.
6552 o N Byte number in file of byte under cursor, first byte is 1.
6553 Mnemonic: Offset from start of file (with one added)
6554 {not available when compiled without |+byte_offset| feature}
6555 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006556 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557 l N Line number.
6558 L N Number of lines in buffer.
6559 c N Column number.
6560 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006561 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562 p N Percentage through file in lines as in |CTRL-G|.
6563 P S Percentage through file of displayed window. This is like the
6564 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006565 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006567 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006568 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569 ( - Start of item group. Can be used for setting the width and
6570 alignment of a section. Must be followed by %) somewhere.
6571 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006572 T N For 'tabline': start of tab page N label. Use %T after the last
6573 label. This information is used for mouse clicks.
6574 X N For 'tabline': start of close tab N label. Use %X after the
6575 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6576 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 < - Where to truncate line if too long. Default is at the start.
6578 No width fields allowed.
6579 = - Separation point between left and right aligned items.
6580 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006581 # - Set highlight group. The name must follow and then a # again.
6582 Thus use %#HLname# for highlight group HLname. The same
6583 highlighting is used, also for the statusline of non-current
6584 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006585 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006586 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587 The difference between User{N} and StatusLine will be applied
6588 to StatusLineNC for the statusline of non-current windows.
6589 The number N must be between 1 and 9. See |hl-User1..9|
6590
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006591 When displaying a flag, Vim removes the leading comma, if any, when
6592 that flag comes right after plaintext. This will make a nice display
6593 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594
Bram Moolenaar582fd852005-03-28 20:58:01 +00006595 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596 not set) and a minwid is not set for the group, the whole group will
6597 become empty. This will make a group like the following disappear
6598 completely from the statusline when none of the flags are set. >
6599 :set statusline=...%(\ [%M%R%H]%)...
6600<
6601 Beware that an expression is evaluated each and every time the status
6602 line is displayed. The current buffer and current window will be set
6603 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006604 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006606 real current buffer.
6607
6608 The 'statusline' option may be evaluated in the |sandbox|, see
6609 |sandbox-option|.
6610
6611 It is not allowed to change text or jump to another window while
6612 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613
6614 If the statusline is not updated when you want it (e.g., after setting
6615 a variable that's used in an expression), you can force an update by
6616 setting an option without changing its value. Example: >
6617 :let &ro = &ro
6618
6619< A result of all digits is regarded a number for display purposes.
6620 Otherwise the result is taken as flag text and applied to the rules
6621 described above.
6622
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006623 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006624 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6625 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6626
6627 Examples:
6628 Emulate standard status line with 'ruler' set >
6629 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6630< Similar, but add ASCII value of char under the cursor (like "ga") >
6631 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6632< Display byte count and byte value, modified flag in red. >
6633 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6634 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6635< Display a ,GZ flag if a compressed file is loaded >
6636 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6637< In the |:autocmd|'s: >
6638 :let b:gzflag = 1
6639< And: >
6640 :unlet b:gzflag
6641< And define this function: >
6642 :function VarExists(var, val)
6643 : if exists(a:var) | return a:val | else | return '' | endif
6644 :endfunction
6645<
6646 *'suffixes'* *'su'*
6647'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6648 global
6649 {not in Vi}
6650 Files with these suffixes get a lower priority when multiple files
6651 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006652 suffixes. Spaces after the comma are ignored. A dot is also seen as
6653 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 separator, precede it with a backslash (see |option-backslash| about
6655 including spaces and backslashes).
6656 See 'wildignore' for completely ignoring files.
6657 The use of |:set+=| and |:set-=| is preferred when adding or removing
6658 suffixes from the list. This avoids problems when a future version
6659 uses another default.
6660
6661 *'suffixesadd'* *'sua'*
6662'suffixesadd' 'sua' string (default "")
6663 local to buffer
6664 {not in Vi}
6665 {not available when compiled without the
6666 |+file_in_path| feature}
6667 Comma separated list of suffixes, which are used when searching for a
6668 file for the "gf", "[I", etc. commands. Example: >
6669 :set suffixesadd=.java
6670<
6671 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6672'swapfile' 'swf' boolean (default on)
6673 local to buffer
6674 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006675 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 swapfile is not wanted for a specific buffer. For example, with
6677 confidential information that even root must not be able to access.
6678 Careful: All text will be in memory:
6679 - Don't use this for big files.
6680 - Recovery will be impossible!
6681 A swapfile will only be present when |'updatecount'| is non-zero and
6682 'swapfile' is set.
6683 When 'swapfile' is reset, the swap file for the current buffer is
6684 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6685 non-zero, a swap file is immediately created.
6686 Also see |swap-file| and |'swapsync'|.
6687
6688 This option is used together with 'bufhidden' and 'buftype' to
6689 specify special kinds of buffers. See |special-buffers|.
6690
6691 *'swapsync'* *'sws'*
6692'swapsync' 'sws' string (default "fsync")
6693 global
6694 {not in Vi}
6695 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006696 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006697 When this option is empty parts of the swap file may be in memory and
6698 not written to disk. When the system crashes you may lose more work.
6699 On Unix the system does a sync now and then without Vim asking for it,
6700 so the disadvantage of setting this option off is small. On some
6701 systems the swap file will not be written at all. For a unix system
6702 setting it to "sync" will use the sync() call instead of the default
6703 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006704 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705
6706 *'switchbuf'* *'swb'*
6707'switchbuf' 'swb' string (default "")
6708 global
6709 {not in Vi}
6710 This option controls the behavior when switching between buffers.
6711 Possible values (comma separated list):
6712 useopen If included, jump to the first open window that
6713 contains the specified buffer (if there is one).
6714 Otherwise: Do not examine other windows.
6715 This setting is checked with |quickfix| commands, when
6716 jumping to errors (":cc", ":cn", "cp", etc.). It is
6717 also used in all buffer related split commands, for
6718 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006719 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006720 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006722 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006724 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006725 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006727 *'synmaxcol'* *'smc'*
6728'synmaxcol' 'smc' number (default 3000)
6729 local to buffer
6730 {not in Vi}
6731 {not available when compiled without the |+syntax|
6732 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006733 Maximum column in which to search for syntax items. In long lines the
6734 text after this column is not highlighted and following lines may not
6735 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006736 This helps to avoid very slow redrawing for an XML file that is one
6737 long line.
6738 Set to zero to remove the limit.
6739
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 *'syntax'* *'syn'*
6741'syntax' 'syn' string (default empty)
6742 local to buffer
6743 {not in Vi}
6744 {not available when compiled without the |+syntax|
6745 feature}
6746 When this option is set, the syntax with this name is loaded, unless
6747 syntax highlighting has been switched off with ":syntax off".
6748 Otherwise this option does not always reflect the current syntax (the
6749 b:current_syntax variable does).
6750 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006751 not automatically recognized. Example, in an IDL file:
6752 /* vim: set syntax=idl : */ ~
6753 When a dot appears in the value then this separates two filetype
6754 names. Example:
6755 /* vim: set syntax=c.doxygen : */ ~
6756 This will use the "c" syntax first, then the "doxygen" syntax.
6757 Note that the second one must be prepared to be loaded as an addition,
6758 otherwise it will be skipped. More than one dot may appear.
6759 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760 :set syntax=OFF
6761< To switch syntax highlighting on according to the current value of the
6762 'filetype' option: >
6763 :set syntax=ON
6764< What actually happens when setting the 'syntax' option is that the
6765 Syntax autocommand event is triggered with the value as argument.
6766 This option is not copied to another buffer, independent of the 's' or
6767 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006768 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006770 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006771'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006772 global
6773 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006774 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006775 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006776 When nonempty, this option determines the content of the tab pages
6777 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006778 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006779
6780 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006781 option and only when there is no GUI tab line. When 'e' is in
6782 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006783 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006784
6785 The value is evaluated like with 'statusline'. You can use
6786 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006787 the text to be displayed. Use "%1T" for the first label, "%2T" for
6788 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006789
6790 Keep in mind that only one of the tab pages is the current one, others
6791 are invisible and you can't jump to their windows.
6792
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006793
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006794 *'tabpagemax'* *'tpm'*
6795'tabpagemax' 'tpm' number (default 10)
6796 global
6797 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006798 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006799 feature}
6800 Maximum number of tab pages to be opened by the |-p| command line
6801 argument or the ":tab all" command. |tabpage|
6802
6803
6804 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805'tabstop' 'ts' number (default 8)
6806 local to buffer
6807 Number of spaces that a <Tab> in the file counts for. Also see
6808 |:retab| command, and 'softtabstop' option.
6809
6810 Note: Setting 'tabstop' to any other value than 8 can make your file
6811 appear wrong in many places (e.g., when printing it).
6812
6813 There are four main ways to use tabs in Vim:
6814 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6815 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006816 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 behave like a tab appears every 4 (or 3) characters.
6818 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6819 'expandtab'. This way you will always insert spaces. The
6820 formatting will never be messed up when 'tabstop' is changed.
6821 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006822 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 works when using Vim to edit the file.
6824 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6825 'noexpandtab'. This should then work (for initial indents only)
6826 for any tabstop setting that people use. It might be nice to have
6827 tabs after the first non-blank inserted as spaces if you do this
6828 though. Otherwise aligned comments will be wrong when 'tabstop' is
6829 changed.
6830
6831 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6832'tagbsearch' 'tbs' boolean (default on)
6833 global
6834 {not in Vi}
6835 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006836 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 searching makes searching for a tag a LOT faster, but a linear search
6838 will find more tags if the tags file wasn't properly sorted.
6839 Vim normally assumes that your tags files are sorted, or indicate that
6840 they are not sorted. Only when this is not the case does the
6841 'tagbsearch' option need to be switched off.
6842
6843 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006844 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845 certain files, or retry all files with a linear search. When
6846 'tagbsearch' is off, only a linear search is done.
6847
6848 Linear searching is done anyway, for one file, when Vim finds a line
6849 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006850 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851< [The whitespace before and after the '0' must be a single <Tab>]
6852
6853 When a binary search was done and no match was found in any of the
6854 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6855 instead of a normal tag name, a retry is done with a linear search.
6856 Tags in unsorted tags files, and matches with different case will only
6857 be found in the retry.
6858
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006859 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 linear search can be avoided for the 'ignorecase' case. Use a value
6861 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6862 case-fold sorted with the -f switch to "sort" in most unices, as in
6863 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006864 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6865 for this as well. Note that case must be folded to uppercase for this
6866 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867
6868 When 'tagbsearch' is off, tags searching is slower when a full match
6869 exists, but faster when no full match exists. Tags in unsorted tags
6870 files may only be found with 'tagbsearch' off.
6871 When the tags file is not sorted, or sorted in a wrong way (not on
6872 ASCII byte value), 'tagbsearch' should be off, or the line given above
6873 must be included in the tags file.
6874 This option doesn't affect commands that find all matching tags (e.g.,
6875 command-line completion and ":help").
6876 {Vi: always uses binary search in some versions}
6877
6878 *'taglength'* *'tl'*
6879'taglength' 'tl' number (default 0)
6880 global
6881 If non-zero, tags are significant up to this number of characters.
6882
6883 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6884'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6885 global
6886 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006887 If on and using a tags file in another directory, file names in that
6888 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 NOTE: This option is set to the Vi default value when 'compatible' is
6890 set and to the Vim default value when 'compatible' is reset.
6891
6892 *'tags'* *'tag'* *E433*
6893'tags' 'tag' string (default "./tags,tags", when compiled with
6894 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6895 global or local to buffer |global-local|
6896 Filenames for the tag command, separated by spaces or commas. To
6897 include a space or comma in a file name, precede it with a backslash
6898 (see |option-backslash| about including spaces and backslashes).
6899 When a file name starts with "./", the '.' is replaced with the path
6900 of the current file. But only when the 'd' flag is not included in
6901 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6902 |tags-option|.
6903 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02006904 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
6905 find all files named "tags" below "/lib". The filename itself cannot
6906 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
6907 files called "tags?". {not available when compiled without the
6908 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006909 The |tagfiles()| function can be used to get a list of the file names
6910 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6912 files are also supported. They are automatically recognized. The
6913 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6914 differences are ignored (MS-Windows). |emacs-tags|
6915 The use of |:set+=| and |:set-=| is preferred when adding or removing
6916 file names from the list. This avoids problems when a future version
6917 uses another default.
6918 {Vi: default is "tags /usr/lib/tags"}
6919
6920 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6921'tagstack' 'tgst' boolean (default on)
6922 global
6923 {not in all versions of Vi}
6924 When on, the |tagstack| is used normally. When off, a ":tag" or
6925 ":tselect" command with an argument will not push the tag onto the
6926 tagstack. A following ":tag" without an argument, a ":pop" command or
6927 any other command that uses the tagstack will use the unmodified
6928 tagstack, but does change the pointer to the active entry.
6929 Resetting this option is useful when using a ":tag" command in a
6930 mapping which should not change the tagstack.
6931
6932 *'term'* *E529* *E530* *E531*
6933'term' string (default is $TERM, if that fails:
6934 in the GUI: "builtin_gui"
6935 on Amiga: "amiga"
6936 on BeOS: "beos-ansi"
6937 on Mac: "mac-ansi"
6938 on MiNT: "vt52"
6939 on MS-DOS: "pcterm"
6940 on OS/2: "os2ansi"
6941 on Unix: "ansi"
6942 on VMS: "ansi"
6943 on Win 32: "win32")
6944 global
6945 Name of the terminal. Used for choosing the terminal control
6946 characters. Environment variables are expanded |:set_env|.
6947 For example: >
6948 :set term=$TERM
6949< See |termcap|.
6950
6951 *'termbidi'* *'tbidi'*
6952 *'notermbidi'* *'notbidi'*
6953'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6954 global
6955 {not in Vi}
6956 {only available when compiled with the |+arabic|
6957 feature}
6958 The terminal is in charge of Bi-directionality of text (as specified
6959 by Unicode). The terminal is also expected to do the required shaping
6960 that some languages (such as Arabic) require.
6961 Setting this option implies that 'rightleft' will not be set when
6962 'arabic' is set and the value of 'arabicshape' will be ignored.
6963 Note that setting 'termbidi' has the immediate effect that
6964 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6965 This option is reset when the GUI is started.
6966 For further details see |arabic.txt|.
6967
6968 *'termencoding'* *'tenc'*
6969'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6970 Macintosh GUI: "macroman")
6971 global
6972 {only available when compiled with the |+multi_byte|
6973 feature}
6974 {not in Vi}
6975 Encoding used for the terminal. This specifies what character
6976 encoding the keyboard produces and the display will understand. For
6977 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006978 display). Except for the Mac when 'macatsui' is off, then
6979 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 In the Win32 console version the default value is the console codepage
6981 when it differs from the ANSI codepage.
6982 *E617*
6983 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6984 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6985 Any attempts to set a different value will be rejected, and an error
6986 message is shown.
6987 For the Win32 GUI 'termencoding' is not used for typed characters,
6988 because the Win32 system always passes Unicode characters.
6989 When empty, the same encoding is used as for the 'encoding' option.
6990 This is the normal value.
6991 Not all combinations for 'termencoding' and 'encoding' are valid. See
6992 |encoding-table|.
6993 The value for this option must be supported by internal conversions or
6994 iconv(). When this is not possible no conversion will be done and you
6995 will probably experience problems with non-ASCII characters.
6996 Example: You are working with the locale set to euc-jp (Japanese) and
6997 want to edit a UTF-8 file: >
6998 :let &termencoding = &encoding
6999 :set encoding=utf-8
7000< You need to do this when your system has no locale support for UTF-8.
7001
7002 *'terse'* *'noterse'*
7003'terse' boolean (default off)
7004 global
7005 When set: Add 's' flag to 'shortmess' option (this makes the message
7006 for a search that hits the start or end of the file not being
7007 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7008 shortens a lot of messages}
7009
7010 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7011'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7012 global
7013 {not in Vi}
7014 This option is obsolete. Use 'fileformats'.
7015 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7016 set to the default value for the current system. When 'textauto' is
7017 reset, 'fileformats' is made empty.
7018 NOTE: This option is set to the Vi default value when 'compatible' is
7019 set and to the Vim default value when 'compatible' is reset.
7020
7021 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7022'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7023 others: default off)
7024 local to buffer
7025 {not in Vi}
7026 This option is obsolete. Use 'fileformat'.
7027 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7028 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7029 "unix".
7030
7031 *'textwidth'* *'tw'*
7032'textwidth' 'tw' number (default 0)
7033 local to buffer
7034 {not in Vi}
7035 Maximum width of text that is being inserted. A longer line will be
7036 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007037 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7038 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007039 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007040 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041 NOTE: This option is set to 0 when 'compatible' is set.
7042
7043 *'thesaurus'* *'tsr'*
7044'thesaurus' 'tsr' string (default "")
7045 global or local to buffer |global-local|
7046 {not in Vi}
7047 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007048 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 the file should contain words with similar meaning, separated by
7050 non-keyword characters (white space is preferred). Maximum line
7051 length is 510 bytes.
7052 To obtain a file to be used here, check out the wordlist FAQ at
7053 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007054 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 after a comma are ignored, otherwise spaces are included in the file
7056 name. See |option-backslash| about using backslashes.
7057 The use of |:set+=| and |:set-=| is preferred when adding or removing
7058 directories from the list. This avoids problems when a future version
7059 uses another default.
7060 Backticks cannot be used in this option for security reasons.
7061
7062 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7063'tildeop' 'top' boolean (default off)
7064 global
7065 {not in Vi}
7066 When on: The tilde command "~" behaves like an operator.
7067 NOTE: This option is reset when 'compatible' is set.
7068
7069 *'timeout'* *'to'* *'notimeout'* *'noto'*
7070'timeout' 'to' boolean (default on)
7071 global
7072 *'ttimeout'* *'nottimeout'*
7073'ttimeout' boolean (default off)
7074 global
7075 {not in Vi}
7076 These two options together determine the behavior when part of a
7077 mapped key sequence or keyboard code has been received:
7078
7079 'timeout' 'ttimeout' action ~
7080 off off do not time out
7081 on on or off time out on :mappings and key codes
7082 off on time out on key codes
7083
7084 If both options are off, Vim will wait until either the complete
7085 mapping or key sequence has been received, or it is clear that there
7086 is no mapping or key sequence for the received characters. For
7087 example: if you have mapped "vl" and Vim has received 'v', the next
7088 character is needed to see if the 'v' is followed by an 'l'.
7089 When one of the options is on, Vim will wait for about 1 second for
7090 the next character to arrive. After that the already received
7091 characters are interpreted as single characters. The waiting time can
7092 be changed with the 'timeoutlen' option.
7093 On slow terminals or very busy systems timing out may cause
7094 malfunctioning cursor keys. If both options are off, Vim waits
7095 forever after an entered <Esc> if there are key codes that start
7096 with <Esc>. You will have to type <Esc> twice. If you do not have
7097 problems with key codes, but would like to have :mapped key
7098 sequences not timing out in 1 second, set the 'ttimeout' option and
7099 reset the 'timeout' option.
7100
7101 NOTE: 'ttimeout' is reset when 'compatible' is set.
7102
7103 *'timeoutlen'* *'tm'*
7104'timeoutlen' 'tm' number (default 1000)
7105 global
7106 {not in all versions of Vi}
7107 *'ttimeoutlen'* *'ttm'*
7108'ttimeoutlen' 'ttm' number (default -1)
7109 global
7110 {not in Vi}
7111 The time in milliseconds that is waited for a key code or mapped key
7112 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7113 when part of a command has been typed.
7114 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7115 different timeout value for key codes is desired set 'ttimeoutlen' to
7116 a non-negative number.
7117
7118 ttimeoutlen mapping delay key code delay ~
7119 < 0 'timeoutlen' 'timeoutlen'
7120 >= 0 'timeoutlen' 'ttimeoutlen'
7121
7122 The timeout only happens when the 'timeout' and 'ttimeout' options
7123 tell so. A useful setting would be >
7124 :set timeout timeoutlen=3000 ttimeoutlen=100
7125< (time out on mapping after three seconds, time out on key codes after
7126 a tenth of a second).
7127
7128 *'title'* *'notitle'*
7129'title' boolean (default off, on when title can be restored)
7130 global
7131 {not in Vi}
7132 {not available when compiled without the |+title|
7133 feature}
7134 When on, the title of the window will be set to the value of
7135 'titlestring' (if it is not empty), or to:
7136 filename [+=-] (path) - VIM
7137 Where:
7138 filename the name of the file being edited
7139 - indicates the file cannot be modified, 'ma' off
7140 + indicates the file was modified
7141 = indicates the file is read-only
7142 =+ indicates the file is read-only and modified
7143 (path) is the path of the file being edited
7144 - VIM the server name |v:servername| or "VIM"
7145 Only works if the terminal supports setting window titles
7146 (currently Amiga console, Win32 console, all GUI versions and
7147 terminals with a non- empty 't_ts' option - these are Unix xterm and
7148 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7149 *X11*
7150 When Vim was compiled with HAVE_X11 defined, the original title will
7151 be restored if possible. The output of ":version" will include "+X11"
7152 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7153 works for the icon name |'icon'|.
7154 But: When Vim was started with the |-X| argument, restoring the title
7155 will not work (except in the GUI).
7156 If the title cannot be restored, it is set to the value of 'titleold'.
7157 You might want to restore the title outside of Vim then.
7158 When using an xterm from a remote machine you can use this command:
7159 rsh machine_name xterm -display $DISPLAY &
7160 then the WINDOWID environment variable should be inherited and the
7161 title of the window should change back to what it should be after
7162 exiting Vim.
7163
7164 *'titlelen'*
7165'titlelen' number (default 85)
7166 global
7167 {not in Vi}
7168 {not available when compiled without the |+title|
7169 feature}
7170 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007171 title. When the title is longer, only the end of the path name is
7172 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007173 Using a percentage makes this adapt to the width of the window. But
7174 it won't work perfectly, because the actual number of characters
7175 available also depends on the font used and other things in the title
7176 bar. When 'titlelen' is zero the full path is used. Otherwise,
7177 values from 1 to 30000 percent can be used.
7178 'titlelen' is also used for the 'titlestring' option.
7179
7180 *'titleold'*
7181'titleold' string (default "Thanks for flying Vim")
7182 global
7183 {not in Vi}
7184 {only available when compiled with the |+title|
7185 feature}
7186 This option will be used for the window title when exiting Vim if the
7187 original title cannot be restored. Only happens if 'title' is on or
7188 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007189 This option cannot be set from a |modeline| or in the |sandbox|, for
7190 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191 *'titlestring'*
7192'titlestring' string (default "")
7193 global
7194 {not in Vi}
7195 {not available when compiled without the |+title|
7196 feature}
7197 When this option is not empty, it will be used for the title of the
7198 window. This happens only when the 'title' option is on.
7199 Only works if the terminal supports setting window titles (currently
7200 Amiga console, Win32 console, all GUI versions and terminals with a
7201 non-empty 't_ts' option).
7202 When Vim was compiled with HAVE_X11 defined, the original title will
7203 be restored if possible |X11|.
7204 When this option contains printf-style '%' items, they will be
7205 expanded according to the rules used for 'statusline'.
7206 Example: >
7207 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7208 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7209< The value of 'titlelen' is used to align items in the middle or right
7210 of the available space.
7211 Some people prefer to have the file name first: >
7212 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7213< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007214 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215 separating space only when needed.
7216 NOTE: Use of special characters in 'titlestring' may cause the display
7217 to be garbled (e.g., when it contains a CR or NL character).
7218 {not available when compiled without the |+statusline| feature}
7219
7220 *'toolbar'* *'tb'*
7221'toolbar' 'tb' string (default "icons,tooltips")
7222 global
7223 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7224 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007225 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007226 possible values are:
7227 icons Toolbar buttons are shown with icons.
7228 text Toolbar buttons shown with text.
7229 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007230 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 tooltips Tooltips are active for toolbar buttons.
7232 Tooltips refer to the popup help text which appears after the mouse
7233 cursor is placed over a toolbar button for a brief moment.
7234
7235 If you want the toolbar to be shown with icons as well as text, do the
7236 following: >
7237 :set tb=icons,text
7238< Motif and Athena cannot display icons and text at the same time. They
7239 will show icons if both are requested.
7240
7241 If none of the strings specified in 'toolbar' are valid or if
7242 'toolbar' is empty, this option is ignored. If you want to disable
7243 the toolbar, you need to set the 'guioptions' option. For example: >
7244 :set guioptions-=T
7245< Also see |gui-toolbar|.
7246
7247 *'toolbariconsize'* *'tbis'*
7248'toolbariconsize' 'tbis' string (default "small")
7249 global
7250 {not in Vi}
7251 {only in the GTK+ 2 GUI}
7252 Controls the size of toolbar icons. The possible values are:
7253 tiny Use tiny toolbar icons.
7254 small Use small toolbar icons (default).
7255 medium Use medium-sized toolbar icons.
7256 large Use large toolbar icons.
7257 The exact dimensions in pixels of the various icon sizes depend on
7258 the current theme. Common dimensions are large=32x32, medium=24x24,
7259 small=20x20 and tiny=16x16.
7260
7261 If 'toolbariconsize' is empty, the global default size as determined
7262 by user preferences or the current theme is used.
7263
7264 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7265'ttybuiltin' 'tbi' boolean (default on)
7266 global
7267 {not in Vi}
7268 When on, the builtin termcaps are searched before the external ones.
7269 When off the builtin termcaps are searched after the external ones.
7270 When this option is changed, you should set the 'term' option next for
7271 the change to take effect, for example: >
7272 :set notbi term=$TERM
7273< See also |termcap|.
7274 Rationale: The default for this option is "on", because the builtin
7275 termcap entries are generally better (many systems contain faulty
7276 xterm entries...).
7277
7278 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7279'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7280 sun-cmd, screen, rxvt, dtterm or
7281 iris-ansi; also on when running Vim in
7282 a DOS console)
7283 global
7284 {not in Vi}
7285 Indicates a fast terminal connection. More characters will be sent to
7286 the screen for redrawing, instead of using insert/delete line
7287 commands. Improves smoothness of redrawing when there are multiple
7288 windows and the terminal does not support a scrolling region.
7289 Also enables the extra writing of characters at the end of each screen
7290 line for lines that wrap. This helps when using copy/paste with the
7291 mouse in an xterm and other terminals.
7292
7293 *'ttymouse'* *'ttym'*
7294'ttymouse' 'ttym' string (default depends on 'term')
7295 global
7296 {not in Vi}
7297 {only in Unix and VMS, doesn't work in the GUI; not
7298 available when compiled without |+mouse|}
7299 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007300 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007301 *xterm-mouse*
7302 xterm xterm-like mouse handling. The mouse generates
7303 "<Esc>[Mscr", where "scr" is three bytes:
7304 "s" = button state
7305 "c" = column plus 33
7306 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007307 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007308 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007309 xterm2 Works like "xterm", but with the xterm reporting the
7310 mouse position while the mouse is dragged. This works
7311 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007312 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007313 work. See below for how Vim detects this
7314 automatically.
7315 *netterm-mouse*
7316 netterm NetTerm mouse handling. The mouse generates
7317 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7318 for the row and column.
7319 *dec-mouse*
7320 dec DEC terminal mouse handling. The mouse generates a
7321 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007322 This is also available for an Xterm, if it was
7323 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007324 *jsbterm-mouse*
7325 jsbterm JSB term mouse handling.
7326 *pterm-mouse*
7327 pterm QNX pterm mouse handling.
7328
7329 The mouse handling must be enabled at compile time |+mouse_xterm|
7330 |+mouse_dec| |+mouse_netterm|.
7331 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7332 recognized, if enabled at compile time. DEC terminal mouse codes
7333 are recognized if enabled at compile time, and 'ttymouse' is not
7334 "xterm" (because the xterm and dec mouse codes conflict).
7335 This option is automatically set to "xterm", when the 'term' option is
7336 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7337 or "xterm2" already. The main use of this option is to set it to
7338 "xterm", when the terminal name doesn't start with "xterm", but it can
7339 handle xterm mouse codes.
7340 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007341 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 feature and if |t_RV| is set to the escape sequence to request the
7343 xterm version number. Otherwise "xterm2" must be set explicitly.
7344 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7345 t_RV to an empty string: >
7346 :set t_RV=
7347<
7348 *'ttyscroll'* *'tsl'*
7349'ttyscroll' 'tsl' number (default 999)
7350 global
7351 Maximum number of lines to scroll the screen. If there are more lines
7352 to scroll the window is redrawn. For terminals where scrolling is
7353 very slow and redrawing is not slow this can be set to a small number,
7354 e.g., 3, to speed up displaying.
7355
7356 *'ttytype'* *'tty'*
7357'ttytype' 'tty' string (default from $TERM)
7358 global
7359 Alias for 'term', see above.
7360
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007361 *'undodir'* *'udir'*
7362'undodir' 'udir' string (default ".")
7363 global
7364 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007365 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007366 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007367 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007368 "." means using the directory of the file. The undo file name for
7369 "file.txt" is ".file.txt.un~".
7370 For other directories the file name is the full path of the edited
7371 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007372 When writing: The first directory that exists is used. "." always
7373 works, no directories after "." will be used for writing.
7374 When reading all entries are tried to find an undo file. The first
7375 undo file that exists is used. When it cannot be read an error is
7376 given, no further entry is used.
7377 See |undo-persistence|.
7378
7379 *'undofile'* *'udf'*
7380'undofile' 'udf' boolean (default off)
7381 local to buffer
7382 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007383 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007384 When on, Vim automatically saves undo history to an undo file when
7385 writing a buffer to a file, and restores undo history from the same
7386 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007387 The directory where the undo file is stored is specified by 'undodir'.
7388 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007389 The undo file is not read when 'undoreload' causes the buffer from
7390 before a reload to be saved for undo.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007391 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007392
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393 *'undolevels'* *'ul'*
7394'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7395 Win32 and OS/2)
7396 global
7397 {not in Vi}
7398 Maximum number of changes that can be undone. Since undo information
7399 is kept in memory, higher numbers will cause more memory to be used
7400 (nevertheless, a single change can use an unlimited amount of memory).
7401 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7402 itself: >
7403 set ul=0
7404< But you can also get Vi compatibility by including the 'u' flag in
7405 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007406 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007407 Set to a negative number for no undo at all: >
7408 set ul=-1
7409< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007410 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007411
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007412 *'undoreload'* *'ur'*
7413'undoreload' 'ur' number (default 10000)
7414 global
7415 {not in Vi}
7416 Save the whole buffer for undo when reloading it. This applies to the
7417 ":e!" command and reloading for when the buffer changed outside of
7418 Vim. |FileChangedShell|
7419 The save only happens when this options is negative or when the number
7420 of lines is smaller than the value of this option.
7421 Set this option to zero to disable undo for a reload.
7422
7423 When saving undo for a reload, any undo file is not read.
7424
7425 Note that this causes the whole buffer to be stored in memory. Set
7426 this option to a lower value if you run out of memory.
7427
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428 *'updatecount'* *'uc'*
7429'updatecount' 'uc' number (default: 200)
7430 global
7431 {not in Vi}
7432 After typing this many characters the swap file will be written to
7433 disk. When zero, no swap file will be created at all (see chapter on
7434 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7435 Vim with the "-n" option, see |startup|. When editing in readonly
7436 mode this option will be initialized to 10000.
7437 The swapfile can be disabled per buffer with |'swapfile'|.
7438 When 'updatecount' is set from zero to non-zero, swap files are
7439 created for all buffers that have 'swapfile' set. When 'updatecount'
7440 is set to zero, existing swap files are not deleted.
7441 Also see |'swapsync'|.
7442 This option has no meaning in buffers where |'buftype'| is "nofile"
7443 or "nowrite".
7444
7445 *'updatetime'* *'ut'*
7446'updatetime' 'ut' number (default 4000)
7447 global
7448 {not in Vi}
7449 If this many milliseconds nothing is typed the swap file will be
7450 written to disk (see |crash-recovery|). Also used for the
7451 |CursorHold| autocommand event.
7452
7453 *'verbose'* *'vbs'*
7454'verbose' 'vbs' number (default 0)
7455 global
7456 {not in Vi, although some versions have a boolean
7457 verbose option}
7458 When bigger than zero, Vim will give messages about what it is doing.
7459 Currently, these messages are given:
7460 >= 1 When the viminfo file is read or written.
7461 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007462 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463 >= 8 Files for which a group of autocommands is executed.
7464 >= 9 Every executed autocommand.
7465 >= 12 Every executed function.
7466 >= 13 When an exception is thrown, caught, finished, or discarded.
7467 >= 14 Anything pending in a ":finally" clause.
7468 >= 15 Every executed Ex command (truncated at 200 characters).
7469
7470 This option can also be set with the "-V" argument. See |-V|.
7471 This option is also set by the |:verbose| command.
7472
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007473 When the 'verbosefile' option is set then the verbose messages are not
7474 displayed.
7475
7476 *'verbosefile'* *'vfile'*
7477'verbosefile' 'vfile' string (default empty)
7478 global
7479 {not in Vi}
7480 When not empty all messages are written in a file with this name.
7481 When the file exists messages are appended.
7482 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007483 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007484 Setting 'verbosefile' to a new value is like making it empty first.
7485 The difference with |:redir| is that verbose messages are not
7486 displayed when 'verbosefile' is set.
7487
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 *'viewdir'* *'vdir'*
7489'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7490 "$VIM/vimfiles/view",
7491 for Unix: "~/.vim/view",
7492 for Macintosh: "$VIM:vimfiles:view"
7493 for VMS: "sys$login:vimfiles/view"
7494 for RiscOS: "Choices:vimfiles/view")
7495 global
7496 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007497 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498 feature}
7499 Name of the directory where to store files for |:mkview|.
7500 This option cannot be set from a |modeline| or in the |sandbox|, for
7501 security reasons.
7502
7503 *'viewoptions'* *'vop'*
7504'viewoptions' 'vop' string (default: "folds,options,cursor")
7505 global
7506 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007507 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 feature}
7509 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007510 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511 word save and restore ~
7512 cursor cursor position in file and in window
7513 folds manually created folds, opened/closed folds and local
7514 fold options
7515 options options and mappings local to a window or buffer (not
7516 global values for local options)
7517 slash backslashes in file names replaced with forward
7518 slashes
7519 unix with Unix end-of-line format (single <NL>), even when
7520 on Windows or DOS
7521
7522 "slash" and "unix" are useful on Windows when sharing view files
7523 with Unix. The Unix version of Vim cannot source dos format scripts,
7524 but the Windows version of Vim can source unix format scripts.
7525
7526 *'viminfo'* *'vi'* *E526* *E527* *E528*
7527'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007528 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7529 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7530 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 global
7532 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007533 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007534 feature}
7535 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007536 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537 separated list of parameters, each consisting of a single character
7538 identifying the particular parameter, followed by a number or string
7539 which specifies the value of that parameter. If a particular
7540 character is left out, then the default value is used for that
7541 parameter. The following is a list of the identifying characters and
7542 the effect of their value.
7543 CHAR VALUE ~
7544 ! When included, save and restore global variables that start
7545 with an uppercase letter, and don't contain a lowercase
7546 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007547 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007548 read back correctly, you end up with an empty item.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007549 " Maximum number of lines saved for each register. Old name of
7550 the '<' item, with the disadvantage that you need to put a
7551 backslash before the ", otherwise it will be recognized as the
7552 start of a comment!
7553 % When included, save and restore the buffer list. If Vim is
7554 started with a file name argument, the buffer list is not
7555 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007556 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557 without a file name and buffers for help files are not written
7558 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007559 When followed by a number, the number specifies the maximum
7560 number of buffers that are stored. Without a number all
7561 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 ' Maximum number of previously edited files for which the marks
7563 are remembered. This parameter must always be included when
7564 'viminfo' is non-empty.
7565 Including this item also means that the |jumplist| and the
7566 |changelist| are stored in the viminfo file.
7567 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007568 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569 patterns are also saved. When not included, the value of
7570 'history' is used.
7571 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007572 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 < Maximum number of lines saved for each register. If zero then
7574 registers are not saved. When not included, all lines are
7575 saved. '"' is the old name for this item.
7576 Also see the 's' item below: limit specified in Kbyte.
7577 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007578 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579 c When included, convert the text in the viminfo file from the
7580 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007581 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 f Whether file marks need to be stored. If zero, file marks ('0
7583 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007584 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585 cursor position (when exiting or when doing ":wviminfo").
7586 h Disable the effect of 'hlsearch' when loading the viminfo
7587 file. When not included, it depends on whether ":nohlsearch"
7588 has been used since the last search command.
7589 n Name of the viminfo file. The name must immediately follow
7590 the 'n'. Must be the last one! If the "-i" argument was
7591 given when starting Vim, that file name overrides the one
7592 given here with 'viminfo'. Environment variables are expanded
7593 when opening the file, not when setting the option.
7594 r Removable media. The argument is a string (up to the next
7595 ','). This parameter can be given several times. Each
7596 specifies the start of a path for which no marks will be
7597 stored. This is to avoid removable media. For MS-DOS you
7598 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7599 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7600 ignored. Maximum length of each 'r' argument is 50
7601 characters.
7602 s Maximum size of an item in Kbyte. If zero then registers are
7603 not saved. Currently only applies to registers. The default
7604 "s10" will exclude registers with more than 10 Kbyte of text.
7605 Also see the '<' item above: line count limit.
7606
7607 Example: >
7608 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7609<
7610 '50 Marks will be remembered for the last 50 files you
7611 edited.
7612 <1000 Contents of registers (up to 1000 lines each) will be
7613 remembered.
7614 s100 Registers with more than 100 Kbyte text are skipped.
7615 :0 Command-line history will not be saved.
7616 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7617 no / Since '/' is not specified, the default will be used,
7618 that is, save all of the search history, and also the
7619 previous search and substitute patterns.
7620 no % The buffer list will not be saved nor read back.
7621 no h 'hlsearch' highlighting will be restored.
7622
7623 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7624 load the contents of the file, this is not done automatically.
7625
7626 This option cannot be set from a |modeline| or in the |sandbox|, for
7627 security reasons.
7628
7629 *'virtualedit'* *'ve'*
7630'virtualedit' 've' string (default "")
7631 global
7632 {not in Vi}
7633 {not available when compiled without the
7634 |+virtualedit| feature}
7635 A comma separated list of these words:
7636 block Allow virtual editing in Visual block mode.
7637 insert Allow virtual editing in Insert mode.
7638 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007639 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007640
Bram Moolenaar071d4272004-06-13 20:20:40 +00007641 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007642 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643 of the line. Useful for selecting a rectangle in Visual mode and
7644 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007645 "onemore" is not the same, it will only allow moving the cursor just
7646 after the last character of the line. This makes some commands more
7647 consistent. Previously the cursor was always past the end of the line
7648 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007649 break some plugins or Vim scripts. For example because |l| can move
7650 the cursor after the last character. Use with care!
7651 Using the |$| command will move to the last character in the line, not
7652 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007653 It doesn't make sense to combine "all" with "onemore", but you will
7654 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655
7656 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7657'visualbell' 'vb' boolean (default off)
7658 global
7659 {not in Vi}
7660 Use visual bell instead of beeping. The terminal code to display the
7661 visual bell is given with 't_vb'. When no beep or flash is wanted,
7662 use ":set vb t_vb=".
7663 Note: When the GUI starts, 't_vb' is reset to its default value. You
7664 might want to set it again in your |gvimrc|.
7665 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7666 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7667 where 40 is the time in msec.
7668 Does not work on the Amiga, you always get a screen flash.
7669 Also see 'errorbells'.
7670
7671 *'warn'* *'nowarn'*
7672'warn' boolean (default on)
7673 global
7674 Give a warning message when a shell command is used while the buffer
7675 has been changed.
7676
7677 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7678'weirdinvert' 'wiv' boolean (default off)
7679 global
7680 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007681 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682 It is provided for backwards compatibility with version 4.x.
7683 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7684 vice versa. Has no effect when the GUI is running.
7685
7686 *'whichwrap'* *'ww'*
7687'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7688 global
7689 {not in Vi}
7690 Allow specified keys that move the cursor left/right to move to the
7691 previous/next line when the cursor is on the first/last character in
7692 the line. Concatenate characters to allow this for these keys:
7693 char key mode ~
7694 b <BS> Normal and Visual
7695 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007696 h "h" Normal and Visual (not recommended)
7697 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698 < <Left> Normal and Visual
7699 > <Right> Normal and Visual
7700 ~ "~" Normal
7701 [ <Left> Insert and Replace
7702 ] <Right> Insert and Replace
7703 For example: >
7704 :set ww=<,>,[,]
7705< allows wrap only when cursor keys are used.
7706 When the movement keys are used in combination with a delete or change
7707 operator, the <EOL> also counts for a character. This makes "3h"
7708 different from "3dh" when the cursor crosses the end of a line. This
7709 is also true for "x" and "X", because they do the same as "dl" and
7710 "dh". If you use this, you may also want to use the mapping
7711 ":map <BS> X" to make backspace delete the character in front of the
7712 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007713 When 'l' is included and it is used after an operator at the end of a
7714 line then it will not move to the next line. This makes "dl", "cl",
7715 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007716 NOTE: This option is set to the Vi default value when 'compatible' is
7717 set and to the Vim default value when 'compatible' is reset.
7718
7719 *'wildchar'* *'wc'*
7720'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7721 global
7722 {not in Vi}
7723 Character you have to type to start wildcard expansion in the
7724 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007725 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 The character is not recognized when used inside a macro. See
7727 'wildcharm' for that.
7728 Although 'wc' is a number option, you can set it to a special key: >
7729 :set wc=<Esc>
7730< NOTE: This option is set to the Vi default value when 'compatible' is
7731 set and to the Vim default value when 'compatible' is reset.
7732
7733 *'wildcharm'* *'wcm'*
7734'wildcharm' 'wcm' number (default: none (0))
7735 global
7736 {not in Vi}
7737 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007738 recognized when used inside a macro. You can find "spare" command-line
7739 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740 you'll never actually type 'wildcharm', just use it in mappings that
7741 automatically invoke completion mode, e.g.: >
7742 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007743 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007744< Then after typing :ss you can use CTRL-P & CTRL-N.
7745
7746 *'wildignore'* *'wig'*
7747'wildignore' 'wig' string (default "")
7748 global
7749 {not in Vi}
7750 {not available when compiled without the |+wildignore|
7751 feature}
7752 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007753 patterns is ignored when completing file or directory names, and
7754 influences the result of |expand()|, |glob()| and |globpath()| unless
7755 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007756 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7757 Also see 'suffixes'.
7758 Example: >
7759 :set wildignore=*.o,*.obj
7760< The use of |:set+=| and |:set-=| is preferred when adding or removing
7761 a pattern from the list. This avoids problems when a future version
7762 uses another default.
7763
Bram Moolenaar94950a92010-12-02 16:01:29 +01007764
7765 *'wildignorecase* *'wic'* *'nowildignorecase* *'nowic'*
7766'wildignorecase' 'wic' boolean (default off)
7767 global
7768 {not in Vi}
7769 When set case is ignored when completing file names and directories.
7770 Has no effect on systems where file name case is generally ignored.
7771 Does not apply when the shell is used to expand wildcards, which
7772 happens when there are special characters.
7773
7774
Bram Moolenaar071d4272004-06-13 20:20:40 +00007775 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7776'wildmenu' 'wmnu' boolean (default off)
7777 global
7778 {not in Vi}
7779 {not available if compiled without the |+wildmenu|
7780 feature}
7781 When 'wildmenu' is on, command-line completion operates in an enhanced
7782 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7783 the possible matches are shown just above the command line, with the
7784 first match highlighted (overwriting the status line, if there is
7785 one). Keys that show the previous/next match, such as <Tab> or
7786 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7787 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7788 specified. "longest" and "list" do not start "wildmenu" mode.
7789 If there are more matches than can fit in the line, a ">" is shown on
7790 the right and/or a "<" is shown on the left. The status line scrolls
7791 as needed.
7792 The "wildmenu" mode is abandoned when a key is hit that is not used
7793 for selecting a completion.
7794 While the "wildmenu" is active the following keys have special
7795 meanings:
7796
7797 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7798 <Down> - in filename/menu name completion: move into a
7799 subdirectory or submenu.
7800 <CR> - in menu completion, when the cursor is just after a
7801 dot: move into a submenu.
7802 <Up> - in filename/menu name completion: move up into
7803 parent directory or parent menu.
7804
7805 This makes the menus accessible from the console |console-menus|.
7806
7807 If you prefer the <Left> and <Right> keys to move the cursor instead
7808 of selecting a different match, use this: >
7809 :cnoremap <Left> <Space><BS><Left>
7810 :cnoremap <Right> <Space><BS><Right>
7811<
7812 The "WildMenu" highlighting is used for displaying the current match
7813 |hl-WildMenu|.
7814
7815 *'wildmode'* *'wim'*
7816'wildmode' 'wim' string (Vim default: "full")
7817 global
7818 {not in Vi}
7819 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007820 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007821 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007822 first part specifies the behavior for the first use of 'wildchar',
7823 The second part for the second use, etc.
7824 These are the possible values for each part:
7825 "" Complete only the first match.
7826 "full" Complete the next full match. After the last match,
7827 the original string is used and then the first match
7828 again.
7829 "longest" Complete till longest common string. If this doesn't
7830 result in a longer string, use the next part.
7831 "longest:full" Like "longest", but also start 'wildmenu' if it is
7832 enabled.
7833 "list" When more than one match, list all matches.
7834 "list:full" When more than one match, list all matches and
7835 complete first match.
7836 "list:longest" When more than one match, list all matches and
7837 complete till longest common string.
7838 When there is only a single match, it is fully completed in all cases.
7839
7840 Examples: >
7841 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007842< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843 :set wildmode=longest,full
7844< Complete longest common string, then each full match >
7845 :set wildmode=list:full
7846< List all matches and complete each full match >
7847 :set wildmode=list,full
7848< List all matches without completing, then each full match >
7849 :set wildmode=longest,list
7850< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007851 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007852
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007853 *'wildoptions'* *'wop'*
7854'wildoptions' 'wop' string (default "")
7855 global
7856 {not in Vi}
7857 {not available when compiled without the |+wildignore|
7858 feature}
7859 A list of words that change how command line completion is done.
7860 Currently only one word is allowed:
7861 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007862 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007863 is displayed per line. Often used tag kinds are:
7864 d #define
7865 f function
7866 Also see |cmdline-completion|.
7867
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868 *'winaltkeys'* *'wak'*
7869'winaltkeys' 'wak' string (default "menu")
7870 global
7871 {not in Vi}
7872 {only used in Win32, Motif, GTK and Photon GUI}
7873 Some GUI versions allow the access to menu entries by using the ALT
7874 key in combination with a character that appears underlined in the
7875 menu. This conflicts with the use of the ALT key for mappings and
7876 entering special characters. This option tells what to do:
7877 no Don't use ALT keys for menus. ALT key combinations can be
7878 mapped, but there is no automatic handling. This can then be
7879 done with the |:simalt| command.
7880 yes ALT key handling is done by the windowing system. ALT key
7881 combinations cannot be mapped.
7882 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007883 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 keys can be mapped.
7885 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7886 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007887 This option is not used for <F10>; on Win32 and with GTK <F10> will
7888 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007890 *'window'* *'wi'*
7891'window' 'wi' number (default screen height - 1)
7892 global
7893 Window height. Do not confuse this with the height of the Vim window,
7894 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007895 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7896 value is smaller than 'lines' minus one. The screen will scroll
7897 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007898 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7899 in a much smarter way, taking care of wrapping lines.
7900 When resizing the Vim window, the value is smaller than 1 or more than
7901 or equal to 'lines' it will be set to 'lines' minus 1.
7902 {Vi also uses the option to specify the number of displayed lines}
7903
Bram Moolenaar071d4272004-06-13 20:20:40 +00007904 *'winheight'* *'wh'* *E591*
7905'winheight' 'wh' number (default 1)
7906 global
7907 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007908 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909 feature}
7910 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007911 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007912 focus goes to a window that is smaller, its size is increased, at the
7913 cost of the height of other windows.
7914 Set 'winheight' to a small number for normal editing.
7915 Set it to 999 to make the current window fill most of the screen.
7916 Other windows will be only 'winminheight' high. This has the drawback
7917 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7918 to create only two windows, set the option after startup is done,
7919 using the |VimEnter| event: >
7920 au VimEnter * set winheight=999
7921< Minimum value is 1.
7922 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007923 height of the current window.
7924 'winheight' applies to the current window. Use 'winminheight' to set
7925 the minimal height for other windows.
7926
7927 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7928'winfixheight' 'wfh' boolean (default off)
7929 local to window
7930 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007931 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007932 feature}
7933 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007934 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7935 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007936 The height may be changed anyway when running out of room.
7937
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007938 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7939'winfixwidth' 'wfw' boolean (default off)
7940 local to window
7941 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007942 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007943 feature}
7944 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007945 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007946 The width may be changed anyway when running out of room.
7947
Bram Moolenaar071d4272004-06-13 20:20:40 +00007948 *'winminheight'* *'wmh'*
7949'winminheight' 'wmh' number (default 1)
7950 global
7951 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007952 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953 feature}
7954 The minimal height of a window, when it's not the current window.
7955 This is a hard minimum, windows will never become smaller.
7956 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7957 status bar) if necessary. They will return to at least one line when
7958 they become active (since the cursor has to have somewhere to go.)
7959 Use 'winheight' to set the minimal height of the current window.
7960 This option is only checked when making a window smaller. Don't use a
7961 large number, it will cause errors when opening more than a few
7962 windows. A value of 0 to 3 is reasonable.
7963
7964 *'winminwidth'* *'wmw'*
7965'winminwidth' 'wmw' number (default 1)
7966 global
7967 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007968 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969 feature}
7970 The minimal width of a window, when it's not the current window.
7971 This is a hard minimum, windows will never become smaller.
7972 When set to zero, windows may be "squashed" to zero columns (i.e. just
7973 a vertical separator) if necessary. They will return to at least one
7974 line when they become active (since the cursor has to have somewhere
7975 to go.)
7976 Use 'winwidth' to set the minimal width of the current window.
7977 This option is only checked when making a window smaller. Don't use a
7978 large number, it will cause errors when opening more than a few
7979 windows. A value of 0 to 12 is reasonable.
7980
7981 *'winwidth'* *'wiw'* *E592*
7982'winwidth' 'wiw' number (default 20)
7983 global
7984 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007985 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986 feature}
7987 Minimal number of columns for the current window. This is not a hard
7988 minimum, Vim will use fewer columns if there is not enough room. If
7989 the current window is smaller, its size is increased, at the cost of
7990 the width of other windows. Set it to 999 to make the current window
7991 always fill the screen. Set it to a small number for normal editing.
7992 The width is not adjusted after one of the commands to change the
7993 width of the current window.
7994 'winwidth' applies to the current window. Use 'winminwidth' to set
7995 the minimal width for other windows.
7996
7997 *'wrap'* *'nowrap'*
7998'wrap' boolean (default on)
7999 local to window
8000 {not in Vi}
8001 This option changes how text is displayed. It doesn't change the text
8002 in the buffer, see 'textwidth' for that.
8003 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008004 displaying continues on the next line. When off lines will not wrap
8005 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008006 moved to a part that is not shown, the screen will scroll
8007 horizontally.
8008 The line will be broken in the middle of a word if necessary. See
8009 'linebreak' to get the break at a word boundary.
8010 To make scrolling horizontally a bit more useful, try this: >
8011 :set sidescroll=5
8012 :set listchars+=precedes:<,extends:>
8013< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008014 This option can't be set from a |modeline| when the 'diff' option is
8015 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008016
8017 *'wrapmargin'* *'wm'*
8018'wrapmargin' 'wm' number (default 0)
8019 local to buffer
8020 Number of characters from the right window border where wrapping
8021 starts. When typing text beyond this limit, an <EOL> will be inserted
8022 and inserting continues on the next line.
8023 Options that add a margin, such as 'number' and 'foldcolumn', cause
8024 the text width to be further reduced. This is Vi compatible.
8025 When 'textwidth' is non-zero, this option is not used.
8026 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8027 and less usefully}
8028
8029 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8030'wrapscan' 'ws' boolean (default on) *E384* *E385*
8031 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008032 Searches wrap around the end of the file. Also applies to |]s| and
8033 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008034
8035 *'write'* *'nowrite'*
8036'write' boolean (default on)
8037 global
8038 {not in Vi}
8039 Allows writing files. When not set, writing a file is not allowed.
8040 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008041 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008042 argument. Filtering text is still possible, even though this requires
8043 writing a temporary file.
8044
8045 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8046'writeany' 'wa' boolean (default off)
8047 global
8048 Allows writing to any file with no need for "!" override.
8049
8050 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8051'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8052 otherwise)
8053 global
8054 {not in Vi}
8055 Make a backup before overwriting a file. The backup is removed after
8056 the file was successfully written, unless the 'backup' option is
8057 also on. Reset this option if your file system is almost full. See
8058 |backup-table| for another explanation.
8059 When the 'backupskip' pattern matches, a backup is not made anyway.
8060 NOTE: This option is set to the default value when 'compatible' is
8061 set.
8062
8063 *'writedelay'* *'wd'*
8064'writedelay' 'wd' number (default 0)
8065 global
8066 {not in Vi}
8067 The number of microseconds to wait for each character sent to the
8068 screen. When non-zero, characters are sent to the terminal one by
8069 one. For MS-DOS pcterm this does not work. For debugging purposes.
8070
8071 vim:tw=78:ts=8:ft=help:norl: