blob: da0ef5bf9eff7826ba16d1194e5b464657e060ae [file] [log] [blame]
Bram Moolenaarfff2bee2010-05-15 13:56:02 +02001*options.txt* For Vim version 7.3a. Last change: 2010 May 13
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 Moolenaar071d4272004-06-13 20:20:40 +0000140{not available when compiled without the +eval feature}
141
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.
276 With the "all" argument: display all local option's
277 local values.
278 Without argument: Display all local option's local
279 values which are different from the default.
280 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.
301 With the "all" argument: display all local option's
302 global values.
303 Without argument: display all local option's global
304 values which are different from the default.
305 {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.
668
669 There are a number of CJK fonts for which the width of glyphs for
670 those characters are solely based on how many octets they take in
671 legacy/traditional CJK encodings. In those encodings, Euro,
672 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000673 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000675 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 Vim is running inside a terminal (emulators) that uses a CJK font
677 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
678 this option should be set to "double" to match the width perceived
679 by Vim with the width of glyphs in the font. Perhaps it also has
680 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
681 when the system locale is set to one of CJK locales. See Unicode
682 Standard Annex #11 (http://www.unicode.org/reports/tr11).
683
684 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
685'antialias' 'anti' boolean (default: off)
686 global
687 {not in Vi}
688 {only available when compiled with GUI enabled
689 on Mac OS X}
690 This option only has an effect in the GUI version of Vim on Mac OS X
691 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
692 which can be easier to read at certain sizes on certain displays.
693 Setting this option can sometimes cause problems if 'guifont' is set
694 to its default (empty string).
695
696 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
697'autochdir' 'acd' boolean (default off)
698 global
699 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200700 {only available when compiled with it, use
701 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000702 When on, Vim will change the current working directory whenever you
703 open a file, switch buffers, delete a buffer or open/close a window.
704 It will change to the directory containing the file which was opened
705 or selected.
706 This option is provided for backward compatibility with the Vim
707 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000708 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709
710 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
711'arabic' 'arab' boolean (default off)
712 local to window
713 {not in Vi}
714 {only available when compiled with the |+arabic|
715 feature}
716 This option can be set to start editing Arabic text.
717 Setting this option will:
718 - Set the 'rightleft' option, unless 'termbidi' is set.
719 - Set the 'arabicshape' option, unless 'termbidi' is set.
720 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
721 between typing English and Arabic key mapping.
722 - Set the 'delcombine' option
723 Note that 'encoding' must be "utf-8" for working with Arabic text.
724
725 Resetting this option will:
726 - Reset the 'rightleft' option.
727 - Disable the use of 'keymap' (without changing its value).
728 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
729 option.
730 Also see |arabic.txt|.
731
732 *'arabicshape'* *'arshape'*
733 *'noarabicshape'* *'noarshape'*
734'arabicshape' 'arshape' boolean (default on)
735 global
736 {not in Vi}
737 {only available when compiled with the |+arabic|
738 feature}
739 When on and 'termbidi' is off, the required visual character
740 corrections that need to take place for displaying the Arabic language
741 take affect. Shaping, in essence, gets enabled; the term is a broad
742 one which encompasses:
743 a) the changing/morphing of characters based on their location
744 within a word (initial, medial, final and stand-alone).
745 b) the enabling of the ability to compose characters
746 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100747 When disabled the display shows each character's true stand-alone
748 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 Arabic is a complex language which requires other settings, for
750 further details see |arabic.txt|.
751
752 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
753'autoindent' 'ai' boolean (default off)
754 local to buffer
755 Copy indent from current line when starting a new line (typing <CR>
756 in Insert mode or when using the "o" or "O" command). If you do not
757 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000758 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
759 to another line has the same effect, unless the 'I' flag is included
760 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000761 When autoindent is on, formatting (with the "gq" command or when you
762 reach 'textwidth' in Insert mode) uses the indentation of the first
763 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 When 'smartindent' or 'cindent' is on the indent is changed in
765 a different way.
766 The 'autoindent' option is reset when the 'paste' option is set.
767 {small difference from Vi: After the indent is deleted when typing
768 <Esc> or <CR>, the cursor position when moving up or down is after the
769 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
770
771 *'autoread'* *'ar'* *'noautoread'* *'noar'*
772'autoread' 'ar' boolean (default off)
773 global or local to buffer |global-local|
774 {not in Vi}
775 When a file has been detected to have been changed outside of Vim and
776 it has not been changed inside of Vim, automatically read it again.
777 When the file has been deleted this is not done. |timestamp|
778 If this option has a local value, use this command to switch back to
779 using the global value: >
780 :set autoread<
781<
782 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
783'autowrite' 'aw' boolean (default off)
784 global
785 Write the contents of the file, if it has been modified, on each
786 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000787 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
789 Note that for some commands the 'autowrite' option is not used, see
790 'autowriteall' for that.
791
792 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
793'autowriteall' 'awa' boolean (default off)
794 global
795 {not in Vi}
796 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
797 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
798 Setting this option also implies that Vim behaves like 'autowrite' has
799 been set.
800
801 *'background'* *'bg'*
802'background' 'bg' string (default "dark" or "light")
803 global
804 {not in Vi}
805 When set to "dark", Vim will try to use colors that look good on a
806 dark background. When set to "light", Vim will try to use colors that
807 look good on a light background. Any other value is illegal.
808 Vim tries to set the default value according to the terminal used.
809 This will not always be correct.
810 Setting this option does not change the background color, it tells Vim
811 what the background color looks like. For changing the background
812 color, see |:hi-normal|.
813
814 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000815 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000816 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100817 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 setting 'background' will cause the color scheme to be reloaded. If
819 the color scheme adjusts to the value of 'background' this will work.
820 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100821 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822
823 When setting 'background' to the default value with: >
824 :set background&
825< Vim will guess the value. In the GUI this should work correctly,
826 in other cases Vim might not be able to guess the right value.
827
828 When starting the GUI, the default value for 'background' will be
829 "light". When the value is not set in the .gvimrc, and Vim detects
830 that the background is actually quite dark, 'background' is set to
831 "dark". But this happens only AFTER the .gvimrc file has been read
832 (because the window needs to be opened to find the actual background
833 color). To get around this, force the GUI window to be opened by
834 putting a ":gui" command in the .gvimrc file, before where the value
835 of 'background' is used (e.g., before ":syntax on").
836 Normally this option would be set in the .vimrc file. Possibly
837 depending on the terminal name. Example: >
838 :if &term == "pcterm"
839 : set background=dark
840 :endif
841< When this option is set, the default settings for the highlight groups
842 will change. To use other settings, place ":highlight" commands AFTER
843 the setting of the 'background' option.
844 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
845 to select the colors for syntax highlighting. After changing this
846 option, you must load syntax.vim again to see the result. This can be
847 done with ":syntax on".
848
849 *'backspace'* *'bs'*
850'backspace' 'bs' string (default "")
851 global
852 {not in Vi}
853 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
854 mode. This is a list of items, separated by commas. Each item allows
855 a way to backspace over something:
856 value effect ~
857 indent allow backspacing over autoindent
858 eol allow backspacing over line breaks (join lines)
859 start allow backspacing over the start of insert; CTRL-W and CTRL-U
860 stop once at the start of insert.
861
862 When the value is empty, Vi compatible backspacing is used.
863
864 For backwards compatibility with version 5.4 and earlier:
865 value effect ~
866 0 same as ":set backspace=" (Vi compatible)
867 1 same as ":set backspace=indent,eol"
868 2 same as ":set backspace=indent,eol,start"
869
870 See |:fixdel| if your <BS> or <Del> key does not do what you want.
871 NOTE: This option is set to "" when 'compatible' is set.
872
873 *'backup'* *'bk'* *'nobackup'* *'nobk'*
874'backup' 'bk' boolean (default off)
875 global
876 {not in Vi}
877 Make a backup before overwriting a file. Leave it around after the
878 file has been successfully written. If you do not want to keep the
879 backup file, but you do want a backup while the file is being
880 written, reset this option and set the 'writebackup' option (this is
881 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000882 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 |backup-table| for more explanations.
884 When the 'backupskip' pattern matches, a backup is not made anyway.
885 When 'patchmode' is set, the backup may be renamed to become the
886 oldest version of a file.
887 NOTE: This option is reset when 'compatible' is set.
888
889 *'backupcopy'* *'bkc'*
890'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
891 global
892 {not in Vi}
893 When writing a file and a backup is made, this option tells how it's
894 done. This is a comma separated list of words.
895
896 The main values are:
897 "yes" make a copy of the file and overwrite the original one
898 "no" rename the file and write a new one
899 "auto" one of the previous, what works best
900
901 Extra values that can be combined with the ones above are:
902 "breaksymlink" always break symlinks when writing
903 "breakhardlink" always break hardlinks when writing
904
905 Making a copy and overwriting the original file:
906 - Takes extra time to copy the file.
907 + When the file has special attributes, is a (hard/symbolic) link or
908 has a resource fork, all this is preserved.
909 - When the file is a link the backup will have the name of the link,
910 not of the real file.
911
912 Renaming the file and writing a new one:
913 + It's fast.
914 - Sometimes not all attributes of the file can be copied to the new
915 file.
916 - When the file is a link the new file will not be a link.
917
918 The "auto" value is the middle way: When Vim sees that renaming file
919 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000920 the file is not a link) that is used. When problems are expected, a
921 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922
923 The "breaksymlink" and "breakhardlink" values can be used in
924 combination with any of "yes", "no" and "auto". When included, they
925 force Vim to always break either symbolic or hard links by doing
926 exactly what the "no" option does, renaming the original file to
927 become the backup and writing a new file in its place. This can be
928 useful for example in source trees where all the files are symbolic or
929 hard links and any changes should stay in the local source tree, not
930 be propagated back to the original source.
931 *crontab*
932 One situation where "no" and "auto" will cause problems: A program
933 that opens a file, invokes Vim to edit that file, and then tests if
934 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000935 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 example.
937
938 When a copy is made, the original file is truncated and then filled
939 with the new text. This means that protection bits, owner and
940 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000941 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 group of the backup is set to the group of the original file. If this
943 fails, the protection bits for the group are made the same as for
944 others.
945
946 When the file is renamed this is the other way around: The backup has
947 the same attributes of the original file, and the newly written file
948 is owned by the current user. When the file was a (hard/symbolic)
949 link, the new file will not! That's why the "auto" value doesn't
950 rename when the file is a link. The owner and group of the newly
951 written file will be set to the same ones as the original file, but
952 the system may refuse to do this. In that case the "auto" value will
953 again not rename the file.
954
955 *'backupdir'* *'bdir'*
956'backupdir' 'bdir' string (default for Amiga: ".,t:",
957 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
958 for Unix: ".,~/tmp,~/")
959 global
960 {not in Vi}
961 List of directories for the backup file, separated with commas.
962 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100963 where this is possible. The directory must exist, Vim will not
964 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 - Empty means that no backup file will be created ('patchmode' is
966 impossible!). Writing may fail because of this.
967 - A directory "." means to put the backup file in the same directory
968 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000969 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 put the backup file relative to where the edited file is. The
971 leading "." is replaced with the path name of the edited file.
972 ("." inside a directory name has no special meaning).
973 - Spaces after the comma are ignored, other spaces are considered part
974 of the directory name. To have a space at the start of a directory
975 name, precede it with a backslash.
976 - To include a comma in a directory name precede it with a backslash.
977 - A directory name may end in an '/'.
978 - Environment variables are expanded |:set_env|.
979 - Careful with '\' characters, type one before a space, type two to
980 get one in the option (see |option-backslash|), for example: >
981 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
982< - For backwards compatibility with Vim version 3.0 a '>' at the start
983 of the option is removed.
984 See also 'backup' and 'writebackup' options.
985 If you want to hide your backup files on Unix, consider this value: >
986 :set backupdir=./.backup,~/.backup,.,/tmp
987< You must create a ".backup" directory in each directory and in your
988 home directory for this to work properly.
989 The use of |:set+=| and |:set-=| is preferred when adding or removing
990 directories from the list. This avoids problems when a future version
991 uses another default.
992 This option cannot be set from a |modeline| or in the |sandbox|, for
993 security reasons.
994
995 *'backupext'* *'bex'* *E589*
996'backupext' 'bex' string (default "~", for VMS: "_")
997 global
998 {not in Vi}
999 String which is appended to a file name to make the name of the
1000 backup file. The default is quite unusual, because this avoids
1001 accidentally overwriting existing files with a backup file. You might
1002 prefer using ".bak", but make sure that you don't have files with
1003 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001004 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001006 If you like to keep a lot of backups, you could use a BufWritePre
1007 autocommand to change 'backupext' just before writing the file to
1008 include a timestamp. >
1009 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1010< Use 'backupdir' to put the backup in a different directory.
1011
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 *'backupskip'* *'bsk'*
1013'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1014 global
1015 {not in Vi}
1016 {not available when compiled without the |+wildignore|
1017 feature}
1018 A list of file patterns. When one of the patterns matches with the
1019 name of the file which is written, no backup file is created. Both
1020 the specified file name and the full path name of the file are used.
1021 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1022 Watch out for special characters, see |option-backslash|.
1023 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001024 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001025
1026 Note that environment variables are not expanded. If you want to use
1027 $HOME you must expand it explicitly, e.g.: >
1028 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1029
1030< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001031 backup would be made by renaming the original file crontab won't see
1032 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033
1034 *'balloondelay'* *'bdlay'*
1035'balloondelay' 'bdlay' number (default: 600)
1036 global
1037 {not in Vi}
1038 {only available when compiled with the |+balloon_eval|
1039 feature}
1040 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1041
1042 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1043'ballooneval' 'beval' boolean (default off)
1044 global
1045 {not in Vi}
1046 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001047 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 Switch on the |balloon-eval| functionality.
1049
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001050 *'balloonexpr'* *'bexpr'*
1051'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001052 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001053 {not in Vi}
1054 {only available when compiled with the |+balloon_eval|
1055 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001056 Expression for text to show in evaluation balloon. It is only used
1057 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001058
1059 v:beval_bufnr number of the buffer in which balloon is going to show
1060 v:beval_winnr number of the window
1061 v:beval_lnum line number
1062 v:beval_col column number (byte index)
1063 v:beval_text word under or after the mouse pointer
1064
1065 The evaluation of the expression must not have side effects!
1066 Example: >
1067 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001068 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001069 \', column ' . v:beval_col .
1070 \ ' of file ' . bufname(v:beval_bufnr) .
1071 \ ' on word "' . v:beval_text . '"'
1072 endfunction
1073 set bexpr=MyBalloonExpr()
1074 set ballooneval
1075<
1076 NOTE: The balloon is displayed only if the cursor is on a text
1077 character. If the result of evaluating 'balloonexpr' is not empty,
1078 Vim does not try to send a message to an external debugger (Netbeans
1079 or Sun Workshop).
1080
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001081 The expression may be evaluated in the |sandbox|, see
1082 |sandbox-option|.
1083
1084 It is not allowed to change text or jump to another window while
1085 evaluating 'balloonexpr' |textlock|.
1086
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001087 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001088 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001089< When they are supported "\n" characters will start a new line. If the
1090 expression evaluates to a |List| this is equal to using each List item
1091 as a string and putting "\n" in between them.
1092
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1094'binary' 'bin' boolean (default off)
1095 local to buffer
1096 {not in Vi}
1097 This option should be set before editing a binary file. You can also
1098 use the |-b| Vim argument. When this option is switched on a few
1099 options will be changed (also when it already was on):
1100 'textwidth' will be set to 0
1101 'wrapmargin' will be set to 0
1102 'modeline' will be off
1103 'expandtab' will be off
1104 Also, 'fileformat' and 'fileformats' options will not be used, the
1105 file is read and written like 'fileformat' was "unix" (a single <NL>
1106 separates lines).
1107 The 'fileencoding' and 'fileencodings' options will not be used, the
1108 file is read without conversion.
1109 NOTE: When you start editing a(nother) file while the 'bin' option is
1110 on, settings from autocommands may change the settings again (e.g.,
1111 'textwidth'), causing trouble when editing. You might want to set
1112 'bin' again when the file has been loaded.
1113 The previous values of these options are remembered and restored when
1114 'bin' is switched from on to off. Each buffer has its own set of
1115 saved option values.
1116 To edit a file with 'binary' set you can use the |++bin| argument.
1117 This avoids you have to do ":set bin", which would have effect for all
1118 files you edit.
1119 When writing a file the <EOL> for the last line is only written if
1120 there was one in the original file (normally Vim appends an <EOL> to
1121 the last line if there is none; this would make the file longer). See
1122 the 'endofline' option.
1123
1124 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1125'bioskey' 'biosk' boolean (default on)
1126 global
1127 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001128 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129 better to detect CTRL-C, but only works for the console. When using a
1130 terminal over a serial port reset this option.
1131 Also see |'conskey'|.
1132
1133 *'bomb'* *'nobomb'*
1134'bomb' boolean (default off)
1135 local to buffer
1136 {not in Vi}
1137 {only available when compiled with the |+multi_byte|
1138 feature}
1139 When writing a file and the following conditions are met, a BOM (Byte
1140 Order Mark) is prepended to the file:
1141 - this option is on
1142 - the 'binary' option is off
1143 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1144 endian variants.
1145 Some applications use the BOM to recognize the encoding of the file.
1146 Often used for UCS-2 files on MS-Windows. For other applications it
1147 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001148 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1150 check for the presence of the BOM is done and 'bomb' set accordingly.
1151 Unless 'binary' is set, it is removed from the first line, so that you
1152 don't see it when editing. When you don't change the options, the BOM
1153 will be restored when writing the file.
1154
1155 *'breakat'* *'brk'*
1156'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1157 global
1158 {not in Vi}
1159 {not available when compiled without the |+linebreak|
1160 feature}
1161 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001162 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1163 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164
1165 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001166'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001168 {not in Vi} {only for Motif, Athena, GTK, Mac and
1169 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001171 last Use same directory as with last file browser, where a
1172 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 buffer Use the directory of the related buffer.
1174 current Use the current directory.
1175 {path} Use the specified directory
1176
1177 *'bufhidden'* *'bh'*
1178'bufhidden' 'bh' string (default: "")
1179 local to buffer
1180 {not in Vi}
1181 {not available when compiled without the |+quickfix|
1182 feature}
1183 This option specifies what happens when a buffer is no longer
1184 displayed in a window:
1185 <empty> follow the global 'hidden' option
1186 hide hide the buffer (don't unload it), also when 'hidden'
1187 is not set
1188 unload unload the buffer, also when 'hidden' is set or using
1189 |:hide|
1190 delete delete the buffer from the buffer list, also when
1191 'hidden' is set or using |:hide|, like using
1192 |:bdelete|
1193 wipe wipe out the buffer from the buffer list, also when
1194 'hidden' is set or using |:hide|, like using
1195 |:bwipeout|
1196
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001197 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1198 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 This option is used together with 'buftype' and 'swapfile' to specify
1200 special kinds of buffers. See |special-buffers|.
1201
1202 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1203'buflisted' 'bl' boolean (default: on)
1204 local to buffer
1205 {not in Vi}
1206 When this option is set, the buffer shows up in the buffer list. If
1207 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1208 This option is reset by Vim for buffers that are only used to remember
1209 a file name or marks. Vim sets it when starting to edit a buffer.
1210 But not when moving to a buffer with ":buffer".
1211
1212 *'buftype'* *'bt'* *E382*
1213'buftype' 'bt' string (default: "")
1214 local to buffer
1215 {not in Vi}
1216 {not available when compiled without the |+quickfix|
1217 feature}
1218 The value of this option specifies the type of a buffer:
1219 <empty> normal buffer
1220 nofile buffer which is not related to a file and will not be
1221 written
1222 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001223 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001224 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001225 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001227 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228 help help buffer (you are not supposed to set this
1229 manually)
1230
1231 This option is used together with 'bufhidden' and 'swapfile' to
1232 specify special kinds of buffers. See |special-buffers|.
1233
1234 Be careful with changing this option, it can have many side effects!
1235
Bram Moolenaar280f1262006-01-30 00:14:18 +00001236 A "quickfix" buffer is only used for the error list and the location
1237 list. This value is set by the |:cwindow| and |:lwindow| commands and
1238 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239
1240 "nofile" and "nowrite" buffers are similar:
1241 both: The buffer is not to be written to disk, ":w" doesn't
1242 work (":w filename" does work though).
1243 both: The buffer is never considered to be |'modified'|.
1244 There is no warning when the changes will be lost, for
1245 example when you quit Vim.
1246 both: A swap file is only created when using too much memory
1247 (when 'swapfile' has been reset there is never a swap
1248 file).
1249 nofile only: The buffer name is fixed, it is not handled like a
1250 file name. It is not modified in response to a |:cd|
1251 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001252 *E676*
1253 "acwrite" implies that the buffer name is not related to a file, like
1254 "nofile", but it will be written. Thus, in contrast to "nofile" and
1255 "nowrite", ":w" does work and a modified buffer can't be abandoned
1256 without saving. For writing there must be matching |BufWriteCmd|,
1257 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258
1259 *'casemap'* *'cmp'*
1260'casemap' 'cmp' string (default: "internal,keepascii")
1261 global
1262 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001263 {only available when compiled with the |+multi_byte|
1264 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 Specifies details about changing the case of letters. It may contain
1266 these words, separated by a comma:
1267 internal Use internal case mapping functions, the current
1268 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001269 matters when 'encoding' is a Unicode encoding,
1270 "latin1" or "iso-8859-15". When "internal" is
1271 omitted, the towupper() and towlower() system library
1272 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1274 case mapping, the current locale is not effective.
1275 This probably only matters for Turkish.
1276
1277 *'cdpath'* *'cd'* *E344* *E346*
1278'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1279 global
1280 {not in Vi}
1281 {not available when compiled without the
1282 |+file_in_path| feature}
1283 This is a list of directories which will be searched when using the
1284 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001285 for has a relative path, not an absolute part starting with "/", "./"
1286 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 The 'cdpath' option's value has the same form and semantics as
1288 |'path'|. Also see |file-searching|.
1289 The default value is taken from $CDPATH, with a "," prepended to look
1290 in the current directory first.
1291 If the default value taken from $CDPATH is not what you want, include
1292 a modified version of the following command in your vimrc file to
1293 override it: >
1294 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1295< This option cannot be set from a |modeline| or in the |sandbox|, for
1296 security reasons.
1297 (parts of 'cdpath' can be passed to the shell to expand file names).
1298
1299 *'cedit'*
1300'cedit' string (Vi default: "", Vim default: CTRL-F)
1301 global
1302 {not in Vi}
1303 {not available when compiled without the |+vertsplit|
1304 feature}
1305 The key used in Command-line Mode to open the command-line window.
1306 The default is CTRL-F when 'compatible' is off.
1307 Only non-printable keys are allowed.
1308 The key can be specified as a single character, but it is difficult to
1309 type. The preferred way is to use the <> notation. Examples: >
1310 :set cedit=<C-Y>
1311 :set cedit=<Esc>
1312< |Nvi| also has this option, but it only uses the first character.
1313 See |cmdwin|.
1314
1315 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1316'charconvert' 'ccv' string (default "")
1317 global
1318 {only available when compiled with the |+multi_byte|
1319 feature and the |+eval| feature}
1320 {not in Vi}
1321 An expression that is used for character encoding conversion. It is
1322 evaluated when a file that is to be read or has been written has a
1323 different encoding from what is desired.
1324 'charconvert' is not used when the internal iconv() function is
1325 supported and is able to do the conversion. Using iconv() is
1326 preferred, because it is much faster.
1327 'charconvert' is not used when reading stdin |--|, because there is no
1328 file to convert from. You will have to save the text in a file first.
1329 The expression must return zero or an empty string for success,
1330 non-zero for failure.
1331 The possible encoding names encountered are in 'encoding'.
1332 Additionally, names given in 'fileencodings' and 'fileencoding' are
1333 used.
1334 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1335 is done internally by Vim, 'charconvert' is not used for this.
1336 'charconvert' is also used to convert the viminfo file, if the 'c'
1337 flag is present in 'viminfo'. Also used for Unicode conversion.
1338 Example: >
1339 set charconvert=CharConvert()
1340 fun CharConvert()
1341 system("recode "
1342 \ . v:charconvert_from . ".." . v:charconvert_to
1343 \ . " <" . v:fname_in . " >" v:fname_out)
1344 return v:shell_error
1345 endfun
1346< The related Vim variables are:
1347 v:charconvert_from name of the current encoding
1348 v:charconvert_to name of the desired encoding
1349 v:fname_in name of the input file
1350 v:fname_out name of the output file
1351 Note that v:fname_in and v:fname_out will never be the same.
1352 Note that v:charconvert_from and v:charconvert_to may be different
1353 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1354 Encryption is not done by Vim when using 'charconvert'. If you want
1355 to encrypt the file after conversion, 'charconvert' should take care
1356 of this.
1357 This option cannot be set from a |modeline| or in the |sandbox|, for
1358 security reasons.
1359
1360 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1361'cindent' 'cin' boolean (default off)
1362 local to buffer
1363 {not in Vi}
1364 {not available when compiled without the |+cindent|
1365 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001366 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 that trigger reindenting in insert mode and 'cinoptions' to set your
1368 preferred indent style.
1369 If 'indentexpr' is not empty, it overrules 'cindent'.
1370 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1371 the "=" operator indents using this algorithm rather than calling an
1372 external program.
1373 See |C-indenting|.
1374 When you don't like the way 'cindent' works, try the 'smartindent'
1375 option or 'indentexpr'.
1376 This option is not used when 'paste' is set.
1377 NOTE: This option is reset when 'compatible' is set.
1378
1379 *'cinkeys'* *'cink'*
1380'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1381 local to buffer
1382 {not in Vi}
1383 {not available when compiled without the |+cindent|
1384 feature}
1385 A list of keys that, when typed in Insert mode, cause reindenting of
1386 the current line. Only used if 'cindent' is on and 'indentexpr' is
1387 empty.
1388 For the format of this option see |cinkeys-format|.
1389 See |C-indenting|.
1390
1391 *'cinoptions'* *'cino'*
1392'cinoptions' 'cino' string (default "")
1393 local to buffer
1394 {not in Vi}
1395 {not available when compiled without the |+cindent|
1396 feature}
1397 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1398 program. See |cinoptions-values| for the values of this option, and
1399 |C-indenting| for info on C indenting in general.
1400
1401
1402 *'cinwords'* *'cinw'*
1403'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1404 local to buffer
1405 {not in Vi}
1406 {not available when compiled without both the
1407 |+cindent| and the |+smartindent| features}
1408 These keywords start an extra indent in the next line when
1409 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1410 an appropriate place (inside {}).
1411 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1412 matter, include the keyword both the uppercase and lowercase:
1413 "if,If,IF".
1414
1415 *'clipboard'* *'cb'*
1416'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1417 for X-windows, "" otherwise)
1418 global
1419 {not in Vi}
1420 {only in GUI versions or when the |+xterm_clipboard|
1421 feature is included}
1422 This option is a list of comma separated names.
1423 These names are recognized:
1424
1425 unnamed When included, Vim will use the clipboard register '*'
1426 for all yank, delete, change and put operations which
1427 would normally go to the unnamed register. When a
1428 register is explicitly specified, it will always be
1429 used regardless of whether "unnamed" is in 'clipboard'
1430 or not. The clipboard register can always be
1431 explicitly accessed using the "* notation. Also see
1432 |gui-clipboard|.
1433
1434 autoselect Works like the 'a' flag in 'guioptions': If present,
1435 then whenever Visual mode is started, or the Visual
1436 area extended, Vim tries to become the owner of the
1437 windowing system's global selection or put the
1438 selected text on the clipboard used by the selection
1439 register "*. See |guioptions_a| and |quotestar| for
1440 details. When the GUI is active, the 'a' flag in
1441 'guioptions' is used, when the GUI is not active, this
1442 "autoselect" flag is used.
1443 Also applies to the modeless selection.
1444
1445 autoselectml Like "autoselect", but for the modeless selection
1446 only. Compare to the 'A' flag in 'guioptions'.
1447
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001448 html When the clipboard contains HTML, use this when
1449 pasting. When putting text on the clipboard, mark it
1450 as HTML. This works to copy rendered HTML from
1451 Firefox, paste it as raw HTML in Vim, select the HTML
1452 in Vim and paste it in a rich edit box in Firefox.
1453 Only supported for GTK version 2 and later.
1454 Only available with the |+multi_byte| feature.
1455
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456 exclude:{pattern}
1457 Defines a pattern that is matched against the name of
1458 the terminal 'term'. If there is a match, no
1459 connection will be made to the X server. This is
1460 useful in this situation:
1461 - Running Vim in a console.
1462 - $DISPLAY is set to start applications on another
1463 display.
1464 - You do not want to connect to the X server in the
1465 console, but do want this in a terminal emulator.
1466 To never connect to the X server use: >
1467 exclude:.*
1468< This has the same effect as using the |-X| argument.
1469 Note that when there is no connection to the X server
1470 the window title won't be restored and the clipboard
1471 cannot be accessed.
1472 The value of 'magic' is ignored, {pattern} is
1473 interpreted as if 'magic' was on.
1474 The rest of the option value will be used for
1475 {pattern}, this must be the last entry.
1476
1477 *'cmdheight'* *'ch'*
1478'cmdheight' 'ch' number (default 1)
1479 global
1480 {not in Vi}
1481 Number of screen lines to use for the command-line. Helps avoiding
1482 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001483 The value of this option is stored with the tab page, so that each tab
1484 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485
1486 *'cmdwinheight'* *'cwh'*
1487'cmdwinheight' 'cwh' number (default 7)
1488 global
1489 {not in Vi}
1490 {not available when compiled without the |+vertsplit|
1491 feature}
1492 Number of screen lines to use for the command-line window. |cmdwin|
1493
1494 *'columns'* *'co'* *E594*
1495'columns' 'co' number (default 80 or terminal width)
1496 global
1497 {not in Vi}
1498 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001499 initialization and does not have to be set by hand. Also see
1500 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 When Vim is running in the GUI or in a resizable window, setting this
1502 option will cause the window size to be changed. When you only want
1503 to use the size for the GUI, put the command in your |gvimrc| file.
1504 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001505 number of columns of the display, the display may be messed up. For
1506 the GUI it is always possible and Vim limits the number of columns to
1507 what fits on the screen. You can use this command to get the widest
1508 window possible: >
1509 :set columns=9999
1510< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511
1512 *'comments'* *'com'* *E524* *E525*
1513'comments' 'com' string (default
1514 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1515 local to buffer
1516 {not in Vi}
1517 {not available when compiled without the |+comments|
1518 feature}
1519 A comma separated list of strings that can start a comment line. See
1520 |format-comments|. See |option-backslash| about using backslashes to
1521 insert a space.
1522
1523 *'commentstring'* *'cms'* *E537*
1524'commentstring' 'cms' string (default "/*%s*/")
1525 local to buffer
1526 {not in Vi}
1527 {not available when compiled without the |+folding|
1528 feature}
1529 A template for a comment. The "%s" in the value is replaced with the
1530 comment text. Currently only used to add markers for folding, see
1531 |fold-marker|.
1532
1533 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001534'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1535 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 global
1537 {not in Vi}
1538 This option has the effect of making Vim either more Vi-compatible, or
1539 make Vim behave in a more useful way.
1540 This is a special kind of option, because when it's set or reset,
1541 other options are also changed as a side effect. CAREFUL: Setting or
1542 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001543 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544 set this option in your vimrc file, you should probably put it at the
1545 very start.
1546 By default this option is on and the Vi defaults are used for the
1547 options. This default was chosen for those people who want to use Vim
1548 just like Vi, and don't even (want to) know about the 'compatible'
1549 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001550 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001551 this option is switched off, and all options that have not been
1552 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001553 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001554 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001555 happen for the system-wide vimrc or gvimrc file, nor for a file given
1556 with the |-u| argument). Also see |compatible-default| and
1557 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 You can also set this option with the "-C" argument, and reset it with
1559 "-N". See |-C| and |-N|.
1560 Switching this option off makes the Vim defaults be used for options
1561 that have a different Vi and Vim default value. See the options
1562 marked with a '+' below. Other options are not modified.
1563 At the moment this option is set, several other options will be set
1564 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001565 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001566 editing.
1567 See also 'cpoptions'.
1568
1569 option + set value effect ~
1570
1571 'allowrevins' off no CTRL-_ command
1572 'backupcopy' Unix: "yes" backup file is a copy
1573 others: "auto" copy or rename backup file
1574 'backspace' "" normal backspace
1575 'backup' off no backup file
1576 'cindent' off no C code indentation
1577 'cedit' + "" no key to open the |cmdwin|
1578 'cpoptions' + (all flags) Vi-compatible flags
1579 'cscopetag' off don't use cscope for ":tag"
1580 'cscopetagorder' 0 see |cscopetagorder|
1581 'cscopeverbose' off see |cscopeverbose|
1582 'digraph' off no digraphs
1583 'esckeys' + off no <Esc>-keys in Insert mode
1584 'expandtab' off tabs not expanded to spaces
1585 'fileformats' + "" no automatic file format detection,
1586 "dos,unix" except for DOS, Windows and OS/2
1587 'formatoptions' + "vt" Vi compatible formatting
1588 'gdefault' off no default 'g' flag for ":s"
1589 'history' + 0 no commandline history
1590 'hkmap' off no Hebrew keyboard mapping
1591 'hkmapp' off no phonetic Hebrew keyboard mapping
1592 'hlsearch' off no highlighting of search matches
1593 'incsearch' off no incremental searching
1594 'indentexpr' "" no indenting by expression
1595 'insertmode' off do not start in Insert mode
1596 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1597 characters and '_'
1598 'joinspaces' on insert 2 spaces after period
1599 'modeline' + off no modelines
1600 'more' + off no pauses in listings
1601 'revins' off no reverse insert
1602 'ruler' off no ruler
1603 'scrolljump' 1 no jump scroll
1604 'scrolloff' 0 no scroll offset
1605 'shiftround' off indent not rounded to shiftwidth
1606 'shortmess' + "" no shortening of messages
1607 'showcmd' + off command characters not shown
1608 'showmode' + off current mode not shown
1609 'smartcase' off no automatic ignore case switch
1610 'smartindent' off no smart indentation
1611 'smarttab' off no smart tab size
1612 'softtabstop' 0 tabs are always 'tabstop' positions
1613 'startofline' on goto startofline with some commands
1614 'tagrelative' + off tag file names are not relative
1615 'textauto' + off no automatic textmode detection
1616 'textwidth' 0 no automatic line wrap
1617 'tildeop' off tilde is not an operator
1618 'ttimeout' off no terminal timeout
1619 'whichwrap' + "" left-right movements don't wrap
1620 'wildchar' + CTRL-E only when the current value is <Tab>
1621 use CTRL-E for cmdline completion
1622 'writebackup' on or off depends on +writebackup feature
1623
1624 *'complete'* *'cpt'* *E535*
1625'complete' 'cpt' string (default: ".,w,b,u,t,i")
1626 local to buffer
1627 {not in Vi}
1628 This option specifies how keyword completion |ins-completion| works
1629 when CTRL-P or CTRL-N are used. It is also used for whole-line
1630 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1631 and the places to scan. It is a comma separated list of flags:
1632 . scan the current buffer ('wrapscan' is ignored)
1633 w scan buffers from other windows
1634 b scan other loaded buffers that are in the buffer list
1635 u scan the unloaded buffers that are in the buffer list
1636 U scan the buffers that are not in the buffer list
1637 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001638 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639 k{dict} scan the file {dict}. Several "k" flags can be given,
1640 patterns are valid too. For example: >
1641 :set cpt=k/usr/dict/*,k~/spanish
1642< s scan the files given with the 'thesaurus' option
1643 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1644 are valid too.
1645 i scan current and included files
1646 d scan current and included files for defined name or macro
1647 |i_CTRL-X_CTRL-D|
1648 ] tag completion
1649 t same as "]"
1650
1651 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1652 not executed, this may lead to unexpected completions from some files
1653 (gzipped files for example). Unloaded buffers are not scanned for
1654 whole-line completion.
1655
1656 The default is ".,w,b,u,t,i", which means to scan:
1657 1. the current buffer
1658 2. buffers in other windows
1659 3. other loaded buffers
1660 4. unloaded buffers
1661 5. tags
1662 6. included files
1663
1664 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001665 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1666 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001668 *'completefunc'* *'cfu'*
1669'completefunc' 'cfu' string (default: empty)
1670 local to buffer
1671 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001672 {not available when compiled without the +eval
1673 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001674 This option specifies a function to be used for Insert mode completion
1675 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001676 See |complete-functions| for an explanation of how the function is
1677 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001678
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001679
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001680 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001681'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001682 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001683 {not available when compiled without the
1684 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001685 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001686 A comma separated list of options for Insert mode completion
1687 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001688
1689 menu Use a popup menu to show the possible completions. The
1690 menu is only shown when there is more than one match and
1691 sufficient colors are available. |ins-completion-menu|
1692
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001693 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001694 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001695 match, e.g., what file it comes from.
1696
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001697 longest Only insert the longest common text of the matches. If
1698 the menu is displayed you can use CTRL-L to add more
1699 characters. Whether case is ignored depends on the kind
1700 of completion. For buffer text the 'ignorecase' option is
1701 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001702
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001703 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001704 completion in the preview window. Only works in
1705 combination with "menu" or "menuone".
1706
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001707
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1709'confirm' 'cf' boolean (default off)
1710 global
1711 {not in Vi}
1712 When 'confirm' is on, certain operations that would normally
1713 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1714 instead raise a |dialog| asking if you wish to save the current
1715 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1716 If 'confirm' is off you can still activate confirmation for one
1717 command only (this is most useful in mappings) with the |:confirm|
1718 command.
1719 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1720
1721 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1722'conskey' 'consk' boolean (default off)
1723 global
1724 {not in Vi} {only for MS-DOS}
1725 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001726 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 three methods of console input are available:
1728 'conskey' 'bioskey' action ~
1729 on on or off direct console input
1730 off on BIOS
1731 off off STDIN
1732
1733 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1734'copyindent' 'ci' boolean (default off)
1735 local to buffer
1736 {not in Vi}
1737 Copy the structure of the existing lines indent when autoindenting a
1738 new line. Normally the new indent is reconstructed by a series of
1739 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1740 in which case only spaces are used). Enabling this option makes the
1741 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001742 existing line. 'expandtab' has no effect on these characters, a Tab
1743 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 line, the remaining space is filled in the normal manner.
1745 NOTE: 'copyindent' is reset when 'compatible' is set.
1746 Also see 'preserveindent'.
1747
1748 *'cpoptions'* *'cpo'*
1749'cpoptions' 'cpo' string (Vim default: "aABceFs",
1750 Vi default: all flags)
1751 global
1752 {not in Vi}
1753 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001754 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 not being vi-compatible is mostly or sometimes preferred.
1756 'cpoptions' stands for "compatible-options".
1757 Commas can be added for readability.
1758 To avoid problems with flags that are added in the future, use the
1759 "+=" and "-=" feature of ":set" |add-option-flags|.
1760 NOTE: This option is set to the Vi default value when 'compatible' is
1761 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001762 NOTE: This option is set to the POSIX default value at startup when
1763 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001764 variable exists |posix|. This means Vim tries to behave like the
1765 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766
1767 contains behavior ~
1768 *cpo-a*
1769 a When included, a ":read" command with a file name
1770 argument will set the alternate file name for the
1771 current window.
1772 *cpo-A*
1773 A When included, a ":write" command with a file name
1774 argument will set the alternate file name for the
1775 current window.
1776 *cpo-b*
1777 b "\|" in a ":map" command is recognized as the end of
1778 the map command. The '\' is included in the mapping,
1779 the text after the '|' is interpreted as the next
1780 command. Use a CTRL-V instead of a backslash to
1781 include the '|' in the mapping. Applies to all
1782 mapping, abbreviation, menu and autocmd commands.
1783 See also |map_bar|.
1784 *cpo-B*
1785 B A backslash has no special meaning in mappings,
1786 abbreviations and the "to" part of the menu commands.
1787 Remove this flag to be able to use a backslash like a
1788 CTRL-V. For example, the command ":map X \<Esc>"
1789 results in X being mapped to:
1790 'B' included: "\^[" (^[ is a real <Esc>)
1791 'B' excluded: "<Esc>" (5 characters)
1792 ('<' excluded in both cases)
1793 *cpo-c*
1794 c Searching continues at the end of any match at the
1795 cursor position, but not further than the start of the
1796 next line. When not present searching continues
1797 one character from the cursor position. With 'c'
1798 "abababababab" only gets three matches when repeating
1799 "/abab", without 'c' there are five matches.
1800 *cpo-C*
1801 C Do not concatenate sourced lines that start with a
1802 backslash. See |line-continuation|.
1803 *cpo-d*
1804 d Using "./" in the 'tags' option doesn't mean to use
1805 the tags file relative to the current file, but the
1806 tags file in the current directory.
1807 *cpo-D*
1808 D Can't use CTRL-K to enter a digraph after Normal mode
1809 commands with a character argument, like |r|, |f| and
1810 |t|.
1811 *cpo-e*
1812 e When executing a register with ":@r", always add a
1813 <CR> to the last line, also when the register is not
1814 linewise. If this flag is not present, the register
1815 is not linewise and the last line does not end in a
1816 <CR>, then the last line is put on the command-line
1817 and can be edited before hitting <CR>.
1818 *cpo-E*
1819 E It is an error when using "y", "d", "c", "g~", "gu" or
1820 "gU" on an Empty region. The operators only work when
1821 at least one character is to be operate on. Example:
1822 This makes "y0" fail in the first column.
1823 *cpo-f*
1824 f When included, a ":read" command with a file name
1825 argument will set the file name for the current buffer,
1826 if the current buffer doesn't have a file name yet.
1827 *cpo-F*
1828 F When included, a ":write" command with a file name
1829 argument will set the file name for the current
1830 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001831 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 *cpo-g*
1833 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001834 *cpo-H*
1835 H When using "I" on a line with only blanks, insert
1836 before the last blank. Without this flag insert after
1837 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 *cpo-i*
1839 i When included, interrupting the reading of a file will
1840 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001841 *cpo-I*
1842 I When moving the cursor up or down just after inserting
1843 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 *cpo-j*
1845 j When joining lines, only add two spaces after a '.',
1846 not after '!' or '?'. Also see 'joinspaces'.
1847 *cpo-J*
1848 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001849 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 white space.
1851 *cpo-k*
1852 k Disable the recognition of raw key codes in
1853 mappings, abbreviations, and the "to" part of menu
1854 commands. For example, if <Key> sends ^[OA (where ^[
1855 is <Esc>), the command ":map X ^[OA" results in X
1856 being mapped to:
1857 'k' included: "^[OA" (3 characters)
1858 'k' excluded: "<Key>" (one key code)
1859 Also see the '<' flag below.
1860 *cpo-K*
1861 K Don't wait for a key code to complete when it is
1862 halfway a mapping. This breaks mapping <F1><F1> when
1863 only part of the second <F1> has been read. It
1864 enables cancelling the mapping by typing <F1><Esc>.
1865 *cpo-l*
1866 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001867 literally, only "\]", "\^", "\-" and "\\" are special.
1868 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1870 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001871 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 *cpo-L*
1873 L When the 'list' option is set, 'wrapmargin',
1874 'textwidth', 'softtabstop' and Virtual Replace mode
1875 (see |gR|) count a <Tab> as two characters, instead of
1876 the normal behavior of a <Tab>.
1877 *cpo-m*
1878 m When included, a showmatch will always wait half a
1879 second. When not included, a showmatch will wait half
1880 a second or until a character is typed. |'showmatch'|
1881 *cpo-M*
1882 M When excluded, "%" matching will take backslashes into
1883 account. Thus in "( \( )" and "\( ( \)" the outer
1884 parenthesis match. When included "%" ignores
1885 backslashes, which is Vi compatible.
1886 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001887 n When included, the column used for 'number' and
1888 'relativenumber' will also be used for text of wrapped
1889 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 *cpo-o*
1891 o Line offset to search command is not remembered for
1892 next search.
1893 *cpo-O*
1894 O Don't complain if a file is being overwritten, even
1895 when it didn't exist when editing it. This is a
1896 protection against a file unexpectedly created by
1897 someone else. Vi didn't complain about this.
1898 *cpo-p*
1899 p Vi compatible Lisp indenting. When not present, a
1900 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001901 *cpo-P*
1902 P When included, a ":write" command that appends to a
1903 file will set the file name for the current buffer, if
1904 the current buffer doesn't have a file name yet and
1905 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001906 *cpo-q*
1907 q When joining multiple lines leave the cursor at the
1908 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909 *cpo-r*
1910 r Redo ("." command) uses "/" to repeat a search
1911 command, instead of the actually used search string.
1912 *cpo-R*
1913 R Remove marks from filtered lines. Without this flag
1914 marks are kept like |:keepmarks| was used.
1915 *cpo-s*
1916 s Set buffer options when entering the buffer for the
1917 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001918 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 set when the buffer is created.
1920 *cpo-S*
1921 S Set buffer options always when entering a buffer
1922 (except 'readonly', 'fileformat', 'filetype' and
1923 'syntax'). This is the (most) Vi compatible setting.
1924 The options are set to the values in the current
1925 buffer. When you change an option and go to another
1926 buffer, the value is copied. Effectively makes the
1927 buffer options global to all buffers.
1928
1929 's' 'S' copy buffer options
1930 no no when buffer created
1931 yes no when buffer first entered (default)
1932 X yes each time when buffer entered (vi comp.)
1933 *cpo-t*
1934 t Search pattern for the tag command is remembered for
1935 "n" command. Otherwise Vim only puts the pattern in
1936 the history for search pattern, but doesn't change the
1937 last used search pattern.
1938 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001939 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 *cpo-v*
1941 v Backspaced characters remain visible on the screen in
1942 Insert mode. Without this flag the characters are
1943 erased from the screen right away. With this flag the
1944 screen newly typed text overwrites backspaced
1945 characters.
1946 *cpo-w*
1947 w When using "cw" on a blank character, only change one
1948 character and not all blanks until the start of the
1949 next word.
1950 *cpo-W*
1951 W Don't overwrite a readonly file. When omitted, ":w!"
1952 overwrites a readonly file, if possible.
1953 *cpo-x*
1954 x <Esc> on the command-line executes the command-line.
1955 The default in Vim is to abandon the command-line,
1956 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001957 *cpo-X*
1958 X When using a count with "R" the replaced text is
1959 deleted only once. Also when repeating "R" with "."
1960 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961 *cpo-y*
1962 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001963 *cpo-Z*
1964 Z When using "w!" while the 'readonly' option is set,
1965 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001966 *cpo-!*
1967 ! When redoing a filter command, use the last used
1968 external command, whatever it was. Otherwise the last
1969 used -filter- command is used.
1970 *cpo-$*
1971 $ When making a change to one line, don't redisplay the
1972 line, but put a '$' at the end of the changed text.
1973 The changed text will be overwritten when you type the
1974 new text. The line is redisplayed if you type any
1975 command that moves the cursor from the insertion
1976 point.
1977 *cpo-%*
1978 % Vi-compatible matching is done for the "%" command.
1979 Does not recognize "#if", "#endif", etc.
1980 Does not recognize "/*" and "*/".
1981 Parens inside single and double quotes are also
1982 counted, causing a string that contains a paren to
1983 disturb the matching. For example, in a line like
1984 "if (strcmp("foo(", s))" the first paren does not
1985 match the last one. When this flag is not included,
1986 parens inside single and double quotes are treated
1987 specially. When matching a paren outside of quotes,
1988 everything inside quotes is ignored. When matching a
1989 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001990 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001991 This flag is also used for other features, such as
1992 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001993 *cpo--*
1994 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001995 it would go above the first line or below the last
1996 line. Without it the cursor moves to the first or
1997 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001998 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001999 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002000 *cpo-+*
2001 + When included, a ":write file" command will reset the
2002 'modified' flag of the buffer, even though the buffer
2003 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002004 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005 * Use ":*" in the same way as ":@". When not included,
2006 ":*" is an alias for ":'<,'>", select the Visual area.
2007 *cpo-<*
2008 < Disable the recognition of special key codes in |<>|
2009 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002010 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 ":map X <Tab>" results in X being mapped to:
2012 '<' included: "<Tab>" (5 characters)
2013 '<' excluded: "^I" (^I is a real <Tab>)
2014 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002015 *cpo->*
2016 > When appending to a register, put a line break before
2017 the appended text.
2018
2019 POSIX flags. These are not included in the Vi default value, except
2020 when $VIM_POSIX was set on startup. |posix|
2021
2022 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002023 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002024 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002025 *cpo-&*
2026 & When ":preserve" was used keep the swap file when
2027 exiting normally while this buffer is still loaded.
2028 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002029 *cpo-\*
2030 \ Backslash in a [] range in a search pattern is taken
2031 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002032 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2033 '\' excluded: "/[ \-]" finds <Space> and '-'
2034 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002035 *cpo-/*
2036 / When "%" is used as the replacement string in a |:s|
2037 command, use the previous replacement string. |:s%|
2038 *cpo-{*
2039 { The |{| and |}| commands also stop at a "{" character
2040 at the start of a line.
2041 *cpo-.*
2042 . The ":chdir" and ":cd" commands fail if the current
2043 buffer is modified, unless ! is used. Vim doesn't
2044 need this, since it remembers the full path of an
2045 opened file.
2046 *cpo-bar*
2047 | The value of the $LINES and $COLUMNS environment
2048 variables overrule the terminal size values obtained
2049 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002050
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002052 *'cryptmethod'* *'cm'*
2053'cryptmethod' number (default 0)
2054 local to buffer
2055 {not in Vi}
2056 Method used for encryption when the buffer is written to a file:
2057 0 PkZip compatible method. A weak kind of encryption.
2058 backwards compatible with Vim 7.2 and older.
2059 1 Blowfish method. Strong encryption. Not compatible
2060 with Vim 7.2 and older.
2061 When reading an encrypted file 'cryptmethod' will be set automatically
2062 to detected method for the file being read.
2063
2064
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065 *'cscopepathcomp'* *'cspc'*
2066'cscopepathcomp' 'cspc' number (default 0)
2067 global
2068 {not available when compiled without the |+cscope|
2069 feature}
2070 {not in Vi}
2071 Determines how many components of the path to show in a list of tags.
2072 See |cscopepathcomp|.
2073
2074 *'cscopeprg'* *'csprg'*
2075'cscopeprg' 'csprg' string (default "cscope")
2076 global
2077 {not available when compiled without the |+cscope|
2078 feature}
2079 {not in Vi}
2080 Specifies the command to execute cscope. See |cscopeprg|.
2081 This option cannot be set from a |modeline| or in the |sandbox|, for
2082 security reasons.
2083
2084 *'cscopequickfix'* *'csqf'*
2085'cscopequickfix' 'csqf' string (default "")
2086 global
2087 {not available when compiled without the |+cscope|
2088 or |+quickfix| features}
2089 {not in Vi}
2090 Specifies whether to use quickfix window to show cscope results.
2091 See |cscopequickfix|.
2092
2093 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2094'cscopetag' 'cst' boolean (default off)
2095 global
2096 {not available when compiled without the |+cscope|
2097 feature}
2098 {not in Vi}
2099 Use cscope for tag commands. See |cscope-options|.
2100 NOTE: This option is reset when 'compatible' is set.
2101
2102 *'cscopetagorder'* *'csto'*
2103'cscopetagorder' 'csto' number (default 0)
2104 global
2105 {not available when compiled without the |+cscope|
2106 feature}
2107 {not in Vi}
2108 Determines the order in which ":cstag" performs a search. See
2109 |cscopetagorder|.
2110 NOTE: This option is set to 0 when 'compatible' is set.
2111
2112 *'cscopeverbose'* *'csverb'*
2113 *'nocscopeverbose'* *'nocsverb'*
2114'cscopeverbose' 'csverb' boolean (default off)
2115 global
2116 {not available when compiled without the |+cscope|
2117 feature}
2118 {not in Vi}
2119 Give messages when adding a cscope database. See |cscopeverbose|.
2120 NOTE: This option is reset when 'compatible' is set.
2121
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002122
2123 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2124'cursorcolumn' 'cuc' boolean (default off)
2125 local to window
2126 {not in Vi}
2127 {not available when compiled without the |+syntax|
2128 feature}
2129 Highlight the screen column of the cursor with CursorColumn
2130 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2131 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002132 If you only want the highlighting in the current window you can use
2133 these autocommands: >
2134 au WinLeave * set nocursorline nocursorcolumn
2135 au WinEnter * set cursorline cursorcolumn
2136<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002137
2138 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2139'cursorline' 'cul' boolean (default off)
2140 local to window
2141 {not in Vi}
2142 {not available when compiled without the |+syntax|
2143 feature}
2144 Highlight the screen line of the cursor with CursorLine
2145 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2146 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002147 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002148 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002149
2150
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151 *'debug'*
2152'debug' string (default "")
2153 global
2154 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002155 These values can be used:
2156 msg Error messages that would otherwise be omitted will be given
2157 anyway.
2158 throw Error messages that would otherwise be omitted will be given
2159 anyway and also throw an exception and set |v:errmsg|.
2160 beep A message will be given when otherwise only a beep would be
2161 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002162 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002163 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2164 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165
2166 *'define'* *'def'*
2167'define' 'def' string (default "^\s*#\s*define")
2168 global or local to buffer |global-local|
2169 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002170 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 pattern, just like for the "/" command. This option is used for the
2172 commands like "[i" and "[d" |include-search|. The 'isident' option is
2173 used to recognize the defined name after the match:
2174 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2175 See |option-backslash| about inserting backslashes to include a space
2176 or backslash.
2177 The default value is for C programs. For C++ this value would be
2178 useful, to include const type declarations: >
2179 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2180< When using the ":set" command, you need to double the backslashes!
2181
2182 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2183'delcombine' 'deco' boolean (default off)
2184 global
2185 {not in Vi}
2186 {only available when compiled with the |+multi_byte|
2187 feature}
2188 If editing Unicode and this option is set, backspace and Normal mode
2189 "x" delete each combining character on its own. When it is off (the
2190 default) the character along with its combining characters are
2191 deleted.
2192 Note: When 'delcombine' is set "xx" may work different from "2x"!
2193
2194 This is useful for Arabic, Hebrew and many other languages where one
2195 may have combining characters overtop of base characters, and want
2196 to remove only the combining ones.
2197
2198 *'dictionary'* *'dict'*
2199'dictionary' 'dict' string (default "")
2200 global or local to buffer |global-local|
2201 {not in Vi}
2202 List of file names, separated by commas, that are used to lookup words
2203 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2204 contain a list of words. This can be one word per line, or several
2205 words per line, separated by non-keyword characters (white space is
2206 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002207 When this option is empty, or an entry "spell" is present, spell
2208 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002209 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 after a comma are ignored, otherwise spaces are included in the file
2211 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002212 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213 Where to find a list of words?
2214 - On FreeBSD, there is the file "/usr/share/dict/words".
2215 - In the Simtel archive, look in the "msdos/linguist" directory.
2216 - In "miscfiles" of the GNU collection.
2217 The use of |:set+=| and |:set-=| is preferred when adding or removing
2218 directories from the list. This avoids problems when a future version
2219 uses another default.
2220 Backticks cannot be used in this option for security reasons.
2221
2222 *'diff'* *'nodiff'*
2223'diff' boolean (default off)
2224 local to window
2225 {not in Vi}
2226 {not available when compiled without the |+diff|
2227 feature}
2228 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002229 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230
2231 *'dex'* *'diffexpr'*
2232'diffexpr' 'dex' string (default "")
2233 global
2234 {not in Vi}
2235 {not available when compiled without the |+diff|
2236 feature}
2237 Expression which is evaluated to obtain an ed-style diff file from two
2238 versions of a file. See |diff-diffexpr|.
2239 This option cannot be set from a |modeline| or in the |sandbox|, for
2240 security reasons.
2241
2242 *'dip'* *'diffopt'*
2243'diffopt' 'dip' string (default "filler")
2244 global
2245 {not in Vi}
2246 {not available when compiled without the |+diff|
2247 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002248 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249 All are optional. Items must be separated by a comma.
2250
2251 filler Show filler lines, to keep the text
2252 synchronized with a window that has inserted
2253 lines at the same position. Mostly useful
2254 when windows are side-by-side and 'scrollbind'
2255 is set.
2256
2257 context:{n} Use a context of {n} lines between a change
2258 and a fold that contains unchanged lines.
2259 When omitted a context of six lines is used.
2260 See |fold-diff|.
2261
2262 icase Ignore changes in case of text. "a" and "A"
2263 are considered the same. Adds the "-i" flag
2264 to the "diff" command if 'diffexpr' is empty.
2265
2266 iwhite Ignore changes in amount of white space. Adds
2267 the "-b" flag to the "diff" command if
2268 'diffexpr' is empty. Check the documentation
2269 of the "diff" command for what this does
2270 exactly. It should ignore adding trailing
2271 white space, but not leading white space.
2272
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002273 horizontal Start diff mode with horizontal splits (unless
2274 explicitly specified otherwise).
2275
2276 vertical Start diff mode with vertical splits (unless
2277 explicitly specified otherwise).
2278
2279 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2280 starting diff mode. Without this 2 is used.
2281
Bram Moolenaar071d4272004-06-13 20:20:40 +00002282 Examples: >
2283
2284 :set diffopt=filler,context:4
2285 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002286 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287<
2288 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2289'digraph' 'dg' boolean (default off)
2290 global
2291 {not in Vi}
2292 {not available when compiled without the |+digraphs|
2293 feature}
2294 Enable the entering of digraphs in Insert mode with {char1} <BS>
2295 {char2}. See |digraphs|.
2296 NOTE: This option is reset when 'compatible' is set.
2297
2298 *'directory'* *'dir'*
2299'directory' 'dir' string (default for Amiga: ".,t:",
2300 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2301 for Unix: ".,~/tmp,/var/tmp,/tmp")
2302 global
2303 List of directory names for the swap file, separated with commas.
2304 - The swap file will be created in the first directory where this is
2305 possible.
2306 - Empty means that no swap file will be used (recovery is
2307 impossible!).
2308 - A directory "." means to put the swap file in the same directory as
2309 the edited file. On Unix, a dot is prepended to the file name, so
2310 it doesn't show in a directory listing. On MS-Windows the "hidden"
2311 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002312 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002313 put the swap file relative to where the edited file is. The leading
2314 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002315 - For Unix and Win32, if a directory ends in two path separators "//"
2316 or "\\", the swap file name will be built from the complete path to
2317 the file with all path separators substituted to percent '%' signs.
2318 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002319 On Win32, when a separating comma is following, you must use "//",
2320 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002321 - Spaces after the comma are ignored, other spaces are considered part
2322 of the directory name. To have a space at the start of a directory
2323 name, precede it with a backslash.
2324 - To include a comma in a directory name precede it with a backslash.
2325 - A directory name may end in an ':' or '/'.
2326 - Environment variables are expanded |:set_env|.
2327 - Careful with '\' characters, type one before a space, type two to
2328 get one in the option (see |option-backslash|), for example: >
2329 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2330< - For backwards compatibility with Vim version 3.0 a '>' at the start
2331 of the option is removed.
2332 Using "." first in the list is recommended. This means that editing
2333 the same file twice will result in a warning. Using "/tmp" on Unix is
2334 discouraged: When the system crashes you lose the swap file.
2335 "/var/tmp" is often not cleared when rebooting, thus is a better
2336 choice than "/tmp". But it can contain a lot of files, your swap
2337 files get lost in the crowd. That is why a "tmp" directory in your
2338 home directory is tried first.
2339 The use of |:set+=| and |:set-=| is preferred when adding or removing
2340 directories from the list. This avoids problems when a future version
2341 uses another default.
2342 This option cannot be set from a |modeline| or in the |sandbox|, for
2343 security reasons.
2344 {Vi: directory to put temp file in, defaults to "/tmp"}
2345
2346 *'display'* *'dy'*
2347'display' 'dy' string (default "")
2348 global
2349 {not in Vi}
2350 Change the way text is displayed. This is comma separated list of
2351 flags:
2352 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002353 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354 last line that doesn't fit is replaced with "@" lines.
2355 uhex Show unprintable characters hexadecimal as <xx>
2356 instead of using ^C and ~C.
2357
2358 *'eadirection'* *'ead'*
2359'eadirection' 'ead' string (default "both")
2360 global
2361 {not in Vi}
2362 {not available when compiled without the +vertsplit
2363 feature}
2364 Tells when the 'equalalways' option applies:
2365 ver vertically, width of windows is not affected
2366 hor horizontally, height of windows is not affected
2367 both width and height of windows is affected
2368
2369 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2370'edcompatible' 'ed' boolean (default off)
2371 global
2372 Makes the 'g' and 'c' flags of the ":substitute" command to be
2373 toggled each time the flag is given. See |complex-change|. See
2374 also 'gdefault' option.
2375 Switching this option on is discouraged!
2376
2377 *'encoding'* *'enc'* *E543*
2378'encoding' 'enc' string (default: "latin1" or value from $LANG)
2379 global
2380 {only available when compiled with the |+multi_byte|
2381 feature}
2382 {not in Vi}
2383 Sets the character encoding used inside Vim. It applies to text in
2384 the buffers, registers, Strings in expressions, text stored in the
2385 viminfo file, etc. It sets the kind of characters which Vim can work
2386 with. See |encoding-names| for the possible values.
2387
2388 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002389 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002391 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392
2393 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2394 "utf-8". Although care has been taken to allow different values of
2395 'encoding', "utf-8" is the natural choice for the environment and
2396 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002397 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 versions, and to avoid changing the encoding of newly created files
2399 without your knowledge (in case 'fileencodings' is empty).
2400
2401 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002402 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403 iconv() or as specified with 'charconvert'.
2404
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002405 If you need to know whether 'encoding' is a multi-byte encoding, you
2406 can use: >
2407 if has("multi_byte_encoding")
2408<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409 Normally 'encoding' will be equal to your current locale. This will
2410 be the default if Vim recognizes your environment settings. If
2411 'encoding' is not set to the current locale, 'termencoding' must be
2412 set to convert typed and displayed text. See |encoding-table|.
2413
2414 When you set this option, it fires the |EncodingChanged| autocommand
2415 event so that you can set up fonts if necessary.
2416
2417 When the option is set, the value is converted to lowercase. Thus
2418 you can set it with uppercase values too. Underscores are translated
2419 to '-' signs.
2420 When the encoding is recognized, it is changed to the standard name.
2421 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2422 "iso-8859-2" and "utf8" becomes "utf-8".
2423
2424 Note: "latin1" is also used when the encoding could not be detected.
2425 This only works when editing files in the same encoding! When the
2426 actual character set is not latin1, make sure 'fileencoding' and
2427 'fileencodings' are empty. When conversion is needed, switch to using
2428 utf-8.
2429
2430 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2431 You don't notice this while editing, but it does matter for the
2432 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2433 setting 'encoding' to one of these values instead of utf-8 only has
2434 effect for encoding used for files when 'fileencoding' is empty.
2435
Bram Moolenaar661b1822005-07-28 22:36:45 +00002436 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2437 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002438
2439 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2440'endofline' 'eol' boolean (default on)
2441 local to buffer
2442 {not in Vi}
2443 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002444 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002445 option is automatically set when starting to edit a new file, unless
2446 the file does not have an <EOL> for the last line in the file, in
2447 which case it is reset. Normally you don't have to set or reset this
2448 option. When 'binary' is off the value is not used when writing the
2449 file. When 'binary' is on it is used to remember the presence of a
2450 <EOL> for the last line in the file, so that when you write the file
2451 the situation from the original file can be kept. But you can change
2452 it if you want to.
2453
2454 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2455'equalalways' 'ea' boolean (default on)
2456 global
2457 {not in Vi}
2458 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002459 splitting or closing a window. This also happens the moment the
2460 option is switched on. When off, splitting a window will reduce the
2461 size of the current window and leave the other windows the same. When
2462 closing a window the extra lines are given to the window next to it
2463 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464 When mixing vertically and horizontally split windows, a minimal size
2465 is computed and some windows may be larger if there is room. The
2466 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002467 Changing the height and width of a window can be avoided by setting
2468 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002469 If a window size is specified when creating a new window sizes are
2470 currently not equalized (it's complicated, but may be implemented in
2471 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472
2473 *'equalprg'* *'ep'*
2474'equalprg' 'ep' string (default "")
2475 global or local to buffer |global-local|
2476 {not in Vi}
2477 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002478 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002479 or 'indentexpr'. When Vim was compiled without internal formatting,
2480 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002481 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482 about including spaces and backslashes.
2483 This option cannot be set from a |modeline| or in the |sandbox|, for
2484 security reasons.
2485
2486 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2487'errorbells' 'eb' boolean (default off)
2488 global
2489 Ring the bell (beep or screen flash) for error messages. This only
2490 makes a difference for error messages, the bell will be used always
2491 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002492 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493 screen flash or do nothing.
2494
2495 *'errorfile'* *'ef'*
2496'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2497 others: "errors.err")
2498 global
2499 {not in Vi}
2500 {not available when compiled without the |+quickfix|
2501 feature}
2502 Name of the errorfile for the QuickFix mode (see |:cf|).
2503 When the "-q" command-line argument is used, 'errorfile' is set to the
2504 following argument. See |-q|.
2505 NOT used for the ":make" command. See 'makeef' for that.
2506 Environment variables are expanded |:set_env|.
2507 See |option-backslash| about including spaces and backslashes.
2508 This option cannot be set from a |modeline| or in the |sandbox|, for
2509 security reasons.
2510
2511 *'errorformat'* *'efm'*
2512'errorformat' 'efm' string (default is very long)
2513 global or local to buffer |global-local|
2514 {not in Vi}
2515 {not available when compiled without the |+quickfix|
2516 feature}
2517 Scanf-like description of the format for the lines in the error file
2518 (see |errorformat|).
2519
2520 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2521'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2522 global
2523 {not in Vi}
2524 Function keys that start with an <Esc> are recognized in Insert
2525 mode. When this option is off, the cursor and function keys cannot be
2526 used in Insert mode if they start with an <Esc>. The advantage of
2527 this is that the single <Esc> is recognized immediately, instead of
2528 after one second. Instead of resetting this option, you might want to
2529 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2530 when 'esckeys' is off, you can still map anything, but the cursor keys
2531 won't work by default.
2532 NOTE: This option is set to the Vi default value when 'compatible' is
2533 set and to the Vim default value when 'compatible' is reset.
2534
2535 *'eventignore'* *'ei'*
2536'eventignore' 'ei' string (default "")
2537 global
2538 {not in Vi}
2539 {not available when compiled without the |+autocmd|
2540 feature}
2541 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002542 When set to "all" or when "all" is one of the items, all autocommand
2543 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 Otherwise this is a comma separated list of event names. Example: >
2545 :set ei=WinEnter,WinLeave
2546<
2547 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2548'expandtab' 'et' boolean (default off)
2549 local to buffer
2550 {not in Vi}
2551 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002552 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2554 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2555 NOTE: This option is reset when 'compatible' is set.
2556
2557 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2558'exrc' 'ex' boolean (default off)
2559 global
2560 {not in Vi}
2561 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2562 directory. If you switch this option on you should also consider
2563 setting the 'secure' option (see |initialization|). Using a local
2564 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2565 also see |.vimrc| and |gui-init|.
2566 This option cannot be set from a |modeline| or in the |sandbox|, for
2567 security reasons.
2568
2569 *'fileencoding'* *'fenc'* *E213*
2570'fileencoding' 'fenc' string (default: "")
2571 local to buffer
2572 {only available when compiled with the |+multi_byte|
2573 feature}
2574 {not in Vi}
2575 Sets the character encoding for the file of this buffer.
2576 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002577 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 When 'fileencoding' is empty, the same value as 'encoding' will be
2579 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002580 Conversion will also be done when 'encoding' and 'fileencoding' are
2581 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2582 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002584 'encoding' is "utf-8" or another Unicode encoding, conversion
2585 is most likely done in a way that the reverse conversion
2586 results in the same text. When 'encoding' is not "utf-8" some
2587 characters may be lost!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 See 'encoding' for the possible values. Additionally, values may be
2589 specified that can be handled by the converter, see
2590 |mbyte-conversion|.
2591 When reading a file 'fileencoding' will be set from 'fileencodings'.
2592 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002593 'fileencoding', use the |++enc| argument. One exception: when
2594 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002595 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2597 When the option is set, the value is converted to lowercase. Thus
2598 you can set it with uppercase values too. '_' characters are
2599 replaced with '-'. If a name is recognized from the list for
2600 'encoding', it is replaced by the standard name. For example
2601 "ISO8859-2" becomes "iso-8859-2".
2602 When this option is set, after starting to edit a file, the 'modified'
2603 option is set, because the file would be different when written.
2604 If you do this in a modeline, you might want to set 'nomodified' to
2605 avoid this.
2606 This option can not be changed when 'modifiable' is off.
2607
2608 *'fe'*
2609 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002610 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 old short name was 'fe', which is no longer used.
2612
2613 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002614'fileencodings' 'fencs' string (default: "ucs-bom",
2615 "ucs-bom,utf-8,default,latin1" when
2616 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002617 global
2618 {only available when compiled with the |+multi_byte|
2619 feature}
2620 {not in Vi}
2621 This is a list of character encodings considered when starting to edit
2622 an existing file. When a file is read, Vim tries to use the first
2623 mentioned character encoding. If an error is detected, the next one
2624 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002625 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626 an empty string, which means the value of 'encoding' is used.
2627 WARNING: Conversion can cause loss of information! When
2628 'encoding' is "utf-8" (or one of the other Unicode variants)
2629 conversion is most likely done in a way that the reverse
2630 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002631 "utf-8" some non-ASCII characters may be lost! You can use
2632 the |++bad| argument to specify what is done with characters
2633 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 For an empty file or a file with only ASCII characters most encodings
2635 will work and the first entry of 'fileencodings' will be used (except
2636 "ucs-bom", which requires the BOM to be present). If you prefer
2637 another encoding use an BufReadPost autocommand event to test if your
2638 preferred encoding is to be used. Example: >
2639 au BufReadPost * if search('\S', 'w') == 0 |
2640 \ set fenc=iso-2022-jp | endif
2641< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2642 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002643 When the |++enc| argument is used then the value of 'fileencodings' is
2644 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002645 Note that 'fileencodings' is not used for a new file, the global value
2646 of 'fileencoding' is used instead. You can set it with: >
2647 :setglobal fenc=iso-8859-2
2648< This means that a non-existing file may get a different encoding than
2649 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002650 The special value "ucs-bom" can be used to check for a Unicode BOM
2651 (Byte Order Mark) at the start of the file. It must not be preceded
2652 by "utf-8" or another Unicode encoding for this to work properly.
2653 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2654 because Vim cannot detect an error, thus the encoding is always
2655 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002656 The special value "default" can be used for the encoding from the
2657 environment. This is the default value for 'encoding'. It is useful
2658 when 'encoding' is set to "utf-8" and your environment uses a
2659 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002660 When 'encoding' is "utf-8" and a file contains an illegal byte
2661 sequence it won't be recognized as UTF-8. You can use the |8g8|
2662 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663 WRONG VALUES: WHAT'S WRONG:
2664 latin1,utf-8 "latin1" will always be used
2665 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2666 file
2667 cp1250,latin1 "cp1250" will always be used
2668 If 'fileencodings' is empty, 'fileencoding' is not modified.
2669 See 'fileencoding' for the possible values.
2670 Setting this option does not have an effect until the next time a file
2671 is read.
2672
2673 *'fileformat'* *'ff'*
2674'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2675 Unix default: "unix",
2676 Macintosh default: "mac")
2677 local to buffer
2678 {not in Vi}
2679 This gives the <EOL> of the current buffer, which is used for
2680 reading/writing the buffer from/to a file:
2681 dos <CR> <NL>
2682 unix <NL>
2683 mac <CR>
2684 When "dos" is used, CTRL-Z at the end of a file is ignored.
2685 See |file-formats| and |file-read|.
2686 For the character encoding of the file see 'fileencoding'.
2687 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2688 works like it was set to "unix'.
2689 This option is set automatically when starting to edit a file and
2690 'fileformats' is not empty and 'binary' is off.
2691 When this option is set, after starting to edit a file, the 'modified'
2692 option is set, because the file would be different when written.
2693 This option can not be changed when 'modifiable' is off.
2694 For backwards compatibility: When this option is set to "dos",
2695 'textmode' is set, otherwise 'textmode' is reset.
2696
2697 *'fileformats'* *'ffs'*
2698'fileformats' 'ffs' string (default:
2699 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2700 Vim Unix: "unix,dos",
2701 Vim Mac: "mac,unix,dos",
2702 Vi Cygwin: "unix,dos",
2703 Vi others: "")
2704 global
2705 {not in Vi}
2706 This gives the end-of-line (<EOL>) formats that will be tried when
2707 starting to edit a new buffer and when reading a file into an existing
2708 buffer:
2709 - When empty, the format defined with 'fileformat' will be used
2710 always. It is not set automatically.
2711 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002712 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713 'fileformats' name will be used when a file is read into an existing
2714 buffer, no matter what 'fileformat' for that buffer is set to.
2715 - When more than one name is present, separated by commas, automatic
2716 <EOL> detection will be done when reading a file. When starting to
2717 edit a file, a check is done for the <EOL>:
2718 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2719 'fileformat' is set to "dos".
2720 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002721 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722 preceding <CR>, "unix" is preferred over "dos".
2723 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2724 This means that "mac" is only chosen when "unix" is not present,
2725 or when no <NL> is found in the file, and when "dos" is not
2726 present, or no <CR><NL> is present in the file.
2727 Also if "unix" was first chosen, but the first <CR> is before
2728 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2729 the file, then 'fileformat' is set to "mac".
2730 4. If 'fileformat' is still not set, the first name from
2731 'fileformats' is used.
2732 When reading a file into an existing buffer, the same is done, but
2733 this happens like 'fileformat' has been set appropriately for that
2734 file only, the option is not changed.
2735 When 'binary' is set, the value of 'fileformats' is not used.
2736
2737 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2738 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2739 done:
2740 - When 'fileformats' is empty, there is no automatic detection. Dos
2741 format will be used.
2742 - When 'fileformats' is set to one or more names, automatic detection
2743 is done. This is based on the first <NL> in the file: If there is a
2744 <CR> in front of it, Dos format is used, otherwise Unix format is
2745 used.
2746 Also see |file-formats|.
2747 For backwards compatibility: When this option is set to an empty
2748 string or one format (no comma is included), 'textauto' is reset,
2749 otherwise 'textauto' is set.
2750 NOTE: This option is set to the Vi default value when 'compatible' is
2751 set and to the Vim default value when 'compatible' is reset.
2752
2753 *'filetype'* *'ft'*
2754'filetype' 'ft' string (default: "")
2755 local to buffer
2756 {not in Vi}
2757 {not available when compiled without the |+autocmd|
2758 feature}
2759 When this option is set, the FileType autocommand event is triggered.
2760 All autocommands that match with the value of this option will be
2761 executed. Thus the value of 'filetype' is used in place of the file
2762 name.
2763 Otherwise this option does not always reflect the current file type.
2764 This option is normally set when the file type is detected. To enable
2765 this use the ":filetype on" command. |:filetype|
2766 Setting this option to a different value is most useful in a modeline,
2767 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002768 Example, for in an IDL file:
2769 /* vim: set filetype=idl : */ ~
2770 |FileType| |filetypes|
2771 When a dot appears in the value then this separates two filetype
2772 names. Example:
2773 /* vim: set filetype=c.doxygen : */ ~
2774 This will use the "c" filetype first, then the "doxygen" filetype.
2775 This works both for filetype plugins and for syntax files. More than
2776 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777 Do not confuse this option with 'osfiletype', which is for the file
2778 type that is actually stored with the file.
2779 This option is not copied to another buffer, independent of the 's' or
2780 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002781 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782
2783 *'fillchars'* *'fcs'*
2784'fillchars' 'fcs' string (default "vert:|,fold:-")
2785 global
2786 {not in Vi}
2787 {not available when compiled without the |+windows|
2788 and |+folding| features}
2789 Characters to fill the statuslines and vertical separators.
2790 It is a comma separated list of items:
2791
2792 item default Used for ~
2793 stl:c ' ' or '^' statusline of the current window
2794 stlnc:c ' ' or '-' statusline of the non-current windows
2795 vert:c '|' vertical separators |:vsplit|
2796 fold:c '-' filling 'foldtext'
2797 diff:c '-' deleted lines of the 'diff' option
2798
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002799 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 "stlnc" the space will be used when there is highlighting, '^' or '-'
2801 otherwise.
2802
2803 Example: >
2804 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2805< This is similar to the default, except that these characters will also
2806 be used when there is highlighting.
2807
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002808 for "stl" and "stlnc" only single-byte values are supported.
2809
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 The highlighting used for these items:
2811 item highlight group ~
2812 stl:c StatusLine |hl-StatusLine|
2813 stlnc:c StatusLineNC |hl-StatusLineNC|
2814 vert:c VertSplit |hl-VertSplit|
2815 fold:c Folded |hl-Folded|
2816 diff:c DiffDelete |hl-DiffDelete|
2817
2818 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2819'fkmap' 'fk' boolean (default off) *E198*
2820 global
2821 {not in Vi}
2822 {only available when compiled with the |+rightleft|
2823 feature}
2824 When on, the keyboard is mapped for the Farsi character set.
2825 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002826 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827
2828 *'foldclose'* *'fcl'*
2829'foldclose' 'fcl' string (default "")
2830 global
2831 {not in Vi}
2832 {not available when compiled without the |+folding|
2833 feature}
2834 When set to "all", a fold is closed when the cursor isn't in it and
2835 its level is higher than 'foldlevel'. Useful if you want folds to
2836 automatically close when moving out of them.
2837
2838 *'foldcolumn'* *'fdc'*
2839'foldcolumn' 'fdc' number (default 0)
2840 local to window
2841 {not in Vi}
2842 {not available when compiled without the |+folding|
2843 feature}
2844 When non-zero, a column with the specified width is shown at the side
2845 of the window which indicates open and closed folds. The maximum
2846 value is 12.
2847 See |folding|.
2848
2849 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2850'foldenable' 'fen' boolean (default on)
2851 local to window
2852 {not in Vi}
2853 {not available when compiled without the |+folding|
2854 feature}
2855 When off, all folds are open. This option can be used to quickly
2856 switch between showing all text unfolded and viewing the text with
2857 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002858 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859 'foldenable' is off.
2860 This option is set by commands that create a new fold or close a fold.
2861 See |folding|.
2862
2863 *'foldexpr'* *'fde'*
2864'foldexpr' 'fde' string (default: "0")
2865 local to window
2866 {not in Vi}
2867 {not available when compiled without the |+folding|
2868 or |+eval| feature}
2869 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002870 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002871
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002872 The expression may be evaluated in the |sandbox|, see
2873 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002874 This option can't be set from a |modeline| when the 'diff' option is
2875 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002876
2877 It is not allowed to change text or jump to another window while
2878 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879
2880 *'foldignore'* *'fdi'*
2881'foldignore' 'fdi' string (default: "#")
2882 local to window
2883 {not in Vi}
2884 {not available when compiled without the |+folding|
2885 feature}
2886 Used only when 'foldmethod' is "indent". Lines starting with
2887 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002888 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 The default "#" works well for C programs. See |fold-indent|.
2890
2891 *'foldlevel'* *'fdl'*
2892'foldlevel' 'fdl' number (default: 0)
2893 local to window
2894 {not in Vi}
2895 {not available when compiled without the |+folding|
2896 feature}
2897 Sets the fold level: Folds with a higher level will be closed.
2898 Setting this option to zero will close all folds. Higher numbers will
2899 close fewer folds.
2900 This option is set by commands like |zm|, |zM| and |zR|.
2901 See |fold-foldlevel|.
2902
2903 *'foldlevelstart'* *'fdls'*
2904'foldlevelstart' 'fdls' number (default: -1)
2905 global
2906 {not in Vi}
2907 {not available when compiled without the |+folding|
2908 feature}
2909 Sets 'foldlevel' when starting to edit another buffer in a window.
2910 Useful to always start editing with all folds closed (value zero),
2911 some folds closed (one) or no folds closed (99).
2912 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002913 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 ignores this option and closes all folds.
2915 It is also done before BufReadPre autocommands, to allow an autocmd to
2916 overrule the 'foldlevel' value for specific files.
2917 When the value is negative, it is not used.
2918
2919 *'foldmarker'* *'fmr'* *E536*
2920'foldmarker' 'fmr' string (default: "{{{,}}}")
2921 local to window
2922 {not in Vi}
2923 {not available when compiled without the |+folding|
2924 feature}
2925 The start and end marker used when 'foldmethod' is "marker". There
2926 must be one comma, which separates the start and end marker. The
2927 marker is a literal string (a regular expression would be too slow).
2928 See |fold-marker|.
2929
2930 *'foldmethod'* *'fdm'*
2931'foldmethod' 'fdm' string (default: "manual")
2932 local to window
2933 {not in Vi}
2934 {not available when compiled without the |+folding|
2935 feature}
2936 The kind of folding used for the current window. Possible values:
2937 |fold-manual| manual Folds are created manually.
2938 |fold-indent| indent Lines with equal indent form a fold.
2939 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2940 |fold-marker| marker Markers are used to specify folds.
2941 |fold-syntax| syntax Syntax highlighting items specify folds.
2942 |fold-diff| diff Fold text that is not changed.
2943
2944 *'foldminlines'* *'fml'*
2945'foldminlines' 'fml' number (default: 1)
2946 local to window
2947 {not in Vi}
2948 {not available when compiled without the |+folding|
2949 feature}
2950 Sets the minimum number of screen lines for a fold to be displayed
2951 closed. Also for manually closed folds.
2952 Note that this only has an effect of what is displayed. After using
2953 "zc" to close a fold, which is displayed open because it's smaller
2954 than 'foldminlines', a following "zc" may close a containing fold.
2955
2956 *'foldnestmax'* *'fdn'*
2957'foldnestmax' 'fdn' number (default: 20)
2958 local to window
2959 {not in Vi}
2960 {not available when compiled without the |+folding|
2961 feature}
2962 Sets the maximum nesting of folds for the "indent" and "syntax"
2963 methods. This avoids that too many folds will be created. Using more
2964 than 20 doesn't work, because the internal limit is 20.
2965
2966 *'foldopen'* *'fdo'*
2967'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2968 search,tag,undo")
2969 global
2970 {not in Vi}
2971 {not available when compiled without the |+folding|
2972 feature}
2973 Specifies for which type of commands folds will be opened, if the
2974 command moves the cursor into a closed fold. It is a comma separated
2975 list of items.
2976 item commands ~
2977 all any
2978 block "(", "{", "[[", "[{", etc.
2979 hor horizontal movements: "l", "w", "fx", etc.
2980 insert any command in Insert mode
2981 jump far jumps: "G", "gg", etc.
2982 mark jumping to a mark: "'m", CTRL-O, etc.
2983 percent "%"
2984 quickfix ":cn", ":crew", ":make", etc.
2985 search search for a pattern: "/", "n", "*", "gd", etc.
2986 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002987 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 tag jumping to a tag: ":ta", CTRL-T, etc.
2989 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002990 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 the |zv| command to the mapping to get the same effect.
2992 When a movement command is used for an operator (e.g., "dl" or "y%")
2993 this option is not used. This means the operator will include the
2994 whole closed fold.
2995 Note that vertical movements are not here, because it would make it
2996 very difficult to move onto a closed fold.
2997 In insert mode the folds containing the cursor will always be open
2998 when text is inserted.
2999 To close folds you can re-apply 'foldlevel' with the |zx| command or
3000 set the 'foldclose' option to "all".
3001
3002 *'foldtext'* *'fdt'*
3003'foldtext' 'fdt' string (default: "foldtext()")
3004 local to window
3005 {not in Vi}
3006 {not available when compiled without the |+folding|
3007 feature}
3008 An expression which is used to specify the text displayed for a closed
3009 fold. See |fold-foldtext|.
3010
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003011 The expression may be evaluated in the |sandbox|, see
3012 |sandbox-option|.
3013
3014 It is not allowed to change text or jump to another window while
3015 evaluating 'foldtext' |textlock|.
3016
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 *'formatoptions'* *'fo'*
3018'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3019 local to buffer
3020 {not in Vi}
3021 This is a sequence of letters which describes how automatic
3022 formatting is to be done. See |fo-table|. When the 'paste' option is
3023 on, no formatting is done (like 'formatoptions' is empty). Commas can
3024 be inserted for readability.
3025 To avoid problems with flags that are added in the future, use the
3026 "+=" and "-=" feature of ":set" |add-option-flags|.
3027 NOTE: This option is set to the Vi default value when 'compatible' is
3028 set and to the Vim default value when 'compatible' is reset.
3029
Bram Moolenaar86b68352004-12-27 21:59:20 +00003030 *'formatlistpat'* *'flp'*
3031'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3032 local to buffer
3033 {not in Vi}
3034 A pattern that is used to recognize a list header. This is used for
3035 the "n" flag in 'formatoptions'.
3036 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003037 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003038 while still checking more characters. There must be a character
3039 following the pattern, when it matches the whole line it is handled
3040 like there is no match.
3041 The default recognizes a number, followed by an optional punctuation
3042 character and white space.
3043
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 *'formatprg'* *'fp'*
3045'formatprg' 'fp' string (default "")
3046 global
3047 {not in Vi}
3048 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003049 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003051 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003052 If the 'formatexpr' option is not empty it will be used instead.
3053 Otherwise, if 'formatprg' option is an empty string, the internal
3054 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003055 Environment variables are expanded |:set_env|. See |option-backslash|
3056 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003057 The expression may be evaluated in the |sandbox|, see
3058 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003060 *'formatexpr'* *'fex'*
3061'formatexpr' 'fex' string (default "")
3062 local to buffer
3063 {not in Vi}
3064 {not available when compiled without the |+eval|
3065 feature}
3066 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003067 operator. When this option is empty 'formatprg' is used.
3068
3069 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003070 The |v:count| variable holds the number of lines to be formatted.
3071 The |v:char| variable holds the character that is going to be
3072 inserted. This can be empty. Don't insert it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003073
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003074 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003075 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003076< This will invoke the mylang#Format() function in the
3077 autoload/mylang.vim file in 'runtimepath'. |autoload|
3078
3079 The expression is also evaluated when 'textwidth' is set and adding
3080 text beyond that limit. This happens under the same conditions as
3081 when internal formatting is used. Make sure the cursor is kept in the
3082 same spot relative to the text then! The |mode()| function will
3083 return "i" or "R" in this situation. When the function returns
3084 non-zero Vim will fall back to using the internal format mechanism.
3085
3086 The expression may be evaluated in the |sandbox|, see
3087 |sandbox-option|.
3088
3089 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003090'fsync' 'fs' boolean (default on)
3091 global
3092 {not in Vi}
3093 When on, the library function fsync() will be called after writing a
3094 file. This will flush a file to disk, ensuring that it is safely
3095 written even on filesystems which do metadata-only journaling. This
3096 will force the harddrive to spin up on Linux systems running in laptop
3097 mode, so it may be undesirable in some situations. Be warned that
3098 turning this off increases the chances of data loss after a crash. On
3099 systems without an fsync() implementation, this variable is always
3100 off.
3101 Also see 'swapsync' for controlling fsync() on swap files.
3102
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3104'gdefault' 'gd' boolean (default off)
3105 global
3106 {not in Vi}
3107 When on, the ":substitute" flag 'g' is default on. This means that
3108 all matches in a line are substituted instead of one. When a 'g' flag
3109 is given to a ":substitute" command, this will toggle the substitution
3110 of all or one match. See |complex-change|.
3111
3112 command 'gdefault' on 'gdefault' off ~
3113 :s/// subst. all subst. one
3114 :s///g subst. one subst. all
3115 :s///gg subst. all subst. one
3116
3117 NOTE: This option is reset when 'compatible' is set.
3118
3119 *'grepformat'* *'gfm'*
3120'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3121 global
3122 {not in Vi}
3123 Format to recognize for the ":grep" command output.
3124 This is a scanf-like string that uses the same format as the
3125 'errorformat' option: see |errorformat|.
3126
3127 *'grepprg'* *'gp'*
3128'grepprg' 'gp' string (default "grep -n ",
3129 Unix: "grep -n $* /dev/null",
3130 Win32: "findstr /n" or "grep -n",
3131 VMS: "SEARCH/NUMBERS ")
3132 global or local to buffer |global-local|
3133 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003134 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 and '#' characters, which are expanded like when used in a command-
3136 line. The placeholder "$*" is allowed to specify where the arguments
3137 will be included. Environment variables are expanded |:set_env|. See
3138 |option-backslash| about including spaces and backslashes.
3139 When your "grep" accepts the "-H" argument, use this to make ":grep"
3140 also work well with a single file: >
3141 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003142< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003143 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3144 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003145 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 apply equally to 'grepprg'.
3147 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3148 otherwise it's "grep -n".
3149 This option cannot be set from a |modeline| or in the |sandbox|, for
3150 security reasons.
3151
3152 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3153'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3154 ve:ver35-Cursor,
3155 o:hor50-Cursor,
3156 i-ci:ver25-Cursor/lCursor,
3157 r-cr:hor20-Cursor/lCursor,
3158 sm:block-Cursor
3159 -blinkwait175-blinkoff150-blinkon175",
3160 for MS-DOS and Win32 console:
3161 "n-v-c:block,o:hor50,i-ci:hor15,
3162 r-cr:hor30,sm:block")
3163 global
3164 {not in Vi}
3165 {only available when compiled with GUI enabled, and
3166 for MS-DOS and Win32 console}
3167 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003168 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 the height of the cursor can be changed. This can be done by
3170 specifying a block cursor, or a percentage for a vertical or
3171 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003172 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003174 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175 mode-list and an argument-list:
3176 mode-list:argument-list,mode-list:argument-list,..
3177 The mode-list is a dash separated list of these modes:
3178 n Normal mode
3179 v Visual mode
3180 ve Visual mode with 'selection' "exclusive" (same as 'v',
3181 if not specified)
3182 o Operator-pending mode
3183 i Insert mode
3184 r Replace mode
3185 c Command-line Normal (append) mode
3186 ci Command-line Insert mode
3187 cr Command-line Replace mode
3188 sm showmatch in Insert mode
3189 a all modes
3190 The argument-list is a dash separated list of these arguments:
3191 hor{N} horizontal bar, {N} percent of the character height
3192 ver{N} vertical bar, {N} percent of the character width
3193 block block cursor, fills the whole character
3194 [only one of the above three should be present]
3195 blinkwait{N} *cursor-blinking*
3196 blinkon{N}
3197 blinkoff{N}
3198 blink times for cursor: blinkwait is the delay before
3199 the cursor starts blinking, blinkon is the time that
3200 the cursor is shown and blinkoff is the time that the
3201 cursor is not shown. The times are in msec. When one
3202 of the numbers is zero, there is no blinking. The
3203 default is: "blinkwait700-blinkon400-blinkoff250".
3204 These numbers are used for a missing entry. This
3205 means that blinking is enabled by default. To switch
3206 blinking off you can use "blinkon0". The cursor only
3207 blinks when Vim is waiting for input, not while
3208 executing a command.
3209 To make the cursor blink in an xterm, see
3210 |xterm-blink|.
3211 {group-name}
3212 a highlight group name, that sets the color and font
3213 for the cursor
3214 {group-name}/{group-name}
3215 Two highlight group names, the first is used when
3216 no language mappings are used, the other when they
3217 are. |language-mapping|
3218
3219 Examples of parts:
3220 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3221 block cursor with colors from the "nCursor"
3222 highlight group
3223 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3224 In Insert and Command-line Insert mode, use a
3225 30% vertical bar cursor with colors from the
3226 "iCursor" highlight group. Blink a bit
3227 faster.
3228
3229 The 'a' mode is different. It will set the given argument-list for
3230 all modes. It does not reset anything to defaults. This can be used
3231 to do a common setting for all modes. For example, to switch off
3232 blinking: "a:blinkon0"
3233
3234 Examples of cursor highlighting: >
3235 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3236 :highlight Cursor gui=NONE guifg=bg guibg=fg
3237<
3238 *'guifont'* *'gfn'*
3239 *E235* *E596* *E610* *E611*
3240'guifont' 'gfn' string (default "")
3241 global
3242 {not in Vi}
3243 {only available when compiled with GUI enabled}
3244 This is a list of fonts which will be used for the GUI version of Vim.
3245 In its simplest form the value is just one font name. When
3246 the font cannot be found you will get an error message. To try other
3247 font names a list can be specified, font names separated with commas.
3248 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003249
Bram Moolenaar05159a02005-02-26 23:04:13 +00003250 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3251 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003252
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253 Spaces after a comma are ignored. To include a comma in a font name
3254 precede it with a backslash. Setting an option requires an extra
3255 backslash before a space and a backslash. See also
3256 |option-backslash|. For example: >
3257 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003258< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003260
3261 If none of the fonts can be loaded, Vim will keep the current setting.
3262 If an empty font list is given, Vim will try using other resource
3263 settings (for X, it will use the Vim.font resource), and finally it
3264 will try some builtin default which should always be there ("7x13" in
3265 the case of X). The font names given should be "normal" fonts. Vim
3266 will try to find the related bold and italic fonts.
3267
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003268 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003269 :set guifont=*
3270< will bring up a font requester, where you can pick the font you want.
3271
3272 The font name depends on the GUI used. See |setting-guifont| for a
3273 way to set 'guifont' for various systems.
3274
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 For the GTK+ 2 GUI the font name looks like this: >
3276 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003277< That's all. XLFDs are not used. For Chinese this is reported to work
3278 well: >
3279 if has("gui_gtk2")
3280 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3281 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3282 endif
3283<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003284 For Mac OSX you can use something like this: >
3285 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003286< Also see 'macatsui', it can help fix display problems.
3287 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003289 width). An exception is GTK 2: all fonts are accepted, but
3290 mono-spaced fonts look best.
3291
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292 To preview a font on X11, you might be able to use the "xfontsel"
3293 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003294
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 For the Win32 GUI *E244* *E245*
3296 - takes these options in the font name:
3297 hXX - height is XX (points, can be floating-point)
3298 wXX - width is XX (points, can be floating-point)
3299 b - bold
3300 i - italic
3301 u - underline
3302 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003303 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3305 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3306 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003307 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308
3309 Use a ':' to separate the options.
3310 - A '_' can be used in the place of a space, so you don't need to use
3311 backslashes to escape the spaces.
3312 - Examples: >
3313 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3314 :set guifont=Andale_Mono:h7.5:w4.5
3315< See also |font-sizes|.
3316
3317 *'guifontset'* *'gfs'*
3318 *E250* *E252* *E234* *E597* *E598*
3319'guifontset' 'gfs' string (default "")
3320 global
3321 {not in Vi}
3322 {only available when compiled with GUI enabled and
3323 with the |+xfontset| feature}
3324 {not available in the GTK+ 2 GUI}
3325 When not empty, specifies two (or more) fonts to be used. The first
3326 one for normal English, the second one for your special language. See
3327 |xfontset|.
3328 Setting this option also means that all font names will be handled as
3329 a fontset name. Also the ones used for the "font" argument of the
3330 |:highlight| command.
3331 The fonts must match with the current locale. If fonts for the
3332 character sets that the current locale uses are not included, setting
3333 'guifontset' will fail.
3334 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3335 the comma-separated names are alternative names, one of which will be
3336 used. In 'guifontset' the whole string is one fontset name,
3337 including the commas. It is not possible to specify alternative
3338 fontset names.
3339 This example works on many X11 systems: >
3340 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3341<
3342 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3343'guifontwide' 'gfw' string (default "")
3344 global
3345 {not in Vi}
3346 {only available when compiled with GUI enabled}
3347 When not empty, specifies a comma-separated list of fonts to be used
3348 for double-width characters. The first font that can be loaded is
3349 used.
3350 Note: The size of these fonts must be exactly twice as wide as the one
3351 specified with 'guifont' and the same height.
3352
3353 All GUI versions but GTK+ 2:
3354
3355 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3356 'guifontset' is empty or invalid.
3357 When 'guifont' is set and a valid font is found in it and
3358 'guifontwide' is empty Vim will attempt to find a matching
3359 double-width font and set 'guifontwide' to it.
3360
3361 GTK+ 2 GUI only: *guifontwide_gtk2*
3362
3363 If set and valid, 'guifontwide' is always used for double width
3364 characters, even if 'encoding' is not set to "utf-8".
3365 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003366 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 font for characters not available in 'guifont'. Thus you do not need
3368 to set 'guifontwide' at all unless you want to override the choice
3369 made by Pango/Xft.
3370
3371 *'guiheadroom'* *'ghr'*
3372'guiheadroom' 'ghr' number (default 50)
3373 global
3374 {not in Vi} {only for GTK and X11 GUI}
3375 The number of pixels subtracted from the screen height when fitting
3376 the GUI window on the screen. Set this before the GUI is started,
3377 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003378 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 lines will be left for window decorations and other items on the
3380 screen. Set it to a negative value to allow windows taller than the
3381 screen.
3382
3383 *'guioptions'* *'go'*
3384'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003385 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 global
3387 {not in Vi}
3388 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003389 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 sequence of letters which describes what components and options of the
3391 GUI should be used.
3392 To avoid problems with flags that are added in the future, use the
3393 "+=" and "-=" feature of ":set" |add-option-flags|.
3394
3395 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003396 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003397 'a' Autoselect: If present, then whenever VISUAL mode is started,
3398 or the Visual area extended, Vim tries to become the owner of
3399 the windowing system's global selection. This means that the
3400 Visually highlighted text is available for pasting into other
3401 applications as well as into Vim itself. When the Visual mode
3402 ends, possibly due to an operation on the text, or when an
3403 application wants to paste the selection, the highlighted text
3404 is automatically yanked into the "* selection register.
3405 Thus the selection is still available for pasting into other
3406 applications after the VISUAL mode has ended.
3407 If not present, then Vim won't become the owner of the
3408 windowing system's global selection unless explicitly told to
3409 by a yank or delete operation for the "* register.
3410 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003411 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003412 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413 applies to the modeless selection.
3414
3415 'guioptions' autoselect Visual autoselect modeless ~
3416 "" - -
3417 "a" yes yes
3418 "A" - yes
3419 "aA" yes yes
3420
Bram Moolenaar02467872007-05-06 13:22:01 +00003421 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003422 'c' Use console dialogs instead of popup dialogs for simple
3423 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003424 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003425 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003426 'guitablabel' can be used to change the text in the labels.
3427 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003428 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003429 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003430 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 'f' Foreground: Don't use fork() to detach the GUI from the shell
3432 where it was started. Use this for programs that wait for the
3433 editor to finish (e.g., an e-mail program). Alternatively you
3434 can use "gvim -f" or ":gui -f" to start the GUI in the
3435 foreground. |gui-fork|
3436 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003437 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003438 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3440 corner of the window. It's black&white on non-GTK, because of
3441 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar02467872007-05-06 13:22:01 +00003442 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443 'm' Menu bar is present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003444 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003445 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003447 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448 file is sourced the system menu has already been loaded; the
3449 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar02467872007-05-06 13:22:01 +00003450 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 'g' Grey menu items: Make menu items that are not active grey. If
3452 'g' is not included inactive menu items are not shown at all.
3453 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003454 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 't' Include tearoff menu items. Currently only works for Win32,
3456 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003457 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003458 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003459 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003460 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 'r' Right-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003462 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 'R' Right-hand scrollbar is present when there is a vertically
3464 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003465 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466 'l' Left-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003467 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 'L' Left-hand scrollbar is present when there is a vertically
3469 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003470 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3472 the longest visible line, or on the cursor line if the 'h'
3473 flag is included. |gui-horiz-scroll|
Bram Moolenaar02467872007-05-06 13:22:01 +00003474 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475 'h' Limit horizontal scrollbar size to the length of the cursor
3476 line. Reduces computations. |gui-horiz-scroll|
3477
3478 And yes, you may even have scrollbars on the left AND the right if
3479 you really want to :-). See |gui-scrollbars| for more information.
3480
Bram Moolenaar02467872007-05-06 13:22:01 +00003481 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 'v' Use a vertical button layout for dialogs. When not included,
3483 a horizontal layout is preferred, but when it doesn't fit a
3484 vertical layout is used anyway.
Bram Moolenaar02467872007-05-06 13:22:01 +00003485 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 'p' Use Pointer callbacks for X11 GUI. This is required for some
3487 window managers. If the cursor is not blinking or hollow at
3488 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003489 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 removing it after the GUI has started has no effect.
Bram Moolenaar02467872007-05-06 13:22:01 +00003491 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003492 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493
Bram Moolenaar02467872007-05-06 13:22:01 +00003494
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 *'guipty'* *'noguipty'*
3496'guipty' boolean (default on)
3497 global
3498 {not in Vi}
3499 {only available when compiled with GUI enabled}
3500 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3501 I/O to/from shell commands. See |gui-pty|.
3502
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003503 *'guitablabel'* *'gtl'*
3504'guitablabel' 'gtl' string (default empty)
3505 global
3506 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003507 {only available when compiled with GUI enabled and
3508 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003509 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003510 pages line. When empty and when the result is empty Vim will use a
3511 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003512
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003513 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003514 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003515
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003516 Only used when the GUI tab pages line is displayed. 'e' must be
3517 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3518 used.
3519
Bram Moolenaar57657d82006-04-21 22:12:41 +00003520 *'guitabtooltip'* *'gtt'*
3521'guitabtooltip' 'gtt' string (default empty)
3522 global
3523 {not in Vi}
3524 {only available when compiled with GUI enabled and
3525 with the +windows feature}
3526 When nonempty describes the text to use in a tooltip for the GUI tab
3527 pages line. When empty Vim will use a default tooltip.
3528 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003529 You can include a line break. Simplest method is to use |:let|: >
3530 :let &guitabtooltip = "line one\nline two"
3531<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003532
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533 *'helpfile'* *'hf'*
3534'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3535 (others) "$VIMRUNTIME/doc/help.txt")
3536 global
3537 {not in Vi}
3538 Name of the main help file. All distributed help files should be
3539 placed together in one directory. Additionally, all "doc" directories
3540 in 'runtimepath' will be used.
3541 Environment variables are expanded |:set_env|. For example:
3542 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003543 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 spaces and backslashes.
3545 This option cannot be set from a |modeline| or in the |sandbox|, for
3546 security reasons.
3547
3548 *'helpheight'* *'hh'*
3549'helpheight' 'hh' number (default 20)
3550 global
3551 {not in Vi}
3552 {not available when compiled without the +windows
3553 feature}
3554 Minimal initial height of the help window when it is opened with the
3555 ":help" command. The initial height of the help window is half of the
3556 current window, or (when the 'ea' option is on) the same as other
3557 windows. When the height is less than 'helpheight', the height is
3558 set to 'helpheight'. Set to zero to disable.
3559
3560 *'helplang'* *'hlg'*
3561'helplang' 'hlg' string (default: messages language or empty)
3562 global
3563 {only available when compiled with the |+multi_lang|
3564 feature}
3565 {not in Vi}
3566 Comma separated list of languages. Vim will use the first language
3567 for which the desired help can be found. The English help will always
3568 be used as a last resort. You can add "en" to prefer English over
3569 another language, but that will only find tags that exist in that
3570 language and not in the English help.
3571 Example: >
3572 :set helplang=de,it
3573< This will first search German, then Italian and finally English help
3574 files.
3575 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3576 try to find the tag in the current language before using this option.
3577 See |help-translated|.
3578
3579 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3580'hidden' 'hid' boolean (default off)
3581 global
3582 {not in Vi}
3583 When off a buffer is unloaded when it is |abandon|ed. When on a
3584 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3585 displayed in another window, it does not become hidden, of course.
3586 The commands that move through the buffer list sometimes make a buffer
3587 hidden although the 'hidden' option is off: When the buffer is
3588 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003589 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003590 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591 This option is set for one command with ":hide {command}" |:hide|.
3592 WARNING: It's easy to forget that you have changes in hidden buffers.
3593 Think twice when using ":q!" or ":qa!".
3594
3595 *'highlight'* *'hl'*
3596'highlight' 'hl' string (default (as a single string):
3597 "8:SpecialKey,@:NonText,d:Directory,
3598 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3599 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003600 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3602 f:Folded,F:FoldColumn,A:DiffAdd,
3603 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003604 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003605 R:SpellRare,L:SpellLocal,
3606 +:Pmenu,=:PmenuSel,
3607 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 global
3609 {not in Vi}
3610 This option can be used to set highlighting mode for various
3611 occasions. It is a comma separated list of character pairs. The
3612 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003613 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3615 |hl-NonText| @ '~' and '@' at the end of the window and
3616 characters from 'showbreak'
3617 |hl-Directory| d directories in CTRL-D listing and other special
3618 things in listings
3619 |hl-ErrorMsg| e error messages
3620 h (obsolete, ignored)
3621 |hl-IncSearch| i 'incsearch' highlighting
3622 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3623 |hl-MoreMsg| m |more-prompt|
3624 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003625 |hl-LineNr| n line number for ":number" and ":#" commands, and
3626 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 |hl-Question| r |hit-enter| prompt and yes/no questions
3628 |hl-StatusLine| s status line of current window |status-line|
3629 |hl-StatusLineNC| S status lines of not-current windows
3630 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3631 |hl-VertSplit| c column used to separate vertically split windows
3632 |hl-Visual| v Visual mode
3633 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3634 Selection" Only X11 Gui's |gui-x11| and
3635 |xterm-clipboard|.
3636 |hl-WarningMsg| w warning messages
3637 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3638 |hl-Folded| f line used for closed folds
3639 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003640 |hl-DiffAdd| A added line in diff mode
3641 |hl-DiffChange| C changed line in diff mode
3642 |hl-DiffDelete| D deleted line in diff mode
3643 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003645 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003646 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003647 |hl-SpellRare| R rare word |spell|
3648 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003649 |hl-Pmenu| + popup menu normal line
3650 |hl-PmenuSel| = popup menu normal line
3651 |hl-PmenuSbar| x popup menu scrollbar
3652 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653
3654 The display modes are:
3655 r reverse (termcap entry "mr" and "me")
3656 i italic (termcap entry "ZH" and "ZR")
3657 b bold (termcap entry "md" and "me")
3658 s standout (termcap entry "so" and "se")
3659 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003660 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 n no highlighting
3662 - no highlighting
3663 : use a highlight group
3664 The default is used for occasions that are not included.
3665 If you want to change what the display modes do, see |dos-colors|
3666 for an example.
3667 When using the ':' display mode, this must be followed by the name of
3668 a highlight group. A highlight group can be used to define any type
3669 of highlighting, including using color. See |:highlight| on how to
3670 define one. The default uses a different group for each occasion.
3671 See |highlight-default| for the default highlight groups.
3672
3673 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3674'hlsearch' 'hls' boolean (default off)
3675 global
3676 {not in Vi}
3677 {not available when compiled without the
3678 |+extra_search| feature}
3679 When there is a previous search pattern, highlight all its matches.
3680 The type of highlighting used can be set with the 'l' occasion in the
3681 'highlight' option. This uses the "Search" highlight group by
3682 default. Note that only the matching text is highlighted, any offsets
3683 are not applied.
3684 See also: 'incsearch' and |:match|.
3685 When you get bored looking at the highlighted matches, you can turn it
3686 off with |:nohlsearch|. As soon as you use a search command, the
3687 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003688 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 When the search pattern can match an end-of-line, Vim will try to
3690 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003691 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003692 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003693 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 NOTE: This option is reset when 'compatible' is set.
3695
3696 *'history'* *'hi'*
3697'history' 'hi' number (Vim default: 20, Vi default: 0)
3698 global
3699 {not in Vi}
3700 A history of ":" commands, and a history of previous search patterns
3701 are remembered. This option decides how many entries may be stored in
3702 each of these histories (see |cmdline-editing|).
3703 NOTE: This option is set to the Vi default value when 'compatible' is
3704 set and to the Vim default value when 'compatible' is reset.
3705
3706 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3707'hkmap' 'hk' boolean (default off)
3708 global
3709 {not in Vi}
3710 {only available when compiled with the |+rightleft|
3711 feature}
3712 When on, the keyboard is mapped for the Hebrew character set.
3713 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3714 toggle this option. See |rileft.txt|.
3715 NOTE: This option is reset when 'compatible' is set.
3716
3717 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3718'hkmapp' 'hkp' boolean (default off)
3719 global
3720 {not in Vi}
3721 {only available when compiled with the |+rightleft|
3722 feature}
3723 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3724 This is useful if you have a non-Hebrew keyboard.
3725 See |rileft.txt|.
3726 NOTE: This option is reset when 'compatible' is set.
3727
3728 *'icon'* *'noicon'*
3729'icon' boolean (default off, on when title can be restored)
3730 global
3731 {not in Vi}
3732 {not available when compiled without the |+title|
3733 feature}
3734 When on, the icon text of the window will be set to the value of
3735 'iconstring' (if it is not empty), or to the name of the file
3736 currently being edited. Only the last part of the name is used.
3737 Overridden by the 'iconstring' option.
3738 Only works if the terminal supports setting window icons (currently
3739 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3740 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3741 builtin termcap).
3742 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003743 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 X11.
3745
3746 *'iconstring'*
3747'iconstring' string (default "")
3748 global
3749 {not in Vi}
3750 {not available when compiled without the |+title|
3751 feature}
3752 When this option is not empty, it will be used for the icon text of
3753 the window. This happens only when the 'icon' option is on.
3754 Only works if the terminal supports setting window icon text
3755 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3756 Does not work for MS Windows.
3757 When Vim was compiled with HAVE_X11 defined, the original icon will be
3758 restored if possible |X11|.
3759 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003760 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003761 'titlestring' for example settings.
3762 {not available when compiled without the |+statusline| feature}
3763
3764 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3765'ignorecase' 'ic' boolean (default off)
3766 global
3767 Ignore case in search patterns. Also used when searching in the tags
3768 file.
3769 Also see 'smartcase'.
3770 Can be overruled by using "\c" or "\C" in the pattern, see
3771 |/ignorecase|.
3772
3773 *'imactivatekey'* *'imak'*
3774'imactivatekey' 'imak' string (default "")
3775 global
3776 {not in Vi}
3777 {only available when compiled with |+xim| and
3778 |+GUI_GTK|}
3779 Specifies the key that your Input Method in X-Windows uses for
3780 activation. When this is specified correctly, vim can fully control
3781 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3782 You can't use this option to change the activation key, the option
3783 tells Vim what the key is.
3784 Format:
3785 [MODIFIER_FLAG-]KEY_STRING
3786
3787 These characters can be used for MODIFIER_FLAG (case is ignored):
3788 S Shift key
3789 L Lock key
3790 C Control key
3791 1 Mod1 key
3792 2 Mod2 key
3793 3 Mod3 key
3794 4 Mod4 key
3795 5 Mod5 key
3796 Combinations are allowed, for example "S-C-space" or "SC-space" are
3797 both shift+ctrl+space.
3798 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3799
3800 Example: >
3801 :set imactivatekey=S-space
3802< "S-space" means shift+space. This is the activation key for kinput2 +
3803 canna (Japanese), and ami (Korean).
3804
3805 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3806'imcmdline' 'imc' boolean (default off)
3807 global
3808 {not in Vi}
3809 {only available when compiled with the |+xim|
3810 |+multi_byte_ime| or |global-ime| feature}
3811 When set the Input Method is always on when starting to edit a command
3812 line, unless entering a search pattern (see 'imsearch' for that).
3813 Setting this option is useful when your input method allows entering
3814 English characters directly, e.g., when it's used to type accented
3815 characters with dead keys.
3816
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003817 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3819 global
3820 {not in Vi}
3821 {only available when compiled with the |+xim|
3822 |+multi_byte_ime| or |global-ime| feature}
3823 When set the Input Method is never used. This is useful to disable
3824 the IM when it doesn't work properly.
3825 Currently this option is on by default for SGI/IRIX machines. This
3826 may change in later releases.
3827
3828 *'iminsert'* *'imi'*
3829'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3830 local to buffer
3831 {not in Vi}
3832 Specifies whether :lmap or an Input Method (IM) is to be used in
3833 Insert mode. Valid values:
3834 0 :lmap is off and IM is off
3835 1 :lmap is ON and IM is off
3836 2 :lmap is off and IM is ON
3837 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3838 or |global-ime|.
3839 To always reset the option to zero when leaving Insert mode with <Esc>
3840 this can be used: >
3841 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3842< This makes :lmap and IM turn off automatically when leaving Insert
3843 mode.
3844 Note that this option changes when using CTRL-^ in Insert mode
3845 |i_CTRL-^|.
3846 The value is set to 1 when setting 'keymap' to a valid keymap name.
3847 It is also used for the argument of commands like "r" and "f".
3848 The value 0 may not work correctly with Athena and Motif with some XIM
3849 methods. Use 'imdisable' to disable XIM then.
3850
3851 *'imsearch'* *'ims'*
3852'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3853 local to buffer
3854 {not in Vi}
3855 Specifies whether :lmap or an Input Method (IM) is to be used when
3856 entering a search pattern. Valid values:
3857 -1 the value of 'iminsert' is used, makes it look like
3858 'iminsert' is also used when typing a search pattern
3859 0 :lmap is off and IM is off
3860 1 :lmap is ON and IM is off
3861 2 :lmap is off and IM is ON
3862 Note that this option changes when using CTRL-^ in Command-line mode
3863 |c_CTRL-^|.
3864 The value is set to 1 when it is not -1 and setting the 'keymap'
3865 option to a valid keymap name.
3866 The value 0 may not work correctly with Athena and Motif with some XIM
3867 methods. Use 'imdisable' to disable XIM then.
3868
3869 *'include'* *'inc'*
3870'include' 'inc' string (default "^\s*#\s*include")
3871 global or local to buffer |global-local|
3872 {not in Vi}
3873 {not available when compiled without the
3874 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003875 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 pattern, just like for the "/" command (See |pattern|). The default
3877 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003878 "]I", "[d", etc.
3879 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003880 comes after the matched pattern. But if "\zs" appears in the pattern
3881 then the text matched from "\zs" to the end, or until "\ze" if it
3882 appears, is used as the file name. Use this to include characters
3883 that are not in 'isfname', such as a space. You can then use
3884 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003885 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886
3887 *'includeexpr'* *'inex'*
3888'includeexpr' 'inex' string (default "")
3889 local to buffer
3890 {not in Vi}
3891 {not available when compiled without the
3892 |+find_in_path| or |+eval| feature}
3893 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003894 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 :set includeexpr=substitute(v:fname,'\\.','/','g')
3896< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003897
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003899 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 Also used for |<cfile>|.
3901
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003902 The expression may be evaluated in the |sandbox|, see
3903 |sandbox-option|.
3904
3905 It is not allowed to change text or jump to another window while
3906 evaluating 'includeexpr' |textlock|.
3907
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3909'incsearch' 'is' boolean (default off)
3910 global
3911 {not in Vi}
3912 {not available when compiled without the
3913 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003914 While typing a search command, show where the pattern, as it was typed
3915 so far, matches. The matched string is highlighted. If the pattern
3916 is invalid or not found, nothing is shown. The screen will be updated
3917 often, this is only useful on fast terminals.
3918 Note that the match will be shown, but the cursor will return to its
3919 original position when no match is found and when pressing <Esc>. You
3920 still need to finish the search command with <Enter> to move the
3921 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003922 When compiled with the |+reltime| feature Vim only searches for about
3923 half a second. With a complicated pattern and/or a lot of text the
3924 match may not be found. This is to avoid that Vim hangs while you
3925 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003926 The highlighting can be set with the 'i' flag in 'highlight'.
3927 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003928 CTRL-L can be used to add one character from after the current match
3929 to the command line.
3930 CTRL-R CTRL-W can be used to add the word at the end of the current
3931 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 NOTE: This option is reset when 'compatible' is set.
3933
3934 *'indentexpr'* *'inde'*
3935'indentexpr' 'inde' string (default "")
3936 local to buffer
3937 {not in Vi}
3938 {not available when compiled without the |+cindent|
3939 or |+eval| features}
3940 Expression which is evaluated to obtain the proper indent for a line.
3941 It is used when a new line is created, for the |=| operator and
3942 in Insert mode as specified with the 'indentkeys' option.
3943 When this option is not empty, it overrules the 'cindent' and
3944 'smartindent' indenting.
3945 When 'paste' is set this option is not used for indenting.
3946 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003947 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 when the expression is evaluated (but it may be moved around).
3949 The expression must return the number of spaces worth of indent. It
3950 can return "-1" to keep the current indent (this means 'autoindent' is
3951 used for the indent).
3952 Functions useful for computing the indent are |indent()|, |cindent()|
3953 and |lispindent()|.
3954 The evaluation of the expression must not have side effects! It must
3955 not change the text, jump to another window, etc. Afterwards the
3956 cursor position is always restored, thus the cursor may be moved.
3957 Normally this option would be set to call a function: >
3958 :set indentexpr=GetMyIndent()
3959< Error messages will be suppressed, unless the 'debug' option contains
3960 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003961 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 NOTE: This option is made empty when 'compatible' is set.
3963
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003964 The expression may be evaluated in the |sandbox|, see
3965 |sandbox-option|.
3966
3967 It is not allowed to change text or jump to another window while
3968 evaluating 'indentexpr' |textlock|.
3969
3970
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971 *'indentkeys'* *'indk'*
3972'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3973 local to buffer
3974 {not in Vi}
3975 {not available when compiled without the |+cindent|
3976 feature}
3977 A list of keys that, when typed in Insert mode, cause reindenting of
3978 the current line. Only happens if 'indentexpr' isn't empty.
3979 The format is identical to 'cinkeys', see |indentkeys-format|.
3980 See |C-indenting| and |indent-expression|.
3981
3982 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3983'infercase' 'inf' boolean (default off)
3984 local to buffer
3985 {not in Vi}
3986 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00003987 'ignorecase' is also on, the case of the match is adjusted depending
3988 on the typed text. If the typed text contains a lowercase letter
3989 where the match has an upper case letter, the completed part is made
3990 lowercase. If the typed text has no lowercase letters and the match
3991 has a lowercase letter where the typed text has an uppercase letter,
3992 and there is a letter before it, the completed part is made uppercase.
3993 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994
3995 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3996'insertmode' 'im' boolean (default off)
3997 global
3998 {not in Vi}
3999 Makes Vim work in a way that Insert mode is the default mode. Useful
4000 if you want to use Vim as a modeless editor. Used for |evim|.
4001 These Insert mode commands will be useful:
4002 - Use the cursor keys to move around.
4003 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4004 this is a mapping, it is executed as if 'insertmode' was off.
4005 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004007 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4008 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009
4010 These items change when 'insertmode' is set:
4011 - when starting to edit of a file, Vim goes to Insert mode.
4012 - <Esc> in Insert mode is a no-op and beeps.
4013 - <Esc> in Normal mode makes Vim go to Insert mode.
4014 - CTRL-L in Insert mode is a command, it is not inserted.
4015 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4016 However, when <Esc> is used inside a mapping, it behaves like
4017 'insertmode' was not set. This was done to be able to use the same
4018 mappings with 'insertmode' set or not set.
4019 When executing commands with |:normal| 'insertmode' is not used.
4020
4021 NOTE: This option is reset when 'compatible' is set.
4022
4023 *'isfname'* *'isf'*
4024'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4025 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4026 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4027 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4028 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4029 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4030 global
4031 {not in Vi}
4032 The characters specified by this option are included in file names and
4033 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004034 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 Multi-byte characters 256 and above are always included, only the
4036 characters up to 255 are specified with this option.
4037 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004038 Think twice before adding white space to this option. Although a
4039 space may appear inside a file name, the effect will be that Vim
4040 doesn't know where a file name starts or ends when doing completion.
4041 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042
4043 Note that on systems using a backslash as path separator, Vim tries to
4044 do its best to make it work as you would expect. That is a bit
4045 tricky, since Vi originally used the backslash to escape special
4046 characters. Vim will not remove a backslash in front of a normal file
4047 name character on these systems, but it will on Unix and alikes. The
4048 '&' and '^' are not included by default, because these are special for
4049 cmd.exe.
4050
4051 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004052 Each part can be a single character number or a range. A range is two
4053 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054 decimal number between 0 and 255 or the ASCII character itself (does
4055 not work for digits). Example:
4056 "_,-,128-140,#-43" (include '_' and '-' and the range
4057 128 to 140 and '#' to 43)
4058 If a part starts with '^', the following character number or range
4059 will be excluded from the option. The option is interpreted from left
4060 to right. Put the excluded character after the range where it is
4061 included. To include '^' itself use it as the last character of the
4062 option or the end of a range. Example:
4063 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4064 If the character is '@', all characters where isalpha() returns TRUE
4065 are included. Normally these are the characters a to z and A to Z,
4066 plus accented characters. To include '@' itself use "@-@". Examples:
4067 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004068 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 "a-z,A-Z,@-@" All letters plus the '@' character.
4070 A comma can be included by using it where a character number is
4071 expected. Example:
4072 "48-57,,,_" Digits, comma and underscore.
4073 A comma can be excluded by prepending a '^'. Example:
4074 " -~,^,,9" All characters from space to '~', excluding
4075 comma, plus <Tab>.
4076 See |option-backslash| about including spaces and backslashes.
4077
4078 *'isident'* *'isi'*
4079'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4080 "@,48-57,_,128-167,224-235"
4081 otherwise: "@,48-57,_,192-255")
4082 global
4083 {not in Vi}
4084 The characters given by this option are included in identifiers.
4085 Identifiers are used in recognizing environment variables and after a
4086 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004087 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 option.
4089 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004090 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4092
4093 *'iskeyword'* *'isk'*
4094'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4095 "@,48-57,_,128-167,224-235"
4096 otherwise: "@,48-57,_,192-255"
4097 Vi default: "@,48-57,_")
4098 local to buffer
4099 {not in Vi}
4100 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004101 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 'isfname' for a description of the format of this option. For C
4103 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4104 For a help file it is set to all non-blank printable characters except
4105 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4106 command).
4107 When the 'lisp' option is on the '-' character is always included.
4108 NOTE: This option is set to the Vi default value when 'compatible' is
4109 set and to the Vim default value when 'compatible' is reset.
4110
4111 *'isprint'* *'isp'*
4112'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4113 "@,~-255"; otherwise: "@,161-255")
4114 global
4115 {not in Vi}
4116 The characters given by this option are displayed directly on the
4117 screen. It is also used for "\p" in a |pattern|. The characters from
4118 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4119 even when they are not included in 'isprint' or excluded. See
4120 'isfname' for a description of the format of this option.
4121
4122 Non-printable characters are displayed with two characters:
4123 0 - 31 "^@" - "^_"
4124 32 - 126 always single characters
4125 127 "^?"
4126 128 - 159 "~@" - "~_"
4127 160 - 254 "| " - "|~"
4128 255 "~?"
4129 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4130 displayed as <xx>, with the hexadecimal value of the byte.
4131 When 'display' contains "uhex" all unprintable characters are
4132 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004133 The SpecialKey highlighting will be used for unprintable characters.
4134 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135
4136 Multi-byte characters 256 and above are always included, only the
4137 characters up to 255 are specified with this option. When a character
4138 is printable but it is not available in the current font, a
4139 replacement character will be shown.
4140 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4141 There is no option to specify these characters.
4142
4143 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4144'joinspaces' 'js' boolean (default on)
4145 global
4146 {not in Vi}
4147 Insert two spaces after a '.', '?' and '!' with a join command.
4148 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4149 Otherwise only one space is inserted.
4150 NOTE: This option is set when 'compatible' is set.
4151
4152 *'key'*
4153'key' string (default "")
4154 local to buffer
4155 {not in Vi}
4156 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004157 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 Careful: Do not set the key value by hand, someone might see the typed
4159 key. Use the |:X| command. But you can make 'key' empty: >
4160 :set key=
4161< It is not possible to get the value of this option with ":set key" or
4162 "echo &key". This is to avoid showing it to someone who shouldn't
4163 know. It also means you cannot see it yourself once you have set it,
4164 be careful not to make a typing error!
4165
4166 *'keymap'* *'kmp'* *E544*
4167'keymap' 'kmp' string (default "")
4168 local to buffer
4169 {not in Vi}
4170 {only available when compiled with the |+keymap|
4171 feature}
4172 Name of a keyboard mapping. See |mbyte-keymap|.
4173 Setting this option to a valid keymap name has the side effect of
4174 setting 'iminsert' to one, so that the keymap becomes effective.
4175 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004176 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177
4178 *'keymodel'* *'km'*
4179'keymodel' 'km' string (default "")
4180 global
4181 {not in Vi}
4182 List of comma separated words, which enable special things that keys
4183 can do. These values can be used:
4184 startsel Using a shifted special key starts selection (either
4185 Select mode or Visual mode, depending on "key" being
4186 present in 'selectmode').
4187 stopsel Using a not-shifted special key stops selection.
4188 Special keys in this context are the cursor keys, <End>, <Home>,
4189 <PageUp> and <PageDown>.
4190 The 'keymodel' option is set by the |:behave| command.
4191
4192 *'keywordprg'* *'kp'*
4193'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4194 OS/2: "view /", VMS: "help")
4195 global or local to buffer |global-local|
4196 {not in Vi}
4197 Program to use for the |K| command. Environment variables are
4198 expanded |:set_env|. ":help" may be used to access the Vim internal
4199 help. (Note that previously setting the global option to the empty
4200 value did this, which is now deprecated.)
4201 When "man" is used, Vim will automatically translate a count for the
4202 "K" command to a section number. Also for "man -s", in which case the
4203 "-s" is removed when there is no count.
4204 See |option-backslash| about including spaces and backslashes.
4205 Example: >
4206 :set keywordprg=man\ -s
4207< This option cannot be set from a |modeline| or in the |sandbox|, for
4208 security reasons.
4209
4210 *'langmap'* *'lmap'* *E357* *E358*
4211'langmap' 'lmap' string (default "")
4212 global
4213 {not in Vi}
4214 {only available when compiled with the |+langmap|
4215 feature}
4216 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004217 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 inserted directly. When in command mode the 'langmap' option takes
4219 care of translating these special characters to the original meaning
4220 of the key. This means you don't have to change the keyboard mode to
4221 be able to execute Normal mode commands.
4222 This is the opposite of the 'keymap' option, where characters are
4223 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004225 Example (for Greek, in UTF-8): *greek* >
4226 :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 +00004227< Example (exchanges meaning of z and y for commands): >
4228 :set langmap=zy,yz,ZY,YZ
4229<
4230 The 'langmap' option is a list of parts, separated with commas. Each
4231 part can be in one of two forms:
4232 1. A list of pairs. Each pair is a "from" character immediately
4233 followed by the "to" character. Examples: "aA", "aAbBcC".
4234 2. A list of "from" characters, a semi-colon and a list of "to"
4235 characters. Example: "abc;ABC"
4236 Example: "aA,fgh;FGH,cCdDeE"
4237 Special characters need to be preceded with a backslash. These are
4238 ";", ',' and backslash itself.
4239
4240 This will allow you to activate vim actions without having to switch
4241 back and forth between the languages. Your language characters will
4242 be understood as normal vim English characters (according to the
4243 langmap mappings) in the following cases:
4244 o Normal/Visual mode (commands, buffer/register names, user mappings)
4245 o Insert/Replace Mode: Register names after CTRL-R
4246 o Insert/Replace Mode: Mappings
4247 Characters entered in Command-line mode will NOT be affected by
4248 this option. Note that this option can be changed at any time
4249 allowing to switch between mappings for different languages/encodings.
4250 Use a mapping to avoid having to type it each time!
4251
4252 *'langmenu'* *'lm'*
4253'langmenu' 'lm' string (default "")
4254 global
4255 {not in Vi}
4256 {only available when compiled with the |+menu| and
4257 |+multi_lang| features}
4258 Language to use for menu translation. Tells which file is loaded
4259 from the "lang" directory in 'runtimepath': >
4260 "lang/menu_" . &langmenu . ".vim"
4261< (without the spaces). For example, to always use the Dutch menus, no
4262 matter what $LANG is set to: >
4263 :set langmenu=nl_NL.ISO_8859-1
4264< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004265 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 If your $LANG is set to a non-English language but you do want to use
4267 the English menus: >
4268 :set langmenu=none
4269< This option must be set before loading menus, switching on filetype
4270 detection or syntax highlighting. Once the menus are defined setting
4271 this option has no effect. But you could do this: >
4272 :source $VIMRUNTIME/delmenu.vim
4273 :set langmenu=de_DE.ISO_8859-1
4274 :source $VIMRUNTIME/menu.vim
4275< Warning: This deletes all menus that you defined yourself!
4276
4277 *'laststatus'* *'ls'*
4278'laststatus' 'ls' number (default 1)
4279 global
4280 {not in Vi}
4281 The value of this option influences when the last window will have a
4282 status line:
4283 0: never
4284 1: only if there are at least two windows
4285 2: always
4286 The screen looks nicer with a status line if you have several
4287 windows, but it takes another screen line. |status-line|
4288
4289 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4290'lazyredraw' 'lz' boolean (default off)
4291 global
4292 {not in Vi}
4293 When this option is set, the screen will not be redrawn while
4294 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004295 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 update use |:redraw|.
4297
4298 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4299'linebreak' 'lbr' boolean (default off)
4300 local to window
4301 {not in Vi}
4302 {not available when compiled without the |+linebreak|
4303 feature}
4304 If on Vim will wrap long lines at a character in 'breakat' rather
4305 than at the last character that fits on the screen. Unlike
4306 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4307 it only affects the way the file is displayed, not its contents. The
4308 value of 'showbreak' is used to put in front of wrapped lines.
4309 This option is not used when the 'wrap' option is off or 'list' is on.
4310 Note that <Tab> characters after an <EOL> are mostly not displayed
4311 with the right amount of white space.
4312
4313 *'lines'* *E593*
4314'lines' number (default 24 or terminal height)
4315 global
4316 Number of lines of the Vim window.
4317 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004318 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 When Vim is running in the GUI or in a resizable window, setting this
4320 option will cause the window size to be changed. When you only want
4321 to use the size for the GUI, put the command in your |gvimrc| file.
4322 Vim limits the number of lines to what fits on the screen. You can
4323 use this command to get the tallest window possible: >
4324 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004325< Minimum value is 2, maximum value is 1000.
4326 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 When you set this option and Vim is unable to change the physical
4328 number of lines of the display, the display may be messed up.
4329
4330 *'linespace'* *'lsp'*
4331'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4332 global
4333 {not in Vi}
4334 {only in the GUI}
4335 Number of pixel lines inserted between characters. Useful if the font
4336 uses the full character cell height, making lines touch each other.
4337 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004338 With some fonts there can be too much room between lines (to have
4339 space for ascents and descents). Then it makes sense to set
4340 'linespace' to a negative value. This may cause display problems
4341 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342
4343 *'lisp'* *'nolisp'*
4344'lisp' boolean (default off)
4345 local to buffer
4346 {not available when compiled without the |+lispindent|
4347 feature}
4348 Lisp mode: When <Enter> is typed in insert mode set the indent for
4349 the next line to Lisp standards (well, sort of). Also happens with
4350 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4351 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4352 better. Also see 'lispwords'.
4353 The '-' character is included in keyword characters. Redefines the
4354 "=" operator to use this same indentation algorithm rather than
4355 calling an external program if 'equalprg' is empty.
4356 This option is not used when 'paste' is set.
4357 {Vi: Does it a little bit differently}
4358
4359 *'lispwords'* *'lw'*
4360'lispwords' 'lw' string (default is very long)
4361 global
4362 {not in Vi}
4363 {not available when compiled without the |+lispindent|
4364 feature}
4365 Comma separated list of words that influence the Lisp indenting.
4366 |'lisp'|
4367
4368 *'list'* *'nolist'*
4369'list' boolean (default off)
4370 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004371 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4372 line. Useful to see the difference between tabs and spaces and for
4373 trailing blanks. Further changed by the 'listchars' option.
4374
4375 The cursor is displayed at the start of the space a Tab character
4376 occupies, not at the end as usual in Normal mode. To get this cursor
4377 position while displaying Tabs with spaces, use: >
4378 :set list lcs=tab\ \
4379<
4380 Note that list mode will also affect formatting (set with 'textwidth'
4381 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382 changing the way tabs are displayed.
4383
4384 *'listchars'* *'lcs'*
4385'listchars' 'lcs' string (default "eol:$")
4386 global
4387 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004388 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 settings.
4390 eol:c Character to show at the end of each line. When
4391 omitted, there is no extra character at the end of the
4392 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004393 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004395 fill the space that the tab normally occupies.
4396 "tab:>-" will show a tab that takes four spaces as
4397 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004398 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 trailing spaces are blank.
4400 extends:c Character to show in the last column, when 'wrap' is
4401 off and the line continues beyond the right of the
4402 screen.
4403 precedes:c Character to show in the first column, when 'wrap'
4404 is off and there is text preceding the character
4405 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004406 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004407 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004409 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004411 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412
4413 Examples: >
4414 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004415 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 :set lcs=extends:>,precedes:<
4417< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004418 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004419 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420
4421 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4422'loadplugins' 'lpl' boolean (default on)
4423 global
4424 {not in Vi}
4425 When on the plugin scripts are loaded when starting up |load-plugins|.
4426 This option can be reset in your |vimrc| file to disable the loading
4427 of plugins.
4428 Note that using the "-u NONE" and "--noplugin" command line arguments
4429 reset this option. |-u| |--noplugin|
4430
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004431 *'macatsui'* *'nomacatsui'*
4432'macatsui' boolean (default on)
4433 global
4434 {only available in Mac GUI version}
4435 This is a workaround for when drawing doesn't work properly. When set
4436 and compiled with multi-byte support ATSUI text drawing is used. When
4437 not set ATSUI text drawing is not used. Switch this option off when
4438 you experience drawing problems. In a future version the problems may
4439 be solved and this option becomes obsolete. Therefore use this method
4440 to unset it: >
4441 if exists('&macatsui')
4442 set nomacatsui
4443 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004444< Another option to check if you have drawing problems is
4445 'termencoding'.
4446
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447 *'magic'* *'nomagic'*
4448'magic' boolean (default on)
4449 global
4450 Changes the special characters that can be used in search patterns.
4451 See |pattern|.
4452 NOTE: To avoid portability problems with using patterns, always keep
4453 this option at the default "on". Only switch it off when working with
4454 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004455 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456
4457 *'makeef'* *'mef'*
4458'makeef' 'mef' string (default: "")
4459 global
4460 {not in Vi}
4461 {not available when compiled without the |+quickfix|
4462 feature}
4463 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4464 and the |:grep| command.
4465 When it is empty, an internally generated temp file will be used.
4466 When "##" is included, it is replaced by a number to make the name
4467 unique. This makes sure that the ":make" command doesn't overwrite an
4468 existing file.
4469 NOT used for the ":cf" command. See 'errorfile' for that.
4470 Environment variables are expanded |:set_env|.
4471 See |option-backslash| about including spaces and backslashes.
4472 This option cannot be set from a |modeline| or in the |sandbox|, for
4473 security reasons.
4474
4475 *'makeprg'* *'mp'*
4476'makeprg' 'mp' string (default "make", VMS: "MMS")
4477 global or local to buffer |global-local|
4478 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004479 Program to use for the ":make" command. See |:make_makeprg|.
4480 This option may contain '%' and '#' characters, which are expanded to
4481 the current and alternate file name. |:_%| |:_#|
4482 Environment variables are expanded |:set_env|. See |option-backslash|
4483 about including spaces and backslashes.
4484 Note that a '|' must be escaped twice: once for ":set" and once for
4485 the interpretation of a command. When you use a filter called
4486 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 :set makeprg=gmake\ \\\|\ myfilter
4488< The placeholder "$*" can be given (even multiple times) to specify
4489 where the arguments will be included, for example: >
4490 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4491< This option cannot be set from a |modeline| or in the |sandbox|, for
4492 security reasons.
4493
4494 *'matchpairs'* *'mps'*
4495'matchpairs' 'mps' string (default "(:),{:},[:]")
4496 local to buffer
4497 {not in Vi}
4498 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004499 other. Currently only single byte character pairs are allowed, and
4500 they must be different. The characters must be separated by a colon.
4501 The pairs must be separated by a comma. Example for including '<' and
4502 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 :set mps+=<:>
4504
4505< A more exotic example, to jump between the '=' and ';' in an
4506 assignment, useful for languages like C and Java: >
4507 :au FileType c,cpp,java set mps+==:;
4508
4509< For a more advanced way of using "%", see the matchit.vim plugin in
4510 the $VIMRUNTIME/macros directory. |add-local-help|
4511
4512 *'matchtime'* *'mat'*
4513'matchtime' 'mat' number (default 5)
4514 global
4515 {not in Vi}{in Nvi}
4516 Tenths of a second to show the matching paren, when 'showmatch' is
4517 set. Note that this is not in milliseconds, like other options that
4518 set a time. This is to be compatible with Nvi.
4519
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004520 *'maxcombine'* *'mco'*
4521'maxcombine' 'mco' number (default 2)
4522 global
4523 {not in Vi}
4524 {only available when compiled with the |+multi_byte|
4525 feature}
4526 The maximum number of combining characters supported for displaying.
4527 Only used when 'encoding' is "utf-8".
4528 The default is OK for most languages. Hebrew may require 4.
4529 Maximum value is 6.
4530 Even when this option is set to 2 you can still edit text with more
4531 combining characters, you just can't see them. Use |g8| or |ga|.
4532 See |mbyte-combining|.
4533
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534 *'maxfuncdepth'* *'mfd'*
4535'maxfuncdepth' 'mfd' number (default 100)
4536 global
4537 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004538 {not available when compiled without the +eval
4539 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540 Maximum depth of function calls for user functions. This normally
4541 catches endless recursion. When using a recursive function with
4542 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4543 more memory, there is the danger of failing when memory is exhausted.
4544 See also |:function|.
4545
4546 *'maxmapdepth'* *'mmd'* *E223*
4547'maxmapdepth' 'mmd' number (default 1000)
4548 global
4549 {not in Vi}
4550 Maximum number of times a mapping is done without resulting in a
4551 character to be used. This normally catches endless mappings, like
4552 ":map x y" with ":map y x". It still does not catch ":map g wg",
4553 because the 'w' is used before the next mapping is done. See also
4554 |key-mapping|.
4555
4556 *'maxmem'* *'mm'*
4557'maxmem' 'mm' number (default between 256 to 5120 (system
4558 dependent) or half the amount of memory
4559 available)
4560 global
4561 {not in Vi}
4562 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4563 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004564 other memory to be freed. The maximum usable value is about 2000000.
4565 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004567 *'maxmempattern'* *'mmp'*
4568'maxmempattern' 'mmp' number (default 1000)
4569 global
4570 {not in Vi}
4571 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004572 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004573 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004574 When Vim runs into the limit it gives an error message and mostly
4575 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004576 Running into the limit often means that the pattern is very
4577 inefficient or too complex. This may already happen with the pattern
4578 "\(.\)*" on a very long line. ".*" works much better.
4579 Vim may run out of memory before hitting the 'maxmempattern' limit.
4580
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 *'maxmemtot'* *'mmt'*
4582'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4583 dependent) or half the amount of memory
4584 available)
4585 global
4586 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004587 Maximum amount of memory in Kbyte to use for all buffers together.
4588 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4589 without a limit. On 64 bit machines higher values might work. But
4590 hey, do you really need more than 2 Gbyte for text editing?
4591 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592
4593 *'menuitems'* *'mis'*
4594'menuitems' 'mis' number (default 25)
4595 global
4596 {not in Vi}
4597 {not available when compiled without the |+menu|
4598 feature}
4599 Maximum number of items to use in a menu. Used for menus that are
4600 generated from a list of items, e.g., the Buffers menu. Changing this
4601 option has no direct effect, the menu must be refreshed first.
4602
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004603 *'mkspellmem'* *'msm'*
4604'mkspellmem' 'msm' string (default "460000,2000,500")
4605 global
4606 {not in Vi}
4607 {not available when compiled without the |+syntax|
4608 feature}
4609 Parameters for |:mkspell|. This tunes when to start compressing the
4610 word tree. Compression can be slow when there are many words, but
4611 it's needed to avoid running out of memory. The amount of memory used
4612 per word depends very much on how similar the words are, that's why
4613 this tuning is complicated.
4614
4615 There are three numbers, separated by commas:
4616 {start},{inc},{added}
4617
4618 For most languages the uncompressed word tree fits in memory. {start}
4619 gives the amount of memory in Kbyte that can be used before any
4620 compression is done. It should be a bit smaller than the amount of
4621 memory that is available to Vim.
4622
4623 When going over the {start} limit the {inc} number specifies the
4624 amount of memory in Kbyte that can be allocated before another
4625 compression is done. A low number means compression is done after
4626 less words are added, which is slow. A high number means more memory
4627 will be allocated.
4628
4629 After doing compression, {added} times 1024 words can be added before
4630 the {inc} limit is ignored and compression is done when any extra
4631 amount of memory is needed. A low number means there is a smaller
4632 chance of hitting the {inc} limit, less memory is used but it's
4633 slower.
4634
4635 The languages for which these numbers are important are Italian and
4636 Hungarian. The default works for when you have about 512 Mbyte. If
4637 you have 1 Gbyte you could use: >
4638 :set mkspellmem=900000,3000,800
4639< If you have less than 512 Mbyte |:mkspell| may fail for some
4640 languages, no matter what you set 'mkspellmem' to.
4641
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004643'modeline' 'ml' boolean (Vim default: on (off for root),
4644 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645 local to buffer
4646 *'modelines'* *'mls'*
4647'modelines' 'mls' number (default 5)
4648 global
4649 {not in Vi}
4650 If 'modeline' is on 'modelines' gives the number of lines that is
4651 checked for set commands. If 'modeline' is off or 'modelines' is zero
4652 no lines are checked. See |modeline|.
4653 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4654 set and to the Vim default value when 'compatible' is reset.
4655
4656 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4657'modifiable' 'ma' boolean (default on)
4658 local to buffer
4659 {not in Vi} *E21*
4660 When off the buffer contents cannot be changed. The 'fileformat' and
4661 'fileencoding' options also can't be changed.
4662 Can be reset with the |-M| command line argument.
4663
4664 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4665'modified' 'mod' boolean (default off)
4666 local to buffer
4667 {not in Vi}
4668 When on, the buffer is considered to be modified. This option is set
4669 when:
4670 1. A change was made to the text since it was last written. Using the
4671 |undo| command to go back to the original text will reset the
4672 option. But undoing changes that were made before writing the
4673 buffer will set the option again, since the text is different from
4674 when it was written.
4675 2. 'fileformat' or 'fileencoding' is different from its original
4676 value. The original value is set when the buffer is read or
4677 written. A ":set nomodified" command also resets the original
4678 values to the current values and the 'modified' option will be
4679 reset.
4680 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4681 will be ignored.
4682
4683 *'more'* *'nomore'*
4684'more' boolean (Vim default: on, Vi default: off)
4685 global
4686 {not in Vi}
4687 When on, listings pause when the whole screen is filled. You will get
4688 the |more-prompt|. When this option is off there are no pauses, the
4689 listing continues until finished.
4690 NOTE: This option is set to the Vi default value when 'compatible' is
4691 set and to the Vim default value when 'compatible' is reset.
4692
4693 *'mouse'* *E538*
4694'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4695 global
4696 {not in Vi}
4697 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004698 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4699 sysmouse and Linux console with gpm). For using the mouse in the
4700 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 The mouse can be enabled for different modes:
4702 n Normal mode
4703 v Visual mode
4704 i Insert mode
4705 c Command-line mode
4706 h all previous modes when editing a help file
4707 a all previous modes
4708 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709 Normally you would enable the mouse in all four modes with: >
4710 :set mouse=a
4711< When the mouse is not enabled, the GUI will still use the mouse for
4712 modeless selection. This doesn't move the text cursor.
4713
4714 See |mouse-using|. Also see |'clipboard'|.
4715
4716 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004717 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 the mouse buttons can still be used by keeping the shift key pressed.
4719 Also see the 'clipboard' option.
4720
4721 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4722'mousefocus' 'mousef' boolean (default off)
4723 global
4724 {not in Vi}
4725 {only works in the GUI}
4726 The window that the mouse pointer is on is automatically activated.
4727 When changing the window layout or window focus in another way, the
4728 mouse pointer is moved to the window with keyboard focus. Off is the
4729 default because it makes using the pull down menus a little goofy, as
4730 a pointer transit may activate a window unintentionally.
4731
4732 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4733'mousehide' 'mh' boolean (default on)
4734 global
4735 {not in Vi}
4736 {only works in the GUI}
4737 When on, the mouse pointer is hidden when characters are typed.
4738 The mouse pointer is restored when the mouse is moved.
4739
4740 *'mousemodel'* *'mousem'*
4741'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4742 global
4743 {not in Vi}
4744 Sets the model to use for the mouse. The name mostly specifies what
4745 the right mouse button is used for:
4746 extend Right mouse button extends a selection. This works
4747 like in an xterm.
4748 popup Right mouse button pops up a menu. The shifted left
4749 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004750 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 popup_setpos Like "popup", but the cursor will be moved to the
4752 position where the mouse was clicked, and thus the
4753 selected operation will act upon the clicked object.
4754 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004755 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 course, that right clicking outside a selection will
4757 end Visual mode.
4758 Overview of what button does what for each model:
4759 mouse extend popup(_setpos) ~
4760 left click place cursor place cursor
4761 left drag start selection start selection
4762 shift-left search word extend selection
4763 right click extend selection popup menu (place cursor)
4764 right drag extend selection -
4765 middle click paste paste
4766
4767 In the "popup" model the right mouse button produces a pop-up menu.
4768 You need to define this first, see |popup-menu|.
4769
4770 Note that you can further refine the meaning of buttons with mappings.
4771 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4772 selection (because that's handled in the GUI code directly).
4773
4774 The 'mousemodel' option is set by the |:behave| command.
4775
4776 *'mouseshape'* *'mouses'* *E547*
4777'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004778 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004779 global
4780 {not in Vi}
4781 {only available when compiled with the |+mouseshape|
4782 feature}
4783 This option tells Vim what the mouse pointer should look like in
4784 different modes. The option is a comma separated list of parts, much
4785 like used for 'guicursor'. Each part consist of a mode/location-list
4786 and an argument-list:
4787 mode-list:shape,mode-list:shape,..
4788 The mode-list is a dash separated list of these modes/locations:
4789 In a normal window: ~
4790 n Normal mode
4791 v Visual mode
4792 ve Visual mode with 'selection' "exclusive" (same as 'v',
4793 if not specified)
4794 o Operator-pending mode
4795 i Insert mode
4796 r Replace mode
4797
4798 Others: ~
4799 c appending to the command-line
4800 ci inserting in the command-line
4801 cr replacing in the command-line
4802 m at the 'Hit ENTER' or 'More' prompts
4803 ml idem, but cursor in the last line
4804 e any mode, pointer below last window
4805 s any mode, pointer on a status line
4806 sd any mode, while dragging a status line
4807 vs any mode, pointer on a vertical separator line
4808 vd any mode, while dragging a vertical separator line
4809 a everywhere
4810
4811 The shape is one of the following:
4812 avail name looks like ~
4813 w x arrow Normal mouse pointer
4814 w x blank no pointer at all (use with care!)
4815 w x beam I-beam
4816 w x updown up-down sizing arrows
4817 w x leftright left-right sizing arrows
4818 w x busy The system's usual busy pointer
4819 w x no The system's usual 'no input' pointer
4820 x udsizing indicates up-down resizing
4821 x lrsizing indicates left-right resizing
4822 x crosshair like a big thin +
4823 x hand1 black hand
4824 x hand2 white hand
4825 x pencil what you write with
4826 x question big ?
4827 x rightup-arrow arrow pointing right-up
4828 w x up-arrow arrow pointing up
4829 x <number> any X11 pointer number (see X11/cursorfont.h)
4830
4831 The "avail" column contains a 'w' if the shape is available for Win32,
4832 x for X11.
4833 Any modes not specified or shapes not available use the normal mouse
4834 pointer.
4835
4836 Example: >
4837 :set mouseshape=s:udsizing,m:no
4838< will make the mouse turn to a sizing arrow over the status lines and
4839 indicate no input when the hit-enter prompt is displayed (since
4840 clicking the mouse has no effect in this state.)
4841
4842 *'mousetime'* *'mouset'*
4843'mousetime' 'mouset' number (default 500)
4844 global
4845 {not in Vi}
4846 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4847 time in msec between two mouse clicks for the second click to be
4848 recognized as a multi click.
4849
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004850 *'mzquantum'* *'mzq'*
4851'mzquantum' 'mzq' number (default 100)
4852 global
4853 {not in Vi}
4854 {not available when compiled without the |+mzscheme|
4855 feature}
4856 The number of milliseconds between polls for MzScheme threads.
4857 Negative or zero value means no thread scheduling.
4858
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 *'nrformats'* *'nf'*
4860'nrformats' 'nf' string (default "octal,hex")
4861 local to buffer
4862 {not in Vi}
4863 This defines what bases Vim will consider for numbers when using the
4864 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4865 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004866 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 incremented or decremented. This is useful for a list with a
4868 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004869 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004871 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 considered to be hexadecimal. Example: Using CTRL-X on
4873 "0x100" results in "0x0ff".
4874 Numbers which simply begin with a digit in the range 1-9 are always
4875 considered decimal. This also happens for numbers that are not
4876 recognized as octal or hex.
4877
4878 *'number'* *'nu'* *'nonumber'* *'nonu'*
4879'number' 'nu' boolean (default off)
4880 local to window
4881 Print the line number in front of each line. When the 'n' option is
4882 excluded from 'cpoptions' a wrapped line will not use the column of
4883 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004884 The 'numberwidth' option can be used to set the room used for the line
4885 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 When a long, wrapped line doesn't start with the first character, '-'
4887 characters are put before the number.
4888 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02004889 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004891 *'numberwidth'* *'nuw'*
4892'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4893 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004894 {not in Vi}
4895 {only available when compiled with the |+linebreak|
4896 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004897 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02004898 when the 'number' or 'relativenumber' option is set or printing lines
4899 with a line number. Since one space is always between the number and
4900 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004901 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02004902 fit the highest line number in the buffer respectively the number of
4903 rows in the window, depending on whether 'number' or 'relativenumber'
4904 is set. Thus with the Vim default of 4 there is room for a line number
4905 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004906 The minimum value is 1, the maximum value is 10.
4907 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4908
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004909 *'omnifunc'* *'ofu'*
4910'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004911 local to buffer
4912 {not in Vi}
4913 {not available when compiled without the +eval
4914 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004915 This option specifies a function to be used for Insert mode omni
4916 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004917 See |complete-functions| for an explanation of how the function is
4918 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00004919 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00004920 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00004921
4922
Bram Moolenaar02467872007-05-06 13:22:01 +00004923 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00004924'opendevice' 'odev' boolean (default off)
4925 global
4926 {not in Vi}
4927 {only for MS-DOS, MS-Windows and OS/2}
4928 Enable reading and writing from devices. This may get Vim stuck on a
4929 device that can be opened but doesn't actually do the I/O. Therefore
4930 it is off by default.
4931 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
4932 result in editing a device.
4933
4934
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004935 *'operatorfunc'* *'opfunc'*
4936'operatorfunc' 'opfunc' string (default: empty)
4937 global
4938 {not in Vi}
4939 This option specifies a function to be called by the |g@| operator.
4940 See |:map-operator| for more info and an example.
4941
4942 This option cannot be set from a |modeline| or in the |sandbox|, for
4943 security reasons.
4944
4945
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 *'osfiletype'* *'oft'* *E366*
4947'osfiletype' 'oft' string (RISC-OS default: "Text",
4948 others default: "")
4949 local to buffer
4950 {not in Vi}
4951 {only available when compiled with the |+osfiletype|
4952 feature}
4953 Some operating systems store extra information about files besides
4954 name, datestamp and permissions. This option contains the extra
4955 information, the nature of which will vary between systems.
4956 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00004957 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 It can affect the pattern matching of the automatic commands.
4959 |autocmd-osfiletypes|
4960
4961 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00004962'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004963 global
4964 Specifies the nroff macros that separate paragraphs. These are pairs
4965 of two letters (see |object-motions|).
4966
4967 *'paste'* *'nopaste'*
4968'paste' boolean (default off)
4969 global
4970 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004971 Put Vim in Paste mode. This is useful if you want to cut or copy
4972 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 unexpected effects.
4974 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004975 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 knows about pasting and will mostly do the right thing without 'paste'
4977 being set. The same is true for a terminal where Vim handles the
4978 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004979 This option is reset when starting the GUI. Thus if you set it in
4980 your .vimrc it will work in a terminal, but not in the GUI. Setting
4981 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4982 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983 When the 'paste' option is switched on (also when it was already on):
4984 - mapping in Insert mode and Command-line mode is disabled
4985 - abbreviations are disabled
4986 - 'textwidth' is set to 0
4987 - 'wrapmargin' is set to 0
4988 - 'autoindent' is reset
4989 - 'smartindent' is reset
4990 - 'softtabstop' is set to 0
4991 - 'revins' is reset
4992 - 'ruler' is reset
4993 - 'showmatch' is reset
4994 - 'formatoptions' is used like it is empty
4995 These options keep their value, but their effect is disabled:
4996 - 'lisp'
4997 - 'indentexpr'
4998 - 'cindent'
4999 NOTE: When you start editing another file while the 'paste' option is
5000 on, settings from the modelines or autocommands may change the
5001 settings again, causing trouble when pasting text. You might want to
5002 set the 'paste' option again.
5003 When the 'paste' option is reset the mentioned options are restored to
5004 the value before the moment 'paste' was switched from off to on.
5005 Resetting 'paste' before ever setting it does not have any effect.
5006 Since mapping doesn't work while 'paste' is active, you need to use
5007 the 'pastetoggle' option to toggle the 'paste' option with some key.
5008
5009 *'pastetoggle'* *'pt'*
5010'pastetoggle' 'pt' string (default "")
5011 global
5012 {not in Vi}
5013 When non-empty, specifies the key sequence that toggles the 'paste'
5014 option. This is like specifying a mapping: >
5015 :map {keys} :set invpaste<CR>
5016< Where {keys} is the value of 'pastetoggle'.
5017 The difference is that it will work even when 'paste' is set.
5018 'pastetoggle' works in Insert mode and Normal mode, but not in
5019 Command-line mode.
5020 Mappings are checked first, thus overrule 'pastetoggle'. However,
5021 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5022 this: >
5023 :map <F10> :set paste<CR>
5024 :map <F11> :set nopaste<CR>
5025 :imap <F10> <C-O>:set paste<CR>
5026 :imap <F11> <nop>
5027 :set pastetoggle=<F11>
5028< This will make <F10> start paste mode and <F11> stop paste mode.
5029 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5030 mode everything is inserted literally, except the 'pastetoggle' key
5031 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005032 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033
5034 *'pex'* *'patchexpr'*
5035'patchexpr' 'pex' string (default "")
5036 global
5037 {not in Vi}
5038 {not available when compiled without the |+diff|
5039 feature}
5040 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005041 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042
5043 *'patchmode'* *'pm'* *E206*
5044'patchmode' 'pm' string (default "")
5045 global
5046 {not in Vi}
5047 When non-empty the oldest version of a file is kept. This can be used
5048 to keep the original version of a file if you are changing files in a
5049 source distribution. Only the first time that a file is written a
5050 copy of the original file will be kept. The name of the copy is the
5051 name of the original file with the string in the 'patchmode' option
5052 appended. This option should start with a dot. Use a string like
5053 ".org". 'backupdir' must not be empty for this to work (Detail: The
5054 backup file is renamed to the patchmode file after the new file has
5055 been successfully written, that's why it must be possible to write a
5056 backup file). If there was no file to be backed up, an empty file is
5057 created.
5058 When the 'backupskip' pattern matches, a patchmode file is not made.
5059 Using 'patchmode' for compressed files appends the extension at the
5060 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5061 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005062 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063
5064 *'path'* *'pa'* *E343* *E345* *E347*
5065'path' 'pa' string (default on Unix: ".,/usr/include,,"
5066 on OS/2: ".,/emx/include,,"
5067 other systems: ".,,")
5068 global or local to buffer |global-local|
5069 {not in Vi}
5070 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005071 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5072 provided that the file being searched for has a relative path (not
5073 starting with "/", "./" or "../"). The directories in the 'path'
5074 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 - Use commas to separate directory names: >
5076 :set path=.,/usr/local/include,/usr/include
5077< - Spaces can also be used to separate directory names (for backwards
5078 compatibility with version 3.0). To have a space in a directory
5079 name, precede it with an extra backslash, and escape the space: >
5080 :set path=.,/dir/with\\\ space
5081< - To include a comma in a directory name precede it with an extra
5082 backslash: >
5083 :set path=.,/dir/with\\,comma
5084< - To search relative to the directory of the current file, use: >
5085 :set path=.
5086< - To search in the current directory use an empty string between two
5087 commas: >
5088 :set path=,,
5089< - A directory name may end in a ':' or '/'.
5090 - Environment variables are expanded |:set_env|.
5091 - When using |netrw.vim| URLs can be used. For example, adding
5092 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005093 - Search upwards and downwards in a directory tree using "*", "**" and
5094 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095 {not available when compiled without the |+path_extra| feature}
5096 - Careful with '\' characters, type two to get one in the option: >
5097 :set path=.,c:\\include
5098< Or just use '/' instead: >
5099 :set path=.,c:/include
5100< Don't forget "." or files won't even be found in the same directory as
5101 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005102 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103 it is something like 256 or 1024 characters.
5104 You can check if all the include files are found, using the value of
5105 'path', see |:checkpath|.
5106 The use of |:set+=| and |:set-=| is preferred when adding or removing
5107 directories from the list. This avoids problems when a future version
5108 uses another default. To remove the current directory use: >
5109 :set path-=
5110< To add the current directory use: >
5111 :set path+=
5112< To use an environment variable, you probably need to replace the
5113 separator. Here is an example to append $INCL, in which directory
5114 names are separated with a semi-colon: >
5115 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5116< Replace the ';' with a ':' or whatever separator is used. Note that
5117 this doesn't work when $INCL contains a comma or white space.
5118
5119 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5120'preserveindent' 'pi' boolean (default off)
5121 local to buffer
5122 {not in Vi}
5123 When changing the indent of the current line, preserve as much of the
5124 indent structure as possible. Normally the indent is replaced by a
5125 series of tabs followed by spaces as required (unless |'expandtab'| is
5126 enabled, in which case only spaces are used). Enabling this option
5127 means the indent will preserve as many existing characters as possible
5128 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005129 'expandtab' does not apply to the preserved white space, a Tab remains
5130 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005131 NOTE: When using ">>" multiple times the resulting indent is a mix of
5132 tabs and spaces. You might not like this.
5133 NOTE: 'preserveindent' is reset when 'compatible' is set.
5134 Also see 'copyindent'.
5135 Use |:retab| to clean up white space.
5136
5137 *'previewheight'* *'pvh'*
5138'previewheight' 'pvh' number (default 12)
5139 global
5140 {not in Vi}
5141 {not available when compiled without the |+windows| or
5142 |+quickfix| feature}
5143 Default height for a preview window. Used for |:ptag| and associated
5144 commands. Used for |CTRL-W_}| when no count is given.
5145
5146 *'previewwindow'* *'nopreviewwindow'*
5147 *'pvw'* *'nopvw'* *E590*
5148'previewwindow' 'pvw' boolean (default off)
5149 local to window
5150 {not in Vi}
5151 {not available when compiled without the |+windows| or
5152 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005153 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 set. It's normally not set directly, but by using one of the commands
5155 |:ptag|, |:pedit|, etc.
5156
5157 *'printdevice'* *'pdev'*
5158'printdevice' 'pdev' string (default empty)
5159 global
5160 {not in Vi}
5161 {only available when compiled with the |+printer|
5162 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005163 The name of the printer to be used for |:hardcopy|.
5164 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005165 This option cannot be set from a |modeline| or in the |sandbox|, for
5166 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167
Bram Moolenaar8299df92004-07-10 09:47:34 +00005168 *'printencoding'* *'penc'*
5169'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 global
5171 {not in Vi}
5172 {only available when compiled with the |+printer|
5173 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005174 Sets the character encoding used when printing.
5175 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005176
5177 *'printexpr'* *'pexpr'*
5178'printexpr' 'pexpr' String (default: see below)
5179 global
5180 {not in Vi}
5181 {only available when compiled with the |+printer|
5182 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005183 Expression used to print the PostScript produced with |:hardcopy|.
5184 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185
Bram Moolenaar8299df92004-07-10 09:47:34 +00005186 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187'printfont' 'pfn' string (default "courier")
5188 global
5189 {not in Vi}
5190 {only available when compiled with the |+printer|
5191 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005192 The name of the font that will be used for |:hardcopy|.
5193 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194
5195 *'printheader'* *'pheader'*
5196'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5197 global
5198 {not in Vi}
5199 {only available when compiled with the |+printer|
5200 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005201 The format of the header produced in |:hardcopy| output.
5202 See |pheader-option|.
5203
5204 *'printmbcharset'* *'pmbcs'*
5205'printmbcharset' 'pmbcs' string (default "")
5206 global
5207 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005208 {only available when compiled with the |+printer|,
5209 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005210 The CJK character set to be used for CJK output from |:hardcopy|.
5211 See |pmbcs-option|.
5212
5213 *'printmbfont'* *'pmbfn'*
5214'printmbfont' 'pmbfn' string (default "")
5215 global
5216 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005217 {only available when compiled with the |+printer|,
5218 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005219 List of font names to be used for CJK output from |:hardcopy|.
5220 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221
5222 *'printoptions'* *'popt'*
5223'printoptions' 'popt' string (default "")
5224 global
5225 {not in Vi}
5226 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005227 List of items that control the format of the output of |:hardcopy|.
5228 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005230 *'prompt'* *'noprompt'*
5231'prompt' boolean (default on)
5232 global
5233 When on a ":" prompt is used in Ex mode.
5234
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005235 *'pumheight'* *'ph'*
5236'pumheight' 'ph' number (default 0)
5237 global
5238 {not available when compiled without the
5239 |+insert_expand| feature}
5240 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005241 Determines the maximum number of items to show in the popup menu for
5242 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005243 |ins-completion-menu|.
5244
5245
Bram Moolenaar677ee682005-01-27 14:41:15 +00005246 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005247'quoteescape' 'qe' string (default "\")
5248 local to buffer
5249 {not in Vi}
5250 The characters that are used to escape quotes in a string. Used for
5251 objects like a', a" and a` |a'|.
5252 When one of the characters in this option is found inside a string,
5253 the following character will be skipped. The default value makes the
5254 text "foo\"bar\\" considered to be one string.
5255
Bram Moolenaar071d4272004-06-13 20:20:40 +00005256 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5257'readonly' 'ro' boolean (default off)
5258 local to buffer
5259 If on, writes fail unless you use a '!'. Protects you from
5260 accidentally overwriting a file. Default on when Vim is started
5261 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005262 When using ":w!" the 'readonly' option is reset for the current
5263 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005265 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005267 *'redrawtime'* *'rdt'*
5268'redrawtime' 'rdt' number (default 2000)
5269 global
5270 {not in Vi}
5271 {only available when compiled with the |+reltime|
5272 feature}
5273 The time in milliseconds for redrawing the display. This applies to
5274 searching for patterns for 'hlsearch' and |:match| highlighting.
5275 When redrawing takes more than this many milliseconds no further
5276 matches will be highlighted. This is used to avoid that Vim hangs
5277 when using a very complicated pattern.
5278
Bram Moolenaar64486672010-05-16 15:46:46 +02005279 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5280'relativenumber' 'rnu' boolean (default off)
5281 local to window
5282 {not in Vi}
5283 Show the line number relative to the line with the cursor in front of
5284 each line. Relative line numbers help you using the |count| you can
5285 precede some vertical motion commands (e.g. j k + -) with, without
5286 having to calculate it yourself. Especially useful in combination with
5287 other commands (e.g. y d c < > gq gw =).
5288 When the 'n' option is excluded from 'cpoptions' a wrapped
5289 line will not use the column of line numbers (this is the default when
5290 'compatible' isn't set).
5291 The 'numberwidth' option can be used to set the room used for the line
5292 number.
5293 When a long, wrapped line doesn't start with the first character, '-'
5294 characters are put before the number.
5295 See |hl-LineNr| for the highlighting used for the number.
5296 When setting this option, 'number' is reset.
5297
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298 *'remap'* *'noremap'*
5299'remap' boolean (default on)
5300 global
5301 Allows for mappings to work recursively. If you do not want this for
5302 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005303 NOTE: To avoid portability problems with Vim scripts, always keep
5304 this option at the default "on". Only switch it off when working with
5305 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005306
5307 *'report'*
5308'report' number (default 2)
5309 global
5310 Threshold for reporting number of lines changed. When the number of
5311 changed lines is more than 'report' a message will be given for most
5312 ":" commands. If you want it always, set 'report' to 0.
5313 For the ":substitute" command the number of substitutions is used
5314 instead of the number of lines.
5315
5316 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5317'restorescreen' 'rs' boolean (default on)
5318 global
5319 {not in Vi} {only in Windows 95/NT console version}
5320 When set, the screen contents is restored when exiting Vim. This also
5321 happens when executing external commands.
5322
5323 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5324 options in your .vimrc. To disable restoring:
5325 set t_ti= t_te=
5326 To enable restoring (for an xterm):
5327 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5328 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5329
5330 *'revins'* *'ri'* *'norevins'* *'nori'*
5331'revins' 'ri' boolean (default off)
5332 global
5333 {not in Vi}
5334 {only available when compiled with the |+rightleft|
5335 feature}
5336 Inserting characters in Insert mode will work backwards. See "typing
5337 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5338 command in Insert mode, when 'allowrevins' is set.
5339 NOTE: This option is reset when 'compatible' or 'paste' is set.
5340
5341 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5342'rightleft' 'rl' boolean (default off)
5343 local to window
5344 {not in Vi}
5345 {only available when compiled with the |+rightleft|
5346 feature}
5347 When on, display orientation becomes right-to-left, i.e., characters
5348 that are stored in the file appear from the right to the left.
5349 Using this option, it is possible to edit files for languages that
5350 are written from the right to the left such as Hebrew and Arabic.
5351 This option is per window, so it is possible to edit mixed files
5352 simultaneously, or to view the same file in both ways (this is
5353 useful whenever you have a mixed text file with both right-to-left
5354 and left-to-right strings so that both sets are displayed properly
5355 in different windows). Also see |rileft.txt|.
5356
5357 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5358'rightleftcmd' 'rlc' string (default "search")
5359 local to window
5360 {not in Vi}
5361 {only available when compiled with the |+rightleft|
5362 feature}
5363 Each word in this option enables the command line editing to work in
5364 right-to-left mode for a group of commands:
5365
5366 search "/" and "?" commands
5367
5368 This is useful for languages such as Hebrew, Arabic and Farsi.
5369 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5370
5371 *'ruler'* *'ru'* *'noruler'* *'noru'*
5372'ruler' 'ru' boolean (default off)
5373 global
5374 {not in Vi}
5375 {not available when compiled without the
5376 |+cmdline_info| feature}
5377 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005378 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379 text in the file is shown on the far right:
5380 Top first line is visible
5381 Bot last line is visible
5382 All first and last line are visible
5383 45% relative position in the file
5384 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005385 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005387 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 this option takes precedence over 'ruler' and 'rulerformat'
5389 If the number of characters displayed is different from the number of
5390 bytes in the text (e.g., for a TAB or a multi-byte character), both
5391 the text column (byte number) and the screen column are shown,
5392 separated with a dash.
5393 For an empty line "0-1" is shown.
5394 For an empty buffer the line number will also be zero: "0,0-1".
5395 This option is reset when the 'paste' option is set.
5396 If you don't want to see the ruler all the time but want to know where
5397 you are, use "g CTRL-G" |g_CTRL-G|.
5398 NOTE: This option is reset when 'compatible' is set.
5399
5400 *'rulerformat'* *'ruf'*
5401'rulerformat' 'ruf' string (default empty)
5402 global
5403 {not in Vi}
5404 {not available when compiled without the |+statusline|
5405 feature}
5406 When this option is not empty, it determines the content of the ruler
5407 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005408 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409 The default ruler width is 17 characters. To make the ruler 15
5410 characters wide, put "%15(" at the start and "%)" at the end.
5411 Example: >
5412 :set rulerformat=%15(%c%V\ %p%%%)
5413<
5414 *'runtimepath'* *'rtp'* *vimfiles*
5415'runtimepath' 'rtp' string (default:
5416 Unix: "$HOME/.vim,
5417 $VIM/vimfiles,
5418 $VIMRUNTIME,
5419 $VIM/vimfiles/after,
5420 $HOME/.vim/after"
5421 Amiga: "home:vimfiles,
5422 $VIM/vimfiles,
5423 $VIMRUNTIME,
5424 $VIM/vimfiles/after,
5425 home:vimfiles/after"
5426 PC, OS/2: "$HOME/vimfiles,
5427 $VIM/vimfiles,
5428 $VIMRUNTIME,
5429 $VIM/vimfiles/after,
5430 $HOME/vimfiles/after"
5431 Macintosh: "$VIM:vimfiles,
5432 $VIMRUNTIME,
5433 $VIM:vimfiles:after"
5434 RISC-OS: "Choices:vimfiles,
5435 $VIMRUNTIME,
5436 Choices:vimfiles/after"
5437 VMS: "sys$login:vimfiles,
5438 $VIM/vimfiles,
5439 $VIMRUNTIME,
5440 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005441 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 global
5443 {not in Vi}
5444 This is a list of directories which will be searched for runtime
5445 files:
5446 filetype.vim filetypes by file name |new-filetype|
5447 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005448 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449 colors/ color scheme files |:colorscheme|
5450 compiler/ compiler files |:compiler|
5451 doc/ documentation |write-local-help|
5452 ftplugin/ filetype plugins |write-filetype-plugin|
5453 indent/ indent scripts |indent-expression|
5454 keymap/ key mapping files |mbyte-keymap|
5455 lang/ menu translations |:menutrans|
5456 menu.vim GUI menus |menu.vim|
5457 plugin/ plugin scripts |write-plugin|
5458 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005459 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 syntax/ syntax files |mysyntaxfile|
5461 tutor/ files for vimtutor |tutor|
5462
5463 And any other file searched for with the |:runtime| command.
5464
5465 The defaults for most systems are setup to search five locations:
5466 1. In your home directory, for your personal preferences.
5467 2. In a system-wide Vim directory, for preferences from the system
5468 administrator.
5469 3. In $VIMRUNTIME, for files distributed with Vim.
5470 *after-directory*
5471 4. In the "after" directory in the system-wide Vim directory. This is
5472 for the system administrator to overrule or add to the distributed
5473 defaults (rarely needed)
5474 5. In the "after" directory in your home directory. This is for
5475 personal preferences to overrule or add to the distributed defaults
5476 or system-wide settings (rarely needed).
5477
5478 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5479 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005480 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 wildcards.
5482 See |:runtime|.
5483 Example: >
5484 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5485< This will use the directory "~/vimruntime" first (containing your
5486 personal Vim runtime files), then "/mygroup/vim" (shared between a
5487 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5488 files).
5489 You probably should always include $VIMRUNTIME somewhere, to use the
5490 distributed runtime files. You can put a directory before $VIMRUNTIME
5491 to find files which replace a distributed runtime files. You can put
5492 a directory after $VIMRUNTIME to find files which add to distributed
5493 runtime files.
5494 This option cannot be set from a |modeline| or in the |sandbox|, for
5495 security reasons.
5496
5497 *'scroll'* *'scr'*
5498'scroll' 'scr' number (default: half the window height)
5499 local to window
5500 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5501 set to half the number of lines in the window when the window size
5502 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005503 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5505 the number of screen lines instead of file lines, makes a difference
5506 when lines wrap}
5507
5508 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5509'scrollbind' 'scb' boolean (default off)
5510 local to window
5511 {not in Vi}
5512 {not available when compiled without the |+scrollbind|
5513 feature}
5514 See also |scroll-binding|. When this option is set, the current
5515 window scrolls as other scrollbind windows (windows that also have
5516 this option set) scroll. This option is useful for viewing the
5517 differences between two versions of a file, see 'diff'.
5518 See |'scrollopt'| for options that determine how this option should be
5519 interpreted.
5520 This option is mostly reset when splitting a window to edit another
5521 file. This means that ":split | edit file" results in two windows
5522 with scroll-binding, but ":split file" does not.
5523
5524 *'scrolljump'* *'sj'*
5525'scrolljump' 'sj' number (default 1)
5526 global
5527 {not in Vi}
5528 Minimal number of lines to scroll when the cursor gets off the
5529 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5530 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005531 When set to a negative number from -1 to -100 this is used as the
5532 percentage of the window height. Thus -50 scrolls half the window
5533 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534 NOTE: This option is set to 1 when 'compatible' is set.
5535
5536 *'scrolloff'* *'so'*
5537'scrolloff' 'so' number (default 0)
5538 global
5539 {not in Vi}
5540 Minimal number of screen lines to keep above and below the cursor.
5541 This will make some context visible around where you are working. If
5542 you set it to a very large value (999) the cursor line will always be
5543 in the middle of the window (except at the start or end of the file or
5544 when long lines wrap).
5545 For scrolling horizontally see 'sidescrolloff'.
5546 NOTE: This option is set to 0 when 'compatible' is set.
5547
5548 *'scrollopt'* *'sbo'*
5549'scrollopt' 'sbo' string (default "ver,jump")
5550 global
5551 {not available when compiled without the |+scrollbind|
5552 feature}
5553 {not in Vi}
5554 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005555 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5556 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005557 The following words are available:
5558 ver Bind vertical scrolling for 'scrollbind' windows
5559 hor Bind horizontal scrolling for 'scrollbind' windows
5560 jump Applies to the offset between two windows for vertical
5561 scrolling. This offset is the difference in the first
5562 displayed line of the bound windows. When moving
5563 around in a window, another 'scrollbind' window may
5564 reach a position before the start or after the end of
5565 the buffer. The offset is not changed though, when
5566 moving back the 'scrollbind' window will try to scroll
5567 to the desired position when possible.
5568 When now making that window the current one, two
5569 things can be done with the relative offset:
5570 1. When "jump" is not included, the relative offset is
5571 adjusted for the scroll position in the new current
5572 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005573 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574 2. When "jump" is included, the other windows are
5575 scrolled to keep the same relative offset. When
5576 going back to the other window, it still uses the
5577 same relative offset.
5578 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005579 When 'diff' mode is active there always is vertical scroll binding,
5580 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005581
5582 *'sections'* *'sect'*
5583'sections' 'sect' string (default "SHNHH HUnhsh")
5584 global
5585 Specifies the nroff macros that separate sections. These are pairs of
5586 two letters (See |object-motions|). The default makes a section start
5587 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5588
5589 *'secure'* *'nosecure'* *E523*
5590'secure' boolean (default off)
5591 global
5592 {not in Vi}
5593 When on, ":autocmd", shell and write commands are not allowed in
5594 ".vimrc" and ".exrc" in the current directory and map commands are
5595 displayed. Switch it off only if you know that you will not run into
5596 problems, or when the 'exrc' option is off. On Unix this option is
5597 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005598 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005599 'secure' at the end of your ~/.vimrc then.
5600 This option cannot be set from a |modeline| or in the |sandbox|, for
5601 security reasons.
5602
5603 *'selection'* *'sel'*
5604'selection' 'sel' string (default "inclusive")
5605 global
5606 {not in Vi}
5607 This option defines the behavior of the selection. It is only used
5608 in Visual and Select mode.
5609 Possible values:
5610 value past line inclusive ~
5611 old no yes
5612 inclusive yes yes
5613 exclusive yes no
5614 "past line" means that the cursor is allowed to be positioned one
5615 character past the line.
5616 "inclusive" means that the last character of the selection is included
5617 in an operation. For example, when "x" is used to delete the
5618 selection.
5619 Note that when "exclusive" is used and selecting from the end
5620 backwards, you cannot include the last character of a line, when
5621 starting in Normal mode and 'virtualedit' empty.
5622
5623 The 'selection' option is set by the |:behave| command.
5624
5625 *'selectmode'* *'slm'*
5626'selectmode' 'slm' string (default "")
5627 global
5628 {not in Vi}
5629 This is a comma separated list of words, which specifies when to start
5630 Select mode instead of Visual mode, when a selection is started.
5631 Possible values:
5632 mouse when using the mouse
5633 key when using shifted special keys
5634 cmd when using "v", "V" or CTRL-V
5635 See |Select-mode|.
5636 The 'selectmode' option is set by the |:behave| command.
5637
5638 *'sessionoptions'* *'ssop'*
5639'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005640 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641 global
5642 {not in Vi}
5643 {not available when compiled without the +mksession
5644 feature}
5645 Changes the effect of the |:mksession| command. It is a comma
5646 separated list of words. Each word enables saving and restoring
5647 something:
5648 word save and restore ~
5649 blank empty windows
5650 buffers hidden and unloaded buffers, not just those in windows
5651 curdir the current directory
5652 folds manually created folds, opened/closed folds and local
5653 fold options
5654 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005655 and contain at least one lowercase letter. Only
5656 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657 help the help window
5658 localoptions options and mappings local to a window or buffer (not
5659 global values for local options)
5660 options all options and mappings (also global values for local
5661 options)
5662 resize size of the Vim window: 'lines' and 'columns'
5663 sesdir the directory in which the session file is located
5664 will become the current directory (useful with
5665 projects accessed over a network from different
5666 systems)
5667 slash backslashes in file names replaced with forward
5668 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005669 tabpages all tab pages; without this only the current tab page
5670 is restored, so that you can make a session for each
5671 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672 unix with Unix end-of-line format (single <NL>), even when
5673 on Windows or DOS
5674 winpos position of the whole Vim window
5675 winsize window sizes
5676
5677 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005678 When neither "curdir" nor "sesdir" is included, file names are stored
5679 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680 "slash" and "unix" are useful on Windows when sharing session files
5681 with Unix. The Unix version of Vim cannot source dos format scripts,
5682 but the Windows version of Vim can source unix format scripts.
5683
5684 *'shell'* *'sh'* *E91*
5685'shell' 'sh' string (default $SHELL or "sh",
5686 MS-DOS and Win32: "command.com" or
5687 "cmd.exe", OS/2: "cmd")
5688 global
5689 Name of the shell to use for ! and :! commands. When changing the
5690 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5691 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005692 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 See |option-backslash| about including spaces and backslashes.
5694 Environment variables are expanded |:set_env|.
5695 If the name of the shell contains a space, you might need to enclose
5696 it in quotes. Example: >
5697 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5698< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005699 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 "-f" is not inside the quotes, because it is not part of the command
5701 name. And Vim automagically recognizes the backslashes that are path
5702 separators.
5703 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5704 variable to change the way external commands are executed. See the
5705 libc.inf file of DJGPP.
5706 Under MS-Windows, when the executable ends in ".com" it must be
5707 included. Thus setting the shell to "command.com" or "4dos.com"
5708 works, but "command" and "4dos" do not work for all commands (e.g.,
5709 filtering).
5710 For unknown reasons, when using "4dos.com" the current directory is
5711 changed to "C:\". To avoid this set 'shell' like this: >
5712 :set shell=command.com\ /c\ 4dos
5713< This option cannot be set from a |modeline| or in the |sandbox|, for
5714 security reasons.
5715
5716 *'shellcmdflag'* *'shcf'*
5717'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5718 does not contain "sh" somewhere: "/c")
5719 global
5720 {not in Vi}
5721 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5722 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5723 systems, the default is set according to the value of 'shell', to
5724 reduce the need to set this option by the user. It's not used for
5725 OS/2 (EMX figures this out itself). See |option-backslash| about
5726 including spaces and backslashes. See |dos-shell|.
5727 This option cannot be set from a |modeline| or in the |sandbox|, for
5728 security reasons.
5729
5730 *'shellpipe'* *'sp'*
5731'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5732 global
5733 {not in Vi}
5734 {not available when compiled without the |+quickfix|
5735 feature}
5736 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005737 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738 including spaces and backslashes.
5739 The name of the temporary file can be represented by "%s" if necessary
5740 (the file name is appended automatically if no %s appears in the value
5741 of this option).
5742 For the Amiga and MS-DOS the default is ">". The output is directly
5743 saved in a file and not echoed to the screen.
5744 For Unix the default it "| tee". The stdout of the compiler is saved
5745 in a file and echoed to the screen. If the 'shell' option is "csh" or
5746 "tcsh" after initializations, the default becomes "|& tee". If the
5747 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005748 "2>&1| tee". This means that stderr is also included. Before using
5749 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750 The initialization of this option is done after reading the ".vimrc"
5751 and the other initializations, so that when the 'shell' option is set
5752 there, the 'shellpipe' option changes automatically, unless it was
5753 explicitly set before.
5754 When 'shellpipe' is set to an empty string, no redirection of the
5755 ":make" output will be done. This is useful if you use a 'makeprg'
5756 that writes to 'makeef' by itself. If you want no piping, but do
5757 want to include the 'makeef', set 'shellpipe' to a single space.
5758 Don't forget to precede the space with a backslash: ":set sp=\ ".
5759 In the future pipes may be used for filtering and this option will
5760 become obsolete (at least for Unix).
5761 This option cannot be set from a |modeline| or in the |sandbox|, for
5762 security reasons.
5763
5764 *'shellquote'* *'shq'*
5765'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5766 contains "sh" somewhere: "\"")
5767 global
5768 {not in Vi}
5769 Quoting character(s), put around the command passed to the shell, for
5770 the "!" and ":!" commands. The redirection is kept outside of the
5771 quoting. See 'shellxquote' to include the redirection. It's
5772 probably not useful to set both options.
5773 This is an empty string by default. Only known to be useful for
5774 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5775 or bash, where it should be "\"". The default is adjusted according
5776 the value of 'shell', to reduce the need to set this option by the
5777 user. See |dos-shell|.
5778 This option cannot be set from a |modeline| or in the |sandbox|, for
5779 security reasons.
5780
5781 *'shellredir'* *'srr'*
5782'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5783 global
5784 {not in Vi}
5785 String to be used to put the output of a filter command in a temporary
5786 file. See also |:!|. See |option-backslash| about including spaces
5787 and backslashes.
5788 The name of the temporary file can be represented by "%s" if necessary
5789 (the file name is appended automatically if no %s appears in the value
5790 of this option).
5791 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5792 or "zsh" during initializations, the default becomes ">&". If the
5793 'shell' option is "sh", "ksh" or "bash" the default becomes
5794 ">%s 2>&1". This means that stderr is also included.
5795 For Win32, the Unix checks are done and additionally "cmd" is checked
5796 for, which makes the default ">%s 2>&1". Also, the same names with
5797 ".exe" appended are checked for.
5798 The initialization of this option is done after reading the ".vimrc"
5799 and the other initializations, so that when the 'shell' option is set
5800 there, the 'shellredir' option changes automatically unless it was
5801 explicitly set before.
5802 In the future pipes may be used for filtering and this option will
5803 become obsolete (at least for Unix).
5804 This option cannot be set from a |modeline| or in the |sandbox|, for
5805 security reasons.
5806
5807 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5808'shellslash' 'ssl' boolean (default off)
5809 global
5810 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5811 When set, a forward slash is used when expanding file names. This is
5812 useful when a Unix-like shell is used instead of command.com or
5813 cmd.exe. Backward slashes can still be typed, but they are changed to
5814 forward slashes by Vim.
5815 Note that setting or resetting this option has no effect for some
5816 existing file names, thus this option needs to be set before opening
5817 any file for best results. This might change in the future.
5818 'shellslash' only works when a backslash can be used as a path
5819 separator. To test if this is so use: >
5820 if exists('+shellslash')
5821<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005822 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5823'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5824 global
5825 {not in Vi}
5826 When on, use temp files for shell commands. When off use a pipe.
5827 When using a pipe is not possible temp files are used anyway.
5828 Currently a pipe is only supported on Unix. You can check it with: >
5829 :if has("filterpipe")
5830< The advantage of using a pipe is that nobody can read the temp file
5831 and the 'shell' command does not need to support redirection.
5832 The advantage of using a temp file is that the file type and encoding
5833 can be detected.
5834 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5835 |FilterWritePost| autocommands event are not triggered when
5836 'shelltemp' is off.
5837
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838 *'shelltype'* *'st'*
5839'shelltype' 'st' number (default 0)
5840 global
5841 {not in Vi} {only for the Amiga}
5842 On the Amiga this option influences the way how the commands work
5843 which use a shell.
5844 0 and 1: always use the shell
5845 2 and 3: use the shell only to filter lines
5846 4 and 5: use shell only for ':sh' command
5847 When not using the shell, the command is executed directly.
5848
5849 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5850 1 and 3: use "shell cmd" to start external commands
5851
5852 *'shellxquote'* *'sxq'*
5853'shellxquote' 'sxq' string (default: "";
5854 for Win32, when 'shell' contains "sh"
5855 somewhere: "\""
5856 for Unix, when using system(): "\"")
5857 global
5858 {not in Vi}
5859 Quoting character(s), put around the command passed to the shell, for
5860 the "!" and ":!" commands. Includes the redirection. See
5861 'shellquote' to exclude the redirection. It's probably not useful
5862 to set both options.
5863 This is an empty string by default. Known to be useful for
5864 third-party shells when using the Win32 version, such as the MKS Korn
5865 Shell or bash, where it should be "\"". The default is adjusted
5866 according the value of 'shell', to reduce the need to set this option
5867 by the user. See |dos-shell|.
5868 This option cannot be set from a |modeline| or in the |sandbox|, for
5869 security reasons.
5870
5871 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5872'shiftround' 'sr' boolean (default off)
5873 global
5874 {not in Vi}
5875 Round indent to multiple of 'shiftwidth'. Applies to > and <
5876 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5877 a multiple of 'shiftwidth' (this is Vi compatible).
5878 NOTE: This option is reset when 'compatible' is set.
5879
5880 *'shiftwidth'* *'sw'*
5881'shiftwidth' 'sw' number (default 8)
5882 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005883 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884 |'cindent'|, |>>|, |<<|, etc.
5885
5886 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005887'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5888 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005889 global
5890 {not in Vi}
5891 This option helps to avoid all the |hit-enter| prompts caused by file
5892 messages, for example with CTRL-G, and to avoid some other messages.
5893 It is a list of flags:
5894 flag meaning when present ~
5895 f use "(3 of 5)" instead of "(file 3 of 5)"
5896 i use "[noeol]" instead of "[Incomplete last line]"
5897 l use "999L, 888C" instead of "999 lines, 888 characters"
5898 m use "[+]" instead of "[Modified]"
5899 n use "[New]" instead of "[New File]"
5900 r use "[RO]" instead of "[readonly]"
5901 w use "[w]" instead of "written" for file write message
5902 and "[a]" instead of "appended" for ':w >> file' command
5903 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5904 "[unix format]" and "[mac]" instead of "[mac format]".
5905 a all of the above abbreviations
5906
5907 o overwrite message for writing a file with subsequent message
5908 for reading a file (useful for ":wn" or when 'autowrite' on)
5909 O message for reading a file overwrites any previous message.
5910 Also for quickfix message (e.g., ":cn").
5911 s don't give "search hit BOTTOM, continuing at TOP" or "search
5912 hit TOP, continuing at BOTTOM" messages
5913 t truncate file message at the start if it is too long to fit
5914 on the command-line, "<" will appear in the left most column.
5915 Ignored in Ex mode.
5916 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005917 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918 Ignored in Ex mode.
5919 W don't give "written" or "[w]" when writing a file
5920 A don't give the "ATTENTION" message when an existing swap file
5921 is found.
5922 I don't give the intro message when starting Vim |:intro|.
5923
5924 This gives you the opportunity to avoid that a change between buffers
5925 requires you to hit <Enter>, but still gives as useful a message as
5926 possible for the space available. To get the whole message that you
5927 would have got with 'shm' empty, use ":file!"
5928 Useful values:
5929 shm= No abbreviation of message.
5930 shm=a Abbreviation, but no loss of information.
5931 shm=at Abbreviation, and truncate message when necessary.
5932
5933 NOTE: This option is set to the Vi default value when 'compatible' is
5934 set and to the Vim default value when 'compatible' is reset.
5935
5936 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5937'shortname' 'sn' boolean (default off)
5938 local to buffer
5939 {not in Vi, not in MS-DOS versions}
5940 Filenames are assumed to be 8 characters plus one extension of 3
5941 characters. Multiple dots in file names are not allowed. When this
5942 option is on, dots in file names are replaced with underscores when
5943 adding an extension (".~" or ".swp"). This option is not available
5944 for MS-DOS, because then it would always be on. This option is useful
5945 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5946 or crossdos. When running the Win32 GUI version under Win32s, this
5947 option is always on by default.
5948
5949 *'showbreak'* *'sbr'* *E595*
5950'showbreak' 'sbr' string (default "")
5951 global
5952 {not in Vi}
5953 {not available when compiled without the |+linebreak|
5954 feature}
5955 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005956 values are "> " or "+++ ": >
5957 :set showbreak=>\
5958< Note the backslash to escape the trailing space. It's easier like
5959 this: >
5960 :let &showbreak = '+++ '
5961< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00005962 comma (in a future version the comma might be used to separate the
5963 part that is shown at the end and at the start of a line).
5964 The characters are highlighted according to the '@' flag in
5965 'highlight'.
5966 Note that tabs after the showbreak will be displayed differently.
5967 If you want the 'showbreak' to appear in between line numbers, add the
5968 "n" flag to 'cpoptions'.
5969
5970 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5971'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5972 off)
5973 global
5974 {not in Vi}
5975 {not available when compiled without the
5976 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00005977 Show (partial) command in the last line of the screen. Set this
5978 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005979 In Visual mode the size of the selected area is shown:
5980 - When selecting characters within a line, the number of characters.
5981 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005982 - When selecting a block, the size in screen characters:
5983 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005984 NOTE: This option is set to the Vi default value when 'compatible' is
5985 set and to the Vim default value when 'compatible' is reset.
5986
5987 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5988'showfulltag' 'sft' boolean (default off)
5989 global
5990 {not in Vi}
5991 When completing a word in insert mode (see |ins-completion|) from the
5992 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005993 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994 matched a C function, you can see a template for what arguments are
5995 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00005996 Note that this doesn't work well together with having "longest" in
5997 'completeopt', because the completion from the search pattern may not
5998 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999
6000 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6001'showmatch' 'sm' boolean (default off)
6002 global
6003 When a bracket is inserted, briefly jump to the matching one. The
6004 jump is only done if the match can be seen on the screen. The time to
6005 show the match can be set with 'matchtime'.
6006 A Beep is given if there is no match (no matter if the match can be
6007 seen or not). This option is reset when the 'paste' option is set.
6008 When the 'm' flag is not included in 'cpoptions', typing a character
6009 will immediately move the cursor back to where it belongs.
6010 See the "sm" field in 'guicursor' for setting the cursor shape and
6011 blinking when showing the match.
6012 The 'matchpairs' option can be used to specify the characters to show
6013 matches for. 'rightleft' and 'revins' are used to look for opposite
6014 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006015 Also see the matchparen plugin for highlighting the match when moving
6016 around |pi_paren.txt|.
6017 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018
6019 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6020'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6021 global
6022 If in Insert, Replace or Visual mode put a message on the last line.
6023 Use the 'M' flag in 'highlight' to set the type of highlighting for
6024 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006025 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006026 doesn't mean XIM is really active, especially when 'imactivatekey' is
6027 not set.
6028 NOTE: This option is set to the Vi default value when 'compatible' is
6029 set and to the Vim default value when 'compatible' is reset.
6030
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006031 *'showtabline'* *'stal'*
6032'showtabline' 'stal' number (default 1)
6033 global
6034 {not in Vi}
6035 {not available when compiled without the +windows
6036 feature}
6037 The value of this option specifies when the line with tab page labels
6038 will be displayed:
6039 0: never
6040 1: only if there are at least two tab pages
6041 2: always
6042 This is both for the GUI and non-GUI implementation of the tab pages
6043 line.
6044 See |tab-page| for more information about tab pages.
6045
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 *'sidescroll'* *'ss'*
6047'sidescroll' 'ss' number (default 0)
6048 global
6049 {not in Vi}
6050 The minimal number of columns to scroll horizontally. Used only when
6051 the 'wrap' option is off and the cursor is moved off of the screen.
6052 When it is zero the cursor will be put in the middle of the screen.
6053 When using a slow terminal set it to a large number or 0. When using
6054 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6055 commands.
6056
6057 *'sidescrolloff'* *'siso'*
6058'sidescrolloff' 'siso' number (default 0)
6059 global
6060 {not in Vi}
6061 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006062 right of the cursor if 'nowrap' is set. Setting this option to a
6063 value greater than 0 while having |'sidescroll'| also at a non-zero
6064 value makes some context visible in the line you are scrolling in
6065 horizontally (except at beginning of the line). Setting this option
6066 to a large value (like 999) has the effect of keeping the cursor
6067 horizontally centered in the window, as long as one does not come too
6068 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006069 NOTE: This option is set to 0 when 'compatible' is set.
6070
6071 Example: Try this together with 'sidescroll' and 'listchars' as
6072 in the following example to never allow the cursor to move
6073 onto the "extends" character:
6074
6075 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6076 :set sidescrolloff=1
6077
6078
6079 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6080'smartcase' 'scs' boolean (default off)
6081 global
6082 {not in Vi}
6083 Override the 'ignorecase' option if the search pattern contains upper
6084 case characters. Only used when the search pattern is typed and
6085 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006086 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006087 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6088 recalling the search pattern from history and hitting <Enter>.
6089 NOTE: This option is reset when 'compatible' is set.
6090
6091 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6092'smartindent' 'si' boolean (default off)
6093 local to buffer
6094 {not in Vi}
6095 {not available when compiled without the
6096 |+smartindent| feature}
6097 Do smart autoindenting when starting a new line. Works for C-like
6098 programs, but can also be used for other languages. 'cindent' does
6099 something like this, works better in most cases, but is more strict,
6100 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6101 'indentexpr' is a more advanced alternative.
6102 Normally 'autoindent' should also be on when using 'smartindent'.
6103 An indent is automatically inserted:
6104 - After a line ending in '{'.
6105 - After a line starting with a keyword from 'cinwords'.
6106 - Before a line starting with '}' (only with the "O" command).
6107 When typing '}' as the first character in a new line, that line is
6108 given the same indent as the matching '{'.
6109 When typing '#' as the first character in a new line, the indent for
6110 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006111 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006112 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6113 When using the ">>" command, lines starting with '#' are not shifted
6114 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006115 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006116 is set smart indenting is disabled.
6117
6118 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6119'smarttab' 'sta' boolean (default off)
6120 global
6121 {not in Vi}
6122 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006123 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6124 <BS> will delete a 'shiftwidth' worth of space at the start of the
6125 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006126 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006127 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6128 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006129 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006130 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006131 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132 NOTE: This option is reset when 'compatible' is set.
6133
6134 *'softtabstop'* *'sts'*
6135'softtabstop' 'sts' number (default 0)
6136 local to buffer
6137 {not in Vi}
6138 Number of spaces that a <Tab> counts for while performing editing
6139 operations, like inserting a <Tab> or using <BS>. It "feels" like
6140 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6141 used. This is useful to keep the 'ts' setting at its standard value
6142 of 8, while being able to edit like it is set to 'sts'. However,
6143 commands like "x" still work on the actual characters.
6144 When 'sts' is zero, this feature is off.
6145 'softtabstop' is set to 0 when the 'paste' option is set.
6146 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6147 spaces is minimized by using <Tab>s.
6148 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6149 set.
6150 NOTE: This option is set to 0 when 'compatible' is set.
6151
Bram Moolenaar217ad922005-03-20 22:37:15 +00006152 *'spell'* *'nospell'*
6153'spell' boolean (default off)
6154 local to window
6155 {not in Vi}
6156 {not available when compiled without the |+syntax|
6157 feature}
6158 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006159 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006160
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006161 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006162'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006163 local to buffer
6164 {not in Vi}
6165 {not available when compiled without the |+syntax|
6166 feature}
6167 Pattern to locate the end of a sentence. The following word will be
6168 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006169 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006170 When this check is not wanted make this option empty.
6171 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006172 Be careful with special characters, see |option-backslash| about
6173 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006174 To set this option automatically depending on the language, see
6175 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006176
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006177 *'spellfile'* *'spf'*
6178'spellfile' 'spf' string (default empty)
6179 local to buffer
6180 {not in Vi}
6181 {not available when compiled without the |+syntax|
6182 feature}
6183 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006184 commands. It must end in ".{encoding}.add". You need to include the
6185 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006186 *E765*
6187 It may also be a comma separated list of names. A count before the
6188 |zg| and |zw| commands can be used to access each. This allows using
6189 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006190 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006191 you: Using the first directory in 'runtimepath' that is writable. If
6192 there is no "spell" directory yet it will be created. For the file
6193 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006194 ignoring the region.
6195 The resulting ".spl" file will be used for spell checking, it does not
6196 have to appear in 'spelllang'.
6197 Normally one file is used for all regions, but you can add the region
6198 name if you want to. However, it will then only be used when
6199 'spellfile' is set to it, for entries in 'spelllang' only files
6200 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006201 This option cannot be set from a |modeline| or in the |sandbox|, for
6202 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006203
Bram Moolenaar217ad922005-03-20 22:37:15 +00006204 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006205'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006206 local to buffer
6207 {not in Vi}
6208 {not available when compiled without the |+syntax|
6209 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006210 A comma separated list of word list names. When the 'spell' option is
6211 on spellchecking will be done for these languages. Example: >
6212 set spelllang=en_us,nl,medical
6213< This means US English, Dutch and medical words are recognized. Words
6214 that are not recognized will be highlighted.
6215 The word list name must not include a comma or dot. Using a dash is
6216 recommended to separate the two letter language name from a
6217 specification. Thus "en-rare" is used for rare English words.
6218 A region name must come last and have the form "_xx", where "xx" is
6219 the two-letter, lower case region name. You can use more than one
6220 region by listing them: "en_us,en_ca" supports both US and Canadian
6221 English, but not words specific for Australia, New Zealand or Great
6222 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006223 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006224 As a special case the name of a .spl file can be given as-is. The
6225 first "_xx" in the name is removed and used as the region name
6226 (_xx is an underscore, two letters and followed by a non-letter).
6227 This is mainly for testing purposes. You must make sure the correct
6228 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006229 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006230 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6231 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006232 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006233
Bram Moolenaar98692072006-02-04 00:57:42 +00006234 If the |spellfile.vim| plugin is active and you use a language name
6235 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6236 will ask you if you want to download the file.
6237
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006238 After this option has been set successfully, Vim will source the files
6239 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006240 up to the first comma, dot or underscore.
6241 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006242
6243
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006244 *'spellsuggest'* *'sps'*
6245'spellsuggest' 'sps' string (default "best")
6246 global
6247 {not in Vi}
6248 {not available when compiled without the |+syntax|
6249 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006250 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006251 the |spellsuggest()| function. This is a comma-separated list of
6252 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006253
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006254 best Internal method that works best for English. Finds
6255 changes like "fast" and uses a bit of sound-a-like
6256 scoring to improve the ordering.
6257
6258 double Internal method that uses two methods and mixes the
6259 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006260 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006261 word. That only works when the language specifies
6262 sound folding. Can be slow and doesn't always give
6263 better results.
6264
6265 fast Internal method that only checks for simple changes:
6266 character inserts/deletes/swaps. Works well for
6267 simple typing mistakes.
6268
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006269 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006270 Not used for |spellsuggest()|. The number of
6271 suggestions is never more than the value of 'lines'
6272 minus two.
6273
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006274 file:{filename} Read file {filename}, which must have two columns,
6275 separated by a slash. The first column contains the
6276 bad word, the second column the suggested good word.
6277 Example:
6278 theribal/terrible ~
6279 Use this for common mistakes that do not appear at the
6280 top of the suggestion list with the internal methods.
6281 Lines without a slash are ignored, use this for
6282 comments.
6283 The file is used for all languages.
6284
6285 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6286 trouble with spaces. |v:val| holds the badly spelled
6287 word. The expression must evaluate to a List of
6288 Lists, each with a suggestion and a score.
6289 Example:
6290 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006291 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006292 internal methods use. A lower score is better.
6293 This may invoke |spellsuggest()| if you temporarily
6294 set 'spellsuggest' to exclude the "expr:" part.
6295 Errors are silently ignored, unless you set the
6296 'verbose' option to a non-zero value.
6297
6298 Only one of "best", "double" or "fast" may be used. The others may
6299 appear several times in any order. Example: >
6300 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6301<
6302 This option cannot be set from a |modeline| or in the |sandbox|, for
6303 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006304
6305
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6307'splitbelow' 'sb' boolean (default off)
6308 global
6309 {not in Vi}
6310 {not available when compiled without the +windows
6311 feature}
6312 When on, splitting a window will put the new window below the current
6313 one. |:split|
6314
6315 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6316'splitright' 'spr' boolean (default off)
6317 global
6318 {not in Vi}
6319 {not available when compiled without the +vertsplit
6320 feature}
6321 When on, splitting a window will put the new window right of the
6322 current one. |:vsplit|
6323
6324 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6325'startofline' 'sol' boolean (default on)
6326 global
6327 {not in Vi}
6328 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006329 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006330 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006331 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 with a linewise operator, with "%" with a count and to buffer changing
6333 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6334 only has a line number, e.g., ":25" or ":+".
6335 In case of buffer changing commands the cursor is placed at the column
6336 where it was the last time the buffer was edited.
6337 NOTE: This option is set when 'compatible' is set.
6338
6339 *'statusline'* *'stl'* *E540* *E541* *E542*
6340'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006341 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 {not in Vi}
6343 {not available when compiled without the |+statusline|
6344 feature}
6345 When nonempty, this option determines the content of the status line.
6346 Also see |status-line|.
6347
6348 The option consists of printf style '%' items interspersed with
6349 normal text. Each status line item is of the form:
6350 %-0{minwid}.{maxwid}{item}
6351 All fields except the {item} is optional. A single percent sign can
6352 be given as "%%". Up to 80 items can be specified.
6353
Bram Moolenaar238a5642006-02-21 22:12:05 +00006354 When the option starts with "%!" then it is used as an expression,
6355 evaluated and the result is used as the option value. Example: >
6356 :set statusline=%!MyStatusLine()
6357< The result can contain %{} items that will be evaluated too.
6358
6359 When there is error while evaluating the option then it will be made
6360 empty to avoid further errors. Otherwise screen updating would loop.
6361
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 Note that the only effect of 'ruler' when this option is set (and
6363 'laststatus' is 2) is controlling the output of |CTRL-G|.
6364
6365 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006366 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006368 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006369 minwid Minimum width of the item, padding as set by '-' & '0'.
6370 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006371 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 on the left for text items. Numeric items will be
6373 shifted down to maxwid-2 digits followed by '>'number
6374 where number is the amount of missing digits, much like
6375 an exponential notation.
6376 item A one letter code as described below.
6377
6378 Following is a description of the possible statusline items. The
6379 second character in "item" is the type:
6380 N for number
6381 S for string
6382 F for flags as described below
6383 - not applicable
6384
6385 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006386 f S Path to the file in the buffer, as typed or relative to current
6387 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 F S Full path to the file in the buffer.
6389 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006390 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006392 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006394 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006396 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006398 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6400 {not available when compiled without |+autocmd| feature}
6401 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6402 being used: "<keymap>"
6403 n N Buffer number.
6404 b N Value of byte under cursor.
6405 B N As above, in hexadecimal.
6406 o N Byte number in file of byte under cursor, first byte is 1.
6407 Mnemonic: Offset from start of file (with one added)
6408 {not available when compiled without |+byte_offset| feature}
6409 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006410 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 l N Line number.
6412 L N Number of lines in buffer.
6413 c N Column number.
6414 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006415 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416 p N Percentage through file in lines as in |CTRL-G|.
6417 P S Percentage through file of displayed window. This is like the
6418 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006419 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006421 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006422 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006423 ( - Start of item group. Can be used for setting the width and
6424 alignment of a section. Must be followed by %) somewhere.
6425 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006426 T N For 'tabline': start of tab page N label. Use %T after the last
6427 label. This information is used for mouse clicks.
6428 X N For 'tabline': start of close tab N label. Use %X after the
6429 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6430 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006431 < - Where to truncate line if too long. Default is at the start.
6432 No width fields allowed.
6433 = - Separation point between left and right aligned items.
6434 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006435 # - Set highlight group. The name must follow and then a # again.
6436 Thus use %#HLname# for highlight group HLname. The same
6437 highlighting is used, also for the statusline of non-current
6438 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006439 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006440 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441 The difference between User{N} and StatusLine will be applied
6442 to StatusLineNC for the statusline of non-current windows.
6443 The number N must be between 1 and 9. See |hl-User1..9|
6444
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006445 When displaying a flag, Vim removes the leading comma, if any, when
6446 that flag comes right after plaintext. This will make a nice display
6447 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006448
Bram Moolenaar582fd852005-03-28 20:58:01 +00006449 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 not set) and a minwid is not set for the group, the whole group will
6451 become empty. This will make a group like the following disappear
6452 completely from the statusline when none of the flags are set. >
6453 :set statusline=...%(\ [%M%R%H]%)...
6454<
6455 Beware that an expression is evaluated each and every time the status
6456 line is displayed. The current buffer and current window will be set
6457 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006458 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006460 real current buffer.
6461
6462 The 'statusline' option may be evaluated in the |sandbox|, see
6463 |sandbox-option|.
6464
6465 It is not allowed to change text or jump to another window while
6466 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467
6468 If the statusline is not updated when you want it (e.g., after setting
6469 a variable that's used in an expression), you can force an update by
6470 setting an option without changing its value. Example: >
6471 :let &ro = &ro
6472
6473< A result of all digits is regarded a number for display purposes.
6474 Otherwise the result is taken as flag text and applied to the rules
6475 described above.
6476
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006477 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6479 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6480
6481 Examples:
6482 Emulate standard status line with 'ruler' set >
6483 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6484< Similar, but add ASCII value of char under the cursor (like "ga") >
6485 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6486< Display byte count and byte value, modified flag in red. >
6487 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6488 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6489< Display a ,GZ flag if a compressed file is loaded >
6490 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6491< In the |:autocmd|'s: >
6492 :let b:gzflag = 1
6493< And: >
6494 :unlet b:gzflag
6495< And define this function: >
6496 :function VarExists(var, val)
6497 : if exists(a:var) | return a:val | else | return '' | endif
6498 :endfunction
6499<
6500 *'suffixes'* *'su'*
6501'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6502 global
6503 {not in Vi}
6504 Files with these suffixes get a lower priority when multiple files
6505 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006506 suffixes. Spaces after the comma are ignored. A dot is also seen as
6507 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 separator, precede it with a backslash (see |option-backslash| about
6509 including spaces and backslashes).
6510 See 'wildignore' for completely ignoring files.
6511 The use of |:set+=| and |:set-=| is preferred when adding or removing
6512 suffixes from the list. This avoids problems when a future version
6513 uses another default.
6514
6515 *'suffixesadd'* *'sua'*
6516'suffixesadd' 'sua' string (default "")
6517 local to buffer
6518 {not in Vi}
6519 {not available when compiled without the
6520 |+file_in_path| feature}
6521 Comma separated list of suffixes, which are used when searching for a
6522 file for the "gf", "[I", etc. commands. Example: >
6523 :set suffixesadd=.java
6524<
6525 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6526'swapfile' 'swf' boolean (default on)
6527 local to buffer
6528 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006529 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 swapfile is not wanted for a specific buffer. For example, with
6531 confidential information that even root must not be able to access.
6532 Careful: All text will be in memory:
6533 - Don't use this for big files.
6534 - Recovery will be impossible!
6535 A swapfile will only be present when |'updatecount'| is non-zero and
6536 'swapfile' is set.
6537 When 'swapfile' is reset, the swap file for the current buffer is
6538 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6539 non-zero, a swap file is immediately created.
6540 Also see |swap-file| and |'swapsync'|.
6541
6542 This option is used together with 'bufhidden' and 'buftype' to
6543 specify special kinds of buffers. See |special-buffers|.
6544
6545 *'swapsync'* *'sws'*
6546'swapsync' 'sws' string (default "fsync")
6547 global
6548 {not in Vi}
6549 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006550 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551 When this option is empty parts of the swap file may be in memory and
6552 not written to disk. When the system crashes you may lose more work.
6553 On Unix the system does a sync now and then without Vim asking for it,
6554 so the disadvantage of setting this option off is small. On some
6555 systems the swap file will not be written at all. For a unix system
6556 setting it to "sync" will use the sync() call instead of the default
6557 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006558 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559
6560 *'switchbuf'* *'swb'*
6561'switchbuf' 'swb' string (default "")
6562 global
6563 {not in Vi}
6564 This option controls the behavior when switching between buffers.
6565 Possible values (comma separated list):
6566 useopen If included, jump to the first open window that
6567 contains the specified buffer (if there is one).
6568 Otherwise: Do not examine other windows.
6569 This setting is checked with |quickfix| commands, when
6570 jumping to errors (":cc", ":cn", "cp", etc.). It is
6571 also used in all buffer related split commands, for
6572 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006573 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006574 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006575 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006576 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006578 newtab Like "split", but open a new tab page. Overrules
6579 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006581 *'synmaxcol'* *'smc'*
6582'synmaxcol' 'smc' number (default 3000)
6583 local to buffer
6584 {not in Vi}
6585 {not available when compiled without the |+syntax|
6586 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006587 Maximum column in which to search for syntax items. In long lines the
6588 text after this column is not highlighted and following lines may not
6589 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006590 This helps to avoid very slow redrawing for an XML file that is one
6591 long line.
6592 Set to zero to remove the limit.
6593
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 *'syntax'* *'syn'*
6595'syntax' 'syn' string (default empty)
6596 local to buffer
6597 {not in Vi}
6598 {not available when compiled without the |+syntax|
6599 feature}
6600 When this option is set, the syntax with this name is loaded, unless
6601 syntax highlighting has been switched off with ":syntax off".
6602 Otherwise this option does not always reflect the current syntax (the
6603 b:current_syntax variable does).
6604 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006605 not automatically recognized. Example, in an IDL file:
6606 /* vim: set syntax=idl : */ ~
6607 When a dot appears in the value then this separates two filetype
6608 names. Example:
6609 /* vim: set syntax=c.doxygen : */ ~
6610 This will use the "c" syntax first, then the "doxygen" syntax.
6611 Note that the second one must be prepared to be loaded as an addition,
6612 otherwise it will be skipped. More than one dot may appear.
6613 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 :set syntax=OFF
6615< To switch syntax highlighting on according to the current value of the
6616 'filetype' option: >
6617 :set syntax=ON
6618< What actually happens when setting the 'syntax' option is that the
6619 Syntax autocommand event is triggered with the value as argument.
6620 This option is not copied to another buffer, independent of the 's' or
6621 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006622 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006624 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006625'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006626 global
6627 {not in Vi}
6628 {not available when compiled without the +windows
6629 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006630 When nonempty, this option determines the content of the tab pages
6631 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006632 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006633
6634 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006635 option and only when there is no GUI tab line. When 'e' is in
6636 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6637 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006638
6639 The value is evaluated like with 'statusline'. You can use
6640 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006641 the text to be displayed. Use "%1T" for the first label, "%2T" for
6642 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006643
6644 Keep in mind that only one of the tab pages is the current one, others
6645 are invisible and you can't jump to their windows.
6646
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006647
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006648 *'tabpagemax'* *'tpm'*
6649'tabpagemax' 'tpm' number (default 10)
6650 global
6651 {not in Vi}
6652 {not available when compiled without the +windows
6653 feature}
6654 Maximum number of tab pages to be opened by the |-p| command line
6655 argument or the ":tab all" command. |tabpage|
6656
6657
6658 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659'tabstop' 'ts' number (default 8)
6660 local to buffer
6661 Number of spaces that a <Tab> in the file counts for. Also see
6662 |:retab| command, and 'softtabstop' option.
6663
6664 Note: Setting 'tabstop' to any other value than 8 can make your file
6665 appear wrong in many places (e.g., when printing it).
6666
6667 There are four main ways to use tabs in Vim:
6668 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6669 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006670 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 behave like a tab appears every 4 (or 3) characters.
6672 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6673 'expandtab'. This way you will always insert spaces. The
6674 formatting will never be messed up when 'tabstop' is changed.
6675 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006676 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 works when using Vim to edit the file.
6678 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6679 'noexpandtab'. This should then work (for initial indents only)
6680 for any tabstop setting that people use. It might be nice to have
6681 tabs after the first non-blank inserted as spaces if you do this
6682 though. Otherwise aligned comments will be wrong when 'tabstop' is
6683 changed.
6684
6685 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6686'tagbsearch' 'tbs' boolean (default on)
6687 global
6688 {not in Vi}
6689 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006690 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006691 searching makes searching for a tag a LOT faster, but a linear search
6692 will find more tags if the tags file wasn't properly sorted.
6693 Vim normally assumes that your tags files are sorted, or indicate that
6694 they are not sorted. Only when this is not the case does the
6695 'tagbsearch' option need to be switched off.
6696
6697 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006698 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699 certain files, or retry all files with a linear search. When
6700 'tagbsearch' is off, only a linear search is done.
6701
6702 Linear searching is done anyway, for one file, when Vim finds a line
6703 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006704 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705< [The whitespace before and after the '0' must be a single <Tab>]
6706
6707 When a binary search was done and no match was found in any of the
6708 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6709 instead of a normal tag name, a retry is done with a linear search.
6710 Tags in unsorted tags files, and matches with different case will only
6711 be found in the retry.
6712
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006713 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 linear search can be avoided for the 'ignorecase' case. Use a value
6715 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6716 case-fold sorted with the -f switch to "sort" in most unices, as in
6717 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006718 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6719 for this as well. Note that case must be folded to uppercase for this
6720 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721
6722 When 'tagbsearch' is off, tags searching is slower when a full match
6723 exists, but faster when no full match exists. Tags in unsorted tags
6724 files may only be found with 'tagbsearch' off.
6725 When the tags file is not sorted, or sorted in a wrong way (not on
6726 ASCII byte value), 'tagbsearch' should be off, or the line given above
6727 must be included in the tags file.
6728 This option doesn't affect commands that find all matching tags (e.g.,
6729 command-line completion and ":help").
6730 {Vi: always uses binary search in some versions}
6731
6732 *'taglength'* *'tl'*
6733'taglength' 'tl' number (default 0)
6734 global
6735 If non-zero, tags are significant up to this number of characters.
6736
6737 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6738'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6739 global
6740 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006741 If on and using a tags file in another directory, file names in that
6742 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 NOTE: This option is set to the Vi default value when 'compatible' is
6744 set and to the Vim default value when 'compatible' is reset.
6745
6746 *'tags'* *'tag'* *E433*
6747'tags' 'tag' string (default "./tags,tags", when compiled with
6748 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6749 global or local to buffer |global-local|
6750 Filenames for the tag command, separated by spaces or commas. To
6751 include a space or comma in a file name, precede it with a backslash
6752 (see |option-backslash| about including spaces and backslashes).
6753 When a file name starts with "./", the '.' is replaced with the path
6754 of the current file. But only when the 'd' flag is not included in
6755 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6756 |tags-option|.
6757 "*", "**" and other wildcards can be used to search for tags files in
6758 a directory tree. See |file-searching|. {not available when compiled
6759 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006760 The |tagfiles()| function can be used to get a list of the file names
6761 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6763 files are also supported. They are automatically recognized. The
6764 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6765 differences are ignored (MS-Windows). |emacs-tags|
6766 The use of |:set+=| and |:set-=| is preferred when adding or removing
6767 file names from the list. This avoids problems when a future version
6768 uses another default.
6769 {Vi: default is "tags /usr/lib/tags"}
6770
6771 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6772'tagstack' 'tgst' boolean (default on)
6773 global
6774 {not in all versions of Vi}
6775 When on, the |tagstack| is used normally. When off, a ":tag" or
6776 ":tselect" command with an argument will not push the tag onto the
6777 tagstack. A following ":tag" without an argument, a ":pop" command or
6778 any other command that uses the tagstack will use the unmodified
6779 tagstack, but does change the pointer to the active entry.
6780 Resetting this option is useful when using a ":tag" command in a
6781 mapping which should not change the tagstack.
6782
6783 *'term'* *E529* *E530* *E531*
6784'term' string (default is $TERM, if that fails:
6785 in the GUI: "builtin_gui"
6786 on Amiga: "amiga"
6787 on BeOS: "beos-ansi"
6788 on Mac: "mac-ansi"
6789 on MiNT: "vt52"
6790 on MS-DOS: "pcterm"
6791 on OS/2: "os2ansi"
6792 on Unix: "ansi"
6793 on VMS: "ansi"
6794 on Win 32: "win32")
6795 global
6796 Name of the terminal. Used for choosing the terminal control
6797 characters. Environment variables are expanded |:set_env|.
6798 For example: >
6799 :set term=$TERM
6800< See |termcap|.
6801
6802 *'termbidi'* *'tbidi'*
6803 *'notermbidi'* *'notbidi'*
6804'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6805 global
6806 {not in Vi}
6807 {only available when compiled with the |+arabic|
6808 feature}
6809 The terminal is in charge of Bi-directionality of text (as specified
6810 by Unicode). The terminal is also expected to do the required shaping
6811 that some languages (such as Arabic) require.
6812 Setting this option implies that 'rightleft' will not be set when
6813 'arabic' is set and the value of 'arabicshape' will be ignored.
6814 Note that setting 'termbidi' has the immediate effect that
6815 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6816 This option is reset when the GUI is started.
6817 For further details see |arabic.txt|.
6818
6819 *'termencoding'* *'tenc'*
6820'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6821 Macintosh GUI: "macroman")
6822 global
6823 {only available when compiled with the |+multi_byte|
6824 feature}
6825 {not in Vi}
6826 Encoding used for the terminal. This specifies what character
6827 encoding the keyboard produces and the display will understand. For
6828 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006829 display). Except for the Mac when 'macatsui' is off, then
6830 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 In the Win32 console version the default value is the console codepage
6832 when it differs from the ANSI codepage.
6833 *E617*
6834 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6835 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6836 Any attempts to set a different value will be rejected, and an error
6837 message is shown.
6838 For the Win32 GUI 'termencoding' is not used for typed characters,
6839 because the Win32 system always passes Unicode characters.
6840 When empty, the same encoding is used as for the 'encoding' option.
6841 This is the normal value.
6842 Not all combinations for 'termencoding' and 'encoding' are valid. See
6843 |encoding-table|.
6844 The value for this option must be supported by internal conversions or
6845 iconv(). When this is not possible no conversion will be done and you
6846 will probably experience problems with non-ASCII characters.
6847 Example: You are working with the locale set to euc-jp (Japanese) and
6848 want to edit a UTF-8 file: >
6849 :let &termencoding = &encoding
6850 :set encoding=utf-8
6851< You need to do this when your system has no locale support for UTF-8.
6852
6853 *'terse'* *'noterse'*
6854'terse' boolean (default off)
6855 global
6856 When set: Add 's' flag to 'shortmess' option (this makes the message
6857 for a search that hits the start or end of the file not being
6858 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6859 shortens a lot of messages}
6860
6861 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6862'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6863 global
6864 {not in Vi}
6865 This option is obsolete. Use 'fileformats'.
6866 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6867 set to the default value for the current system. When 'textauto' is
6868 reset, 'fileformats' is made empty.
6869 NOTE: This option is set to the Vi default value when 'compatible' is
6870 set and to the Vim default value when 'compatible' is reset.
6871
6872 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6873'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6874 others: default off)
6875 local to buffer
6876 {not in Vi}
6877 This option is obsolete. Use 'fileformat'.
6878 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6879 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6880 "unix".
6881
6882 *'textwidth'* *'tw'*
6883'textwidth' 'tw' number (default 0)
6884 local to buffer
6885 {not in Vi}
6886 Maximum width of text that is being inserted. A longer line will be
6887 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006888 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6889 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00006891 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 NOTE: This option is set to 0 when 'compatible' is set.
6893
6894 *'thesaurus'* *'tsr'*
6895'thesaurus' 'tsr' string (default "")
6896 global or local to buffer |global-local|
6897 {not in Vi}
6898 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006899 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900 the file should contain words with similar meaning, separated by
6901 non-keyword characters (white space is preferred). Maximum line
6902 length is 510 bytes.
6903 To obtain a file to be used here, check out the wordlist FAQ at
6904 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006905 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 after a comma are ignored, otherwise spaces are included in the file
6907 name. See |option-backslash| about using backslashes.
6908 The use of |:set+=| and |:set-=| is preferred when adding or removing
6909 directories from the list. This avoids problems when a future version
6910 uses another default.
6911 Backticks cannot be used in this option for security reasons.
6912
6913 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6914'tildeop' 'top' boolean (default off)
6915 global
6916 {not in Vi}
6917 When on: The tilde command "~" behaves like an operator.
6918 NOTE: This option is reset when 'compatible' is set.
6919
6920 *'timeout'* *'to'* *'notimeout'* *'noto'*
6921'timeout' 'to' boolean (default on)
6922 global
6923 *'ttimeout'* *'nottimeout'*
6924'ttimeout' boolean (default off)
6925 global
6926 {not in Vi}
6927 These two options together determine the behavior when part of a
6928 mapped key sequence or keyboard code has been received:
6929
6930 'timeout' 'ttimeout' action ~
6931 off off do not time out
6932 on on or off time out on :mappings and key codes
6933 off on time out on key codes
6934
6935 If both options are off, Vim will wait until either the complete
6936 mapping or key sequence has been received, or it is clear that there
6937 is no mapping or key sequence for the received characters. For
6938 example: if you have mapped "vl" and Vim has received 'v', the next
6939 character is needed to see if the 'v' is followed by an 'l'.
6940 When one of the options is on, Vim will wait for about 1 second for
6941 the next character to arrive. After that the already received
6942 characters are interpreted as single characters. The waiting time can
6943 be changed with the 'timeoutlen' option.
6944 On slow terminals or very busy systems timing out may cause
6945 malfunctioning cursor keys. If both options are off, Vim waits
6946 forever after an entered <Esc> if there are key codes that start
6947 with <Esc>. You will have to type <Esc> twice. If you do not have
6948 problems with key codes, but would like to have :mapped key
6949 sequences not timing out in 1 second, set the 'ttimeout' option and
6950 reset the 'timeout' option.
6951
6952 NOTE: 'ttimeout' is reset when 'compatible' is set.
6953
6954 *'timeoutlen'* *'tm'*
6955'timeoutlen' 'tm' number (default 1000)
6956 global
6957 {not in all versions of Vi}
6958 *'ttimeoutlen'* *'ttm'*
6959'ttimeoutlen' 'ttm' number (default -1)
6960 global
6961 {not in Vi}
6962 The time in milliseconds that is waited for a key code or mapped key
6963 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6964 when part of a command has been typed.
6965 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6966 different timeout value for key codes is desired set 'ttimeoutlen' to
6967 a non-negative number.
6968
6969 ttimeoutlen mapping delay key code delay ~
6970 < 0 'timeoutlen' 'timeoutlen'
6971 >= 0 'timeoutlen' 'ttimeoutlen'
6972
6973 The timeout only happens when the 'timeout' and 'ttimeout' options
6974 tell so. A useful setting would be >
6975 :set timeout timeoutlen=3000 ttimeoutlen=100
6976< (time out on mapping after three seconds, time out on key codes after
6977 a tenth of a second).
6978
6979 *'title'* *'notitle'*
6980'title' boolean (default off, on when title can be restored)
6981 global
6982 {not in Vi}
6983 {not available when compiled without the |+title|
6984 feature}
6985 When on, the title of the window will be set to the value of
6986 'titlestring' (if it is not empty), or to:
6987 filename [+=-] (path) - VIM
6988 Where:
6989 filename the name of the file being edited
6990 - indicates the file cannot be modified, 'ma' off
6991 + indicates the file was modified
6992 = indicates the file is read-only
6993 =+ indicates the file is read-only and modified
6994 (path) is the path of the file being edited
6995 - VIM the server name |v:servername| or "VIM"
6996 Only works if the terminal supports setting window titles
6997 (currently Amiga console, Win32 console, all GUI versions and
6998 terminals with a non- empty 't_ts' option - these are Unix xterm and
6999 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7000 *X11*
7001 When Vim was compiled with HAVE_X11 defined, the original title will
7002 be restored if possible. The output of ":version" will include "+X11"
7003 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7004 works for the icon name |'icon'|.
7005 But: When Vim was started with the |-X| argument, restoring the title
7006 will not work (except in the GUI).
7007 If the title cannot be restored, it is set to the value of 'titleold'.
7008 You might want to restore the title outside of Vim then.
7009 When using an xterm from a remote machine you can use this command:
7010 rsh machine_name xterm -display $DISPLAY &
7011 then the WINDOWID environment variable should be inherited and the
7012 title of the window should change back to what it should be after
7013 exiting Vim.
7014
7015 *'titlelen'*
7016'titlelen' number (default 85)
7017 global
7018 {not in Vi}
7019 {not available when compiled without the |+title|
7020 feature}
7021 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007022 title. When the title is longer, only the end of the path name is
7023 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 Using a percentage makes this adapt to the width of the window. But
7025 it won't work perfectly, because the actual number of characters
7026 available also depends on the font used and other things in the title
7027 bar. When 'titlelen' is zero the full path is used. Otherwise,
7028 values from 1 to 30000 percent can be used.
7029 'titlelen' is also used for the 'titlestring' option.
7030
7031 *'titleold'*
7032'titleold' string (default "Thanks for flying Vim")
7033 global
7034 {not in Vi}
7035 {only available when compiled with the |+title|
7036 feature}
7037 This option will be used for the window title when exiting Vim if the
7038 original title cannot be restored. Only happens if 'title' is on or
7039 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007040 This option cannot be set from a |modeline| or in the |sandbox|, for
7041 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007042 *'titlestring'*
7043'titlestring' string (default "")
7044 global
7045 {not in Vi}
7046 {not available when compiled without the |+title|
7047 feature}
7048 When this option is not empty, it will be used for the title of the
7049 window. This happens only when the 'title' option is on.
7050 Only works if the terminal supports setting window titles (currently
7051 Amiga console, Win32 console, all GUI versions and terminals with a
7052 non-empty 't_ts' option).
7053 When Vim was compiled with HAVE_X11 defined, the original title will
7054 be restored if possible |X11|.
7055 When this option contains printf-style '%' items, they will be
7056 expanded according to the rules used for 'statusline'.
7057 Example: >
7058 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7059 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7060< The value of 'titlelen' is used to align items in the middle or right
7061 of the available space.
7062 Some people prefer to have the file name first: >
7063 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7064< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007065 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066 separating space only when needed.
7067 NOTE: Use of special characters in 'titlestring' may cause the display
7068 to be garbled (e.g., when it contains a CR or NL character).
7069 {not available when compiled without the |+statusline| feature}
7070
7071 *'toolbar'* *'tb'*
7072'toolbar' 'tb' string (default "icons,tooltips")
7073 global
7074 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7075 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007076 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007077 possible values are:
7078 icons Toolbar buttons are shown with icons.
7079 text Toolbar buttons shown with text.
7080 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007081 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082 tooltips Tooltips are active for toolbar buttons.
7083 Tooltips refer to the popup help text which appears after the mouse
7084 cursor is placed over a toolbar button for a brief moment.
7085
7086 If you want the toolbar to be shown with icons as well as text, do the
7087 following: >
7088 :set tb=icons,text
7089< Motif and Athena cannot display icons and text at the same time. They
7090 will show icons if both are requested.
7091
7092 If none of the strings specified in 'toolbar' are valid or if
7093 'toolbar' is empty, this option is ignored. If you want to disable
7094 the toolbar, you need to set the 'guioptions' option. For example: >
7095 :set guioptions-=T
7096< Also see |gui-toolbar|.
7097
7098 *'toolbariconsize'* *'tbis'*
7099'toolbariconsize' 'tbis' string (default "small")
7100 global
7101 {not in Vi}
7102 {only in the GTK+ 2 GUI}
7103 Controls the size of toolbar icons. The possible values are:
7104 tiny Use tiny toolbar icons.
7105 small Use small toolbar icons (default).
7106 medium Use medium-sized toolbar icons.
7107 large Use large toolbar icons.
7108 The exact dimensions in pixels of the various icon sizes depend on
7109 the current theme. Common dimensions are large=32x32, medium=24x24,
7110 small=20x20 and tiny=16x16.
7111
7112 If 'toolbariconsize' is empty, the global default size as determined
7113 by user preferences or the current theme is used.
7114
7115 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7116'ttybuiltin' 'tbi' boolean (default on)
7117 global
7118 {not in Vi}
7119 When on, the builtin termcaps are searched before the external ones.
7120 When off the builtin termcaps are searched after the external ones.
7121 When this option is changed, you should set the 'term' option next for
7122 the change to take effect, for example: >
7123 :set notbi term=$TERM
7124< See also |termcap|.
7125 Rationale: The default for this option is "on", because the builtin
7126 termcap entries are generally better (many systems contain faulty
7127 xterm entries...).
7128
7129 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7130'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7131 sun-cmd, screen, rxvt, dtterm or
7132 iris-ansi; also on when running Vim in
7133 a DOS console)
7134 global
7135 {not in Vi}
7136 Indicates a fast terminal connection. More characters will be sent to
7137 the screen for redrawing, instead of using insert/delete line
7138 commands. Improves smoothness of redrawing when there are multiple
7139 windows and the terminal does not support a scrolling region.
7140 Also enables the extra writing of characters at the end of each screen
7141 line for lines that wrap. This helps when using copy/paste with the
7142 mouse in an xterm and other terminals.
7143
7144 *'ttymouse'* *'ttym'*
7145'ttymouse' 'ttym' string (default depends on 'term')
7146 global
7147 {not in Vi}
7148 {only in Unix and VMS, doesn't work in the GUI; not
7149 available when compiled without |+mouse|}
7150 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007151 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 *xterm-mouse*
7153 xterm xterm-like mouse handling. The mouse generates
7154 "<Esc>[Mscr", where "scr" is three bytes:
7155 "s" = button state
7156 "c" = column plus 33
7157 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007158 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007159 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 xterm2 Works like "xterm", but with the xterm reporting the
7161 mouse position while the mouse is dragged. This works
7162 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007163 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 work. See below for how Vim detects this
7165 automatically.
7166 *netterm-mouse*
7167 netterm NetTerm mouse handling. The mouse generates
7168 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7169 for the row and column.
7170 *dec-mouse*
7171 dec DEC terminal mouse handling. The mouse generates a
7172 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007173 This is also available for an Xterm, if it was
7174 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175 *jsbterm-mouse*
7176 jsbterm JSB term mouse handling.
7177 *pterm-mouse*
7178 pterm QNX pterm mouse handling.
7179
7180 The mouse handling must be enabled at compile time |+mouse_xterm|
7181 |+mouse_dec| |+mouse_netterm|.
7182 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7183 recognized, if enabled at compile time. DEC terminal mouse codes
7184 are recognized if enabled at compile time, and 'ttymouse' is not
7185 "xterm" (because the xterm and dec mouse codes conflict).
7186 This option is automatically set to "xterm", when the 'term' option is
7187 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7188 or "xterm2" already. The main use of this option is to set it to
7189 "xterm", when the terminal name doesn't start with "xterm", but it can
7190 handle xterm mouse codes.
7191 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007192 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 feature and if |t_RV| is set to the escape sequence to request the
7194 xterm version number. Otherwise "xterm2" must be set explicitly.
7195 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7196 t_RV to an empty string: >
7197 :set t_RV=
7198<
7199 *'ttyscroll'* *'tsl'*
7200'ttyscroll' 'tsl' number (default 999)
7201 global
7202 Maximum number of lines to scroll the screen. If there are more lines
7203 to scroll the window is redrawn. For terminals where scrolling is
7204 very slow and redrawing is not slow this can be set to a small number,
7205 e.g., 3, to speed up displaying.
7206
7207 *'ttytype'* *'tty'*
7208'ttytype' 'tty' string (default from $TERM)
7209 global
7210 Alias for 'term', see above.
7211
7212 *'undolevels'* *'ul'*
7213'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7214 Win32 and OS/2)
7215 global
7216 {not in Vi}
7217 Maximum number of changes that can be undone. Since undo information
7218 is kept in memory, higher numbers will cause more memory to be used
7219 (nevertheless, a single change can use an unlimited amount of memory).
7220 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7221 itself: >
7222 set ul=0
7223< But you can also get Vi compatibility by including the 'u' flag in
7224 'cpoptions', and still be able to use CTRL-R to repeat undo.
7225 Set to a negative number for no undo at all: >
7226 set ul=-1
7227< This helps when you run out of memory for a single change.
7228 Also see |undo-two-ways|.
7229
7230 *'updatecount'* *'uc'*
7231'updatecount' 'uc' number (default: 200)
7232 global
7233 {not in Vi}
7234 After typing this many characters the swap file will be written to
7235 disk. When zero, no swap file will be created at all (see chapter on
7236 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7237 Vim with the "-n" option, see |startup|. When editing in readonly
7238 mode this option will be initialized to 10000.
7239 The swapfile can be disabled per buffer with |'swapfile'|.
7240 When 'updatecount' is set from zero to non-zero, swap files are
7241 created for all buffers that have 'swapfile' set. When 'updatecount'
7242 is set to zero, existing swap files are not deleted.
7243 Also see |'swapsync'|.
7244 This option has no meaning in buffers where |'buftype'| is "nofile"
7245 or "nowrite".
7246
7247 *'updatetime'* *'ut'*
7248'updatetime' 'ut' number (default 4000)
7249 global
7250 {not in Vi}
7251 If this many milliseconds nothing is typed the swap file will be
7252 written to disk (see |crash-recovery|). Also used for the
7253 |CursorHold| autocommand event.
7254
7255 *'verbose'* *'vbs'*
7256'verbose' 'vbs' number (default 0)
7257 global
7258 {not in Vi, although some versions have a boolean
7259 verbose option}
7260 When bigger than zero, Vim will give messages about what it is doing.
7261 Currently, these messages are given:
7262 >= 1 When the viminfo file is read or written.
7263 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007264 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265 >= 8 Files for which a group of autocommands is executed.
7266 >= 9 Every executed autocommand.
7267 >= 12 Every executed function.
7268 >= 13 When an exception is thrown, caught, finished, or discarded.
7269 >= 14 Anything pending in a ":finally" clause.
7270 >= 15 Every executed Ex command (truncated at 200 characters).
7271
7272 This option can also be set with the "-V" argument. See |-V|.
7273 This option is also set by the |:verbose| command.
7274
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007275 When the 'verbosefile' option is set then the verbose messages are not
7276 displayed.
7277
7278 *'verbosefile'* *'vfile'*
7279'verbosefile' 'vfile' string (default empty)
7280 global
7281 {not in Vi}
7282 When not empty all messages are written in a file with this name.
7283 When the file exists messages are appended.
7284 Writing to the file ends when Vim exits or when 'verbosefile' is made
7285 empty.
7286 Setting 'verbosefile' to a new value is like making it empty first.
7287 The difference with |:redir| is that verbose messages are not
7288 displayed when 'verbosefile' is set.
7289
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 *'viewdir'* *'vdir'*
7291'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7292 "$VIM/vimfiles/view",
7293 for Unix: "~/.vim/view",
7294 for Macintosh: "$VIM:vimfiles:view"
7295 for VMS: "sys$login:vimfiles/view"
7296 for RiscOS: "Choices:vimfiles/view")
7297 global
7298 {not in Vi}
7299 {not available when compiled without the +mksession
7300 feature}
7301 Name of the directory where to store files for |:mkview|.
7302 This option cannot be set from a |modeline| or in the |sandbox|, for
7303 security reasons.
7304
7305 *'viewoptions'* *'vop'*
7306'viewoptions' 'vop' string (default: "folds,options,cursor")
7307 global
7308 {not in Vi}
7309 {not available when compiled without the +mksession
7310 feature}
7311 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007312 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007313 word save and restore ~
7314 cursor cursor position in file and in window
7315 folds manually created folds, opened/closed folds and local
7316 fold options
7317 options options and mappings local to a window or buffer (not
7318 global values for local options)
7319 slash backslashes in file names replaced with forward
7320 slashes
7321 unix with Unix end-of-line format (single <NL>), even when
7322 on Windows or DOS
7323
7324 "slash" and "unix" are useful on Windows when sharing view files
7325 with Unix. The Unix version of Vim cannot source dos format scripts,
7326 but the Windows version of Vim can source unix format scripts.
7327
7328 *'viminfo'* *'vi'* *E526* *E527* *E528*
7329'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007330 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7331 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7332 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007333 global
7334 {not in Vi}
7335 {not available when compiled without the |+viminfo|
7336 feature}
7337 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007338 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339 separated list of parameters, each consisting of a single character
7340 identifying the particular parameter, followed by a number or string
7341 which specifies the value of that parameter. If a particular
7342 character is left out, then the default value is used for that
7343 parameter. The following is a list of the identifying characters and
7344 the effect of their value.
7345 CHAR VALUE ~
7346 ! When included, save and restore global variables that start
7347 with an uppercase letter, and don't contain a lowercase
7348 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007349 and "_K_L_M" are not. Only String and Number types are
7350 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 " Maximum number of lines saved for each register. Old name of
7352 the '<' item, with the disadvantage that you need to put a
7353 backslash before the ", otherwise it will be recognized as the
7354 start of a comment!
7355 % When included, save and restore the buffer list. If Vim is
7356 started with a file name argument, the buffer list is not
7357 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007358 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359 without a file name and buffers for help files are not written
7360 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007361 When followed by a number, the number specifies the maximum
7362 number of buffers that are stored. Without a number all
7363 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364 ' Maximum number of previously edited files for which the marks
7365 are remembered. This parameter must always be included when
7366 'viminfo' is non-empty.
7367 Including this item also means that the |jumplist| and the
7368 |changelist| are stored in the viminfo file.
7369 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007370 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371 patterns are also saved. When not included, the value of
7372 'history' is used.
7373 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007374 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 < Maximum number of lines saved for each register. If zero then
7376 registers are not saved. When not included, all lines are
7377 saved. '"' is the old name for this item.
7378 Also see the 's' item below: limit specified in Kbyte.
7379 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007380 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381 c When included, convert the text in the viminfo file from the
7382 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007383 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 f Whether file marks need to be stored. If zero, file marks ('0
7385 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007386 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007387 cursor position (when exiting or when doing ":wviminfo").
7388 h Disable the effect of 'hlsearch' when loading the viminfo
7389 file. When not included, it depends on whether ":nohlsearch"
7390 has been used since the last search command.
7391 n Name of the viminfo file. The name must immediately follow
7392 the 'n'. Must be the last one! If the "-i" argument was
7393 given when starting Vim, that file name overrides the one
7394 given here with 'viminfo'. Environment variables are expanded
7395 when opening the file, not when setting the option.
7396 r Removable media. The argument is a string (up to the next
7397 ','). This parameter can be given several times. Each
7398 specifies the start of a path for which no marks will be
7399 stored. This is to avoid removable media. For MS-DOS you
7400 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7401 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7402 ignored. Maximum length of each 'r' argument is 50
7403 characters.
7404 s Maximum size of an item in Kbyte. If zero then registers are
7405 not saved. Currently only applies to registers. The default
7406 "s10" will exclude registers with more than 10 Kbyte of text.
7407 Also see the '<' item above: line count limit.
7408
7409 Example: >
7410 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7411<
7412 '50 Marks will be remembered for the last 50 files you
7413 edited.
7414 <1000 Contents of registers (up to 1000 lines each) will be
7415 remembered.
7416 s100 Registers with more than 100 Kbyte text are skipped.
7417 :0 Command-line history will not be saved.
7418 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7419 no / Since '/' is not specified, the default will be used,
7420 that is, save all of the search history, and also the
7421 previous search and substitute patterns.
7422 no % The buffer list will not be saved nor read back.
7423 no h 'hlsearch' highlighting will be restored.
7424
7425 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7426 load the contents of the file, this is not done automatically.
7427
7428 This option cannot be set from a |modeline| or in the |sandbox|, for
7429 security reasons.
7430
7431 *'virtualedit'* *'ve'*
7432'virtualedit' 've' string (default "")
7433 global
7434 {not in Vi}
7435 {not available when compiled without the
7436 |+virtualedit| feature}
7437 A comma separated list of these words:
7438 block Allow virtual editing in Visual block mode.
7439 insert Allow virtual editing in Insert mode.
7440 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007441 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007442
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007444 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007445 of the line. Useful for selecting a rectangle in Visual mode and
7446 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007447 "onemore" is not the same, it will only allow moving the cursor just
7448 after the last character of the line. This makes some commands more
7449 consistent. Previously the cursor was always past the end of the line
7450 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007451 break some plugins or Vim scripts. For example because |l| can move
7452 the cursor after the last character. Use with care!
7453 Using the |$| command will move to the last character in the line, not
7454 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007455 It doesn't make sense to combine "all" with "onemore", but you will
7456 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457
7458 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7459'visualbell' 'vb' boolean (default off)
7460 global
7461 {not in Vi}
7462 Use visual bell instead of beeping. The terminal code to display the
7463 visual bell is given with 't_vb'. When no beep or flash is wanted,
7464 use ":set vb t_vb=".
7465 Note: When the GUI starts, 't_vb' is reset to its default value. You
7466 might want to set it again in your |gvimrc|.
7467 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7468 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7469 where 40 is the time in msec.
7470 Does not work on the Amiga, you always get a screen flash.
7471 Also see 'errorbells'.
7472
7473 *'warn'* *'nowarn'*
7474'warn' boolean (default on)
7475 global
7476 Give a warning message when a shell command is used while the buffer
7477 has been changed.
7478
7479 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7480'weirdinvert' 'wiv' boolean (default off)
7481 global
7482 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007483 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484 It is provided for backwards compatibility with version 4.x.
7485 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7486 vice versa. Has no effect when the GUI is running.
7487
7488 *'whichwrap'* *'ww'*
7489'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7490 global
7491 {not in Vi}
7492 Allow specified keys that move the cursor left/right to move to the
7493 previous/next line when the cursor is on the first/last character in
7494 the line. Concatenate characters to allow this for these keys:
7495 char key mode ~
7496 b <BS> Normal and Visual
7497 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007498 h "h" Normal and Visual (not recommended)
7499 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007500 < <Left> Normal and Visual
7501 > <Right> Normal and Visual
7502 ~ "~" Normal
7503 [ <Left> Insert and Replace
7504 ] <Right> Insert and Replace
7505 For example: >
7506 :set ww=<,>,[,]
7507< allows wrap only when cursor keys are used.
7508 When the movement keys are used in combination with a delete or change
7509 operator, the <EOL> also counts for a character. This makes "3h"
7510 different from "3dh" when the cursor crosses the end of a line. This
7511 is also true for "x" and "X", because they do the same as "dl" and
7512 "dh". If you use this, you may also want to use the mapping
7513 ":map <BS> X" to make backspace delete the character in front of the
7514 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007515 When 'l' is included and it is used after an operator at the end of a
7516 line then it will not move to the next line. This makes "dl", "cl",
7517 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518 NOTE: This option is set to the Vi default value when 'compatible' is
7519 set and to the Vim default value when 'compatible' is reset.
7520
7521 *'wildchar'* *'wc'*
7522'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7523 global
7524 {not in Vi}
7525 Character you have to type to start wildcard expansion in the
7526 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007527 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 The character is not recognized when used inside a macro. See
7529 'wildcharm' for that.
7530 Although 'wc' is a number option, you can set it to a special key: >
7531 :set wc=<Esc>
7532< NOTE: This option is set to the Vi default value when 'compatible' is
7533 set and to the Vim default value when 'compatible' is reset.
7534
7535 *'wildcharm'* *'wcm'*
7536'wildcharm' 'wcm' number (default: none (0))
7537 global
7538 {not in Vi}
7539 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007540 recognized when used inside a macro. You can find "spare" command-line
7541 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542 you'll never actually type 'wildcharm', just use it in mappings that
7543 automatically invoke completion mode, e.g.: >
7544 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007545 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546< Then after typing :ss you can use CTRL-P & CTRL-N.
7547
7548 *'wildignore'* *'wig'*
7549'wildignore' 'wig' string (default "")
7550 global
7551 {not in Vi}
7552 {not available when compiled without the |+wildignore|
7553 feature}
7554 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007555 patterns is ignored when completing file or directory names, and
7556 influences the result of |expand()|, |glob()| and |globpath()| unless
7557 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7559 Also see 'suffixes'.
7560 Example: >
7561 :set wildignore=*.o,*.obj
7562< The use of |:set+=| and |:set-=| is preferred when adding or removing
7563 a pattern from the list. This avoids problems when a future version
7564 uses another default.
7565
7566 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7567'wildmenu' 'wmnu' boolean (default off)
7568 global
7569 {not in Vi}
7570 {not available if compiled without the |+wildmenu|
7571 feature}
7572 When 'wildmenu' is on, command-line completion operates in an enhanced
7573 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7574 the possible matches are shown just above the command line, with the
7575 first match highlighted (overwriting the status line, if there is
7576 one). Keys that show the previous/next match, such as <Tab> or
7577 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7578 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7579 specified. "longest" and "list" do not start "wildmenu" mode.
7580 If there are more matches than can fit in the line, a ">" is shown on
7581 the right and/or a "<" is shown on the left. The status line scrolls
7582 as needed.
7583 The "wildmenu" mode is abandoned when a key is hit that is not used
7584 for selecting a completion.
7585 While the "wildmenu" is active the following keys have special
7586 meanings:
7587
7588 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7589 <Down> - in filename/menu name completion: move into a
7590 subdirectory or submenu.
7591 <CR> - in menu completion, when the cursor is just after a
7592 dot: move into a submenu.
7593 <Up> - in filename/menu name completion: move up into
7594 parent directory or parent menu.
7595
7596 This makes the menus accessible from the console |console-menus|.
7597
7598 If you prefer the <Left> and <Right> keys to move the cursor instead
7599 of selecting a different match, use this: >
7600 :cnoremap <Left> <Space><BS><Left>
7601 :cnoremap <Right> <Space><BS><Right>
7602<
7603 The "WildMenu" highlighting is used for displaying the current match
7604 |hl-WildMenu|.
7605
7606 *'wildmode'* *'wim'*
7607'wildmode' 'wim' string (Vim default: "full")
7608 global
7609 {not in Vi}
7610 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007611 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007612 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007613 first part specifies the behavior for the first use of 'wildchar',
7614 The second part for the second use, etc.
7615 These are the possible values for each part:
7616 "" Complete only the first match.
7617 "full" Complete the next full match. After the last match,
7618 the original string is used and then the first match
7619 again.
7620 "longest" Complete till longest common string. If this doesn't
7621 result in a longer string, use the next part.
7622 "longest:full" Like "longest", but also start 'wildmenu' if it is
7623 enabled.
7624 "list" When more than one match, list all matches.
7625 "list:full" When more than one match, list all matches and
7626 complete first match.
7627 "list:longest" When more than one match, list all matches and
7628 complete till longest common string.
7629 When there is only a single match, it is fully completed in all cases.
7630
7631 Examples: >
7632 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007633< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634 :set wildmode=longest,full
7635< Complete longest common string, then each full match >
7636 :set wildmode=list:full
7637< List all matches and complete each full match >
7638 :set wildmode=list,full
7639< List all matches without completing, then each full match >
7640 :set wildmode=longest,list
7641< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007642 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007644 *'wildoptions'* *'wop'*
7645'wildoptions' 'wop' string (default "")
7646 global
7647 {not in Vi}
7648 {not available when compiled without the |+wildignore|
7649 feature}
7650 A list of words that change how command line completion is done.
7651 Currently only one word is allowed:
7652 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007653 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007654 is displayed per line. Often used tag kinds are:
7655 d #define
7656 f function
7657 Also see |cmdline-completion|.
7658
Bram Moolenaar071d4272004-06-13 20:20:40 +00007659 *'winaltkeys'* *'wak'*
7660'winaltkeys' 'wak' string (default "menu")
7661 global
7662 {not in Vi}
7663 {only used in Win32, Motif, GTK and Photon GUI}
7664 Some GUI versions allow the access to menu entries by using the ALT
7665 key in combination with a character that appears underlined in the
7666 menu. This conflicts with the use of the ALT key for mappings and
7667 entering special characters. This option tells what to do:
7668 no Don't use ALT keys for menus. ALT key combinations can be
7669 mapped, but there is no automatic handling. This can then be
7670 done with the |:simalt| command.
7671 yes ALT key handling is done by the windowing system. ALT key
7672 combinations cannot be mapped.
7673 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007674 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007675 keys can be mapped.
7676 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7677 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007678 This option is not used for <F10>; on Win32 and with GTK <F10> will
7679 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007680
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007681 *'window'* *'wi'*
7682'window' 'wi' number (default screen height - 1)
7683 global
7684 Window height. Do not confuse this with the height of the Vim window,
7685 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007686 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7687 value is smaller than 'lines' minus one. The screen will scroll
7688 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007689 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7690 in a much smarter way, taking care of wrapping lines.
7691 When resizing the Vim window, the value is smaller than 1 or more than
7692 or equal to 'lines' it will be set to 'lines' minus 1.
7693 {Vi also uses the option to specify the number of displayed lines}
7694
Bram Moolenaar071d4272004-06-13 20:20:40 +00007695 *'winheight'* *'wh'* *E591*
7696'winheight' 'wh' number (default 1)
7697 global
7698 {not in Vi}
7699 {not available when compiled without the +windows
7700 feature}
7701 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007702 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007703 focus goes to a window that is smaller, its size is increased, at the
7704 cost of the height of other windows.
7705 Set 'winheight' to a small number for normal editing.
7706 Set it to 999 to make the current window fill most of the screen.
7707 Other windows will be only 'winminheight' high. This has the drawback
7708 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7709 to create only two windows, set the option after startup is done,
7710 using the |VimEnter| event: >
7711 au VimEnter * set winheight=999
7712< Minimum value is 1.
7713 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007714 height of the current window.
7715 'winheight' applies to the current window. Use 'winminheight' to set
7716 the minimal height for other windows.
7717
7718 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7719'winfixheight' 'wfh' boolean (default off)
7720 local to window
7721 {not in Vi}
7722 {not available when compiled without the +windows
7723 feature}
7724 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007725 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7726 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007727 The height may be changed anyway when running out of room.
7728
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007729 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7730'winfixwidth' 'wfw' boolean (default off)
7731 local to window
7732 {not in Vi}
7733 {not available when compiled without the +windows
7734 feature}
7735 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007736 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007737 The width may be changed anyway when running out of room.
7738
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739 *'winminheight'* *'wmh'*
7740'winminheight' 'wmh' number (default 1)
7741 global
7742 {not in Vi}
7743 {not available when compiled without the +windows
7744 feature}
7745 The minimal height of a window, when it's not the current window.
7746 This is a hard minimum, windows will never become smaller.
7747 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7748 status bar) if necessary. They will return to at least one line when
7749 they become active (since the cursor has to have somewhere to go.)
7750 Use 'winheight' to set the minimal height of the current window.
7751 This option is only checked when making a window smaller. Don't use a
7752 large number, it will cause errors when opening more than a few
7753 windows. A value of 0 to 3 is reasonable.
7754
7755 *'winminwidth'* *'wmw'*
7756'winminwidth' 'wmw' number (default 1)
7757 global
7758 {not in Vi}
7759 {not available when compiled without the +vertsplit
7760 feature}
7761 The minimal width of a window, when it's not the current window.
7762 This is a hard minimum, windows will never become smaller.
7763 When set to zero, windows may be "squashed" to zero columns (i.e. just
7764 a vertical separator) if necessary. They will return to at least one
7765 line when they become active (since the cursor has to have somewhere
7766 to go.)
7767 Use 'winwidth' to set the minimal width of the current window.
7768 This option is only checked when making a window smaller. Don't use a
7769 large number, it will cause errors when opening more than a few
7770 windows. A value of 0 to 12 is reasonable.
7771
7772 *'winwidth'* *'wiw'* *E592*
7773'winwidth' 'wiw' number (default 20)
7774 global
7775 {not in Vi}
7776 {not available when compiled without the +vertsplit
7777 feature}
7778 Minimal number of columns for the current window. This is not a hard
7779 minimum, Vim will use fewer columns if there is not enough room. If
7780 the current window is smaller, its size is increased, at the cost of
7781 the width of other windows. Set it to 999 to make the current window
7782 always fill the screen. Set it to a small number for normal editing.
7783 The width is not adjusted after one of the commands to change the
7784 width of the current window.
7785 'winwidth' applies to the current window. Use 'winminwidth' to set
7786 the minimal width for other windows.
7787
7788 *'wrap'* *'nowrap'*
7789'wrap' boolean (default on)
7790 local to window
7791 {not in Vi}
7792 This option changes how text is displayed. It doesn't change the text
7793 in the buffer, see 'textwidth' for that.
7794 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007795 displaying continues on the next line. When off lines will not wrap
7796 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797 moved to a part that is not shown, the screen will scroll
7798 horizontally.
7799 The line will be broken in the middle of a word if necessary. See
7800 'linebreak' to get the break at a word boundary.
7801 To make scrolling horizontally a bit more useful, try this: >
7802 :set sidescroll=5
7803 :set listchars+=precedes:<,extends:>
7804< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007805 This option can't be set from a |modeline| when the 'diff' option is
7806 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807
7808 *'wrapmargin'* *'wm'*
7809'wrapmargin' 'wm' number (default 0)
7810 local to buffer
7811 Number of characters from the right window border where wrapping
7812 starts. When typing text beyond this limit, an <EOL> will be inserted
7813 and inserting continues on the next line.
7814 Options that add a margin, such as 'number' and 'foldcolumn', cause
7815 the text width to be further reduced. This is Vi compatible.
7816 When 'textwidth' is non-zero, this option is not used.
7817 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7818 and less usefully}
7819
7820 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7821'wrapscan' 'ws' boolean (default on) *E384* *E385*
7822 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007823 Searches wrap around the end of the file. Also applies to |]s| and
7824 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007825
7826 *'write'* *'nowrite'*
7827'write' boolean (default on)
7828 global
7829 {not in Vi}
7830 Allows writing files. When not set, writing a file is not allowed.
7831 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007832 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007833 argument. Filtering text is still possible, even though this requires
7834 writing a temporary file.
7835
7836 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7837'writeany' 'wa' boolean (default off)
7838 global
7839 Allows writing to any file with no need for "!" override.
7840
7841 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7842'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7843 otherwise)
7844 global
7845 {not in Vi}
7846 Make a backup before overwriting a file. The backup is removed after
7847 the file was successfully written, unless the 'backup' option is
7848 also on. Reset this option if your file system is almost full. See
7849 |backup-table| for another explanation.
7850 When the 'backupskip' pattern matches, a backup is not made anyway.
7851 NOTE: This option is set to the default value when 'compatible' is
7852 set.
7853
7854 *'writedelay'* *'wd'*
7855'writedelay' 'wd' number (default 0)
7856 global
7857 {not in Vi}
7858 The number of microseconds to wait for each character sent to the
7859 screen. When non-zero, characters are sent to the terminal one by
7860 one. For MS-DOS pcterm this does not work. For debugging purposes.
7861
7862 vim:tw=78:ts=8:ft=help:norl: