blob: c54927479cd4c9350ab0b4864f016baaf3f90858 [file] [log] [blame]
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001*options.txt* For Vim version 7.3b. Last change: 2010 Jul 23
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
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001172 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.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001453 You probably want to add this only temporarily,
1454 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001455 Only supported for GTK version 2 and later.
1456 Only available with the |+multi_byte| feature.
1457
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458 exclude:{pattern}
1459 Defines a pattern that is matched against the name of
1460 the terminal 'term'. If there is a match, no
1461 connection will be made to the X server. This is
1462 useful in this situation:
1463 - Running Vim in a console.
1464 - $DISPLAY is set to start applications on another
1465 display.
1466 - You do not want to connect to the X server in the
1467 console, but do want this in a terminal emulator.
1468 To never connect to the X server use: >
1469 exclude:.*
1470< This has the same effect as using the |-X| argument.
1471 Note that when there is no connection to the X server
1472 the window title won't be restored and the clipboard
1473 cannot be accessed.
1474 The value of 'magic' is ignored, {pattern} is
1475 interpreted as if 'magic' was on.
1476 The rest of the option value will be used for
1477 {pattern}, this must be the last entry.
1478
1479 *'cmdheight'* *'ch'*
1480'cmdheight' 'ch' number (default 1)
1481 global
1482 {not in Vi}
1483 Number of screen lines to use for the command-line. Helps avoiding
1484 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001485 The value of this option is stored with the tab page, so that each tab
1486 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487
1488 *'cmdwinheight'* *'cwh'*
1489'cmdwinheight' 'cwh' number (default 7)
1490 global
1491 {not in Vi}
1492 {not available when compiled without the |+vertsplit|
1493 feature}
1494 Number of screen lines to use for the command-line window. |cmdwin|
1495
1496 *'columns'* *'co'* *E594*
1497'columns' 'co' number (default 80 or terminal width)
1498 global
1499 {not in Vi}
1500 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001501 initialization and does not have to be set by hand. Also see
1502 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503 When Vim is running in the GUI or in a resizable window, setting this
1504 option will cause the window size to be changed. When you only want
1505 to use the size for the GUI, put the command in your |gvimrc| file.
1506 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001507 number of columns of the display, the display may be messed up. For
1508 the GUI it is always possible and Vim limits the number of columns to
1509 what fits on the screen. You can use this command to get the widest
1510 window possible: >
1511 :set columns=9999
1512< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513
1514 *'comments'* *'com'* *E524* *E525*
1515'comments' 'com' string (default
1516 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1517 local to buffer
1518 {not in Vi}
1519 {not available when compiled without the |+comments|
1520 feature}
1521 A comma separated list of strings that can start a comment line. See
1522 |format-comments|. See |option-backslash| about using backslashes to
1523 insert a space.
1524
1525 *'commentstring'* *'cms'* *E537*
1526'commentstring' 'cms' string (default "/*%s*/")
1527 local to buffer
1528 {not in Vi}
1529 {not available when compiled without the |+folding|
1530 feature}
1531 A template for a comment. The "%s" in the value is replaced with the
1532 comment text. Currently only used to add markers for folding, see
1533 |fold-marker|.
1534
1535 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001536'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1537 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 global
1539 {not in Vi}
1540 This option has the effect of making Vim either more Vi-compatible, or
1541 make Vim behave in a more useful way.
1542 This is a special kind of option, because when it's set or reset,
1543 other options are also changed as a side effect. CAREFUL: Setting or
1544 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001545 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 set this option in your vimrc file, you should probably put it at the
1547 very start.
1548 By default this option is on and the Vi defaults are used for the
1549 options. This default was chosen for those people who want to use Vim
1550 just like Vi, and don't even (want to) know about the 'compatible'
1551 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001552 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001553 this option is switched off, and all options that have not been
1554 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001555 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001556 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001557 happen for the system-wide vimrc or gvimrc file, nor for a file given
1558 with the |-u| argument). Also see |compatible-default| and
1559 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 You can also set this option with the "-C" argument, and reset it with
1561 "-N". See |-C| and |-N|.
1562 Switching this option off makes the Vim defaults be used for options
1563 that have a different Vi and Vim default value. See the options
1564 marked with a '+' below. Other options are not modified.
1565 At the moment this option is set, several other options will be set
1566 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001567 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 editing.
1569 See also 'cpoptions'.
1570
1571 option + set value effect ~
1572
1573 'allowrevins' off no CTRL-_ command
1574 'backupcopy' Unix: "yes" backup file is a copy
1575 others: "auto" copy or rename backup file
1576 'backspace' "" normal backspace
1577 'backup' off no backup file
1578 'cindent' off no C code indentation
1579 'cedit' + "" no key to open the |cmdwin|
1580 'cpoptions' + (all flags) Vi-compatible flags
1581 'cscopetag' off don't use cscope for ":tag"
1582 'cscopetagorder' 0 see |cscopetagorder|
1583 'cscopeverbose' off see |cscopeverbose|
1584 'digraph' off no digraphs
1585 'esckeys' + off no <Esc>-keys in Insert mode
1586 'expandtab' off tabs not expanded to spaces
1587 'fileformats' + "" no automatic file format detection,
1588 "dos,unix" except for DOS, Windows and OS/2
1589 'formatoptions' + "vt" Vi compatible formatting
1590 'gdefault' off no default 'g' flag for ":s"
1591 'history' + 0 no commandline history
1592 'hkmap' off no Hebrew keyboard mapping
1593 'hkmapp' off no phonetic Hebrew keyboard mapping
1594 'hlsearch' off no highlighting of search matches
1595 'incsearch' off no incremental searching
1596 'indentexpr' "" no indenting by expression
1597 'insertmode' off do not start in Insert mode
1598 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1599 characters and '_'
1600 'joinspaces' on insert 2 spaces after period
1601 'modeline' + off no modelines
1602 'more' + off no pauses in listings
1603 'revins' off no reverse insert
1604 'ruler' off no ruler
1605 'scrolljump' 1 no jump scroll
1606 'scrolloff' 0 no scroll offset
1607 'shiftround' off indent not rounded to shiftwidth
1608 'shortmess' + "" no shortening of messages
1609 'showcmd' + off command characters not shown
1610 'showmode' + off current mode not shown
1611 'smartcase' off no automatic ignore case switch
1612 'smartindent' off no smart indentation
1613 'smarttab' off no smart tab size
1614 'softtabstop' 0 tabs are always 'tabstop' positions
1615 'startofline' on goto startofline with some commands
1616 'tagrelative' + off tag file names are not relative
1617 'textauto' + off no automatic textmode detection
1618 'textwidth' 0 no automatic line wrap
1619 'tildeop' off tilde is not an operator
1620 'ttimeout' off no terminal timeout
1621 'whichwrap' + "" left-right movements don't wrap
1622 'wildchar' + CTRL-E only when the current value is <Tab>
1623 use CTRL-E for cmdline completion
1624 'writebackup' on or off depends on +writebackup feature
1625
1626 *'complete'* *'cpt'* *E535*
1627'complete' 'cpt' string (default: ".,w,b,u,t,i")
1628 local to buffer
1629 {not in Vi}
1630 This option specifies how keyword completion |ins-completion| works
1631 when CTRL-P or CTRL-N are used. It is also used for whole-line
1632 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1633 and the places to scan. It is a comma separated list of flags:
1634 . scan the current buffer ('wrapscan' is ignored)
1635 w scan buffers from other windows
1636 b scan other loaded buffers that are in the buffer list
1637 u scan the unloaded buffers that are in the buffer list
1638 U scan the buffers that are not in the buffer list
1639 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001640 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 k{dict} scan the file {dict}. Several "k" flags can be given,
1642 patterns are valid too. For example: >
1643 :set cpt=k/usr/dict/*,k~/spanish
1644< s scan the files given with the 'thesaurus' option
1645 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1646 are valid too.
1647 i scan current and included files
1648 d scan current and included files for defined name or macro
1649 |i_CTRL-X_CTRL-D|
1650 ] tag completion
1651 t same as "]"
1652
1653 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1654 not executed, this may lead to unexpected completions from some files
1655 (gzipped files for example). Unloaded buffers are not scanned for
1656 whole-line completion.
1657
1658 The default is ".,w,b,u,t,i", which means to scan:
1659 1. the current buffer
1660 2. buffers in other windows
1661 3. other loaded buffers
1662 4. unloaded buffers
1663 5. tags
1664 6. included files
1665
1666 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001667 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1668 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001670 *'completefunc'* *'cfu'*
1671'completefunc' 'cfu' string (default: empty)
1672 local to buffer
1673 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001674 {not available when compiled without the +eval
1675 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001676 This option specifies a function to be used for Insert mode completion
1677 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001678 See |complete-functions| for an explanation of how the function is
1679 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001680
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001681
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001682 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001683'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001684 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001685 {not available when compiled without the
1686 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001687 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001688 A comma separated list of options for Insert mode completion
1689 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001690
1691 menu Use a popup menu to show the possible completions. The
1692 menu is only shown when there is more than one match and
1693 sufficient colors are available. |ins-completion-menu|
1694
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001695 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001696 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001697 match, e.g., what file it comes from.
1698
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001699 longest Only insert the longest common text of the matches. If
1700 the menu is displayed you can use CTRL-L to add more
1701 characters. Whether case is ignored depends on the kind
1702 of completion. For buffer text the 'ignorecase' option is
1703 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001704
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001705 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001706 completion in the preview window. Only works in
1707 combination with "menu" or "menuone".
1708
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001709
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001710 *'concealcursor'* *'cocu'*
1711'concealcursor' 'cocu' string (default: "")
1712 local to window
1713 {not in Vi}
1714 {not available when compiled without the |+conceal|
1715 feature}
1716 Sets the modes in which text in the cursor line can also be concealed.
1717 When the current mode is listed then concealing happens just like in
1718 other lines.
1719 n Normal mode
1720 v Visual mode
1721 i Insert mode
1722
1723 A useful value is "n". This is used in help files. So long as you
1724 are moving around text is concealed, but when starting to insert text
1725 or selecting a Visual area the concealed text is displayed, so that
1726 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001727 Keep in mind that the cursor position is not always where it's
1728 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001729
1730
1731'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001732 number (default 0)
1733 local to window
1734 {not in Vi}
1735 {not available when compiled without the |+conceal|
1736 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001737 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1738 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001739
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001740 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001741 0 Text is shown normally
1742 1 Each block of concealed text is replaced with the
1743 character defined in 'listchars' (default is a dash)
1744 and highlighted with the "Conceal" highlight group.
1745 2 Concealed text is completely hidden unless it has a
1746 custom replacement character defined (see
1747 |:syn-cchar|.
Bram Moolenaara7781e02010-07-19 20:13:22 +02001748 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001749
Bram Moolenaara7781e02010-07-19 20:13:22 +02001750 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001751 edit and copy the text. This can be changed with the 'concealcursor'
1752 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001753
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1755'confirm' 'cf' boolean (default off)
1756 global
1757 {not in Vi}
1758 When 'confirm' is on, certain operations that would normally
1759 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1760 instead raise a |dialog| asking if you wish to save the current
1761 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1762 If 'confirm' is off you can still activate confirmation for one
1763 command only (this is most useful in mappings) with the |:confirm|
1764 command.
1765 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1766
1767 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1768'conskey' 'consk' boolean (default off)
1769 global
1770 {not in Vi} {only for MS-DOS}
1771 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001772 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 three methods of console input are available:
1774 'conskey' 'bioskey' action ~
1775 on on or off direct console input
1776 off on BIOS
1777 off off STDIN
1778
1779 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1780'copyindent' 'ci' boolean (default off)
1781 local to buffer
1782 {not in Vi}
1783 Copy the structure of the existing lines indent when autoindenting a
1784 new line. Normally the new indent is reconstructed by a series of
1785 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1786 in which case only spaces are used). Enabling this option makes the
1787 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001788 existing line. 'expandtab' has no effect on these characters, a Tab
1789 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 line, the remaining space is filled in the normal manner.
1791 NOTE: 'copyindent' is reset when 'compatible' is set.
1792 Also see 'preserveindent'.
1793
1794 *'cpoptions'* *'cpo'*
1795'cpoptions' 'cpo' string (Vim default: "aABceFs",
1796 Vi default: all flags)
1797 global
1798 {not in Vi}
1799 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001800 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 not being vi-compatible is mostly or sometimes preferred.
1802 'cpoptions' stands for "compatible-options".
1803 Commas can be added for readability.
1804 To avoid problems with flags that are added in the future, use the
1805 "+=" and "-=" feature of ":set" |add-option-flags|.
1806 NOTE: This option is set to the Vi default value when 'compatible' is
1807 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001808 NOTE: This option is set to the POSIX default value at startup when
1809 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001810 variable exists |posix|. This means Vim tries to behave like the
1811 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812
1813 contains behavior ~
1814 *cpo-a*
1815 a When included, a ":read" command with a file name
1816 argument will set the alternate file name for the
1817 current window.
1818 *cpo-A*
1819 A When included, a ":write" command with a file name
1820 argument will set the alternate file name for the
1821 current window.
1822 *cpo-b*
1823 b "\|" in a ":map" command is recognized as the end of
1824 the map command. The '\' is included in the mapping,
1825 the text after the '|' is interpreted as the next
1826 command. Use a CTRL-V instead of a backslash to
1827 include the '|' in the mapping. Applies to all
1828 mapping, abbreviation, menu and autocmd commands.
1829 See also |map_bar|.
1830 *cpo-B*
1831 B A backslash has no special meaning in mappings,
1832 abbreviations and the "to" part of the menu commands.
1833 Remove this flag to be able to use a backslash like a
1834 CTRL-V. For example, the command ":map X \<Esc>"
1835 results in X being mapped to:
1836 'B' included: "\^[" (^[ is a real <Esc>)
1837 'B' excluded: "<Esc>" (5 characters)
1838 ('<' excluded in both cases)
1839 *cpo-c*
1840 c Searching continues at the end of any match at the
1841 cursor position, but not further than the start of the
1842 next line. When not present searching continues
1843 one character from the cursor position. With 'c'
1844 "abababababab" only gets three matches when repeating
1845 "/abab", without 'c' there are five matches.
1846 *cpo-C*
1847 C Do not concatenate sourced lines that start with a
1848 backslash. See |line-continuation|.
1849 *cpo-d*
1850 d Using "./" in the 'tags' option doesn't mean to use
1851 the tags file relative to the current file, but the
1852 tags file in the current directory.
1853 *cpo-D*
1854 D Can't use CTRL-K to enter a digraph after Normal mode
1855 commands with a character argument, like |r|, |f| and
1856 |t|.
1857 *cpo-e*
1858 e When executing a register with ":@r", always add a
1859 <CR> to the last line, also when the register is not
1860 linewise. If this flag is not present, the register
1861 is not linewise and the last line does not end in a
1862 <CR>, then the last line is put on the command-line
1863 and can be edited before hitting <CR>.
1864 *cpo-E*
1865 E It is an error when using "y", "d", "c", "g~", "gu" or
1866 "gU" on an Empty region. The operators only work when
1867 at least one character is to be operate on. Example:
1868 This makes "y0" fail in the first column.
1869 *cpo-f*
1870 f When included, a ":read" command with a file name
1871 argument will set the file name for the current buffer,
1872 if the current buffer doesn't have a file name yet.
1873 *cpo-F*
1874 F When included, a ":write" command with a file name
1875 argument will set the file name for the current
1876 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001877 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 *cpo-g*
1879 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001880 *cpo-H*
1881 H When using "I" on a line with only blanks, insert
1882 before the last blank. Without this flag insert after
1883 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001884 *cpo-i*
1885 i When included, interrupting the reading of a file will
1886 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001887 *cpo-I*
1888 I When moving the cursor up or down just after inserting
1889 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 *cpo-j*
1891 j When joining lines, only add two spaces after a '.',
1892 not after '!' or '?'. Also see 'joinspaces'.
1893 *cpo-J*
1894 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001895 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 white space.
1897 *cpo-k*
1898 k Disable the recognition of raw key codes in
1899 mappings, abbreviations, and the "to" part of menu
1900 commands. For example, if <Key> sends ^[OA (where ^[
1901 is <Esc>), the command ":map X ^[OA" results in X
1902 being mapped to:
1903 'k' included: "^[OA" (3 characters)
1904 'k' excluded: "<Key>" (one key code)
1905 Also see the '<' flag below.
1906 *cpo-K*
1907 K Don't wait for a key code to complete when it is
1908 halfway a mapping. This breaks mapping <F1><F1> when
1909 only part of the second <F1> has been read. It
1910 enables cancelling the mapping by typing <F1><Esc>.
1911 *cpo-l*
1912 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001913 literally, only "\]", "\^", "\-" and "\\" are special.
1914 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001915 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1916 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001917 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918 *cpo-L*
1919 L When the 'list' option is set, 'wrapmargin',
1920 'textwidth', 'softtabstop' and Virtual Replace mode
1921 (see |gR|) count a <Tab> as two characters, instead of
1922 the normal behavior of a <Tab>.
1923 *cpo-m*
1924 m When included, a showmatch will always wait half a
1925 second. When not included, a showmatch will wait half
1926 a second or until a character is typed. |'showmatch'|
1927 *cpo-M*
1928 M When excluded, "%" matching will take backslashes into
1929 account. Thus in "( \( )" and "\( ( \)" the outer
1930 parenthesis match. When included "%" ignores
1931 backslashes, which is Vi compatible.
1932 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001933 n When included, the column used for 'number' and
1934 'relativenumber' will also be used for text of wrapped
1935 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001936 *cpo-o*
1937 o Line offset to search command is not remembered for
1938 next search.
1939 *cpo-O*
1940 O Don't complain if a file is being overwritten, even
1941 when it didn't exist when editing it. This is a
1942 protection against a file unexpectedly created by
1943 someone else. Vi didn't complain about this.
1944 *cpo-p*
1945 p Vi compatible Lisp indenting. When not present, a
1946 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001947 *cpo-P*
1948 P When included, a ":write" command that appends to a
1949 file will set the file name for the current buffer, if
1950 the current buffer doesn't have a file name yet and
1951 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001952 *cpo-q*
1953 q When joining multiple lines leave the cursor at the
1954 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955 *cpo-r*
1956 r Redo ("." command) uses "/" to repeat a search
1957 command, instead of the actually used search string.
1958 *cpo-R*
1959 R Remove marks from filtered lines. Without this flag
1960 marks are kept like |:keepmarks| was used.
1961 *cpo-s*
1962 s Set buffer options when entering the buffer for the
1963 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001964 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 set when the buffer is created.
1966 *cpo-S*
1967 S Set buffer options always when entering a buffer
1968 (except 'readonly', 'fileformat', 'filetype' and
1969 'syntax'). This is the (most) Vi compatible setting.
1970 The options are set to the values in the current
1971 buffer. When you change an option and go to another
1972 buffer, the value is copied. Effectively makes the
1973 buffer options global to all buffers.
1974
1975 's' 'S' copy buffer options
1976 no no when buffer created
1977 yes no when buffer first entered (default)
1978 X yes each time when buffer entered (vi comp.)
1979 *cpo-t*
1980 t Search pattern for the tag command is remembered for
1981 "n" command. Otherwise Vim only puts the pattern in
1982 the history for search pattern, but doesn't change the
1983 last used search pattern.
1984 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001985 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001986 *cpo-v*
1987 v Backspaced characters remain visible on the screen in
1988 Insert mode. Without this flag the characters are
1989 erased from the screen right away. With this flag the
1990 screen newly typed text overwrites backspaced
1991 characters.
1992 *cpo-w*
1993 w When using "cw" on a blank character, only change one
1994 character and not all blanks until the start of the
1995 next word.
1996 *cpo-W*
1997 W Don't overwrite a readonly file. When omitted, ":w!"
1998 overwrites a readonly file, if possible.
1999 *cpo-x*
2000 x <Esc> on the command-line executes the command-line.
2001 The default in Vim is to abandon the command-line,
2002 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002003 *cpo-X*
2004 X When using a count with "R" the replaced text is
2005 deleted only once. Also when repeating "R" with "."
2006 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007 *cpo-y*
2008 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002009 *cpo-Z*
2010 Z When using "w!" while the 'readonly' option is set,
2011 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 *cpo-!*
2013 ! When redoing a filter command, use the last used
2014 external command, whatever it was. Otherwise the last
2015 used -filter- command is used.
2016 *cpo-$*
2017 $ When making a change to one line, don't redisplay the
2018 line, but put a '$' at the end of the changed text.
2019 The changed text will be overwritten when you type the
2020 new text. The line is redisplayed if you type any
2021 command that moves the cursor from the insertion
2022 point.
2023 *cpo-%*
2024 % Vi-compatible matching is done for the "%" command.
2025 Does not recognize "#if", "#endif", etc.
2026 Does not recognize "/*" and "*/".
2027 Parens inside single and double quotes are also
2028 counted, causing a string that contains a paren to
2029 disturb the matching. For example, in a line like
2030 "if (strcmp("foo(", s))" the first paren does not
2031 match the last one. When this flag is not included,
2032 parens inside single and double quotes are treated
2033 specially. When matching a paren outside of quotes,
2034 everything inside quotes is ignored. When matching a
2035 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002036 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002037 This flag is also used for other features, such as
2038 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002039 *cpo--*
2040 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002041 it would go above the first line or below the last
2042 line. Without it the cursor moves to the first or
2043 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002044 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002045 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002046 *cpo-+*
2047 + When included, a ":write file" command will reset the
2048 'modified' flag of the buffer, even though the buffer
2049 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002050 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051 * Use ":*" in the same way as ":@". When not included,
2052 ":*" is an alias for ":'<,'>", select the Visual area.
2053 *cpo-<*
2054 < Disable the recognition of special key codes in |<>|
2055 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002056 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 ":map X <Tab>" results in X being mapped to:
2058 '<' included: "<Tab>" (5 characters)
2059 '<' excluded: "^I" (^I is a real <Tab>)
2060 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002061 *cpo->*
2062 > When appending to a register, put a line break before
2063 the appended text.
2064
2065 POSIX flags. These are not included in the Vi default value, except
2066 when $VIM_POSIX was set on startup. |posix|
2067
2068 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002069 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002070 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002071 *cpo-&*
2072 & When ":preserve" was used keep the swap file when
2073 exiting normally while this buffer is still loaded.
2074 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002075 *cpo-\*
2076 \ Backslash in a [] range in a search pattern is taken
2077 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002078 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2079 '\' excluded: "/[ \-]" finds <Space> and '-'
2080 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002081 *cpo-/*
2082 / When "%" is used as the replacement string in a |:s|
2083 command, use the previous replacement string. |:s%|
2084 *cpo-{*
2085 { The |{| and |}| commands also stop at a "{" character
2086 at the start of a line.
2087 *cpo-.*
2088 . The ":chdir" and ":cd" commands fail if the current
2089 buffer is modified, unless ! is used. Vim doesn't
2090 need this, since it remembers the full path of an
2091 opened file.
2092 *cpo-bar*
2093 | The value of the $LINES and $COLUMNS environment
2094 variables overrule the terminal size values obtained
2095 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002096
Bram Moolenaar071d4272004-06-13 20:20:40 +00002097
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002098 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002099'cryptmethod' string (default "zip")
2100 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002101 {not in Vi}
2102 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002103 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002104 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002105 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002106 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002107 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002108 or later, files can NOT be read by Vim 7.2 and older.
2109 This adds a "seed" to the file, every time you write
2110 the file the encrypted bytes will be different.
2111
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002112 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002113 to the detected method of the file being read. Thus if you write it
2114 without changing 'cryptmethod' the same method will be used.
2115 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002116 explicitly write it, you don't get a warning unless there are other
2117 modifications. Also see |:X|.
2118
2119 When setting the global value to an empty string, it will end up with
2120 the value "zip". When setting the local value to an empty string the
2121 buffer will use the global value.
2122
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002123 When a new encryption method is added in a later version of Vim, and
2124 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002125 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002126
2127
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 *'cscopepathcomp'* *'cspc'*
2129'cscopepathcomp' 'cspc' number (default 0)
2130 global
2131 {not available when compiled without the |+cscope|
2132 feature}
2133 {not in Vi}
2134 Determines how many components of the path to show in a list of tags.
2135 See |cscopepathcomp|.
2136
2137 *'cscopeprg'* *'csprg'*
2138'cscopeprg' 'csprg' string (default "cscope")
2139 global
2140 {not available when compiled without the |+cscope|
2141 feature}
2142 {not in Vi}
2143 Specifies the command to execute cscope. See |cscopeprg|.
2144 This option cannot be set from a |modeline| or in the |sandbox|, for
2145 security reasons.
2146
2147 *'cscopequickfix'* *'csqf'*
2148'cscopequickfix' 'csqf' string (default "")
2149 global
2150 {not available when compiled without the |+cscope|
2151 or |+quickfix| features}
2152 {not in Vi}
2153 Specifies whether to use quickfix window to show cscope results.
2154 See |cscopequickfix|.
2155
2156 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2157'cscopetag' 'cst' boolean (default off)
2158 global
2159 {not available when compiled without the |+cscope|
2160 feature}
2161 {not in Vi}
2162 Use cscope for tag commands. See |cscope-options|.
2163 NOTE: This option is reset when 'compatible' is set.
2164
2165 *'cscopetagorder'* *'csto'*
2166'cscopetagorder' 'csto' number (default 0)
2167 global
2168 {not available when compiled without the |+cscope|
2169 feature}
2170 {not in Vi}
2171 Determines the order in which ":cstag" performs a search. See
2172 |cscopetagorder|.
2173 NOTE: This option is set to 0 when 'compatible' is set.
2174
2175 *'cscopeverbose'* *'csverb'*
2176 *'nocscopeverbose'* *'nocsverb'*
2177'cscopeverbose' 'csverb' boolean (default off)
2178 global
2179 {not available when compiled without the |+cscope|
2180 feature}
2181 {not in Vi}
2182 Give messages when adding a cscope database. See |cscopeverbose|.
2183 NOTE: This option is reset when 'compatible' is set.
2184
Bram Moolenaar860cae12010-06-05 23:22:07 +02002185 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2186'cursorbind' 'crb' boolean (default off)
2187 local to window
2188 {not in Vi}
2189 {not available when compiled without the |+cursorbind|
2190 feature}
2191 When this option is set, as the cursor in the current
2192 window moves other cursorbound windows (windows that also have
2193 this option set) move their cursors to the corresponding line and
2194 column. This option is useful for viewing the
2195 differences between two versions of a file (see 'diff'); in diff mode,
2196 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002197 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002198
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002199
2200 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2201'cursorcolumn' 'cuc' boolean (default off)
2202 local to window
2203 {not in Vi}
2204 {not available when compiled without the |+syntax|
2205 feature}
2206 Highlight the screen column of the cursor with CursorColumn
2207 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2208 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002209 If you only want the highlighting in the current window you can use
2210 these autocommands: >
2211 au WinLeave * set nocursorline nocursorcolumn
2212 au WinEnter * set cursorline cursorcolumn
2213<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002214
2215 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2216'cursorline' 'cul' boolean (default off)
2217 local to window
2218 {not in Vi}
2219 {not available when compiled without the |+syntax|
2220 feature}
2221 Highlight the screen line of the cursor with CursorLine
2222 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2223 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002224 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002225 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002226
2227
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 *'debug'*
2229'debug' string (default "")
2230 global
2231 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002232 These values can be used:
2233 msg Error messages that would otherwise be omitted will be given
2234 anyway.
2235 throw Error messages that would otherwise be omitted will be given
2236 anyway and also throw an exception and set |v:errmsg|.
2237 beep A message will be given when otherwise only a beep would be
2238 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002239 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002240 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2241 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242
2243 *'define'* *'def'*
2244'define' 'def' string (default "^\s*#\s*define")
2245 global or local to buffer |global-local|
2246 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002247 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248 pattern, just like for the "/" command. This option is used for the
2249 commands like "[i" and "[d" |include-search|. The 'isident' option is
2250 used to recognize the defined name after the match:
2251 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2252 See |option-backslash| about inserting backslashes to include a space
2253 or backslash.
2254 The default value is for C programs. For C++ this value would be
2255 useful, to include const type declarations: >
2256 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2257< When using the ":set" command, you need to double the backslashes!
2258
2259 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2260'delcombine' 'deco' boolean (default off)
2261 global
2262 {not in Vi}
2263 {only available when compiled with the |+multi_byte|
2264 feature}
2265 If editing Unicode and this option is set, backspace and Normal mode
2266 "x" delete each combining character on its own. When it is off (the
2267 default) the character along with its combining characters are
2268 deleted.
2269 Note: When 'delcombine' is set "xx" may work different from "2x"!
2270
2271 This is useful for Arabic, Hebrew and many other languages where one
2272 may have combining characters overtop of base characters, and want
2273 to remove only the combining ones.
2274
2275 *'dictionary'* *'dict'*
2276'dictionary' 'dict' string (default "")
2277 global or local to buffer |global-local|
2278 {not in Vi}
2279 List of file names, separated by commas, that are used to lookup words
2280 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2281 contain a list of words. This can be one word per line, or several
2282 words per line, separated by non-keyword characters (white space is
2283 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002284 When this option is empty, or an entry "spell" is present, spell
2285 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002286 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287 after a comma are ignored, otherwise spaces are included in the file
2288 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002289 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290 Where to find a list of words?
2291 - On FreeBSD, there is the file "/usr/share/dict/words".
2292 - In the Simtel archive, look in the "msdos/linguist" directory.
2293 - In "miscfiles" of the GNU collection.
2294 The use of |:set+=| and |:set-=| is preferred when adding or removing
2295 directories from the list. This avoids problems when a future version
2296 uses another default.
2297 Backticks cannot be used in this option for security reasons.
2298
2299 *'diff'* *'nodiff'*
2300'diff' boolean (default off)
2301 local to window
2302 {not in Vi}
2303 {not available when compiled without the |+diff|
2304 feature}
2305 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002306 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002307
2308 *'dex'* *'diffexpr'*
2309'diffexpr' 'dex' string (default "")
2310 global
2311 {not in Vi}
2312 {not available when compiled without the |+diff|
2313 feature}
2314 Expression which is evaluated to obtain an ed-style diff file from two
2315 versions of a file. See |diff-diffexpr|.
2316 This option cannot be set from a |modeline| or in the |sandbox|, for
2317 security reasons.
2318
2319 *'dip'* *'diffopt'*
2320'diffopt' 'dip' string (default "filler")
2321 global
2322 {not in Vi}
2323 {not available when compiled without the |+diff|
2324 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002325 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 All are optional. Items must be separated by a comma.
2327
2328 filler Show filler lines, to keep the text
2329 synchronized with a window that has inserted
2330 lines at the same position. Mostly useful
2331 when windows are side-by-side and 'scrollbind'
2332 is set.
2333
2334 context:{n} Use a context of {n} lines between a change
2335 and a fold that contains unchanged lines.
2336 When omitted a context of six lines is used.
2337 See |fold-diff|.
2338
2339 icase Ignore changes in case of text. "a" and "A"
2340 are considered the same. Adds the "-i" flag
2341 to the "diff" command if 'diffexpr' is empty.
2342
2343 iwhite Ignore changes in amount of white space. Adds
2344 the "-b" flag to the "diff" command if
2345 'diffexpr' is empty. Check the documentation
2346 of the "diff" command for what this does
2347 exactly. It should ignore adding trailing
2348 white space, but not leading white space.
2349
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002350 horizontal Start diff mode with horizontal splits (unless
2351 explicitly specified otherwise).
2352
2353 vertical Start diff mode with vertical splits (unless
2354 explicitly specified otherwise).
2355
2356 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2357 starting diff mode. Without this 2 is used.
2358
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359 Examples: >
2360
2361 :set diffopt=filler,context:4
2362 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002363 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364<
2365 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2366'digraph' 'dg' boolean (default off)
2367 global
2368 {not in Vi}
2369 {not available when compiled without the |+digraphs|
2370 feature}
2371 Enable the entering of digraphs in Insert mode with {char1} <BS>
2372 {char2}. See |digraphs|.
2373 NOTE: This option is reset when 'compatible' is set.
2374
2375 *'directory'* *'dir'*
2376'directory' 'dir' string (default for Amiga: ".,t:",
2377 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2378 for Unix: ".,~/tmp,/var/tmp,/tmp")
2379 global
2380 List of directory names for the swap file, separated with commas.
2381 - The swap file will be created in the first directory where this is
2382 possible.
2383 - Empty means that no swap file will be used (recovery is
2384 impossible!).
2385 - A directory "." means to put the swap file in the same directory as
2386 the edited file. On Unix, a dot is prepended to the file name, so
2387 it doesn't show in a directory listing. On MS-Windows the "hidden"
2388 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002389 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 put the swap file relative to where the edited file is. The leading
2391 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002392 - For Unix and Win32, if a directory ends in two path separators "//"
2393 or "\\", the swap file name will be built from the complete path to
2394 the file with all path separators substituted to percent '%' signs.
2395 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002396 On Win32, when a separating comma is following, you must use "//",
2397 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 - Spaces after the comma are ignored, other spaces are considered part
2399 of the directory name. To have a space at the start of a directory
2400 name, precede it with a backslash.
2401 - To include a comma in a directory name precede it with a backslash.
2402 - A directory name may end in an ':' or '/'.
2403 - Environment variables are expanded |:set_env|.
2404 - Careful with '\' characters, type one before a space, type two to
2405 get one in the option (see |option-backslash|), for example: >
2406 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2407< - For backwards compatibility with Vim version 3.0 a '>' at the start
2408 of the option is removed.
2409 Using "." first in the list is recommended. This means that editing
2410 the same file twice will result in a warning. Using "/tmp" on Unix is
2411 discouraged: When the system crashes you lose the swap file.
2412 "/var/tmp" is often not cleared when rebooting, thus is a better
2413 choice than "/tmp". But it can contain a lot of files, your swap
2414 files get lost in the crowd. That is why a "tmp" directory in your
2415 home directory is tried first.
2416 The use of |:set+=| and |:set-=| is preferred when adding or removing
2417 directories from the list. This avoids problems when a future version
2418 uses another default.
2419 This option cannot be set from a |modeline| or in the |sandbox|, for
2420 security reasons.
2421 {Vi: directory to put temp file in, defaults to "/tmp"}
2422
2423 *'display'* *'dy'*
2424'display' 'dy' string (default "")
2425 global
2426 {not in Vi}
2427 Change the way text is displayed. This is comma separated list of
2428 flags:
2429 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002430 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431 last line that doesn't fit is replaced with "@" lines.
2432 uhex Show unprintable characters hexadecimal as <xx>
2433 instead of using ^C and ~C.
2434
2435 *'eadirection'* *'ead'*
2436'eadirection' 'ead' string (default "both")
2437 global
2438 {not in Vi}
2439 {not available when compiled without the +vertsplit
2440 feature}
2441 Tells when the 'equalalways' option applies:
2442 ver vertically, width of windows is not affected
2443 hor horizontally, height of windows is not affected
2444 both width and height of windows is affected
2445
2446 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2447'edcompatible' 'ed' boolean (default off)
2448 global
2449 Makes the 'g' and 'c' flags of the ":substitute" command to be
2450 toggled each time the flag is given. See |complex-change|. See
2451 also 'gdefault' option.
2452 Switching this option on is discouraged!
2453
2454 *'encoding'* *'enc'* *E543*
2455'encoding' 'enc' string (default: "latin1" or value from $LANG)
2456 global
2457 {only available when compiled with the |+multi_byte|
2458 feature}
2459 {not in Vi}
2460 Sets the character encoding used inside Vim. It applies to text in
2461 the buffers, registers, Strings in expressions, text stored in the
2462 viminfo file, etc. It sets the kind of characters which Vim can work
2463 with. See |encoding-names| for the possible values.
2464
2465 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002466 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002468 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002469
Bram Moolenaar865242e2010-07-14 21:12:05 +02002470 This option cannot be set from a |modeline|. It would most likely
2471 corrupt the text.
2472
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2474 "utf-8". Although care has been taken to allow different values of
2475 'encoding', "utf-8" is the natural choice for the environment and
2476 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002477 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478 versions, and to avoid changing the encoding of newly created files
2479 without your knowledge (in case 'fileencodings' is empty).
2480
2481 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002482 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483 iconv() or as specified with 'charconvert'.
2484
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002485 If you need to know whether 'encoding' is a multi-byte encoding, you
2486 can use: >
2487 if has("multi_byte_encoding")
2488<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489 Normally 'encoding' will be equal to your current locale. This will
2490 be the default if Vim recognizes your environment settings. If
2491 'encoding' is not set to the current locale, 'termencoding' must be
2492 set to convert typed and displayed text. See |encoding-table|.
2493
2494 When you set this option, it fires the |EncodingChanged| autocommand
2495 event so that you can set up fonts if necessary.
2496
2497 When the option is set, the value is converted to lowercase. Thus
2498 you can set it with uppercase values too. Underscores are translated
2499 to '-' signs.
2500 When the encoding is recognized, it is changed to the standard name.
2501 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2502 "iso-8859-2" and "utf8" becomes "utf-8".
2503
2504 Note: "latin1" is also used when the encoding could not be detected.
2505 This only works when editing files in the same encoding! When the
2506 actual character set is not latin1, make sure 'fileencoding' and
2507 'fileencodings' are empty. When conversion is needed, switch to using
2508 utf-8.
2509
2510 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2511 You don't notice this while editing, but it does matter for the
2512 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2513 setting 'encoding' to one of these values instead of utf-8 only has
2514 effect for encoding used for files when 'fileencoding' is empty.
2515
Bram Moolenaar661b1822005-07-28 22:36:45 +00002516 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2517 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518
2519 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2520'endofline' 'eol' boolean (default on)
2521 local to buffer
2522 {not in Vi}
2523 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002524 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 option is automatically set when starting to edit a new file, unless
2526 the file does not have an <EOL> for the last line in the file, in
2527 which case it is reset. Normally you don't have to set or reset this
2528 option. When 'binary' is off the value is not used when writing the
2529 file. When 'binary' is on it is used to remember the presence of a
2530 <EOL> for the last line in the file, so that when you write the file
2531 the situation from the original file can be kept. But you can change
2532 it if you want to.
2533
2534 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2535'equalalways' 'ea' boolean (default on)
2536 global
2537 {not in Vi}
2538 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002539 splitting or closing a window. This also happens the moment the
2540 option is switched on. When off, splitting a window will reduce the
2541 size of the current window and leave the other windows the same. When
2542 closing a window the extra lines are given to the window next to it
2543 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 When mixing vertically and horizontally split windows, a minimal size
2545 is computed and some windows may be larger if there is room. The
2546 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002547 Changing the height and width of a window can be avoided by setting
2548 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002549 If a window size is specified when creating a new window sizes are
2550 currently not equalized (it's complicated, but may be implemented in
2551 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552
2553 *'equalprg'* *'ep'*
2554'equalprg' 'ep' string (default "")
2555 global or local to buffer |global-local|
2556 {not in Vi}
2557 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002558 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002559 or 'indentexpr'. When Vim was compiled without internal formatting,
2560 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002561 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562 about including spaces and backslashes.
2563 This option cannot be set from a |modeline| or in the |sandbox|, for
2564 security reasons.
2565
2566 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2567'errorbells' 'eb' boolean (default off)
2568 global
2569 Ring the bell (beep or screen flash) for error messages. This only
2570 makes a difference for error messages, the bell will be used always
2571 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002572 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573 screen flash or do nothing.
2574
2575 *'errorfile'* *'ef'*
2576'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2577 others: "errors.err")
2578 global
2579 {not in Vi}
2580 {not available when compiled without the |+quickfix|
2581 feature}
2582 Name of the errorfile for the QuickFix mode (see |:cf|).
2583 When the "-q" command-line argument is used, 'errorfile' is set to the
2584 following argument. See |-q|.
2585 NOT used for the ":make" command. See 'makeef' for that.
2586 Environment variables are expanded |:set_env|.
2587 See |option-backslash| about including spaces and backslashes.
2588 This option cannot be set from a |modeline| or in the |sandbox|, for
2589 security reasons.
2590
2591 *'errorformat'* *'efm'*
2592'errorformat' 'efm' string (default is very long)
2593 global or local to buffer |global-local|
2594 {not in Vi}
2595 {not available when compiled without the |+quickfix|
2596 feature}
2597 Scanf-like description of the format for the lines in the error file
2598 (see |errorformat|).
2599
2600 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2601'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2602 global
2603 {not in Vi}
2604 Function keys that start with an <Esc> are recognized in Insert
2605 mode. When this option is off, the cursor and function keys cannot be
2606 used in Insert mode if they start with an <Esc>. The advantage of
2607 this is that the single <Esc> is recognized immediately, instead of
2608 after one second. Instead of resetting this option, you might want to
2609 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2610 when 'esckeys' is off, you can still map anything, but the cursor keys
2611 won't work by default.
2612 NOTE: This option is set to the Vi default value when 'compatible' is
2613 set and to the Vim default value when 'compatible' is reset.
2614
2615 *'eventignore'* *'ei'*
2616'eventignore' 'ei' string (default "")
2617 global
2618 {not in Vi}
2619 {not available when compiled without the |+autocmd|
2620 feature}
2621 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002622 When set to "all" or when "all" is one of the items, all autocommand
2623 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 Otherwise this is a comma separated list of event names. Example: >
2625 :set ei=WinEnter,WinLeave
2626<
2627 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2628'expandtab' 'et' boolean (default off)
2629 local to buffer
2630 {not in Vi}
2631 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002632 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2634 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2635 NOTE: This option is reset when 'compatible' is set.
2636
2637 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2638'exrc' 'ex' boolean (default off)
2639 global
2640 {not in Vi}
2641 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2642 directory. If you switch this option on you should also consider
2643 setting the 'secure' option (see |initialization|). Using a local
2644 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2645 also see |.vimrc| and |gui-init|.
2646 This option cannot be set from a |modeline| or in the |sandbox|, for
2647 security reasons.
2648
2649 *'fileencoding'* *'fenc'* *E213*
2650'fileencoding' 'fenc' string (default: "")
2651 local to buffer
2652 {only available when compiled with the |+multi_byte|
2653 feature}
2654 {not in Vi}
2655 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002656
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002658 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659 When 'fileencoding' is empty, the same value as 'encoding' will be
2660 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002661 Conversion will also be done when 'encoding' and 'fileencoding' are
2662 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2663 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002665 'encoding' is "utf-8" or another Unicode encoding, conversion
2666 is most likely done in a way that the reverse conversion
2667 results in the same text. When 'encoding' is not "utf-8" some
2668 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002669
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 See 'encoding' for the possible values. Additionally, values may be
2671 specified that can be handled by the converter, see
2672 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002673
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 When reading a file 'fileencoding' will be set from 'fileencodings'.
2675 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002676 'fileencoding', use the |++enc| argument. One exception: when
2677 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002678 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002679
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2681 When the option is set, the value is converted to lowercase. Thus
2682 you can set it with uppercase values too. '_' characters are
2683 replaced with '-'. If a name is recognized from the list for
2684 'encoding', it is replaced by the standard name. For example
2685 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002686
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 When this option is set, after starting to edit a file, the 'modified'
2688 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002689
2690 Keep in mind that changing 'fenc' from a modeline happens
2691 AFTER the text has been read, thus it applies to when the file will be
2692 written. If you do set 'fenc' in a modeline, you might want to set
2693 'nomodified' to avoid not being able to ":q".
2694
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 This option can not be changed when 'modifiable' is off.
2696
2697 *'fe'*
2698 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002699 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 old short name was 'fe', which is no longer used.
2701
2702 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002703'fileencodings' 'fencs' string (default: "ucs-bom",
2704 "ucs-bom,utf-8,default,latin1" when
2705 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706 global
2707 {only available when compiled with the |+multi_byte|
2708 feature}
2709 {not in Vi}
2710 This is a list of character encodings considered when starting to edit
2711 an existing file. When a file is read, Vim tries to use the first
2712 mentioned character encoding. If an error is detected, the next one
2713 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002714 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 an empty string, which means the value of 'encoding' is used.
2716 WARNING: Conversion can cause loss of information! When
2717 'encoding' is "utf-8" (or one of the other Unicode variants)
2718 conversion is most likely done in a way that the reverse
2719 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002720 "utf-8" some non-ASCII characters may be lost! You can use
2721 the |++bad| argument to specify what is done with characters
2722 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 For an empty file or a file with only ASCII characters most encodings
2724 will work and the first entry of 'fileencodings' will be used (except
2725 "ucs-bom", which requires the BOM to be present). If you prefer
2726 another encoding use an BufReadPost autocommand event to test if your
2727 preferred encoding is to be used. Example: >
2728 au BufReadPost * if search('\S', 'w') == 0 |
2729 \ set fenc=iso-2022-jp | endif
2730< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2731 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002732 When the |++enc| argument is used then the value of 'fileencodings' is
2733 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002734 Note that 'fileencodings' is not used for a new file, the global value
2735 of 'fileencoding' is used instead. You can set it with: >
2736 :setglobal fenc=iso-8859-2
2737< This means that a non-existing file may get a different encoding than
2738 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739 The special value "ucs-bom" can be used to check for a Unicode BOM
2740 (Byte Order Mark) at the start of the file. It must not be preceded
2741 by "utf-8" or another Unicode encoding for this to work properly.
2742 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2743 because Vim cannot detect an error, thus the encoding is always
2744 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002745 The special value "default" can be used for the encoding from the
2746 environment. This is the default value for 'encoding'. It is useful
2747 when 'encoding' is set to "utf-8" and your environment uses a
2748 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002749 When 'encoding' is "utf-8" and a file contains an illegal byte
2750 sequence it won't be recognized as UTF-8. You can use the |8g8|
2751 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 WRONG VALUES: WHAT'S WRONG:
2753 latin1,utf-8 "latin1" will always be used
2754 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2755 file
2756 cp1250,latin1 "cp1250" will always be used
2757 If 'fileencodings' is empty, 'fileencoding' is not modified.
2758 See 'fileencoding' for the possible values.
2759 Setting this option does not have an effect until the next time a file
2760 is read.
2761
2762 *'fileformat'* *'ff'*
2763'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2764 Unix default: "unix",
2765 Macintosh default: "mac")
2766 local to buffer
2767 {not in Vi}
2768 This gives the <EOL> of the current buffer, which is used for
2769 reading/writing the buffer from/to a file:
2770 dos <CR> <NL>
2771 unix <NL>
2772 mac <CR>
2773 When "dos" is used, CTRL-Z at the end of a file is ignored.
2774 See |file-formats| and |file-read|.
2775 For the character encoding of the file see 'fileencoding'.
2776 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2777 works like it was set to "unix'.
2778 This option is set automatically when starting to edit a file and
2779 'fileformats' is not empty and 'binary' is off.
2780 When this option is set, after starting to edit a file, the 'modified'
2781 option is set, because the file would be different when written.
2782 This option can not be changed when 'modifiable' is off.
2783 For backwards compatibility: When this option is set to "dos",
2784 'textmode' is set, otherwise 'textmode' is reset.
2785
2786 *'fileformats'* *'ffs'*
2787'fileformats' 'ffs' string (default:
2788 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2789 Vim Unix: "unix,dos",
2790 Vim Mac: "mac,unix,dos",
2791 Vi Cygwin: "unix,dos",
2792 Vi others: "")
2793 global
2794 {not in Vi}
2795 This gives the end-of-line (<EOL>) formats that will be tried when
2796 starting to edit a new buffer and when reading a file into an existing
2797 buffer:
2798 - When empty, the format defined with 'fileformat' will be used
2799 always. It is not set automatically.
2800 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002801 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 'fileformats' name will be used when a file is read into an existing
2803 buffer, no matter what 'fileformat' for that buffer is set to.
2804 - When more than one name is present, separated by commas, automatic
2805 <EOL> detection will be done when reading a file. When starting to
2806 edit a file, a check is done for the <EOL>:
2807 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2808 'fileformat' is set to "dos".
2809 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002810 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 preceding <CR>, "unix" is preferred over "dos".
2812 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2813 This means that "mac" is only chosen when "unix" is not present,
2814 or when no <NL> is found in the file, and when "dos" is not
2815 present, or no <CR><NL> is present in the file.
2816 Also if "unix" was first chosen, but the first <CR> is before
2817 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2818 the file, then 'fileformat' is set to "mac".
2819 4. If 'fileformat' is still not set, the first name from
2820 'fileformats' is used.
2821 When reading a file into an existing buffer, the same is done, but
2822 this happens like 'fileformat' has been set appropriately for that
2823 file only, the option is not changed.
2824 When 'binary' is set, the value of 'fileformats' is not used.
2825
2826 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2827 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2828 done:
2829 - When 'fileformats' is empty, there is no automatic detection. Dos
2830 format will be used.
2831 - When 'fileformats' is set to one or more names, automatic detection
2832 is done. This is based on the first <NL> in the file: If there is a
2833 <CR> in front of it, Dos format is used, otherwise Unix format is
2834 used.
2835 Also see |file-formats|.
2836 For backwards compatibility: When this option is set to an empty
2837 string or one format (no comma is included), 'textauto' is reset,
2838 otherwise 'textauto' is set.
2839 NOTE: This option is set to the Vi default value when 'compatible' is
2840 set and to the Vim default value when 'compatible' is reset.
2841
2842 *'filetype'* *'ft'*
2843'filetype' 'ft' string (default: "")
2844 local to buffer
2845 {not in Vi}
2846 {not available when compiled without the |+autocmd|
2847 feature}
2848 When this option is set, the FileType autocommand event is triggered.
2849 All autocommands that match with the value of this option will be
2850 executed. Thus the value of 'filetype' is used in place of the file
2851 name.
2852 Otherwise this option does not always reflect the current file type.
2853 This option is normally set when the file type is detected. To enable
2854 this use the ":filetype on" command. |:filetype|
2855 Setting this option to a different value is most useful in a modeline,
2856 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002857 Example, for in an IDL file:
2858 /* vim: set filetype=idl : */ ~
2859 |FileType| |filetypes|
2860 When a dot appears in the value then this separates two filetype
2861 names. Example:
2862 /* vim: set filetype=c.doxygen : */ ~
2863 This will use the "c" filetype first, then the "doxygen" filetype.
2864 This works both for filetype plugins and for syntax files. More than
2865 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866 Do not confuse this option with 'osfiletype', which is for the file
2867 type that is actually stored with the file.
2868 This option is not copied to another buffer, independent of the 's' or
2869 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002870 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871
2872 *'fillchars'* *'fcs'*
2873'fillchars' 'fcs' string (default "vert:|,fold:-")
2874 global
2875 {not in Vi}
2876 {not available when compiled without the |+windows|
2877 and |+folding| features}
2878 Characters to fill the statuslines and vertical separators.
2879 It is a comma separated list of items:
2880
2881 item default Used for ~
2882 stl:c ' ' or '^' statusline of the current window
2883 stlnc:c ' ' or '-' statusline of the non-current windows
2884 vert:c '|' vertical separators |:vsplit|
2885 fold:c '-' filling 'foldtext'
2886 diff:c '-' deleted lines of the 'diff' option
2887
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002888 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 "stlnc" the space will be used when there is highlighting, '^' or '-'
2890 otherwise.
2891
2892 Example: >
2893 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2894< This is similar to the default, except that these characters will also
2895 be used when there is highlighting.
2896
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002897 for "stl" and "stlnc" only single-byte values are supported.
2898
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 The highlighting used for these items:
2900 item highlight group ~
2901 stl:c StatusLine |hl-StatusLine|
2902 stlnc:c StatusLineNC |hl-StatusLineNC|
2903 vert:c VertSplit |hl-VertSplit|
2904 fold:c Folded |hl-Folded|
2905 diff:c DiffDelete |hl-DiffDelete|
2906
2907 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2908'fkmap' 'fk' boolean (default off) *E198*
2909 global
2910 {not in Vi}
2911 {only available when compiled with the |+rightleft|
2912 feature}
2913 When on, the keyboard is mapped for the Farsi character set.
2914 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002915 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916
2917 *'foldclose'* *'fcl'*
2918'foldclose' 'fcl' string (default "")
2919 global
2920 {not in Vi}
2921 {not available when compiled without the |+folding|
2922 feature}
2923 When set to "all", a fold is closed when the cursor isn't in it and
2924 its level is higher than 'foldlevel'. Useful if you want folds to
2925 automatically close when moving out of them.
2926
2927 *'foldcolumn'* *'fdc'*
2928'foldcolumn' 'fdc' number (default 0)
2929 local to window
2930 {not in Vi}
2931 {not available when compiled without the |+folding|
2932 feature}
2933 When non-zero, a column with the specified width is shown at the side
2934 of the window which indicates open and closed folds. The maximum
2935 value is 12.
2936 See |folding|.
2937
2938 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2939'foldenable' 'fen' boolean (default on)
2940 local to window
2941 {not in Vi}
2942 {not available when compiled without the |+folding|
2943 feature}
2944 When off, all folds are open. This option can be used to quickly
2945 switch between showing all text unfolded and viewing the text with
2946 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002947 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 'foldenable' is off.
2949 This option is set by commands that create a new fold or close a fold.
2950 See |folding|.
2951
2952 *'foldexpr'* *'fde'*
2953'foldexpr' 'fde' string (default: "0")
2954 local to window
2955 {not in Vi}
2956 {not available when compiled without the |+folding|
2957 or |+eval| feature}
2958 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002959 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002960
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002961 The expression may be evaluated in the |sandbox|, see
2962 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002963 This option can't be set from a |modeline| when the 'diff' option is
2964 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002965
2966 It is not allowed to change text or jump to another window while
2967 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968
2969 *'foldignore'* *'fdi'*
2970'foldignore' 'fdi' string (default: "#")
2971 local to window
2972 {not in Vi}
2973 {not available when compiled without the |+folding|
2974 feature}
2975 Used only when 'foldmethod' is "indent". Lines starting with
2976 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002977 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 The default "#" works well for C programs. See |fold-indent|.
2979
2980 *'foldlevel'* *'fdl'*
2981'foldlevel' 'fdl' number (default: 0)
2982 local to window
2983 {not in Vi}
2984 {not available when compiled without the |+folding|
2985 feature}
2986 Sets the fold level: Folds with a higher level will be closed.
2987 Setting this option to zero will close all folds. Higher numbers will
2988 close fewer folds.
2989 This option is set by commands like |zm|, |zM| and |zR|.
2990 See |fold-foldlevel|.
2991
2992 *'foldlevelstart'* *'fdls'*
2993'foldlevelstart' 'fdls' number (default: -1)
2994 global
2995 {not in Vi}
2996 {not available when compiled without the |+folding|
2997 feature}
2998 Sets 'foldlevel' when starting to edit another buffer in a window.
2999 Useful to always start editing with all folds closed (value zero),
3000 some folds closed (one) or no folds closed (99).
3001 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003002 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 ignores this option and closes all folds.
3004 It is also done before BufReadPre autocommands, to allow an autocmd to
3005 overrule the 'foldlevel' value for specific files.
3006 When the value is negative, it is not used.
3007
3008 *'foldmarker'* *'fmr'* *E536*
3009'foldmarker' 'fmr' string (default: "{{{,}}}")
3010 local to window
3011 {not in Vi}
3012 {not available when compiled without the |+folding|
3013 feature}
3014 The start and end marker used when 'foldmethod' is "marker". There
3015 must be one comma, which separates the start and end marker. The
3016 marker is a literal string (a regular expression would be too slow).
3017 See |fold-marker|.
3018
3019 *'foldmethod'* *'fdm'*
3020'foldmethod' 'fdm' string (default: "manual")
3021 local to window
3022 {not in Vi}
3023 {not available when compiled without the |+folding|
3024 feature}
3025 The kind of folding used for the current window. Possible values:
3026 |fold-manual| manual Folds are created manually.
3027 |fold-indent| indent Lines with equal indent form a fold.
3028 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3029 |fold-marker| marker Markers are used to specify folds.
3030 |fold-syntax| syntax Syntax highlighting items specify folds.
3031 |fold-diff| diff Fold text that is not changed.
3032
3033 *'foldminlines'* *'fml'*
3034'foldminlines' 'fml' number (default: 1)
3035 local to window
3036 {not in Vi}
3037 {not available when compiled without the |+folding|
3038 feature}
3039 Sets the minimum number of screen lines for a fold to be displayed
3040 closed. Also for manually closed folds.
3041 Note that this only has an effect of what is displayed. After using
3042 "zc" to close a fold, which is displayed open because it's smaller
3043 than 'foldminlines', a following "zc" may close a containing fold.
3044
3045 *'foldnestmax'* *'fdn'*
3046'foldnestmax' 'fdn' number (default: 20)
3047 local to window
3048 {not in Vi}
3049 {not available when compiled without the |+folding|
3050 feature}
3051 Sets the maximum nesting of folds for the "indent" and "syntax"
3052 methods. This avoids that too many folds will be created. Using more
3053 than 20 doesn't work, because the internal limit is 20.
3054
3055 *'foldopen'* *'fdo'*
3056'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3057 search,tag,undo")
3058 global
3059 {not in Vi}
3060 {not available when compiled without the |+folding|
3061 feature}
3062 Specifies for which type of commands folds will be opened, if the
3063 command moves the cursor into a closed fold. It is a comma separated
3064 list of items.
3065 item commands ~
3066 all any
3067 block "(", "{", "[[", "[{", etc.
3068 hor horizontal movements: "l", "w", "fx", etc.
3069 insert any command in Insert mode
3070 jump far jumps: "G", "gg", etc.
3071 mark jumping to a mark: "'m", CTRL-O, etc.
3072 percent "%"
3073 quickfix ":cn", ":crew", ":make", etc.
3074 search search for a pattern: "/", "n", "*", "gd", etc.
3075 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003076 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077 tag jumping to a tag: ":ta", CTRL-T, etc.
3078 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003079 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 the |zv| command to the mapping to get the same effect.
3081 When a movement command is used for an operator (e.g., "dl" or "y%")
3082 this option is not used. This means the operator will include the
3083 whole closed fold.
3084 Note that vertical movements are not here, because it would make it
3085 very difficult to move onto a closed fold.
3086 In insert mode the folds containing the cursor will always be open
3087 when text is inserted.
3088 To close folds you can re-apply 'foldlevel' with the |zx| command or
3089 set the 'foldclose' option to "all".
3090
3091 *'foldtext'* *'fdt'*
3092'foldtext' 'fdt' string (default: "foldtext()")
3093 local to window
3094 {not in Vi}
3095 {not available when compiled without the |+folding|
3096 feature}
3097 An expression which is used to specify the text displayed for a closed
3098 fold. See |fold-foldtext|.
3099
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003100 The expression may be evaluated in the |sandbox|, see
3101 |sandbox-option|.
3102
3103 It is not allowed to change text or jump to another window while
3104 evaluating 'foldtext' |textlock|.
3105
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 *'formatoptions'* *'fo'*
3107'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3108 local to buffer
3109 {not in Vi}
3110 This is a sequence of letters which describes how automatic
3111 formatting is to be done. See |fo-table|. When the 'paste' option is
3112 on, no formatting is done (like 'formatoptions' is empty). Commas can
3113 be inserted for readability.
3114 To avoid problems with flags that are added in the future, use the
3115 "+=" and "-=" feature of ":set" |add-option-flags|.
3116 NOTE: This option is set to the Vi default value when 'compatible' is
3117 set and to the Vim default value when 'compatible' is reset.
3118
Bram Moolenaar86b68352004-12-27 21:59:20 +00003119 *'formatlistpat'* *'flp'*
3120'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3121 local to buffer
3122 {not in Vi}
3123 A pattern that is used to recognize a list header. This is used for
3124 the "n" flag in 'formatoptions'.
3125 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003126 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003127 while still checking more characters. There must be a character
3128 following the pattern, when it matches the whole line it is handled
3129 like there is no match.
3130 The default recognizes a number, followed by an optional punctuation
3131 character and white space.
3132
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 *'formatprg'* *'fp'*
3134'formatprg' 'fp' string (default "")
3135 global
3136 {not in Vi}
3137 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003138 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003140 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003141 If the 'formatexpr' option is not empty it will be used instead.
3142 Otherwise, if 'formatprg' option is an empty string, the internal
3143 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003144 Environment variables are expanded |:set_env|. See |option-backslash|
3145 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003146 The expression may be evaluated in the |sandbox|, see
3147 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003149 *'formatexpr'* *'fex'*
3150'formatexpr' 'fex' string (default "")
3151 local to buffer
3152 {not in Vi}
3153 {not available when compiled without the |+eval|
3154 feature}
3155 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003156 operator or automatic formatting (see 'formatoptions'). When this
3157 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003158
3159 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003160 The |v:count| variable holds the number of lines to be formatted.
3161 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003162 inserted if the expression is being evaluated due to
3163 automatic formatting. This can be empty. Don't insert
3164 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003165
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003166 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003167 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003168< This will invoke the mylang#Format() function in the
3169 autoload/mylang.vim file in 'runtimepath'. |autoload|
3170
3171 The expression is also evaluated when 'textwidth' is set and adding
3172 text beyond that limit. This happens under the same conditions as
3173 when internal formatting is used. Make sure the cursor is kept in the
3174 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003175 return "i" or "R" in this situation.
3176
3177 When the expression evaluates to non-zero Vim will fall back to using
3178 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003179
3180 The expression may be evaluated in the |sandbox|, see
3181 |sandbox-option|.
3182
3183 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003184'fsync' 'fs' boolean (default on)
3185 global
3186 {not in Vi}
3187 When on, the library function fsync() will be called after writing a
3188 file. This will flush a file to disk, ensuring that it is safely
3189 written even on filesystems which do metadata-only journaling. This
3190 will force the harddrive to spin up on Linux systems running in laptop
3191 mode, so it may be undesirable in some situations. Be warned that
3192 turning this off increases the chances of data loss after a crash. On
3193 systems without an fsync() implementation, this variable is always
3194 off.
3195 Also see 'swapsync' for controlling fsync() on swap files.
3196
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3198'gdefault' 'gd' boolean (default off)
3199 global
3200 {not in Vi}
3201 When on, the ":substitute" flag 'g' is default on. This means that
3202 all matches in a line are substituted instead of one. When a 'g' flag
3203 is given to a ":substitute" command, this will toggle the substitution
3204 of all or one match. See |complex-change|.
3205
3206 command 'gdefault' on 'gdefault' off ~
3207 :s/// subst. all subst. one
3208 :s///g subst. one subst. all
3209 :s///gg subst. all subst. one
3210
3211 NOTE: This option is reset when 'compatible' is set.
3212
3213 *'grepformat'* *'gfm'*
3214'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3215 global
3216 {not in Vi}
3217 Format to recognize for the ":grep" command output.
3218 This is a scanf-like string that uses the same format as the
3219 'errorformat' option: see |errorformat|.
3220
3221 *'grepprg'* *'gp'*
3222'grepprg' 'gp' string (default "grep -n ",
3223 Unix: "grep -n $* /dev/null",
3224 Win32: "findstr /n" or "grep -n",
3225 VMS: "SEARCH/NUMBERS ")
3226 global or local to buffer |global-local|
3227 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003228 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 and '#' characters, which are expanded like when used in a command-
3230 line. The placeholder "$*" is allowed to specify where the arguments
3231 will be included. Environment variables are expanded |:set_env|. See
3232 |option-backslash| about including spaces and backslashes.
3233 When your "grep" accepts the "-H" argument, use this to make ":grep"
3234 also work well with a single file: >
3235 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003236< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003237 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3238 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003239 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 apply equally to 'grepprg'.
3241 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3242 otherwise it's "grep -n".
3243 This option cannot be set from a |modeline| or in the |sandbox|, for
3244 security reasons.
3245
3246 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3247'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3248 ve:ver35-Cursor,
3249 o:hor50-Cursor,
3250 i-ci:ver25-Cursor/lCursor,
3251 r-cr:hor20-Cursor/lCursor,
3252 sm:block-Cursor
3253 -blinkwait175-blinkoff150-blinkon175",
3254 for MS-DOS and Win32 console:
3255 "n-v-c:block,o:hor50,i-ci:hor15,
3256 r-cr:hor30,sm:block")
3257 global
3258 {not in Vi}
3259 {only available when compiled with GUI enabled, and
3260 for MS-DOS and Win32 console}
3261 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003262 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 the height of the cursor can be changed. This can be done by
3264 specifying a block cursor, or a percentage for a vertical or
3265 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003266 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003268 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 mode-list and an argument-list:
3270 mode-list:argument-list,mode-list:argument-list,..
3271 The mode-list is a dash separated list of these modes:
3272 n Normal mode
3273 v Visual mode
3274 ve Visual mode with 'selection' "exclusive" (same as 'v',
3275 if not specified)
3276 o Operator-pending mode
3277 i Insert mode
3278 r Replace mode
3279 c Command-line Normal (append) mode
3280 ci Command-line Insert mode
3281 cr Command-line Replace mode
3282 sm showmatch in Insert mode
3283 a all modes
3284 The argument-list is a dash separated list of these arguments:
3285 hor{N} horizontal bar, {N} percent of the character height
3286 ver{N} vertical bar, {N} percent of the character width
3287 block block cursor, fills the whole character
3288 [only one of the above three should be present]
3289 blinkwait{N} *cursor-blinking*
3290 blinkon{N}
3291 blinkoff{N}
3292 blink times for cursor: blinkwait is the delay before
3293 the cursor starts blinking, blinkon is the time that
3294 the cursor is shown and blinkoff is the time that the
3295 cursor is not shown. The times are in msec. When one
3296 of the numbers is zero, there is no blinking. The
3297 default is: "blinkwait700-blinkon400-blinkoff250".
3298 These numbers are used for a missing entry. This
3299 means that blinking is enabled by default. To switch
3300 blinking off you can use "blinkon0". The cursor only
3301 blinks when Vim is waiting for input, not while
3302 executing a command.
3303 To make the cursor blink in an xterm, see
3304 |xterm-blink|.
3305 {group-name}
3306 a highlight group name, that sets the color and font
3307 for the cursor
3308 {group-name}/{group-name}
3309 Two highlight group names, the first is used when
3310 no language mappings are used, the other when they
3311 are. |language-mapping|
3312
3313 Examples of parts:
3314 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3315 block cursor with colors from the "nCursor"
3316 highlight group
3317 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3318 In Insert and Command-line Insert mode, use a
3319 30% vertical bar cursor with colors from the
3320 "iCursor" highlight group. Blink a bit
3321 faster.
3322
3323 The 'a' mode is different. It will set the given argument-list for
3324 all modes. It does not reset anything to defaults. This can be used
3325 to do a common setting for all modes. For example, to switch off
3326 blinking: "a:blinkon0"
3327
3328 Examples of cursor highlighting: >
3329 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3330 :highlight Cursor gui=NONE guifg=bg guibg=fg
3331<
3332 *'guifont'* *'gfn'*
3333 *E235* *E596* *E610* *E611*
3334'guifont' 'gfn' string (default "")
3335 global
3336 {not in Vi}
3337 {only available when compiled with GUI enabled}
3338 This is a list of fonts which will be used for the GUI version of Vim.
3339 In its simplest form the value is just one font name. When
3340 the font cannot be found you will get an error message. To try other
3341 font names a list can be specified, font names separated with commas.
3342 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003343
Bram Moolenaar05159a02005-02-26 23:04:13 +00003344 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3345 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003346
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 Spaces after a comma are ignored. To include a comma in a font name
3348 precede it with a backslash. Setting an option requires an extra
3349 backslash before a space and a backslash. See also
3350 |option-backslash|. For example: >
3351 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003352< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003354
3355 If none of the fonts can be loaded, Vim will keep the current setting.
3356 If an empty font list is given, Vim will try using other resource
3357 settings (for X, it will use the Vim.font resource), and finally it
3358 will try some builtin default which should always be there ("7x13" in
3359 the case of X). The font names given should be "normal" fonts. Vim
3360 will try to find the related bold and italic fonts.
3361
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003362 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003363 :set guifont=*
3364< will bring up a font requester, where you can pick the font you want.
3365
3366 The font name depends on the GUI used. See |setting-guifont| for a
3367 way to set 'guifont' for various systems.
3368
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 For the GTK+ 2 GUI the font name looks like this: >
3370 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003371< That's all. XLFDs are not used. For Chinese this is reported to work
3372 well: >
3373 if has("gui_gtk2")
3374 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3375 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3376 endif
3377<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003378 For Mac OSX you can use something like this: >
3379 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003380< Also see 'macatsui', it can help fix display problems.
3381 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003383 width). An exception is GTK 2: all fonts are accepted, but
3384 mono-spaced fonts look best.
3385
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 To preview a font on X11, you might be able to use the "xfontsel"
3387 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003388
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389 For the Win32 GUI *E244* *E245*
3390 - takes these options in the font name:
3391 hXX - height is XX (points, can be floating-point)
3392 wXX - width is XX (points, can be floating-point)
3393 b - bold
3394 i - italic
3395 u - underline
3396 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003397 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3399 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3400 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003401 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402
3403 Use a ':' to separate the options.
3404 - A '_' can be used in the place of a space, so you don't need to use
3405 backslashes to escape the spaces.
3406 - Examples: >
3407 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3408 :set guifont=Andale_Mono:h7.5:w4.5
3409< See also |font-sizes|.
3410
3411 *'guifontset'* *'gfs'*
3412 *E250* *E252* *E234* *E597* *E598*
3413'guifontset' 'gfs' string (default "")
3414 global
3415 {not in Vi}
3416 {only available when compiled with GUI enabled and
3417 with the |+xfontset| feature}
3418 {not available in the GTK+ 2 GUI}
3419 When not empty, specifies two (or more) fonts to be used. The first
3420 one for normal English, the second one for your special language. See
3421 |xfontset|.
3422 Setting this option also means that all font names will be handled as
3423 a fontset name. Also the ones used for the "font" argument of the
3424 |:highlight| command.
3425 The fonts must match with the current locale. If fonts for the
3426 character sets that the current locale uses are not included, setting
3427 'guifontset' will fail.
3428 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3429 the comma-separated names are alternative names, one of which will be
3430 used. In 'guifontset' the whole string is one fontset name,
3431 including the commas. It is not possible to specify alternative
3432 fontset names.
3433 This example works on many X11 systems: >
3434 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3435<
3436 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3437'guifontwide' 'gfw' string (default "")
3438 global
3439 {not in Vi}
3440 {only available when compiled with GUI enabled}
3441 When not empty, specifies a comma-separated list of fonts to be used
3442 for double-width characters. The first font that can be loaded is
3443 used.
3444 Note: The size of these fonts must be exactly twice as wide as the one
3445 specified with 'guifont' and the same height.
3446
3447 All GUI versions but GTK+ 2:
3448
3449 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3450 'guifontset' is empty or invalid.
3451 When 'guifont' is set and a valid font is found in it and
3452 'guifontwide' is empty Vim will attempt to find a matching
3453 double-width font and set 'guifontwide' to it.
3454
3455 GTK+ 2 GUI only: *guifontwide_gtk2*
3456
3457 If set and valid, 'guifontwide' is always used for double width
3458 characters, even if 'encoding' is not set to "utf-8".
3459 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003460 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 font for characters not available in 'guifont'. Thus you do not need
3462 to set 'guifontwide' at all unless you want to override the choice
3463 made by Pango/Xft.
3464
3465 *'guiheadroom'* *'ghr'*
3466'guiheadroom' 'ghr' number (default 50)
3467 global
3468 {not in Vi} {only for GTK and X11 GUI}
3469 The number of pixels subtracted from the screen height when fitting
3470 the GUI window on the screen. Set this before the GUI is started,
3471 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003472 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 lines will be left for window decorations and other items on the
3474 screen. Set it to a negative value to allow windows taller than the
3475 screen.
3476
3477 *'guioptions'* *'go'*
3478'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003479 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 global
3481 {not in Vi}
3482 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003483 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 sequence of letters which describes what components and options of the
3485 GUI should be used.
3486 To avoid problems with flags that are added in the future, use the
3487 "+=" and "-=" feature of ":set" |add-option-flags|.
3488
3489 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003490 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 'a' Autoselect: If present, then whenever VISUAL mode is started,
3492 or the Visual area extended, Vim tries to become the owner of
3493 the windowing system's global selection. This means that the
3494 Visually highlighted text is available for pasting into other
3495 applications as well as into Vim itself. When the Visual mode
3496 ends, possibly due to an operation on the text, or when an
3497 application wants to paste the selection, the highlighted text
3498 is automatically yanked into the "* selection register.
3499 Thus the selection is still available for pasting into other
3500 applications after the VISUAL mode has ended.
3501 If not present, then Vim won't become the owner of the
3502 windowing system's global selection unless explicitly told to
3503 by a yank or delete operation for the "* register.
3504 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003505 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003506 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507 applies to the modeless selection.
3508
3509 'guioptions' autoselect Visual autoselect modeless ~
3510 "" - -
3511 "a" yes yes
3512 "A" - yes
3513 "aA" yes yes
3514
Bram Moolenaar02467872007-05-06 13:22:01 +00003515 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 'c' Use console dialogs instead of popup dialogs for simple
3517 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003518 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003519 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003520 'guitablabel' can be used to change the text in the labels.
3521 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003522 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003523 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003524 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 'f' Foreground: Don't use fork() to detach the GUI from the shell
3526 where it was started. Use this for programs that wait for the
3527 editor to finish (e.g., an e-mail program). Alternatively you
3528 can use "gvim -f" or ":gui -f" to start the GUI in the
3529 foreground. |gui-fork|
3530 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003531 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003532 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3534 corner of the window. It's black&white on non-GTK, because of
3535 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003536 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003538 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003539 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003541 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 file is sourced the system menu has already been loaded; the
3543 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003544 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 'g' Grey menu items: Make menu items that are not active grey. If
3546 'g' is not included inactive menu items are not shown at all.
3547 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003548 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 't' Include tearoff menu items. Currently only works for Win32,
3550 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003551 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003552 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003553 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003554 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003556 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 'R' Right-hand scrollbar is present when there is a vertically
3558 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003559 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003561 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 'L' Left-hand scrollbar is present when there is a vertically
3563 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003564 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003565 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3566 the longest visible line, or on the cursor line if the 'h'
3567 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003568 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 'h' Limit horizontal scrollbar size to the length of the cursor
3570 line. Reduces computations. |gui-horiz-scroll|
3571
3572 And yes, you may even have scrollbars on the left AND the right if
3573 you really want to :-). See |gui-scrollbars| for more information.
3574
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003575 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576 'v' Use a vertical button layout for dialogs. When not included,
3577 a horizontal layout is preferred, but when it doesn't fit a
3578 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003579 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 'p' Use Pointer callbacks for X11 GUI. This is required for some
3581 window managers. If the cursor is not blinking or hollow at
3582 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003583 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003585 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003586 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587
Bram Moolenaar02467872007-05-06 13:22:01 +00003588
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 *'guipty'* *'noguipty'*
3590'guipty' boolean (default on)
3591 global
3592 {not in Vi}
3593 {only available when compiled with GUI enabled}
3594 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3595 I/O to/from shell commands. See |gui-pty|.
3596
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003597 *'guitablabel'* *'gtl'*
3598'guitablabel' 'gtl' string (default empty)
3599 global
3600 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003601 {only available when compiled with GUI enabled and
3602 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003603 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003604 pages line. When empty and when the result is empty Vim will use a
3605 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003606
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003607 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003608 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003609
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003610 Only used when the GUI tab pages line is displayed. 'e' must be
3611 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3612 used.
3613
Bram Moolenaar57657d82006-04-21 22:12:41 +00003614 *'guitabtooltip'* *'gtt'*
3615'guitabtooltip' 'gtt' string (default empty)
3616 global
3617 {not in Vi}
3618 {only available when compiled with GUI enabled and
3619 with the +windows feature}
3620 When nonempty describes the text to use in a tooltip for the GUI tab
3621 pages line. When empty Vim will use a default tooltip.
3622 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003623 You can include a line break. Simplest method is to use |:let|: >
3624 :let &guitabtooltip = "line one\nline two"
3625<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003626
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 *'helpfile'* *'hf'*
3628'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3629 (others) "$VIMRUNTIME/doc/help.txt")
3630 global
3631 {not in Vi}
3632 Name of the main help file. All distributed help files should be
3633 placed together in one directory. Additionally, all "doc" directories
3634 in 'runtimepath' will be used.
3635 Environment variables are expanded |:set_env|. For example:
3636 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003637 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 spaces and backslashes.
3639 This option cannot be set from a |modeline| or in the |sandbox|, for
3640 security reasons.
3641
3642 *'helpheight'* *'hh'*
3643'helpheight' 'hh' number (default 20)
3644 global
3645 {not in Vi}
3646 {not available when compiled without the +windows
3647 feature}
3648 Minimal initial height of the help window when it is opened with the
3649 ":help" command. The initial height of the help window is half of the
3650 current window, or (when the 'ea' option is on) the same as other
3651 windows. When the height is less than 'helpheight', the height is
3652 set to 'helpheight'. Set to zero to disable.
3653
3654 *'helplang'* *'hlg'*
3655'helplang' 'hlg' string (default: messages language or empty)
3656 global
3657 {only available when compiled with the |+multi_lang|
3658 feature}
3659 {not in Vi}
3660 Comma separated list of languages. Vim will use the first language
3661 for which the desired help can be found. The English help will always
3662 be used as a last resort. You can add "en" to prefer English over
3663 another language, but that will only find tags that exist in that
3664 language and not in the English help.
3665 Example: >
3666 :set helplang=de,it
3667< This will first search German, then Italian and finally English help
3668 files.
3669 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3670 try to find the tag in the current language before using this option.
3671 See |help-translated|.
3672
3673 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3674'hidden' 'hid' boolean (default off)
3675 global
3676 {not in Vi}
3677 When off a buffer is unloaded when it is |abandon|ed. When on a
3678 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3679 displayed in another window, it does not become hidden, of course.
3680 The commands that move through the buffer list sometimes make a buffer
3681 hidden although the 'hidden' option is off: When the buffer is
3682 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003683 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003684 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 This option is set for one command with ":hide {command}" |:hide|.
3686 WARNING: It's easy to forget that you have changes in hidden buffers.
3687 Think twice when using ":q!" or ":qa!".
3688
3689 *'highlight'* *'hl'*
3690'highlight' 'hl' string (default (as a single string):
3691 "8:SpecialKey,@:NonText,d:Directory,
3692 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3693 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003694 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3696 f:Folded,F:FoldColumn,A:DiffAdd,
3697 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003698 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003699 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003700 +:Pmenu,=:PmenuSel,
3701 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 global
3703 {not in Vi}
3704 This option can be used to set highlighting mode for various
3705 occasions. It is a comma separated list of character pairs. The
3706 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003707 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3709 |hl-NonText| @ '~' and '@' at the end of the window and
3710 characters from 'showbreak'
3711 |hl-Directory| d directories in CTRL-D listing and other special
3712 things in listings
3713 |hl-ErrorMsg| e error messages
3714 h (obsolete, ignored)
3715 |hl-IncSearch| i 'incsearch' highlighting
3716 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3717 |hl-MoreMsg| m |more-prompt|
3718 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003719 |hl-LineNr| n line number for ":number" and ":#" commands, and
3720 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 |hl-Question| r |hit-enter| prompt and yes/no questions
3722 |hl-StatusLine| s status line of current window |status-line|
3723 |hl-StatusLineNC| S status lines of not-current windows
3724 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3725 |hl-VertSplit| c column used to separate vertically split windows
3726 |hl-Visual| v Visual mode
3727 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3728 Selection" Only X11 Gui's |gui-x11| and
3729 |xterm-clipboard|.
3730 |hl-WarningMsg| w warning messages
3731 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3732 |hl-Folded| f line used for closed folds
3733 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003734 |hl-DiffAdd| A added line in diff mode
3735 |hl-DiffChange| C changed line in diff mode
3736 |hl-DiffDelete| D deleted line in diff mode
3737 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003739 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003740 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003741 |hl-SpellRare| R rare word |spell|
3742 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003743 |hl-Conceal| - the placeholders used for concealed characters
3744 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003745 |hl-Pmenu| + popup menu normal line
3746 |hl-PmenuSel| = popup menu normal line
3747 |hl-PmenuSbar| x popup menu scrollbar
3748 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749
3750 The display modes are:
3751 r reverse (termcap entry "mr" and "me")
3752 i italic (termcap entry "ZH" and "ZR")
3753 b bold (termcap entry "md" and "me")
3754 s standout (termcap entry "so" and "se")
3755 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003756 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 n no highlighting
3758 - no highlighting
3759 : use a highlight group
3760 The default is used for occasions that are not included.
3761 If you want to change what the display modes do, see |dos-colors|
3762 for an example.
3763 When using the ':' display mode, this must be followed by the name of
3764 a highlight group. A highlight group can be used to define any type
3765 of highlighting, including using color. See |:highlight| on how to
3766 define one. The default uses a different group for each occasion.
3767 See |highlight-default| for the default highlight groups.
3768
3769 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3770'hlsearch' 'hls' boolean (default off)
3771 global
3772 {not in Vi}
3773 {not available when compiled without the
3774 |+extra_search| feature}
3775 When there is a previous search pattern, highlight all its matches.
3776 The type of highlighting used can be set with the 'l' occasion in the
3777 'highlight' option. This uses the "Search" highlight group by
3778 default. Note that only the matching text is highlighted, any offsets
3779 are not applied.
3780 See also: 'incsearch' and |:match|.
3781 When you get bored looking at the highlighted matches, you can turn it
3782 off with |:nohlsearch|. As soon as you use a search command, the
3783 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003784 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 When the search pattern can match an end-of-line, Vim will try to
3786 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003787 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003789 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 NOTE: This option is reset when 'compatible' is set.
3791
3792 *'history'* *'hi'*
3793'history' 'hi' number (Vim default: 20, Vi default: 0)
3794 global
3795 {not in Vi}
3796 A history of ":" commands, and a history of previous search patterns
3797 are remembered. This option decides how many entries may be stored in
3798 each of these histories (see |cmdline-editing|).
3799 NOTE: This option is set to the Vi default value when 'compatible' is
3800 set and to the Vim default value when 'compatible' is reset.
3801
3802 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3803'hkmap' 'hk' boolean (default off)
3804 global
3805 {not in Vi}
3806 {only available when compiled with the |+rightleft|
3807 feature}
3808 When on, the keyboard is mapped for the Hebrew character set.
3809 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3810 toggle this option. See |rileft.txt|.
3811 NOTE: This option is reset when 'compatible' is set.
3812
3813 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3814'hkmapp' 'hkp' boolean (default off)
3815 global
3816 {not in Vi}
3817 {only available when compiled with the |+rightleft|
3818 feature}
3819 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3820 This is useful if you have a non-Hebrew keyboard.
3821 See |rileft.txt|.
3822 NOTE: This option is reset when 'compatible' is set.
3823
3824 *'icon'* *'noicon'*
3825'icon' boolean (default off, on when title can be restored)
3826 global
3827 {not in Vi}
3828 {not available when compiled without the |+title|
3829 feature}
3830 When on, the icon text of the window will be set to the value of
3831 'iconstring' (if it is not empty), or to the name of the file
3832 currently being edited. Only the last part of the name is used.
3833 Overridden by the 'iconstring' option.
3834 Only works if the terminal supports setting window icons (currently
3835 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3836 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3837 builtin termcap).
3838 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003839 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 X11.
3841
3842 *'iconstring'*
3843'iconstring' string (default "")
3844 global
3845 {not in Vi}
3846 {not available when compiled without the |+title|
3847 feature}
3848 When this option is not empty, it will be used for the icon text of
3849 the window. This happens only when the 'icon' option is on.
3850 Only works if the terminal supports setting window icon text
3851 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3852 Does not work for MS Windows.
3853 When Vim was compiled with HAVE_X11 defined, the original icon will be
3854 restored if possible |X11|.
3855 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003856 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857 'titlestring' for example settings.
3858 {not available when compiled without the |+statusline| feature}
3859
3860 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3861'ignorecase' 'ic' boolean (default off)
3862 global
3863 Ignore case in search patterns. Also used when searching in the tags
3864 file.
3865 Also see 'smartcase'.
3866 Can be overruled by using "\c" or "\C" in the pattern, see
3867 |/ignorecase|.
3868
3869 *'imactivatekey'* *'imak'*
3870'imactivatekey' 'imak' string (default "")
3871 global
3872 {not in Vi}
3873 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003874 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 Specifies the key that your Input Method in X-Windows uses for
3876 activation. When this is specified correctly, vim can fully control
3877 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3878 You can't use this option to change the activation key, the option
3879 tells Vim what the key is.
3880 Format:
3881 [MODIFIER_FLAG-]KEY_STRING
3882
3883 These characters can be used for MODIFIER_FLAG (case is ignored):
3884 S Shift key
3885 L Lock key
3886 C Control key
3887 1 Mod1 key
3888 2 Mod2 key
3889 3 Mod3 key
3890 4 Mod4 key
3891 5 Mod5 key
3892 Combinations are allowed, for example "S-C-space" or "SC-space" are
3893 both shift+ctrl+space.
3894 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3895
3896 Example: >
3897 :set imactivatekey=S-space
3898< "S-space" means shift+space. This is the activation key for kinput2 +
3899 canna (Japanese), and ami (Korean).
3900
3901 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3902'imcmdline' 'imc' boolean (default off)
3903 global
3904 {not in Vi}
3905 {only available when compiled with the |+xim|
3906 |+multi_byte_ime| or |global-ime| feature}
3907 When set the Input Method is always on when starting to edit a command
3908 line, unless entering a search pattern (see 'imsearch' for that).
3909 Setting this option is useful when your input method allows entering
3910 English characters directly, e.g., when it's used to type accented
3911 characters with dead keys.
3912
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003913 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3915 global
3916 {not in Vi}
3917 {only available when compiled with the |+xim|
3918 |+multi_byte_ime| or |global-ime| feature}
3919 When set the Input Method is never used. This is useful to disable
3920 the IM when it doesn't work properly.
3921 Currently this option is on by default for SGI/IRIX machines. This
3922 may change in later releases.
3923
3924 *'iminsert'* *'imi'*
3925'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3926 local to buffer
3927 {not in Vi}
3928 Specifies whether :lmap or an Input Method (IM) is to be used in
3929 Insert mode. Valid values:
3930 0 :lmap is off and IM is off
3931 1 :lmap is ON and IM is off
3932 2 :lmap is off and IM is ON
3933 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3934 or |global-ime|.
3935 To always reset the option to zero when leaving Insert mode with <Esc>
3936 this can be used: >
3937 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3938< This makes :lmap and IM turn off automatically when leaving Insert
3939 mode.
3940 Note that this option changes when using CTRL-^ in Insert mode
3941 |i_CTRL-^|.
3942 The value is set to 1 when setting 'keymap' to a valid keymap name.
3943 It is also used for the argument of commands like "r" and "f".
3944 The value 0 may not work correctly with Athena and Motif with some XIM
3945 methods. Use 'imdisable' to disable XIM then.
3946
3947 *'imsearch'* *'ims'*
3948'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3949 local to buffer
3950 {not in Vi}
3951 Specifies whether :lmap or an Input Method (IM) is to be used when
3952 entering a search pattern. Valid values:
3953 -1 the value of 'iminsert' is used, makes it look like
3954 'iminsert' is also used when typing a search pattern
3955 0 :lmap is off and IM is off
3956 1 :lmap is ON and IM is off
3957 2 :lmap is off and IM is ON
3958 Note that this option changes when using CTRL-^ in Command-line mode
3959 |c_CTRL-^|.
3960 The value is set to 1 when it is not -1 and setting the 'keymap'
3961 option to a valid keymap name.
3962 The value 0 may not work correctly with Athena and Motif with some XIM
3963 methods. Use 'imdisable' to disable XIM then.
3964
3965 *'include'* *'inc'*
3966'include' 'inc' string (default "^\s*#\s*include")
3967 global or local to buffer |global-local|
3968 {not in Vi}
3969 {not available when compiled without the
3970 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003971 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 pattern, just like for the "/" command (See |pattern|). The default
3973 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003974 "]I", "[d", etc.
3975 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003976 comes after the matched pattern. But if "\zs" appears in the pattern
3977 then the text matched from "\zs" to the end, or until "\ze" if it
3978 appears, is used as the file name. Use this to include characters
3979 that are not in 'isfname', such as a space. You can then use
3980 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003981 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982
3983 *'includeexpr'* *'inex'*
3984'includeexpr' 'inex' string (default "")
3985 local to buffer
3986 {not in Vi}
3987 {not available when compiled without the
3988 |+find_in_path| or |+eval| feature}
3989 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003990 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 :set includeexpr=substitute(v:fname,'\\.','/','g')
3992< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003993
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003995 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 Also used for |<cfile>|.
3997
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003998 The expression may be evaluated in the |sandbox|, see
3999 |sandbox-option|.
4000
4001 It is not allowed to change text or jump to another window while
4002 evaluating 'includeexpr' |textlock|.
4003
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4005'incsearch' 'is' boolean (default off)
4006 global
4007 {not in Vi}
4008 {not available when compiled without the
4009 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004010 While typing a search command, show where the pattern, as it was typed
4011 so far, matches. The matched string is highlighted. If the pattern
4012 is invalid or not found, nothing is shown. The screen will be updated
4013 often, this is only useful on fast terminals.
4014 Note that the match will be shown, but the cursor will return to its
4015 original position when no match is found and when pressing <Esc>. You
4016 still need to finish the search command with <Enter> to move the
4017 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004018 When compiled with the |+reltime| feature Vim only searches for about
4019 half a second. With a complicated pattern and/or a lot of text the
4020 match may not be found. This is to avoid that Vim hangs while you
4021 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004022 The highlighting can be set with the 'i' flag in 'highlight'.
4023 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004024 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004025 to the command line. If 'ignorecase' and 'smartcase' are set and the
4026 command line has no uppercase characters, the added character is
4027 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004028 CTRL-R CTRL-W can be used to add the word at the end of the current
4029 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 NOTE: This option is reset when 'compatible' is set.
4031
4032 *'indentexpr'* *'inde'*
4033'indentexpr' 'inde' string (default "")
4034 local to buffer
4035 {not in Vi}
4036 {not available when compiled without the |+cindent|
4037 or |+eval| features}
4038 Expression which is evaluated to obtain the proper indent for a line.
4039 It is used when a new line is created, for the |=| operator and
4040 in Insert mode as specified with the 'indentkeys' option.
4041 When this option is not empty, it overrules the 'cindent' and
4042 'smartindent' indenting.
4043 When 'paste' is set this option is not used for indenting.
4044 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004045 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 when the expression is evaluated (but it may be moved around).
4047 The expression must return the number of spaces worth of indent. It
4048 can return "-1" to keep the current indent (this means 'autoindent' is
4049 used for the indent).
4050 Functions useful for computing the indent are |indent()|, |cindent()|
4051 and |lispindent()|.
4052 The evaluation of the expression must not have side effects! It must
4053 not change the text, jump to another window, etc. Afterwards the
4054 cursor position is always restored, thus the cursor may be moved.
4055 Normally this option would be set to call a function: >
4056 :set indentexpr=GetMyIndent()
4057< Error messages will be suppressed, unless the 'debug' option contains
4058 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004059 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060 NOTE: This option is made empty when 'compatible' is set.
4061
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004062 The expression may be evaluated in the |sandbox|, see
4063 |sandbox-option|.
4064
4065 It is not allowed to change text or jump to another window while
4066 evaluating 'indentexpr' |textlock|.
4067
4068
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 *'indentkeys'* *'indk'*
4070'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4071 local to buffer
4072 {not in Vi}
4073 {not available when compiled without the |+cindent|
4074 feature}
4075 A list of keys that, when typed in Insert mode, cause reindenting of
4076 the current line. Only happens if 'indentexpr' isn't empty.
4077 The format is identical to 'cinkeys', see |indentkeys-format|.
4078 See |C-indenting| and |indent-expression|.
4079
4080 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4081'infercase' 'inf' boolean (default off)
4082 local to buffer
4083 {not in Vi}
4084 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004085 'ignorecase' is also on, the case of the match is adjusted depending
4086 on the typed text. If the typed text contains a lowercase letter
4087 where the match has an upper case letter, the completed part is made
4088 lowercase. If the typed text has no lowercase letters and the match
4089 has a lowercase letter where the typed text has an uppercase letter,
4090 and there is a letter before it, the completed part is made uppercase.
4091 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092
4093 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4094'insertmode' 'im' boolean (default off)
4095 global
4096 {not in Vi}
4097 Makes Vim work in a way that Insert mode is the default mode. Useful
4098 if you want to use Vim as a modeless editor. Used for |evim|.
4099 These Insert mode commands will be useful:
4100 - Use the cursor keys to move around.
4101 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4102 this is a mapping, it is executed as if 'insertmode' was off.
4103 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004105 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4106 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107
4108 These items change when 'insertmode' is set:
4109 - when starting to edit of a file, Vim goes to Insert mode.
4110 - <Esc> in Insert mode is a no-op and beeps.
4111 - <Esc> in Normal mode makes Vim go to Insert mode.
4112 - CTRL-L in Insert mode is a command, it is not inserted.
4113 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4114 However, when <Esc> is used inside a mapping, it behaves like
4115 'insertmode' was not set. This was done to be able to use the same
4116 mappings with 'insertmode' set or not set.
4117 When executing commands with |:normal| 'insertmode' is not used.
4118
4119 NOTE: This option is reset when 'compatible' is set.
4120
4121 *'isfname'* *'isf'*
4122'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4123 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4124 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4125 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4126 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4127 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4128 global
4129 {not in Vi}
4130 The characters specified by this option are included in file names and
4131 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004132 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 Multi-byte characters 256 and above are always included, only the
4134 characters up to 255 are specified with this option.
4135 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004136 Think twice before adding white space to this option. Although a
4137 space may appear inside a file name, the effect will be that Vim
4138 doesn't know where a file name starts or ends when doing completion.
4139 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140
4141 Note that on systems using a backslash as path separator, Vim tries to
4142 do its best to make it work as you would expect. That is a bit
4143 tricky, since Vi originally used the backslash to escape special
4144 characters. Vim will not remove a backslash in front of a normal file
4145 name character on these systems, but it will on Unix and alikes. The
4146 '&' and '^' are not included by default, because these are special for
4147 cmd.exe.
4148
4149 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004150 Each part can be a single character number or a range. A range is two
4151 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 decimal number between 0 and 255 or the ASCII character itself (does
4153 not work for digits). Example:
4154 "_,-,128-140,#-43" (include '_' and '-' and the range
4155 128 to 140 and '#' to 43)
4156 If a part starts with '^', the following character number or range
4157 will be excluded from the option. The option is interpreted from left
4158 to right. Put the excluded character after the range where it is
4159 included. To include '^' itself use it as the last character of the
4160 option or the end of a range. Example:
4161 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4162 If the character is '@', all characters where isalpha() returns TRUE
4163 are included. Normally these are the characters a to z and A to Z,
4164 plus accented characters. To include '@' itself use "@-@". Examples:
4165 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004166 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 "a-z,A-Z,@-@" All letters plus the '@' character.
4168 A comma can be included by using it where a character number is
4169 expected. Example:
4170 "48-57,,,_" Digits, comma and underscore.
4171 A comma can be excluded by prepending a '^'. Example:
4172 " -~,^,,9" All characters from space to '~', excluding
4173 comma, plus <Tab>.
4174 See |option-backslash| about including spaces and backslashes.
4175
4176 *'isident'* *'isi'*
4177'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4178 "@,48-57,_,128-167,224-235"
4179 otherwise: "@,48-57,_,192-255")
4180 global
4181 {not in Vi}
4182 The characters given by this option are included in identifiers.
4183 Identifiers are used in recognizing environment variables and after a
4184 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004185 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 option.
4187 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004188 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4190
4191 *'iskeyword'* *'isk'*
4192'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4193 "@,48-57,_,128-167,224-235"
4194 otherwise: "@,48-57,_,192-255"
4195 Vi default: "@,48-57,_")
4196 local to buffer
4197 {not in Vi}
4198 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004199 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 'isfname' for a description of the format of this option. For C
4201 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4202 For a help file it is set to all non-blank printable characters except
4203 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4204 command).
4205 When the 'lisp' option is on the '-' character is always included.
4206 NOTE: This option is set to the Vi default value when 'compatible' is
4207 set and to the Vim default value when 'compatible' is reset.
4208
4209 *'isprint'* *'isp'*
4210'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4211 "@,~-255"; otherwise: "@,161-255")
4212 global
4213 {not in Vi}
4214 The characters given by this option are displayed directly on the
4215 screen. It is also used for "\p" in a |pattern|. The characters from
4216 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4217 even when they are not included in 'isprint' or excluded. See
4218 'isfname' for a description of the format of this option.
4219
4220 Non-printable characters are displayed with two characters:
4221 0 - 31 "^@" - "^_"
4222 32 - 126 always single characters
4223 127 "^?"
4224 128 - 159 "~@" - "~_"
4225 160 - 254 "| " - "|~"
4226 255 "~?"
4227 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4228 displayed as <xx>, with the hexadecimal value of the byte.
4229 When 'display' contains "uhex" all unprintable characters are
4230 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004231 The SpecialKey highlighting will be used for unprintable characters.
4232 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233
4234 Multi-byte characters 256 and above are always included, only the
4235 characters up to 255 are specified with this option. When a character
4236 is printable but it is not available in the current font, a
4237 replacement character will be shown.
4238 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4239 There is no option to specify these characters.
4240
4241 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4242'joinspaces' 'js' boolean (default on)
4243 global
4244 {not in Vi}
4245 Insert two spaces after a '.', '?' and '!' with a join command.
4246 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4247 Otherwise only one space is inserted.
4248 NOTE: This option is set when 'compatible' is set.
4249
4250 *'key'*
4251'key' string (default "")
4252 local to buffer
4253 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004254 {only available when compiled with the |+cryptv|
4255 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004257 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 Careful: Do not set the key value by hand, someone might see the typed
4259 key. Use the |:X| command. But you can make 'key' empty: >
4260 :set key=
4261< It is not possible to get the value of this option with ":set key" or
4262 "echo &key". This is to avoid showing it to someone who shouldn't
4263 know. It also means you cannot see it yourself once you have set it,
4264 be careful not to make a typing error!
4265
4266 *'keymap'* *'kmp'* *E544*
4267'keymap' 'kmp' string (default "")
4268 local to buffer
4269 {not in Vi}
4270 {only available when compiled with the |+keymap|
4271 feature}
4272 Name of a keyboard mapping. See |mbyte-keymap|.
4273 Setting this option to a valid keymap name has the side effect of
4274 setting 'iminsert' to one, so that the keymap becomes effective.
4275 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004276 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277
4278 *'keymodel'* *'km'*
4279'keymodel' 'km' string (default "")
4280 global
4281 {not in Vi}
4282 List of comma separated words, which enable special things that keys
4283 can do. These values can be used:
4284 startsel Using a shifted special key starts selection (either
4285 Select mode or Visual mode, depending on "key" being
4286 present in 'selectmode').
4287 stopsel Using a not-shifted special key stops selection.
4288 Special keys in this context are the cursor keys, <End>, <Home>,
4289 <PageUp> and <PageDown>.
4290 The 'keymodel' option is set by the |:behave| command.
4291
4292 *'keywordprg'* *'kp'*
4293'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4294 OS/2: "view /", VMS: "help")
4295 global or local to buffer |global-local|
4296 {not in Vi}
4297 Program to use for the |K| command. Environment variables are
4298 expanded |:set_env|. ":help" may be used to access the Vim internal
4299 help. (Note that previously setting the global option to the empty
4300 value did this, which is now deprecated.)
4301 When "man" is used, Vim will automatically translate a count for the
4302 "K" command to a section number. Also for "man -s", in which case the
4303 "-s" is removed when there is no count.
4304 See |option-backslash| about including spaces and backslashes.
4305 Example: >
4306 :set keywordprg=man\ -s
4307< This option cannot be set from a |modeline| or in the |sandbox|, for
4308 security reasons.
4309
4310 *'langmap'* *'lmap'* *E357* *E358*
4311'langmap' 'lmap' string (default "")
4312 global
4313 {not in Vi}
4314 {only available when compiled with the |+langmap|
4315 feature}
4316 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004317 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 inserted directly. When in command mode the 'langmap' option takes
4319 care of translating these special characters to the original meaning
4320 of the key. This means you don't have to change the keyboard mode to
4321 be able to execute Normal mode commands.
4322 This is the opposite of the 'keymap' option, where characters are
4323 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004325 Example (for Greek, in UTF-8): *greek* >
4326 :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 +00004327< Example (exchanges meaning of z and y for commands): >
4328 :set langmap=zy,yz,ZY,YZ
4329<
4330 The 'langmap' option is a list of parts, separated with commas. Each
4331 part can be in one of two forms:
4332 1. A list of pairs. Each pair is a "from" character immediately
4333 followed by the "to" character. Examples: "aA", "aAbBcC".
4334 2. A list of "from" characters, a semi-colon and a list of "to"
4335 characters. Example: "abc;ABC"
4336 Example: "aA,fgh;FGH,cCdDeE"
4337 Special characters need to be preceded with a backslash. These are
4338 ";", ',' and backslash itself.
4339
4340 This will allow you to activate vim actions without having to switch
4341 back and forth between the languages. Your language characters will
4342 be understood as normal vim English characters (according to the
4343 langmap mappings) in the following cases:
4344 o Normal/Visual mode (commands, buffer/register names, user mappings)
4345 o Insert/Replace Mode: Register names after CTRL-R
4346 o Insert/Replace Mode: Mappings
4347 Characters entered in Command-line mode will NOT be affected by
4348 this option. Note that this option can be changed at any time
4349 allowing to switch between mappings for different languages/encodings.
4350 Use a mapping to avoid having to type it each time!
4351
4352 *'langmenu'* *'lm'*
4353'langmenu' 'lm' string (default "")
4354 global
4355 {not in Vi}
4356 {only available when compiled with the |+menu| and
4357 |+multi_lang| features}
4358 Language to use for menu translation. Tells which file is loaded
4359 from the "lang" directory in 'runtimepath': >
4360 "lang/menu_" . &langmenu . ".vim"
4361< (without the spaces). For example, to always use the Dutch menus, no
4362 matter what $LANG is set to: >
4363 :set langmenu=nl_NL.ISO_8859-1
4364< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004365 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366 If your $LANG is set to a non-English language but you do want to use
4367 the English menus: >
4368 :set langmenu=none
4369< This option must be set before loading menus, switching on filetype
4370 detection or syntax highlighting. Once the menus are defined setting
4371 this option has no effect. But you could do this: >
4372 :source $VIMRUNTIME/delmenu.vim
4373 :set langmenu=de_DE.ISO_8859-1
4374 :source $VIMRUNTIME/menu.vim
4375< Warning: This deletes all menus that you defined yourself!
4376
4377 *'laststatus'* *'ls'*
4378'laststatus' 'ls' number (default 1)
4379 global
4380 {not in Vi}
4381 The value of this option influences when the last window will have a
4382 status line:
4383 0: never
4384 1: only if there are at least two windows
4385 2: always
4386 The screen looks nicer with a status line if you have several
4387 windows, but it takes another screen line. |status-line|
4388
4389 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4390'lazyredraw' 'lz' boolean (default off)
4391 global
4392 {not in Vi}
4393 When this option is set, the screen will not be redrawn while
4394 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004395 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 update use |:redraw|.
4397
4398 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4399'linebreak' 'lbr' boolean (default off)
4400 local to window
4401 {not in Vi}
4402 {not available when compiled without the |+linebreak|
4403 feature}
4404 If on Vim will wrap long lines at a character in 'breakat' rather
4405 than at the last character that fits on the screen. Unlike
4406 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4407 it only affects the way the file is displayed, not its contents. The
4408 value of 'showbreak' is used to put in front of wrapped lines.
4409 This option is not used when the 'wrap' option is off or 'list' is on.
4410 Note that <Tab> characters after an <EOL> are mostly not displayed
4411 with the right amount of white space.
4412
4413 *'lines'* *E593*
4414'lines' number (default 24 or terminal height)
4415 global
4416 Number of lines of the Vim window.
4417 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004418 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 When Vim is running in the GUI or in a resizable window, setting this
4420 option will cause the window size to be changed. When you only want
4421 to use the size for the GUI, put the command in your |gvimrc| file.
4422 Vim limits the number of lines to what fits on the screen. You can
4423 use this command to get the tallest window possible: >
4424 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004425< Minimum value is 2, maximum value is 1000.
4426 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 When you set this option and Vim is unable to change the physical
4428 number of lines of the display, the display may be messed up.
4429
4430 *'linespace'* *'lsp'*
4431'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4432 global
4433 {not in Vi}
4434 {only in the GUI}
4435 Number of pixel lines inserted between characters. Useful if the font
4436 uses the full character cell height, making lines touch each other.
4437 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004438 With some fonts there can be too much room between lines (to have
4439 space for ascents and descents). Then it makes sense to set
4440 'linespace' to a negative value. This may cause display problems
4441 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442
4443 *'lisp'* *'nolisp'*
4444'lisp' boolean (default off)
4445 local to buffer
4446 {not available when compiled without the |+lispindent|
4447 feature}
4448 Lisp mode: When <Enter> is typed in insert mode set the indent for
4449 the next line to Lisp standards (well, sort of). Also happens with
4450 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4451 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4452 better. Also see 'lispwords'.
4453 The '-' character is included in keyword characters. Redefines the
4454 "=" operator to use this same indentation algorithm rather than
4455 calling an external program if 'equalprg' is empty.
4456 This option is not used when 'paste' is set.
4457 {Vi: Does it a little bit differently}
4458
4459 *'lispwords'* *'lw'*
4460'lispwords' 'lw' string (default is very long)
4461 global
4462 {not in Vi}
4463 {not available when compiled without the |+lispindent|
4464 feature}
4465 Comma separated list of words that influence the Lisp indenting.
4466 |'lisp'|
4467
4468 *'list'* *'nolist'*
4469'list' boolean (default off)
4470 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004471 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4472 line. Useful to see the difference between tabs and spaces and for
4473 trailing blanks. Further changed by the 'listchars' option.
4474
4475 The cursor is displayed at the start of the space a Tab character
4476 occupies, not at the end as usual in Normal mode. To get this cursor
4477 position while displaying Tabs with spaces, use: >
4478 :set list lcs=tab\ \
4479<
4480 Note that list mode will also affect formatting (set with 'textwidth'
4481 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 changing the way tabs are displayed.
4483
4484 *'listchars'* *'lcs'*
4485'listchars' 'lcs' string (default "eol:$")
4486 global
4487 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004488 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 settings.
4490 eol:c Character to show at the end of each line. When
4491 omitted, there is no extra character at the end of the
4492 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004493 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004495 fill the space that the tab normally occupies.
4496 "tab:>-" will show a tab that takes four spaces as
4497 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004498 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 trailing spaces are blank.
4500 extends:c Character to show in the last column, when 'wrap' is
4501 off and the line continues beyond the right of the
4502 screen.
4503 precedes:c Character to show in the first column, when 'wrap'
4504 is off and there is text preceding the character
4505 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004506 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004507 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004508 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004509 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004511 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004512 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004513 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514
4515 Examples: >
4516 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004517 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 :set lcs=extends:>,precedes:<
4519< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004520 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004521 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522
4523 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4524'loadplugins' 'lpl' boolean (default on)
4525 global
4526 {not in Vi}
4527 When on the plugin scripts are loaded when starting up |load-plugins|.
4528 This option can be reset in your |vimrc| file to disable the loading
4529 of plugins.
4530 Note that using the "-u NONE" and "--noplugin" command line arguments
4531 reset this option. |-u| |--noplugin|
4532
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004533 *'macatsui'* *'nomacatsui'*
4534'macatsui' boolean (default on)
4535 global
4536 {only available in Mac GUI version}
4537 This is a workaround for when drawing doesn't work properly. When set
4538 and compiled with multi-byte support ATSUI text drawing is used. When
4539 not set ATSUI text drawing is not used. Switch this option off when
4540 you experience drawing problems. In a future version the problems may
4541 be solved and this option becomes obsolete. Therefore use this method
4542 to unset it: >
4543 if exists('&macatsui')
4544 set nomacatsui
4545 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004546< Another option to check if you have drawing problems is
4547 'termencoding'.
4548
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 *'magic'* *'nomagic'*
4550'magic' boolean (default on)
4551 global
4552 Changes the special characters that can be used in search patterns.
4553 See |pattern|.
4554 NOTE: To avoid portability problems with using patterns, always keep
4555 this option at the default "on". Only switch it off when working with
4556 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004557 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558
4559 *'makeef'* *'mef'*
4560'makeef' 'mef' string (default: "")
4561 global
4562 {not in Vi}
4563 {not available when compiled without the |+quickfix|
4564 feature}
4565 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4566 and the |:grep| command.
4567 When it is empty, an internally generated temp file will be used.
4568 When "##" is included, it is replaced by a number to make the name
4569 unique. This makes sure that the ":make" command doesn't overwrite an
4570 existing file.
4571 NOT used for the ":cf" command. See 'errorfile' for that.
4572 Environment variables are expanded |:set_env|.
4573 See |option-backslash| about including spaces and backslashes.
4574 This option cannot be set from a |modeline| or in the |sandbox|, for
4575 security reasons.
4576
4577 *'makeprg'* *'mp'*
4578'makeprg' 'mp' string (default "make", VMS: "MMS")
4579 global or local to buffer |global-local|
4580 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004581 Program to use for the ":make" command. See |:make_makeprg|.
4582 This option may contain '%' and '#' characters, which are expanded to
4583 the current and alternate file name. |:_%| |:_#|
4584 Environment variables are expanded |:set_env|. See |option-backslash|
4585 about including spaces and backslashes.
4586 Note that a '|' must be escaped twice: once for ":set" and once for
4587 the interpretation of a command. When you use a filter called
4588 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 :set makeprg=gmake\ \\\|\ myfilter
4590< The placeholder "$*" can be given (even multiple times) to specify
4591 where the arguments will be included, for example: >
4592 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4593< This option cannot be set from a |modeline| or in the |sandbox|, for
4594 security reasons.
4595
Bram Moolenaar1a384422010-07-14 19:53:30 +02004596 *'colorcolumn'* *'cc'*
4597'colorcolumn' 'cc' string (default "")
4598 local to window
4599 {not in Vi}
4600 {not available when compiled without the |+syntax|
4601 feature}
4602 'colorcolumn' is a comma separated list of screen columns that are
4603 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
4604 text. Will make screen redrawing slower.
4605 The screen column can be an absolute number, or a number preceded with
4606 '+' or '-', which is added to or subtracted from 'textwidth'. >
4607
4608 :set cc=+1 " highlight column after 'textwidth'
4609 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
4610 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
4611<
4612 When 'textwidth' is zero then the items with '-' and '+' are not used.
4613 A maximum of 256 columns are highlighted.
4614
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 *'matchpairs'* *'mps'*
4616'matchpairs' 'mps' string (default "(:),{:},[:]")
4617 local to buffer
4618 {not in Vi}
4619 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004620 other. Currently only single byte character pairs are allowed, and
4621 they must be different. The characters must be separated by a colon.
4622 The pairs must be separated by a comma. Example for including '<' and
4623 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 :set mps+=<:>
4625
4626< A more exotic example, to jump between the '=' and ';' in an
4627 assignment, useful for languages like C and Java: >
4628 :au FileType c,cpp,java set mps+==:;
4629
4630< For a more advanced way of using "%", see the matchit.vim plugin in
4631 the $VIMRUNTIME/macros directory. |add-local-help|
4632
4633 *'matchtime'* *'mat'*
4634'matchtime' 'mat' number (default 5)
4635 global
4636 {not in Vi}{in Nvi}
4637 Tenths of a second to show the matching paren, when 'showmatch' is
4638 set. Note that this is not in milliseconds, like other options that
4639 set a time. This is to be compatible with Nvi.
4640
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004641 *'maxcombine'* *'mco'*
4642'maxcombine' 'mco' number (default 2)
4643 global
4644 {not in Vi}
4645 {only available when compiled with the |+multi_byte|
4646 feature}
4647 The maximum number of combining characters supported for displaying.
4648 Only used when 'encoding' is "utf-8".
4649 The default is OK for most languages. Hebrew may require 4.
4650 Maximum value is 6.
4651 Even when this option is set to 2 you can still edit text with more
4652 combining characters, you just can't see them. Use |g8| or |ga|.
4653 See |mbyte-combining|.
4654
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 *'maxfuncdepth'* *'mfd'*
4656'maxfuncdepth' 'mfd' number (default 100)
4657 global
4658 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004659 {not available when compiled without the +eval
4660 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004661 Maximum depth of function calls for user functions. This normally
4662 catches endless recursion. When using a recursive function with
4663 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4664 more memory, there is the danger of failing when memory is exhausted.
4665 See also |:function|.
4666
4667 *'maxmapdepth'* *'mmd'* *E223*
4668'maxmapdepth' 'mmd' number (default 1000)
4669 global
4670 {not in Vi}
4671 Maximum number of times a mapping is done without resulting in a
4672 character to be used. This normally catches endless mappings, like
4673 ":map x y" with ":map y x". It still does not catch ":map g wg",
4674 because the 'w' is used before the next mapping is done. See also
4675 |key-mapping|.
4676
4677 *'maxmem'* *'mm'*
4678'maxmem' 'mm' number (default between 256 to 5120 (system
4679 dependent) or half the amount of memory
4680 available)
4681 global
4682 {not in Vi}
4683 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4684 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004685 other memory to be freed. The maximum usable value is about 2000000.
4686 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004688 *'maxmempattern'* *'mmp'*
4689'maxmempattern' 'mmp' number (default 1000)
4690 global
4691 {not in Vi}
4692 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004693 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004694 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004695 When Vim runs into the limit it gives an error message and mostly
4696 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004697 Running into the limit often means that the pattern is very
4698 inefficient or too complex. This may already happen with the pattern
4699 "\(.\)*" on a very long line. ".*" works much better.
4700 Vim may run out of memory before hitting the 'maxmempattern' limit.
4701
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 *'maxmemtot'* *'mmt'*
4703'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4704 dependent) or half the amount of memory
4705 available)
4706 global
4707 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004708 Maximum amount of memory in Kbyte to use for all buffers together.
4709 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4710 without a limit. On 64 bit machines higher values might work. But
4711 hey, do you really need more than 2 Gbyte for text editing?
4712 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004713
4714 *'menuitems'* *'mis'*
4715'menuitems' 'mis' number (default 25)
4716 global
4717 {not in Vi}
4718 {not available when compiled without the |+menu|
4719 feature}
4720 Maximum number of items to use in a menu. Used for menus that are
4721 generated from a list of items, e.g., the Buffers menu. Changing this
4722 option has no direct effect, the menu must be refreshed first.
4723
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004724 *'mkspellmem'* *'msm'*
4725'mkspellmem' 'msm' string (default "460000,2000,500")
4726 global
4727 {not in Vi}
4728 {not available when compiled without the |+syntax|
4729 feature}
4730 Parameters for |:mkspell|. This tunes when to start compressing the
4731 word tree. Compression can be slow when there are many words, but
4732 it's needed to avoid running out of memory. The amount of memory used
4733 per word depends very much on how similar the words are, that's why
4734 this tuning is complicated.
4735
4736 There are three numbers, separated by commas:
4737 {start},{inc},{added}
4738
4739 For most languages the uncompressed word tree fits in memory. {start}
4740 gives the amount of memory in Kbyte that can be used before any
4741 compression is done. It should be a bit smaller than the amount of
4742 memory that is available to Vim.
4743
4744 When going over the {start} limit the {inc} number specifies the
4745 amount of memory in Kbyte that can be allocated before another
4746 compression is done. A low number means compression is done after
4747 less words are added, which is slow. A high number means more memory
4748 will be allocated.
4749
4750 After doing compression, {added} times 1024 words can be added before
4751 the {inc} limit is ignored and compression is done when any extra
4752 amount of memory is needed. A low number means there is a smaller
4753 chance of hitting the {inc} limit, less memory is used but it's
4754 slower.
4755
4756 The languages for which these numbers are important are Italian and
4757 Hungarian. The default works for when you have about 512 Mbyte. If
4758 you have 1 Gbyte you could use: >
4759 :set mkspellmem=900000,3000,800
4760< If you have less than 512 Mbyte |:mkspell| may fail for some
4761 languages, no matter what you set 'mkspellmem' to.
4762
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004764'modeline' 'ml' boolean (Vim default: on (off for root),
4765 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004766 local to buffer
4767 *'modelines'* *'mls'*
4768'modelines' 'mls' number (default 5)
4769 global
4770 {not in Vi}
4771 If 'modeline' is on 'modelines' gives the number of lines that is
4772 checked for set commands. If 'modeline' is off or 'modelines' is zero
4773 no lines are checked. See |modeline|.
4774 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4775 set and to the Vim default value when 'compatible' is reset.
4776
4777 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4778'modifiable' 'ma' boolean (default on)
4779 local to buffer
4780 {not in Vi} *E21*
4781 When off the buffer contents cannot be changed. The 'fileformat' and
4782 'fileencoding' options also can't be changed.
4783 Can be reset with the |-M| command line argument.
4784
4785 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4786'modified' 'mod' boolean (default off)
4787 local to buffer
4788 {not in Vi}
4789 When on, the buffer is considered to be modified. This option is set
4790 when:
4791 1. A change was made to the text since it was last written. Using the
4792 |undo| command to go back to the original text will reset the
4793 option. But undoing changes that were made before writing the
4794 buffer will set the option again, since the text is different from
4795 when it was written.
4796 2. 'fileformat' or 'fileencoding' is different from its original
4797 value. The original value is set when the buffer is read or
4798 written. A ":set nomodified" command also resets the original
4799 values to the current values and the 'modified' option will be
4800 reset.
4801 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4802 will be ignored.
4803
4804 *'more'* *'nomore'*
4805'more' boolean (Vim default: on, Vi default: off)
4806 global
4807 {not in Vi}
4808 When on, listings pause when the whole screen is filled. You will get
4809 the |more-prompt|. When this option is off there are no pauses, the
4810 listing continues until finished.
4811 NOTE: This option is set to the Vi default value when 'compatible' is
4812 set and to the Vim default value when 'compatible' is reset.
4813
4814 *'mouse'* *E538*
4815'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4816 global
4817 {not in Vi}
4818 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004819 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4820 sysmouse and Linux console with gpm). For using the mouse in the
4821 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 The mouse can be enabled for different modes:
4823 n Normal mode
4824 v Visual mode
4825 i Insert mode
4826 c Command-line mode
4827 h all previous modes when editing a help file
4828 a all previous modes
4829 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830 Normally you would enable the mouse in all four modes with: >
4831 :set mouse=a
4832< When the mouse is not enabled, the GUI will still use the mouse for
4833 modeless selection. This doesn't move the text cursor.
4834
4835 See |mouse-using|. Also see |'clipboard'|.
4836
4837 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004838 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839 the mouse buttons can still be used by keeping the shift key pressed.
4840 Also see the 'clipboard' option.
4841
4842 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4843'mousefocus' 'mousef' boolean (default off)
4844 global
4845 {not in Vi}
4846 {only works in the GUI}
4847 The window that the mouse pointer is on is automatically activated.
4848 When changing the window layout or window focus in another way, the
4849 mouse pointer is moved to the window with keyboard focus. Off is the
4850 default because it makes using the pull down menus a little goofy, as
4851 a pointer transit may activate a window unintentionally.
4852
4853 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4854'mousehide' 'mh' boolean (default on)
4855 global
4856 {not in Vi}
4857 {only works in the GUI}
4858 When on, the mouse pointer is hidden when characters are typed.
4859 The mouse pointer is restored when the mouse is moved.
4860
4861 *'mousemodel'* *'mousem'*
4862'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4863 global
4864 {not in Vi}
4865 Sets the model to use for the mouse. The name mostly specifies what
4866 the right mouse button is used for:
4867 extend Right mouse button extends a selection. This works
4868 like in an xterm.
4869 popup Right mouse button pops up a menu. The shifted left
4870 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004871 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 popup_setpos Like "popup", but the cursor will be moved to the
4873 position where the mouse was clicked, and thus the
4874 selected operation will act upon the clicked object.
4875 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004876 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 course, that right clicking outside a selection will
4878 end Visual mode.
4879 Overview of what button does what for each model:
4880 mouse extend popup(_setpos) ~
4881 left click place cursor place cursor
4882 left drag start selection start selection
4883 shift-left search word extend selection
4884 right click extend selection popup menu (place cursor)
4885 right drag extend selection -
4886 middle click paste paste
4887
4888 In the "popup" model the right mouse button produces a pop-up menu.
4889 You need to define this first, see |popup-menu|.
4890
4891 Note that you can further refine the meaning of buttons with mappings.
4892 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4893 selection (because that's handled in the GUI code directly).
4894
4895 The 'mousemodel' option is set by the |:behave| command.
4896
4897 *'mouseshape'* *'mouses'* *E547*
4898'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004899 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 global
4901 {not in Vi}
4902 {only available when compiled with the |+mouseshape|
4903 feature}
4904 This option tells Vim what the mouse pointer should look like in
4905 different modes. The option is a comma separated list of parts, much
4906 like used for 'guicursor'. Each part consist of a mode/location-list
4907 and an argument-list:
4908 mode-list:shape,mode-list:shape,..
4909 The mode-list is a dash separated list of these modes/locations:
4910 In a normal window: ~
4911 n Normal mode
4912 v Visual mode
4913 ve Visual mode with 'selection' "exclusive" (same as 'v',
4914 if not specified)
4915 o Operator-pending mode
4916 i Insert mode
4917 r Replace mode
4918
4919 Others: ~
4920 c appending to the command-line
4921 ci inserting in the command-line
4922 cr replacing in the command-line
4923 m at the 'Hit ENTER' or 'More' prompts
4924 ml idem, but cursor in the last line
4925 e any mode, pointer below last window
4926 s any mode, pointer on a status line
4927 sd any mode, while dragging a status line
4928 vs any mode, pointer on a vertical separator line
4929 vd any mode, while dragging a vertical separator line
4930 a everywhere
4931
4932 The shape is one of the following:
4933 avail name looks like ~
4934 w x arrow Normal mouse pointer
4935 w x blank no pointer at all (use with care!)
4936 w x beam I-beam
4937 w x updown up-down sizing arrows
4938 w x leftright left-right sizing arrows
4939 w x busy The system's usual busy pointer
4940 w x no The system's usual 'no input' pointer
4941 x udsizing indicates up-down resizing
4942 x lrsizing indicates left-right resizing
4943 x crosshair like a big thin +
4944 x hand1 black hand
4945 x hand2 white hand
4946 x pencil what you write with
4947 x question big ?
4948 x rightup-arrow arrow pointing right-up
4949 w x up-arrow arrow pointing up
4950 x <number> any X11 pointer number (see X11/cursorfont.h)
4951
4952 The "avail" column contains a 'w' if the shape is available for Win32,
4953 x for X11.
4954 Any modes not specified or shapes not available use the normal mouse
4955 pointer.
4956
4957 Example: >
4958 :set mouseshape=s:udsizing,m:no
4959< will make the mouse turn to a sizing arrow over the status lines and
4960 indicate no input when the hit-enter prompt is displayed (since
4961 clicking the mouse has no effect in this state.)
4962
4963 *'mousetime'* *'mouset'*
4964'mousetime' 'mouset' number (default 500)
4965 global
4966 {not in Vi}
4967 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4968 time in msec between two mouse clicks for the second click to be
4969 recognized as a multi click.
4970
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004971 *'mzquantum'* *'mzq'*
4972'mzquantum' 'mzq' number (default 100)
4973 global
4974 {not in Vi}
4975 {not available when compiled without the |+mzscheme|
4976 feature}
4977 The number of milliseconds between polls for MzScheme threads.
4978 Negative or zero value means no thread scheduling.
4979
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 *'nrformats'* *'nf'*
4981'nrformats' 'nf' string (default "octal,hex")
4982 local to buffer
4983 {not in Vi}
4984 This defines what bases Vim will consider for numbers when using the
4985 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4986 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004987 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02004989 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00004990 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004992 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 considered to be hexadecimal. Example: Using CTRL-X on
4994 "0x100" results in "0x0ff".
4995 Numbers which simply begin with a digit in the range 1-9 are always
4996 considered decimal. This also happens for numbers that are not
4997 recognized as octal or hex.
4998
4999 *'number'* *'nu'* *'nonumber'* *'nonu'*
5000'number' 'nu' boolean (default off)
5001 local to window
5002 Print the line number in front of each line. When the 'n' option is
5003 excluded from 'cpoptions' a wrapped line will not use the column of
5004 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005005 The 'numberwidth' option can be used to set the room used for the line
5006 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007 When a long, wrapped line doesn't start with the first character, '-'
5008 characters are put before the number.
5009 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005010 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005012 *'numberwidth'* *'nuw'*
5013'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5014 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005015 {not in Vi}
5016 {only available when compiled with the |+linebreak|
5017 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005018 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005019 when the 'number' or 'relativenumber' option is set or printing lines
5020 with a line number. Since one space is always between the number and
5021 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005022 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005023 fit the highest line number in the buffer respectively the number of
5024 rows in the window, depending on whether 'number' or 'relativenumber'
5025 is set. Thus with the Vim default of 4 there is room for a line number
5026 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005027 The minimum value is 1, the maximum value is 10.
5028 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5029
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005030 *'omnifunc'* *'ofu'*
5031'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005032 local to buffer
5033 {not in Vi}
5034 {not available when compiled without the +eval
5035 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005036 This option specifies a function to be used for Insert mode omni
5037 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005038 See |complete-functions| for an explanation of how the function is
5039 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005040 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005041 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005042
5043
Bram Moolenaar02467872007-05-06 13:22:01 +00005044 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005045'opendevice' 'odev' boolean (default off)
5046 global
5047 {not in Vi}
5048 {only for MS-DOS, MS-Windows and OS/2}
5049 Enable reading and writing from devices. This may get Vim stuck on a
5050 device that can be opened but doesn't actually do the I/O. Therefore
5051 it is off by default.
5052 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5053 result in editing a device.
5054
5055
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005056 *'operatorfunc'* *'opfunc'*
5057'operatorfunc' 'opfunc' string (default: empty)
5058 global
5059 {not in Vi}
5060 This option specifies a function to be called by the |g@| operator.
5061 See |:map-operator| for more info and an example.
5062
5063 This option cannot be set from a |modeline| or in the |sandbox|, for
5064 security reasons.
5065
5066
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 *'osfiletype'* *'oft'* *E366*
5068'osfiletype' 'oft' string (RISC-OS default: "Text",
5069 others default: "")
5070 local to buffer
5071 {not in Vi}
5072 {only available when compiled with the |+osfiletype|
5073 feature}
5074 Some operating systems store extra information about files besides
5075 name, datestamp and permissions. This option contains the extra
5076 information, the nature of which will vary between systems.
5077 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005078 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 It can affect the pattern matching of the automatic commands.
5080 |autocmd-osfiletypes|
5081
5082 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005083'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 global
5085 Specifies the nroff macros that separate paragraphs. These are pairs
5086 of two letters (see |object-motions|).
5087
5088 *'paste'* *'nopaste'*
5089'paste' boolean (default off)
5090 global
5091 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005092 Put Vim in Paste mode. This is useful if you want to cut or copy
5093 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005094 unexpected effects.
5095 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005096 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 knows about pasting and will mostly do the right thing without 'paste'
5098 being set. The same is true for a terminal where Vim handles the
5099 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005100 This option is reset when starting the GUI. Thus if you set it in
5101 your .vimrc it will work in a terminal, but not in the GUI. Setting
5102 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5103 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104 When the 'paste' option is switched on (also when it was already on):
5105 - mapping in Insert mode and Command-line mode is disabled
5106 - abbreviations are disabled
5107 - 'textwidth' is set to 0
5108 - 'wrapmargin' is set to 0
5109 - 'autoindent' is reset
5110 - 'smartindent' is reset
5111 - 'softtabstop' is set to 0
5112 - 'revins' is reset
5113 - 'ruler' is reset
5114 - 'showmatch' is reset
5115 - 'formatoptions' is used like it is empty
5116 These options keep their value, but their effect is disabled:
5117 - 'lisp'
5118 - 'indentexpr'
5119 - 'cindent'
5120 NOTE: When you start editing another file while the 'paste' option is
5121 on, settings from the modelines or autocommands may change the
5122 settings again, causing trouble when pasting text. You might want to
5123 set the 'paste' option again.
5124 When the 'paste' option is reset the mentioned options are restored to
5125 the value before the moment 'paste' was switched from off to on.
5126 Resetting 'paste' before ever setting it does not have any effect.
5127 Since mapping doesn't work while 'paste' is active, you need to use
5128 the 'pastetoggle' option to toggle the 'paste' option with some key.
5129
5130 *'pastetoggle'* *'pt'*
5131'pastetoggle' 'pt' string (default "")
5132 global
5133 {not in Vi}
5134 When non-empty, specifies the key sequence that toggles the 'paste'
5135 option. This is like specifying a mapping: >
5136 :map {keys} :set invpaste<CR>
5137< Where {keys} is the value of 'pastetoggle'.
5138 The difference is that it will work even when 'paste' is set.
5139 'pastetoggle' works in Insert mode and Normal mode, but not in
5140 Command-line mode.
5141 Mappings are checked first, thus overrule 'pastetoggle'. However,
5142 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5143 this: >
5144 :map <F10> :set paste<CR>
5145 :map <F11> :set nopaste<CR>
5146 :imap <F10> <C-O>:set paste<CR>
5147 :imap <F11> <nop>
5148 :set pastetoggle=<F11>
5149< This will make <F10> start paste mode and <F11> stop paste mode.
5150 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5151 mode everything is inserted literally, except the 'pastetoggle' key
5152 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005153 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154
5155 *'pex'* *'patchexpr'*
5156'patchexpr' 'pex' string (default "")
5157 global
5158 {not in Vi}
5159 {not available when compiled without the |+diff|
5160 feature}
5161 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005162 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163
5164 *'patchmode'* *'pm'* *E206*
5165'patchmode' 'pm' string (default "")
5166 global
5167 {not in Vi}
5168 When non-empty the oldest version of a file is kept. This can be used
5169 to keep the original version of a file if you are changing files in a
5170 source distribution. Only the first time that a file is written a
5171 copy of the original file will be kept. The name of the copy is the
5172 name of the original file with the string in the 'patchmode' option
5173 appended. This option should start with a dot. Use a string like
5174 ".org". 'backupdir' must not be empty for this to work (Detail: The
5175 backup file is renamed to the patchmode file after the new file has
5176 been successfully written, that's why it must be possible to write a
5177 backup file). If there was no file to be backed up, an empty file is
5178 created.
5179 When the 'backupskip' pattern matches, a patchmode file is not made.
5180 Using 'patchmode' for compressed files appends the extension at the
5181 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5182 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005183 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184
5185 *'path'* *'pa'* *E343* *E345* *E347*
5186'path' 'pa' string (default on Unix: ".,/usr/include,,"
5187 on OS/2: ".,/emx/include,,"
5188 other systems: ".,,")
5189 global or local to buffer |global-local|
5190 {not in Vi}
5191 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005192 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5193 provided that the file being searched for has a relative path (not
5194 starting with "/", "./" or "../"). The directories in the 'path'
5195 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196 - Use commas to separate directory names: >
5197 :set path=.,/usr/local/include,/usr/include
5198< - Spaces can also be used to separate directory names (for backwards
5199 compatibility with version 3.0). To have a space in a directory
5200 name, precede it with an extra backslash, and escape the space: >
5201 :set path=.,/dir/with\\\ space
5202< - To include a comma in a directory name precede it with an extra
5203 backslash: >
5204 :set path=.,/dir/with\\,comma
5205< - To search relative to the directory of the current file, use: >
5206 :set path=.
5207< - To search in the current directory use an empty string between two
5208 commas: >
5209 :set path=,,
5210< - A directory name may end in a ':' or '/'.
5211 - Environment variables are expanded |:set_env|.
5212 - When using |netrw.vim| URLs can be used. For example, adding
5213 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005214 - Search upwards and downwards in a directory tree using "*", "**" and
5215 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216 {not available when compiled without the |+path_extra| feature}
5217 - Careful with '\' characters, type two to get one in the option: >
5218 :set path=.,c:\\include
5219< Or just use '/' instead: >
5220 :set path=.,c:/include
5221< Don't forget "." or files won't even be found in the same directory as
5222 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005223 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 it is something like 256 or 1024 characters.
5225 You can check if all the include files are found, using the value of
5226 'path', see |:checkpath|.
5227 The use of |:set+=| and |:set-=| is preferred when adding or removing
5228 directories from the list. This avoids problems when a future version
5229 uses another default. To remove the current directory use: >
5230 :set path-=
5231< To add the current directory use: >
5232 :set path+=
5233< To use an environment variable, you probably need to replace the
5234 separator. Here is an example to append $INCL, in which directory
5235 names are separated with a semi-colon: >
5236 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5237< Replace the ';' with a ':' or whatever separator is used. Note that
5238 this doesn't work when $INCL contains a comma or white space.
5239
5240 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5241'preserveindent' 'pi' boolean (default off)
5242 local to buffer
5243 {not in Vi}
5244 When changing the indent of the current line, preserve as much of the
5245 indent structure as possible. Normally the indent is replaced by a
5246 series of tabs followed by spaces as required (unless |'expandtab'| is
5247 enabled, in which case only spaces are used). Enabling this option
5248 means the indent will preserve as many existing characters as possible
5249 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005250 'expandtab' does not apply to the preserved white space, a Tab remains
5251 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252 NOTE: When using ">>" multiple times the resulting indent is a mix of
5253 tabs and spaces. You might not like this.
5254 NOTE: 'preserveindent' is reset when 'compatible' is set.
5255 Also see 'copyindent'.
5256 Use |:retab| to clean up white space.
5257
5258 *'previewheight'* *'pvh'*
5259'previewheight' 'pvh' number (default 12)
5260 global
5261 {not in Vi}
5262 {not available when compiled without the |+windows| or
5263 |+quickfix| feature}
5264 Default height for a preview window. Used for |:ptag| and associated
5265 commands. Used for |CTRL-W_}| when no count is given.
5266
5267 *'previewwindow'* *'nopreviewwindow'*
5268 *'pvw'* *'nopvw'* *E590*
5269'previewwindow' 'pvw' boolean (default off)
5270 local to window
5271 {not in Vi}
5272 {not available when compiled without the |+windows| or
5273 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005274 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275 set. It's normally not set directly, but by using one of the commands
5276 |:ptag|, |:pedit|, etc.
5277
5278 *'printdevice'* *'pdev'*
5279'printdevice' 'pdev' string (default empty)
5280 global
5281 {not in Vi}
5282 {only available when compiled with the |+printer|
5283 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005284 The name of the printer to be used for |:hardcopy|.
5285 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005286 This option cannot be set from a |modeline| or in the |sandbox|, for
5287 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288
Bram Moolenaar8299df92004-07-10 09:47:34 +00005289 *'printencoding'* *'penc'*
5290'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291 global
5292 {not in Vi}
5293 {only available when compiled with the |+printer|
5294 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005295 Sets the character encoding used when printing.
5296 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005297
5298 *'printexpr'* *'pexpr'*
5299'printexpr' 'pexpr' String (default: see below)
5300 global
5301 {not in Vi}
5302 {only available when compiled with the |+printer|
5303 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005304 Expression used to print the PostScript produced with |:hardcopy|.
5305 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005306
Bram Moolenaar8299df92004-07-10 09:47:34 +00005307 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308'printfont' 'pfn' string (default "courier")
5309 global
5310 {not in Vi}
5311 {only available when compiled with the |+printer|
5312 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005313 The name of the font that will be used for |:hardcopy|.
5314 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315
5316 *'printheader'* *'pheader'*
5317'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5318 global
5319 {not in Vi}
5320 {only available when compiled with the |+printer|
5321 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005322 The format of the header produced in |:hardcopy| output.
5323 See |pheader-option|.
5324
5325 *'printmbcharset'* *'pmbcs'*
5326'printmbcharset' 'pmbcs' string (default "")
5327 global
5328 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005329 {only available when compiled with the |+printer|,
5330 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005331 The CJK character set to be used for CJK output from |:hardcopy|.
5332 See |pmbcs-option|.
5333
5334 *'printmbfont'* *'pmbfn'*
5335'printmbfont' 'pmbfn' string (default "")
5336 global
5337 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005338 {only available when compiled with the |+printer|,
5339 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005340 List of font names to be used for CJK output from |:hardcopy|.
5341 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342
5343 *'printoptions'* *'popt'*
5344'printoptions' 'popt' string (default "")
5345 global
5346 {not in Vi}
5347 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005348 List of items that control the format of the output of |:hardcopy|.
5349 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005351 *'prompt'* *'noprompt'*
5352'prompt' boolean (default on)
5353 global
5354 When on a ":" prompt is used in Ex mode.
5355
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005356 *'pumheight'* *'ph'*
5357'pumheight' 'ph' number (default 0)
5358 global
5359 {not available when compiled without the
5360 |+insert_expand| feature}
5361 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005362 Determines the maximum number of items to show in the popup menu for
5363 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005364 |ins-completion-menu|.
5365
5366
Bram Moolenaar677ee682005-01-27 14:41:15 +00005367 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005368'quoteescape' 'qe' string (default "\")
5369 local to buffer
5370 {not in Vi}
5371 The characters that are used to escape quotes in a string. Used for
5372 objects like a', a" and a` |a'|.
5373 When one of the characters in this option is found inside a string,
5374 the following character will be skipped. The default value makes the
5375 text "foo\"bar\\" considered to be one string.
5376
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5378'readonly' 'ro' boolean (default off)
5379 local to buffer
5380 If on, writes fail unless you use a '!'. Protects you from
5381 accidentally overwriting a file. Default on when Vim is started
5382 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005383 When using ":w!" the 'readonly' option is reset for the current
5384 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005385 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005386 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005387
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005388 *'redrawtime'* *'rdt'*
5389'redrawtime' 'rdt' number (default 2000)
5390 global
5391 {not in Vi}
5392 {only available when compiled with the |+reltime|
5393 feature}
5394 The time in milliseconds for redrawing the display. This applies to
5395 searching for patterns for 'hlsearch' and |:match| highlighting.
5396 When redrawing takes more than this many milliseconds no further
5397 matches will be highlighted. This is used to avoid that Vim hangs
5398 when using a very complicated pattern.
5399
Bram Moolenaar64486672010-05-16 15:46:46 +02005400 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5401'relativenumber' 'rnu' boolean (default off)
5402 local to window
5403 {not in Vi}
5404 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005405 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005406 precede some vertical motion commands (e.g. j k + -) with, without
5407 having to calculate it yourself. Especially useful in combination with
5408 other commands (e.g. y d c < > gq gw =).
5409 When the 'n' option is excluded from 'cpoptions' a wrapped
5410 line will not use the column of line numbers (this is the default when
5411 'compatible' isn't set).
5412 The 'numberwidth' option can be used to set the room used for the line
5413 number.
5414 When a long, wrapped line doesn't start with the first character, '-'
5415 characters are put before the number.
5416 See |hl-LineNr| for the highlighting used for the number.
5417 When setting this option, 'number' is reset.
5418
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 *'remap'* *'noremap'*
5420'remap' boolean (default on)
5421 global
5422 Allows for mappings to work recursively. If you do not want this for
5423 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005424 NOTE: To avoid portability problems with Vim scripts, always keep
5425 this option at the default "on". Only switch it off when working with
5426 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427
5428 *'report'*
5429'report' number (default 2)
5430 global
5431 Threshold for reporting number of lines changed. When the number of
5432 changed lines is more than 'report' a message will be given for most
5433 ":" commands. If you want it always, set 'report' to 0.
5434 For the ":substitute" command the number of substitutions is used
5435 instead of the number of lines.
5436
5437 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5438'restorescreen' 'rs' boolean (default on)
5439 global
5440 {not in Vi} {only in Windows 95/NT console version}
5441 When set, the screen contents is restored when exiting Vim. This also
5442 happens when executing external commands.
5443
5444 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5445 options in your .vimrc. To disable restoring:
5446 set t_ti= t_te=
5447 To enable restoring (for an xterm):
5448 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5449 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5450
5451 *'revins'* *'ri'* *'norevins'* *'nori'*
5452'revins' 'ri' boolean (default off)
5453 global
5454 {not in Vi}
5455 {only available when compiled with the |+rightleft|
5456 feature}
5457 Inserting characters in Insert mode will work backwards. See "typing
5458 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5459 command in Insert mode, when 'allowrevins' is set.
5460 NOTE: This option is reset when 'compatible' or 'paste' is set.
5461
5462 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5463'rightleft' 'rl' boolean (default off)
5464 local to window
5465 {not in Vi}
5466 {only available when compiled with the |+rightleft|
5467 feature}
5468 When on, display orientation becomes right-to-left, i.e., characters
5469 that are stored in the file appear from the right to the left.
5470 Using this option, it is possible to edit files for languages that
5471 are written from the right to the left such as Hebrew and Arabic.
5472 This option is per window, so it is possible to edit mixed files
5473 simultaneously, or to view the same file in both ways (this is
5474 useful whenever you have a mixed text file with both right-to-left
5475 and left-to-right strings so that both sets are displayed properly
5476 in different windows). Also see |rileft.txt|.
5477
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005478 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479'rightleftcmd' 'rlc' string (default "search")
5480 local to window
5481 {not in Vi}
5482 {only available when compiled with the |+rightleft|
5483 feature}
5484 Each word in this option enables the command line editing to work in
5485 right-to-left mode for a group of commands:
5486
5487 search "/" and "?" commands
5488
5489 This is useful for languages such as Hebrew, Arabic and Farsi.
5490 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5491
5492 *'ruler'* *'ru'* *'noruler'* *'noru'*
5493'ruler' 'ru' boolean (default off)
5494 global
5495 {not in Vi}
5496 {not available when compiled without the
5497 |+cmdline_info| feature}
5498 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005499 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005500 text in the file is shown on the far right:
5501 Top first line is visible
5502 Bot last line is visible
5503 All first and last line are visible
5504 45% relative position in the file
5505 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005506 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005508 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509 this option takes precedence over 'ruler' and 'rulerformat'
5510 If the number of characters displayed is different from the number of
5511 bytes in the text (e.g., for a TAB or a multi-byte character), both
5512 the text column (byte number) and the screen column are shown,
5513 separated with a dash.
5514 For an empty line "0-1" is shown.
5515 For an empty buffer the line number will also be zero: "0,0-1".
5516 This option is reset when the 'paste' option is set.
5517 If you don't want to see the ruler all the time but want to know where
5518 you are, use "g CTRL-G" |g_CTRL-G|.
5519 NOTE: This option is reset when 'compatible' is set.
5520
5521 *'rulerformat'* *'ruf'*
5522'rulerformat' 'ruf' string (default empty)
5523 global
5524 {not in Vi}
5525 {not available when compiled without the |+statusline|
5526 feature}
5527 When this option is not empty, it determines the content of the ruler
5528 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005529 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530 The default ruler width is 17 characters. To make the ruler 15
5531 characters wide, put "%15(" at the start and "%)" at the end.
5532 Example: >
5533 :set rulerformat=%15(%c%V\ %p%%%)
5534<
5535 *'runtimepath'* *'rtp'* *vimfiles*
5536'runtimepath' 'rtp' string (default:
5537 Unix: "$HOME/.vim,
5538 $VIM/vimfiles,
5539 $VIMRUNTIME,
5540 $VIM/vimfiles/after,
5541 $HOME/.vim/after"
5542 Amiga: "home:vimfiles,
5543 $VIM/vimfiles,
5544 $VIMRUNTIME,
5545 $VIM/vimfiles/after,
5546 home:vimfiles/after"
5547 PC, OS/2: "$HOME/vimfiles,
5548 $VIM/vimfiles,
5549 $VIMRUNTIME,
5550 $VIM/vimfiles/after,
5551 $HOME/vimfiles/after"
5552 Macintosh: "$VIM:vimfiles,
5553 $VIMRUNTIME,
5554 $VIM:vimfiles:after"
5555 RISC-OS: "Choices:vimfiles,
5556 $VIMRUNTIME,
5557 Choices:vimfiles/after"
5558 VMS: "sys$login:vimfiles,
5559 $VIM/vimfiles,
5560 $VIMRUNTIME,
5561 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005562 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005563 global
5564 {not in Vi}
5565 This is a list of directories which will be searched for runtime
5566 files:
5567 filetype.vim filetypes by file name |new-filetype|
5568 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005569 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005570 colors/ color scheme files |:colorscheme|
5571 compiler/ compiler files |:compiler|
5572 doc/ documentation |write-local-help|
5573 ftplugin/ filetype plugins |write-filetype-plugin|
5574 indent/ indent scripts |indent-expression|
5575 keymap/ key mapping files |mbyte-keymap|
5576 lang/ menu translations |:menutrans|
5577 menu.vim GUI menus |menu.vim|
5578 plugin/ plugin scripts |write-plugin|
5579 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005580 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005581 syntax/ syntax files |mysyntaxfile|
5582 tutor/ files for vimtutor |tutor|
5583
5584 And any other file searched for with the |:runtime| command.
5585
5586 The defaults for most systems are setup to search five locations:
5587 1. In your home directory, for your personal preferences.
5588 2. In a system-wide Vim directory, for preferences from the system
5589 administrator.
5590 3. In $VIMRUNTIME, for files distributed with Vim.
5591 *after-directory*
5592 4. In the "after" directory in the system-wide Vim directory. This is
5593 for the system administrator to overrule or add to the distributed
5594 defaults (rarely needed)
5595 5. In the "after" directory in your home directory. This is for
5596 personal preferences to overrule or add to the distributed defaults
5597 or system-wide settings (rarely needed).
5598
5599 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5600 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005601 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602 wildcards.
5603 See |:runtime|.
5604 Example: >
5605 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5606< This will use the directory "~/vimruntime" first (containing your
5607 personal Vim runtime files), then "/mygroup/vim" (shared between a
5608 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5609 files).
5610 You probably should always include $VIMRUNTIME somewhere, to use the
5611 distributed runtime files. You can put a directory before $VIMRUNTIME
5612 to find files which replace a distributed runtime files. You can put
5613 a directory after $VIMRUNTIME to find files which add to distributed
5614 runtime files.
5615 This option cannot be set from a |modeline| or in the |sandbox|, for
5616 security reasons.
5617
5618 *'scroll'* *'scr'*
5619'scroll' 'scr' number (default: half the window height)
5620 local to window
5621 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5622 set to half the number of lines in the window when the window size
5623 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005624 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5626 the number of screen lines instead of file lines, makes a difference
5627 when lines wrap}
5628
5629 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5630'scrollbind' 'scb' boolean (default off)
5631 local to window
5632 {not in Vi}
5633 {not available when compiled without the |+scrollbind|
5634 feature}
5635 See also |scroll-binding|. When this option is set, the current
5636 window scrolls as other scrollbind windows (windows that also have
5637 this option set) scroll. This option is useful for viewing the
5638 differences between two versions of a file, see 'diff'.
5639 See |'scrollopt'| for options that determine how this option should be
5640 interpreted.
5641 This option is mostly reset when splitting a window to edit another
5642 file. This means that ":split | edit file" results in two windows
5643 with scroll-binding, but ":split file" does not.
5644
5645 *'scrolljump'* *'sj'*
5646'scrolljump' 'sj' number (default 1)
5647 global
5648 {not in Vi}
5649 Minimal number of lines to scroll when the cursor gets off the
5650 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5651 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005652 When set to a negative number from -1 to -100 this is used as the
5653 percentage of the window height. Thus -50 scrolls half the window
5654 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655 NOTE: This option is set to 1 when 'compatible' is set.
5656
5657 *'scrolloff'* *'so'*
5658'scrolloff' 'so' number (default 0)
5659 global
5660 {not in Vi}
5661 Minimal number of screen lines to keep above and below the cursor.
5662 This will make some context visible around where you are working. If
5663 you set it to a very large value (999) the cursor line will always be
5664 in the middle of the window (except at the start or end of the file or
5665 when long lines wrap).
5666 For scrolling horizontally see 'sidescrolloff'.
5667 NOTE: This option is set to 0 when 'compatible' is set.
5668
5669 *'scrollopt'* *'sbo'*
5670'scrollopt' 'sbo' string (default "ver,jump")
5671 global
5672 {not available when compiled without the |+scrollbind|
5673 feature}
5674 {not in Vi}
5675 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005676 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5677 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678 The following words are available:
5679 ver Bind vertical scrolling for 'scrollbind' windows
5680 hor Bind horizontal scrolling for 'scrollbind' windows
5681 jump Applies to the offset between two windows for vertical
5682 scrolling. This offset is the difference in the first
5683 displayed line of the bound windows. When moving
5684 around in a window, another 'scrollbind' window may
5685 reach a position before the start or after the end of
5686 the buffer. The offset is not changed though, when
5687 moving back the 'scrollbind' window will try to scroll
5688 to the desired position when possible.
5689 When now making that window the current one, two
5690 things can be done with the relative offset:
5691 1. When "jump" is not included, the relative offset is
5692 adjusted for the scroll position in the new current
5693 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005694 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 2. When "jump" is included, the other windows are
5696 scrolled to keep the same relative offset. When
5697 going back to the other window, it still uses the
5698 same relative offset.
5699 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005700 When 'diff' mode is active there always is vertical scroll binding,
5701 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005702
5703 *'sections'* *'sect'*
5704'sections' 'sect' string (default "SHNHH HUnhsh")
5705 global
5706 Specifies the nroff macros that separate sections. These are pairs of
5707 two letters (See |object-motions|). The default makes a section start
5708 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5709
5710 *'secure'* *'nosecure'* *E523*
5711'secure' boolean (default off)
5712 global
5713 {not in Vi}
5714 When on, ":autocmd", shell and write commands are not allowed in
5715 ".vimrc" and ".exrc" in the current directory and map commands are
5716 displayed. Switch it off only if you know that you will not run into
5717 problems, or when the 'exrc' option is off. On Unix this option is
5718 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005719 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 'secure' at the end of your ~/.vimrc then.
5721 This option cannot be set from a |modeline| or in the |sandbox|, for
5722 security reasons.
5723
5724 *'selection'* *'sel'*
5725'selection' 'sel' string (default "inclusive")
5726 global
5727 {not in Vi}
5728 This option defines the behavior of the selection. It is only used
5729 in Visual and Select mode.
5730 Possible values:
5731 value past line inclusive ~
5732 old no yes
5733 inclusive yes yes
5734 exclusive yes no
5735 "past line" means that the cursor is allowed to be positioned one
5736 character past the line.
5737 "inclusive" means that the last character of the selection is included
5738 in an operation. For example, when "x" is used to delete the
5739 selection.
5740 Note that when "exclusive" is used and selecting from the end
5741 backwards, you cannot include the last character of a line, when
5742 starting in Normal mode and 'virtualedit' empty.
5743
5744 The 'selection' option is set by the |:behave| command.
5745
5746 *'selectmode'* *'slm'*
5747'selectmode' 'slm' string (default "")
5748 global
5749 {not in Vi}
5750 This is a comma separated list of words, which specifies when to start
5751 Select mode instead of Visual mode, when a selection is started.
5752 Possible values:
5753 mouse when using the mouse
5754 key when using shifted special keys
5755 cmd when using "v", "V" or CTRL-V
5756 See |Select-mode|.
5757 The 'selectmode' option is set by the |:behave| command.
5758
5759 *'sessionoptions'* *'ssop'*
5760'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005761 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762 global
5763 {not in Vi}
5764 {not available when compiled without the +mksession
5765 feature}
5766 Changes the effect of the |:mksession| command. It is a comma
5767 separated list of words. Each word enables saving and restoring
5768 something:
5769 word save and restore ~
5770 blank empty windows
5771 buffers hidden and unloaded buffers, not just those in windows
5772 curdir the current directory
5773 folds manually created folds, opened/closed folds and local
5774 fold options
5775 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005776 and contain at least one lowercase letter. Only
5777 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 help the help window
5779 localoptions options and mappings local to a window or buffer (not
5780 global values for local options)
5781 options all options and mappings (also global values for local
5782 options)
5783 resize size of the Vim window: 'lines' and 'columns'
5784 sesdir the directory in which the session file is located
5785 will become the current directory (useful with
5786 projects accessed over a network from different
5787 systems)
5788 slash backslashes in file names replaced with forward
5789 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005790 tabpages all tab pages; without this only the current tab page
5791 is restored, so that you can make a session for each
5792 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 unix with Unix end-of-line format (single <NL>), even when
5794 on Windows or DOS
5795 winpos position of the whole Vim window
5796 winsize window sizes
5797
5798 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005799 When neither "curdir" nor "sesdir" is included, file names are stored
5800 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005801 "slash" and "unix" are useful on Windows when sharing session files
5802 with Unix. The Unix version of Vim cannot source dos format scripts,
5803 but the Windows version of Vim can source unix format scripts.
5804
5805 *'shell'* *'sh'* *E91*
5806'shell' 'sh' string (default $SHELL or "sh",
5807 MS-DOS and Win32: "command.com" or
5808 "cmd.exe", OS/2: "cmd")
5809 global
5810 Name of the shell to use for ! and :! commands. When changing the
5811 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5812 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005813 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814 See |option-backslash| about including spaces and backslashes.
5815 Environment variables are expanded |:set_env|.
5816 If the name of the shell contains a space, you might need to enclose
5817 it in quotes. Example: >
5818 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5819< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005820 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005821 "-f" is not inside the quotes, because it is not part of the command
5822 name. And Vim automagically recognizes the backslashes that are path
5823 separators.
5824 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5825 variable to change the way external commands are executed. See the
5826 libc.inf file of DJGPP.
5827 Under MS-Windows, when the executable ends in ".com" it must be
5828 included. Thus setting the shell to "command.com" or "4dos.com"
5829 works, but "command" and "4dos" do not work for all commands (e.g.,
5830 filtering).
5831 For unknown reasons, when using "4dos.com" the current directory is
5832 changed to "C:\". To avoid this set 'shell' like this: >
5833 :set shell=command.com\ /c\ 4dos
5834< This option cannot be set from a |modeline| or in the |sandbox|, for
5835 security reasons.
5836
5837 *'shellcmdflag'* *'shcf'*
5838'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5839 does not contain "sh" somewhere: "/c")
5840 global
5841 {not in Vi}
5842 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5843 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5844 systems, the default is set according to the value of 'shell', to
5845 reduce the need to set this option by the user. It's not used for
5846 OS/2 (EMX figures this out itself). See |option-backslash| about
5847 including spaces and backslashes. See |dos-shell|.
5848 This option cannot be set from a |modeline| or in the |sandbox|, for
5849 security reasons.
5850
5851 *'shellpipe'* *'sp'*
5852'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5853 global
5854 {not in Vi}
5855 {not available when compiled without the |+quickfix|
5856 feature}
5857 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005858 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005859 including spaces and backslashes.
5860 The name of the temporary file can be represented by "%s" if necessary
5861 (the file name is appended automatically if no %s appears in the value
5862 of this option).
5863 For the Amiga and MS-DOS the default is ">". The output is directly
5864 saved in a file and not echoed to the screen.
5865 For Unix the default it "| tee". The stdout of the compiler is saved
5866 in a file and echoed to the screen. If the 'shell' option is "csh" or
5867 "tcsh" after initializations, the default becomes "|& tee". If the
5868 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005869 "2>&1| tee". This means that stderr is also included. Before using
5870 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871 The initialization of this option is done after reading the ".vimrc"
5872 and the other initializations, so that when the 'shell' option is set
5873 there, the 'shellpipe' option changes automatically, unless it was
5874 explicitly set before.
5875 When 'shellpipe' is set to an empty string, no redirection of the
5876 ":make" output will be done. This is useful if you use a 'makeprg'
5877 that writes to 'makeef' by itself. If you want no piping, but do
5878 want to include the 'makeef', set 'shellpipe' to a single space.
5879 Don't forget to precede the space with a backslash: ":set sp=\ ".
5880 In the future pipes may be used for filtering and this option will
5881 become obsolete (at least for Unix).
5882 This option cannot be set from a |modeline| or in the |sandbox|, for
5883 security reasons.
5884
5885 *'shellquote'* *'shq'*
5886'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5887 contains "sh" somewhere: "\"")
5888 global
5889 {not in Vi}
5890 Quoting character(s), put around the command passed to the shell, for
5891 the "!" and ":!" commands. The redirection is kept outside of the
5892 quoting. See 'shellxquote' to include the redirection. It's
5893 probably not useful to set both options.
5894 This is an empty string by default. Only known to be useful for
5895 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5896 or bash, where it should be "\"". The default is adjusted according
5897 the value of 'shell', to reduce the need to set this option by the
5898 user. See |dos-shell|.
5899 This option cannot be set from a |modeline| or in the |sandbox|, for
5900 security reasons.
5901
5902 *'shellredir'* *'srr'*
5903'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5904 global
5905 {not in Vi}
5906 String to be used to put the output of a filter command in a temporary
5907 file. See also |:!|. See |option-backslash| about including spaces
5908 and backslashes.
5909 The name of the temporary file can be represented by "%s" if necessary
5910 (the file name is appended automatically if no %s appears in the value
5911 of this option).
5912 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5913 or "zsh" during initializations, the default becomes ">&". If the
5914 'shell' option is "sh", "ksh" or "bash" the default becomes
5915 ">%s 2>&1". This means that stderr is also included.
5916 For Win32, the Unix checks are done and additionally "cmd" is checked
5917 for, which makes the default ">%s 2>&1". Also, the same names with
5918 ".exe" appended are checked for.
5919 The initialization of this option is done after reading the ".vimrc"
5920 and the other initializations, so that when the 'shell' option is set
5921 there, the 'shellredir' option changes automatically unless it was
5922 explicitly set before.
5923 In the future pipes may be used for filtering and this option will
5924 become obsolete (at least for Unix).
5925 This option cannot be set from a |modeline| or in the |sandbox|, for
5926 security reasons.
5927
5928 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5929'shellslash' 'ssl' boolean (default off)
5930 global
5931 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5932 When set, a forward slash is used when expanding file names. This is
5933 useful when a Unix-like shell is used instead of command.com or
5934 cmd.exe. Backward slashes can still be typed, but they are changed to
5935 forward slashes by Vim.
5936 Note that setting or resetting this option has no effect for some
5937 existing file names, thus this option needs to be set before opening
5938 any file for best results. This might change in the future.
5939 'shellslash' only works when a backslash can be used as a path
5940 separator. To test if this is so use: >
5941 if exists('+shellslash')
5942<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005943 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5944'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5945 global
5946 {not in Vi}
5947 When on, use temp files for shell commands. When off use a pipe.
5948 When using a pipe is not possible temp files are used anyway.
5949 Currently a pipe is only supported on Unix. You can check it with: >
5950 :if has("filterpipe")
5951< The advantage of using a pipe is that nobody can read the temp file
5952 and the 'shell' command does not need to support redirection.
5953 The advantage of using a temp file is that the file type and encoding
5954 can be detected.
5955 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5956 |FilterWritePost| autocommands event are not triggered when
5957 'shelltemp' is off.
5958
Bram Moolenaar071d4272004-06-13 20:20:40 +00005959 *'shelltype'* *'st'*
5960'shelltype' 'st' number (default 0)
5961 global
5962 {not in Vi} {only for the Amiga}
5963 On the Amiga this option influences the way how the commands work
5964 which use a shell.
5965 0 and 1: always use the shell
5966 2 and 3: use the shell only to filter lines
5967 4 and 5: use shell only for ':sh' command
5968 When not using the shell, the command is executed directly.
5969
5970 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5971 1 and 3: use "shell cmd" to start external commands
5972
5973 *'shellxquote'* *'sxq'*
5974'shellxquote' 'sxq' string (default: "";
5975 for Win32, when 'shell' contains "sh"
5976 somewhere: "\""
5977 for Unix, when using system(): "\"")
5978 global
5979 {not in Vi}
5980 Quoting character(s), put around the command passed to the shell, for
5981 the "!" and ":!" commands. Includes the redirection. See
5982 'shellquote' to exclude the redirection. It's probably not useful
5983 to set both options.
5984 This is an empty string by default. Known to be useful for
5985 third-party shells when using the Win32 version, such as the MKS Korn
5986 Shell or bash, where it should be "\"". The default is adjusted
5987 according the value of 'shell', to reduce the need to set this option
5988 by the user. See |dos-shell|.
5989 This option cannot be set from a |modeline| or in the |sandbox|, for
5990 security reasons.
5991
5992 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5993'shiftround' 'sr' boolean (default off)
5994 global
5995 {not in Vi}
5996 Round indent to multiple of 'shiftwidth'. Applies to > and <
5997 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5998 a multiple of 'shiftwidth' (this is Vi compatible).
5999 NOTE: This option is reset when 'compatible' is set.
6000
6001 *'shiftwidth'* *'sw'*
6002'shiftwidth' 'sw' number (default 8)
6003 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006004 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005 |'cindent'|, |>>|, |<<|, etc.
6006
6007 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006008'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6009 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 global
6011 {not in Vi}
6012 This option helps to avoid all the |hit-enter| prompts caused by file
6013 messages, for example with CTRL-G, and to avoid some other messages.
6014 It is a list of flags:
6015 flag meaning when present ~
6016 f use "(3 of 5)" instead of "(file 3 of 5)"
6017 i use "[noeol]" instead of "[Incomplete last line]"
6018 l use "999L, 888C" instead of "999 lines, 888 characters"
6019 m use "[+]" instead of "[Modified]"
6020 n use "[New]" instead of "[New File]"
6021 r use "[RO]" instead of "[readonly]"
6022 w use "[w]" instead of "written" for file write message
6023 and "[a]" instead of "appended" for ':w >> file' command
6024 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6025 "[unix format]" and "[mac]" instead of "[mac format]".
6026 a all of the above abbreviations
6027
6028 o overwrite message for writing a file with subsequent message
6029 for reading a file (useful for ":wn" or when 'autowrite' on)
6030 O message for reading a file overwrites any previous message.
6031 Also for quickfix message (e.g., ":cn").
6032 s don't give "search hit BOTTOM, continuing at TOP" or "search
6033 hit TOP, continuing at BOTTOM" messages
6034 t truncate file message at the start if it is too long to fit
6035 on the command-line, "<" will appear in the left most column.
6036 Ignored in Ex mode.
6037 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006038 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 Ignored in Ex mode.
6040 W don't give "written" or "[w]" when writing a file
6041 A don't give the "ATTENTION" message when an existing swap file
6042 is found.
6043 I don't give the intro message when starting Vim |:intro|.
6044
6045 This gives you the opportunity to avoid that a change between buffers
6046 requires you to hit <Enter>, but still gives as useful a message as
6047 possible for the space available. To get the whole message that you
6048 would have got with 'shm' empty, use ":file!"
6049 Useful values:
6050 shm= No abbreviation of message.
6051 shm=a Abbreviation, but no loss of information.
6052 shm=at Abbreviation, and truncate message when necessary.
6053
6054 NOTE: This option is set to the Vi default value when 'compatible' is
6055 set and to the Vim default value when 'compatible' is reset.
6056
6057 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6058'shortname' 'sn' boolean (default off)
6059 local to buffer
6060 {not in Vi, not in MS-DOS versions}
6061 Filenames are assumed to be 8 characters plus one extension of 3
6062 characters. Multiple dots in file names are not allowed. When this
6063 option is on, dots in file names are replaced with underscores when
6064 adding an extension (".~" or ".swp"). This option is not available
6065 for MS-DOS, because then it would always be on. This option is useful
6066 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6067 or crossdos. When running the Win32 GUI version under Win32s, this
6068 option is always on by default.
6069
6070 *'showbreak'* *'sbr'* *E595*
6071'showbreak' 'sbr' string (default "")
6072 global
6073 {not in Vi}
6074 {not available when compiled without the |+linebreak|
6075 feature}
6076 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006077 values are "> " or "+++ ": >
6078 :set showbreak=>\
6079< Note the backslash to escape the trailing space. It's easier like
6080 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006081 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006082< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083 comma (in a future version the comma might be used to separate the
6084 part that is shown at the end and at the start of a line).
6085 The characters are highlighted according to the '@' flag in
6086 'highlight'.
6087 Note that tabs after the showbreak will be displayed differently.
6088 If you want the 'showbreak' to appear in between line numbers, add the
6089 "n" flag to 'cpoptions'.
6090
6091 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6092'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6093 off)
6094 global
6095 {not in Vi}
6096 {not available when compiled without the
6097 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006098 Show (partial) command in the last line of the screen. Set this
6099 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 In Visual mode the size of the selected area is shown:
6101 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006102 If the number of bytes is different it is also displayed: "2-6"
6103 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006105 - When selecting a block, the size in screen characters:
6106 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006107 NOTE: This option is set to the Vi default value when 'compatible' is
6108 set and to the Vim default value when 'compatible' is reset.
6109
6110 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6111'showfulltag' 'sft' boolean (default off)
6112 global
6113 {not in Vi}
6114 When completing a word in insert mode (see |ins-completion|) from the
6115 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006116 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006117 matched a C function, you can see a template for what arguments are
6118 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006119 Note that this doesn't work well together with having "longest" in
6120 'completeopt', because the completion from the search pattern may not
6121 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122
6123 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6124'showmatch' 'sm' boolean (default off)
6125 global
6126 When a bracket is inserted, briefly jump to the matching one. The
6127 jump is only done if the match can be seen on the screen. The time to
6128 show the match can be set with 'matchtime'.
6129 A Beep is given if there is no match (no matter if the match can be
6130 seen or not). This option is reset when the 'paste' option is set.
6131 When the 'm' flag is not included in 'cpoptions', typing a character
6132 will immediately move the cursor back to where it belongs.
6133 See the "sm" field in 'guicursor' for setting the cursor shape and
6134 blinking when showing the match.
6135 The 'matchpairs' option can be used to specify the characters to show
6136 matches for. 'rightleft' and 'revins' are used to look for opposite
6137 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006138 Also see the matchparen plugin for highlighting the match when moving
6139 around |pi_paren.txt|.
6140 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141
6142 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6143'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6144 global
6145 If in Insert, Replace or Visual mode put a message on the last line.
6146 Use the 'M' flag in 'highlight' to set the type of highlighting for
6147 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006148 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 doesn't mean XIM is really active, especially when 'imactivatekey' is
6150 not set.
6151 NOTE: This option is set to the Vi default value when 'compatible' is
6152 set and to the Vim default value when 'compatible' is reset.
6153
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006154 *'showtabline'* *'stal'*
6155'showtabline' 'stal' number (default 1)
6156 global
6157 {not in Vi}
6158 {not available when compiled without the +windows
6159 feature}
6160 The value of this option specifies when the line with tab page labels
6161 will be displayed:
6162 0: never
6163 1: only if there are at least two tab pages
6164 2: always
6165 This is both for the GUI and non-GUI implementation of the tab pages
6166 line.
6167 See |tab-page| for more information about tab pages.
6168
Bram Moolenaar071d4272004-06-13 20:20:40 +00006169 *'sidescroll'* *'ss'*
6170'sidescroll' 'ss' number (default 0)
6171 global
6172 {not in Vi}
6173 The minimal number of columns to scroll horizontally. Used only when
6174 the 'wrap' option is off and the cursor is moved off of the screen.
6175 When it is zero the cursor will be put in the middle of the screen.
6176 When using a slow terminal set it to a large number or 0. When using
6177 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6178 commands.
6179
6180 *'sidescrolloff'* *'siso'*
6181'sidescrolloff' 'siso' number (default 0)
6182 global
6183 {not in Vi}
6184 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006185 right of the cursor if 'nowrap' is set. Setting this option to a
6186 value greater than 0 while having |'sidescroll'| also at a non-zero
6187 value makes some context visible in the line you are scrolling in
6188 horizontally (except at beginning of the line). Setting this option
6189 to a large value (like 999) has the effect of keeping the cursor
6190 horizontally centered in the window, as long as one does not come too
6191 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006192 NOTE: This option is set to 0 when 'compatible' is set.
6193
6194 Example: Try this together with 'sidescroll' and 'listchars' as
6195 in the following example to never allow the cursor to move
6196 onto the "extends" character:
6197
6198 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6199 :set sidescrolloff=1
6200
6201
6202 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6203'smartcase' 'scs' boolean (default off)
6204 global
6205 {not in Vi}
6206 Override the 'ignorecase' option if the search pattern contains upper
6207 case characters. Only used when the search pattern is typed and
6208 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006209 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6211 recalling the search pattern from history and hitting <Enter>.
6212 NOTE: This option is reset when 'compatible' is set.
6213
6214 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6215'smartindent' 'si' boolean (default off)
6216 local to buffer
6217 {not in Vi}
6218 {not available when compiled without the
6219 |+smartindent| feature}
6220 Do smart autoindenting when starting a new line. Works for C-like
6221 programs, but can also be used for other languages. 'cindent' does
6222 something like this, works better in most cases, but is more strict,
6223 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6224 'indentexpr' is a more advanced alternative.
6225 Normally 'autoindent' should also be on when using 'smartindent'.
6226 An indent is automatically inserted:
6227 - After a line ending in '{'.
6228 - After a line starting with a keyword from 'cinwords'.
6229 - Before a line starting with '}' (only with the "O" command).
6230 When typing '}' as the first character in a new line, that line is
6231 given the same indent as the matching '{'.
6232 When typing '#' as the first character in a new line, the indent for
6233 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006234 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6236 When using the ">>" command, lines starting with '#' are not shifted
6237 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006238 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239 is set smart indenting is disabled.
6240
6241 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6242'smarttab' 'sta' boolean (default off)
6243 global
6244 {not in Vi}
6245 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006246 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6247 <BS> will delete a 'shiftwidth' worth of space at the start of the
6248 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006249 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006250 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6251 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006252 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006254 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255 NOTE: This option is reset when 'compatible' is set.
6256
6257 *'softtabstop'* *'sts'*
6258'softtabstop' 'sts' number (default 0)
6259 local to buffer
6260 {not in Vi}
6261 Number of spaces that a <Tab> counts for while performing editing
6262 operations, like inserting a <Tab> or using <BS>. It "feels" like
6263 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6264 used. This is useful to keep the 'ts' setting at its standard value
6265 of 8, while being able to edit like it is set to 'sts'. However,
6266 commands like "x" still work on the actual characters.
6267 When 'sts' is zero, this feature is off.
6268 'softtabstop' is set to 0 when the 'paste' option is set.
6269 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6270 spaces is minimized by using <Tab>s.
6271 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6272 set.
6273 NOTE: This option is set to 0 when 'compatible' is set.
6274
Bram Moolenaar217ad922005-03-20 22:37:15 +00006275 *'spell'* *'nospell'*
6276'spell' boolean (default off)
6277 local to window
6278 {not in Vi}
6279 {not available when compiled without the |+syntax|
6280 feature}
6281 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006282 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006283
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006284 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006285'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006286 local to buffer
6287 {not in Vi}
6288 {not available when compiled without the |+syntax|
6289 feature}
6290 Pattern to locate the end of a sentence. The following word will be
6291 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006292 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006293 When this check is not wanted make this option empty.
6294 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006295 Be careful with special characters, see |option-backslash| about
6296 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006297 To set this option automatically depending on the language, see
6298 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006299
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006300 *'spellfile'* *'spf'*
6301'spellfile' 'spf' string (default empty)
6302 local to buffer
6303 {not in Vi}
6304 {not available when compiled without the |+syntax|
6305 feature}
6306 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006307 commands. It must end in ".{encoding}.add". You need to include the
6308 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006309 *E765*
6310 It may also be a comma separated list of names. A count before the
6311 |zg| and |zw| commands can be used to access each. This allows using
6312 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006313 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006314 you: Using the first directory in 'runtimepath' that is writable. If
6315 there is no "spell" directory yet it will be created. For the file
6316 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006317 ignoring the region.
6318 The resulting ".spl" file will be used for spell checking, it does not
6319 have to appear in 'spelllang'.
6320 Normally one file is used for all regions, but you can add the region
6321 name if you want to. However, it will then only be used when
6322 'spellfile' is set to it, for entries in 'spelllang' only files
6323 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006324 This option cannot be set from a |modeline| or in the |sandbox|, for
6325 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006326
Bram Moolenaar217ad922005-03-20 22:37:15 +00006327 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006328'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006329 local to buffer
6330 {not in Vi}
6331 {not available when compiled without the |+syntax|
6332 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006333 A comma separated list of word list names. When the 'spell' option is
6334 on spellchecking will be done for these languages. Example: >
6335 set spelllang=en_us,nl,medical
6336< This means US English, Dutch and medical words are recognized. Words
6337 that are not recognized will be highlighted.
6338 The word list name must not include a comma or dot. Using a dash is
6339 recommended to separate the two letter language name from a
6340 specification. Thus "en-rare" is used for rare English words.
6341 A region name must come last and have the form "_xx", where "xx" is
6342 the two-letter, lower case region name. You can use more than one
6343 region by listing them: "en_us,en_ca" supports both US and Canadian
6344 English, but not words specific for Australia, New Zealand or Great
6345 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006346 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006347 As a special case the name of a .spl file can be given as-is. The
6348 first "_xx" in the name is removed and used as the region name
6349 (_xx is an underscore, two letters and followed by a non-letter).
6350 This is mainly for testing purposes. You must make sure the correct
6351 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006352 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006353 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6354 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006355 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006356
Bram Moolenaar98692072006-02-04 00:57:42 +00006357 If the |spellfile.vim| plugin is active and you use a language name
6358 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6359 will ask you if you want to download the file.
6360
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006361 After this option has been set successfully, Vim will source the files
6362 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006363 up to the first comma, dot or underscore.
6364 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006365
6366
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006367 *'spellsuggest'* *'sps'*
6368'spellsuggest' 'sps' string (default "best")
6369 global
6370 {not in Vi}
6371 {not available when compiled without the |+syntax|
6372 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006373 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006374 the |spellsuggest()| function. This is a comma-separated list of
6375 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006376
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006377 best Internal method that works best for English. Finds
6378 changes like "fast" and uses a bit of sound-a-like
6379 scoring to improve the ordering.
6380
6381 double Internal method that uses two methods and mixes the
6382 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006383 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006384 word. That only works when the language specifies
6385 sound folding. Can be slow and doesn't always give
6386 better results.
6387
6388 fast Internal method that only checks for simple changes:
6389 character inserts/deletes/swaps. Works well for
6390 simple typing mistakes.
6391
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006392 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006393 Not used for |spellsuggest()|. The number of
6394 suggestions is never more than the value of 'lines'
6395 minus two.
6396
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006397 file:{filename} Read file {filename}, which must have two columns,
6398 separated by a slash. The first column contains the
6399 bad word, the second column the suggested good word.
6400 Example:
6401 theribal/terrible ~
6402 Use this for common mistakes that do not appear at the
6403 top of the suggestion list with the internal methods.
6404 Lines without a slash are ignored, use this for
6405 comments.
6406 The file is used for all languages.
6407
6408 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6409 trouble with spaces. |v:val| holds the badly spelled
6410 word. The expression must evaluate to a List of
6411 Lists, each with a suggestion and a score.
6412 Example:
6413 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006414 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006415 internal methods use. A lower score is better.
6416 This may invoke |spellsuggest()| if you temporarily
6417 set 'spellsuggest' to exclude the "expr:" part.
6418 Errors are silently ignored, unless you set the
6419 'verbose' option to a non-zero value.
6420
6421 Only one of "best", "double" or "fast" may be used. The others may
6422 appear several times in any order. Example: >
6423 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6424<
6425 This option cannot be set from a |modeline| or in the |sandbox|, for
6426 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006427
6428
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6430'splitbelow' 'sb' boolean (default off)
6431 global
6432 {not in Vi}
6433 {not available when compiled without the +windows
6434 feature}
6435 When on, splitting a window will put the new window below the current
6436 one. |:split|
6437
6438 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6439'splitright' 'spr' boolean (default off)
6440 global
6441 {not in Vi}
6442 {not available when compiled without the +vertsplit
6443 feature}
6444 When on, splitting a window will put the new window right of the
6445 current one. |:vsplit|
6446
6447 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6448'startofline' 'sol' boolean (default on)
6449 global
6450 {not in Vi}
6451 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006452 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006453 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006454 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 with a linewise operator, with "%" with a count and to buffer changing
6456 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6457 only has a line number, e.g., ":25" or ":+".
6458 In case of buffer changing commands the cursor is placed at the column
6459 where it was the last time the buffer was edited.
6460 NOTE: This option is set when 'compatible' is set.
6461
6462 *'statusline'* *'stl'* *E540* *E541* *E542*
6463'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006464 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 {not in Vi}
6466 {not available when compiled without the |+statusline|
6467 feature}
6468 When nonempty, this option determines the content of the status line.
6469 Also see |status-line|.
6470
6471 The option consists of printf style '%' items interspersed with
6472 normal text. Each status line item is of the form:
6473 %-0{minwid}.{maxwid}{item}
6474 All fields except the {item} is optional. A single percent sign can
6475 be given as "%%". Up to 80 items can be specified.
6476
Bram Moolenaar238a5642006-02-21 22:12:05 +00006477 When the option starts with "%!" then it is used as an expression,
6478 evaluated and the result is used as the option value. Example: >
6479 :set statusline=%!MyStatusLine()
6480< The result can contain %{} items that will be evaluated too.
6481
6482 When there is error while evaluating the option then it will be made
6483 empty to avoid further errors. Otherwise screen updating would loop.
6484
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485 Note that the only effect of 'ruler' when this option is set (and
6486 'laststatus' is 2) is controlling the output of |CTRL-G|.
6487
6488 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006489 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006491 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 minwid Minimum width of the item, padding as set by '-' & '0'.
6493 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006494 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 on the left for text items. Numeric items will be
6496 shifted down to maxwid-2 digits followed by '>'number
6497 where number is the amount of missing digits, much like
6498 an exponential notation.
6499 item A one letter code as described below.
6500
6501 Following is a description of the possible statusline items. The
6502 second character in "item" is the type:
6503 N for number
6504 S for string
6505 F for flags as described below
6506 - not applicable
6507
6508 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006509 f S Path to the file in the buffer, as typed or relative to current
6510 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511 F S Full path to the file in the buffer.
6512 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006513 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006515 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006517 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006519 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006521 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6523 {not available when compiled without |+autocmd| feature}
6524 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6525 being used: "<keymap>"
6526 n N Buffer number.
6527 b N Value of byte under cursor.
6528 B N As above, in hexadecimal.
6529 o N Byte number in file of byte under cursor, first byte is 1.
6530 Mnemonic: Offset from start of file (with one added)
6531 {not available when compiled without |+byte_offset| feature}
6532 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006533 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006534 l N Line number.
6535 L N Number of lines in buffer.
6536 c N Column number.
6537 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006538 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006539 p N Percentage through file in lines as in |CTRL-G|.
6540 P S Percentage through file of displayed window. This is like the
6541 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006542 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006544 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006545 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 ( - Start of item group. Can be used for setting the width and
6547 alignment of a section. Must be followed by %) somewhere.
6548 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006549 T N For 'tabline': start of tab page N label. Use %T after the last
6550 label. This information is used for mouse clicks.
6551 X N For 'tabline': start of close tab N label. Use %X after the
6552 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6553 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 < - Where to truncate line if too long. Default is at the start.
6555 No width fields allowed.
6556 = - Separation point between left and right aligned items.
6557 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006558 # - Set highlight group. The name must follow and then a # again.
6559 Thus use %#HLname# for highlight group HLname. The same
6560 highlighting is used, also for the statusline of non-current
6561 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006563 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006564 The difference between User{N} and StatusLine will be applied
6565 to StatusLineNC for the statusline of non-current windows.
6566 The number N must be between 1 and 9. See |hl-User1..9|
6567
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006568 When displaying a flag, Vim removes the leading comma, if any, when
6569 that flag comes right after plaintext. This will make a nice display
6570 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571
Bram Moolenaar582fd852005-03-28 20:58:01 +00006572 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 not set) and a minwid is not set for the group, the whole group will
6574 become empty. This will make a group like the following disappear
6575 completely from the statusline when none of the flags are set. >
6576 :set statusline=...%(\ [%M%R%H]%)...
6577<
6578 Beware that an expression is evaluated each and every time the status
6579 line is displayed. The current buffer and current window will be set
6580 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006581 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006583 real current buffer.
6584
6585 The 'statusline' option may be evaluated in the |sandbox|, see
6586 |sandbox-option|.
6587
6588 It is not allowed to change text or jump to another window while
6589 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590
6591 If the statusline is not updated when you want it (e.g., after setting
6592 a variable that's used in an expression), you can force an update by
6593 setting an option without changing its value. Example: >
6594 :let &ro = &ro
6595
6596< A result of all digits is regarded a number for display purposes.
6597 Otherwise the result is taken as flag text and applied to the rules
6598 described above.
6599
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006600 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6602 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6603
6604 Examples:
6605 Emulate standard status line with 'ruler' set >
6606 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6607< Similar, but add ASCII value of char under the cursor (like "ga") >
6608 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6609< Display byte count and byte value, modified flag in red. >
6610 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6611 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6612< Display a ,GZ flag if a compressed file is loaded >
6613 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6614< In the |:autocmd|'s: >
6615 :let b:gzflag = 1
6616< And: >
6617 :unlet b:gzflag
6618< And define this function: >
6619 :function VarExists(var, val)
6620 : if exists(a:var) | return a:val | else | return '' | endif
6621 :endfunction
6622<
6623 *'suffixes'* *'su'*
6624'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6625 global
6626 {not in Vi}
6627 Files with these suffixes get a lower priority when multiple files
6628 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006629 suffixes. Spaces after the comma are ignored. A dot is also seen as
6630 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 separator, precede it with a backslash (see |option-backslash| about
6632 including spaces and backslashes).
6633 See 'wildignore' for completely ignoring files.
6634 The use of |:set+=| and |:set-=| is preferred when adding or removing
6635 suffixes from the list. This avoids problems when a future version
6636 uses another default.
6637
6638 *'suffixesadd'* *'sua'*
6639'suffixesadd' 'sua' string (default "")
6640 local to buffer
6641 {not in Vi}
6642 {not available when compiled without the
6643 |+file_in_path| feature}
6644 Comma separated list of suffixes, which are used when searching for a
6645 file for the "gf", "[I", etc. commands. Example: >
6646 :set suffixesadd=.java
6647<
6648 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6649'swapfile' 'swf' boolean (default on)
6650 local to buffer
6651 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006652 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 swapfile is not wanted for a specific buffer. For example, with
6654 confidential information that even root must not be able to access.
6655 Careful: All text will be in memory:
6656 - Don't use this for big files.
6657 - Recovery will be impossible!
6658 A swapfile will only be present when |'updatecount'| is non-zero and
6659 'swapfile' is set.
6660 When 'swapfile' is reset, the swap file for the current buffer is
6661 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6662 non-zero, a swap file is immediately created.
6663 Also see |swap-file| and |'swapsync'|.
6664
6665 This option is used together with 'bufhidden' and 'buftype' to
6666 specify special kinds of buffers. See |special-buffers|.
6667
6668 *'swapsync'* *'sws'*
6669'swapsync' 'sws' string (default "fsync")
6670 global
6671 {not in Vi}
6672 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006673 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 When this option is empty parts of the swap file may be in memory and
6675 not written to disk. When the system crashes you may lose more work.
6676 On Unix the system does a sync now and then without Vim asking for it,
6677 so the disadvantage of setting this option off is small. On some
6678 systems the swap file will not be written at all. For a unix system
6679 setting it to "sync" will use the sync() call instead of the default
6680 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006681 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682
6683 *'switchbuf'* *'swb'*
6684'switchbuf' 'swb' string (default "")
6685 global
6686 {not in Vi}
6687 This option controls the behavior when switching between buffers.
6688 Possible values (comma separated list):
6689 useopen If included, jump to the first open window that
6690 contains the specified buffer (if there is one).
6691 Otherwise: Do not examine other windows.
6692 This setting is checked with |quickfix| commands, when
6693 jumping to errors (":cc", ":cn", "cp", etc.). It is
6694 also used in all buffer related split commands, for
6695 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006696 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006697 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006698 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006699 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006701 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006702 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006704 *'synmaxcol'* *'smc'*
6705'synmaxcol' 'smc' number (default 3000)
6706 local to buffer
6707 {not in Vi}
6708 {not available when compiled without the |+syntax|
6709 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006710 Maximum column in which to search for syntax items. In long lines the
6711 text after this column is not highlighted and following lines may not
6712 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006713 This helps to avoid very slow redrawing for an XML file that is one
6714 long line.
6715 Set to zero to remove the limit.
6716
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 *'syntax'* *'syn'*
6718'syntax' 'syn' string (default empty)
6719 local to buffer
6720 {not in Vi}
6721 {not available when compiled without the |+syntax|
6722 feature}
6723 When this option is set, the syntax with this name is loaded, unless
6724 syntax highlighting has been switched off with ":syntax off".
6725 Otherwise this option does not always reflect the current syntax (the
6726 b:current_syntax variable does).
6727 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006728 not automatically recognized. Example, in an IDL file:
6729 /* vim: set syntax=idl : */ ~
6730 When a dot appears in the value then this separates two filetype
6731 names. Example:
6732 /* vim: set syntax=c.doxygen : */ ~
6733 This will use the "c" syntax first, then the "doxygen" syntax.
6734 Note that the second one must be prepared to be loaded as an addition,
6735 otherwise it will be skipped. More than one dot may appear.
6736 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006737 :set syntax=OFF
6738< To switch syntax highlighting on according to the current value of the
6739 'filetype' option: >
6740 :set syntax=ON
6741< What actually happens when setting the 'syntax' option is that the
6742 Syntax autocommand event is triggered with the value as argument.
6743 This option is not copied to another buffer, independent of the 's' or
6744 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006745 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006747 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006748'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006749 global
6750 {not in Vi}
6751 {not available when compiled without the +windows
6752 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006753 When nonempty, this option determines the content of the tab pages
6754 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006755 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006756
6757 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006758 option and only when there is no GUI tab line. When 'e' is in
6759 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6760 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006761
6762 The value is evaluated like with 'statusline'. You can use
6763 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006764 the text to be displayed. Use "%1T" for the first label, "%2T" for
6765 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006766
6767 Keep in mind that only one of the tab pages is the current one, others
6768 are invisible and you can't jump to their windows.
6769
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006770
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006771 *'tabpagemax'* *'tpm'*
6772'tabpagemax' 'tpm' number (default 10)
6773 global
6774 {not in Vi}
6775 {not available when compiled without the +windows
6776 feature}
6777 Maximum number of tab pages to be opened by the |-p| command line
6778 argument or the ":tab all" command. |tabpage|
6779
6780
6781 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782'tabstop' 'ts' number (default 8)
6783 local to buffer
6784 Number of spaces that a <Tab> in the file counts for. Also see
6785 |:retab| command, and 'softtabstop' option.
6786
6787 Note: Setting 'tabstop' to any other value than 8 can make your file
6788 appear wrong in many places (e.g., when printing it).
6789
6790 There are four main ways to use tabs in Vim:
6791 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6792 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006793 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 behave like a tab appears every 4 (or 3) characters.
6795 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6796 'expandtab'. This way you will always insert spaces. The
6797 formatting will never be messed up when 'tabstop' is changed.
6798 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006799 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800 works when using Vim to edit the file.
6801 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6802 'noexpandtab'. This should then work (for initial indents only)
6803 for any tabstop setting that people use. It might be nice to have
6804 tabs after the first non-blank inserted as spaces if you do this
6805 though. Otherwise aligned comments will be wrong when 'tabstop' is
6806 changed.
6807
6808 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6809'tagbsearch' 'tbs' boolean (default on)
6810 global
6811 {not in Vi}
6812 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006813 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 searching makes searching for a tag a LOT faster, but a linear search
6815 will find more tags if the tags file wasn't properly sorted.
6816 Vim normally assumes that your tags files are sorted, or indicate that
6817 they are not sorted. Only when this is not the case does the
6818 'tagbsearch' option need to be switched off.
6819
6820 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006821 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822 certain files, or retry all files with a linear search. When
6823 'tagbsearch' is off, only a linear search is done.
6824
6825 Linear searching is done anyway, for one file, when Vim finds a line
6826 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006827 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828< [The whitespace before and after the '0' must be a single <Tab>]
6829
6830 When a binary search was done and no match was found in any of the
6831 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6832 instead of a normal tag name, a retry is done with a linear search.
6833 Tags in unsorted tags files, and matches with different case will only
6834 be found in the retry.
6835
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006836 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 linear search can be avoided for the 'ignorecase' case. Use a value
6838 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6839 case-fold sorted with the -f switch to "sort" in most unices, as in
6840 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006841 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6842 for this as well. Note that case must be folded to uppercase for this
6843 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844
6845 When 'tagbsearch' is off, tags searching is slower when a full match
6846 exists, but faster when no full match exists. Tags in unsorted tags
6847 files may only be found with 'tagbsearch' off.
6848 When the tags file is not sorted, or sorted in a wrong way (not on
6849 ASCII byte value), 'tagbsearch' should be off, or the line given above
6850 must be included in the tags file.
6851 This option doesn't affect commands that find all matching tags (e.g.,
6852 command-line completion and ":help").
6853 {Vi: always uses binary search in some versions}
6854
6855 *'taglength'* *'tl'*
6856'taglength' 'tl' number (default 0)
6857 global
6858 If non-zero, tags are significant up to this number of characters.
6859
6860 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6861'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6862 global
6863 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006864 If on and using a tags file in another directory, file names in that
6865 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 NOTE: This option is set to the Vi default value when 'compatible' is
6867 set and to the Vim default value when 'compatible' is reset.
6868
6869 *'tags'* *'tag'* *E433*
6870'tags' 'tag' string (default "./tags,tags", when compiled with
6871 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6872 global or local to buffer |global-local|
6873 Filenames for the tag command, separated by spaces or commas. To
6874 include a space or comma in a file name, precede it with a backslash
6875 (see |option-backslash| about including spaces and backslashes).
6876 When a file name starts with "./", the '.' is replaced with the path
6877 of the current file. But only when the 'd' flag is not included in
6878 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6879 |tags-option|.
6880 "*", "**" and other wildcards can be used to search for tags files in
6881 a directory tree. See |file-searching|. {not available when compiled
6882 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006883 The |tagfiles()| function can be used to get a list of the file names
6884 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6886 files are also supported. They are automatically recognized. The
6887 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6888 differences are ignored (MS-Windows). |emacs-tags|
6889 The use of |:set+=| and |:set-=| is preferred when adding or removing
6890 file names from the list. This avoids problems when a future version
6891 uses another default.
6892 {Vi: default is "tags /usr/lib/tags"}
6893
6894 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6895'tagstack' 'tgst' boolean (default on)
6896 global
6897 {not in all versions of Vi}
6898 When on, the |tagstack| is used normally. When off, a ":tag" or
6899 ":tselect" command with an argument will not push the tag onto the
6900 tagstack. A following ":tag" without an argument, a ":pop" command or
6901 any other command that uses the tagstack will use the unmodified
6902 tagstack, but does change the pointer to the active entry.
6903 Resetting this option is useful when using a ":tag" command in a
6904 mapping which should not change the tagstack.
6905
6906 *'term'* *E529* *E530* *E531*
6907'term' string (default is $TERM, if that fails:
6908 in the GUI: "builtin_gui"
6909 on Amiga: "amiga"
6910 on BeOS: "beos-ansi"
6911 on Mac: "mac-ansi"
6912 on MiNT: "vt52"
6913 on MS-DOS: "pcterm"
6914 on OS/2: "os2ansi"
6915 on Unix: "ansi"
6916 on VMS: "ansi"
6917 on Win 32: "win32")
6918 global
6919 Name of the terminal. Used for choosing the terminal control
6920 characters. Environment variables are expanded |:set_env|.
6921 For example: >
6922 :set term=$TERM
6923< See |termcap|.
6924
6925 *'termbidi'* *'tbidi'*
6926 *'notermbidi'* *'notbidi'*
6927'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6928 global
6929 {not in Vi}
6930 {only available when compiled with the |+arabic|
6931 feature}
6932 The terminal is in charge of Bi-directionality of text (as specified
6933 by Unicode). The terminal is also expected to do the required shaping
6934 that some languages (such as Arabic) require.
6935 Setting this option implies that 'rightleft' will not be set when
6936 'arabic' is set and the value of 'arabicshape' will be ignored.
6937 Note that setting 'termbidi' has the immediate effect that
6938 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6939 This option is reset when the GUI is started.
6940 For further details see |arabic.txt|.
6941
6942 *'termencoding'* *'tenc'*
6943'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6944 Macintosh GUI: "macroman")
6945 global
6946 {only available when compiled with the |+multi_byte|
6947 feature}
6948 {not in Vi}
6949 Encoding used for the terminal. This specifies what character
6950 encoding the keyboard produces and the display will understand. For
6951 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006952 display). Except for the Mac when 'macatsui' is off, then
6953 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954 In the Win32 console version the default value is the console codepage
6955 when it differs from the ANSI codepage.
6956 *E617*
6957 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6958 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6959 Any attempts to set a different value will be rejected, and an error
6960 message is shown.
6961 For the Win32 GUI 'termencoding' is not used for typed characters,
6962 because the Win32 system always passes Unicode characters.
6963 When empty, the same encoding is used as for the 'encoding' option.
6964 This is the normal value.
6965 Not all combinations for 'termencoding' and 'encoding' are valid. See
6966 |encoding-table|.
6967 The value for this option must be supported by internal conversions or
6968 iconv(). When this is not possible no conversion will be done and you
6969 will probably experience problems with non-ASCII characters.
6970 Example: You are working with the locale set to euc-jp (Japanese) and
6971 want to edit a UTF-8 file: >
6972 :let &termencoding = &encoding
6973 :set encoding=utf-8
6974< You need to do this when your system has no locale support for UTF-8.
6975
6976 *'terse'* *'noterse'*
6977'terse' boolean (default off)
6978 global
6979 When set: Add 's' flag to 'shortmess' option (this makes the message
6980 for a search that hits the start or end of the file not being
6981 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6982 shortens a lot of messages}
6983
6984 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6985'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6986 global
6987 {not in Vi}
6988 This option is obsolete. Use 'fileformats'.
6989 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6990 set to the default value for the current system. When 'textauto' is
6991 reset, 'fileformats' is made empty.
6992 NOTE: This option is set to the Vi default value when 'compatible' is
6993 set and to the Vim default value when 'compatible' is reset.
6994
6995 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6996'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6997 others: default off)
6998 local to buffer
6999 {not in Vi}
7000 This option is obsolete. Use 'fileformat'.
7001 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7002 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7003 "unix".
7004
7005 *'textwidth'* *'tw'*
7006'textwidth' 'tw' number (default 0)
7007 local to buffer
7008 {not in Vi}
7009 Maximum width of text that is being inserted. A longer line will be
7010 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007011 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7012 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007014 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015 NOTE: This option is set to 0 when 'compatible' is set.
7016
7017 *'thesaurus'* *'tsr'*
7018'thesaurus' 'tsr' string (default "")
7019 global or local to buffer |global-local|
7020 {not in Vi}
7021 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007022 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007023 the file should contain words with similar meaning, separated by
7024 non-keyword characters (white space is preferred). Maximum line
7025 length is 510 bytes.
7026 To obtain a file to be used here, check out the wordlist FAQ at
7027 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007028 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 after a comma are ignored, otherwise spaces are included in the file
7030 name. See |option-backslash| about using backslashes.
7031 The use of |:set+=| and |:set-=| is preferred when adding or removing
7032 directories from the list. This avoids problems when a future version
7033 uses another default.
7034 Backticks cannot be used in this option for security reasons.
7035
7036 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7037'tildeop' 'top' boolean (default off)
7038 global
7039 {not in Vi}
7040 When on: The tilde command "~" behaves like an operator.
7041 NOTE: This option is reset when 'compatible' is set.
7042
7043 *'timeout'* *'to'* *'notimeout'* *'noto'*
7044'timeout' 'to' boolean (default on)
7045 global
7046 *'ttimeout'* *'nottimeout'*
7047'ttimeout' boolean (default off)
7048 global
7049 {not in Vi}
7050 These two options together determine the behavior when part of a
7051 mapped key sequence or keyboard code has been received:
7052
7053 'timeout' 'ttimeout' action ~
7054 off off do not time out
7055 on on or off time out on :mappings and key codes
7056 off on time out on key codes
7057
7058 If both options are off, Vim will wait until either the complete
7059 mapping or key sequence has been received, or it is clear that there
7060 is no mapping or key sequence for the received characters. For
7061 example: if you have mapped "vl" and Vim has received 'v', the next
7062 character is needed to see if the 'v' is followed by an 'l'.
7063 When one of the options is on, Vim will wait for about 1 second for
7064 the next character to arrive. After that the already received
7065 characters are interpreted as single characters. The waiting time can
7066 be changed with the 'timeoutlen' option.
7067 On slow terminals or very busy systems timing out may cause
7068 malfunctioning cursor keys. If both options are off, Vim waits
7069 forever after an entered <Esc> if there are key codes that start
7070 with <Esc>. You will have to type <Esc> twice. If you do not have
7071 problems with key codes, but would like to have :mapped key
7072 sequences not timing out in 1 second, set the 'ttimeout' option and
7073 reset the 'timeout' option.
7074
7075 NOTE: 'ttimeout' is reset when 'compatible' is set.
7076
7077 *'timeoutlen'* *'tm'*
7078'timeoutlen' 'tm' number (default 1000)
7079 global
7080 {not in all versions of Vi}
7081 *'ttimeoutlen'* *'ttm'*
7082'ttimeoutlen' 'ttm' number (default -1)
7083 global
7084 {not in Vi}
7085 The time in milliseconds that is waited for a key code or mapped key
7086 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7087 when part of a command has been typed.
7088 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7089 different timeout value for key codes is desired set 'ttimeoutlen' to
7090 a non-negative number.
7091
7092 ttimeoutlen mapping delay key code delay ~
7093 < 0 'timeoutlen' 'timeoutlen'
7094 >= 0 'timeoutlen' 'ttimeoutlen'
7095
7096 The timeout only happens when the 'timeout' and 'ttimeout' options
7097 tell so. A useful setting would be >
7098 :set timeout timeoutlen=3000 ttimeoutlen=100
7099< (time out on mapping after three seconds, time out on key codes after
7100 a tenth of a second).
7101
7102 *'title'* *'notitle'*
7103'title' boolean (default off, on when title can be restored)
7104 global
7105 {not in Vi}
7106 {not available when compiled without the |+title|
7107 feature}
7108 When on, the title of the window will be set to the value of
7109 'titlestring' (if it is not empty), or to:
7110 filename [+=-] (path) - VIM
7111 Where:
7112 filename the name of the file being edited
7113 - indicates the file cannot be modified, 'ma' off
7114 + indicates the file was modified
7115 = indicates the file is read-only
7116 =+ indicates the file is read-only and modified
7117 (path) is the path of the file being edited
7118 - VIM the server name |v:servername| or "VIM"
7119 Only works if the terminal supports setting window titles
7120 (currently Amiga console, Win32 console, all GUI versions and
7121 terminals with a non- empty 't_ts' option - these are Unix xterm and
7122 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7123 *X11*
7124 When Vim was compiled with HAVE_X11 defined, the original title will
7125 be restored if possible. The output of ":version" will include "+X11"
7126 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7127 works for the icon name |'icon'|.
7128 But: When Vim was started with the |-X| argument, restoring the title
7129 will not work (except in the GUI).
7130 If the title cannot be restored, it is set to the value of 'titleold'.
7131 You might want to restore the title outside of Vim then.
7132 When using an xterm from a remote machine you can use this command:
7133 rsh machine_name xterm -display $DISPLAY &
7134 then the WINDOWID environment variable should be inherited and the
7135 title of the window should change back to what it should be after
7136 exiting Vim.
7137
7138 *'titlelen'*
7139'titlelen' number (default 85)
7140 global
7141 {not in Vi}
7142 {not available when compiled without the |+title|
7143 feature}
7144 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007145 title. When the title is longer, only the end of the path name is
7146 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 Using a percentage makes this adapt to the width of the window. But
7148 it won't work perfectly, because the actual number of characters
7149 available also depends on the font used and other things in the title
7150 bar. When 'titlelen' is zero the full path is used. Otherwise,
7151 values from 1 to 30000 percent can be used.
7152 'titlelen' is also used for the 'titlestring' option.
7153
7154 *'titleold'*
7155'titleold' string (default "Thanks for flying Vim")
7156 global
7157 {not in Vi}
7158 {only available when compiled with the |+title|
7159 feature}
7160 This option will be used for the window title when exiting Vim if the
7161 original title cannot be restored. Only happens if 'title' is on or
7162 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007163 This option cannot be set from a |modeline| or in the |sandbox|, for
7164 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 *'titlestring'*
7166'titlestring' string (default "")
7167 global
7168 {not in Vi}
7169 {not available when compiled without the |+title|
7170 feature}
7171 When this option is not empty, it will be used for the title of the
7172 window. This happens only when the 'title' option is on.
7173 Only works if the terminal supports setting window titles (currently
7174 Amiga console, Win32 console, all GUI versions and terminals with a
7175 non-empty 't_ts' option).
7176 When Vim was compiled with HAVE_X11 defined, the original title will
7177 be restored if possible |X11|.
7178 When this option contains printf-style '%' items, they will be
7179 expanded according to the rules used for 'statusline'.
7180 Example: >
7181 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7182 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7183< The value of 'titlelen' is used to align items in the middle or right
7184 of the available space.
7185 Some people prefer to have the file name first: >
7186 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7187< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007188 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007189 separating space only when needed.
7190 NOTE: Use of special characters in 'titlestring' may cause the display
7191 to be garbled (e.g., when it contains a CR or NL character).
7192 {not available when compiled without the |+statusline| feature}
7193
7194 *'toolbar'* *'tb'*
7195'toolbar' 'tb' string (default "icons,tooltips")
7196 global
7197 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7198 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007199 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 possible values are:
7201 icons Toolbar buttons are shown with icons.
7202 text Toolbar buttons shown with text.
7203 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007204 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007205 tooltips Tooltips are active for toolbar buttons.
7206 Tooltips refer to the popup help text which appears after the mouse
7207 cursor is placed over a toolbar button for a brief moment.
7208
7209 If you want the toolbar to be shown with icons as well as text, do the
7210 following: >
7211 :set tb=icons,text
7212< Motif and Athena cannot display icons and text at the same time. They
7213 will show icons if both are requested.
7214
7215 If none of the strings specified in 'toolbar' are valid or if
7216 'toolbar' is empty, this option is ignored. If you want to disable
7217 the toolbar, you need to set the 'guioptions' option. For example: >
7218 :set guioptions-=T
7219< Also see |gui-toolbar|.
7220
7221 *'toolbariconsize'* *'tbis'*
7222'toolbariconsize' 'tbis' string (default "small")
7223 global
7224 {not in Vi}
7225 {only in the GTK+ 2 GUI}
7226 Controls the size of toolbar icons. The possible values are:
7227 tiny Use tiny toolbar icons.
7228 small Use small toolbar icons (default).
7229 medium Use medium-sized toolbar icons.
7230 large Use large toolbar icons.
7231 The exact dimensions in pixels of the various icon sizes depend on
7232 the current theme. Common dimensions are large=32x32, medium=24x24,
7233 small=20x20 and tiny=16x16.
7234
7235 If 'toolbariconsize' is empty, the global default size as determined
7236 by user preferences or the current theme is used.
7237
7238 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7239'ttybuiltin' 'tbi' boolean (default on)
7240 global
7241 {not in Vi}
7242 When on, the builtin termcaps are searched before the external ones.
7243 When off the builtin termcaps are searched after the external ones.
7244 When this option is changed, you should set the 'term' option next for
7245 the change to take effect, for example: >
7246 :set notbi term=$TERM
7247< See also |termcap|.
7248 Rationale: The default for this option is "on", because the builtin
7249 termcap entries are generally better (many systems contain faulty
7250 xterm entries...).
7251
7252 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7253'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7254 sun-cmd, screen, rxvt, dtterm or
7255 iris-ansi; also on when running Vim in
7256 a DOS console)
7257 global
7258 {not in Vi}
7259 Indicates a fast terminal connection. More characters will be sent to
7260 the screen for redrawing, instead of using insert/delete line
7261 commands. Improves smoothness of redrawing when there are multiple
7262 windows and the terminal does not support a scrolling region.
7263 Also enables the extra writing of characters at the end of each screen
7264 line for lines that wrap. This helps when using copy/paste with the
7265 mouse in an xterm and other terminals.
7266
7267 *'ttymouse'* *'ttym'*
7268'ttymouse' 'ttym' string (default depends on 'term')
7269 global
7270 {not in Vi}
7271 {only in Unix and VMS, doesn't work in the GUI; not
7272 available when compiled without |+mouse|}
7273 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007274 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 *xterm-mouse*
7276 xterm xterm-like mouse handling. The mouse generates
7277 "<Esc>[Mscr", where "scr" is three bytes:
7278 "s" = button state
7279 "c" = column plus 33
7280 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007281 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007282 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283 xterm2 Works like "xterm", but with the xterm reporting the
7284 mouse position while the mouse is dragged. This works
7285 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007286 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287 work. See below for how Vim detects this
7288 automatically.
7289 *netterm-mouse*
7290 netterm NetTerm mouse handling. The mouse generates
7291 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7292 for the row and column.
7293 *dec-mouse*
7294 dec DEC terminal mouse handling. The mouse generates a
7295 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007296 This is also available for an Xterm, if it was
7297 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007298 *jsbterm-mouse*
7299 jsbterm JSB term mouse handling.
7300 *pterm-mouse*
7301 pterm QNX pterm mouse handling.
7302
7303 The mouse handling must be enabled at compile time |+mouse_xterm|
7304 |+mouse_dec| |+mouse_netterm|.
7305 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7306 recognized, if enabled at compile time. DEC terminal mouse codes
7307 are recognized if enabled at compile time, and 'ttymouse' is not
7308 "xterm" (because the xterm and dec mouse codes conflict).
7309 This option is automatically set to "xterm", when the 'term' option is
7310 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7311 or "xterm2" already. The main use of this option is to set it to
7312 "xterm", when the terminal name doesn't start with "xterm", but it can
7313 handle xterm mouse codes.
7314 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007315 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 feature and if |t_RV| is set to the escape sequence to request the
7317 xterm version number. Otherwise "xterm2" must be set explicitly.
7318 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7319 t_RV to an empty string: >
7320 :set t_RV=
7321<
7322 *'ttyscroll'* *'tsl'*
7323'ttyscroll' 'tsl' number (default 999)
7324 global
7325 Maximum number of lines to scroll the screen. If there are more lines
7326 to scroll the window is redrawn. For terminals where scrolling is
7327 very slow and redrawing is not slow this can be set to a small number,
7328 e.g., 3, to speed up displaying.
7329
7330 *'ttytype'* *'tty'*
7331'ttytype' 'tty' string (default from $TERM)
7332 global
7333 Alias for 'term', see above.
7334
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007335 *'undodir'* *'udir'*
7336'undodir' 'udir' string (default ".")
7337 global
7338 {not in Vi}
7339 {only when compiled with the +persistent_undo feature}
7340 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007341 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007342 "." means using the directory of the file. The undo file name for
7343 "file.txt" is ".file.txt.un~".
7344 For other directories the file name is the full path of the edited
7345 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007346 When writing: The first directory that exists is used. "." always
7347 works, no directories after "." will be used for writing.
7348 When reading all entries are tried to find an undo file. The first
7349 undo file that exists is used. When it cannot be read an error is
7350 given, no further entry is used.
7351 See |undo-persistence|.
7352
7353 *'undofile'* *'udf'*
7354'undofile' 'udf' boolean (default off)
7355 local to buffer
7356 {not in Vi}
7357 {only when compiled with the +persistent_undo feature}
7358 When on, Vim automatically saves undo history to an undo file when
7359 writing a buffer to a file, and restores undo history from the same
7360 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007361 The directory where the undo file is stored is specified by 'undodir'.
7362 For more information about this feature see |undo-persistence|.
7363 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007364
Bram Moolenaar071d4272004-06-13 20:20:40 +00007365 *'undolevels'* *'ul'*
7366'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7367 Win32 and OS/2)
7368 global
7369 {not in Vi}
7370 Maximum number of changes that can be undone. Since undo information
7371 is kept in memory, higher numbers will cause more memory to be used
7372 (nevertheless, a single change can use an unlimited amount of memory).
7373 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7374 itself: >
7375 set ul=0
7376< But you can also get Vi compatibility by including the 'u' flag in
7377 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007378 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007379 Set to a negative number for no undo at all: >
7380 set ul=-1
7381< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007382 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007383
7384 *'updatecount'* *'uc'*
7385'updatecount' 'uc' number (default: 200)
7386 global
7387 {not in Vi}
7388 After typing this many characters the swap file will be written to
7389 disk. When zero, no swap file will be created at all (see chapter on
7390 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7391 Vim with the "-n" option, see |startup|. When editing in readonly
7392 mode this option will be initialized to 10000.
7393 The swapfile can be disabled per buffer with |'swapfile'|.
7394 When 'updatecount' is set from zero to non-zero, swap files are
7395 created for all buffers that have 'swapfile' set. When 'updatecount'
7396 is set to zero, existing swap files are not deleted.
7397 Also see |'swapsync'|.
7398 This option has no meaning in buffers where |'buftype'| is "nofile"
7399 or "nowrite".
7400
7401 *'updatetime'* *'ut'*
7402'updatetime' 'ut' number (default 4000)
7403 global
7404 {not in Vi}
7405 If this many milliseconds nothing is typed the swap file will be
7406 written to disk (see |crash-recovery|). Also used for the
7407 |CursorHold| autocommand event.
7408
7409 *'verbose'* *'vbs'*
7410'verbose' 'vbs' number (default 0)
7411 global
7412 {not in Vi, although some versions have a boolean
7413 verbose option}
7414 When bigger than zero, Vim will give messages about what it is doing.
7415 Currently, these messages are given:
7416 >= 1 When the viminfo file is read or written.
7417 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007418 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007419 >= 8 Files for which a group of autocommands is executed.
7420 >= 9 Every executed autocommand.
7421 >= 12 Every executed function.
7422 >= 13 When an exception is thrown, caught, finished, or discarded.
7423 >= 14 Anything pending in a ":finally" clause.
7424 >= 15 Every executed Ex command (truncated at 200 characters).
7425
7426 This option can also be set with the "-V" argument. See |-V|.
7427 This option is also set by the |:verbose| command.
7428
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007429 When the 'verbosefile' option is set then the verbose messages are not
7430 displayed.
7431
7432 *'verbosefile'* *'vfile'*
7433'verbosefile' 'vfile' string (default empty)
7434 global
7435 {not in Vi}
7436 When not empty all messages are written in a file with this name.
7437 When the file exists messages are appended.
7438 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007439 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007440 Setting 'verbosefile' to a new value is like making it empty first.
7441 The difference with |:redir| is that verbose messages are not
7442 displayed when 'verbosefile' is set.
7443
Bram Moolenaar071d4272004-06-13 20:20:40 +00007444 *'viewdir'* *'vdir'*
7445'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7446 "$VIM/vimfiles/view",
7447 for Unix: "~/.vim/view",
7448 for Macintosh: "$VIM:vimfiles:view"
7449 for VMS: "sys$login:vimfiles/view"
7450 for RiscOS: "Choices:vimfiles/view")
7451 global
7452 {not in Vi}
7453 {not available when compiled without the +mksession
7454 feature}
7455 Name of the directory where to store files for |:mkview|.
7456 This option cannot be set from a |modeline| or in the |sandbox|, for
7457 security reasons.
7458
7459 *'viewoptions'* *'vop'*
7460'viewoptions' 'vop' string (default: "folds,options,cursor")
7461 global
7462 {not in Vi}
7463 {not available when compiled without the +mksession
7464 feature}
7465 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007466 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467 word save and restore ~
7468 cursor cursor position in file and in window
7469 folds manually created folds, opened/closed folds and local
7470 fold options
7471 options options and mappings local to a window or buffer (not
7472 global values for local options)
7473 slash backslashes in file names replaced with forward
7474 slashes
7475 unix with Unix end-of-line format (single <NL>), even when
7476 on Windows or DOS
7477
7478 "slash" and "unix" are useful on Windows when sharing view files
7479 with Unix. The Unix version of Vim cannot source dos format scripts,
7480 but the Windows version of Vim can source unix format scripts.
7481
7482 *'viminfo'* *'vi'* *E526* *E527* *E528*
7483'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007484 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7485 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7486 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 global
7488 {not in Vi}
7489 {not available when compiled without the |+viminfo|
7490 feature}
7491 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007492 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 separated list of parameters, each consisting of a single character
7494 identifying the particular parameter, followed by a number or string
7495 which specifies the value of that parameter. If a particular
7496 character is left out, then the default value is used for that
7497 parameter. The following is a list of the identifying characters and
7498 the effect of their value.
7499 CHAR VALUE ~
7500 ! When included, save and restore global variables that start
7501 with an uppercase letter, and don't contain a lowercase
7502 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007503 and "_K_L_M" are not. Only String and Number types are
7504 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 " Maximum number of lines saved for each register. Old name of
7506 the '<' item, with the disadvantage that you need to put a
7507 backslash before the ", otherwise it will be recognized as the
7508 start of a comment!
7509 % When included, save and restore the buffer list. If Vim is
7510 started with a file name argument, the buffer list is not
7511 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007512 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 without a file name and buffers for help files are not written
7514 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007515 When followed by a number, the number specifies the maximum
7516 number of buffers that are stored. Without a number all
7517 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518 ' Maximum number of previously edited files for which the marks
7519 are remembered. This parameter must always be included when
7520 'viminfo' is non-empty.
7521 Including this item also means that the |jumplist| and the
7522 |changelist| are stored in the viminfo file.
7523 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007524 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 patterns are also saved. When not included, the value of
7526 'history' is used.
7527 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007528 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 < Maximum number of lines saved for each register. If zero then
7530 registers are not saved. When not included, all lines are
7531 saved. '"' is the old name for this item.
7532 Also see the 's' item below: limit specified in Kbyte.
7533 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007534 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535 c When included, convert the text in the viminfo file from the
7536 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007537 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538 f Whether file marks need to be stored. If zero, file marks ('0
7539 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007540 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007541 cursor position (when exiting or when doing ":wviminfo").
7542 h Disable the effect of 'hlsearch' when loading the viminfo
7543 file. When not included, it depends on whether ":nohlsearch"
7544 has been used since the last search command.
7545 n Name of the viminfo file. The name must immediately follow
7546 the 'n'. Must be the last one! If the "-i" argument was
7547 given when starting Vim, that file name overrides the one
7548 given here with 'viminfo'. Environment variables are expanded
7549 when opening the file, not when setting the option.
7550 r Removable media. The argument is a string (up to the next
7551 ','). This parameter can be given several times. Each
7552 specifies the start of a path for which no marks will be
7553 stored. This is to avoid removable media. For MS-DOS you
7554 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7555 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7556 ignored. Maximum length of each 'r' argument is 50
7557 characters.
7558 s Maximum size of an item in Kbyte. If zero then registers are
7559 not saved. Currently only applies to registers. The default
7560 "s10" will exclude registers with more than 10 Kbyte of text.
7561 Also see the '<' item above: line count limit.
7562
7563 Example: >
7564 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7565<
7566 '50 Marks will be remembered for the last 50 files you
7567 edited.
7568 <1000 Contents of registers (up to 1000 lines each) will be
7569 remembered.
7570 s100 Registers with more than 100 Kbyte text are skipped.
7571 :0 Command-line history will not be saved.
7572 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7573 no / Since '/' is not specified, the default will be used,
7574 that is, save all of the search history, and also the
7575 previous search and substitute patterns.
7576 no % The buffer list will not be saved nor read back.
7577 no h 'hlsearch' highlighting will be restored.
7578
7579 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7580 load the contents of the file, this is not done automatically.
7581
7582 This option cannot be set from a |modeline| or in the |sandbox|, for
7583 security reasons.
7584
7585 *'virtualedit'* *'ve'*
7586'virtualedit' 've' string (default "")
7587 global
7588 {not in Vi}
7589 {not available when compiled without the
7590 |+virtualedit| feature}
7591 A comma separated list of these words:
7592 block Allow virtual editing in Visual block mode.
7593 insert Allow virtual editing in Insert mode.
7594 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007595 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007596
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007598 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 of the line. Useful for selecting a rectangle in Visual mode and
7600 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007601 "onemore" is not the same, it will only allow moving the cursor just
7602 after the last character of the line. This makes some commands more
7603 consistent. Previously the cursor was always past the end of the line
7604 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007605 break some plugins or Vim scripts. For example because |l| can move
7606 the cursor after the last character. Use with care!
7607 Using the |$| command will move to the last character in the line, not
7608 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007609 It doesn't make sense to combine "all" with "onemore", but you will
7610 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611
7612 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7613'visualbell' 'vb' boolean (default off)
7614 global
7615 {not in Vi}
7616 Use visual bell instead of beeping. The terminal code to display the
7617 visual bell is given with 't_vb'. When no beep or flash is wanted,
7618 use ":set vb t_vb=".
7619 Note: When the GUI starts, 't_vb' is reset to its default value. You
7620 might want to set it again in your |gvimrc|.
7621 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7622 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7623 where 40 is the time in msec.
7624 Does not work on the Amiga, you always get a screen flash.
7625 Also see 'errorbells'.
7626
7627 *'warn'* *'nowarn'*
7628'warn' boolean (default on)
7629 global
7630 Give a warning message when a shell command is used while the buffer
7631 has been changed.
7632
7633 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7634'weirdinvert' 'wiv' boolean (default off)
7635 global
7636 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007637 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007638 It is provided for backwards compatibility with version 4.x.
7639 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7640 vice versa. Has no effect when the GUI is running.
7641
7642 *'whichwrap'* *'ww'*
7643'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7644 global
7645 {not in Vi}
7646 Allow specified keys that move the cursor left/right to move to the
7647 previous/next line when the cursor is on the first/last character in
7648 the line. Concatenate characters to allow this for these keys:
7649 char key mode ~
7650 b <BS> Normal and Visual
7651 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007652 h "h" Normal and Visual (not recommended)
7653 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007654 < <Left> Normal and Visual
7655 > <Right> Normal and Visual
7656 ~ "~" Normal
7657 [ <Left> Insert and Replace
7658 ] <Right> Insert and Replace
7659 For example: >
7660 :set ww=<,>,[,]
7661< allows wrap only when cursor keys are used.
7662 When the movement keys are used in combination with a delete or change
7663 operator, the <EOL> also counts for a character. This makes "3h"
7664 different from "3dh" when the cursor crosses the end of a line. This
7665 is also true for "x" and "X", because they do the same as "dl" and
7666 "dh". If you use this, you may also want to use the mapping
7667 ":map <BS> X" to make backspace delete the character in front of the
7668 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007669 When 'l' is included and it is used after an operator at the end of a
7670 line then it will not move to the next line. This makes "dl", "cl",
7671 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007672 NOTE: This option is set to the Vi default value when 'compatible' is
7673 set and to the Vim default value when 'compatible' is reset.
7674
7675 *'wildchar'* *'wc'*
7676'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7677 global
7678 {not in Vi}
7679 Character you have to type to start wildcard expansion in the
7680 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007681 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682 The character is not recognized when used inside a macro. See
7683 'wildcharm' for that.
7684 Although 'wc' is a number option, you can set it to a special key: >
7685 :set wc=<Esc>
7686< NOTE: This option is set to the Vi default value when 'compatible' is
7687 set and to the Vim default value when 'compatible' is reset.
7688
7689 *'wildcharm'* *'wcm'*
7690'wildcharm' 'wcm' number (default: none (0))
7691 global
7692 {not in Vi}
7693 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007694 recognized when used inside a macro. You can find "spare" command-line
7695 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007696 you'll never actually type 'wildcharm', just use it in mappings that
7697 automatically invoke completion mode, e.g.: >
7698 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007699 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007700< Then after typing :ss you can use CTRL-P & CTRL-N.
7701
7702 *'wildignore'* *'wig'*
7703'wildignore' 'wig' string (default "")
7704 global
7705 {not in Vi}
7706 {not available when compiled without the |+wildignore|
7707 feature}
7708 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007709 patterns is ignored when completing file or directory names, and
7710 influences the result of |expand()|, |glob()| and |globpath()| unless
7711 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7713 Also see 'suffixes'.
7714 Example: >
7715 :set wildignore=*.o,*.obj
7716< The use of |:set+=| and |:set-=| is preferred when adding or removing
7717 a pattern from the list. This avoids problems when a future version
7718 uses another default.
7719
7720 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7721'wildmenu' 'wmnu' boolean (default off)
7722 global
7723 {not in Vi}
7724 {not available if compiled without the |+wildmenu|
7725 feature}
7726 When 'wildmenu' is on, command-line completion operates in an enhanced
7727 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7728 the possible matches are shown just above the command line, with the
7729 first match highlighted (overwriting the status line, if there is
7730 one). Keys that show the previous/next match, such as <Tab> or
7731 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7732 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7733 specified. "longest" and "list" do not start "wildmenu" mode.
7734 If there are more matches than can fit in the line, a ">" is shown on
7735 the right and/or a "<" is shown on the left. The status line scrolls
7736 as needed.
7737 The "wildmenu" mode is abandoned when a key is hit that is not used
7738 for selecting a completion.
7739 While the "wildmenu" is active the following keys have special
7740 meanings:
7741
7742 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7743 <Down> - in filename/menu name completion: move into a
7744 subdirectory or submenu.
7745 <CR> - in menu completion, when the cursor is just after a
7746 dot: move into a submenu.
7747 <Up> - in filename/menu name completion: move up into
7748 parent directory or parent menu.
7749
7750 This makes the menus accessible from the console |console-menus|.
7751
7752 If you prefer the <Left> and <Right> keys to move the cursor instead
7753 of selecting a different match, use this: >
7754 :cnoremap <Left> <Space><BS><Left>
7755 :cnoremap <Right> <Space><BS><Right>
7756<
7757 The "WildMenu" highlighting is used for displaying the current match
7758 |hl-WildMenu|.
7759
7760 *'wildmode'* *'wim'*
7761'wildmode' 'wim' string (Vim default: "full")
7762 global
7763 {not in Vi}
7764 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007765 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007766 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007767 first part specifies the behavior for the first use of 'wildchar',
7768 The second part for the second use, etc.
7769 These are the possible values for each part:
7770 "" Complete only the first match.
7771 "full" Complete the next full match. After the last match,
7772 the original string is used and then the first match
7773 again.
7774 "longest" Complete till longest common string. If this doesn't
7775 result in a longer string, use the next part.
7776 "longest:full" Like "longest", but also start 'wildmenu' if it is
7777 enabled.
7778 "list" When more than one match, list all matches.
7779 "list:full" When more than one match, list all matches and
7780 complete first match.
7781 "list:longest" When more than one match, list all matches and
7782 complete till longest common string.
7783 When there is only a single match, it is fully completed in all cases.
7784
7785 Examples: >
7786 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007787< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788 :set wildmode=longest,full
7789< Complete longest common string, then each full match >
7790 :set wildmode=list:full
7791< List all matches and complete each full match >
7792 :set wildmode=list,full
7793< List all matches without completing, then each full match >
7794 :set wildmode=longest,list
7795< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007796 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007798 *'wildoptions'* *'wop'*
7799'wildoptions' 'wop' string (default "")
7800 global
7801 {not in Vi}
7802 {not available when compiled without the |+wildignore|
7803 feature}
7804 A list of words that change how command line completion is done.
7805 Currently only one word is allowed:
7806 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007807 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007808 is displayed per line. Often used tag kinds are:
7809 d #define
7810 f function
7811 Also see |cmdline-completion|.
7812
Bram Moolenaar071d4272004-06-13 20:20:40 +00007813 *'winaltkeys'* *'wak'*
7814'winaltkeys' 'wak' string (default "menu")
7815 global
7816 {not in Vi}
7817 {only used in Win32, Motif, GTK and Photon GUI}
7818 Some GUI versions allow the access to menu entries by using the ALT
7819 key in combination with a character that appears underlined in the
7820 menu. This conflicts with the use of the ALT key for mappings and
7821 entering special characters. This option tells what to do:
7822 no Don't use ALT keys for menus. ALT key combinations can be
7823 mapped, but there is no automatic handling. This can then be
7824 done with the |:simalt| command.
7825 yes ALT key handling is done by the windowing system. ALT key
7826 combinations cannot be mapped.
7827 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007828 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 keys can be mapped.
7830 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7831 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007832 This option is not used for <F10>; on Win32 and with GTK <F10> will
7833 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007835 *'window'* *'wi'*
7836'window' 'wi' number (default screen height - 1)
7837 global
7838 Window height. Do not confuse this with the height of the Vim window,
7839 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007840 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7841 value is smaller than 'lines' minus one. The screen will scroll
7842 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007843 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7844 in a much smarter way, taking care of wrapping lines.
7845 When resizing the Vim window, the value is smaller than 1 or more than
7846 or equal to 'lines' it will be set to 'lines' minus 1.
7847 {Vi also uses the option to specify the number of displayed lines}
7848
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849 *'winheight'* *'wh'* *E591*
7850'winheight' 'wh' number (default 1)
7851 global
7852 {not in Vi}
7853 {not available when compiled without the +windows
7854 feature}
7855 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007856 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007857 focus goes to a window that is smaller, its size is increased, at the
7858 cost of the height of other windows.
7859 Set 'winheight' to a small number for normal editing.
7860 Set it to 999 to make the current window fill most of the screen.
7861 Other windows will be only 'winminheight' high. This has the drawback
7862 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7863 to create only two windows, set the option after startup is done,
7864 using the |VimEnter| event: >
7865 au VimEnter * set winheight=999
7866< Minimum value is 1.
7867 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868 height of the current window.
7869 'winheight' applies to the current window. Use 'winminheight' to set
7870 the minimal height for other windows.
7871
7872 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7873'winfixheight' 'wfh' boolean (default off)
7874 local to window
7875 {not in Vi}
7876 {not available when compiled without the +windows
7877 feature}
7878 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007879 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7880 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881 The height may be changed anyway when running out of room.
7882
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007883 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7884'winfixwidth' 'wfw' boolean (default off)
7885 local to window
7886 {not in Vi}
7887 {not available when compiled without the +windows
7888 feature}
7889 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007890 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007891 The width may be changed anyway when running out of room.
7892
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893 *'winminheight'* *'wmh'*
7894'winminheight' 'wmh' number (default 1)
7895 global
7896 {not in Vi}
7897 {not available when compiled without the +windows
7898 feature}
7899 The minimal height of a window, when it's not the current window.
7900 This is a hard minimum, windows will never become smaller.
7901 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7902 status bar) if necessary. They will return to at least one line when
7903 they become active (since the cursor has to have somewhere to go.)
7904 Use 'winheight' to set the minimal height of the current window.
7905 This option is only checked when making a window smaller. Don't use a
7906 large number, it will cause errors when opening more than a few
7907 windows. A value of 0 to 3 is reasonable.
7908
7909 *'winminwidth'* *'wmw'*
7910'winminwidth' 'wmw' number (default 1)
7911 global
7912 {not in Vi}
7913 {not available when compiled without the +vertsplit
7914 feature}
7915 The minimal width of a window, when it's not the current window.
7916 This is a hard minimum, windows will never become smaller.
7917 When set to zero, windows may be "squashed" to zero columns (i.e. just
7918 a vertical separator) if necessary. They will return to at least one
7919 line when they become active (since the cursor has to have somewhere
7920 to go.)
7921 Use 'winwidth' to set the minimal width of the current window.
7922 This option is only checked when making a window smaller. Don't use a
7923 large number, it will cause errors when opening more than a few
7924 windows. A value of 0 to 12 is reasonable.
7925
7926 *'winwidth'* *'wiw'* *E592*
7927'winwidth' 'wiw' number (default 20)
7928 global
7929 {not in Vi}
7930 {not available when compiled without the +vertsplit
7931 feature}
7932 Minimal number of columns for the current window. This is not a hard
7933 minimum, Vim will use fewer columns if there is not enough room. If
7934 the current window is smaller, its size is increased, at the cost of
7935 the width of other windows. Set it to 999 to make the current window
7936 always fill the screen. Set it to a small number for normal editing.
7937 The width is not adjusted after one of the commands to change the
7938 width of the current window.
7939 'winwidth' applies to the current window. Use 'winminwidth' to set
7940 the minimal width for other windows.
7941
7942 *'wrap'* *'nowrap'*
7943'wrap' boolean (default on)
7944 local to window
7945 {not in Vi}
7946 This option changes how text is displayed. It doesn't change the text
7947 in the buffer, see 'textwidth' for that.
7948 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007949 displaying continues on the next line. When off lines will not wrap
7950 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007951 moved to a part that is not shown, the screen will scroll
7952 horizontally.
7953 The line will be broken in the middle of a word if necessary. See
7954 'linebreak' to get the break at a word boundary.
7955 To make scrolling horizontally a bit more useful, try this: >
7956 :set sidescroll=5
7957 :set listchars+=precedes:<,extends:>
7958< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007959 This option can't be set from a |modeline| when the 'diff' option is
7960 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961
7962 *'wrapmargin'* *'wm'*
7963'wrapmargin' 'wm' number (default 0)
7964 local to buffer
7965 Number of characters from the right window border where wrapping
7966 starts. When typing text beyond this limit, an <EOL> will be inserted
7967 and inserting continues on the next line.
7968 Options that add a margin, such as 'number' and 'foldcolumn', cause
7969 the text width to be further reduced. This is Vi compatible.
7970 When 'textwidth' is non-zero, this option is not used.
7971 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7972 and less usefully}
7973
7974 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7975'wrapscan' 'ws' boolean (default on) *E384* *E385*
7976 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007977 Searches wrap around the end of the file. Also applies to |]s| and
7978 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007979
7980 *'write'* *'nowrite'*
7981'write' boolean (default on)
7982 global
7983 {not in Vi}
7984 Allows writing files. When not set, writing a file is not allowed.
7985 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007986 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007987 argument. Filtering text is still possible, even though this requires
7988 writing a temporary file.
7989
7990 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7991'writeany' 'wa' boolean (default off)
7992 global
7993 Allows writing to any file with no need for "!" override.
7994
7995 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7996'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7997 otherwise)
7998 global
7999 {not in Vi}
8000 Make a backup before overwriting a file. The backup is removed after
8001 the file was successfully written, unless the 'backup' option is
8002 also on. Reset this option if your file system is almost full. See
8003 |backup-table| for another explanation.
8004 When the 'backupskip' pattern matches, a backup is not made anyway.
8005 NOTE: This option is set to the default value when 'compatible' is
8006 set.
8007
8008 *'writedelay'* *'wd'*
8009'writedelay' 'wd' number (default 0)
8010 global
8011 {not in Vi}
8012 The number of microseconds to wait for each character sent to the
8013 screen. When non-zero, characters are sent to the terminal one by
8014 one. For MS-DOS pcterm this does not work. For debugging purposes.
8015
8016 vim:tw=78:ts=8:ft=help:norl: