blob: c07549d07933fae82025fef605e89946cbbbef83 [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:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002057 *pkzip*
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002058 0 PkZip compatible method. A weak kind of encryption.
2059 backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002060 *blowfish*
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002061 1 Blowfish method. Strong encryption. Not compatible
2062 with Vim 7.2 and older.
2063 When reading an encrypted file 'cryptmethod' will be set automatically
2064 to detected method for the file being read.
2065
2066
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 *'cscopepathcomp'* *'cspc'*
2068'cscopepathcomp' 'cspc' number (default 0)
2069 global
2070 {not available when compiled without the |+cscope|
2071 feature}
2072 {not in Vi}
2073 Determines how many components of the path to show in a list of tags.
2074 See |cscopepathcomp|.
2075
2076 *'cscopeprg'* *'csprg'*
2077'cscopeprg' 'csprg' string (default "cscope")
2078 global
2079 {not available when compiled without the |+cscope|
2080 feature}
2081 {not in Vi}
2082 Specifies the command to execute cscope. See |cscopeprg|.
2083 This option cannot be set from a |modeline| or in the |sandbox|, for
2084 security reasons.
2085
2086 *'cscopequickfix'* *'csqf'*
2087'cscopequickfix' 'csqf' string (default "")
2088 global
2089 {not available when compiled without the |+cscope|
2090 or |+quickfix| features}
2091 {not in Vi}
2092 Specifies whether to use quickfix window to show cscope results.
2093 See |cscopequickfix|.
2094
2095 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2096'cscopetag' 'cst' boolean (default off)
2097 global
2098 {not available when compiled without the |+cscope|
2099 feature}
2100 {not in Vi}
2101 Use cscope for tag commands. See |cscope-options|.
2102 NOTE: This option is reset when 'compatible' is set.
2103
2104 *'cscopetagorder'* *'csto'*
2105'cscopetagorder' 'csto' number (default 0)
2106 global
2107 {not available when compiled without the |+cscope|
2108 feature}
2109 {not in Vi}
2110 Determines the order in which ":cstag" performs a search. See
2111 |cscopetagorder|.
2112 NOTE: This option is set to 0 when 'compatible' is set.
2113
2114 *'cscopeverbose'* *'csverb'*
2115 *'nocscopeverbose'* *'nocsverb'*
2116'cscopeverbose' 'csverb' boolean (default off)
2117 global
2118 {not available when compiled without the |+cscope|
2119 feature}
2120 {not in Vi}
2121 Give messages when adding a cscope database. See |cscopeverbose|.
2122 NOTE: This option is reset when 'compatible' is set.
2123
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002124
2125 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2126'cursorcolumn' 'cuc' boolean (default off)
2127 local to window
2128 {not in Vi}
2129 {not available when compiled without the |+syntax|
2130 feature}
2131 Highlight the screen column of the cursor with CursorColumn
2132 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2133 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002134 If you only want the highlighting in the current window you can use
2135 these autocommands: >
2136 au WinLeave * set nocursorline nocursorcolumn
2137 au WinEnter * set cursorline cursorcolumn
2138<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002139
2140 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2141'cursorline' 'cul' boolean (default off)
2142 local to window
2143 {not in Vi}
2144 {not available when compiled without the |+syntax|
2145 feature}
2146 Highlight the screen line of the cursor with CursorLine
2147 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2148 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002149 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002150 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002151
2152
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153 *'debug'*
2154'debug' string (default "")
2155 global
2156 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002157 These values can be used:
2158 msg Error messages that would otherwise be omitted will be given
2159 anyway.
2160 throw Error messages that would otherwise be omitted will be given
2161 anyway and also throw an exception and set |v:errmsg|.
2162 beep A message will be given when otherwise only a beep would be
2163 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002164 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002165 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2166 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167
2168 *'define'* *'def'*
2169'define' 'def' string (default "^\s*#\s*define")
2170 global or local to buffer |global-local|
2171 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002172 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173 pattern, just like for the "/" command. This option is used for the
2174 commands like "[i" and "[d" |include-search|. The 'isident' option is
2175 used to recognize the defined name after the match:
2176 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2177 See |option-backslash| about inserting backslashes to include a space
2178 or backslash.
2179 The default value is for C programs. For C++ this value would be
2180 useful, to include const type declarations: >
2181 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2182< When using the ":set" command, you need to double the backslashes!
2183
2184 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2185'delcombine' 'deco' boolean (default off)
2186 global
2187 {not in Vi}
2188 {only available when compiled with the |+multi_byte|
2189 feature}
2190 If editing Unicode and this option is set, backspace and Normal mode
2191 "x" delete each combining character on its own. When it is off (the
2192 default) the character along with its combining characters are
2193 deleted.
2194 Note: When 'delcombine' is set "xx" may work different from "2x"!
2195
2196 This is useful for Arabic, Hebrew and many other languages where one
2197 may have combining characters overtop of base characters, and want
2198 to remove only the combining ones.
2199
2200 *'dictionary'* *'dict'*
2201'dictionary' 'dict' string (default "")
2202 global or local to buffer |global-local|
2203 {not in Vi}
2204 List of file names, separated by commas, that are used to lookup words
2205 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2206 contain a list of words. This can be one word per line, or several
2207 words per line, separated by non-keyword characters (white space is
2208 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002209 When this option is empty, or an entry "spell" is present, spell
2210 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002211 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212 after a comma are ignored, otherwise spaces are included in the file
2213 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002214 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215 Where to find a list of words?
2216 - On FreeBSD, there is the file "/usr/share/dict/words".
2217 - In the Simtel archive, look in the "msdos/linguist" directory.
2218 - In "miscfiles" of the GNU collection.
2219 The use of |:set+=| and |:set-=| is preferred when adding or removing
2220 directories from the list. This avoids problems when a future version
2221 uses another default.
2222 Backticks cannot be used in this option for security reasons.
2223
2224 *'diff'* *'nodiff'*
2225'diff' boolean (default off)
2226 local to window
2227 {not in Vi}
2228 {not available when compiled without the |+diff|
2229 feature}
2230 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002231 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232
2233 *'dex'* *'diffexpr'*
2234'diffexpr' 'dex' string (default "")
2235 global
2236 {not in Vi}
2237 {not available when compiled without the |+diff|
2238 feature}
2239 Expression which is evaluated to obtain an ed-style diff file from two
2240 versions of a file. See |diff-diffexpr|.
2241 This option cannot be set from a |modeline| or in the |sandbox|, for
2242 security reasons.
2243
2244 *'dip'* *'diffopt'*
2245'diffopt' 'dip' string (default "filler")
2246 global
2247 {not in Vi}
2248 {not available when compiled without the |+diff|
2249 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002250 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 All are optional. Items must be separated by a comma.
2252
2253 filler Show filler lines, to keep the text
2254 synchronized with a window that has inserted
2255 lines at the same position. Mostly useful
2256 when windows are side-by-side and 'scrollbind'
2257 is set.
2258
2259 context:{n} Use a context of {n} lines between a change
2260 and a fold that contains unchanged lines.
2261 When omitted a context of six lines is used.
2262 See |fold-diff|.
2263
2264 icase Ignore changes in case of text. "a" and "A"
2265 are considered the same. Adds the "-i" flag
2266 to the "diff" command if 'diffexpr' is empty.
2267
2268 iwhite Ignore changes in amount of white space. Adds
2269 the "-b" flag to the "diff" command if
2270 'diffexpr' is empty. Check the documentation
2271 of the "diff" command for what this does
2272 exactly. It should ignore adding trailing
2273 white space, but not leading white space.
2274
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002275 horizontal Start diff mode with horizontal splits (unless
2276 explicitly specified otherwise).
2277
2278 vertical Start diff mode with vertical splits (unless
2279 explicitly specified otherwise).
2280
2281 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2282 starting diff mode. Without this 2 is used.
2283
Bram Moolenaar071d4272004-06-13 20:20:40 +00002284 Examples: >
2285
2286 :set diffopt=filler,context:4
2287 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002288 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289<
2290 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2291'digraph' 'dg' boolean (default off)
2292 global
2293 {not in Vi}
2294 {not available when compiled without the |+digraphs|
2295 feature}
2296 Enable the entering of digraphs in Insert mode with {char1} <BS>
2297 {char2}. See |digraphs|.
2298 NOTE: This option is reset when 'compatible' is set.
2299
2300 *'directory'* *'dir'*
2301'directory' 'dir' string (default for Amiga: ".,t:",
2302 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2303 for Unix: ".,~/tmp,/var/tmp,/tmp")
2304 global
2305 List of directory names for the swap file, separated with commas.
2306 - The swap file will be created in the first directory where this is
2307 possible.
2308 - Empty means that no swap file will be used (recovery is
2309 impossible!).
2310 - A directory "." means to put the swap file in the same directory as
2311 the edited file. On Unix, a dot is prepended to the file name, so
2312 it doesn't show in a directory listing. On MS-Windows the "hidden"
2313 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002314 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002315 put the swap file relative to where the edited file is. The leading
2316 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002317 - For Unix and Win32, if a directory ends in two path separators "//"
2318 or "\\", the swap file name will be built from the complete path to
2319 the file with all path separators substituted to percent '%' signs.
2320 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002321 On Win32, when a separating comma is following, you must use "//",
2322 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 - Spaces after the comma are ignored, other spaces are considered part
2324 of the directory name. To have a space at the start of a directory
2325 name, precede it with a backslash.
2326 - To include a comma in a directory name precede it with a backslash.
2327 - A directory name may end in an ':' or '/'.
2328 - Environment variables are expanded |:set_env|.
2329 - Careful with '\' characters, type one before a space, type two to
2330 get one in the option (see |option-backslash|), for example: >
2331 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2332< - For backwards compatibility with Vim version 3.0 a '>' at the start
2333 of the option is removed.
2334 Using "." first in the list is recommended. This means that editing
2335 the same file twice will result in a warning. Using "/tmp" on Unix is
2336 discouraged: When the system crashes you lose the swap file.
2337 "/var/tmp" is often not cleared when rebooting, thus is a better
2338 choice than "/tmp". But it can contain a lot of files, your swap
2339 files get lost in the crowd. That is why a "tmp" directory in your
2340 home directory is tried first.
2341 The use of |:set+=| and |:set-=| is preferred when adding or removing
2342 directories from the list. This avoids problems when a future version
2343 uses another default.
2344 This option cannot be set from a |modeline| or in the |sandbox|, for
2345 security reasons.
2346 {Vi: directory to put temp file in, defaults to "/tmp"}
2347
2348 *'display'* *'dy'*
2349'display' 'dy' string (default "")
2350 global
2351 {not in Vi}
2352 Change the way text is displayed. This is comma separated list of
2353 flags:
2354 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002355 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356 last line that doesn't fit is replaced with "@" lines.
2357 uhex Show unprintable characters hexadecimal as <xx>
2358 instead of using ^C and ~C.
2359
2360 *'eadirection'* *'ead'*
2361'eadirection' 'ead' string (default "both")
2362 global
2363 {not in Vi}
2364 {not available when compiled without the +vertsplit
2365 feature}
2366 Tells when the 'equalalways' option applies:
2367 ver vertically, width of windows is not affected
2368 hor horizontally, height of windows is not affected
2369 both width and height of windows is affected
2370
2371 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2372'edcompatible' 'ed' boolean (default off)
2373 global
2374 Makes the 'g' and 'c' flags of the ":substitute" command to be
2375 toggled each time the flag is given. See |complex-change|. See
2376 also 'gdefault' option.
2377 Switching this option on is discouraged!
2378
2379 *'encoding'* *'enc'* *E543*
2380'encoding' 'enc' string (default: "latin1" or value from $LANG)
2381 global
2382 {only available when compiled with the |+multi_byte|
2383 feature}
2384 {not in Vi}
2385 Sets the character encoding used inside Vim. It applies to text in
2386 the buffers, registers, Strings in expressions, text stored in the
2387 viminfo file, etc. It sets the kind of characters which Vim can work
2388 with. See |encoding-names| for the possible values.
2389
2390 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002391 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002393 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002394
2395 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2396 "utf-8". Although care has been taken to allow different values of
2397 'encoding', "utf-8" is the natural choice for the environment and
2398 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002399 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400 versions, and to avoid changing the encoding of newly created files
2401 without your knowledge (in case 'fileencodings' is empty).
2402
2403 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002404 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405 iconv() or as specified with 'charconvert'.
2406
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002407 If you need to know whether 'encoding' is a multi-byte encoding, you
2408 can use: >
2409 if has("multi_byte_encoding")
2410<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 Normally 'encoding' will be equal to your current locale. This will
2412 be the default if Vim recognizes your environment settings. If
2413 'encoding' is not set to the current locale, 'termencoding' must be
2414 set to convert typed and displayed text. See |encoding-table|.
2415
2416 When you set this option, it fires the |EncodingChanged| autocommand
2417 event so that you can set up fonts if necessary.
2418
2419 When the option is set, the value is converted to lowercase. Thus
2420 you can set it with uppercase values too. Underscores are translated
2421 to '-' signs.
2422 When the encoding is recognized, it is changed to the standard name.
2423 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2424 "iso-8859-2" and "utf8" becomes "utf-8".
2425
2426 Note: "latin1" is also used when the encoding could not be detected.
2427 This only works when editing files in the same encoding! When the
2428 actual character set is not latin1, make sure 'fileencoding' and
2429 'fileencodings' are empty. When conversion is needed, switch to using
2430 utf-8.
2431
2432 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2433 You don't notice this while editing, but it does matter for the
2434 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2435 setting 'encoding' to one of these values instead of utf-8 only has
2436 effect for encoding used for files when 'fileencoding' is empty.
2437
Bram Moolenaar661b1822005-07-28 22:36:45 +00002438 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2439 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440
2441 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2442'endofline' 'eol' boolean (default on)
2443 local to buffer
2444 {not in Vi}
2445 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002446 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447 option is automatically set when starting to edit a new file, unless
2448 the file does not have an <EOL> for the last line in the file, in
2449 which case it is reset. Normally you don't have to set or reset this
2450 option. When 'binary' is off the value is not used when writing the
2451 file. When 'binary' is on it is used to remember the presence of a
2452 <EOL> for the last line in the file, so that when you write the file
2453 the situation from the original file can be kept. But you can change
2454 it if you want to.
2455
2456 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2457'equalalways' 'ea' boolean (default on)
2458 global
2459 {not in Vi}
2460 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002461 splitting or closing a window. This also happens the moment the
2462 option is switched on. When off, splitting a window will reduce the
2463 size of the current window and leave the other windows the same. When
2464 closing a window the extra lines are given to the window next to it
2465 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002466 When mixing vertically and horizontally split windows, a minimal size
2467 is computed and some windows may be larger if there is room. The
2468 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002469 Changing the height and width of a window can be avoided by setting
2470 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002471 If a window size is specified when creating a new window sizes are
2472 currently not equalized (it's complicated, but may be implemented in
2473 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474
2475 *'equalprg'* *'ep'*
2476'equalprg' 'ep' string (default "")
2477 global or local to buffer |global-local|
2478 {not in Vi}
2479 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002480 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002481 or 'indentexpr'. When Vim was compiled without internal formatting,
2482 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002483 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484 about including spaces and backslashes.
2485 This option cannot be set from a |modeline| or in the |sandbox|, for
2486 security reasons.
2487
2488 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2489'errorbells' 'eb' boolean (default off)
2490 global
2491 Ring the bell (beep or screen flash) for error messages. This only
2492 makes a difference for error messages, the bell will be used always
2493 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002494 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495 screen flash or do nothing.
2496
2497 *'errorfile'* *'ef'*
2498'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2499 others: "errors.err")
2500 global
2501 {not in Vi}
2502 {not available when compiled without the |+quickfix|
2503 feature}
2504 Name of the errorfile for the QuickFix mode (see |:cf|).
2505 When the "-q" command-line argument is used, 'errorfile' is set to the
2506 following argument. See |-q|.
2507 NOT used for the ":make" command. See 'makeef' for that.
2508 Environment variables are expanded |:set_env|.
2509 See |option-backslash| about including spaces and backslashes.
2510 This option cannot be set from a |modeline| or in the |sandbox|, for
2511 security reasons.
2512
2513 *'errorformat'* *'efm'*
2514'errorformat' 'efm' string (default is very long)
2515 global or local to buffer |global-local|
2516 {not in Vi}
2517 {not available when compiled without the |+quickfix|
2518 feature}
2519 Scanf-like description of the format for the lines in the error file
2520 (see |errorformat|).
2521
2522 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2523'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2524 global
2525 {not in Vi}
2526 Function keys that start with an <Esc> are recognized in Insert
2527 mode. When this option is off, the cursor and function keys cannot be
2528 used in Insert mode if they start with an <Esc>. The advantage of
2529 this is that the single <Esc> is recognized immediately, instead of
2530 after one second. Instead of resetting this option, you might want to
2531 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2532 when 'esckeys' is off, you can still map anything, but the cursor keys
2533 won't work by default.
2534 NOTE: This option is set to the Vi default value when 'compatible' is
2535 set and to the Vim default value when 'compatible' is reset.
2536
2537 *'eventignore'* *'ei'*
2538'eventignore' 'ei' string (default "")
2539 global
2540 {not in Vi}
2541 {not available when compiled without the |+autocmd|
2542 feature}
2543 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002544 When set to "all" or when "all" is one of the items, all autocommand
2545 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002546 Otherwise this is a comma separated list of event names. Example: >
2547 :set ei=WinEnter,WinLeave
2548<
2549 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2550'expandtab' 'et' boolean (default off)
2551 local to buffer
2552 {not in Vi}
2553 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002554 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2556 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2557 NOTE: This option is reset when 'compatible' is set.
2558
2559 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2560'exrc' 'ex' boolean (default off)
2561 global
2562 {not in Vi}
2563 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2564 directory. If you switch this option on you should also consider
2565 setting the 'secure' option (see |initialization|). Using a local
2566 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2567 also see |.vimrc| and |gui-init|.
2568 This option cannot be set from a |modeline| or in the |sandbox|, for
2569 security reasons.
2570
2571 *'fileencoding'* *'fenc'* *E213*
2572'fileencoding' 'fenc' string (default: "")
2573 local to buffer
2574 {only available when compiled with the |+multi_byte|
2575 feature}
2576 {not in Vi}
2577 Sets the character encoding for the file of this buffer.
2578 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002579 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580 When 'fileencoding' is empty, the same value as 'encoding' will be
2581 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002582 Conversion will also be done when 'encoding' and 'fileencoding' are
2583 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2584 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002586 'encoding' is "utf-8" or another Unicode encoding, conversion
2587 is most likely done in a way that the reverse conversion
2588 results in the same text. When 'encoding' is not "utf-8" some
2589 characters may be lost!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590 See 'encoding' for the possible values. Additionally, values may be
2591 specified that can be handled by the converter, see
2592 |mbyte-conversion|.
2593 When reading a file 'fileencoding' will be set from 'fileencodings'.
2594 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002595 'fileencoding', use the |++enc| argument. One exception: when
2596 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002597 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2599 When the option is set, the value is converted to lowercase. Thus
2600 you can set it with uppercase values too. '_' characters are
2601 replaced with '-'. If a name is recognized from the list for
2602 'encoding', it is replaced by the standard name. For example
2603 "ISO8859-2" becomes "iso-8859-2".
2604 When this option is set, after starting to edit a file, the 'modified'
2605 option is set, because the file would be different when written.
2606 If you do this in a modeline, you might want to set 'nomodified' to
2607 avoid this.
2608 This option can not be changed when 'modifiable' is off.
2609
2610 *'fe'*
2611 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002612 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002613 old short name was 'fe', which is no longer used.
2614
2615 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002616'fileencodings' 'fencs' string (default: "ucs-bom",
2617 "ucs-bom,utf-8,default,latin1" when
2618 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619 global
2620 {only available when compiled with the |+multi_byte|
2621 feature}
2622 {not in Vi}
2623 This is a list of character encodings considered when starting to edit
2624 an existing file. When a file is read, Vim tries to use the first
2625 mentioned character encoding. If an error is detected, the next one
2626 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002627 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 an empty string, which means the value of 'encoding' is used.
2629 WARNING: Conversion can cause loss of information! When
2630 'encoding' is "utf-8" (or one of the other Unicode variants)
2631 conversion is most likely done in a way that the reverse
2632 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002633 "utf-8" some non-ASCII characters may be lost! You can use
2634 the |++bad| argument to specify what is done with characters
2635 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636 For an empty file or a file with only ASCII characters most encodings
2637 will work and the first entry of 'fileencodings' will be used (except
2638 "ucs-bom", which requires the BOM to be present). If you prefer
2639 another encoding use an BufReadPost autocommand event to test if your
2640 preferred encoding is to be used. Example: >
2641 au BufReadPost * if search('\S', 'w') == 0 |
2642 \ set fenc=iso-2022-jp | endif
2643< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2644 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002645 When the |++enc| argument is used then the value of 'fileencodings' is
2646 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002647 Note that 'fileencodings' is not used for a new file, the global value
2648 of 'fileencoding' is used instead. You can set it with: >
2649 :setglobal fenc=iso-8859-2
2650< This means that a non-existing file may get a different encoding than
2651 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 The special value "ucs-bom" can be used to check for a Unicode BOM
2653 (Byte Order Mark) at the start of the file. It must not be preceded
2654 by "utf-8" or another Unicode encoding for this to work properly.
2655 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2656 because Vim cannot detect an error, thus the encoding is always
2657 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002658 The special value "default" can be used for the encoding from the
2659 environment. This is the default value for 'encoding'. It is useful
2660 when 'encoding' is set to "utf-8" and your environment uses a
2661 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002662 When 'encoding' is "utf-8" and a file contains an illegal byte
2663 sequence it won't be recognized as UTF-8. You can use the |8g8|
2664 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 WRONG VALUES: WHAT'S WRONG:
2666 latin1,utf-8 "latin1" will always be used
2667 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2668 file
2669 cp1250,latin1 "cp1250" will always be used
2670 If 'fileencodings' is empty, 'fileencoding' is not modified.
2671 See 'fileencoding' for the possible values.
2672 Setting this option does not have an effect until the next time a file
2673 is read.
2674
2675 *'fileformat'* *'ff'*
2676'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2677 Unix default: "unix",
2678 Macintosh default: "mac")
2679 local to buffer
2680 {not in Vi}
2681 This gives the <EOL> of the current buffer, which is used for
2682 reading/writing the buffer from/to a file:
2683 dos <CR> <NL>
2684 unix <NL>
2685 mac <CR>
2686 When "dos" is used, CTRL-Z at the end of a file is ignored.
2687 See |file-formats| and |file-read|.
2688 For the character encoding of the file see 'fileencoding'.
2689 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2690 works like it was set to "unix'.
2691 This option is set automatically when starting to edit a file and
2692 'fileformats' is not empty and 'binary' is off.
2693 When this option is set, after starting to edit a file, the 'modified'
2694 option is set, because the file would be different when written.
2695 This option can not be changed when 'modifiable' is off.
2696 For backwards compatibility: When this option is set to "dos",
2697 'textmode' is set, otherwise 'textmode' is reset.
2698
2699 *'fileformats'* *'ffs'*
2700'fileformats' 'ffs' string (default:
2701 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2702 Vim Unix: "unix,dos",
2703 Vim Mac: "mac,unix,dos",
2704 Vi Cygwin: "unix,dos",
2705 Vi others: "")
2706 global
2707 {not in Vi}
2708 This gives the end-of-line (<EOL>) formats that will be tried when
2709 starting to edit a new buffer and when reading a file into an existing
2710 buffer:
2711 - When empty, the format defined with 'fileformat' will be used
2712 always. It is not set automatically.
2713 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002714 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 'fileformats' name will be used when a file is read into an existing
2716 buffer, no matter what 'fileformat' for that buffer is set to.
2717 - When more than one name is present, separated by commas, automatic
2718 <EOL> detection will be done when reading a file. When starting to
2719 edit a file, a check is done for the <EOL>:
2720 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2721 'fileformat' is set to "dos".
2722 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002723 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 preceding <CR>, "unix" is preferred over "dos".
2725 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2726 This means that "mac" is only chosen when "unix" is not present,
2727 or when no <NL> is found in the file, and when "dos" is not
2728 present, or no <CR><NL> is present in the file.
2729 Also if "unix" was first chosen, but the first <CR> is before
2730 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2731 the file, then 'fileformat' is set to "mac".
2732 4. If 'fileformat' is still not set, the first name from
2733 'fileformats' is used.
2734 When reading a file into an existing buffer, the same is done, but
2735 this happens like 'fileformat' has been set appropriately for that
2736 file only, the option is not changed.
2737 When 'binary' is set, the value of 'fileformats' is not used.
2738
2739 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2740 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2741 done:
2742 - When 'fileformats' is empty, there is no automatic detection. Dos
2743 format will be used.
2744 - When 'fileformats' is set to one or more names, automatic detection
2745 is done. This is based on the first <NL> in the file: If there is a
2746 <CR> in front of it, Dos format is used, otherwise Unix format is
2747 used.
2748 Also see |file-formats|.
2749 For backwards compatibility: When this option is set to an empty
2750 string or one format (no comma is included), 'textauto' is reset,
2751 otherwise 'textauto' is set.
2752 NOTE: This option is set to the Vi default value when 'compatible' is
2753 set and to the Vim default value when 'compatible' is reset.
2754
2755 *'filetype'* *'ft'*
2756'filetype' 'ft' string (default: "")
2757 local to buffer
2758 {not in Vi}
2759 {not available when compiled without the |+autocmd|
2760 feature}
2761 When this option is set, the FileType autocommand event is triggered.
2762 All autocommands that match with the value of this option will be
2763 executed. Thus the value of 'filetype' is used in place of the file
2764 name.
2765 Otherwise this option does not always reflect the current file type.
2766 This option is normally set when the file type is detected. To enable
2767 this use the ":filetype on" command. |:filetype|
2768 Setting this option to a different value is most useful in a modeline,
2769 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002770 Example, for in an IDL file:
2771 /* vim: set filetype=idl : */ ~
2772 |FileType| |filetypes|
2773 When a dot appears in the value then this separates two filetype
2774 names. Example:
2775 /* vim: set filetype=c.doxygen : */ ~
2776 This will use the "c" filetype first, then the "doxygen" filetype.
2777 This works both for filetype plugins and for syntax files. More than
2778 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779 Do not confuse this option with 'osfiletype', which is for the file
2780 type that is actually stored with the file.
2781 This option is not copied to another buffer, independent of the 's' or
2782 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002783 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784
2785 *'fillchars'* *'fcs'*
2786'fillchars' 'fcs' string (default "vert:|,fold:-")
2787 global
2788 {not in Vi}
2789 {not available when compiled without the |+windows|
2790 and |+folding| features}
2791 Characters to fill the statuslines and vertical separators.
2792 It is a comma separated list of items:
2793
2794 item default Used for ~
2795 stl:c ' ' or '^' statusline of the current window
2796 stlnc:c ' ' or '-' statusline of the non-current windows
2797 vert:c '|' vertical separators |:vsplit|
2798 fold:c '-' filling 'foldtext'
2799 diff:c '-' deleted lines of the 'diff' option
2800
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002801 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 "stlnc" the space will be used when there is highlighting, '^' or '-'
2803 otherwise.
2804
2805 Example: >
2806 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2807< This is similar to the default, except that these characters will also
2808 be used when there is highlighting.
2809
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002810 for "stl" and "stlnc" only single-byte values are supported.
2811
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 The highlighting used for these items:
2813 item highlight group ~
2814 stl:c StatusLine |hl-StatusLine|
2815 stlnc:c StatusLineNC |hl-StatusLineNC|
2816 vert:c VertSplit |hl-VertSplit|
2817 fold:c Folded |hl-Folded|
2818 diff:c DiffDelete |hl-DiffDelete|
2819
2820 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2821'fkmap' 'fk' boolean (default off) *E198*
2822 global
2823 {not in Vi}
2824 {only available when compiled with the |+rightleft|
2825 feature}
2826 When on, the keyboard is mapped for the Farsi character set.
2827 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002828 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829
2830 *'foldclose'* *'fcl'*
2831'foldclose' 'fcl' string (default "")
2832 global
2833 {not in Vi}
2834 {not available when compiled without the |+folding|
2835 feature}
2836 When set to "all", a fold is closed when the cursor isn't in it and
2837 its level is higher than 'foldlevel'. Useful if you want folds to
2838 automatically close when moving out of them.
2839
2840 *'foldcolumn'* *'fdc'*
2841'foldcolumn' 'fdc' number (default 0)
2842 local to window
2843 {not in Vi}
2844 {not available when compiled without the |+folding|
2845 feature}
2846 When non-zero, a column with the specified width is shown at the side
2847 of the window which indicates open and closed folds. The maximum
2848 value is 12.
2849 See |folding|.
2850
2851 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2852'foldenable' 'fen' boolean (default on)
2853 local to window
2854 {not in Vi}
2855 {not available when compiled without the |+folding|
2856 feature}
2857 When off, all folds are open. This option can be used to quickly
2858 switch between showing all text unfolded and viewing the text with
2859 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002860 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861 'foldenable' is off.
2862 This option is set by commands that create a new fold or close a fold.
2863 See |folding|.
2864
2865 *'foldexpr'* *'fde'*
2866'foldexpr' 'fde' string (default: "0")
2867 local to window
2868 {not in Vi}
2869 {not available when compiled without the |+folding|
2870 or |+eval| feature}
2871 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002872 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002873
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002874 The expression may be evaluated in the |sandbox|, see
2875 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002876 This option can't be set from a |modeline| when the 'diff' option is
2877 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002878
2879 It is not allowed to change text or jump to another window while
2880 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881
2882 *'foldignore'* *'fdi'*
2883'foldignore' 'fdi' string (default: "#")
2884 local to window
2885 {not in Vi}
2886 {not available when compiled without the |+folding|
2887 feature}
2888 Used only when 'foldmethod' is "indent". Lines starting with
2889 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002890 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 The default "#" works well for C programs. See |fold-indent|.
2892
2893 *'foldlevel'* *'fdl'*
2894'foldlevel' 'fdl' number (default: 0)
2895 local to window
2896 {not in Vi}
2897 {not available when compiled without the |+folding|
2898 feature}
2899 Sets the fold level: Folds with a higher level will be closed.
2900 Setting this option to zero will close all folds. Higher numbers will
2901 close fewer folds.
2902 This option is set by commands like |zm|, |zM| and |zR|.
2903 See |fold-foldlevel|.
2904
2905 *'foldlevelstart'* *'fdls'*
2906'foldlevelstart' 'fdls' number (default: -1)
2907 global
2908 {not in Vi}
2909 {not available when compiled without the |+folding|
2910 feature}
2911 Sets 'foldlevel' when starting to edit another buffer in a window.
2912 Useful to always start editing with all folds closed (value zero),
2913 some folds closed (one) or no folds closed (99).
2914 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002915 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 ignores this option and closes all folds.
2917 It is also done before BufReadPre autocommands, to allow an autocmd to
2918 overrule the 'foldlevel' value for specific files.
2919 When the value is negative, it is not used.
2920
2921 *'foldmarker'* *'fmr'* *E536*
2922'foldmarker' 'fmr' string (default: "{{{,}}}")
2923 local to window
2924 {not in Vi}
2925 {not available when compiled without the |+folding|
2926 feature}
2927 The start and end marker used when 'foldmethod' is "marker". There
2928 must be one comma, which separates the start and end marker. The
2929 marker is a literal string (a regular expression would be too slow).
2930 See |fold-marker|.
2931
2932 *'foldmethod'* *'fdm'*
2933'foldmethod' 'fdm' string (default: "manual")
2934 local to window
2935 {not in Vi}
2936 {not available when compiled without the |+folding|
2937 feature}
2938 The kind of folding used for the current window. Possible values:
2939 |fold-manual| manual Folds are created manually.
2940 |fold-indent| indent Lines with equal indent form a fold.
2941 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2942 |fold-marker| marker Markers are used to specify folds.
2943 |fold-syntax| syntax Syntax highlighting items specify folds.
2944 |fold-diff| diff Fold text that is not changed.
2945
2946 *'foldminlines'* *'fml'*
2947'foldminlines' 'fml' number (default: 1)
2948 local to window
2949 {not in Vi}
2950 {not available when compiled without the |+folding|
2951 feature}
2952 Sets the minimum number of screen lines for a fold to be displayed
2953 closed. Also for manually closed folds.
2954 Note that this only has an effect of what is displayed. After using
2955 "zc" to close a fold, which is displayed open because it's smaller
2956 than 'foldminlines', a following "zc" may close a containing fold.
2957
2958 *'foldnestmax'* *'fdn'*
2959'foldnestmax' 'fdn' number (default: 20)
2960 local to window
2961 {not in Vi}
2962 {not available when compiled without the |+folding|
2963 feature}
2964 Sets the maximum nesting of folds for the "indent" and "syntax"
2965 methods. This avoids that too many folds will be created. Using more
2966 than 20 doesn't work, because the internal limit is 20.
2967
2968 *'foldopen'* *'fdo'*
2969'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2970 search,tag,undo")
2971 global
2972 {not in Vi}
2973 {not available when compiled without the |+folding|
2974 feature}
2975 Specifies for which type of commands folds will be opened, if the
2976 command moves the cursor into a closed fold. It is a comma separated
2977 list of items.
2978 item commands ~
2979 all any
2980 block "(", "{", "[[", "[{", etc.
2981 hor horizontal movements: "l", "w", "fx", etc.
2982 insert any command in Insert mode
2983 jump far jumps: "G", "gg", etc.
2984 mark jumping to a mark: "'m", CTRL-O, etc.
2985 percent "%"
2986 quickfix ":cn", ":crew", ":make", etc.
2987 search search for a pattern: "/", "n", "*", "gd", etc.
2988 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002989 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 tag jumping to a tag: ":ta", CTRL-T, etc.
2991 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002992 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 the |zv| command to the mapping to get the same effect.
2994 When a movement command is used for an operator (e.g., "dl" or "y%")
2995 this option is not used. This means the operator will include the
2996 whole closed fold.
2997 Note that vertical movements are not here, because it would make it
2998 very difficult to move onto a closed fold.
2999 In insert mode the folds containing the cursor will always be open
3000 when text is inserted.
3001 To close folds you can re-apply 'foldlevel' with the |zx| command or
3002 set the 'foldclose' option to "all".
3003
3004 *'foldtext'* *'fdt'*
3005'foldtext' 'fdt' string (default: "foldtext()")
3006 local to window
3007 {not in Vi}
3008 {not available when compiled without the |+folding|
3009 feature}
3010 An expression which is used to specify the text displayed for a closed
3011 fold. See |fold-foldtext|.
3012
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003013 The expression may be evaluated in the |sandbox|, see
3014 |sandbox-option|.
3015
3016 It is not allowed to change text or jump to another window while
3017 evaluating 'foldtext' |textlock|.
3018
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 *'formatoptions'* *'fo'*
3020'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3021 local to buffer
3022 {not in Vi}
3023 This is a sequence of letters which describes how automatic
3024 formatting is to be done. See |fo-table|. When the 'paste' option is
3025 on, no formatting is done (like 'formatoptions' is empty). Commas can
3026 be inserted for readability.
3027 To avoid problems with flags that are added in the future, use the
3028 "+=" and "-=" feature of ":set" |add-option-flags|.
3029 NOTE: This option is set to the Vi default value when 'compatible' is
3030 set and to the Vim default value when 'compatible' is reset.
3031
Bram Moolenaar86b68352004-12-27 21:59:20 +00003032 *'formatlistpat'* *'flp'*
3033'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3034 local to buffer
3035 {not in Vi}
3036 A pattern that is used to recognize a list header. This is used for
3037 the "n" flag in 'formatoptions'.
3038 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003039 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003040 while still checking more characters. There must be a character
3041 following the pattern, when it matches the whole line it is handled
3042 like there is no match.
3043 The default recognizes a number, followed by an optional punctuation
3044 character and white space.
3045
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 *'formatprg'* *'fp'*
3047'formatprg' 'fp' string (default "")
3048 global
3049 {not in Vi}
3050 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003051 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003053 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003054 If the 'formatexpr' option is not empty it will be used instead.
3055 Otherwise, if 'formatprg' option is an empty string, the internal
3056 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003057 Environment variables are expanded |:set_env|. See |option-backslash|
3058 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003059 The expression may be evaluated in the |sandbox|, see
3060 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003062 *'formatexpr'* *'fex'*
3063'formatexpr' 'fex' string (default "")
3064 local to buffer
3065 {not in Vi}
3066 {not available when compiled without the |+eval|
3067 feature}
3068 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003069 operator. When this option is empty 'formatprg' is used.
3070
3071 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003072 The |v:count| variable holds the number of lines to be formatted.
3073 The |v:char| variable holds the character that is going to be
3074 inserted. This can be empty. Don't insert it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003075
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003076 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003077 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003078< This will invoke the mylang#Format() function in the
3079 autoload/mylang.vim file in 'runtimepath'. |autoload|
3080
3081 The expression is also evaluated when 'textwidth' is set and adding
3082 text beyond that limit. This happens under the same conditions as
3083 when internal formatting is used. Make sure the cursor is kept in the
3084 same spot relative to the text then! The |mode()| function will
3085 return "i" or "R" in this situation. When the function returns
3086 non-zero Vim will fall back to using the internal format mechanism.
3087
3088 The expression may be evaluated in the |sandbox|, see
3089 |sandbox-option|.
3090
3091 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003092'fsync' 'fs' boolean (default on)
3093 global
3094 {not in Vi}
3095 When on, the library function fsync() will be called after writing a
3096 file. This will flush a file to disk, ensuring that it is safely
3097 written even on filesystems which do metadata-only journaling. This
3098 will force the harddrive to spin up on Linux systems running in laptop
3099 mode, so it may be undesirable in some situations. Be warned that
3100 turning this off increases the chances of data loss after a crash. On
3101 systems without an fsync() implementation, this variable is always
3102 off.
3103 Also see 'swapsync' for controlling fsync() on swap files.
3104
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3106'gdefault' 'gd' boolean (default off)
3107 global
3108 {not in Vi}
3109 When on, the ":substitute" flag 'g' is default on. This means that
3110 all matches in a line are substituted instead of one. When a 'g' flag
3111 is given to a ":substitute" command, this will toggle the substitution
3112 of all or one match. See |complex-change|.
3113
3114 command 'gdefault' on 'gdefault' off ~
3115 :s/// subst. all subst. one
3116 :s///g subst. one subst. all
3117 :s///gg subst. all subst. one
3118
3119 NOTE: This option is reset when 'compatible' is set.
3120
3121 *'grepformat'* *'gfm'*
3122'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3123 global
3124 {not in Vi}
3125 Format to recognize for the ":grep" command output.
3126 This is a scanf-like string that uses the same format as the
3127 'errorformat' option: see |errorformat|.
3128
3129 *'grepprg'* *'gp'*
3130'grepprg' 'gp' string (default "grep -n ",
3131 Unix: "grep -n $* /dev/null",
3132 Win32: "findstr /n" or "grep -n",
3133 VMS: "SEARCH/NUMBERS ")
3134 global or local to buffer |global-local|
3135 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003136 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 and '#' characters, which are expanded like when used in a command-
3138 line. The placeholder "$*" is allowed to specify where the arguments
3139 will be included. Environment variables are expanded |:set_env|. See
3140 |option-backslash| about including spaces and backslashes.
3141 When your "grep" accepts the "-H" argument, use this to make ":grep"
3142 also work well with a single file: >
3143 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003144< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003145 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3146 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003147 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 apply equally to 'grepprg'.
3149 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3150 otherwise it's "grep -n".
3151 This option cannot be set from a |modeline| or in the |sandbox|, for
3152 security reasons.
3153
3154 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3155'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3156 ve:ver35-Cursor,
3157 o:hor50-Cursor,
3158 i-ci:ver25-Cursor/lCursor,
3159 r-cr:hor20-Cursor/lCursor,
3160 sm:block-Cursor
3161 -blinkwait175-blinkoff150-blinkon175",
3162 for MS-DOS and Win32 console:
3163 "n-v-c:block,o:hor50,i-ci:hor15,
3164 r-cr:hor30,sm:block")
3165 global
3166 {not in Vi}
3167 {only available when compiled with GUI enabled, and
3168 for MS-DOS and Win32 console}
3169 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003170 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171 the height of the cursor can be changed. This can be done by
3172 specifying a block cursor, or a percentage for a vertical or
3173 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003174 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003176 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 mode-list and an argument-list:
3178 mode-list:argument-list,mode-list:argument-list,..
3179 The mode-list is a dash separated list of these modes:
3180 n Normal mode
3181 v Visual mode
3182 ve Visual mode with 'selection' "exclusive" (same as 'v',
3183 if not specified)
3184 o Operator-pending mode
3185 i Insert mode
3186 r Replace mode
3187 c Command-line Normal (append) mode
3188 ci Command-line Insert mode
3189 cr Command-line Replace mode
3190 sm showmatch in Insert mode
3191 a all modes
3192 The argument-list is a dash separated list of these arguments:
3193 hor{N} horizontal bar, {N} percent of the character height
3194 ver{N} vertical bar, {N} percent of the character width
3195 block block cursor, fills the whole character
3196 [only one of the above three should be present]
3197 blinkwait{N} *cursor-blinking*
3198 blinkon{N}
3199 blinkoff{N}
3200 blink times for cursor: blinkwait is the delay before
3201 the cursor starts blinking, blinkon is the time that
3202 the cursor is shown and blinkoff is the time that the
3203 cursor is not shown. The times are in msec. When one
3204 of the numbers is zero, there is no blinking. The
3205 default is: "blinkwait700-blinkon400-blinkoff250".
3206 These numbers are used for a missing entry. This
3207 means that blinking is enabled by default. To switch
3208 blinking off you can use "blinkon0". The cursor only
3209 blinks when Vim is waiting for input, not while
3210 executing a command.
3211 To make the cursor blink in an xterm, see
3212 |xterm-blink|.
3213 {group-name}
3214 a highlight group name, that sets the color and font
3215 for the cursor
3216 {group-name}/{group-name}
3217 Two highlight group names, the first is used when
3218 no language mappings are used, the other when they
3219 are. |language-mapping|
3220
3221 Examples of parts:
3222 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3223 block cursor with colors from the "nCursor"
3224 highlight group
3225 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3226 In Insert and Command-line Insert mode, use a
3227 30% vertical bar cursor with colors from the
3228 "iCursor" highlight group. Blink a bit
3229 faster.
3230
3231 The 'a' mode is different. It will set the given argument-list for
3232 all modes. It does not reset anything to defaults. This can be used
3233 to do a common setting for all modes. For example, to switch off
3234 blinking: "a:blinkon0"
3235
3236 Examples of cursor highlighting: >
3237 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3238 :highlight Cursor gui=NONE guifg=bg guibg=fg
3239<
3240 *'guifont'* *'gfn'*
3241 *E235* *E596* *E610* *E611*
3242'guifont' 'gfn' string (default "")
3243 global
3244 {not in Vi}
3245 {only available when compiled with GUI enabled}
3246 This is a list of fonts which will be used for the GUI version of Vim.
3247 In its simplest form the value is just one font name. When
3248 the font cannot be found you will get an error message. To try other
3249 font names a list can be specified, font names separated with commas.
3250 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003251
Bram Moolenaar05159a02005-02-26 23:04:13 +00003252 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3253 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003254
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 Spaces after a comma are ignored. To include a comma in a font name
3256 precede it with a backslash. Setting an option requires an extra
3257 backslash before a space and a backslash. See also
3258 |option-backslash|. For example: >
3259 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003260< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003262
3263 If none of the fonts can be loaded, Vim will keep the current setting.
3264 If an empty font list is given, Vim will try using other resource
3265 settings (for X, it will use the Vim.font resource), and finally it
3266 will try some builtin default which should always be there ("7x13" in
3267 the case of X). The font names given should be "normal" fonts. Vim
3268 will try to find the related bold and italic fonts.
3269
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003270 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003271 :set guifont=*
3272< will bring up a font requester, where you can pick the font you want.
3273
3274 The font name depends on the GUI used. See |setting-guifont| for a
3275 way to set 'guifont' for various systems.
3276
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277 For the GTK+ 2 GUI the font name looks like this: >
3278 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003279< That's all. XLFDs are not used. For Chinese this is reported to work
3280 well: >
3281 if has("gui_gtk2")
3282 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3283 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3284 endif
3285<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003286 For Mac OSX you can use something like this: >
3287 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003288< Also see 'macatsui', it can help fix display problems.
3289 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003291 width). An exception is GTK 2: all fonts are accepted, but
3292 mono-spaced fonts look best.
3293
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 To preview a font on X11, you might be able to use the "xfontsel"
3295 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003296
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 For the Win32 GUI *E244* *E245*
3298 - takes these options in the font name:
3299 hXX - height is XX (points, can be floating-point)
3300 wXX - width is XX (points, can be floating-point)
3301 b - bold
3302 i - italic
3303 u - underline
3304 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003305 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3307 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3308 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003309 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310
3311 Use a ':' to separate the options.
3312 - A '_' can be used in the place of a space, so you don't need to use
3313 backslashes to escape the spaces.
3314 - Examples: >
3315 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3316 :set guifont=Andale_Mono:h7.5:w4.5
3317< See also |font-sizes|.
3318
3319 *'guifontset'* *'gfs'*
3320 *E250* *E252* *E234* *E597* *E598*
3321'guifontset' 'gfs' string (default "")
3322 global
3323 {not in Vi}
3324 {only available when compiled with GUI enabled and
3325 with the |+xfontset| feature}
3326 {not available in the GTK+ 2 GUI}
3327 When not empty, specifies two (or more) fonts to be used. The first
3328 one for normal English, the second one for your special language. See
3329 |xfontset|.
3330 Setting this option also means that all font names will be handled as
3331 a fontset name. Also the ones used for the "font" argument of the
3332 |:highlight| command.
3333 The fonts must match with the current locale. If fonts for the
3334 character sets that the current locale uses are not included, setting
3335 'guifontset' will fail.
3336 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3337 the comma-separated names are alternative names, one of which will be
3338 used. In 'guifontset' the whole string is one fontset name,
3339 including the commas. It is not possible to specify alternative
3340 fontset names.
3341 This example works on many X11 systems: >
3342 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3343<
3344 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3345'guifontwide' 'gfw' string (default "")
3346 global
3347 {not in Vi}
3348 {only available when compiled with GUI enabled}
3349 When not empty, specifies a comma-separated list of fonts to be used
3350 for double-width characters. The first font that can be loaded is
3351 used.
3352 Note: The size of these fonts must be exactly twice as wide as the one
3353 specified with 'guifont' and the same height.
3354
3355 All GUI versions but GTK+ 2:
3356
3357 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3358 'guifontset' is empty or invalid.
3359 When 'guifont' is set and a valid font is found in it and
3360 'guifontwide' is empty Vim will attempt to find a matching
3361 double-width font and set 'guifontwide' to it.
3362
3363 GTK+ 2 GUI only: *guifontwide_gtk2*
3364
3365 If set and valid, 'guifontwide' is always used for double width
3366 characters, even if 'encoding' is not set to "utf-8".
3367 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003368 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 font for characters not available in 'guifont'. Thus you do not need
3370 to set 'guifontwide' at all unless you want to override the choice
3371 made by Pango/Xft.
3372
3373 *'guiheadroom'* *'ghr'*
3374'guiheadroom' 'ghr' number (default 50)
3375 global
3376 {not in Vi} {only for GTK and X11 GUI}
3377 The number of pixels subtracted from the screen height when fitting
3378 the GUI window on the screen. Set this before the GUI is started,
3379 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003380 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 lines will be left for window decorations and other items on the
3382 screen. Set it to a negative value to allow windows taller than the
3383 screen.
3384
3385 *'guioptions'* *'go'*
3386'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003387 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 global
3389 {not in Vi}
3390 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003391 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392 sequence of letters which describes what components and options of the
3393 GUI should be used.
3394 To avoid problems with flags that are added in the future, use the
3395 "+=" and "-=" feature of ":set" |add-option-flags|.
3396
3397 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003398 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 'a' Autoselect: If present, then whenever VISUAL mode is started,
3400 or the Visual area extended, Vim tries to become the owner of
3401 the windowing system's global selection. This means that the
3402 Visually highlighted text is available for pasting into other
3403 applications as well as into Vim itself. When the Visual mode
3404 ends, possibly due to an operation on the text, or when an
3405 application wants to paste the selection, the highlighted text
3406 is automatically yanked into the "* selection register.
3407 Thus the selection is still available for pasting into other
3408 applications after the VISUAL mode has ended.
3409 If not present, then Vim won't become the owner of the
3410 windowing system's global selection unless explicitly told to
3411 by a yank or delete operation for the "* register.
3412 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003413 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003414 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415 applies to the modeless selection.
3416
3417 'guioptions' autoselect Visual autoselect modeless ~
3418 "" - -
3419 "a" yes yes
3420 "A" - yes
3421 "aA" yes yes
3422
Bram Moolenaar02467872007-05-06 13:22:01 +00003423 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424 'c' Use console dialogs instead of popup dialogs for simple
3425 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003426 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003427 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003428 'guitablabel' can be used to change the text in the labels.
3429 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003430 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003431 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003432 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 'f' Foreground: Don't use fork() to detach the GUI from the shell
3434 where it was started. Use this for programs that wait for the
3435 editor to finish (e.g., an e-mail program). Alternatively you
3436 can use "gvim -f" or ":gui -f" to start the GUI in the
3437 foreground. |gui-fork|
3438 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003439 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003440 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3442 corner of the window. It's black&white on non-GTK, because of
3443 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar02467872007-05-06 13:22:01 +00003444 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 'm' Menu bar is present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003446 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003447 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003449 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003450 file is sourced the system menu has already been loaded; the
3451 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar02467872007-05-06 13:22:01 +00003452 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 'g' Grey menu items: Make menu items that are not active grey. If
3454 'g' is not included inactive menu items are not shown at all.
3455 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003456 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457 't' Include tearoff menu items. Currently only works for Win32,
3458 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003459 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003460 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003461 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003462 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 'r' Right-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003464 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 'R' Right-hand scrollbar is present when there is a vertically
3466 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003467 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 'l' Left-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003469 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470 'L' Left-hand scrollbar is present when there is a vertically
3471 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003472 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3474 the longest visible line, or on the cursor line if the 'h'
3475 flag is included. |gui-horiz-scroll|
Bram Moolenaar02467872007-05-06 13:22:01 +00003476 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 'h' Limit horizontal scrollbar size to the length of the cursor
3478 line. Reduces computations. |gui-horiz-scroll|
3479
3480 And yes, you may even have scrollbars on the left AND the right if
3481 you really want to :-). See |gui-scrollbars| for more information.
3482
Bram Moolenaar02467872007-05-06 13:22:01 +00003483 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 'v' Use a vertical button layout for dialogs. When not included,
3485 a horizontal layout is preferred, but when it doesn't fit a
3486 vertical layout is used anyway.
Bram Moolenaar02467872007-05-06 13:22:01 +00003487 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 'p' Use Pointer callbacks for X11 GUI. This is required for some
3489 window managers. If the cursor is not blinking or hollow at
3490 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003491 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 removing it after the GUI has started has no effect.
Bram Moolenaar02467872007-05-06 13:22:01 +00003493 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003494 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495
Bram Moolenaar02467872007-05-06 13:22:01 +00003496
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 *'guipty'* *'noguipty'*
3498'guipty' boolean (default on)
3499 global
3500 {not in Vi}
3501 {only available when compiled with GUI enabled}
3502 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3503 I/O to/from shell commands. See |gui-pty|.
3504
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003505 *'guitablabel'* *'gtl'*
3506'guitablabel' 'gtl' string (default empty)
3507 global
3508 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003509 {only available when compiled with GUI enabled and
3510 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003511 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003512 pages line. When empty and when the result is empty Vim will use a
3513 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003514
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003515 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003516 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003517
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003518 Only used when the GUI tab pages line is displayed. 'e' must be
3519 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3520 used.
3521
Bram Moolenaar57657d82006-04-21 22:12:41 +00003522 *'guitabtooltip'* *'gtt'*
3523'guitabtooltip' 'gtt' string (default empty)
3524 global
3525 {not in Vi}
3526 {only available when compiled with GUI enabled and
3527 with the +windows feature}
3528 When nonempty describes the text to use in a tooltip for the GUI tab
3529 pages line. When empty Vim will use a default tooltip.
3530 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003531 You can include a line break. Simplest method is to use |:let|: >
3532 :let &guitabtooltip = "line one\nline two"
3533<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003534
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 *'helpfile'* *'hf'*
3536'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3537 (others) "$VIMRUNTIME/doc/help.txt")
3538 global
3539 {not in Vi}
3540 Name of the main help file. All distributed help files should be
3541 placed together in one directory. Additionally, all "doc" directories
3542 in 'runtimepath' will be used.
3543 Environment variables are expanded |:set_env|. For example:
3544 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003545 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 spaces and backslashes.
3547 This option cannot be set from a |modeline| or in the |sandbox|, for
3548 security reasons.
3549
3550 *'helpheight'* *'hh'*
3551'helpheight' 'hh' number (default 20)
3552 global
3553 {not in Vi}
3554 {not available when compiled without the +windows
3555 feature}
3556 Minimal initial height of the help window when it is opened with the
3557 ":help" command. The initial height of the help window is half of the
3558 current window, or (when the 'ea' option is on) the same as other
3559 windows. When the height is less than 'helpheight', the height is
3560 set to 'helpheight'. Set to zero to disable.
3561
3562 *'helplang'* *'hlg'*
3563'helplang' 'hlg' string (default: messages language or empty)
3564 global
3565 {only available when compiled with the |+multi_lang|
3566 feature}
3567 {not in Vi}
3568 Comma separated list of languages. Vim will use the first language
3569 for which the desired help can be found. The English help will always
3570 be used as a last resort. You can add "en" to prefer English over
3571 another language, but that will only find tags that exist in that
3572 language and not in the English help.
3573 Example: >
3574 :set helplang=de,it
3575< This will first search German, then Italian and finally English help
3576 files.
3577 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3578 try to find the tag in the current language before using this option.
3579 See |help-translated|.
3580
3581 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3582'hidden' 'hid' boolean (default off)
3583 global
3584 {not in Vi}
3585 When off a buffer is unloaded when it is |abandon|ed. When on a
3586 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3587 displayed in another window, it does not become hidden, of course.
3588 The commands that move through the buffer list sometimes make a buffer
3589 hidden although the 'hidden' option is off: When the buffer is
3590 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003591 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003592 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593 This option is set for one command with ":hide {command}" |:hide|.
3594 WARNING: It's easy to forget that you have changes in hidden buffers.
3595 Think twice when using ":q!" or ":qa!".
3596
3597 *'highlight'* *'hl'*
3598'highlight' 'hl' string (default (as a single string):
3599 "8:SpecialKey,@:NonText,d:Directory,
3600 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3601 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003602 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3604 f:Folded,F:FoldColumn,A:DiffAdd,
3605 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003606 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003607 R:SpellRare,L:SpellLocal,
3608 +:Pmenu,=:PmenuSel,
3609 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 global
3611 {not in Vi}
3612 This option can be used to set highlighting mode for various
3613 occasions. It is a comma separated list of character pairs. The
3614 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003615 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3617 |hl-NonText| @ '~' and '@' at the end of the window and
3618 characters from 'showbreak'
3619 |hl-Directory| d directories in CTRL-D listing and other special
3620 things in listings
3621 |hl-ErrorMsg| e error messages
3622 h (obsolete, ignored)
3623 |hl-IncSearch| i 'incsearch' highlighting
3624 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3625 |hl-MoreMsg| m |more-prompt|
3626 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003627 |hl-LineNr| n line number for ":number" and ":#" commands, and
3628 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629 |hl-Question| r |hit-enter| prompt and yes/no questions
3630 |hl-StatusLine| s status line of current window |status-line|
3631 |hl-StatusLineNC| S status lines of not-current windows
3632 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3633 |hl-VertSplit| c column used to separate vertically split windows
3634 |hl-Visual| v Visual mode
3635 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3636 Selection" Only X11 Gui's |gui-x11| and
3637 |xterm-clipboard|.
3638 |hl-WarningMsg| w warning messages
3639 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3640 |hl-Folded| f line used for closed folds
3641 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003642 |hl-DiffAdd| A added line in diff mode
3643 |hl-DiffChange| C changed line in diff mode
3644 |hl-DiffDelete| D deleted line in diff mode
3645 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003647 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003648 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003649 |hl-SpellRare| R rare word |spell|
3650 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003651 |hl-Pmenu| + popup menu normal line
3652 |hl-PmenuSel| = popup menu normal line
3653 |hl-PmenuSbar| x popup menu scrollbar
3654 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003655
3656 The display modes are:
3657 r reverse (termcap entry "mr" and "me")
3658 i italic (termcap entry "ZH" and "ZR")
3659 b bold (termcap entry "md" and "me")
3660 s standout (termcap entry "so" and "se")
3661 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003662 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 n no highlighting
3664 - no highlighting
3665 : use a highlight group
3666 The default is used for occasions that are not included.
3667 If you want to change what the display modes do, see |dos-colors|
3668 for an example.
3669 When using the ':' display mode, this must be followed by the name of
3670 a highlight group. A highlight group can be used to define any type
3671 of highlighting, including using color. See |:highlight| on how to
3672 define one. The default uses a different group for each occasion.
3673 See |highlight-default| for the default highlight groups.
3674
3675 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3676'hlsearch' 'hls' boolean (default off)
3677 global
3678 {not in Vi}
3679 {not available when compiled without the
3680 |+extra_search| feature}
3681 When there is a previous search pattern, highlight all its matches.
3682 The type of highlighting used can be set with the 'l' occasion in the
3683 'highlight' option. This uses the "Search" highlight group by
3684 default. Note that only the matching text is highlighted, any offsets
3685 are not applied.
3686 See also: 'incsearch' and |:match|.
3687 When you get bored looking at the highlighted matches, you can turn it
3688 off with |:nohlsearch|. As soon as you use a search command, the
3689 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003690 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 When the search pattern can match an end-of-line, Vim will try to
3692 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003693 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003695 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 NOTE: This option is reset when 'compatible' is set.
3697
3698 *'history'* *'hi'*
3699'history' 'hi' number (Vim default: 20, Vi default: 0)
3700 global
3701 {not in Vi}
3702 A history of ":" commands, and a history of previous search patterns
3703 are remembered. This option decides how many entries may be stored in
3704 each of these histories (see |cmdline-editing|).
3705 NOTE: This option is set to the Vi default value when 'compatible' is
3706 set and to the Vim default value when 'compatible' is reset.
3707
3708 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3709'hkmap' 'hk' boolean (default off)
3710 global
3711 {not in Vi}
3712 {only available when compiled with the |+rightleft|
3713 feature}
3714 When on, the keyboard is mapped for the Hebrew character set.
3715 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3716 toggle this option. See |rileft.txt|.
3717 NOTE: This option is reset when 'compatible' is set.
3718
3719 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3720'hkmapp' 'hkp' boolean (default off)
3721 global
3722 {not in Vi}
3723 {only available when compiled with the |+rightleft|
3724 feature}
3725 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3726 This is useful if you have a non-Hebrew keyboard.
3727 See |rileft.txt|.
3728 NOTE: This option is reset when 'compatible' is set.
3729
3730 *'icon'* *'noicon'*
3731'icon' boolean (default off, on when title can be restored)
3732 global
3733 {not in Vi}
3734 {not available when compiled without the |+title|
3735 feature}
3736 When on, the icon text of the window will be set to the value of
3737 'iconstring' (if it is not empty), or to the name of the file
3738 currently being edited. Only the last part of the name is used.
3739 Overridden by the 'iconstring' option.
3740 Only works if the terminal supports setting window icons (currently
3741 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3742 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3743 builtin termcap).
3744 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003745 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 X11.
3747
3748 *'iconstring'*
3749'iconstring' string (default "")
3750 global
3751 {not in Vi}
3752 {not available when compiled without the |+title|
3753 feature}
3754 When this option is not empty, it will be used for the icon text of
3755 the window. This happens only when the 'icon' option is on.
3756 Only works if the terminal supports setting window icon text
3757 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3758 Does not work for MS Windows.
3759 When Vim was compiled with HAVE_X11 defined, the original icon will be
3760 restored if possible |X11|.
3761 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003762 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 'titlestring' for example settings.
3764 {not available when compiled without the |+statusline| feature}
3765
3766 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3767'ignorecase' 'ic' boolean (default off)
3768 global
3769 Ignore case in search patterns. Also used when searching in the tags
3770 file.
3771 Also see 'smartcase'.
3772 Can be overruled by using "\c" or "\C" in the pattern, see
3773 |/ignorecase|.
3774
3775 *'imactivatekey'* *'imak'*
3776'imactivatekey' 'imak' string (default "")
3777 global
3778 {not in Vi}
3779 {only available when compiled with |+xim| and
3780 |+GUI_GTK|}
3781 Specifies the key that your Input Method in X-Windows uses for
3782 activation. When this is specified correctly, vim can fully control
3783 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3784 You can't use this option to change the activation key, the option
3785 tells Vim what the key is.
3786 Format:
3787 [MODIFIER_FLAG-]KEY_STRING
3788
3789 These characters can be used for MODIFIER_FLAG (case is ignored):
3790 S Shift key
3791 L Lock key
3792 C Control key
3793 1 Mod1 key
3794 2 Mod2 key
3795 3 Mod3 key
3796 4 Mod4 key
3797 5 Mod5 key
3798 Combinations are allowed, for example "S-C-space" or "SC-space" are
3799 both shift+ctrl+space.
3800 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3801
3802 Example: >
3803 :set imactivatekey=S-space
3804< "S-space" means shift+space. This is the activation key for kinput2 +
3805 canna (Japanese), and ami (Korean).
3806
3807 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3808'imcmdline' 'imc' boolean (default off)
3809 global
3810 {not in Vi}
3811 {only available when compiled with the |+xim|
3812 |+multi_byte_ime| or |global-ime| feature}
3813 When set the Input Method is always on when starting to edit a command
3814 line, unless entering a search pattern (see 'imsearch' for that).
3815 Setting this option is useful when your input method allows entering
3816 English characters directly, e.g., when it's used to type accented
3817 characters with dead keys.
3818
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003819 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3821 global
3822 {not in Vi}
3823 {only available when compiled with the |+xim|
3824 |+multi_byte_ime| or |global-ime| feature}
3825 When set the Input Method is never used. This is useful to disable
3826 the IM when it doesn't work properly.
3827 Currently this option is on by default for SGI/IRIX machines. This
3828 may change in later releases.
3829
3830 *'iminsert'* *'imi'*
3831'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3832 local to buffer
3833 {not in Vi}
3834 Specifies whether :lmap or an Input Method (IM) is to be used in
3835 Insert mode. Valid values:
3836 0 :lmap is off and IM is off
3837 1 :lmap is ON and IM is off
3838 2 :lmap is off and IM is ON
3839 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3840 or |global-ime|.
3841 To always reset the option to zero when leaving Insert mode with <Esc>
3842 this can be used: >
3843 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3844< This makes :lmap and IM turn off automatically when leaving Insert
3845 mode.
3846 Note that this option changes when using CTRL-^ in Insert mode
3847 |i_CTRL-^|.
3848 The value is set to 1 when setting 'keymap' to a valid keymap name.
3849 It is also used for the argument of commands like "r" and "f".
3850 The value 0 may not work correctly with Athena and Motif with some XIM
3851 methods. Use 'imdisable' to disable XIM then.
3852
3853 *'imsearch'* *'ims'*
3854'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3855 local to buffer
3856 {not in Vi}
3857 Specifies whether :lmap or an Input Method (IM) is to be used when
3858 entering a search pattern. Valid values:
3859 -1 the value of 'iminsert' is used, makes it look like
3860 'iminsert' is also used when typing a search pattern
3861 0 :lmap is off and IM is off
3862 1 :lmap is ON and IM is off
3863 2 :lmap is off and IM is ON
3864 Note that this option changes when using CTRL-^ in Command-line mode
3865 |c_CTRL-^|.
3866 The value is set to 1 when it is not -1 and setting the 'keymap'
3867 option to a valid keymap name.
3868 The value 0 may not work correctly with Athena and Motif with some XIM
3869 methods. Use 'imdisable' to disable XIM then.
3870
3871 *'include'* *'inc'*
3872'include' 'inc' string (default "^\s*#\s*include")
3873 global or local to buffer |global-local|
3874 {not in Vi}
3875 {not available when compiled without the
3876 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003877 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 pattern, just like for the "/" command (See |pattern|). The default
3879 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003880 "]I", "[d", etc.
3881 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003882 comes after the matched pattern. But if "\zs" appears in the pattern
3883 then the text matched from "\zs" to the end, or until "\ze" if it
3884 appears, is used as the file name. Use this to include characters
3885 that are not in 'isfname', such as a space. You can then use
3886 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003887 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888
3889 *'includeexpr'* *'inex'*
3890'includeexpr' 'inex' string (default "")
3891 local to buffer
3892 {not in Vi}
3893 {not available when compiled without the
3894 |+find_in_path| or |+eval| feature}
3895 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003896 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 :set includeexpr=substitute(v:fname,'\\.','/','g')
3898< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003899
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003901 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 Also used for |<cfile>|.
3903
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003904 The expression may be evaluated in the |sandbox|, see
3905 |sandbox-option|.
3906
3907 It is not allowed to change text or jump to another window while
3908 evaluating 'includeexpr' |textlock|.
3909
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3911'incsearch' 'is' boolean (default off)
3912 global
3913 {not in Vi}
3914 {not available when compiled without the
3915 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003916 While typing a search command, show where the pattern, as it was typed
3917 so far, matches. The matched string is highlighted. If the pattern
3918 is invalid or not found, nothing is shown. The screen will be updated
3919 often, this is only useful on fast terminals.
3920 Note that the match will be shown, but the cursor will return to its
3921 original position when no match is found and when pressing <Esc>. You
3922 still need to finish the search command with <Enter> to move the
3923 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003924 When compiled with the |+reltime| feature Vim only searches for about
3925 half a second. With a complicated pattern and/or a lot of text the
3926 match may not be found. This is to avoid that Vim hangs while you
3927 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003928 The highlighting can be set with the 'i' flag in 'highlight'.
3929 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003930 CTRL-L can be used to add one character from after the current match
3931 to the command line.
3932 CTRL-R CTRL-W can be used to add the word at the end of the current
3933 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 NOTE: This option is reset when 'compatible' is set.
3935
3936 *'indentexpr'* *'inde'*
3937'indentexpr' 'inde' string (default "")
3938 local to buffer
3939 {not in Vi}
3940 {not available when compiled without the |+cindent|
3941 or |+eval| features}
3942 Expression which is evaluated to obtain the proper indent for a line.
3943 It is used when a new line is created, for the |=| operator and
3944 in Insert mode as specified with the 'indentkeys' option.
3945 When this option is not empty, it overrules the 'cindent' and
3946 'smartindent' indenting.
3947 When 'paste' is set this option is not used for indenting.
3948 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003949 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 when the expression is evaluated (but it may be moved around).
3951 The expression must return the number of spaces worth of indent. It
3952 can return "-1" to keep the current indent (this means 'autoindent' is
3953 used for the indent).
3954 Functions useful for computing the indent are |indent()|, |cindent()|
3955 and |lispindent()|.
3956 The evaluation of the expression must not have side effects! It must
3957 not change the text, jump to another window, etc. Afterwards the
3958 cursor position is always restored, thus the cursor may be moved.
3959 Normally this option would be set to call a function: >
3960 :set indentexpr=GetMyIndent()
3961< Error messages will be suppressed, unless the 'debug' option contains
3962 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003963 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 NOTE: This option is made empty when 'compatible' is set.
3965
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003966 The expression may be evaluated in the |sandbox|, see
3967 |sandbox-option|.
3968
3969 It is not allowed to change text or jump to another window while
3970 evaluating 'indentexpr' |textlock|.
3971
3972
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 *'indentkeys'* *'indk'*
3974'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3975 local to buffer
3976 {not in Vi}
3977 {not available when compiled without the |+cindent|
3978 feature}
3979 A list of keys that, when typed in Insert mode, cause reindenting of
3980 the current line. Only happens if 'indentexpr' isn't empty.
3981 The format is identical to 'cinkeys', see |indentkeys-format|.
3982 See |C-indenting| and |indent-expression|.
3983
3984 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3985'infercase' 'inf' boolean (default off)
3986 local to buffer
3987 {not in Vi}
3988 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00003989 'ignorecase' is also on, the case of the match is adjusted depending
3990 on the typed text. If the typed text contains a lowercase letter
3991 where the match has an upper case letter, the completed part is made
3992 lowercase. If the typed text has no lowercase letters and the match
3993 has a lowercase letter where the typed text has an uppercase letter,
3994 and there is a letter before it, the completed part is made uppercase.
3995 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996
3997 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3998'insertmode' 'im' boolean (default off)
3999 global
4000 {not in Vi}
4001 Makes Vim work in a way that Insert mode is the default mode. Useful
4002 if you want to use Vim as a modeless editor. Used for |evim|.
4003 These Insert mode commands will be useful:
4004 - Use the cursor keys to move around.
4005 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4006 this is a mapping, it is executed as if 'insertmode' was off.
4007 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004009 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4010 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011
4012 These items change when 'insertmode' is set:
4013 - when starting to edit of a file, Vim goes to Insert mode.
4014 - <Esc> in Insert mode is a no-op and beeps.
4015 - <Esc> in Normal mode makes Vim go to Insert mode.
4016 - CTRL-L in Insert mode is a command, it is not inserted.
4017 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4018 However, when <Esc> is used inside a mapping, it behaves like
4019 'insertmode' was not set. This was done to be able to use the same
4020 mappings with 'insertmode' set or not set.
4021 When executing commands with |:normal| 'insertmode' is not used.
4022
4023 NOTE: This option is reset when 'compatible' is set.
4024
4025 *'isfname'* *'isf'*
4026'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4027 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4028 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4029 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4030 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4031 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4032 global
4033 {not in Vi}
4034 The characters specified by this option are included in file names and
4035 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004036 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 Multi-byte characters 256 and above are always included, only the
4038 characters up to 255 are specified with this option.
4039 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004040 Think twice before adding white space to this option. Although a
4041 space may appear inside a file name, the effect will be that Vim
4042 doesn't know where a file name starts or ends when doing completion.
4043 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044
4045 Note that on systems using a backslash as path separator, Vim tries to
4046 do its best to make it work as you would expect. That is a bit
4047 tricky, since Vi originally used the backslash to escape special
4048 characters. Vim will not remove a backslash in front of a normal file
4049 name character on these systems, but it will on Unix and alikes. The
4050 '&' and '^' are not included by default, because these are special for
4051 cmd.exe.
4052
4053 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004054 Each part can be a single character number or a range. A range is two
4055 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 decimal number between 0 and 255 or the ASCII character itself (does
4057 not work for digits). Example:
4058 "_,-,128-140,#-43" (include '_' and '-' and the range
4059 128 to 140 and '#' to 43)
4060 If a part starts with '^', the following character number or range
4061 will be excluded from the option. The option is interpreted from left
4062 to right. Put the excluded character after the range where it is
4063 included. To include '^' itself use it as the last character of the
4064 option or the end of a range. Example:
4065 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4066 If the character is '@', all characters where isalpha() returns TRUE
4067 are included. Normally these are the characters a to z and A to Z,
4068 plus accented characters. To include '@' itself use "@-@". Examples:
4069 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004070 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 "a-z,A-Z,@-@" All letters plus the '@' character.
4072 A comma can be included by using it where a character number is
4073 expected. Example:
4074 "48-57,,,_" Digits, comma and underscore.
4075 A comma can be excluded by prepending a '^'. Example:
4076 " -~,^,,9" All characters from space to '~', excluding
4077 comma, plus <Tab>.
4078 See |option-backslash| about including spaces and backslashes.
4079
4080 *'isident'* *'isi'*
4081'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4082 "@,48-57,_,128-167,224-235"
4083 otherwise: "@,48-57,_,192-255")
4084 global
4085 {not in Vi}
4086 The characters given by this option are included in identifiers.
4087 Identifiers are used in recognizing environment variables and after a
4088 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004089 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 option.
4091 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004092 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4094
4095 *'iskeyword'* *'isk'*
4096'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4097 "@,48-57,_,128-167,224-235"
4098 otherwise: "@,48-57,_,192-255"
4099 Vi default: "@,48-57,_")
4100 local to buffer
4101 {not in Vi}
4102 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004103 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 'isfname' for a description of the format of this option. For C
4105 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4106 For a help file it is set to all non-blank printable characters except
4107 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4108 command).
4109 When the 'lisp' option is on the '-' character is always included.
4110 NOTE: This option is set to the Vi default value when 'compatible' is
4111 set and to the Vim default value when 'compatible' is reset.
4112
4113 *'isprint'* *'isp'*
4114'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4115 "@,~-255"; otherwise: "@,161-255")
4116 global
4117 {not in Vi}
4118 The characters given by this option are displayed directly on the
4119 screen. It is also used for "\p" in a |pattern|. The characters from
4120 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4121 even when they are not included in 'isprint' or excluded. See
4122 'isfname' for a description of the format of this option.
4123
4124 Non-printable characters are displayed with two characters:
4125 0 - 31 "^@" - "^_"
4126 32 - 126 always single characters
4127 127 "^?"
4128 128 - 159 "~@" - "~_"
4129 160 - 254 "| " - "|~"
4130 255 "~?"
4131 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4132 displayed as <xx>, with the hexadecimal value of the byte.
4133 When 'display' contains "uhex" all unprintable characters are
4134 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004135 The SpecialKey highlighting will be used for unprintable characters.
4136 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137
4138 Multi-byte characters 256 and above are always included, only the
4139 characters up to 255 are specified with this option. When a character
4140 is printable but it is not available in the current font, a
4141 replacement character will be shown.
4142 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4143 There is no option to specify these characters.
4144
4145 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4146'joinspaces' 'js' boolean (default on)
4147 global
4148 {not in Vi}
4149 Insert two spaces after a '.', '?' and '!' with a join command.
4150 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4151 Otherwise only one space is inserted.
4152 NOTE: This option is set when 'compatible' is set.
4153
4154 *'key'*
4155'key' string (default "")
4156 local to buffer
4157 {not in Vi}
4158 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004159 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 Careful: Do not set the key value by hand, someone might see the typed
4161 key. Use the |:X| command. But you can make 'key' empty: >
4162 :set key=
4163< It is not possible to get the value of this option with ":set key" or
4164 "echo &key". This is to avoid showing it to someone who shouldn't
4165 know. It also means you cannot see it yourself once you have set it,
4166 be careful not to make a typing error!
4167
4168 *'keymap'* *'kmp'* *E544*
4169'keymap' 'kmp' string (default "")
4170 local to buffer
4171 {not in Vi}
4172 {only available when compiled with the |+keymap|
4173 feature}
4174 Name of a keyboard mapping. See |mbyte-keymap|.
4175 Setting this option to a valid keymap name has the side effect of
4176 setting 'iminsert' to one, so that the keymap becomes effective.
4177 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004178 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179
4180 *'keymodel'* *'km'*
4181'keymodel' 'km' string (default "")
4182 global
4183 {not in Vi}
4184 List of comma separated words, which enable special things that keys
4185 can do. These values can be used:
4186 startsel Using a shifted special key starts selection (either
4187 Select mode or Visual mode, depending on "key" being
4188 present in 'selectmode').
4189 stopsel Using a not-shifted special key stops selection.
4190 Special keys in this context are the cursor keys, <End>, <Home>,
4191 <PageUp> and <PageDown>.
4192 The 'keymodel' option is set by the |:behave| command.
4193
4194 *'keywordprg'* *'kp'*
4195'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4196 OS/2: "view /", VMS: "help")
4197 global or local to buffer |global-local|
4198 {not in Vi}
4199 Program to use for the |K| command. Environment variables are
4200 expanded |:set_env|. ":help" may be used to access the Vim internal
4201 help. (Note that previously setting the global option to the empty
4202 value did this, which is now deprecated.)
4203 When "man" is used, Vim will automatically translate a count for the
4204 "K" command to a section number. Also for "man -s", in which case the
4205 "-s" is removed when there is no count.
4206 See |option-backslash| about including spaces and backslashes.
4207 Example: >
4208 :set keywordprg=man\ -s
4209< This option cannot be set from a |modeline| or in the |sandbox|, for
4210 security reasons.
4211
4212 *'langmap'* *'lmap'* *E357* *E358*
4213'langmap' 'lmap' string (default "")
4214 global
4215 {not in Vi}
4216 {only available when compiled with the |+langmap|
4217 feature}
4218 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004219 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 inserted directly. When in command mode the 'langmap' option takes
4221 care of translating these special characters to the original meaning
4222 of the key. This means you don't have to change the keyboard mode to
4223 be able to execute Normal mode commands.
4224 This is the opposite of the 'keymap' option, where characters are
4225 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004227 Example (for Greek, in UTF-8): *greek* >
4228 :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 +00004229< Example (exchanges meaning of z and y for commands): >
4230 :set langmap=zy,yz,ZY,YZ
4231<
4232 The 'langmap' option is a list of parts, separated with commas. Each
4233 part can be in one of two forms:
4234 1. A list of pairs. Each pair is a "from" character immediately
4235 followed by the "to" character. Examples: "aA", "aAbBcC".
4236 2. A list of "from" characters, a semi-colon and a list of "to"
4237 characters. Example: "abc;ABC"
4238 Example: "aA,fgh;FGH,cCdDeE"
4239 Special characters need to be preceded with a backslash. These are
4240 ";", ',' and backslash itself.
4241
4242 This will allow you to activate vim actions without having to switch
4243 back and forth between the languages. Your language characters will
4244 be understood as normal vim English characters (according to the
4245 langmap mappings) in the following cases:
4246 o Normal/Visual mode (commands, buffer/register names, user mappings)
4247 o Insert/Replace Mode: Register names after CTRL-R
4248 o Insert/Replace Mode: Mappings
4249 Characters entered in Command-line mode will NOT be affected by
4250 this option. Note that this option can be changed at any time
4251 allowing to switch between mappings for different languages/encodings.
4252 Use a mapping to avoid having to type it each time!
4253
4254 *'langmenu'* *'lm'*
4255'langmenu' 'lm' string (default "")
4256 global
4257 {not in Vi}
4258 {only available when compiled with the |+menu| and
4259 |+multi_lang| features}
4260 Language to use for menu translation. Tells which file is loaded
4261 from the "lang" directory in 'runtimepath': >
4262 "lang/menu_" . &langmenu . ".vim"
4263< (without the spaces). For example, to always use the Dutch menus, no
4264 matter what $LANG is set to: >
4265 :set langmenu=nl_NL.ISO_8859-1
4266< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004267 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 If your $LANG is set to a non-English language but you do want to use
4269 the English menus: >
4270 :set langmenu=none
4271< This option must be set before loading menus, switching on filetype
4272 detection or syntax highlighting. Once the menus are defined setting
4273 this option has no effect. But you could do this: >
4274 :source $VIMRUNTIME/delmenu.vim
4275 :set langmenu=de_DE.ISO_8859-1
4276 :source $VIMRUNTIME/menu.vim
4277< Warning: This deletes all menus that you defined yourself!
4278
4279 *'laststatus'* *'ls'*
4280'laststatus' 'ls' number (default 1)
4281 global
4282 {not in Vi}
4283 The value of this option influences when the last window will have a
4284 status line:
4285 0: never
4286 1: only if there are at least two windows
4287 2: always
4288 The screen looks nicer with a status line if you have several
4289 windows, but it takes another screen line. |status-line|
4290
4291 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4292'lazyredraw' 'lz' boolean (default off)
4293 global
4294 {not in Vi}
4295 When this option is set, the screen will not be redrawn while
4296 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004297 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 update use |:redraw|.
4299
4300 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4301'linebreak' 'lbr' boolean (default off)
4302 local to window
4303 {not in Vi}
4304 {not available when compiled without the |+linebreak|
4305 feature}
4306 If on Vim will wrap long lines at a character in 'breakat' rather
4307 than at the last character that fits on the screen. Unlike
4308 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4309 it only affects the way the file is displayed, not its contents. The
4310 value of 'showbreak' is used to put in front of wrapped lines.
4311 This option is not used when the 'wrap' option is off or 'list' is on.
4312 Note that <Tab> characters after an <EOL> are mostly not displayed
4313 with the right amount of white space.
4314
4315 *'lines'* *E593*
4316'lines' number (default 24 or terminal height)
4317 global
4318 Number of lines of the Vim window.
4319 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004320 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 When Vim is running in the GUI or in a resizable window, setting this
4322 option will cause the window size to be changed. When you only want
4323 to use the size for the GUI, put the command in your |gvimrc| file.
4324 Vim limits the number of lines to what fits on the screen. You can
4325 use this command to get the tallest window possible: >
4326 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004327< Minimum value is 2, maximum value is 1000.
4328 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 When you set this option and Vim is unable to change the physical
4330 number of lines of the display, the display may be messed up.
4331
4332 *'linespace'* *'lsp'*
4333'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4334 global
4335 {not in Vi}
4336 {only in the GUI}
4337 Number of pixel lines inserted between characters. Useful if the font
4338 uses the full character cell height, making lines touch each other.
4339 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004340 With some fonts there can be too much room between lines (to have
4341 space for ascents and descents). Then it makes sense to set
4342 'linespace' to a negative value. This may cause display problems
4343 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344
4345 *'lisp'* *'nolisp'*
4346'lisp' boolean (default off)
4347 local to buffer
4348 {not available when compiled without the |+lispindent|
4349 feature}
4350 Lisp mode: When <Enter> is typed in insert mode set the indent for
4351 the next line to Lisp standards (well, sort of). Also happens with
4352 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4353 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4354 better. Also see 'lispwords'.
4355 The '-' character is included in keyword characters. Redefines the
4356 "=" operator to use this same indentation algorithm rather than
4357 calling an external program if 'equalprg' is empty.
4358 This option is not used when 'paste' is set.
4359 {Vi: Does it a little bit differently}
4360
4361 *'lispwords'* *'lw'*
4362'lispwords' 'lw' string (default is very long)
4363 global
4364 {not in Vi}
4365 {not available when compiled without the |+lispindent|
4366 feature}
4367 Comma separated list of words that influence the Lisp indenting.
4368 |'lisp'|
4369
4370 *'list'* *'nolist'*
4371'list' boolean (default off)
4372 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004373 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4374 line. Useful to see the difference between tabs and spaces and for
4375 trailing blanks. Further changed by the 'listchars' option.
4376
4377 The cursor is displayed at the start of the space a Tab character
4378 occupies, not at the end as usual in Normal mode. To get this cursor
4379 position while displaying Tabs with spaces, use: >
4380 :set list lcs=tab\ \
4381<
4382 Note that list mode will also affect formatting (set with 'textwidth'
4383 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 changing the way tabs are displayed.
4385
4386 *'listchars'* *'lcs'*
4387'listchars' 'lcs' string (default "eol:$")
4388 global
4389 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004390 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391 settings.
4392 eol:c Character to show at the end of each line. When
4393 omitted, there is no extra character at the end of the
4394 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004395 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004397 fill the space that the tab normally occupies.
4398 "tab:>-" will show a tab that takes four spaces as
4399 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004400 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401 trailing spaces are blank.
4402 extends:c Character to show in the last column, when 'wrap' is
4403 off and the line continues beyond the right of the
4404 screen.
4405 precedes:c Character to show in the first column, when 'wrap'
4406 is off and there is text preceding the character
4407 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004408 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004409 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004411 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004413 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414
4415 Examples: >
4416 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004417 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418 :set lcs=extends:>,precedes:<
4419< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004420 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004421 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422
4423 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4424'loadplugins' 'lpl' boolean (default on)
4425 global
4426 {not in Vi}
4427 When on the plugin scripts are loaded when starting up |load-plugins|.
4428 This option can be reset in your |vimrc| file to disable the loading
4429 of plugins.
4430 Note that using the "-u NONE" and "--noplugin" command line arguments
4431 reset this option. |-u| |--noplugin|
4432
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004433 *'macatsui'* *'nomacatsui'*
4434'macatsui' boolean (default on)
4435 global
4436 {only available in Mac GUI version}
4437 This is a workaround for when drawing doesn't work properly. When set
4438 and compiled with multi-byte support ATSUI text drawing is used. When
4439 not set ATSUI text drawing is not used. Switch this option off when
4440 you experience drawing problems. In a future version the problems may
4441 be solved and this option becomes obsolete. Therefore use this method
4442 to unset it: >
4443 if exists('&macatsui')
4444 set nomacatsui
4445 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004446< Another option to check if you have drawing problems is
4447 'termencoding'.
4448
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449 *'magic'* *'nomagic'*
4450'magic' boolean (default on)
4451 global
4452 Changes the special characters that can be used in search patterns.
4453 See |pattern|.
4454 NOTE: To avoid portability problems with using patterns, always keep
4455 this option at the default "on". Only switch it off when working with
4456 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004457 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458
4459 *'makeef'* *'mef'*
4460'makeef' 'mef' string (default: "")
4461 global
4462 {not in Vi}
4463 {not available when compiled without the |+quickfix|
4464 feature}
4465 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4466 and the |:grep| command.
4467 When it is empty, an internally generated temp file will be used.
4468 When "##" is included, it is replaced by a number to make the name
4469 unique. This makes sure that the ":make" command doesn't overwrite an
4470 existing file.
4471 NOT used for the ":cf" command. See 'errorfile' for that.
4472 Environment variables are expanded |:set_env|.
4473 See |option-backslash| about including spaces and backslashes.
4474 This option cannot be set from a |modeline| or in the |sandbox|, for
4475 security reasons.
4476
4477 *'makeprg'* *'mp'*
4478'makeprg' 'mp' string (default "make", VMS: "MMS")
4479 global or local to buffer |global-local|
4480 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004481 Program to use for the ":make" command. See |:make_makeprg|.
4482 This option may contain '%' and '#' characters, which are expanded to
4483 the current and alternate file name. |:_%| |:_#|
4484 Environment variables are expanded |:set_env|. See |option-backslash|
4485 about including spaces and backslashes.
4486 Note that a '|' must be escaped twice: once for ":set" and once for
4487 the interpretation of a command. When you use a filter called
4488 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 :set makeprg=gmake\ \\\|\ myfilter
4490< The placeholder "$*" can be given (even multiple times) to specify
4491 where the arguments will be included, for example: >
4492 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4493< This option cannot be set from a |modeline| or in the |sandbox|, for
4494 security reasons.
4495
4496 *'matchpairs'* *'mps'*
4497'matchpairs' 'mps' string (default "(:),{:},[:]")
4498 local to buffer
4499 {not in Vi}
4500 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004501 other. Currently only single byte character pairs are allowed, and
4502 they must be different. The characters must be separated by a colon.
4503 The pairs must be separated by a comma. Example for including '<' and
4504 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 :set mps+=<:>
4506
4507< A more exotic example, to jump between the '=' and ';' in an
4508 assignment, useful for languages like C and Java: >
4509 :au FileType c,cpp,java set mps+==:;
4510
4511< For a more advanced way of using "%", see the matchit.vim plugin in
4512 the $VIMRUNTIME/macros directory. |add-local-help|
4513
4514 *'matchtime'* *'mat'*
4515'matchtime' 'mat' number (default 5)
4516 global
4517 {not in Vi}{in Nvi}
4518 Tenths of a second to show the matching paren, when 'showmatch' is
4519 set. Note that this is not in milliseconds, like other options that
4520 set a time. This is to be compatible with Nvi.
4521
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004522 *'maxcombine'* *'mco'*
4523'maxcombine' 'mco' number (default 2)
4524 global
4525 {not in Vi}
4526 {only available when compiled with the |+multi_byte|
4527 feature}
4528 The maximum number of combining characters supported for displaying.
4529 Only used when 'encoding' is "utf-8".
4530 The default is OK for most languages. Hebrew may require 4.
4531 Maximum value is 6.
4532 Even when this option is set to 2 you can still edit text with more
4533 combining characters, you just can't see them. Use |g8| or |ga|.
4534 See |mbyte-combining|.
4535
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 *'maxfuncdepth'* *'mfd'*
4537'maxfuncdepth' 'mfd' number (default 100)
4538 global
4539 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004540 {not available when compiled without the +eval
4541 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 Maximum depth of function calls for user functions. This normally
4543 catches endless recursion. When using a recursive function with
4544 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4545 more memory, there is the danger of failing when memory is exhausted.
4546 See also |:function|.
4547
4548 *'maxmapdepth'* *'mmd'* *E223*
4549'maxmapdepth' 'mmd' number (default 1000)
4550 global
4551 {not in Vi}
4552 Maximum number of times a mapping is done without resulting in a
4553 character to be used. This normally catches endless mappings, like
4554 ":map x y" with ":map y x". It still does not catch ":map g wg",
4555 because the 'w' is used before the next mapping is done. See also
4556 |key-mapping|.
4557
4558 *'maxmem'* *'mm'*
4559'maxmem' 'mm' number (default between 256 to 5120 (system
4560 dependent) or half the amount of memory
4561 available)
4562 global
4563 {not in Vi}
4564 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4565 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004566 other memory to be freed. The maximum usable value is about 2000000.
4567 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004569 *'maxmempattern'* *'mmp'*
4570'maxmempattern' 'mmp' number (default 1000)
4571 global
4572 {not in Vi}
4573 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004574 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004575 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004576 When Vim runs into the limit it gives an error message and mostly
4577 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004578 Running into the limit often means that the pattern is very
4579 inefficient or too complex. This may already happen with the pattern
4580 "\(.\)*" on a very long line. ".*" works much better.
4581 Vim may run out of memory before hitting the 'maxmempattern' limit.
4582
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 *'maxmemtot'* *'mmt'*
4584'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4585 dependent) or half the amount of memory
4586 available)
4587 global
4588 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004589 Maximum amount of memory in Kbyte to use for all buffers together.
4590 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4591 without a limit. On 64 bit machines higher values might work. But
4592 hey, do you really need more than 2 Gbyte for text editing?
4593 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594
4595 *'menuitems'* *'mis'*
4596'menuitems' 'mis' number (default 25)
4597 global
4598 {not in Vi}
4599 {not available when compiled without the |+menu|
4600 feature}
4601 Maximum number of items to use in a menu. Used for menus that are
4602 generated from a list of items, e.g., the Buffers menu. Changing this
4603 option has no direct effect, the menu must be refreshed first.
4604
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004605 *'mkspellmem'* *'msm'*
4606'mkspellmem' 'msm' string (default "460000,2000,500")
4607 global
4608 {not in Vi}
4609 {not available when compiled without the |+syntax|
4610 feature}
4611 Parameters for |:mkspell|. This tunes when to start compressing the
4612 word tree. Compression can be slow when there are many words, but
4613 it's needed to avoid running out of memory. The amount of memory used
4614 per word depends very much on how similar the words are, that's why
4615 this tuning is complicated.
4616
4617 There are three numbers, separated by commas:
4618 {start},{inc},{added}
4619
4620 For most languages the uncompressed word tree fits in memory. {start}
4621 gives the amount of memory in Kbyte that can be used before any
4622 compression is done. It should be a bit smaller than the amount of
4623 memory that is available to Vim.
4624
4625 When going over the {start} limit the {inc} number specifies the
4626 amount of memory in Kbyte that can be allocated before another
4627 compression is done. A low number means compression is done after
4628 less words are added, which is slow. A high number means more memory
4629 will be allocated.
4630
4631 After doing compression, {added} times 1024 words can be added before
4632 the {inc} limit is ignored and compression is done when any extra
4633 amount of memory is needed. A low number means there is a smaller
4634 chance of hitting the {inc} limit, less memory is used but it's
4635 slower.
4636
4637 The languages for which these numbers are important are Italian and
4638 Hungarian. The default works for when you have about 512 Mbyte. If
4639 you have 1 Gbyte you could use: >
4640 :set mkspellmem=900000,3000,800
4641< If you have less than 512 Mbyte |:mkspell| may fail for some
4642 languages, no matter what you set 'mkspellmem' to.
4643
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004645'modeline' 'ml' boolean (Vim default: on (off for root),
4646 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 local to buffer
4648 *'modelines'* *'mls'*
4649'modelines' 'mls' number (default 5)
4650 global
4651 {not in Vi}
4652 If 'modeline' is on 'modelines' gives the number of lines that is
4653 checked for set commands. If 'modeline' is off or 'modelines' is zero
4654 no lines are checked. See |modeline|.
4655 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4656 set and to the Vim default value when 'compatible' is reset.
4657
4658 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4659'modifiable' 'ma' boolean (default on)
4660 local to buffer
4661 {not in Vi} *E21*
4662 When off the buffer contents cannot be changed. The 'fileformat' and
4663 'fileencoding' options also can't be changed.
4664 Can be reset with the |-M| command line argument.
4665
4666 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4667'modified' 'mod' boolean (default off)
4668 local to buffer
4669 {not in Vi}
4670 When on, the buffer is considered to be modified. This option is set
4671 when:
4672 1. A change was made to the text since it was last written. Using the
4673 |undo| command to go back to the original text will reset the
4674 option. But undoing changes that were made before writing the
4675 buffer will set the option again, since the text is different from
4676 when it was written.
4677 2. 'fileformat' or 'fileencoding' is different from its original
4678 value. The original value is set when the buffer is read or
4679 written. A ":set nomodified" command also resets the original
4680 values to the current values and the 'modified' option will be
4681 reset.
4682 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4683 will be ignored.
4684
4685 *'more'* *'nomore'*
4686'more' boolean (Vim default: on, Vi default: off)
4687 global
4688 {not in Vi}
4689 When on, listings pause when the whole screen is filled. You will get
4690 the |more-prompt|. When this option is off there are no pauses, the
4691 listing continues until finished.
4692 NOTE: This option is set to the Vi default value when 'compatible' is
4693 set and to the Vim default value when 'compatible' is reset.
4694
4695 *'mouse'* *E538*
4696'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4697 global
4698 {not in Vi}
4699 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004700 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4701 sysmouse and Linux console with gpm). For using the mouse in the
4702 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 The mouse can be enabled for different modes:
4704 n Normal mode
4705 v Visual mode
4706 i Insert mode
4707 c Command-line mode
4708 h all previous modes when editing a help file
4709 a all previous modes
4710 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 Normally you would enable the mouse in all four modes with: >
4712 :set mouse=a
4713< When the mouse is not enabled, the GUI will still use the mouse for
4714 modeless selection. This doesn't move the text cursor.
4715
4716 See |mouse-using|. Also see |'clipboard'|.
4717
4718 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004719 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 the mouse buttons can still be used by keeping the shift key pressed.
4721 Also see the 'clipboard' option.
4722
4723 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4724'mousefocus' 'mousef' boolean (default off)
4725 global
4726 {not in Vi}
4727 {only works in the GUI}
4728 The window that the mouse pointer is on is automatically activated.
4729 When changing the window layout or window focus in another way, the
4730 mouse pointer is moved to the window with keyboard focus. Off is the
4731 default because it makes using the pull down menus a little goofy, as
4732 a pointer transit may activate a window unintentionally.
4733
4734 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4735'mousehide' 'mh' boolean (default on)
4736 global
4737 {not in Vi}
4738 {only works in the GUI}
4739 When on, the mouse pointer is hidden when characters are typed.
4740 The mouse pointer is restored when the mouse is moved.
4741
4742 *'mousemodel'* *'mousem'*
4743'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4744 global
4745 {not in Vi}
4746 Sets the model to use for the mouse. The name mostly specifies what
4747 the right mouse button is used for:
4748 extend Right mouse button extends a selection. This works
4749 like in an xterm.
4750 popup Right mouse button pops up a menu. The shifted left
4751 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004752 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 popup_setpos Like "popup", but the cursor will be moved to the
4754 position where the mouse was clicked, and thus the
4755 selected operation will act upon the clicked object.
4756 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004757 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758 course, that right clicking outside a selection will
4759 end Visual mode.
4760 Overview of what button does what for each model:
4761 mouse extend popup(_setpos) ~
4762 left click place cursor place cursor
4763 left drag start selection start selection
4764 shift-left search word extend selection
4765 right click extend selection popup menu (place cursor)
4766 right drag extend selection -
4767 middle click paste paste
4768
4769 In the "popup" model the right mouse button produces a pop-up menu.
4770 You need to define this first, see |popup-menu|.
4771
4772 Note that you can further refine the meaning of buttons with mappings.
4773 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4774 selection (because that's handled in the GUI code directly).
4775
4776 The 'mousemodel' option is set by the |:behave| command.
4777
4778 *'mouseshape'* *'mouses'* *E547*
4779'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004780 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781 global
4782 {not in Vi}
4783 {only available when compiled with the |+mouseshape|
4784 feature}
4785 This option tells Vim what the mouse pointer should look like in
4786 different modes. The option is a comma separated list of parts, much
4787 like used for 'guicursor'. Each part consist of a mode/location-list
4788 and an argument-list:
4789 mode-list:shape,mode-list:shape,..
4790 The mode-list is a dash separated list of these modes/locations:
4791 In a normal window: ~
4792 n Normal mode
4793 v Visual mode
4794 ve Visual mode with 'selection' "exclusive" (same as 'v',
4795 if not specified)
4796 o Operator-pending mode
4797 i Insert mode
4798 r Replace mode
4799
4800 Others: ~
4801 c appending to the command-line
4802 ci inserting in the command-line
4803 cr replacing in the command-line
4804 m at the 'Hit ENTER' or 'More' prompts
4805 ml idem, but cursor in the last line
4806 e any mode, pointer below last window
4807 s any mode, pointer on a status line
4808 sd any mode, while dragging a status line
4809 vs any mode, pointer on a vertical separator line
4810 vd any mode, while dragging a vertical separator line
4811 a everywhere
4812
4813 The shape is one of the following:
4814 avail name looks like ~
4815 w x arrow Normal mouse pointer
4816 w x blank no pointer at all (use with care!)
4817 w x beam I-beam
4818 w x updown up-down sizing arrows
4819 w x leftright left-right sizing arrows
4820 w x busy The system's usual busy pointer
4821 w x no The system's usual 'no input' pointer
4822 x udsizing indicates up-down resizing
4823 x lrsizing indicates left-right resizing
4824 x crosshair like a big thin +
4825 x hand1 black hand
4826 x hand2 white hand
4827 x pencil what you write with
4828 x question big ?
4829 x rightup-arrow arrow pointing right-up
4830 w x up-arrow arrow pointing up
4831 x <number> any X11 pointer number (see X11/cursorfont.h)
4832
4833 The "avail" column contains a 'w' if the shape is available for Win32,
4834 x for X11.
4835 Any modes not specified or shapes not available use the normal mouse
4836 pointer.
4837
4838 Example: >
4839 :set mouseshape=s:udsizing,m:no
4840< will make the mouse turn to a sizing arrow over the status lines and
4841 indicate no input when the hit-enter prompt is displayed (since
4842 clicking the mouse has no effect in this state.)
4843
4844 *'mousetime'* *'mouset'*
4845'mousetime' 'mouset' number (default 500)
4846 global
4847 {not in Vi}
4848 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4849 time in msec between two mouse clicks for the second click to be
4850 recognized as a multi click.
4851
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004852 *'mzquantum'* *'mzq'*
4853'mzquantum' 'mzq' number (default 100)
4854 global
4855 {not in Vi}
4856 {not available when compiled without the |+mzscheme|
4857 feature}
4858 The number of milliseconds between polls for MzScheme threads.
4859 Negative or zero value means no thread scheduling.
4860
Bram Moolenaar071d4272004-06-13 20:20:40 +00004861 *'nrformats'* *'nf'*
4862'nrformats' 'nf' string (default "octal,hex")
4863 local to buffer
4864 {not in Vi}
4865 This defines what bases Vim will consider for numbers when using the
4866 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4867 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004868 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 incremented or decremented. This is useful for a list with a
4870 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004871 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004873 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 considered to be hexadecimal. Example: Using CTRL-X on
4875 "0x100" results in "0x0ff".
4876 Numbers which simply begin with a digit in the range 1-9 are always
4877 considered decimal. This also happens for numbers that are not
4878 recognized as octal or hex.
4879
4880 *'number'* *'nu'* *'nonumber'* *'nonu'*
4881'number' 'nu' boolean (default off)
4882 local to window
4883 Print the line number in front of each line. When the 'n' option is
4884 excluded from 'cpoptions' a wrapped line will not use the column of
4885 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004886 The 'numberwidth' option can be used to set the room used for the line
4887 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888 When a long, wrapped line doesn't start with the first character, '-'
4889 characters are put before the number.
4890 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02004891 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004893 *'numberwidth'* *'nuw'*
4894'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4895 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004896 {not in Vi}
4897 {only available when compiled with the |+linebreak|
4898 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004899 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02004900 when the 'number' or 'relativenumber' option is set or printing lines
4901 with a line number. Since one space is always between the number and
4902 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004903 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02004904 fit the highest line number in the buffer respectively the number of
4905 rows in the window, depending on whether 'number' or 'relativenumber'
4906 is set. Thus with the Vim default of 4 there is room for a line number
4907 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004908 The minimum value is 1, the maximum value is 10.
4909 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4910
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004911 *'omnifunc'* *'ofu'*
4912'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004913 local to buffer
4914 {not in Vi}
4915 {not available when compiled without the +eval
4916 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004917 This option specifies a function to be used for Insert mode omni
4918 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004919 See |complete-functions| for an explanation of how the function is
4920 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00004921 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00004922 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00004923
4924
Bram Moolenaar02467872007-05-06 13:22:01 +00004925 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00004926'opendevice' 'odev' boolean (default off)
4927 global
4928 {not in Vi}
4929 {only for MS-DOS, MS-Windows and OS/2}
4930 Enable reading and writing from devices. This may get Vim stuck on a
4931 device that can be opened but doesn't actually do the I/O. Therefore
4932 it is off by default.
4933 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
4934 result in editing a device.
4935
4936
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004937 *'operatorfunc'* *'opfunc'*
4938'operatorfunc' 'opfunc' string (default: empty)
4939 global
4940 {not in Vi}
4941 This option specifies a function to be called by the |g@| operator.
4942 See |:map-operator| for more info and an example.
4943
4944 This option cannot be set from a |modeline| or in the |sandbox|, for
4945 security reasons.
4946
4947
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948 *'osfiletype'* *'oft'* *E366*
4949'osfiletype' 'oft' string (RISC-OS default: "Text",
4950 others default: "")
4951 local to buffer
4952 {not in Vi}
4953 {only available when compiled with the |+osfiletype|
4954 feature}
4955 Some operating systems store extra information about files besides
4956 name, datestamp and permissions. This option contains the extra
4957 information, the nature of which will vary between systems.
4958 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00004959 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 It can affect the pattern matching of the automatic commands.
4961 |autocmd-osfiletypes|
4962
4963 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00004964'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 global
4966 Specifies the nroff macros that separate paragraphs. These are pairs
4967 of two letters (see |object-motions|).
4968
4969 *'paste'* *'nopaste'*
4970'paste' boolean (default off)
4971 global
4972 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004973 Put Vim in Paste mode. This is useful if you want to cut or copy
4974 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 unexpected effects.
4976 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004977 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 knows about pasting and will mostly do the right thing without 'paste'
4979 being set. The same is true for a terminal where Vim handles the
4980 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004981 This option is reset when starting the GUI. Thus if you set it in
4982 your .vimrc it will work in a terminal, but not in the GUI. Setting
4983 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4984 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985 When the 'paste' option is switched on (also when it was already on):
4986 - mapping in Insert mode and Command-line mode is disabled
4987 - abbreviations are disabled
4988 - 'textwidth' is set to 0
4989 - 'wrapmargin' is set to 0
4990 - 'autoindent' is reset
4991 - 'smartindent' is reset
4992 - 'softtabstop' is set to 0
4993 - 'revins' is reset
4994 - 'ruler' is reset
4995 - 'showmatch' is reset
4996 - 'formatoptions' is used like it is empty
4997 These options keep their value, but their effect is disabled:
4998 - 'lisp'
4999 - 'indentexpr'
5000 - 'cindent'
5001 NOTE: When you start editing another file while the 'paste' option is
5002 on, settings from the modelines or autocommands may change the
5003 settings again, causing trouble when pasting text. You might want to
5004 set the 'paste' option again.
5005 When the 'paste' option is reset the mentioned options are restored to
5006 the value before the moment 'paste' was switched from off to on.
5007 Resetting 'paste' before ever setting it does not have any effect.
5008 Since mapping doesn't work while 'paste' is active, you need to use
5009 the 'pastetoggle' option to toggle the 'paste' option with some key.
5010
5011 *'pastetoggle'* *'pt'*
5012'pastetoggle' 'pt' string (default "")
5013 global
5014 {not in Vi}
5015 When non-empty, specifies the key sequence that toggles the 'paste'
5016 option. This is like specifying a mapping: >
5017 :map {keys} :set invpaste<CR>
5018< Where {keys} is the value of 'pastetoggle'.
5019 The difference is that it will work even when 'paste' is set.
5020 'pastetoggle' works in Insert mode and Normal mode, but not in
5021 Command-line mode.
5022 Mappings are checked first, thus overrule 'pastetoggle'. However,
5023 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5024 this: >
5025 :map <F10> :set paste<CR>
5026 :map <F11> :set nopaste<CR>
5027 :imap <F10> <C-O>:set paste<CR>
5028 :imap <F11> <nop>
5029 :set pastetoggle=<F11>
5030< This will make <F10> start paste mode and <F11> stop paste mode.
5031 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5032 mode everything is inserted literally, except the 'pastetoggle' key
5033 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005034 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035
5036 *'pex'* *'patchexpr'*
5037'patchexpr' 'pex' string (default "")
5038 global
5039 {not in Vi}
5040 {not available when compiled without the |+diff|
5041 feature}
5042 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005043 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044
5045 *'patchmode'* *'pm'* *E206*
5046'patchmode' 'pm' string (default "")
5047 global
5048 {not in Vi}
5049 When non-empty the oldest version of a file is kept. This can be used
5050 to keep the original version of a file if you are changing files in a
5051 source distribution. Only the first time that a file is written a
5052 copy of the original file will be kept. The name of the copy is the
5053 name of the original file with the string in the 'patchmode' option
5054 appended. This option should start with a dot. Use a string like
5055 ".org". 'backupdir' must not be empty for this to work (Detail: The
5056 backup file is renamed to the patchmode file after the new file has
5057 been successfully written, that's why it must be possible to write a
5058 backup file). If there was no file to be backed up, an empty file is
5059 created.
5060 When the 'backupskip' pattern matches, a patchmode file is not made.
5061 Using 'patchmode' for compressed files appends the extension at the
5062 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5063 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005064 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065
5066 *'path'* *'pa'* *E343* *E345* *E347*
5067'path' 'pa' string (default on Unix: ".,/usr/include,,"
5068 on OS/2: ".,/emx/include,,"
5069 other systems: ".,,")
5070 global or local to buffer |global-local|
5071 {not in Vi}
5072 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005073 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5074 provided that the file being searched for has a relative path (not
5075 starting with "/", "./" or "../"). The directories in the 'path'
5076 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077 - Use commas to separate directory names: >
5078 :set path=.,/usr/local/include,/usr/include
5079< - Spaces can also be used to separate directory names (for backwards
5080 compatibility with version 3.0). To have a space in a directory
5081 name, precede it with an extra backslash, and escape the space: >
5082 :set path=.,/dir/with\\\ space
5083< - To include a comma in a directory name precede it with an extra
5084 backslash: >
5085 :set path=.,/dir/with\\,comma
5086< - To search relative to the directory of the current file, use: >
5087 :set path=.
5088< - To search in the current directory use an empty string between two
5089 commas: >
5090 :set path=,,
5091< - A directory name may end in a ':' or '/'.
5092 - Environment variables are expanded |:set_env|.
5093 - When using |netrw.vim| URLs can be used. For example, adding
5094 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005095 - Search upwards and downwards in a directory tree using "*", "**" and
5096 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 {not available when compiled without the |+path_extra| feature}
5098 - Careful with '\' characters, type two to get one in the option: >
5099 :set path=.,c:\\include
5100< Or just use '/' instead: >
5101 :set path=.,c:/include
5102< Don't forget "." or files won't even be found in the same directory as
5103 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005104 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105 it is something like 256 or 1024 characters.
5106 You can check if all the include files are found, using the value of
5107 'path', see |:checkpath|.
5108 The use of |:set+=| and |:set-=| is preferred when adding or removing
5109 directories from the list. This avoids problems when a future version
5110 uses another default. To remove the current directory use: >
5111 :set path-=
5112< To add the current directory use: >
5113 :set path+=
5114< To use an environment variable, you probably need to replace the
5115 separator. Here is an example to append $INCL, in which directory
5116 names are separated with a semi-colon: >
5117 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5118< Replace the ';' with a ':' or whatever separator is used. Note that
5119 this doesn't work when $INCL contains a comma or white space.
5120
5121 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5122'preserveindent' 'pi' boolean (default off)
5123 local to buffer
5124 {not in Vi}
5125 When changing the indent of the current line, preserve as much of the
5126 indent structure as possible. Normally the indent is replaced by a
5127 series of tabs followed by spaces as required (unless |'expandtab'| is
5128 enabled, in which case only spaces are used). Enabling this option
5129 means the indent will preserve as many existing characters as possible
5130 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005131 'expandtab' does not apply to the preserved white space, a Tab remains
5132 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133 NOTE: When using ">>" multiple times the resulting indent is a mix of
5134 tabs and spaces. You might not like this.
5135 NOTE: 'preserveindent' is reset when 'compatible' is set.
5136 Also see 'copyindent'.
5137 Use |:retab| to clean up white space.
5138
5139 *'previewheight'* *'pvh'*
5140'previewheight' 'pvh' number (default 12)
5141 global
5142 {not in Vi}
5143 {not available when compiled without the |+windows| or
5144 |+quickfix| feature}
5145 Default height for a preview window. Used for |:ptag| and associated
5146 commands. Used for |CTRL-W_}| when no count is given.
5147
5148 *'previewwindow'* *'nopreviewwindow'*
5149 *'pvw'* *'nopvw'* *E590*
5150'previewwindow' 'pvw' boolean (default off)
5151 local to window
5152 {not in Vi}
5153 {not available when compiled without the |+windows| or
5154 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005155 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 set. It's normally not set directly, but by using one of the commands
5157 |:ptag|, |:pedit|, etc.
5158
5159 *'printdevice'* *'pdev'*
5160'printdevice' 'pdev' string (default empty)
5161 global
5162 {not in Vi}
5163 {only available when compiled with the |+printer|
5164 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005165 The name of the printer to be used for |:hardcopy|.
5166 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005167 This option cannot be set from a |modeline| or in the |sandbox|, for
5168 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169
Bram Moolenaar8299df92004-07-10 09:47:34 +00005170 *'printencoding'* *'penc'*
5171'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 global
5173 {not in Vi}
5174 {only available when compiled with the |+printer|
5175 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005176 Sets the character encoding used when printing.
5177 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178
5179 *'printexpr'* *'pexpr'*
5180'printexpr' 'pexpr' String (default: see below)
5181 global
5182 {not in Vi}
5183 {only available when compiled with the |+printer|
5184 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005185 Expression used to print the PostScript produced with |:hardcopy|.
5186 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187
Bram Moolenaar8299df92004-07-10 09:47:34 +00005188 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189'printfont' 'pfn' string (default "courier")
5190 global
5191 {not in Vi}
5192 {only available when compiled with the |+printer|
5193 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005194 The name of the font that will be used for |:hardcopy|.
5195 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196
5197 *'printheader'* *'pheader'*
5198'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5199 global
5200 {not in Vi}
5201 {only available when compiled with the |+printer|
5202 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005203 The format of the header produced in |:hardcopy| output.
5204 See |pheader-option|.
5205
5206 *'printmbcharset'* *'pmbcs'*
5207'printmbcharset' 'pmbcs' string (default "")
5208 global
5209 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005210 {only available when compiled with the |+printer|,
5211 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005212 The CJK character set to be used for CJK output from |:hardcopy|.
5213 See |pmbcs-option|.
5214
5215 *'printmbfont'* *'pmbfn'*
5216'printmbfont' 'pmbfn' string (default "")
5217 global
5218 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005219 {only available when compiled with the |+printer|,
5220 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005221 List of font names to be used for CJK output from |:hardcopy|.
5222 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223
5224 *'printoptions'* *'popt'*
5225'printoptions' 'popt' string (default "")
5226 global
5227 {not in Vi}
5228 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005229 List of items that control the format of the output of |:hardcopy|.
5230 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005232 *'prompt'* *'noprompt'*
5233'prompt' boolean (default on)
5234 global
5235 When on a ":" prompt is used in Ex mode.
5236
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005237 *'pumheight'* *'ph'*
5238'pumheight' 'ph' number (default 0)
5239 global
5240 {not available when compiled without the
5241 |+insert_expand| feature}
5242 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005243 Determines the maximum number of items to show in the popup menu for
5244 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005245 |ins-completion-menu|.
5246
5247
Bram Moolenaar677ee682005-01-27 14:41:15 +00005248 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005249'quoteescape' 'qe' string (default "\")
5250 local to buffer
5251 {not in Vi}
5252 The characters that are used to escape quotes in a string. Used for
5253 objects like a', a" and a` |a'|.
5254 When one of the characters in this option is found inside a string,
5255 the following character will be skipped. The default value makes the
5256 text "foo\"bar\\" considered to be one string.
5257
Bram Moolenaar071d4272004-06-13 20:20:40 +00005258 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5259'readonly' 'ro' boolean (default off)
5260 local to buffer
5261 If on, writes fail unless you use a '!'. Protects you from
5262 accidentally overwriting a file. Default on when Vim is started
5263 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005264 When using ":w!" the 'readonly' option is reset for the current
5265 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005267 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005269 *'redrawtime'* *'rdt'*
5270'redrawtime' 'rdt' number (default 2000)
5271 global
5272 {not in Vi}
5273 {only available when compiled with the |+reltime|
5274 feature}
5275 The time in milliseconds for redrawing the display. This applies to
5276 searching for patterns for 'hlsearch' and |:match| highlighting.
5277 When redrawing takes more than this many milliseconds no further
5278 matches will be highlighted. This is used to avoid that Vim hangs
5279 when using a very complicated pattern.
5280
Bram Moolenaar64486672010-05-16 15:46:46 +02005281 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5282'relativenumber' 'rnu' boolean (default off)
5283 local to window
5284 {not in Vi}
5285 Show the line number relative to the line with the cursor in front of
5286 each line. Relative line numbers help you using the |count| you can
5287 precede some vertical motion commands (e.g. j k + -) with, without
5288 having to calculate it yourself. Especially useful in combination with
5289 other commands (e.g. y d c < > gq gw =).
5290 When the 'n' option is excluded from 'cpoptions' a wrapped
5291 line will not use the column of line numbers (this is the default when
5292 'compatible' isn't set).
5293 The 'numberwidth' option can be used to set the room used for the line
5294 number.
5295 When a long, wrapped line doesn't start with the first character, '-'
5296 characters are put before the number.
5297 See |hl-LineNr| for the highlighting used for the number.
5298 When setting this option, 'number' is reset.
5299
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 *'remap'* *'noremap'*
5301'remap' boolean (default on)
5302 global
5303 Allows for mappings to work recursively. If you do not want this for
5304 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005305 NOTE: To avoid portability problems with Vim scripts, always keep
5306 this option at the default "on". Only switch it off when working with
5307 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308
5309 *'report'*
5310'report' number (default 2)
5311 global
5312 Threshold for reporting number of lines changed. When the number of
5313 changed lines is more than 'report' a message will be given for most
5314 ":" commands. If you want it always, set 'report' to 0.
5315 For the ":substitute" command the number of substitutions is used
5316 instead of the number of lines.
5317
5318 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5319'restorescreen' 'rs' boolean (default on)
5320 global
5321 {not in Vi} {only in Windows 95/NT console version}
5322 When set, the screen contents is restored when exiting Vim. This also
5323 happens when executing external commands.
5324
5325 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5326 options in your .vimrc. To disable restoring:
5327 set t_ti= t_te=
5328 To enable restoring (for an xterm):
5329 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5330 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5331
5332 *'revins'* *'ri'* *'norevins'* *'nori'*
5333'revins' 'ri' boolean (default off)
5334 global
5335 {not in Vi}
5336 {only available when compiled with the |+rightleft|
5337 feature}
5338 Inserting characters in Insert mode will work backwards. See "typing
5339 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5340 command in Insert mode, when 'allowrevins' is set.
5341 NOTE: This option is reset when 'compatible' or 'paste' is set.
5342
5343 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5344'rightleft' 'rl' boolean (default off)
5345 local to window
5346 {not in Vi}
5347 {only available when compiled with the |+rightleft|
5348 feature}
5349 When on, display orientation becomes right-to-left, i.e., characters
5350 that are stored in the file appear from the right to the left.
5351 Using this option, it is possible to edit files for languages that
5352 are written from the right to the left such as Hebrew and Arabic.
5353 This option is per window, so it is possible to edit mixed files
5354 simultaneously, or to view the same file in both ways (this is
5355 useful whenever you have a mixed text file with both right-to-left
5356 and left-to-right strings so that both sets are displayed properly
5357 in different windows). Also see |rileft.txt|.
5358
5359 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5360'rightleftcmd' 'rlc' string (default "search")
5361 local to window
5362 {not in Vi}
5363 {only available when compiled with the |+rightleft|
5364 feature}
5365 Each word in this option enables the command line editing to work in
5366 right-to-left mode for a group of commands:
5367
5368 search "/" and "?" commands
5369
5370 This is useful for languages such as Hebrew, Arabic and Farsi.
5371 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5372
5373 *'ruler'* *'ru'* *'noruler'* *'noru'*
5374'ruler' 'ru' boolean (default off)
5375 global
5376 {not in Vi}
5377 {not available when compiled without the
5378 |+cmdline_info| feature}
5379 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005380 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381 text in the file is shown on the far right:
5382 Top first line is visible
5383 Bot last line is visible
5384 All first and last line are visible
5385 45% relative position in the file
5386 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005387 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005389 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390 this option takes precedence over 'ruler' and 'rulerformat'
5391 If the number of characters displayed is different from the number of
5392 bytes in the text (e.g., for a TAB or a multi-byte character), both
5393 the text column (byte number) and the screen column are shown,
5394 separated with a dash.
5395 For an empty line "0-1" is shown.
5396 For an empty buffer the line number will also be zero: "0,0-1".
5397 This option is reset when the 'paste' option is set.
5398 If you don't want to see the ruler all the time but want to know where
5399 you are, use "g CTRL-G" |g_CTRL-G|.
5400 NOTE: This option is reset when 'compatible' is set.
5401
5402 *'rulerformat'* *'ruf'*
5403'rulerformat' 'ruf' string (default empty)
5404 global
5405 {not in Vi}
5406 {not available when compiled without the |+statusline|
5407 feature}
5408 When this option is not empty, it determines the content of the ruler
5409 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005410 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005411 The default ruler width is 17 characters. To make the ruler 15
5412 characters wide, put "%15(" at the start and "%)" at the end.
5413 Example: >
5414 :set rulerformat=%15(%c%V\ %p%%%)
5415<
5416 *'runtimepath'* *'rtp'* *vimfiles*
5417'runtimepath' 'rtp' string (default:
5418 Unix: "$HOME/.vim,
5419 $VIM/vimfiles,
5420 $VIMRUNTIME,
5421 $VIM/vimfiles/after,
5422 $HOME/.vim/after"
5423 Amiga: "home:vimfiles,
5424 $VIM/vimfiles,
5425 $VIMRUNTIME,
5426 $VIM/vimfiles/after,
5427 home:vimfiles/after"
5428 PC, OS/2: "$HOME/vimfiles,
5429 $VIM/vimfiles,
5430 $VIMRUNTIME,
5431 $VIM/vimfiles/after,
5432 $HOME/vimfiles/after"
5433 Macintosh: "$VIM:vimfiles,
5434 $VIMRUNTIME,
5435 $VIM:vimfiles:after"
5436 RISC-OS: "Choices:vimfiles,
5437 $VIMRUNTIME,
5438 Choices:vimfiles/after"
5439 VMS: "sys$login:vimfiles,
5440 $VIM/vimfiles,
5441 $VIMRUNTIME,
5442 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005443 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 global
5445 {not in Vi}
5446 This is a list of directories which will be searched for runtime
5447 files:
5448 filetype.vim filetypes by file name |new-filetype|
5449 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005450 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451 colors/ color scheme files |:colorscheme|
5452 compiler/ compiler files |:compiler|
5453 doc/ documentation |write-local-help|
5454 ftplugin/ filetype plugins |write-filetype-plugin|
5455 indent/ indent scripts |indent-expression|
5456 keymap/ key mapping files |mbyte-keymap|
5457 lang/ menu translations |:menutrans|
5458 menu.vim GUI menus |menu.vim|
5459 plugin/ plugin scripts |write-plugin|
5460 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005461 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462 syntax/ syntax files |mysyntaxfile|
5463 tutor/ files for vimtutor |tutor|
5464
5465 And any other file searched for with the |:runtime| command.
5466
5467 The defaults for most systems are setup to search five locations:
5468 1. In your home directory, for your personal preferences.
5469 2. In a system-wide Vim directory, for preferences from the system
5470 administrator.
5471 3. In $VIMRUNTIME, for files distributed with Vim.
5472 *after-directory*
5473 4. In the "after" directory in the system-wide Vim directory. This is
5474 for the system administrator to overrule or add to the distributed
5475 defaults (rarely needed)
5476 5. In the "after" directory in your home directory. This is for
5477 personal preferences to overrule or add to the distributed defaults
5478 or system-wide settings (rarely needed).
5479
5480 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5481 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005482 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 wildcards.
5484 See |:runtime|.
5485 Example: >
5486 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5487< This will use the directory "~/vimruntime" first (containing your
5488 personal Vim runtime files), then "/mygroup/vim" (shared between a
5489 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5490 files).
5491 You probably should always include $VIMRUNTIME somewhere, to use the
5492 distributed runtime files. You can put a directory before $VIMRUNTIME
5493 to find files which replace a distributed runtime files. You can put
5494 a directory after $VIMRUNTIME to find files which add to distributed
5495 runtime files.
5496 This option cannot be set from a |modeline| or in the |sandbox|, for
5497 security reasons.
5498
5499 *'scroll'* *'scr'*
5500'scroll' 'scr' number (default: half the window height)
5501 local to window
5502 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5503 set to half the number of lines in the window when the window size
5504 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005505 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5507 the number of screen lines instead of file lines, makes a difference
5508 when lines wrap}
5509
5510 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5511'scrollbind' 'scb' boolean (default off)
5512 local to window
5513 {not in Vi}
5514 {not available when compiled without the |+scrollbind|
5515 feature}
5516 See also |scroll-binding|. When this option is set, the current
5517 window scrolls as other scrollbind windows (windows that also have
5518 this option set) scroll. This option is useful for viewing the
5519 differences between two versions of a file, see 'diff'.
5520 See |'scrollopt'| for options that determine how this option should be
5521 interpreted.
5522 This option is mostly reset when splitting a window to edit another
5523 file. This means that ":split | edit file" results in two windows
5524 with scroll-binding, but ":split file" does not.
5525
5526 *'scrolljump'* *'sj'*
5527'scrolljump' 'sj' number (default 1)
5528 global
5529 {not in Vi}
5530 Minimal number of lines to scroll when the cursor gets off the
5531 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5532 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005533 When set to a negative number from -1 to -100 this is used as the
5534 percentage of the window height. Thus -50 scrolls half the window
5535 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005536 NOTE: This option is set to 1 when 'compatible' is set.
5537
5538 *'scrolloff'* *'so'*
5539'scrolloff' 'so' number (default 0)
5540 global
5541 {not in Vi}
5542 Minimal number of screen lines to keep above and below the cursor.
5543 This will make some context visible around where you are working. If
5544 you set it to a very large value (999) the cursor line will always be
5545 in the middle of the window (except at the start or end of the file or
5546 when long lines wrap).
5547 For scrolling horizontally see 'sidescrolloff'.
5548 NOTE: This option is set to 0 when 'compatible' is set.
5549
5550 *'scrollopt'* *'sbo'*
5551'scrollopt' 'sbo' string (default "ver,jump")
5552 global
5553 {not available when compiled without the |+scrollbind|
5554 feature}
5555 {not in Vi}
5556 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005557 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5558 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559 The following words are available:
5560 ver Bind vertical scrolling for 'scrollbind' windows
5561 hor Bind horizontal scrolling for 'scrollbind' windows
5562 jump Applies to the offset between two windows for vertical
5563 scrolling. This offset is the difference in the first
5564 displayed line of the bound windows. When moving
5565 around in a window, another 'scrollbind' window may
5566 reach a position before the start or after the end of
5567 the buffer. The offset is not changed though, when
5568 moving back the 'scrollbind' window will try to scroll
5569 to the desired position when possible.
5570 When now making that window the current one, two
5571 things can be done with the relative offset:
5572 1. When "jump" is not included, the relative offset is
5573 adjusted for the scroll position in the new current
5574 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005575 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576 2. When "jump" is included, the other windows are
5577 scrolled to keep the same relative offset. When
5578 going back to the other window, it still uses the
5579 same relative offset.
5580 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005581 When 'diff' mode is active there always is vertical scroll binding,
5582 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583
5584 *'sections'* *'sect'*
5585'sections' 'sect' string (default "SHNHH HUnhsh")
5586 global
5587 Specifies the nroff macros that separate sections. These are pairs of
5588 two letters (See |object-motions|). The default makes a section start
5589 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5590
5591 *'secure'* *'nosecure'* *E523*
5592'secure' boolean (default off)
5593 global
5594 {not in Vi}
5595 When on, ":autocmd", shell and write commands are not allowed in
5596 ".vimrc" and ".exrc" in the current directory and map commands are
5597 displayed. Switch it off only if you know that you will not run into
5598 problems, or when the 'exrc' option is off. On Unix this option is
5599 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005600 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601 'secure' at the end of your ~/.vimrc then.
5602 This option cannot be set from a |modeline| or in the |sandbox|, for
5603 security reasons.
5604
5605 *'selection'* *'sel'*
5606'selection' 'sel' string (default "inclusive")
5607 global
5608 {not in Vi}
5609 This option defines the behavior of the selection. It is only used
5610 in Visual and Select mode.
5611 Possible values:
5612 value past line inclusive ~
5613 old no yes
5614 inclusive yes yes
5615 exclusive yes no
5616 "past line" means that the cursor is allowed to be positioned one
5617 character past the line.
5618 "inclusive" means that the last character of the selection is included
5619 in an operation. For example, when "x" is used to delete the
5620 selection.
5621 Note that when "exclusive" is used and selecting from the end
5622 backwards, you cannot include the last character of a line, when
5623 starting in Normal mode and 'virtualedit' empty.
5624
5625 The 'selection' option is set by the |:behave| command.
5626
5627 *'selectmode'* *'slm'*
5628'selectmode' 'slm' string (default "")
5629 global
5630 {not in Vi}
5631 This is a comma separated list of words, which specifies when to start
5632 Select mode instead of Visual mode, when a selection is started.
5633 Possible values:
5634 mouse when using the mouse
5635 key when using shifted special keys
5636 cmd when using "v", "V" or CTRL-V
5637 See |Select-mode|.
5638 The 'selectmode' option is set by the |:behave| command.
5639
5640 *'sessionoptions'* *'ssop'*
5641'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005642 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643 global
5644 {not in Vi}
5645 {not available when compiled without the +mksession
5646 feature}
5647 Changes the effect of the |:mksession| command. It is a comma
5648 separated list of words. Each word enables saving and restoring
5649 something:
5650 word save and restore ~
5651 blank empty windows
5652 buffers hidden and unloaded buffers, not just those in windows
5653 curdir the current directory
5654 folds manually created folds, opened/closed folds and local
5655 fold options
5656 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005657 and contain at least one lowercase letter. Only
5658 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659 help the help window
5660 localoptions options and mappings local to a window or buffer (not
5661 global values for local options)
5662 options all options and mappings (also global values for local
5663 options)
5664 resize size of the Vim window: 'lines' and 'columns'
5665 sesdir the directory in which the session file is located
5666 will become the current directory (useful with
5667 projects accessed over a network from different
5668 systems)
5669 slash backslashes in file names replaced with forward
5670 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005671 tabpages all tab pages; without this only the current tab page
5672 is restored, so that you can make a session for each
5673 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674 unix with Unix end-of-line format (single <NL>), even when
5675 on Windows or DOS
5676 winpos position of the whole Vim window
5677 winsize window sizes
5678
5679 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005680 When neither "curdir" nor "sesdir" is included, file names are stored
5681 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005682 "slash" and "unix" are useful on Windows when sharing session files
5683 with Unix. The Unix version of Vim cannot source dos format scripts,
5684 but the Windows version of Vim can source unix format scripts.
5685
5686 *'shell'* *'sh'* *E91*
5687'shell' 'sh' string (default $SHELL or "sh",
5688 MS-DOS and Win32: "command.com" or
5689 "cmd.exe", OS/2: "cmd")
5690 global
5691 Name of the shell to use for ! and :! commands. When changing the
5692 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5693 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005694 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 See |option-backslash| about including spaces and backslashes.
5696 Environment variables are expanded |:set_env|.
5697 If the name of the shell contains a space, you might need to enclose
5698 it in quotes. Example: >
5699 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5700< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005701 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005702 "-f" is not inside the quotes, because it is not part of the command
5703 name. And Vim automagically recognizes the backslashes that are path
5704 separators.
5705 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5706 variable to change the way external commands are executed. See the
5707 libc.inf file of DJGPP.
5708 Under MS-Windows, when the executable ends in ".com" it must be
5709 included. Thus setting the shell to "command.com" or "4dos.com"
5710 works, but "command" and "4dos" do not work for all commands (e.g.,
5711 filtering).
5712 For unknown reasons, when using "4dos.com" the current directory is
5713 changed to "C:\". To avoid this set 'shell' like this: >
5714 :set shell=command.com\ /c\ 4dos
5715< This option cannot be set from a |modeline| or in the |sandbox|, for
5716 security reasons.
5717
5718 *'shellcmdflag'* *'shcf'*
5719'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5720 does not contain "sh" somewhere: "/c")
5721 global
5722 {not in Vi}
5723 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5724 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5725 systems, the default is set according to the value of 'shell', to
5726 reduce the need to set this option by the user. It's not used for
5727 OS/2 (EMX figures this out itself). See |option-backslash| about
5728 including spaces and backslashes. See |dos-shell|.
5729 This option cannot be set from a |modeline| or in the |sandbox|, for
5730 security reasons.
5731
5732 *'shellpipe'* *'sp'*
5733'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5734 global
5735 {not in Vi}
5736 {not available when compiled without the |+quickfix|
5737 feature}
5738 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005739 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 including spaces and backslashes.
5741 The name of the temporary file can be represented by "%s" if necessary
5742 (the file name is appended automatically if no %s appears in the value
5743 of this option).
5744 For the Amiga and MS-DOS the default is ">". The output is directly
5745 saved in a file and not echoed to the screen.
5746 For Unix the default it "| tee". The stdout of the compiler is saved
5747 in a file and echoed to the screen. If the 'shell' option is "csh" or
5748 "tcsh" after initializations, the default becomes "|& tee". If the
5749 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005750 "2>&1| tee". This means that stderr is also included. Before using
5751 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752 The initialization of this option is done after reading the ".vimrc"
5753 and the other initializations, so that when the 'shell' option is set
5754 there, the 'shellpipe' option changes automatically, unless it was
5755 explicitly set before.
5756 When 'shellpipe' is set to an empty string, no redirection of the
5757 ":make" output will be done. This is useful if you use a 'makeprg'
5758 that writes to 'makeef' by itself. If you want no piping, but do
5759 want to include the 'makeef', set 'shellpipe' to a single space.
5760 Don't forget to precede the space with a backslash: ":set sp=\ ".
5761 In the future pipes may be used for filtering and this option will
5762 become obsolete (at least for Unix).
5763 This option cannot be set from a |modeline| or in the |sandbox|, for
5764 security reasons.
5765
5766 *'shellquote'* *'shq'*
5767'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5768 contains "sh" somewhere: "\"")
5769 global
5770 {not in Vi}
5771 Quoting character(s), put around the command passed to the shell, for
5772 the "!" and ":!" commands. The redirection is kept outside of the
5773 quoting. See 'shellxquote' to include the redirection. It's
5774 probably not useful to set both options.
5775 This is an empty string by default. Only known to be useful for
5776 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5777 or bash, where it should be "\"". The default is adjusted according
5778 the value of 'shell', to reduce the need to set this option by the
5779 user. See |dos-shell|.
5780 This option cannot be set from a |modeline| or in the |sandbox|, for
5781 security reasons.
5782
5783 *'shellredir'* *'srr'*
5784'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5785 global
5786 {not in Vi}
5787 String to be used to put the output of a filter command in a temporary
5788 file. See also |:!|. See |option-backslash| about including spaces
5789 and backslashes.
5790 The name of the temporary file can be represented by "%s" if necessary
5791 (the file name is appended automatically if no %s appears in the value
5792 of this option).
5793 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5794 or "zsh" during initializations, the default becomes ">&". If the
5795 'shell' option is "sh", "ksh" or "bash" the default becomes
5796 ">%s 2>&1". This means that stderr is also included.
5797 For Win32, the Unix checks are done and additionally "cmd" is checked
5798 for, which makes the default ">%s 2>&1". Also, the same names with
5799 ".exe" appended are checked for.
5800 The initialization of this option is done after reading the ".vimrc"
5801 and the other initializations, so that when the 'shell' option is set
5802 there, the 'shellredir' option changes automatically unless it was
5803 explicitly set before.
5804 In the future pipes may be used for filtering and this option will
5805 become obsolete (at least for Unix).
5806 This option cannot be set from a |modeline| or in the |sandbox|, for
5807 security reasons.
5808
5809 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5810'shellslash' 'ssl' boolean (default off)
5811 global
5812 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5813 When set, a forward slash is used when expanding file names. This is
5814 useful when a Unix-like shell is used instead of command.com or
5815 cmd.exe. Backward slashes can still be typed, but they are changed to
5816 forward slashes by Vim.
5817 Note that setting or resetting this option has no effect for some
5818 existing file names, thus this option needs to be set before opening
5819 any file for best results. This might change in the future.
5820 'shellslash' only works when a backslash can be used as a path
5821 separator. To test if this is so use: >
5822 if exists('+shellslash')
5823<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005824 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5825'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5826 global
5827 {not in Vi}
5828 When on, use temp files for shell commands. When off use a pipe.
5829 When using a pipe is not possible temp files are used anyway.
5830 Currently a pipe is only supported on Unix. You can check it with: >
5831 :if has("filterpipe")
5832< The advantage of using a pipe is that nobody can read the temp file
5833 and the 'shell' command does not need to support redirection.
5834 The advantage of using a temp file is that the file type and encoding
5835 can be detected.
5836 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5837 |FilterWritePost| autocommands event are not triggered when
5838 'shelltemp' is off.
5839
Bram Moolenaar071d4272004-06-13 20:20:40 +00005840 *'shelltype'* *'st'*
5841'shelltype' 'st' number (default 0)
5842 global
5843 {not in Vi} {only for the Amiga}
5844 On the Amiga this option influences the way how the commands work
5845 which use a shell.
5846 0 and 1: always use the shell
5847 2 and 3: use the shell only to filter lines
5848 4 and 5: use shell only for ':sh' command
5849 When not using the shell, the command is executed directly.
5850
5851 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5852 1 and 3: use "shell cmd" to start external commands
5853
5854 *'shellxquote'* *'sxq'*
5855'shellxquote' 'sxq' string (default: "";
5856 for Win32, when 'shell' contains "sh"
5857 somewhere: "\""
5858 for Unix, when using system(): "\"")
5859 global
5860 {not in Vi}
5861 Quoting character(s), put around the command passed to the shell, for
5862 the "!" and ":!" commands. Includes the redirection. See
5863 'shellquote' to exclude the redirection. It's probably not useful
5864 to set both options.
5865 This is an empty string by default. Known to be useful for
5866 third-party shells when using the Win32 version, such as the MKS Korn
5867 Shell or bash, where it should be "\"". The default is adjusted
5868 according the value of 'shell', to reduce the need to set this option
5869 by the user. See |dos-shell|.
5870 This option cannot be set from a |modeline| or in the |sandbox|, for
5871 security reasons.
5872
5873 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5874'shiftround' 'sr' boolean (default off)
5875 global
5876 {not in Vi}
5877 Round indent to multiple of 'shiftwidth'. Applies to > and <
5878 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5879 a multiple of 'shiftwidth' (this is Vi compatible).
5880 NOTE: This option is reset when 'compatible' is set.
5881
5882 *'shiftwidth'* *'sw'*
5883'shiftwidth' 'sw' number (default 8)
5884 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005885 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 |'cindent'|, |>>|, |<<|, etc.
5887
5888 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005889'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5890 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891 global
5892 {not in Vi}
5893 This option helps to avoid all the |hit-enter| prompts caused by file
5894 messages, for example with CTRL-G, and to avoid some other messages.
5895 It is a list of flags:
5896 flag meaning when present ~
5897 f use "(3 of 5)" instead of "(file 3 of 5)"
5898 i use "[noeol]" instead of "[Incomplete last line]"
5899 l use "999L, 888C" instead of "999 lines, 888 characters"
5900 m use "[+]" instead of "[Modified]"
5901 n use "[New]" instead of "[New File]"
5902 r use "[RO]" instead of "[readonly]"
5903 w use "[w]" instead of "written" for file write message
5904 and "[a]" instead of "appended" for ':w >> file' command
5905 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5906 "[unix format]" and "[mac]" instead of "[mac format]".
5907 a all of the above abbreviations
5908
5909 o overwrite message for writing a file with subsequent message
5910 for reading a file (useful for ":wn" or when 'autowrite' on)
5911 O message for reading a file overwrites any previous message.
5912 Also for quickfix message (e.g., ":cn").
5913 s don't give "search hit BOTTOM, continuing at TOP" or "search
5914 hit TOP, continuing at BOTTOM" messages
5915 t truncate file message at the start if it is too long to fit
5916 on the command-line, "<" will appear in the left most column.
5917 Ignored in Ex mode.
5918 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005919 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920 Ignored in Ex mode.
5921 W don't give "written" or "[w]" when writing a file
5922 A don't give the "ATTENTION" message when an existing swap file
5923 is found.
5924 I don't give the intro message when starting Vim |:intro|.
5925
5926 This gives you the opportunity to avoid that a change between buffers
5927 requires you to hit <Enter>, but still gives as useful a message as
5928 possible for the space available. To get the whole message that you
5929 would have got with 'shm' empty, use ":file!"
5930 Useful values:
5931 shm= No abbreviation of message.
5932 shm=a Abbreviation, but no loss of information.
5933 shm=at Abbreviation, and truncate message when necessary.
5934
5935 NOTE: This option is set to the Vi default value when 'compatible' is
5936 set and to the Vim default value when 'compatible' is reset.
5937
5938 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5939'shortname' 'sn' boolean (default off)
5940 local to buffer
5941 {not in Vi, not in MS-DOS versions}
5942 Filenames are assumed to be 8 characters plus one extension of 3
5943 characters. Multiple dots in file names are not allowed. When this
5944 option is on, dots in file names are replaced with underscores when
5945 adding an extension (".~" or ".swp"). This option is not available
5946 for MS-DOS, because then it would always be on. This option is useful
5947 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5948 or crossdos. When running the Win32 GUI version under Win32s, this
5949 option is always on by default.
5950
5951 *'showbreak'* *'sbr'* *E595*
5952'showbreak' 'sbr' string (default "")
5953 global
5954 {not in Vi}
5955 {not available when compiled without the |+linebreak|
5956 feature}
5957 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005958 values are "> " or "+++ ": >
5959 :set showbreak=>\
5960< Note the backslash to escape the trailing space. It's easier like
5961 this: >
5962 :let &showbreak = '+++ '
5963< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00005964 comma (in a future version the comma might be used to separate the
5965 part that is shown at the end and at the start of a line).
5966 The characters are highlighted according to the '@' flag in
5967 'highlight'.
5968 Note that tabs after the showbreak will be displayed differently.
5969 If you want the 'showbreak' to appear in between line numbers, add the
5970 "n" flag to 'cpoptions'.
5971
5972 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5973'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5974 off)
5975 global
5976 {not in Vi}
5977 {not available when compiled without the
5978 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00005979 Show (partial) command in the last line of the screen. Set this
5980 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981 In Visual mode the size of the selected area is shown:
5982 - When selecting characters within a line, the number of characters.
5983 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005984 - When selecting a block, the size in screen characters:
5985 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005986 NOTE: This option is set to the Vi default value when 'compatible' is
5987 set and to the Vim default value when 'compatible' is reset.
5988
5989 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5990'showfulltag' 'sft' boolean (default off)
5991 global
5992 {not in Vi}
5993 When completing a word in insert mode (see |ins-completion|) from the
5994 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005995 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005996 matched a C function, you can see a template for what arguments are
5997 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00005998 Note that this doesn't work well together with having "longest" in
5999 'completeopt', because the completion from the search pattern may not
6000 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001
6002 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6003'showmatch' 'sm' boolean (default off)
6004 global
6005 When a bracket is inserted, briefly jump to the matching one. The
6006 jump is only done if the match can be seen on the screen. The time to
6007 show the match can be set with 'matchtime'.
6008 A Beep is given if there is no match (no matter if the match can be
6009 seen or not). This option is reset when the 'paste' option is set.
6010 When the 'm' flag is not included in 'cpoptions', typing a character
6011 will immediately move the cursor back to where it belongs.
6012 See the "sm" field in 'guicursor' for setting the cursor shape and
6013 blinking when showing the match.
6014 The 'matchpairs' option can be used to specify the characters to show
6015 matches for. 'rightleft' and 'revins' are used to look for opposite
6016 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006017 Also see the matchparen plugin for highlighting the match when moving
6018 around |pi_paren.txt|.
6019 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020
6021 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6022'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6023 global
6024 If in Insert, Replace or Visual mode put a message on the last line.
6025 Use the 'M' flag in 'highlight' to set the type of highlighting for
6026 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006027 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 doesn't mean XIM is really active, especially when 'imactivatekey' is
6029 not set.
6030 NOTE: This option is set to the Vi default value when 'compatible' is
6031 set and to the Vim default value when 'compatible' is reset.
6032
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006033 *'showtabline'* *'stal'*
6034'showtabline' 'stal' number (default 1)
6035 global
6036 {not in Vi}
6037 {not available when compiled without the +windows
6038 feature}
6039 The value of this option specifies when the line with tab page labels
6040 will be displayed:
6041 0: never
6042 1: only if there are at least two tab pages
6043 2: always
6044 This is both for the GUI and non-GUI implementation of the tab pages
6045 line.
6046 See |tab-page| for more information about tab pages.
6047
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048 *'sidescroll'* *'ss'*
6049'sidescroll' 'ss' number (default 0)
6050 global
6051 {not in Vi}
6052 The minimal number of columns to scroll horizontally. Used only when
6053 the 'wrap' option is off and the cursor is moved off of the screen.
6054 When it is zero the cursor will be put in the middle of the screen.
6055 When using a slow terminal set it to a large number or 0. When using
6056 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6057 commands.
6058
6059 *'sidescrolloff'* *'siso'*
6060'sidescrolloff' 'siso' number (default 0)
6061 global
6062 {not in Vi}
6063 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006064 right of the cursor if 'nowrap' is set. Setting this option to a
6065 value greater than 0 while having |'sidescroll'| also at a non-zero
6066 value makes some context visible in the line you are scrolling in
6067 horizontally (except at beginning of the line). Setting this option
6068 to a large value (like 999) has the effect of keeping the cursor
6069 horizontally centered in the window, as long as one does not come too
6070 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071 NOTE: This option is set to 0 when 'compatible' is set.
6072
6073 Example: Try this together with 'sidescroll' and 'listchars' as
6074 in the following example to never allow the cursor to move
6075 onto the "extends" character:
6076
6077 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6078 :set sidescrolloff=1
6079
6080
6081 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6082'smartcase' 'scs' boolean (default off)
6083 global
6084 {not in Vi}
6085 Override the 'ignorecase' option if the search pattern contains upper
6086 case characters. Only used when the search pattern is typed and
6087 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006088 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6090 recalling the search pattern from history and hitting <Enter>.
6091 NOTE: This option is reset when 'compatible' is set.
6092
6093 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6094'smartindent' 'si' boolean (default off)
6095 local to buffer
6096 {not in Vi}
6097 {not available when compiled without the
6098 |+smartindent| feature}
6099 Do smart autoindenting when starting a new line. Works for C-like
6100 programs, but can also be used for other languages. 'cindent' does
6101 something like this, works better in most cases, but is more strict,
6102 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6103 'indentexpr' is a more advanced alternative.
6104 Normally 'autoindent' should also be on when using 'smartindent'.
6105 An indent is automatically inserted:
6106 - After a line ending in '{'.
6107 - After a line starting with a keyword from 'cinwords'.
6108 - Before a line starting with '}' (only with the "O" command).
6109 When typing '}' as the first character in a new line, that line is
6110 given the same indent as the matching '{'.
6111 When typing '#' as the first character in a new line, the indent for
6112 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006113 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6115 When using the ">>" command, lines starting with '#' are not shifted
6116 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006117 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118 is set smart indenting is disabled.
6119
6120 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6121'smarttab' 'sta' boolean (default off)
6122 global
6123 {not in Vi}
6124 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006125 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6126 <BS> will delete a 'shiftwidth' worth of space at the start of the
6127 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006128 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006129 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6130 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006131 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006133 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134 NOTE: This option is reset when 'compatible' is set.
6135
6136 *'softtabstop'* *'sts'*
6137'softtabstop' 'sts' number (default 0)
6138 local to buffer
6139 {not in Vi}
6140 Number of spaces that a <Tab> counts for while performing editing
6141 operations, like inserting a <Tab> or using <BS>. It "feels" like
6142 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6143 used. This is useful to keep the 'ts' setting at its standard value
6144 of 8, while being able to edit like it is set to 'sts'. However,
6145 commands like "x" still work on the actual characters.
6146 When 'sts' is zero, this feature is off.
6147 'softtabstop' is set to 0 when the 'paste' option is set.
6148 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6149 spaces is minimized by using <Tab>s.
6150 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6151 set.
6152 NOTE: This option is set to 0 when 'compatible' is set.
6153
Bram Moolenaar217ad922005-03-20 22:37:15 +00006154 *'spell'* *'nospell'*
6155'spell' boolean (default off)
6156 local to window
6157 {not in Vi}
6158 {not available when compiled without the |+syntax|
6159 feature}
6160 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006161 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006162
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006163 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006164'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006165 local to buffer
6166 {not in Vi}
6167 {not available when compiled without the |+syntax|
6168 feature}
6169 Pattern to locate the end of a sentence. The following word will be
6170 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006171 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006172 When this check is not wanted make this option empty.
6173 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006174 Be careful with special characters, see |option-backslash| about
6175 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006176 To set this option automatically depending on the language, see
6177 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006178
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006179 *'spellfile'* *'spf'*
6180'spellfile' 'spf' string (default empty)
6181 local to buffer
6182 {not in Vi}
6183 {not available when compiled without the |+syntax|
6184 feature}
6185 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006186 commands. It must end in ".{encoding}.add". You need to include the
6187 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006188 *E765*
6189 It may also be a comma separated list of names. A count before the
6190 |zg| and |zw| commands can be used to access each. This allows using
6191 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006192 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006193 you: Using the first directory in 'runtimepath' that is writable. If
6194 there is no "spell" directory yet it will be created. For the file
6195 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006196 ignoring the region.
6197 The resulting ".spl" file will be used for spell checking, it does not
6198 have to appear in 'spelllang'.
6199 Normally one file is used for all regions, but you can add the region
6200 name if you want to. However, it will then only be used when
6201 'spellfile' is set to it, for entries in 'spelllang' only files
6202 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006203 This option cannot be set from a |modeline| or in the |sandbox|, for
6204 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006205
Bram Moolenaar217ad922005-03-20 22:37:15 +00006206 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006207'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006208 local to buffer
6209 {not in Vi}
6210 {not available when compiled without the |+syntax|
6211 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006212 A comma separated list of word list names. When the 'spell' option is
6213 on spellchecking will be done for these languages. Example: >
6214 set spelllang=en_us,nl,medical
6215< This means US English, Dutch and medical words are recognized. Words
6216 that are not recognized will be highlighted.
6217 The word list name must not include a comma or dot. Using a dash is
6218 recommended to separate the two letter language name from a
6219 specification. Thus "en-rare" is used for rare English words.
6220 A region name must come last and have the form "_xx", where "xx" is
6221 the two-letter, lower case region name. You can use more than one
6222 region by listing them: "en_us,en_ca" supports both US and Canadian
6223 English, but not words specific for Australia, New Zealand or Great
6224 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006225 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006226 As a special case the name of a .spl file can be given as-is. The
6227 first "_xx" in the name is removed and used as the region name
6228 (_xx is an underscore, two letters and followed by a non-letter).
6229 This is mainly for testing purposes. You must make sure the correct
6230 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006231 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006232 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6233 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006234 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006235
Bram Moolenaar98692072006-02-04 00:57:42 +00006236 If the |spellfile.vim| plugin is active and you use a language name
6237 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6238 will ask you if you want to download the file.
6239
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006240 After this option has been set successfully, Vim will source the files
6241 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006242 up to the first comma, dot or underscore.
6243 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006244
6245
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006246 *'spellsuggest'* *'sps'*
6247'spellsuggest' 'sps' string (default "best")
6248 global
6249 {not in Vi}
6250 {not available when compiled without the |+syntax|
6251 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006252 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006253 the |spellsuggest()| function. This is a comma-separated list of
6254 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006255
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006256 best Internal method that works best for English. Finds
6257 changes like "fast" and uses a bit of sound-a-like
6258 scoring to improve the ordering.
6259
6260 double Internal method that uses two methods and mixes the
6261 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006262 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006263 word. That only works when the language specifies
6264 sound folding. Can be slow and doesn't always give
6265 better results.
6266
6267 fast Internal method that only checks for simple changes:
6268 character inserts/deletes/swaps. Works well for
6269 simple typing mistakes.
6270
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006271 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006272 Not used for |spellsuggest()|. The number of
6273 suggestions is never more than the value of 'lines'
6274 minus two.
6275
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006276 file:{filename} Read file {filename}, which must have two columns,
6277 separated by a slash. The first column contains the
6278 bad word, the second column the suggested good word.
6279 Example:
6280 theribal/terrible ~
6281 Use this for common mistakes that do not appear at the
6282 top of the suggestion list with the internal methods.
6283 Lines without a slash are ignored, use this for
6284 comments.
6285 The file is used for all languages.
6286
6287 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6288 trouble with spaces. |v:val| holds the badly spelled
6289 word. The expression must evaluate to a List of
6290 Lists, each with a suggestion and a score.
6291 Example:
6292 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006293 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006294 internal methods use. A lower score is better.
6295 This may invoke |spellsuggest()| if you temporarily
6296 set 'spellsuggest' to exclude the "expr:" part.
6297 Errors are silently ignored, unless you set the
6298 'verbose' option to a non-zero value.
6299
6300 Only one of "best", "double" or "fast" may be used. The others may
6301 appear several times in any order. Example: >
6302 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6303<
6304 This option cannot be set from a |modeline| or in the |sandbox|, for
6305 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006306
6307
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6309'splitbelow' 'sb' boolean (default off)
6310 global
6311 {not in Vi}
6312 {not available when compiled without the +windows
6313 feature}
6314 When on, splitting a window will put the new window below the current
6315 one. |:split|
6316
6317 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6318'splitright' 'spr' boolean (default off)
6319 global
6320 {not in Vi}
6321 {not available when compiled without the +vertsplit
6322 feature}
6323 When on, splitting a window will put the new window right of the
6324 current one. |:vsplit|
6325
6326 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6327'startofline' 'sol' boolean (default on)
6328 global
6329 {not in Vi}
6330 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006331 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006332 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006333 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006334 with a linewise operator, with "%" with a count and to buffer changing
6335 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6336 only has a line number, e.g., ":25" or ":+".
6337 In case of buffer changing commands the cursor is placed at the column
6338 where it was the last time the buffer was edited.
6339 NOTE: This option is set when 'compatible' is set.
6340
6341 *'statusline'* *'stl'* *E540* *E541* *E542*
6342'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006343 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344 {not in Vi}
6345 {not available when compiled without the |+statusline|
6346 feature}
6347 When nonempty, this option determines the content of the status line.
6348 Also see |status-line|.
6349
6350 The option consists of printf style '%' items interspersed with
6351 normal text. Each status line item is of the form:
6352 %-0{minwid}.{maxwid}{item}
6353 All fields except the {item} is optional. A single percent sign can
6354 be given as "%%". Up to 80 items can be specified.
6355
Bram Moolenaar238a5642006-02-21 22:12:05 +00006356 When the option starts with "%!" then it is used as an expression,
6357 evaluated and the result is used as the option value. Example: >
6358 :set statusline=%!MyStatusLine()
6359< The result can contain %{} items that will be evaluated too.
6360
6361 When there is error while evaluating the option then it will be made
6362 empty to avoid further errors. Otherwise screen updating would loop.
6363
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 Note that the only effect of 'ruler' when this option is set (and
6365 'laststatus' is 2) is controlling the output of |CTRL-G|.
6366
6367 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006368 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006369 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006370 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006371 minwid Minimum width of the item, padding as set by '-' & '0'.
6372 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006373 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 on the left for text items. Numeric items will be
6375 shifted down to maxwid-2 digits followed by '>'number
6376 where number is the amount of missing digits, much like
6377 an exponential notation.
6378 item A one letter code as described below.
6379
6380 Following is a description of the possible statusline items. The
6381 second character in "item" is the type:
6382 N for number
6383 S for string
6384 F for flags as described below
6385 - not applicable
6386
6387 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006388 f S Path to the file in the buffer, as typed or relative to current
6389 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006390 F S Full path to the file in the buffer.
6391 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006392 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006394 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006396 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006398 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006400 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6402 {not available when compiled without |+autocmd| feature}
6403 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6404 being used: "<keymap>"
6405 n N Buffer number.
6406 b N Value of byte under cursor.
6407 B N As above, in hexadecimal.
6408 o N Byte number in file of byte under cursor, first byte is 1.
6409 Mnemonic: Offset from start of file (with one added)
6410 {not available when compiled without |+byte_offset| feature}
6411 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006412 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006413 l N Line number.
6414 L N Number of lines in buffer.
6415 c N Column number.
6416 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006417 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 p N Percentage through file in lines as in |CTRL-G|.
6419 P S Percentage through file of displayed window. This is like the
6420 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006421 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006423 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006424 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425 ( - Start of item group. Can be used for setting the width and
6426 alignment of a section. Must be followed by %) somewhere.
6427 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006428 T N For 'tabline': start of tab page N label. Use %T after the last
6429 label. This information is used for mouse clicks.
6430 X N For 'tabline': start of close tab N label. Use %X after the
6431 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6432 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 < - Where to truncate line if too long. Default is at the start.
6434 No width fields allowed.
6435 = - Separation point between left and right aligned items.
6436 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006437 # - Set highlight group. The name must follow and then a # again.
6438 Thus use %#HLname# for highlight group HLname. The same
6439 highlighting is used, also for the statusline of non-current
6440 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006442 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443 The difference between User{N} and StatusLine will be applied
6444 to StatusLineNC for the statusline of non-current windows.
6445 The number N must be between 1 and 9. See |hl-User1..9|
6446
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006447 When displaying a flag, Vim removes the leading comma, if any, when
6448 that flag comes right after plaintext. This will make a nice display
6449 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450
Bram Moolenaar582fd852005-03-28 20:58:01 +00006451 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452 not set) and a minwid is not set for the group, the whole group will
6453 become empty. This will make a group like the following disappear
6454 completely from the statusline when none of the flags are set. >
6455 :set statusline=...%(\ [%M%R%H]%)...
6456<
6457 Beware that an expression is evaluated each and every time the status
6458 line is displayed. The current buffer and current window will be set
6459 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006460 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006462 real current buffer.
6463
6464 The 'statusline' option may be evaluated in the |sandbox|, see
6465 |sandbox-option|.
6466
6467 It is not allowed to change text or jump to another window while
6468 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469
6470 If the statusline is not updated when you want it (e.g., after setting
6471 a variable that's used in an expression), you can force an update by
6472 setting an option without changing its value. Example: >
6473 :let &ro = &ro
6474
6475< A result of all digits is regarded a number for display purposes.
6476 Otherwise the result is taken as flag text and applied to the rules
6477 described above.
6478
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006479 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6481 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6482
6483 Examples:
6484 Emulate standard status line with 'ruler' set >
6485 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6486< Similar, but add ASCII value of char under the cursor (like "ga") >
6487 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6488< Display byte count and byte value, modified flag in red. >
6489 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6490 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6491< Display a ,GZ flag if a compressed file is loaded >
6492 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6493< In the |:autocmd|'s: >
6494 :let b:gzflag = 1
6495< And: >
6496 :unlet b:gzflag
6497< And define this function: >
6498 :function VarExists(var, val)
6499 : if exists(a:var) | return a:val | else | return '' | endif
6500 :endfunction
6501<
6502 *'suffixes'* *'su'*
6503'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6504 global
6505 {not in Vi}
6506 Files with these suffixes get a lower priority when multiple files
6507 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006508 suffixes. Spaces after the comma are ignored. A dot is also seen as
6509 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 separator, precede it with a backslash (see |option-backslash| about
6511 including spaces and backslashes).
6512 See 'wildignore' for completely ignoring files.
6513 The use of |:set+=| and |:set-=| is preferred when adding or removing
6514 suffixes from the list. This avoids problems when a future version
6515 uses another default.
6516
6517 *'suffixesadd'* *'sua'*
6518'suffixesadd' 'sua' string (default "")
6519 local to buffer
6520 {not in Vi}
6521 {not available when compiled without the
6522 |+file_in_path| feature}
6523 Comma separated list of suffixes, which are used when searching for a
6524 file for the "gf", "[I", etc. commands. Example: >
6525 :set suffixesadd=.java
6526<
6527 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6528'swapfile' 'swf' boolean (default on)
6529 local to buffer
6530 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006531 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 swapfile is not wanted for a specific buffer. For example, with
6533 confidential information that even root must not be able to access.
6534 Careful: All text will be in memory:
6535 - Don't use this for big files.
6536 - Recovery will be impossible!
6537 A swapfile will only be present when |'updatecount'| is non-zero and
6538 'swapfile' is set.
6539 When 'swapfile' is reset, the swap file for the current buffer is
6540 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6541 non-zero, a swap file is immediately created.
6542 Also see |swap-file| and |'swapsync'|.
6543
6544 This option is used together with 'bufhidden' and 'buftype' to
6545 specify special kinds of buffers. See |special-buffers|.
6546
6547 *'swapsync'* *'sws'*
6548'swapsync' 'sws' string (default "fsync")
6549 global
6550 {not in Vi}
6551 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006552 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 When this option is empty parts of the swap file may be in memory and
6554 not written to disk. When the system crashes you may lose more work.
6555 On Unix the system does a sync now and then without Vim asking for it,
6556 so the disadvantage of setting this option off is small. On some
6557 systems the swap file will not be written at all. For a unix system
6558 setting it to "sync" will use the sync() call instead of the default
6559 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006560 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561
6562 *'switchbuf'* *'swb'*
6563'switchbuf' 'swb' string (default "")
6564 global
6565 {not in Vi}
6566 This option controls the behavior when switching between buffers.
6567 Possible values (comma separated list):
6568 useopen If included, jump to the first open window that
6569 contains the specified buffer (if there is one).
6570 Otherwise: Do not examine other windows.
6571 This setting is checked with |quickfix| commands, when
6572 jumping to errors (":cc", ":cn", "cp", etc.). It is
6573 also used in all buffer related split commands, for
6574 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006575 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006576 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006578 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006580 newtab Like "split", but open a new tab page. Overrules
6581 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006583 *'synmaxcol'* *'smc'*
6584'synmaxcol' 'smc' number (default 3000)
6585 local to buffer
6586 {not in Vi}
6587 {not available when compiled without the |+syntax|
6588 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006589 Maximum column in which to search for syntax items. In long lines the
6590 text after this column is not highlighted and following lines may not
6591 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006592 This helps to avoid very slow redrawing for an XML file that is one
6593 long line.
6594 Set to zero to remove the limit.
6595
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596 *'syntax'* *'syn'*
6597'syntax' 'syn' string (default empty)
6598 local to buffer
6599 {not in Vi}
6600 {not available when compiled without the |+syntax|
6601 feature}
6602 When this option is set, the syntax with this name is loaded, unless
6603 syntax highlighting has been switched off with ":syntax off".
6604 Otherwise this option does not always reflect the current syntax (the
6605 b:current_syntax variable does).
6606 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006607 not automatically recognized. Example, in an IDL file:
6608 /* vim: set syntax=idl : */ ~
6609 When a dot appears in the value then this separates two filetype
6610 names. Example:
6611 /* vim: set syntax=c.doxygen : */ ~
6612 This will use the "c" syntax first, then the "doxygen" syntax.
6613 Note that the second one must be prepared to be loaded as an addition,
6614 otherwise it will be skipped. More than one dot may appear.
6615 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 :set syntax=OFF
6617< To switch syntax highlighting on according to the current value of the
6618 'filetype' option: >
6619 :set syntax=ON
6620< What actually happens when setting the 'syntax' option is that the
6621 Syntax autocommand event is triggered with the value as argument.
6622 This option is not copied to another buffer, independent of the 's' or
6623 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006624 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006625
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006626 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006627'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006628 global
6629 {not in Vi}
6630 {not available when compiled without the +windows
6631 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006632 When nonempty, this option determines the content of the tab pages
6633 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006634 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006635
6636 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006637 option and only when there is no GUI tab line. When 'e' is in
6638 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6639 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006640
6641 The value is evaluated like with 'statusline'. You can use
6642 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006643 the text to be displayed. Use "%1T" for the first label, "%2T" for
6644 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006645
6646 Keep in mind that only one of the tab pages is the current one, others
6647 are invisible and you can't jump to their windows.
6648
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006649
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006650 *'tabpagemax'* *'tpm'*
6651'tabpagemax' 'tpm' number (default 10)
6652 global
6653 {not in Vi}
6654 {not available when compiled without the +windows
6655 feature}
6656 Maximum number of tab pages to be opened by the |-p| command line
6657 argument or the ":tab all" command. |tabpage|
6658
6659
6660 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661'tabstop' 'ts' number (default 8)
6662 local to buffer
6663 Number of spaces that a <Tab> in the file counts for. Also see
6664 |:retab| command, and 'softtabstop' option.
6665
6666 Note: Setting 'tabstop' to any other value than 8 can make your file
6667 appear wrong in many places (e.g., when printing it).
6668
6669 There are four main ways to use tabs in Vim:
6670 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6671 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006672 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 behave like a tab appears every 4 (or 3) characters.
6674 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6675 'expandtab'. This way you will always insert spaces. The
6676 formatting will never be messed up when 'tabstop' is changed.
6677 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006678 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006679 works when using Vim to edit the file.
6680 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6681 'noexpandtab'. This should then work (for initial indents only)
6682 for any tabstop setting that people use. It might be nice to have
6683 tabs after the first non-blank inserted as spaces if you do this
6684 though. Otherwise aligned comments will be wrong when 'tabstop' is
6685 changed.
6686
6687 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6688'tagbsearch' 'tbs' boolean (default on)
6689 global
6690 {not in Vi}
6691 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006692 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 searching makes searching for a tag a LOT faster, but a linear search
6694 will find more tags if the tags file wasn't properly sorted.
6695 Vim normally assumes that your tags files are sorted, or indicate that
6696 they are not sorted. Only when this is not the case does the
6697 'tagbsearch' option need to be switched off.
6698
6699 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006700 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 certain files, or retry all files with a linear search. When
6702 'tagbsearch' is off, only a linear search is done.
6703
6704 Linear searching is done anyway, for one file, when Vim finds a line
6705 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006706 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707< [The whitespace before and after the '0' must be a single <Tab>]
6708
6709 When a binary search was done and no match was found in any of the
6710 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6711 instead of a normal tag name, a retry is done with a linear search.
6712 Tags in unsorted tags files, and matches with different case will only
6713 be found in the retry.
6714
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006715 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 linear search can be avoided for the 'ignorecase' case. Use a value
6717 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6718 case-fold sorted with the -f switch to "sort" in most unices, as in
6719 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006720 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6721 for this as well. Note that case must be folded to uppercase for this
6722 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723
6724 When 'tagbsearch' is off, tags searching is slower when a full match
6725 exists, but faster when no full match exists. Tags in unsorted tags
6726 files may only be found with 'tagbsearch' off.
6727 When the tags file is not sorted, or sorted in a wrong way (not on
6728 ASCII byte value), 'tagbsearch' should be off, or the line given above
6729 must be included in the tags file.
6730 This option doesn't affect commands that find all matching tags (e.g.,
6731 command-line completion and ":help").
6732 {Vi: always uses binary search in some versions}
6733
6734 *'taglength'* *'tl'*
6735'taglength' 'tl' number (default 0)
6736 global
6737 If non-zero, tags are significant up to this number of characters.
6738
6739 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6740'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6741 global
6742 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006743 If on and using a tags file in another directory, file names in that
6744 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745 NOTE: This option is set to the Vi default value when 'compatible' is
6746 set and to the Vim default value when 'compatible' is reset.
6747
6748 *'tags'* *'tag'* *E433*
6749'tags' 'tag' string (default "./tags,tags", when compiled with
6750 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6751 global or local to buffer |global-local|
6752 Filenames for the tag command, separated by spaces or commas. To
6753 include a space or comma in a file name, precede it with a backslash
6754 (see |option-backslash| about including spaces and backslashes).
6755 When a file name starts with "./", the '.' is replaced with the path
6756 of the current file. But only when the 'd' flag is not included in
6757 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6758 |tags-option|.
6759 "*", "**" and other wildcards can be used to search for tags files in
6760 a directory tree. See |file-searching|. {not available when compiled
6761 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006762 The |tagfiles()| function can be used to get a list of the file names
6763 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6765 files are also supported. They are automatically recognized. The
6766 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6767 differences are ignored (MS-Windows). |emacs-tags|
6768 The use of |:set+=| and |:set-=| is preferred when adding or removing
6769 file names from the list. This avoids problems when a future version
6770 uses another default.
6771 {Vi: default is "tags /usr/lib/tags"}
6772
6773 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6774'tagstack' 'tgst' boolean (default on)
6775 global
6776 {not in all versions of Vi}
6777 When on, the |tagstack| is used normally. When off, a ":tag" or
6778 ":tselect" command with an argument will not push the tag onto the
6779 tagstack. A following ":tag" without an argument, a ":pop" command or
6780 any other command that uses the tagstack will use the unmodified
6781 tagstack, but does change the pointer to the active entry.
6782 Resetting this option is useful when using a ":tag" command in a
6783 mapping which should not change the tagstack.
6784
6785 *'term'* *E529* *E530* *E531*
6786'term' string (default is $TERM, if that fails:
6787 in the GUI: "builtin_gui"
6788 on Amiga: "amiga"
6789 on BeOS: "beos-ansi"
6790 on Mac: "mac-ansi"
6791 on MiNT: "vt52"
6792 on MS-DOS: "pcterm"
6793 on OS/2: "os2ansi"
6794 on Unix: "ansi"
6795 on VMS: "ansi"
6796 on Win 32: "win32")
6797 global
6798 Name of the terminal. Used for choosing the terminal control
6799 characters. Environment variables are expanded |:set_env|.
6800 For example: >
6801 :set term=$TERM
6802< See |termcap|.
6803
6804 *'termbidi'* *'tbidi'*
6805 *'notermbidi'* *'notbidi'*
6806'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6807 global
6808 {not in Vi}
6809 {only available when compiled with the |+arabic|
6810 feature}
6811 The terminal is in charge of Bi-directionality of text (as specified
6812 by Unicode). The terminal is also expected to do the required shaping
6813 that some languages (such as Arabic) require.
6814 Setting this option implies that 'rightleft' will not be set when
6815 'arabic' is set and the value of 'arabicshape' will be ignored.
6816 Note that setting 'termbidi' has the immediate effect that
6817 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6818 This option is reset when the GUI is started.
6819 For further details see |arabic.txt|.
6820
6821 *'termencoding'* *'tenc'*
6822'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6823 Macintosh GUI: "macroman")
6824 global
6825 {only available when compiled with the |+multi_byte|
6826 feature}
6827 {not in Vi}
6828 Encoding used for the terminal. This specifies what character
6829 encoding the keyboard produces and the display will understand. For
6830 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006831 display). Except for the Mac when 'macatsui' is off, then
6832 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833 In the Win32 console version the default value is the console codepage
6834 when it differs from the ANSI codepage.
6835 *E617*
6836 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6837 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6838 Any attempts to set a different value will be rejected, and an error
6839 message is shown.
6840 For the Win32 GUI 'termencoding' is not used for typed characters,
6841 because the Win32 system always passes Unicode characters.
6842 When empty, the same encoding is used as for the 'encoding' option.
6843 This is the normal value.
6844 Not all combinations for 'termencoding' and 'encoding' are valid. See
6845 |encoding-table|.
6846 The value for this option must be supported by internal conversions or
6847 iconv(). When this is not possible no conversion will be done and you
6848 will probably experience problems with non-ASCII characters.
6849 Example: You are working with the locale set to euc-jp (Japanese) and
6850 want to edit a UTF-8 file: >
6851 :let &termencoding = &encoding
6852 :set encoding=utf-8
6853< You need to do this when your system has no locale support for UTF-8.
6854
6855 *'terse'* *'noterse'*
6856'terse' boolean (default off)
6857 global
6858 When set: Add 's' flag to 'shortmess' option (this makes the message
6859 for a search that hits the start or end of the file not being
6860 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6861 shortens a lot of messages}
6862
6863 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6864'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6865 global
6866 {not in Vi}
6867 This option is obsolete. Use 'fileformats'.
6868 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6869 set to the default value for the current system. When 'textauto' is
6870 reset, 'fileformats' is made empty.
6871 NOTE: This option is set to the Vi default value when 'compatible' is
6872 set and to the Vim default value when 'compatible' is reset.
6873
6874 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6875'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6876 others: default off)
6877 local to buffer
6878 {not in Vi}
6879 This option is obsolete. Use 'fileformat'.
6880 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6881 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6882 "unix".
6883
6884 *'textwidth'* *'tw'*
6885'textwidth' 'tw' number (default 0)
6886 local to buffer
6887 {not in Vi}
6888 Maximum width of text that is being inserted. A longer line will be
6889 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006890 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6891 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00006893 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 NOTE: This option is set to 0 when 'compatible' is set.
6895
6896 *'thesaurus'* *'tsr'*
6897'thesaurus' 'tsr' string (default "")
6898 global or local to buffer |global-local|
6899 {not in Vi}
6900 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006901 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 the file should contain words with similar meaning, separated by
6903 non-keyword characters (white space is preferred). Maximum line
6904 length is 510 bytes.
6905 To obtain a file to be used here, check out the wordlist FAQ at
6906 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006907 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 after a comma are ignored, otherwise spaces are included in the file
6909 name. See |option-backslash| about using backslashes.
6910 The use of |:set+=| and |:set-=| is preferred when adding or removing
6911 directories from the list. This avoids problems when a future version
6912 uses another default.
6913 Backticks cannot be used in this option for security reasons.
6914
6915 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6916'tildeop' 'top' boolean (default off)
6917 global
6918 {not in Vi}
6919 When on: The tilde command "~" behaves like an operator.
6920 NOTE: This option is reset when 'compatible' is set.
6921
6922 *'timeout'* *'to'* *'notimeout'* *'noto'*
6923'timeout' 'to' boolean (default on)
6924 global
6925 *'ttimeout'* *'nottimeout'*
6926'ttimeout' boolean (default off)
6927 global
6928 {not in Vi}
6929 These two options together determine the behavior when part of a
6930 mapped key sequence or keyboard code has been received:
6931
6932 'timeout' 'ttimeout' action ~
6933 off off do not time out
6934 on on or off time out on :mappings and key codes
6935 off on time out on key codes
6936
6937 If both options are off, Vim will wait until either the complete
6938 mapping or key sequence has been received, or it is clear that there
6939 is no mapping or key sequence for the received characters. For
6940 example: if you have mapped "vl" and Vim has received 'v', the next
6941 character is needed to see if the 'v' is followed by an 'l'.
6942 When one of the options is on, Vim will wait for about 1 second for
6943 the next character to arrive. After that the already received
6944 characters are interpreted as single characters. The waiting time can
6945 be changed with the 'timeoutlen' option.
6946 On slow terminals or very busy systems timing out may cause
6947 malfunctioning cursor keys. If both options are off, Vim waits
6948 forever after an entered <Esc> if there are key codes that start
6949 with <Esc>. You will have to type <Esc> twice. If you do not have
6950 problems with key codes, but would like to have :mapped key
6951 sequences not timing out in 1 second, set the 'ttimeout' option and
6952 reset the 'timeout' option.
6953
6954 NOTE: 'ttimeout' is reset when 'compatible' is set.
6955
6956 *'timeoutlen'* *'tm'*
6957'timeoutlen' 'tm' number (default 1000)
6958 global
6959 {not in all versions of Vi}
6960 *'ttimeoutlen'* *'ttm'*
6961'ttimeoutlen' 'ttm' number (default -1)
6962 global
6963 {not in Vi}
6964 The time in milliseconds that is waited for a key code or mapped key
6965 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6966 when part of a command has been typed.
6967 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6968 different timeout value for key codes is desired set 'ttimeoutlen' to
6969 a non-negative number.
6970
6971 ttimeoutlen mapping delay key code delay ~
6972 < 0 'timeoutlen' 'timeoutlen'
6973 >= 0 'timeoutlen' 'ttimeoutlen'
6974
6975 The timeout only happens when the 'timeout' and 'ttimeout' options
6976 tell so. A useful setting would be >
6977 :set timeout timeoutlen=3000 ttimeoutlen=100
6978< (time out on mapping after three seconds, time out on key codes after
6979 a tenth of a second).
6980
6981 *'title'* *'notitle'*
6982'title' boolean (default off, on when title can be restored)
6983 global
6984 {not in Vi}
6985 {not available when compiled without the |+title|
6986 feature}
6987 When on, the title of the window will be set to the value of
6988 'titlestring' (if it is not empty), or to:
6989 filename [+=-] (path) - VIM
6990 Where:
6991 filename the name of the file being edited
6992 - indicates the file cannot be modified, 'ma' off
6993 + indicates the file was modified
6994 = indicates the file is read-only
6995 =+ indicates the file is read-only and modified
6996 (path) is the path of the file being edited
6997 - VIM the server name |v:servername| or "VIM"
6998 Only works if the terminal supports setting window titles
6999 (currently Amiga console, Win32 console, all GUI versions and
7000 terminals with a non- empty 't_ts' option - these are Unix xterm and
7001 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7002 *X11*
7003 When Vim was compiled with HAVE_X11 defined, the original title will
7004 be restored if possible. The output of ":version" will include "+X11"
7005 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7006 works for the icon name |'icon'|.
7007 But: When Vim was started with the |-X| argument, restoring the title
7008 will not work (except in the GUI).
7009 If the title cannot be restored, it is set to the value of 'titleold'.
7010 You might want to restore the title outside of Vim then.
7011 When using an xterm from a remote machine you can use this command:
7012 rsh machine_name xterm -display $DISPLAY &
7013 then the WINDOWID environment variable should be inherited and the
7014 title of the window should change back to what it should be after
7015 exiting Vim.
7016
7017 *'titlelen'*
7018'titlelen' number (default 85)
7019 global
7020 {not in Vi}
7021 {not available when compiled without the |+title|
7022 feature}
7023 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007024 title. When the title is longer, only the end of the path name is
7025 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007026 Using a percentage makes this adapt to the width of the window. But
7027 it won't work perfectly, because the actual number of characters
7028 available also depends on the font used and other things in the title
7029 bar. When 'titlelen' is zero the full path is used. Otherwise,
7030 values from 1 to 30000 percent can be used.
7031 'titlelen' is also used for the 'titlestring' option.
7032
7033 *'titleold'*
7034'titleold' string (default "Thanks for flying Vim")
7035 global
7036 {not in Vi}
7037 {only available when compiled with the |+title|
7038 feature}
7039 This option will be used for the window title when exiting Vim if the
7040 original title cannot be restored. Only happens if 'title' is on or
7041 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007042 This option cannot be set from a |modeline| or in the |sandbox|, for
7043 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 *'titlestring'*
7045'titlestring' string (default "")
7046 global
7047 {not in Vi}
7048 {not available when compiled without the |+title|
7049 feature}
7050 When this option is not empty, it will be used for the title of the
7051 window. This happens only when the 'title' option is on.
7052 Only works if the terminal supports setting window titles (currently
7053 Amiga console, Win32 console, all GUI versions and terminals with a
7054 non-empty 't_ts' option).
7055 When Vim was compiled with HAVE_X11 defined, the original title will
7056 be restored if possible |X11|.
7057 When this option contains printf-style '%' items, they will be
7058 expanded according to the rules used for 'statusline'.
7059 Example: >
7060 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7061 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7062< The value of 'titlelen' is used to align items in the middle or right
7063 of the available space.
7064 Some people prefer to have the file name first: >
7065 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7066< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007067 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068 separating space only when needed.
7069 NOTE: Use of special characters in 'titlestring' may cause the display
7070 to be garbled (e.g., when it contains a CR or NL character).
7071 {not available when compiled without the |+statusline| feature}
7072
7073 *'toolbar'* *'tb'*
7074'toolbar' 'tb' string (default "icons,tooltips")
7075 global
7076 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7077 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007078 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 possible values are:
7080 icons Toolbar buttons are shown with icons.
7081 text Toolbar buttons shown with text.
7082 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007083 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 tooltips Tooltips are active for toolbar buttons.
7085 Tooltips refer to the popup help text which appears after the mouse
7086 cursor is placed over a toolbar button for a brief moment.
7087
7088 If you want the toolbar to be shown with icons as well as text, do the
7089 following: >
7090 :set tb=icons,text
7091< Motif and Athena cannot display icons and text at the same time. They
7092 will show icons if both are requested.
7093
7094 If none of the strings specified in 'toolbar' are valid or if
7095 'toolbar' is empty, this option is ignored. If you want to disable
7096 the toolbar, you need to set the 'guioptions' option. For example: >
7097 :set guioptions-=T
7098< Also see |gui-toolbar|.
7099
7100 *'toolbariconsize'* *'tbis'*
7101'toolbariconsize' 'tbis' string (default "small")
7102 global
7103 {not in Vi}
7104 {only in the GTK+ 2 GUI}
7105 Controls the size of toolbar icons. The possible values are:
7106 tiny Use tiny toolbar icons.
7107 small Use small toolbar icons (default).
7108 medium Use medium-sized toolbar icons.
7109 large Use large toolbar icons.
7110 The exact dimensions in pixels of the various icon sizes depend on
7111 the current theme. Common dimensions are large=32x32, medium=24x24,
7112 small=20x20 and tiny=16x16.
7113
7114 If 'toolbariconsize' is empty, the global default size as determined
7115 by user preferences or the current theme is used.
7116
7117 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7118'ttybuiltin' 'tbi' boolean (default on)
7119 global
7120 {not in Vi}
7121 When on, the builtin termcaps are searched before the external ones.
7122 When off the builtin termcaps are searched after the external ones.
7123 When this option is changed, you should set the 'term' option next for
7124 the change to take effect, for example: >
7125 :set notbi term=$TERM
7126< See also |termcap|.
7127 Rationale: The default for this option is "on", because the builtin
7128 termcap entries are generally better (many systems contain faulty
7129 xterm entries...).
7130
7131 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7132'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7133 sun-cmd, screen, rxvt, dtterm or
7134 iris-ansi; also on when running Vim in
7135 a DOS console)
7136 global
7137 {not in Vi}
7138 Indicates a fast terminal connection. More characters will be sent to
7139 the screen for redrawing, instead of using insert/delete line
7140 commands. Improves smoothness of redrawing when there are multiple
7141 windows and the terminal does not support a scrolling region.
7142 Also enables the extra writing of characters at the end of each screen
7143 line for lines that wrap. This helps when using copy/paste with the
7144 mouse in an xterm and other terminals.
7145
7146 *'ttymouse'* *'ttym'*
7147'ttymouse' 'ttym' string (default depends on 'term')
7148 global
7149 {not in Vi}
7150 {only in Unix and VMS, doesn't work in the GUI; not
7151 available when compiled without |+mouse|}
7152 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007153 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154 *xterm-mouse*
7155 xterm xterm-like mouse handling. The mouse generates
7156 "<Esc>[Mscr", where "scr" is three bytes:
7157 "s" = button state
7158 "c" = column plus 33
7159 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007160 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007161 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 xterm2 Works like "xterm", but with the xterm reporting the
7163 mouse position while the mouse is dragged. This works
7164 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007165 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 work. See below for how Vim detects this
7167 automatically.
7168 *netterm-mouse*
7169 netterm NetTerm mouse handling. The mouse generates
7170 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7171 for the row and column.
7172 *dec-mouse*
7173 dec DEC terminal mouse handling. The mouse generates a
7174 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007175 This is also available for an Xterm, if it was
7176 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 *jsbterm-mouse*
7178 jsbterm JSB term mouse handling.
7179 *pterm-mouse*
7180 pterm QNX pterm mouse handling.
7181
7182 The mouse handling must be enabled at compile time |+mouse_xterm|
7183 |+mouse_dec| |+mouse_netterm|.
7184 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7185 recognized, if enabled at compile time. DEC terminal mouse codes
7186 are recognized if enabled at compile time, and 'ttymouse' is not
7187 "xterm" (because the xterm and dec mouse codes conflict).
7188 This option is automatically set to "xterm", when the 'term' option is
7189 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7190 or "xterm2" already. The main use of this option is to set it to
7191 "xterm", when the terminal name doesn't start with "xterm", but it can
7192 handle xterm mouse codes.
7193 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007194 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007195 feature and if |t_RV| is set to the escape sequence to request the
7196 xterm version number. Otherwise "xterm2" must be set explicitly.
7197 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7198 t_RV to an empty string: >
7199 :set t_RV=
7200<
7201 *'ttyscroll'* *'tsl'*
7202'ttyscroll' 'tsl' number (default 999)
7203 global
7204 Maximum number of lines to scroll the screen. If there are more lines
7205 to scroll the window is redrawn. For terminals where scrolling is
7206 very slow and redrawing is not slow this can be set to a small number,
7207 e.g., 3, to speed up displaying.
7208
7209 *'ttytype'* *'tty'*
7210'ttytype' 'tty' string (default from $TERM)
7211 global
7212 Alias for 'term', see above.
7213
7214 *'undolevels'* *'ul'*
7215'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7216 Win32 and OS/2)
7217 global
7218 {not in Vi}
7219 Maximum number of changes that can be undone. Since undo information
7220 is kept in memory, higher numbers will cause more memory to be used
7221 (nevertheless, a single change can use an unlimited amount of memory).
7222 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7223 itself: >
7224 set ul=0
7225< But you can also get Vi compatibility by including the 'u' flag in
7226 'cpoptions', and still be able to use CTRL-R to repeat undo.
7227 Set to a negative number for no undo at all: >
7228 set ul=-1
7229< This helps when you run out of memory for a single change.
7230 Also see |undo-two-ways|.
7231
7232 *'updatecount'* *'uc'*
7233'updatecount' 'uc' number (default: 200)
7234 global
7235 {not in Vi}
7236 After typing this many characters the swap file will be written to
7237 disk. When zero, no swap file will be created at all (see chapter on
7238 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7239 Vim with the "-n" option, see |startup|. When editing in readonly
7240 mode this option will be initialized to 10000.
7241 The swapfile can be disabled per buffer with |'swapfile'|.
7242 When 'updatecount' is set from zero to non-zero, swap files are
7243 created for all buffers that have 'swapfile' set. When 'updatecount'
7244 is set to zero, existing swap files are not deleted.
7245 Also see |'swapsync'|.
7246 This option has no meaning in buffers where |'buftype'| is "nofile"
7247 or "nowrite".
7248
7249 *'updatetime'* *'ut'*
7250'updatetime' 'ut' number (default 4000)
7251 global
7252 {not in Vi}
7253 If this many milliseconds nothing is typed the swap file will be
7254 written to disk (see |crash-recovery|). Also used for the
7255 |CursorHold| autocommand event.
7256
7257 *'verbose'* *'vbs'*
7258'verbose' 'vbs' number (default 0)
7259 global
7260 {not in Vi, although some versions have a boolean
7261 verbose option}
7262 When bigger than zero, Vim will give messages about what it is doing.
7263 Currently, these messages are given:
7264 >= 1 When the viminfo file is read or written.
7265 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007266 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007267 >= 8 Files for which a group of autocommands is executed.
7268 >= 9 Every executed autocommand.
7269 >= 12 Every executed function.
7270 >= 13 When an exception is thrown, caught, finished, or discarded.
7271 >= 14 Anything pending in a ":finally" clause.
7272 >= 15 Every executed Ex command (truncated at 200 characters).
7273
7274 This option can also be set with the "-V" argument. See |-V|.
7275 This option is also set by the |:verbose| command.
7276
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007277 When the 'verbosefile' option is set then the verbose messages are not
7278 displayed.
7279
7280 *'verbosefile'* *'vfile'*
7281'verbosefile' 'vfile' string (default empty)
7282 global
7283 {not in Vi}
7284 When not empty all messages are written in a file with this name.
7285 When the file exists messages are appended.
7286 Writing to the file ends when Vim exits or when 'verbosefile' is made
7287 empty.
7288 Setting 'verbosefile' to a new value is like making it empty first.
7289 The difference with |:redir| is that verbose messages are not
7290 displayed when 'verbosefile' is set.
7291
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 *'viewdir'* *'vdir'*
7293'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7294 "$VIM/vimfiles/view",
7295 for Unix: "~/.vim/view",
7296 for Macintosh: "$VIM:vimfiles:view"
7297 for VMS: "sys$login:vimfiles/view"
7298 for RiscOS: "Choices:vimfiles/view")
7299 global
7300 {not in Vi}
7301 {not available when compiled without the +mksession
7302 feature}
7303 Name of the directory where to store files for |:mkview|.
7304 This option cannot be set from a |modeline| or in the |sandbox|, for
7305 security reasons.
7306
7307 *'viewoptions'* *'vop'*
7308'viewoptions' 'vop' string (default: "folds,options,cursor")
7309 global
7310 {not in Vi}
7311 {not available when compiled without the +mksession
7312 feature}
7313 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007314 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007315 word save and restore ~
7316 cursor cursor position in file and in window
7317 folds manually created folds, opened/closed folds and local
7318 fold options
7319 options options and mappings local to a window or buffer (not
7320 global values for local options)
7321 slash backslashes in file names replaced with forward
7322 slashes
7323 unix with Unix end-of-line format (single <NL>), even when
7324 on Windows or DOS
7325
7326 "slash" and "unix" are useful on Windows when sharing view files
7327 with Unix. The Unix version of Vim cannot source dos format scripts,
7328 but the Windows version of Vim can source unix format scripts.
7329
7330 *'viminfo'* *'vi'* *E526* *E527* *E528*
7331'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007332 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7333 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7334 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 global
7336 {not in Vi}
7337 {not available when compiled without the |+viminfo|
7338 feature}
7339 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007340 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341 separated list of parameters, each consisting of a single character
7342 identifying the particular parameter, followed by a number or string
7343 which specifies the value of that parameter. If a particular
7344 character is left out, then the default value is used for that
7345 parameter. The following is a list of the identifying characters and
7346 the effect of their value.
7347 CHAR VALUE ~
7348 ! When included, save and restore global variables that start
7349 with an uppercase letter, and don't contain a lowercase
7350 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007351 and "_K_L_M" are not. Only String and Number types are
7352 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007353 " Maximum number of lines saved for each register. Old name of
7354 the '<' item, with the disadvantage that you need to put a
7355 backslash before the ", otherwise it will be recognized as the
7356 start of a comment!
7357 % When included, save and restore the buffer list. If Vim is
7358 started with a file name argument, the buffer list is not
7359 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007360 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361 without a file name and buffers for help files are not written
7362 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007363 When followed by a number, the number specifies the maximum
7364 number of buffers that are stored. Without a number all
7365 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 ' Maximum number of previously edited files for which the marks
7367 are remembered. This parameter must always be included when
7368 'viminfo' is non-empty.
7369 Including this item also means that the |jumplist| and the
7370 |changelist| are stored in the viminfo file.
7371 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007372 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007373 patterns are also saved. When not included, the value of
7374 'history' is used.
7375 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007376 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007377 < Maximum number of lines saved for each register. If zero then
7378 registers are not saved. When not included, all lines are
7379 saved. '"' is the old name for this item.
7380 Also see the 's' item below: limit specified in Kbyte.
7381 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007382 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007383 c When included, convert the text in the viminfo file from the
7384 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007385 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007386 f Whether file marks need to be stored. If zero, file marks ('0
7387 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007388 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389 cursor position (when exiting or when doing ":wviminfo").
7390 h Disable the effect of 'hlsearch' when loading the viminfo
7391 file. When not included, it depends on whether ":nohlsearch"
7392 has been used since the last search command.
7393 n Name of the viminfo file. The name must immediately follow
7394 the 'n'. Must be the last one! If the "-i" argument was
7395 given when starting Vim, that file name overrides the one
7396 given here with 'viminfo'. Environment variables are expanded
7397 when opening the file, not when setting the option.
7398 r Removable media. The argument is a string (up to the next
7399 ','). This parameter can be given several times. Each
7400 specifies the start of a path for which no marks will be
7401 stored. This is to avoid removable media. For MS-DOS you
7402 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7403 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7404 ignored. Maximum length of each 'r' argument is 50
7405 characters.
7406 s Maximum size of an item in Kbyte. If zero then registers are
7407 not saved. Currently only applies to registers. The default
7408 "s10" will exclude registers with more than 10 Kbyte of text.
7409 Also see the '<' item above: line count limit.
7410
7411 Example: >
7412 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7413<
7414 '50 Marks will be remembered for the last 50 files you
7415 edited.
7416 <1000 Contents of registers (up to 1000 lines each) will be
7417 remembered.
7418 s100 Registers with more than 100 Kbyte text are skipped.
7419 :0 Command-line history will not be saved.
7420 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7421 no / Since '/' is not specified, the default will be used,
7422 that is, save all of the search history, and also the
7423 previous search and substitute patterns.
7424 no % The buffer list will not be saved nor read back.
7425 no h 'hlsearch' highlighting will be restored.
7426
7427 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7428 load the contents of the file, this is not done automatically.
7429
7430 This option cannot be set from a |modeline| or in the |sandbox|, for
7431 security reasons.
7432
7433 *'virtualedit'* *'ve'*
7434'virtualedit' 've' string (default "")
7435 global
7436 {not in Vi}
7437 {not available when compiled without the
7438 |+virtualedit| feature}
7439 A comma separated list of these words:
7440 block Allow virtual editing in Visual block mode.
7441 insert Allow virtual editing in Insert mode.
7442 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007443 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007444
Bram Moolenaar071d4272004-06-13 20:20:40 +00007445 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007446 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447 of the line. Useful for selecting a rectangle in Visual mode and
7448 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007449 "onemore" is not the same, it will only allow moving the cursor just
7450 after the last character of the line. This makes some commands more
7451 consistent. Previously the cursor was always past the end of the line
7452 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007453 break some plugins or Vim scripts. For example because |l| can move
7454 the cursor after the last character. Use with care!
7455 Using the |$| command will move to the last character in the line, not
7456 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007457 It doesn't make sense to combine "all" with "onemore", but you will
7458 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459
7460 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7461'visualbell' 'vb' boolean (default off)
7462 global
7463 {not in Vi}
7464 Use visual bell instead of beeping. The terminal code to display the
7465 visual bell is given with 't_vb'. When no beep or flash is wanted,
7466 use ":set vb t_vb=".
7467 Note: When the GUI starts, 't_vb' is reset to its default value. You
7468 might want to set it again in your |gvimrc|.
7469 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7470 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7471 where 40 is the time in msec.
7472 Does not work on the Amiga, you always get a screen flash.
7473 Also see 'errorbells'.
7474
7475 *'warn'* *'nowarn'*
7476'warn' boolean (default on)
7477 global
7478 Give a warning message when a shell command is used while the buffer
7479 has been changed.
7480
7481 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7482'weirdinvert' 'wiv' boolean (default off)
7483 global
7484 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007485 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486 It is provided for backwards compatibility with version 4.x.
7487 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7488 vice versa. Has no effect when the GUI is running.
7489
7490 *'whichwrap'* *'ww'*
7491'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7492 global
7493 {not in Vi}
7494 Allow specified keys that move the cursor left/right to move to the
7495 previous/next line when the cursor is on the first/last character in
7496 the line. Concatenate characters to allow this for these keys:
7497 char key mode ~
7498 b <BS> Normal and Visual
7499 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007500 h "h" Normal and Visual (not recommended)
7501 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502 < <Left> Normal and Visual
7503 > <Right> Normal and Visual
7504 ~ "~" Normal
7505 [ <Left> Insert and Replace
7506 ] <Right> Insert and Replace
7507 For example: >
7508 :set ww=<,>,[,]
7509< allows wrap only when cursor keys are used.
7510 When the movement keys are used in combination with a delete or change
7511 operator, the <EOL> also counts for a character. This makes "3h"
7512 different from "3dh" when the cursor crosses the end of a line. This
7513 is also true for "x" and "X", because they do the same as "dl" and
7514 "dh". If you use this, you may also want to use the mapping
7515 ":map <BS> X" to make backspace delete the character in front of the
7516 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007517 When 'l' is included and it is used after an operator at the end of a
7518 line then it will not move to the next line. This makes "dl", "cl",
7519 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520 NOTE: This option is set to the Vi default value when 'compatible' is
7521 set and to the Vim default value when 'compatible' is reset.
7522
7523 *'wildchar'* *'wc'*
7524'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7525 global
7526 {not in Vi}
7527 Character you have to type to start wildcard expansion in the
7528 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007529 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007530 The character is not recognized when used inside a macro. See
7531 'wildcharm' for that.
7532 Although 'wc' is a number option, you can set it to a special key: >
7533 :set wc=<Esc>
7534< NOTE: This option is set to the Vi default value when 'compatible' is
7535 set and to the Vim default value when 'compatible' is reset.
7536
7537 *'wildcharm'* *'wcm'*
7538'wildcharm' 'wcm' number (default: none (0))
7539 global
7540 {not in Vi}
7541 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007542 recognized when used inside a macro. You can find "spare" command-line
7543 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 you'll never actually type 'wildcharm', just use it in mappings that
7545 automatically invoke completion mode, e.g.: >
7546 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007547 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548< Then after typing :ss you can use CTRL-P & CTRL-N.
7549
7550 *'wildignore'* *'wig'*
7551'wildignore' 'wig' string (default "")
7552 global
7553 {not in Vi}
7554 {not available when compiled without the |+wildignore|
7555 feature}
7556 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007557 patterns is ignored when completing file or directory names, and
7558 influences the result of |expand()|, |glob()| and |globpath()| unless
7559 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7561 Also see 'suffixes'.
7562 Example: >
7563 :set wildignore=*.o,*.obj
7564< The use of |:set+=| and |:set-=| is preferred when adding or removing
7565 a pattern from the list. This avoids problems when a future version
7566 uses another default.
7567
7568 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7569'wildmenu' 'wmnu' boolean (default off)
7570 global
7571 {not in Vi}
7572 {not available if compiled without the |+wildmenu|
7573 feature}
7574 When 'wildmenu' is on, command-line completion operates in an enhanced
7575 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7576 the possible matches are shown just above the command line, with the
7577 first match highlighted (overwriting the status line, if there is
7578 one). Keys that show the previous/next match, such as <Tab> or
7579 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7580 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7581 specified. "longest" and "list" do not start "wildmenu" mode.
7582 If there are more matches than can fit in the line, a ">" is shown on
7583 the right and/or a "<" is shown on the left. The status line scrolls
7584 as needed.
7585 The "wildmenu" mode is abandoned when a key is hit that is not used
7586 for selecting a completion.
7587 While the "wildmenu" is active the following keys have special
7588 meanings:
7589
7590 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7591 <Down> - in filename/menu name completion: move into a
7592 subdirectory or submenu.
7593 <CR> - in menu completion, when the cursor is just after a
7594 dot: move into a submenu.
7595 <Up> - in filename/menu name completion: move up into
7596 parent directory or parent menu.
7597
7598 This makes the menus accessible from the console |console-menus|.
7599
7600 If you prefer the <Left> and <Right> keys to move the cursor instead
7601 of selecting a different match, use this: >
7602 :cnoremap <Left> <Space><BS><Left>
7603 :cnoremap <Right> <Space><BS><Right>
7604<
7605 The "WildMenu" highlighting is used for displaying the current match
7606 |hl-WildMenu|.
7607
7608 *'wildmode'* *'wim'*
7609'wildmode' 'wim' string (Vim default: "full")
7610 global
7611 {not in Vi}
7612 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007613 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007614 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007615 first part specifies the behavior for the first use of 'wildchar',
7616 The second part for the second use, etc.
7617 These are the possible values for each part:
7618 "" Complete only the first match.
7619 "full" Complete the next full match. After the last match,
7620 the original string is used and then the first match
7621 again.
7622 "longest" Complete till longest common string. If this doesn't
7623 result in a longer string, use the next part.
7624 "longest:full" Like "longest", but also start 'wildmenu' if it is
7625 enabled.
7626 "list" When more than one match, list all matches.
7627 "list:full" When more than one match, list all matches and
7628 complete first match.
7629 "list:longest" When more than one match, list all matches and
7630 complete till longest common string.
7631 When there is only a single match, it is fully completed in all cases.
7632
7633 Examples: >
7634 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007635< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636 :set wildmode=longest,full
7637< Complete longest common string, then each full match >
7638 :set wildmode=list:full
7639< List all matches and complete each full match >
7640 :set wildmode=list,full
7641< List all matches without completing, then each full match >
7642 :set wildmode=longest,list
7643< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007644 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007645
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007646 *'wildoptions'* *'wop'*
7647'wildoptions' 'wop' string (default "")
7648 global
7649 {not in Vi}
7650 {not available when compiled without the |+wildignore|
7651 feature}
7652 A list of words that change how command line completion is done.
7653 Currently only one word is allowed:
7654 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007655 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007656 is displayed per line. Often used tag kinds are:
7657 d #define
7658 f function
7659 Also see |cmdline-completion|.
7660
Bram Moolenaar071d4272004-06-13 20:20:40 +00007661 *'winaltkeys'* *'wak'*
7662'winaltkeys' 'wak' string (default "menu")
7663 global
7664 {not in Vi}
7665 {only used in Win32, Motif, GTK and Photon GUI}
7666 Some GUI versions allow the access to menu entries by using the ALT
7667 key in combination with a character that appears underlined in the
7668 menu. This conflicts with the use of the ALT key for mappings and
7669 entering special characters. This option tells what to do:
7670 no Don't use ALT keys for menus. ALT key combinations can be
7671 mapped, but there is no automatic handling. This can then be
7672 done with the |:simalt| command.
7673 yes ALT key handling is done by the windowing system. ALT key
7674 combinations cannot be mapped.
7675 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007676 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007677 keys can be mapped.
7678 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7679 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007680 This option is not used for <F10>; on Win32 and with GTK <F10> will
7681 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007683 *'window'* *'wi'*
7684'window' 'wi' number (default screen height - 1)
7685 global
7686 Window height. Do not confuse this with the height of the Vim window,
7687 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007688 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7689 value is smaller than 'lines' minus one. The screen will scroll
7690 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007691 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7692 in a much smarter way, taking care of wrapping lines.
7693 When resizing the Vim window, the value is smaller than 1 or more than
7694 or equal to 'lines' it will be set to 'lines' minus 1.
7695 {Vi also uses the option to specify the number of displayed lines}
7696
Bram Moolenaar071d4272004-06-13 20:20:40 +00007697 *'winheight'* *'wh'* *E591*
7698'winheight' 'wh' number (default 1)
7699 global
7700 {not in Vi}
7701 {not available when compiled without the +windows
7702 feature}
7703 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007704 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007705 focus goes to a window that is smaller, its size is increased, at the
7706 cost of the height of other windows.
7707 Set 'winheight' to a small number for normal editing.
7708 Set it to 999 to make the current window fill most of the screen.
7709 Other windows will be only 'winminheight' high. This has the drawback
7710 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7711 to create only two windows, set the option after startup is done,
7712 using the |VimEnter| event: >
7713 au VimEnter * set winheight=999
7714< Minimum value is 1.
7715 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007716 height of the current window.
7717 'winheight' applies to the current window. Use 'winminheight' to set
7718 the minimal height for other windows.
7719
7720 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7721'winfixheight' 'wfh' boolean (default off)
7722 local to window
7723 {not in Vi}
7724 {not available when compiled without the +windows
7725 feature}
7726 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007727 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7728 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 The height may be changed anyway when running out of room.
7730
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007731 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7732'winfixwidth' 'wfw' boolean (default off)
7733 local to window
7734 {not in Vi}
7735 {not available when compiled without the +windows
7736 feature}
7737 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007738 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007739 The width may be changed anyway when running out of room.
7740
Bram Moolenaar071d4272004-06-13 20:20:40 +00007741 *'winminheight'* *'wmh'*
7742'winminheight' 'wmh' number (default 1)
7743 global
7744 {not in Vi}
7745 {not available when compiled without the +windows
7746 feature}
7747 The minimal height of a window, when it's not the current window.
7748 This is a hard minimum, windows will never become smaller.
7749 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7750 status bar) if necessary. They will return to at least one line when
7751 they become active (since the cursor has to have somewhere to go.)
7752 Use 'winheight' to set the minimal height of the current window.
7753 This option is only checked when making a window smaller. Don't use a
7754 large number, it will cause errors when opening more than a few
7755 windows. A value of 0 to 3 is reasonable.
7756
7757 *'winminwidth'* *'wmw'*
7758'winminwidth' 'wmw' number (default 1)
7759 global
7760 {not in Vi}
7761 {not available when compiled without the +vertsplit
7762 feature}
7763 The minimal width of a window, when it's not the current window.
7764 This is a hard minimum, windows will never become smaller.
7765 When set to zero, windows may be "squashed" to zero columns (i.e. just
7766 a vertical separator) if necessary. They will return to at least one
7767 line when they become active (since the cursor has to have somewhere
7768 to go.)
7769 Use 'winwidth' to set the minimal width of the current window.
7770 This option is only checked when making a window smaller. Don't use a
7771 large number, it will cause errors when opening more than a few
7772 windows. A value of 0 to 12 is reasonable.
7773
7774 *'winwidth'* *'wiw'* *E592*
7775'winwidth' 'wiw' number (default 20)
7776 global
7777 {not in Vi}
7778 {not available when compiled without the +vertsplit
7779 feature}
7780 Minimal number of columns for the current window. This is not a hard
7781 minimum, Vim will use fewer columns if there is not enough room. If
7782 the current window is smaller, its size is increased, at the cost of
7783 the width of other windows. Set it to 999 to make the current window
7784 always fill the screen. Set it to a small number for normal editing.
7785 The width is not adjusted after one of the commands to change the
7786 width of the current window.
7787 'winwidth' applies to the current window. Use 'winminwidth' to set
7788 the minimal width for other windows.
7789
7790 *'wrap'* *'nowrap'*
7791'wrap' boolean (default on)
7792 local to window
7793 {not in Vi}
7794 This option changes how text is displayed. It doesn't change the text
7795 in the buffer, see 'textwidth' for that.
7796 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007797 displaying continues on the next line. When off lines will not wrap
7798 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799 moved to a part that is not shown, the screen will scroll
7800 horizontally.
7801 The line will be broken in the middle of a word if necessary. See
7802 'linebreak' to get the break at a word boundary.
7803 To make scrolling horizontally a bit more useful, try this: >
7804 :set sidescroll=5
7805 :set listchars+=precedes:<,extends:>
7806< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007807 This option can't be set from a |modeline| when the 'diff' option is
7808 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809
7810 *'wrapmargin'* *'wm'*
7811'wrapmargin' 'wm' number (default 0)
7812 local to buffer
7813 Number of characters from the right window border where wrapping
7814 starts. When typing text beyond this limit, an <EOL> will be inserted
7815 and inserting continues on the next line.
7816 Options that add a margin, such as 'number' and 'foldcolumn', cause
7817 the text width to be further reduced. This is Vi compatible.
7818 When 'textwidth' is non-zero, this option is not used.
7819 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7820 and less usefully}
7821
7822 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7823'wrapscan' 'ws' boolean (default on) *E384* *E385*
7824 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007825 Searches wrap around the end of the file. Also applies to |]s| and
7826 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827
7828 *'write'* *'nowrite'*
7829'write' boolean (default on)
7830 global
7831 {not in Vi}
7832 Allows writing files. When not set, writing a file is not allowed.
7833 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007834 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835 argument. Filtering text is still possible, even though this requires
7836 writing a temporary file.
7837
7838 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7839'writeany' 'wa' boolean (default off)
7840 global
7841 Allows writing to any file with no need for "!" override.
7842
7843 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7844'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7845 otherwise)
7846 global
7847 {not in Vi}
7848 Make a backup before overwriting a file. The backup is removed after
7849 the file was successfully written, unless the 'backup' option is
7850 also on. Reset this option if your file system is almost full. See
7851 |backup-table| for another explanation.
7852 When the 'backupskip' pattern matches, a backup is not made anyway.
7853 NOTE: This option is set to the default value when 'compatible' is
7854 set.
7855
7856 *'writedelay'* *'wd'*
7857'writedelay' 'wd' number (default 0)
7858 global
7859 {not in Vi}
7860 The number of microseconds to wait for each character sent to the
7861 screen. When non-zero, characters are sent to the terminal one by
7862 one. For MS-DOS pcterm this does not work. For debugging purposes.
7863
7864 vim:tw=78:ts=8:ft=help:norl: