blob: 469d6064c571db54c70b4648b268056de682017a [file] [log] [blame]
Bram Moolenaar477db062010-07-28 18:17:41 +02001*options.txt* For Vim version 7.3c. Last change: 2010 Jul 28
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.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200276 With the "all" argument: display local values for all
277 local options.
278 Without argument: Display local values for all local
279 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000281 local value. For a global/local boolean option, when
282 the global value is being used, "--" is displayed
283 before the option name.
284 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285 shown (but that might change in the future).
286 {not in Vi}
287
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000288:setl[ocal] {option}< Set the local value of {option} to its global value by
289 copying the value.
290 {not in Vi}
291
292:se[t] {option}< Set the local value of {option} to its global value by
293 making it empty. Only makes sense for |global-local|
294 options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 {not in Vi}
296
297 *:setg* *:setglobal*
298:setg[lobal] ... Like ":set" but set only the global value for a local
299 option without changing the local value.
300 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200301 With the "all" argument: display global values for all
302 local options.
303 Without argument: display global values for all local
304 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000305 {not in Vi}
306
307For buffer-local and window-local options:
308 Command global value local value ~
309 :set option=value set set
310 :setlocal option=value - set
311:setglobal option=value set -
312 :set option? - display
313 :setlocal option? - display
314:setglobal option? display -
315
316
317Global options with a local value *global-local*
318
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000319Options are global when you mostly use one value for all buffers and windows.
320For some global options it's useful to sometimes have a different local value.
321You can set the local value with ":setlocal". That buffer or window will then
322use the local value, while other buffers and windows continue using the global
323value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324
325For example, you have two windows, both on C source code. They use the global
326'makeprg' option. If you do this in one of the two windows: >
327 :set makeprg=gmake
328then the other window will switch to the same value. There is no need to set
329the 'makeprg' option in the other C source window too.
330However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000331another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000332files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333 :setlocal makeprg=perlmake
334You can switch back to using the global value by making the local value empty: >
335 :setlocal makeprg=
336This only works for a string option. For a boolean option you need to use the
337"<" flag, like this: >
338 :setlocal autoread<
339Note that for non-boolean options using "<" copies the global value to the
340local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000341when the global value changes later). You can also use: >
342 :set path<
343This will make the local value of 'path' empty, so that the global value is
344used. Thus it does the same as: >
345 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346Note: In the future more global options can be made global-local. Using
347":setlocal" on a global option might work differently then.
348
349
350Setting the filetype
351
352:setf[iletype] {filetype} *:setf* *:setfiletype*
353 Set the 'filetype' option to {filetype}, but only if
354 not done yet in a sequence of (nested) autocommands.
355 This is short for: >
356 :if !did_filetype()
357 : setlocal filetype={filetype}
358 :endif
359< This command is used in a filetype.vim file to avoid
360 setting the 'filetype' option twice, causing different
361 settings and syntax files to be loaded.
362 {not in Vi}
363
364:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
365:opt[ions] Open a window for viewing and setting all options.
366 Options are grouped by function.
367 Offers short help for each option. Hit <CR> on the
368 short help to open a help window with more help for
369 the option.
370 Modify the value of the option and hit <CR> on the
371 "set" line to set the new value. For window and
372 buffer specific options, the last accessed window is
373 used to set the option value in, unless this is a help
374 window, in which case the window below help window is
375 used (skipping the option-window).
376 {not available when compiled without the |+eval| or
377 |+autocmd| features}
378
379 *$HOME*
380Using "~" is like using "$HOME", but it is only recognized at the start of an
381option and after a space or comma.
382
383On Unix systems "~user" can be used too. It is replaced by the home directory
384of user "user". Example: >
385 :set path=~mool/include,/usr/include,.
386
387On Unix systems the form "${HOME}" can be used too. The name between {} can
388contain non-id characters then. Note that if you want to use this for the
389"gf" command, you need to add the '{' and '}' characters to 'isfname'.
390
391NOTE: expanding environment variables and "~/" is only done with the ":set"
392command, not when assigning a value to an option with ":let".
393
394
395Note the maximum length of an expanded option is limited. How much depends on
396the system, mostly it is something like 256 or 1024 characters.
397
398 *:fix* *:fixdel*
399:fix[del] Set the value of 't_kD':
400 't_kb' is 't_kD' becomes ~
401 CTRL-? CTRL-H
402 not CTRL-? CTRL-?
403
404 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
405
406 If your delete key terminal code is wrong, but the
407 code for backspace is alright, you can put this in
408 your .vimrc: >
409 :fixdel
410< This works no matter what the actual code for
411 backspace is.
412
413 If the backspace key terminal code is wrong you can
414 use this: >
415 :if &term == "termname"
416 : set t_kb=^V<BS>
417 : fixdel
418 :endif
419< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000420 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421 with your terminal name.
422
423 If your <Delete> key sends a strange key sequence (not
424 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
425 :if &term == "termname"
426 : set t_kD=^V<Delete>
427 :endif
428< Where "^V" is CTRL-V and "<Delete>" is the delete key
429 (don't type eight characters!). Replace "termname"
430 with your terminal name.
431
432 *Linux-backspace*
433 Note about Linux: By default the backspace key
434 produces CTRL-?, which is wrong. You can fix it by
435 putting this line in your rc.local: >
436 echo "keycode 14 = BackSpace" | loadkeys
437<
438 *NetBSD-backspace*
439 Note about NetBSD: If your backspace doesn't produce
440 the right code, try this: >
441 xmodmap -e "keycode 22 = BackSpace"
442< If this works, add this in your .Xmodmap file: >
443 keysym 22 = BackSpace
444< You need to restart for this to take effect.
445
446==============================================================================
4472. Automatically setting options *auto-setting*
448
449Besides changing options with the ":set" command, there are three alternatives
450to set options automatically for one or more files:
451
4521. When starting Vim initializations are read from various places. See
453 |initialization|. Most of them are performed for all editing sessions,
454 and some of them depend on the directory where Vim is started.
455 You can create an initialization file with |:mkvimrc|, |:mkview| and
456 |:mksession|.
4572. If you start editing a new file, the automatic commands are executed.
458 This can be used to set options for files matching a particular pattern and
459 many other things. See |autocommand|.
4603. If you start editing a new file, and the 'modeline' option is on, a
461 number of lines at the beginning and end of the file are checked for
462 modelines. This is explained here.
463
464 *modeline* *vim:* *vi:* *ex:* *E520*
465There are two forms of modelines. The first form:
466 [text]{white}{vi:|vim:|ex:}[white]{options}
467
468[text] any text or empty
469{white} at least one blank character (<Space> or <Tab>)
470{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
471[white] optional white space
472{options} a list of option settings, separated with white space or ':',
473 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000474 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000476Example:
477 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478
479The second form (this is compatible with some versions of Vi):
480
481 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
482
483[text] any text or empty
484{white} at least one blank character (<Space> or <Tab>)
485{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
486[white] optional white space
487se[t] the string "set " or "se " (note the space)
488{options} a list of options, separated with white space, which is the
489 argument for a ":set" command
490: a colon
491[text] any text or empty
492
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000493Example:
494 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495
496The white space before {vi:|vim:|ex:} is required. This minimizes the chance
497that a normal word like "lex:" is caught. There is one exception: "vi:" and
498"vim:" can also be at the start of the line (for compatibility with version
4993.0). Using "ex:" at the start of the line will be ignored (this could be
500short for "example:").
501
502 *modeline-local*
503The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000504buffer and window that contain the file. Although it's possible to set global
505options from a modeline, this is unusual. If you have two windows open and
506the files in it set the same global option to a different value, the result
507depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000509When editing a file that was already loaded, only the window-local options
510from the modeline are used. Thus if you manually changed a buffer-local
511option after opening the file, it won't be changed if you edit the same buffer
512in another window. But window-local options will be set.
513
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514 *modeline-version*
515If the modeline is only to be used for some versions of Vim, the version
516number can be specified where "vim:" is used:
517 vim{vers}: version {vers} or later
518 vim<{vers}: version before {vers}
519 vim={vers}: version {vers}
520 vim>{vers}: version after {vers}
521{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000522For example, to use a modeline only for Vim 6.0 and later:
523 /* vim600: set foldmethod=marker: */ ~
524To use a modeline for Vim before version 5.7:
525 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526There can be no blanks between "vim" and the ":".
527
528
529The number of lines that are checked can be set with the 'modelines' option.
530If 'modeline' is off or 'modelines' is 0 no lines are checked.
531
532Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000533like:
534 /* vi:ts=4: */ ~
535will give an error message for the trailing "*/". This line is OK:
536 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538If an error is detected the rest of the line is skipped.
539
540If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000541backslash in front of the ':' will be removed. Example:
542 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543This sets the 'dir' option to "c:\tmp". Only a single backslash before the
544':' is removed. Thus to include "\:" you have to specify "\\:".
545
546No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000547might create a Trojan horse text file with modelines). And not all options
548can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000549|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000550causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
551are wrapped unexpectedly. So disable modelines before editing untrusted text.
552The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553
554Hint: If you would like to do something else than setting an option, you could
555define an autocommand that checks the file for a specific string. For
556example: >
557 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
558And define a function SetVar() that does something with the line containing
559"VAR".
560
561==============================================================================
5623. Options summary *option-summary*
563
564In the list below all the options are mentioned with their full name and with
565an abbreviation if there is one. Both forms may be used.
566
567In this document when a boolean option is "set" that means that ":set option"
568is entered. When an option is "reset", ":set nooption" is used.
569
570For some options there are two default values: The "Vim default", which is
571used when 'compatible' is not set, and the "Vi default", which is used when
572'compatible' is set.
573
574Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000575are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576different value in each window. For example the 'list' option can be set in
577one window and reset in another for the same text, giving both types of view
578at the same time. There are a few options that are specific to a certain
579file. These can have a different value for each file or buffer. For example
580the 'textwidth' option can be 78 for a normal text file and 0 for a C
581program.
582
583 global one option for all buffers and windows
584 local to window each window has its own copy of this option
585 local to buffer each buffer has its own copy of this option
586
587When creating a new window the option values from the currently active window
588are used as a default value for the window-specific options. For the
589buffer-specific options this depends on the 's' and 'S' flags in the
590'cpoptions' option. If 's' is included (which is the default) the values for
591buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000592first entered. If 'S' is present the options are copied each time the buffer
593is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594present, the options are copied from the currently active buffer when the
595buffer is created.
596
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000597Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000599Not all options are supported in all versions. This depends on the supported
600features and sometimes on the system. A remark about this is in curly braces
601below. When an option is not supported it may still be set without getting an
602error, this is called a hidden option. You can't get the value of a hidden
603option though, it is not stored.
604
605To test if option "foo" can be used with ":set" use something like this: >
606 if exists('&foo')
607This also returns true for a hidden option. To test if option "foo" is really
608supported use something like this: >
609 if exists('+foo')
610<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 *E355*
612A jump table for the options with a short description can be found at |Q_op|.
613
614 *'aleph'* *'al'* *aleph* *Aleph*
615'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
616 global
617 {not in Vi}
618 {only available when compiled with the |+rightleft|
619 feature}
620 The ASCII code for the first letter of the Hebrew alphabet. The
621 routine that maps the keyboard in Hebrew mode, both in Insert mode
622 (when hkmap is set) and on the command-line (when hitting CTRL-_)
623 outputs the Hebrew characters in the range [aleph..aleph+26].
624 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
625 See |rileft.txt|.
626
627 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
628'allowrevins' 'ari' boolean (default off)
629 global
630 {not in Vi}
631 {only available when compiled with the |+rightleft|
632 feature}
633 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
634 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
635 into reverse Insert mode, and don't know how to get out. See
636 'revins'.
637 NOTE: This option is reset when 'compatible' is set.
638
639 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
640'altkeymap' 'akm' boolean (default off)
641 global
642 {not in Vi}
643 {only available when compiled with the |+farsi|
644 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000645 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 the keyboard map between Farsi and English, when 'allowrevins' set.
647
Bram Moolenaar582fd852005-03-28 20:58:01 +0000648 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 is useful to start the Vim in native mode i.e. English (left-to-right
650 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000651 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
653 *'ambiwidth'* *'ambw'*
654'ambiwidth' 'ambw' string (default: "single")
655 global
656 {not in Vi}
657 {only available when compiled with the |+multi_byte|
658 feature}
659 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
660 Tells Vim what to do with characters with East Asian Width Class
661 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
662 letters, Cyrillic letters).
663
664 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000665 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 expected by most users.
667 "double": Use twice the width of ASCII characters.
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
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001722 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001723
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001724 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001725 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001726 are moving around text is concealed, but when starting to insert text
1727 or selecting a Visual area the concealed text is displayed, so that
1728 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001729 Keep in mind that the cursor position is not always where it's
1730 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001731
1732
1733'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001734 number (default 0)
1735 local to window
1736 {not in Vi}
1737 {not available when compiled without the |+conceal|
1738 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001739 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1740 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001741
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001742 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001743 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001744 1 Each block of concealed text is replaced with one
1745 character. If the syntax item does not have a custom
1746 replacement character defined (see |:syn-cchar|) the
1747 character defined in 'listchars' is used (default is a
1748 space).
1749 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001750 2 Concealed text is completely hidden unless it has a
1751 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001752 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001753 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001754
Bram Moolenaara7781e02010-07-19 20:13:22 +02001755 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001756 edit and copy the text. This can be changed with the 'concealcursor'
1757 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001758
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1760'confirm' 'cf' boolean (default off)
1761 global
1762 {not in Vi}
1763 When 'confirm' is on, certain operations that would normally
1764 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1765 instead raise a |dialog| asking if you wish to save the current
1766 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1767 If 'confirm' is off you can still activate confirmation for one
1768 command only (this is most useful in mappings) with the |:confirm|
1769 command.
1770 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1771
1772 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1773'conskey' 'consk' boolean (default off)
1774 global
1775 {not in Vi} {only for MS-DOS}
1776 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001777 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778 three methods of console input are available:
1779 'conskey' 'bioskey' action ~
1780 on on or off direct console input
1781 off on BIOS
1782 off off STDIN
1783
1784 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1785'copyindent' 'ci' boolean (default off)
1786 local to buffer
1787 {not in Vi}
1788 Copy the structure of the existing lines indent when autoindenting a
1789 new line. Normally the new indent is reconstructed by a series of
1790 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1791 in which case only spaces are used). Enabling this option makes the
1792 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001793 existing line. 'expandtab' has no effect on these characters, a Tab
1794 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795 line, the remaining space is filled in the normal manner.
1796 NOTE: 'copyindent' is reset when 'compatible' is set.
1797 Also see 'preserveindent'.
1798
1799 *'cpoptions'* *'cpo'*
1800'cpoptions' 'cpo' string (Vim default: "aABceFs",
1801 Vi default: all flags)
1802 global
1803 {not in Vi}
1804 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001805 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806 not being vi-compatible is mostly or sometimes preferred.
1807 'cpoptions' stands for "compatible-options".
1808 Commas can be added for readability.
1809 To avoid problems with flags that are added in the future, use the
1810 "+=" and "-=" feature of ":set" |add-option-flags|.
1811 NOTE: This option is set to the Vi default value when 'compatible' is
1812 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001813 NOTE: This option is set to the POSIX default value at startup when
1814 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001815 variable exists |posix|. This means Vim tries to behave like the
1816 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817
1818 contains behavior ~
1819 *cpo-a*
1820 a When included, a ":read" command with a file name
1821 argument will set the alternate file name for the
1822 current window.
1823 *cpo-A*
1824 A When included, a ":write" command with a file name
1825 argument will set the alternate file name for the
1826 current window.
1827 *cpo-b*
1828 b "\|" in a ":map" command is recognized as the end of
1829 the map command. The '\' is included in the mapping,
1830 the text after the '|' is interpreted as the next
1831 command. Use a CTRL-V instead of a backslash to
1832 include the '|' in the mapping. Applies to all
1833 mapping, abbreviation, menu and autocmd commands.
1834 See also |map_bar|.
1835 *cpo-B*
1836 B A backslash has no special meaning in mappings,
1837 abbreviations and the "to" part of the menu commands.
1838 Remove this flag to be able to use a backslash like a
1839 CTRL-V. For example, the command ":map X \<Esc>"
1840 results in X being mapped to:
1841 'B' included: "\^[" (^[ is a real <Esc>)
1842 'B' excluded: "<Esc>" (5 characters)
1843 ('<' excluded in both cases)
1844 *cpo-c*
1845 c Searching continues at the end of any match at the
1846 cursor position, but not further than the start of the
1847 next line. When not present searching continues
1848 one character from the cursor position. With 'c'
1849 "abababababab" only gets three matches when repeating
1850 "/abab", without 'c' there are five matches.
1851 *cpo-C*
1852 C Do not concatenate sourced lines that start with a
1853 backslash. See |line-continuation|.
1854 *cpo-d*
1855 d Using "./" in the 'tags' option doesn't mean to use
1856 the tags file relative to the current file, but the
1857 tags file in the current directory.
1858 *cpo-D*
1859 D Can't use CTRL-K to enter a digraph after Normal mode
1860 commands with a character argument, like |r|, |f| and
1861 |t|.
1862 *cpo-e*
1863 e When executing a register with ":@r", always add a
1864 <CR> to the last line, also when the register is not
1865 linewise. If this flag is not present, the register
1866 is not linewise and the last line does not end in a
1867 <CR>, then the last line is put on the command-line
1868 and can be edited before hitting <CR>.
1869 *cpo-E*
1870 E It is an error when using "y", "d", "c", "g~", "gu" or
1871 "gU" on an Empty region. The operators only work when
1872 at least one character is to be operate on. Example:
1873 This makes "y0" fail in the first column.
1874 *cpo-f*
1875 f When included, a ":read" command with a file name
1876 argument will set the file name for the current buffer,
1877 if the current buffer doesn't have a file name yet.
1878 *cpo-F*
1879 F When included, a ":write" command with a file name
1880 argument will set the file name for the current
1881 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001882 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883 *cpo-g*
1884 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001885 *cpo-H*
1886 H When using "I" on a line with only blanks, insert
1887 before the last blank. Without this flag insert after
1888 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889 *cpo-i*
1890 i When included, interrupting the reading of a file will
1891 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001892 *cpo-I*
1893 I When moving the cursor up or down just after inserting
1894 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001895 *cpo-j*
1896 j When joining lines, only add two spaces after a '.',
1897 not after '!' or '?'. Also see 'joinspaces'.
1898 *cpo-J*
1899 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001900 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901 white space.
1902 *cpo-k*
1903 k Disable the recognition of raw key codes in
1904 mappings, abbreviations, and the "to" part of menu
1905 commands. For example, if <Key> sends ^[OA (where ^[
1906 is <Esc>), the command ":map X ^[OA" results in X
1907 being mapped to:
1908 'k' included: "^[OA" (3 characters)
1909 'k' excluded: "<Key>" (one key code)
1910 Also see the '<' flag below.
1911 *cpo-K*
1912 K Don't wait for a key code to complete when it is
1913 halfway a mapping. This breaks mapping <F1><F1> when
1914 only part of the second <F1> has been read. It
1915 enables cancelling the mapping by typing <F1><Esc>.
1916 *cpo-l*
1917 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001918 literally, only "\]", "\^", "\-" and "\\" are special.
1919 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1921 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001922 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923 *cpo-L*
1924 L When the 'list' option is set, 'wrapmargin',
1925 'textwidth', 'softtabstop' and Virtual Replace mode
1926 (see |gR|) count a <Tab> as two characters, instead of
1927 the normal behavior of a <Tab>.
1928 *cpo-m*
1929 m When included, a showmatch will always wait half a
1930 second. When not included, a showmatch will wait half
1931 a second or until a character is typed. |'showmatch'|
1932 *cpo-M*
1933 M When excluded, "%" matching will take backslashes into
1934 account. Thus in "( \( )" and "\( ( \)" the outer
1935 parenthesis match. When included "%" ignores
1936 backslashes, which is Vi compatible.
1937 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001938 n When included, the column used for 'number' and
1939 'relativenumber' will also be used for text of wrapped
1940 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001941 *cpo-o*
1942 o Line offset to search command is not remembered for
1943 next search.
1944 *cpo-O*
1945 O Don't complain if a file is being overwritten, even
1946 when it didn't exist when editing it. This is a
1947 protection against a file unexpectedly created by
1948 someone else. Vi didn't complain about this.
1949 *cpo-p*
1950 p Vi compatible Lisp indenting. When not present, a
1951 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001952 *cpo-P*
1953 P When included, a ":write" command that appends to a
1954 file will set the file name for the current buffer, if
1955 the current buffer doesn't have a file name yet and
1956 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001957 *cpo-q*
1958 q When joining multiple lines leave the cursor at the
1959 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001960 *cpo-r*
1961 r Redo ("." command) uses "/" to repeat a search
1962 command, instead of the actually used search string.
1963 *cpo-R*
1964 R Remove marks from filtered lines. Without this flag
1965 marks are kept like |:keepmarks| was used.
1966 *cpo-s*
1967 s Set buffer options when entering the buffer for the
1968 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001969 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001970 set when the buffer is created.
1971 *cpo-S*
1972 S Set buffer options always when entering a buffer
1973 (except 'readonly', 'fileformat', 'filetype' and
1974 'syntax'). This is the (most) Vi compatible setting.
1975 The options are set to the values in the current
1976 buffer. When you change an option and go to another
1977 buffer, the value is copied. Effectively makes the
1978 buffer options global to all buffers.
1979
1980 's' 'S' copy buffer options
1981 no no when buffer created
1982 yes no when buffer first entered (default)
1983 X yes each time when buffer entered (vi comp.)
1984 *cpo-t*
1985 t Search pattern for the tag command is remembered for
1986 "n" command. Otherwise Vim only puts the pattern in
1987 the history for search pattern, but doesn't change the
1988 last used search pattern.
1989 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001990 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001991 *cpo-v*
1992 v Backspaced characters remain visible on the screen in
1993 Insert mode. Without this flag the characters are
1994 erased from the screen right away. With this flag the
1995 screen newly typed text overwrites backspaced
1996 characters.
1997 *cpo-w*
1998 w When using "cw" on a blank character, only change one
1999 character and not all blanks until the start of the
2000 next word.
2001 *cpo-W*
2002 W Don't overwrite a readonly file. When omitted, ":w!"
2003 overwrites a readonly file, if possible.
2004 *cpo-x*
2005 x <Esc> on the command-line executes the command-line.
2006 The default in Vim is to abandon the command-line,
2007 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002008 *cpo-X*
2009 X When using a count with "R" the replaced text is
2010 deleted only once. Also when repeating "R" with "."
2011 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 *cpo-y*
2013 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002014 *cpo-Z*
2015 Z When using "w!" while the 'readonly' option is set,
2016 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017 *cpo-!*
2018 ! When redoing a filter command, use the last used
2019 external command, whatever it was. Otherwise the last
2020 used -filter- command is used.
2021 *cpo-$*
2022 $ When making a change to one line, don't redisplay the
2023 line, but put a '$' at the end of the changed text.
2024 The changed text will be overwritten when you type the
2025 new text. The line is redisplayed if you type any
2026 command that moves the cursor from the insertion
2027 point.
2028 *cpo-%*
2029 % Vi-compatible matching is done for the "%" command.
2030 Does not recognize "#if", "#endif", etc.
2031 Does not recognize "/*" and "*/".
2032 Parens inside single and double quotes are also
2033 counted, causing a string that contains a paren to
2034 disturb the matching. For example, in a line like
2035 "if (strcmp("foo(", s))" the first paren does not
2036 match the last one. When this flag is not included,
2037 parens inside single and double quotes are treated
2038 specially. When matching a paren outside of quotes,
2039 everything inside quotes is ignored. When matching a
2040 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002041 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002042 This flag is also used for other features, such as
2043 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002044 *cpo--*
2045 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002046 it would go above the first line or below the last
2047 line. Without it the cursor moves to the first or
2048 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002049 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002050 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002051 *cpo-+*
2052 + When included, a ":write file" command will reset the
2053 'modified' flag of the buffer, even though the buffer
2054 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002055 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 * Use ":*" in the same way as ":@". When not included,
2057 ":*" is an alias for ":'<,'>", select the Visual area.
2058 *cpo-<*
2059 < Disable the recognition of special key codes in |<>|
2060 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002061 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 ":map X <Tab>" results in X being mapped to:
2063 '<' included: "<Tab>" (5 characters)
2064 '<' excluded: "^I" (^I is a real <Tab>)
2065 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002066 *cpo->*
2067 > When appending to a register, put a line break before
2068 the appended text.
2069
2070 POSIX flags. These are not included in the Vi default value, except
2071 when $VIM_POSIX was set on startup. |posix|
2072
2073 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002074 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002075 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002076 *cpo-&*
2077 & When ":preserve" was used keep the swap file when
2078 exiting normally while this buffer is still loaded.
2079 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002080 *cpo-\*
2081 \ Backslash in a [] range in a search pattern is taken
2082 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002083 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2084 '\' excluded: "/[ \-]" finds <Space> and '-'
2085 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002086 *cpo-/*
2087 / When "%" is used as the replacement string in a |:s|
2088 command, use the previous replacement string. |:s%|
2089 *cpo-{*
2090 { The |{| and |}| commands also stop at a "{" character
2091 at the start of a line.
2092 *cpo-.*
2093 . The ":chdir" and ":cd" commands fail if the current
2094 buffer is modified, unless ! is used. Vim doesn't
2095 need this, since it remembers the full path of an
2096 opened file.
2097 *cpo-bar*
2098 | The value of the $LINES and $COLUMNS environment
2099 variables overrule the terminal size values obtained
2100 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002101
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002103 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002104'cryptmethod' string (default "zip")
2105 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002106 {not in Vi}
2107 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002108 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002109 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002110 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002111 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002112 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002113 or later, files can NOT be read by Vim 7.2 and older.
2114 This adds a "seed" to the file, every time you write
2115 the file the encrypted bytes will be different.
2116
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002117 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002118 to the detected method of the file being read. Thus if you write it
2119 without changing 'cryptmethod' the same method will be used.
2120 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002121 explicitly write it, you don't get a warning unless there are other
2122 modifications. Also see |:X|.
2123
2124 When setting the global value to an empty string, it will end up with
2125 the value "zip". When setting the local value to an empty string the
2126 buffer will use the global value.
2127
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002128 When a new encryption method is added in a later version of Vim, and
2129 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002130 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002131
2132
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 *'cscopepathcomp'* *'cspc'*
2134'cscopepathcomp' 'cspc' number (default 0)
2135 global
2136 {not available when compiled without the |+cscope|
2137 feature}
2138 {not in Vi}
2139 Determines how many components of the path to show in a list of tags.
2140 See |cscopepathcomp|.
2141
2142 *'cscopeprg'* *'csprg'*
2143'cscopeprg' 'csprg' string (default "cscope")
2144 global
2145 {not available when compiled without the |+cscope|
2146 feature}
2147 {not in Vi}
2148 Specifies the command to execute cscope. See |cscopeprg|.
2149 This option cannot be set from a |modeline| or in the |sandbox|, for
2150 security reasons.
2151
2152 *'cscopequickfix'* *'csqf'*
2153'cscopequickfix' 'csqf' string (default "")
2154 global
2155 {not available when compiled without the |+cscope|
2156 or |+quickfix| features}
2157 {not in Vi}
2158 Specifies whether to use quickfix window to show cscope results.
2159 See |cscopequickfix|.
2160
2161 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2162'cscopetag' 'cst' boolean (default off)
2163 global
2164 {not available when compiled without the |+cscope|
2165 feature}
2166 {not in Vi}
2167 Use cscope for tag commands. See |cscope-options|.
2168 NOTE: This option is reset when 'compatible' is set.
2169
2170 *'cscopetagorder'* *'csto'*
2171'cscopetagorder' 'csto' number (default 0)
2172 global
2173 {not available when compiled without the |+cscope|
2174 feature}
2175 {not in Vi}
2176 Determines the order in which ":cstag" performs a search. See
2177 |cscopetagorder|.
2178 NOTE: This option is set to 0 when 'compatible' is set.
2179
2180 *'cscopeverbose'* *'csverb'*
2181 *'nocscopeverbose'* *'nocsverb'*
2182'cscopeverbose' 'csverb' boolean (default off)
2183 global
2184 {not available when compiled without the |+cscope|
2185 feature}
2186 {not in Vi}
2187 Give messages when adding a cscope database. See |cscopeverbose|.
2188 NOTE: This option is reset when 'compatible' is set.
2189
Bram Moolenaar860cae12010-06-05 23:22:07 +02002190 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2191'cursorbind' 'crb' boolean (default off)
2192 local to window
2193 {not in Vi}
2194 {not available when compiled without the |+cursorbind|
2195 feature}
2196 When this option is set, as the cursor in the current
2197 window moves other cursorbound windows (windows that also have
2198 this option set) move their cursors to the corresponding line and
2199 column. This option is useful for viewing the
2200 differences between two versions of a file (see 'diff'); in diff mode,
2201 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002202 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002203
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002204
2205 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2206'cursorcolumn' 'cuc' boolean (default off)
2207 local to window
2208 {not in Vi}
2209 {not available when compiled without the |+syntax|
2210 feature}
2211 Highlight the screen column of the cursor with CursorColumn
2212 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2213 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002214 If you only want the highlighting in the current window you can use
2215 these autocommands: >
2216 au WinLeave * set nocursorline nocursorcolumn
2217 au WinEnter * set cursorline cursorcolumn
2218<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002219
2220 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2221'cursorline' 'cul' boolean (default off)
2222 local to window
2223 {not in Vi}
2224 {not available when compiled without the |+syntax|
2225 feature}
2226 Highlight the screen line of the cursor with CursorLine
2227 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2228 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002229 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002230 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002231
2232
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233 *'debug'*
2234'debug' string (default "")
2235 global
2236 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002237 These values can be used:
2238 msg Error messages that would otherwise be omitted will be given
2239 anyway.
2240 throw Error messages that would otherwise be omitted will be given
2241 anyway and also throw an exception and set |v:errmsg|.
2242 beep A message will be given when otherwise only a beep would be
2243 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002244 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002245 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2246 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247
2248 *'define'* *'def'*
2249'define' 'def' string (default "^\s*#\s*define")
2250 global or local to buffer |global-local|
2251 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002252 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 pattern, just like for the "/" command. This option is used for the
2254 commands like "[i" and "[d" |include-search|. The 'isident' option is
2255 used to recognize the defined name after the match:
2256 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2257 See |option-backslash| about inserting backslashes to include a space
2258 or backslash.
2259 The default value is for C programs. For C++ this value would be
2260 useful, to include const type declarations: >
2261 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2262< When using the ":set" command, you need to double the backslashes!
2263
2264 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2265'delcombine' 'deco' boolean (default off)
2266 global
2267 {not in Vi}
2268 {only available when compiled with the |+multi_byte|
2269 feature}
2270 If editing Unicode and this option is set, backspace and Normal mode
2271 "x" delete each combining character on its own. When it is off (the
2272 default) the character along with its combining characters are
2273 deleted.
2274 Note: When 'delcombine' is set "xx" may work different from "2x"!
2275
2276 This is useful for Arabic, Hebrew and many other languages where one
2277 may have combining characters overtop of base characters, and want
2278 to remove only the combining ones.
2279
2280 *'dictionary'* *'dict'*
2281'dictionary' 'dict' string (default "")
2282 global or local to buffer |global-local|
2283 {not in Vi}
2284 List of file names, separated by commas, that are used to lookup words
2285 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2286 contain a list of words. This can be one word per line, or several
2287 words per line, separated by non-keyword characters (white space is
2288 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002289 When this option is empty, or an entry "spell" is present, spell
2290 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002291 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002292 after a comma are ignored, otherwise spaces are included in the file
2293 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002294 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002295 Where to find a list of words?
2296 - On FreeBSD, there is the file "/usr/share/dict/words".
2297 - In the Simtel archive, look in the "msdos/linguist" directory.
2298 - In "miscfiles" of the GNU collection.
2299 The use of |:set+=| and |:set-=| is preferred when adding or removing
2300 directories from the list. This avoids problems when a future version
2301 uses another default.
2302 Backticks cannot be used in this option for security reasons.
2303
2304 *'diff'* *'nodiff'*
2305'diff' boolean (default off)
2306 local to window
2307 {not in Vi}
2308 {not available when compiled without the |+diff|
2309 feature}
2310 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002311 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312
2313 *'dex'* *'diffexpr'*
2314'diffexpr' 'dex' string (default "")
2315 global
2316 {not in Vi}
2317 {not available when compiled without the |+diff|
2318 feature}
2319 Expression which is evaluated to obtain an ed-style diff file from two
2320 versions of a file. See |diff-diffexpr|.
2321 This option cannot be set from a |modeline| or in the |sandbox|, for
2322 security reasons.
2323
2324 *'dip'* *'diffopt'*
2325'diffopt' 'dip' string (default "filler")
2326 global
2327 {not in Vi}
2328 {not available when compiled without the |+diff|
2329 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002330 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331 All are optional. Items must be separated by a comma.
2332
2333 filler Show filler lines, to keep the text
2334 synchronized with a window that has inserted
2335 lines at the same position. Mostly useful
2336 when windows are side-by-side and 'scrollbind'
2337 is set.
2338
2339 context:{n} Use a context of {n} lines between a change
2340 and a fold that contains unchanged lines.
2341 When omitted a context of six lines is used.
2342 See |fold-diff|.
2343
2344 icase Ignore changes in case of text. "a" and "A"
2345 are considered the same. Adds the "-i" flag
2346 to the "diff" command if 'diffexpr' is empty.
2347
2348 iwhite Ignore changes in amount of white space. Adds
2349 the "-b" flag to the "diff" command if
2350 'diffexpr' is empty. Check the documentation
2351 of the "diff" command for what this does
2352 exactly. It should ignore adding trailing
2353 white space, but not leading white space.
2354
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002355 horizontal Start diff mode with horizontal splits (unless
2356 explicitly specified otherwise).
2357
2358 vertical Start diff mode with vertical splits (unless
2359 explicitly specified otherwise).
2360
2361 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2362 starting diff mode. Without this 2 is used.
2363
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364 Examples: >
2365
2366 :set diffopt=filler,context:4
2367 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002368 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369<
2370 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2371'digraph' 'dg' boolean (default off)
2372 global
2373 {not in Vi}
2374 {not available when compiled without the |+digraphs|
2375 feature}
2376 Enable the entering of digraphs in Insert mode with {char1} <BS>
2377 {char2}. See |digraphs|.
2378 NOTE: This option is reset when 'compatible' is set.
2379
2380 *'directory'* *'dir'*
2381'directory' 'dir' string (default for Amiga: ".,t:",
2382 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2383 for Unix: ".,~/tmp,/var/tmp,/tmp")
2384 global
2385 List of directory names for the swap file, separated with commas.
2386 - The swap file will be created in the first directory where this is
2387 possible.
2388 - Empty means that no swap file will be used (recovery is
2389 impossible!).
2390 - A directory "." means to put the swap file in the same directory as
2391 the edited file. On Unix, a dot is prepended to the file name, so
2392 it doesn't show in a directory listing. On MS-Windows the "hidden"
2393 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002394 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002395 put the swap file relative to where the edited file is. The leading
2396 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002397 - For Unix and Win32, if a directory ends in two path separators "//"
2398 or "\\", the swap file name will be built from the complete path to
2399 the file with all path separators substituted to percent '%' signs.
2400 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002401 On Win32, when a separating comma is following, you must use "//",
2402 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403 - Spaces after the comma are ignored, other spaces are considered part
2404 of the directory name. To have a space at the start of a directory
2405 name, precede it with a backslash.
2406 - To include a comma in a directory name precede it with a backslash.
2407 - A directory name may end in an ':' or '/'.
2408 - Environment variables are expanded |:set_env|.
2409 - Careful with '\' characters, type one before a space, type two to
2410 get one in the option (see |option-backslash|), for example: >
2411 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2412< - For backwards compatibility with Vim version 3.0 a '>' at the start
2413 of the option is removed.
2414 Using "." first in the list is recommended. This means that editing
2415 the same file twice will result in a warning. Using "/tmp" on Unix is
2416 discouraged: When the system crashes you lose the swap file.
2417 "/var/tmp" is often not cleared when rebooting, thus is a better
2418 choice than "/tmp". But it can contain a lot of files, your swap
2419 files get lost in the crowd. That is why a "tmp" directory in your
2420 home directory is tried first.
2421 The use of |:set+=| and |:set-=| is preferred when adding or removing
2422 directories from the list. This avoids problems when a future version
2423 uses another default.
2424 This option cannot be set from a |modeline| or in the |sandbox|, for
2425 security reasons.
2426 {Vi: directory to put temp file in, defaults to "/tmp"}
2427
2428 *'display'* *'dy'*
2429'display' 'dy' string (default "")
2430 global
2431 {not in Vi}
2432 Change the way text is displayed. This is comma separated list of
2433 flags:
2434 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002435 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002436 last line that doesn't fit is replaced with "@" lines.
2437 uhex Show unprintable characters hexadecimal as <xx>
2438 instead of using ^C and ~C.
2439
2440 *'eadirection'* *'ead'*
2441'eadirection' 'ead' string (default "both")
2442 global
2443 {not in Vi}
2444 {not available when compiled without the +vertsplit
2445 feature}
2446 Tells when the 'equalalways' option applies:
2447 ver vertically, width of windows is not affected
2448 hor horizontally, height of windows is not affected
2449 both width and height of windows is affected
2450
2451 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2452'edcompatible' 'ed' boolean (default off)
2453 global
2454 Makes the 'g' and 'c' flags of the ":substitute" command to be
2455 toggled each time the flag is given. See |complex-change|. See
2456 also 'gdefault' option.
2457 Switching this option on is discouraged!
2458
2459 *'encoding'* *'enc'* *E543*
2460'encoding' 'enc' string (default: "latin1" or value from $LANG)
2461 global
2462 {only available when compiled with the |+multi_byte|
2463 feature}
2464 {not in Vi}
2465 Sets the character encoding used inside Vim. It applies to text in
2466 the buffers, registers, Strings in expressions, text stored in the
2467 viminfo file, etc. It sets the kind of characters which Vim can work
2468 with. See |encoding-names| for the possible values.
2469
2470 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002471 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002473 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474
Bram Moolenaar865242e2010-07-14 21:12:05 +02002475 This option cannot be set from a |modeline|. It would most likely
2476 corrupt the text.
2477
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2479 "utf-8". Although care has been taken to allow different values of
2480 'encoding', "utf-8" is the natural choice for the environment and
2481 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002482 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483 versions, and to avoid changing the encoding of newly created files
2484 without your knowledge (in case 'fileencodings' is empty).
2485
2486 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002487 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488 iconv() or as specified with 'charconvert'.
2489
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002490 If you need to know whether 'encoding' is a multi-byte encoding, you
2491 can use: >
2492 if has("multi_byte_encoding")
2493<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002494 Normally 'encoding' will be equal to your current locale. This will
2495 be the default if Vim recognizes your environment settings. If
2496 'encoding' is not set to the current locale, 'termencoding' must be
2497 set to convert typed and displayed text. See |encoding-table|.
2498
2499 When you set this option, it fires the |EncodingChanged| autocommand
2500 event so that you can set up fonts if necessary.
2501
2502 When the option is set, the value is converted to lowercase. Thus
2503 you can set it with uppercase values too. Underscores are translated
2504 to '-' signs.
2505 When the encoding is recognized, it is changed to the standard name.
2506 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2507 "iso-8859-2" and "utf8" becomes "utf-8".
2508
2509 Note: "latin1" is also used when the encoding could not be detected.
2510 This only works when editing files in the same encoding! When the
2511 actual character set is not latin1, make sure 'fileencoding' and
2512 'fileencodings' are empty. When conversion is needed, switch to using
2513 utf-8.
2514
2515 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2516 You don't notice this while editing, but it does matter for the
2517 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2518 setting 'encoding' to one of these values instead of utf-8 only has
2519 effect for encoding used for files when 'fileencoding' is empty.
2520
Bram Moolenaar661b1822005-07-28 22:36:45 +00002521 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2522 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523
2524 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2525'endofline' 'eol' boolean (default on)
2526 local to buffer
2527 {not in Vi}
2528 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002529 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530 option is automatically set when starting to edit a new file, unless
2531 the file does not have an <EOL> for the last line in the file, in
2532 which case it is reset. Normally you don't have to set or reset this
2533 option. When 'binary' is off the value is not used when writing the
2534 file. When 'binary' is on it is used to remember the presence of a
2535 <EOL> for the last line in the file, so that when you write the file
2536 the situation from the original file can be kept. But you can change
2537 it if you want to.
2538
2539 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2540'equalalways' 'ea' boolean (default on)
2541 global
2542 {not in Vi}
2543 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002544 splitting or closing a window. This also happens the moment the
2545 option is switched on. When off, splitting a window will reduce the
2546 size of the current window and leave the other windows the same. When
2547 closing a window the extra lines are given to the window next to it
2548 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 When mixing vertically and horizontally split windows, a minimal size
2550 is computed and some windows may be larger if there is room. The
2551 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002552 Changing the height and width of a window can be avoided by setting
2553 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002554 If a window size is specified when creating a new window sizes are
2555 currently not equalized (it's complicated, but may be implemented in
2556 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557
2558 *'equalprg'* *'ep'*
2559'equalprg' 'ep' string (default "")
2560 global or local to buffer |global-local|
2561 {not in Vi}
2562 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002563 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002564 or 'indentexpr'. When Vim was compiled without internal formatting,
2565 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002566 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567 about including spaces and backslashes.
2568 This option cannot be set from a |modeline| or in the |sandbox|, for
2569 security reasons.
2570
2571 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2572'errorbells' 'eb' boolean (default off)
2573 global
2574 Ring the bell (beep or screen flash) for error messages. This only
2575 makes a difference for error messages, the bell will be used always
2576 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002577 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 screen flash or do nothing.
2579
2580 *'errorfile'* *'ef'*
2581'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2582 others: "errors.err")
2583 global
2584 {not in Vi}
2585 {not available when compiled without the |+quickfix|
2586 feature}
2587 Name of the errorfile for the QuickFix mode (see |:cf|).
2588 When the "-q" command-line argument is used, 'errorfile' is set to the
2589 following argument. See |-q|.
2590 NOT used for the ":make" command. See 'makeef' for that.
2591 Environment variables are expanded |:set_env|.
2592 See |option-backslash| about including spaces and backslashes.
2593 This option cannot be set from a |modeline| or in the |sandbox|, for
2594 security reasons.
2595
2596 *'errorformat'* *'efm'*
2597'errorformat' 'efm' string (default is very long)
2598 global or local to buffer |global-local|
2599 {not in Vi}
2600 {not available when compiled without the |+quickfix|
2601 feature}
2602 Scanf-like description of the format for the lines in the error file
2603 (see |errorformat|).
2604
2605 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2606'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2607 global
2608 {not in Vi}
2609 Function keys that start with an <Esc> are recognized in Insert
2610 mode. When this option is off, the cursor and function keys cannot be
2611 used in Insert mode if they start with an <Esc>. The advantage of
2612 this is that the single <Esc> is recognized immediately, instead of
2613 after one second. Instead of resetting this option, you might want to
2614 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2615 when 'esckeys' is off, you can still map anything, but the cursor keys
2616 won't work by default.
2617 NOTE: This option is set to the Vi default value when 'compatible' is
2618 set and to the Vim default value when 'compatible' is reset.
2619
2620 *'eventignore'* *'ei'*
2621'eventignore' 'ei' string (default "")
2622 global
2623 {not in Vi}
2624 {not available when compiled without the |+autocmd|
2625 feature}
2626 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002627 When set to "all" or when "all" is one of the items, all autocommand
2628 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629 Otherwise this is a comma separated list of event names. Example: >
2630 :set ei=WinEnter,WinLeave
2631<
2632 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2633'expandtab' 'et' boolean (default off)
2634 local to buffer
2635 {not in Vi}
2636 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002637 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2639 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2640 NOTE: This option is reset when 'compatible' is set.
2641
2642 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2643'exrc' 'ex' boolean (default off)
2644 global
2645 {not in Vi}
2646 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2647 directory. If you switch this option on you should also consider
2648 setting the 'secure' option (see |initialization|). Using a local
2649 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2650 also see |.vimrc| and |gui-init|.
2651 This option cannot be set from a |modeline| or in the |sandbox|, for
2652 security reasons.
2653
2654 *'fileencoding'* *'fenc'* *E213*
2655'fileencoding' 'fenc' string (default: "")
2656 local to buffer
2657 {only available when compiled with the |+multi_byte|
2658 feature}
2659 {not in Vi}
2660 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002661
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002663 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 When 'fileencoding' is empty, the same value as 'encoding' will be
2665 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002666 Conversion will also be done when 'encoding' and 'fileencoding' are
2667 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2668 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002669 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002670 'encoding' is "utf-8" or another Unicode encoding, conversion
2671 is most likely done in a way that the reverse conversion
2672 results in the same text. When 'encoding' is not "utf-8" some
2673 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002674
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 See 'encoding' for the possible values. Additionally, values may be
2676 specified that can be handled by the converter, see
2677 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002678
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679 When reading a file 'fileencoding' will be set from 'fileencodings'.
2680 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002681 'fileencoding', use the |++enc| argument. One exception: when
2682 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002683 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002684
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2686 When the option is set, the value is converted to lowercase. Thus
2687 you can set it with uppercase values too. '_' characters are
2688 replaced with '-'. If a name is recognized from the list for
2689 'encoding', it is replaced by the standard name. For example
2690 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002691
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692 When this option is set, after starting to edit a file, the 'modified'
2693 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002694
2695 Keep in mind that changing 'fenc' from a modeline happens
2696 AFTER the text has been read, thus it applies to when the file will be
2697 written. If you do set 'fenc' in a modeline, you might want to set
2698 'nomodified' to avoid not being able to ":q".
2699
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 This option can not be changed when 'modifiable' is off.
2701
2702 *'fe'*
2703 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002704 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 old short name was 'fe', which is no longer used.
2706
2707 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002708'fileencodings' 'fencs' string (default: "ucs-bom",
2709 "ucs-bom,utf-8,default,latin1" when
2710 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 global
2712 {only available when compiled with the |+multi_byte|
2713 feature}
2714 {not in Vi}
2715 This is a list of character encodings considered when starting to edit
2716 an existing file. When a file is read, Vim tries to use the first
2717 mentioned character encoding. If an error is detected, the next one
2718 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002719 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720 an empty string, which means the value of 'encoding' is used.
2721 WARNING: Conversion can cause loss of information! When
2722 'encoding' is "utf-8" (or one of the other Unicode variants)
2723 conversion is most likely done in a way that the reverse
2724 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002725 "utf-8" some non-ASCII characters may be lost! You can use
2726 the |++bad| argument to specify what is done with characters
2727 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728 For an empty file or a file with only ASCII characters most encodings
2729 will work and the first entry of 'fileencodings' will be used (except
2730 "ucs-bom", which requires the BOM to be present). If you prefer
2731 another encoding use an BufReadPost autocommand event to test if your
2732 preferred encoding is to be used. Example: >
2733 au BufReadPost * if search('\S', 'w') == 0 |
2734 \ set fenc=iso-2022-jp | endif
2735< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2736 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002737 When the |++enc| argument is used then the value of 'fileencodings' is
2738 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002739 Note that 'fileencodings' is not used for a new file, the global value
2740 of 'fileencoding' is used instead. You can set it with: >
2741 :setglobal fenc=iso-8859-2
2742< This means that a non-existing file may get a different encoding than
2743 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744 The special value "ucs-bom" can be used to check for a Unicode BOM
2745 (Byte Order Mark) at the start of the file. It must not be preceded
2746 by "utf-8" or another Unicode encoding for this to work properly.
2747 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2748 because Vim cannot detect an error, thus the encoding is always
2749 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002750 The special value "default" can be used for the encoding from the
2751 environment. This is the default value for 'encoding'. It is useful
2752 when 'encoding' is set to "utf-8" and your environment uses a
2753 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002754 When 'encoding' is "utf-8" and a file contains an illegal byte
2755 sequence it won't be recognized as UTF-8. You can use the |8g8|
2756 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 WRONG VALUES: WHAT'S WRONG:
2758 latin1,utf-8 "latin1" will always be used
2759 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2760 file
2761 cp1250,latin1 "cp1250" will always be used
2762 If 'fileencodings' is empty, 'fileencoding' is not modified.
2763 See 'fileencoding' for the possible values.
2764 Setting this option does not have an effect until the next time a file
2765 is read.
2766
2767 *'fileformat'* *'ff'*
2768'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2769 Unix default: "unix",
2770 Macintosh default: "mac")
2771 local to buffer
2772 {not in Vi}
2773 This gives the <EOL> of the current buffer, which is used for
2774 reading/writing the buffer from/to a file:
2775 dos <CR> <NL>
2776 unix <NL>
2777 mac <CR>
2778 When "dos" is used, CTRL-Z at the end of a file is ignored.
2779 See |file-formats| and |file-read|.
2780 For the character encoding of the file see 'fileencoding'.
2781 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2782 works like it was set to "unix'.
2783 This option is set automatically when starting to edit a file and
2784 'fileformats' is not empty and 'binary' is off.
2785 When this option is set, after starting to edit a file, the 'modified'
2786 option is set, because the file would be different when written.
2787 This option can not be changed when 'modifiable' is off.
2788 For backwards compatibility: When this option is set to "dos",
2789 'textmode' is set, otherwise 'textmode' is reset.
2790
2791 *'fileformats'* *'ffs'*
2792'fileformats' 'ffs' string (default:
2793 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2794 Vim Unix: "unix,dos",
2795 Vim Mac: "mac,unix,dos",
2796 Vi Cygwin: "unix,dos",
2797 Vi others: "")
2798 global
2799 {not in Vi}
2800 This gives the end-of-line (<EOL>) formats that will be tried when
2801 starting to edit a new buffer and when reading a file into an existing
2802 buffer:
2803 - When empty, the format defined with 'fileformat' will be used
2804 always. It is not set automatically.
2805 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002806 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 'fileformats' name will be used when a file is read into an existing
2808 buffer, no matter what 'fileformat' for that buffer is set to.
2809 - When more than one name is present, separated by commas, automatic
2810 <EOL> detection will be done when reading a file. When starting to
2811 edit a file, a check is done for the <EOL>:
2812 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2813 'fileformat' is set to "dos".
2814 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002815 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816 preceding <CR>, "unix" is preferred over "dos".
2817 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2818 This means that "mac" is only chosen when "unix" is not present,
2819 or when no <NL> is found in the file, and when "dos" is not
2820 present, or no <CR><NL> is present in the file.
2821 Also if "unix" was first chosen, but the first <CR> is before
2822 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2823 the file, then 'fileformat' is set to "mac".
2824 4. If 'fileformat' is still not set, the first name from
2825 'fileformats' is used.
2826 When reading a file into an existing buffer, the same is done, but
2827 this happens like 'fileformat' has been set appropriately for that
2828 file only, the option is not changed.
2829 When 'binary' is set, the value of 'fileformats' is not used.
2830
2831 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2832 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2833 done:
2834 - When 'fileformats' is empty, there is no automatic detection. Dos
2835 format will be used.
2836 - When 'fileformats' is set to one or more names, automatic detection
2837 is done. This is based on the first <NL> in the file: If there is a
2838 <CR> in front of it, Dos format is used, otherwise Unix format is
2839 used.
2840 Also see |file-formats|.
2841 For backwards compatibility: When this option is set to an empty
2842 string or one format (no comma is included), 'textauto' is reset,
2843 otherwise 'textauto' is set.
2844 NOTE: This option is set to the Vi default value when 'compatible' is
2845 set and to the Vim default value when 'compatible' is reset.
2846
2847 *'filetype'* *'ft'*
2848'filetype' 'ft' string (default: "")
2849 local to buffer
2850 {not in Vi}
2851 {not available when compiled without the |+autocmd|
2852 feature}
2853 When this option is set, the FileType autocommand event is triggered.
2854 All autocommands that match with the value of this option will be
2855 executed. Thus the value of 'filetype' is used in place of the file
2856 name.
2857 Otherwise this option does not always reflect the current file type.
2858 This option is normally set when the file type is detected. To enable
2859 this use the ":filetype on" command. |:filetype|
2860 Setting this option to a different value is most useful in a modeline,
2861 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002862 Example, for in an IDL file:
2863 /* vim: set filetype=idl : */ ~
2864 |FileType| |filetypes|
2865 When a dot appears in the value then this separates two filetype
2866 names. Example:
2867 /* vim: set filetype=c.doxygen : */ ~
2868 This will use the "c" filetype first, then the "doxygen" filetype.
2869 This works both for filetype plugins and for syntax files. More than
2870 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 Do not confuse this option with 'osfiletype', which is for the file
2872 type that is actually stored with the file.
2873 This option is not copied to another buffer, independent of the 's' or
2874 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002875 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876
2877 *'fillchars'* *'fcs'*
2878'fillchars' 'fcs' string (default "vert:|,fold:-")
2879 global
2880 {not in Vi}
2881 {not available when compiled without the |+windows|
2882 and |+folding| features}
2883 Characters to fill the statuslines and vertical separators.
2884 It is a comma separated list of items:
2885
2886 item default Used for ~
2887 stl:c ' ' or '^' statusline of the current window
2888 stlnc:c ' ' or '-' statusline of the non-current windows
2889 vert:c '|' vertical separators |:vsplit|
2890 fold:c '-' filling 'foldtext'
2891 diff:c '-' deleted lines of the 'diff' option
2892
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002893 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894 "stlnc" the space will be used when there is highlighting, '^' or '-'
2895 otherwise.
2896
2897 Example: >
2898 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2899< This is similar to the default, except that these characters will also
2900 be used when there is highlighting.
2901
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002902 for "stl" and "stlnc" only single-byte values are supported.
2903
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 The highlighting used for these items:
2905 item highlight group ~
2906 stl:c StatusLine |hl-StatusLine|
2907 stlnc:c StatusLineNC |hl-StatusLineNC|
2908 vert:c VertSplit |hl-VertSplit|
2909 fold:c Folded |hl-Folded|
2910 diff:c DiffDelete |hl-DiffDelete|
2911
2912 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2913'fkmap' 'fk' boolean (default off) *E198*
2914 global
2915 {not in Vi}
2916 {only available when compiled with the |+rightleft|
2917 feature}
2918 When on, the keyboard is mapped for the Farsi character set.
2919 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002920 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921
2922 *'foldclose'* *'fcl'*
2923'foldclose' 'fcl' string (default "")
2924 global
2925 {not in Vi}
2926 {not available when compiled without the |+folding|
2927 feature}
2928 When set to "all", a fold is closed when the cursor isn't in it and
2929 its level is higher than 'foldlevel'. Useful if you want folds to
2930 automatically close when moving out of them.
2931
2932 *'foldcolumn'* *'fdc'*
2933'foldcolumn' 'fdc' number (default 0)
2934 local to window
2935 {not in Vi}
2936 {not available when compiled without the |+folding|
2937 feature}
2938 When non-zero, a column with the specified width is shown at the side
2939 of the window which indicates open and closed folds. The maximum
2940 value is 12.
2941 See |folding|.
2942
2943 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2944'foldenable' 'fen' boolean (default on)
2945 local to window
2946 {not in Vi}
2947 {not available when compiled without the |+folding|
2948 feature}
2949 When off, all folds are open. This option can be used to quickly
2950 switch between showing all text unfolded and viewing the text with
2951 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002952 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 'foldenable' is off.
2954 This option is set by commands that create a new fold or close a fold.
2955 See |folding|.
2956
2957 *'foldexpr'* *'fde'*
2958'foldexpr' 'fde' string (default: "0")
2959 local to window
2960 {not in Vi}
2961 {not available when compiled without the |+folding|
2962 or |+eval| feature}
2963 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002964 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002965
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002966 The expression may be evaluated in the |sandbox|, see
2967 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002968 This option can't be set from a |modeline| when the 'diff' option is
2969 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002970
2971 It is not allowed to change text or jump to another window while
2972 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973
2974 *'foldignore'* *'fdi'*
2975'foldignore' 'fdi' string (default: "#")
2976 local to window
2977 {not in Vi}
2978 {not available when compiled without the |+folding|
2979 feature}
2980 Used only when 'foldmethod' is "indent". Lines starting with
2981 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002982 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983 The default "#" works well for C programs. See |fold-indent|.
2984
2985 *'foldlevel'* *'fdl'*
2986'foldlevel' 'fdl' number (default: 0)
2987 local to window
2988 {not in Vi}
2989 {not available when compiled without the |+folding|
2990 feature}
2991 Sets the fold level: Folds with a higher level will be closed.
2992 Setting this option to zero will close all folds. Higher numbers will
2993 close fewer folds.
2994 This option is set by commands like |zm|, |zM| and |zR|.
2995 See |fold-foldlevel|.
2996
2997 *'foldlevelstart'* *'fdls'*
2998'foldlevelstart' 'fdls' number (default: -1)
2999 global
3000 {not in Vi}
3001 {not available when compiled without the |+folding|
3002 feature}
3003 Sets 'foldlevel' when starting to edit another buffer in a window.
3004 Useful to always start editing with all folds closed (value zero),
3005 some folds closed (one) or no folds closed (99).
3006 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003007 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 ignores this option and closes all folds.
3009 It is also done before BufReadPre autocommands, to allow an autocmd to
3010 overrule the 'foldlevel' value for specific files.
3011 When the value is negative, it is not used.
3012
3013 *'foldmarker'* *'fmr'* *E536*
3014'foldmarker' 'fmr' string (default: "{{{,}}}")
3015 local to window
3016 {not in Vi}
3017 {not available when compiled without the |+folding|
3018 feature}
3019 The start and end marker used when 'foldmethod' is "marker". There
3020 must be one comma, which separates the start and end marker. The
3021 marker is a literal string (a regular expression would be too slow).
3022 See |fold-marker|.
3023
3024 *'foldmethod'* *'fdm'*
3025'foldmethod' 'fdm' string (default: "manual")
3026 local to window
3027 {not in Vi}
3028 {not available when compiled without the |+folding|
3029 feature}
3030 The kind of folding used for the current window. Possible values:
3031 |fold-manual| manual Folds are created manually.
3032 |fold-indent| indent Lines with equal indent form a fold.
3033 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3034 |fold-marker| marker Markers are used to specify folds.
3035 |fold-syntax| syntax Syntax highlighting items specify folds.
3036 |fold-diff| diff Fold text that is not changed.
3037
3038 *'foldminlines'* *'fml'*
3039'foldminlines' 'fml' number (default: 1)
3040 local to window
3041 {not in Vi}
3042 {not available when compiled without the |+folding|
3043 feature}
3044 Sets the minimum number of screen lines for a fold to be displayed
3045 closed. Also for manually closed folds.
3046 Note that this only has an effect of what is displayed. After using
3047 "zc" to close a fold, which is displayed open because it's smaller
3048 than 'foldminlines', a following "zc" may close a containing fold.
3049
3050 *'foldnestmax'* *'fdn'*
3051'foldnestmax' 'fdn' number (default: 20)
3052 local to window
3053 {not in Vi}
3054 {not available when compiled without the |+folding|
3055 feature}
3056 Sets the maximum nesting of folds for the "indent" and "syntax"
3057 methods. This avoids that too many folds will be created. Using more
3058 than 20 doesn't work, because the internal limit is 20.
3059
3060 *'foldopen'* *'fdo'*
3061'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3062 search,tag,undo")
3063 global
3064 {not in Vi}
3065 {not available when compiled without the |+folding|
3066 feature}
3067 Specifies for which type of commands folds will be opened, if the
3068 command moves the cursor into a closed fold. It is a comma separated
3069 list of items.
3070 item commands ~
3071 all any
3072 block "(", "{", "[[", "[{", etc.
3073 hor horizontal movements: "l", "w", "fx", etc.
3074 insert any command in Insert mode
3075 jump far jumps: "G", "gg", etc.
3076 mark jumping to a mark: "'m", CTRL-O, etc.
3077 percent "%"
3078 quickfix ":cn", ":crew", ":make", etc.
3079 search search for a pattern: "/", "n", "*", "gd", etc.
3080 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003081 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 tag jumping to a tag: ":ta", CTRL-T, etc.
3083 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003084 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 the |zv| command to the mapping to get the same effect.
3086 When a movement command is used for an operator (e.g., "dl" or "y%")
3087 this option is not used. This means the operator will include the
3088 whole closed fold.
3089 Note that vertical movements are not here, because it would make it
3090 very difficult to move onto a closed fold.
3091 In insert mode the folds containing the cursor will always be open
3092 when text is inserted.
3093 To close folds you can re-apply 'foldlevel' with the |zx| command or
3094 set the 'foldclose' option to "all".
3095
3096 *'foldtext'* *'fdt'*
3097'foldtext' 'fdt' string (default: "foldtext()")
3098 local to window
3099 {not in Vi}
3100 {not available when compiled without the |+folding|
3101 feature}
3102 An expression which is used to specify the text displayed for a closed
3103 fold. See |fold-foldtext|.
3104
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003105 The expression may be evaluated in the |sandbox|, see
3106 |sandbox-option|.
3107
3108 It is not allowed to change text or jump to another window while
3109 evaluating 'foldtext' |textlock|.
3110
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 *'formatoptions'* *'fo'*
3112'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3113 local to buffer
3114 {not in Vi}
3115 This is a sequence of letters which describes how automatic
3116 formatting is to be done. See |fo-table|. When the 'paste' option is
3117 on, no formatting is done (like 'formatoptions' is empty). Commas can
3118 be inserted for readability.
3119 To avoid problems with flags that are added in the future, use the
3120 "+=" and "-=" feature of ":set" |add-option-flags|.
3121 NOTE: This option is set to the Vi default value when 'compatible' is
3122 set and to the Vim default value when 'compatible' is reset.
3123
Bram Moolenaar86b68352004-12-27 21:59:20 +00003124 *'formatlistpat'* *'flp'*
3125'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3126 local to buffer
3127 {not in Vi}
3128 A pattern that is used to recognize a list header. This is used for
3129 the "n" flag in 'formatoptions'.
3130 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003131 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003132 while still checking more characters. There must be a character
3133 following the pattern, when it matches the whole line it is handled
3134 like there is no match.
3135 The default recognizes a number, followed by an optional punctuation
3136 character and white space.
3137
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 *'formatprg'* *'fp'*
3139'formatprg' 'fp' string (default "")
3140 global
3141 {not in Vi}
3142 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003143 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003145 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003146 If the 'formatexpr' option is not empty it will be used instead.
3147 Otherwise, if 'formatprg' option is an empty string, the internal
3148 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003149 Environment variables are expanded |:set_env|. See |option-backslash|
3150 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003151 The expression may be evaluated in the |sandbox|, see
3152 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003154 *'formatexpr'* *'fex'*
3155'formatexpr' 'fex' string (default "")
3156 local to buffer
3157 {not in Vi}
3158 {not available when compiled without the |+eval|
3159 feature}
3160 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003161 operator or automatic formatting (see 'formatoptions'). When this
3162 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003163
3164 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003165 The |v:count| variable holds the number of lines to be formatted.
3166 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003167 inserted if the expression is being evaluated due to
3168 automatic formatting. This can be empty. Don't insert
3169 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003170
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003171 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003172 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003173< This will invoke the mylang#Format() function in the
3174 autoload/mylang.vim file in 'runtimepath'. |autoload|
3175
3176 The expression is also evaluated when 'textwidth' is set and adding
3177 text beyond that limit. This happens under the same conditions as
3178 when internal formatting is used. Make sure the cursor is kept in the
3179 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003180 return "i" or "R" in this situation.
3181
3182 When the expression evaluates to non-zero Vim will fall back to using
3183 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003184
3185 The expression may be evaluated in the |sandbox|, see
3186 |sandbox-option|.
3187
3188 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003189'fsync' 'fs' boolean (default on)
3190 global
3191 {not in Vi}
3192 When on, the library function fsync() will be called after writing a
3193 file. This will flush a file to disk, ensuring that it is safely
3194 written even on filesystems which do metadata-only journaling. This
3195 will force the harddrive to spin up on Linux systems running in laptop
3196 mode, so it may be undesirable in some situations. Be warned that
3197 turning this off increases the chances of data loss after a crash. On
3198 systems without an fsync() implementation, this variable is always
3199 off.
3200 Also see 'swapsync' for controlling fsync() on swap files.
3201
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3203'gdefault' 'gd' boolean (default off)
3204 global
3205 {not in Vi}
3206 When on, the ":substitute" flag 'g' is default on. This means that
3207 all matches in a line are substituted instead of one. When a 'g' flag
3208 is given to a ":substitute" command, this will toggle the substitution
3209 of all or one match. See |complex-change|.
3210
3211 command 'gdefault' on 'gdefault' off ~
3212 :s/// subst. all subst. one
3213 :s///g subst. one subst. all
3214 :s///gg subst. all subst. one
3215
3216 NOTE: This option is reset when 'compatible' is set.
3217
3218 *'grepformat'* *'gfm'*
3219'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3220 global
3221 {not in Vi}
3222 Format to recognize for the ":grep" command output.
3223 This is a scanf-like string that uses the same format as the
3224 'errorformat' option: see |errorformat|.
3225
3226 *'grepprg'* *'gp'*
3227'grepprg' 'gp' string (default "grep -n ",
3228 Unix: "grep -n $* /dev/null",
3229 Win32: "findstr /n" or "grep -n",
3230 VMS: "SEARCH/NUMBERS ")
3231 global or local to buffer |global-local|
3232 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003233 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 and '#' characters, which are expanded like when used in a command-
3235 line. The placeholder "$*" is allowed to specify where the arguments
3236 will be included. Environment variables are expanded |:set_env|. See
3237 |option-backslash| about including spaces and backslashes.
3238 When your "grep" accepts the "-H" argument, use this to make ":grep"
3239 also work well with a single file: >
3240 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003241< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003242 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3243 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003244 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245 apply equally to 'grepprg'.
3246 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3247 otherwise it's "grep -n".
3248 This option cannot be set from a |modeline| or in the |sandbox|, for
3249 security reasons.
3250
3251 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3252'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3253 ve:ver35-Cursor,
3254 o:hor50-Cursor,
3255 i-ci:ver25-Cursor/lCursor,
3256 r-cr:hor20-Cursor/lCursor,
3257 sm:block-Cursor
3258 -blinkwait175-blinkoff150-blinkon175",
3259 for MS-DOS and Win32 console:
3260 "n-v-c:block,o:hor50,i-ci:hor15,
3261 r-cr:hor30,sm:block")
3262 global
3263 {not in Vi}
3264 {only available when compiled with GUI enabled, and
3265 for MS-DOS and Win32 console}
3266 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003267 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 the height of the cursor can be changed. This can be done by
3269 specifying a block cursor, or a percentage for a vertical or
3270 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003271 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003273 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 mode-list and an argument-list:
3275 mode-list:argument-list,mode-list:argument-list,..
3276 The mode-list is a dash separated list of these modes:
3277 n Normal mode
3278 v Visual mode
3279 ve Visual mode with 'selection' "exclusive" (same as 'v',
3280 if not specified)
3281 o Operator-pending mode
3282 i Insert mode
3283 r Replace mode
3284 c Command-line Normal (append) mode
3285 ci Command-line Insert mode
3286 cr Command-line Replace mode
3287 sm showmatch in Insert mode
3288 a all modes
3289 The argument-list is a dash separated list of these arguments:
3290 hor{N} horizontal bar, {N} percent of the character height
3291 ver{N} vertical bar, {N} percent of the character width
3292 block block cursor, fills the whole character
3293 [only one of the above three should be present]
3294 blinkwait{N} *cursor-blinking*
3295 blinkon{N}
3296 blinkoff{N}
3297 blink times for cursor: blinkwait is the delay before
3298 the cursor starts blinking, blinkon is the time that
3299 the cursor is shown and blinkoff is the time that the
3300 cursor is not shown. The times are in msec. When one
3301 of the numbers is zero, there is no blinking. The
3302 default is: "blinkwait700-blinkon400-blinkoff250".
3303 These numbers are used for a missing entry. This
3304 means that blinking is enabled by default. To switch
3305 blinking off you can use "blinkon0". The cursor only
3306 blinks when Vim is waiting for input, not while
3307 executing a command.
3308 To make the cursor blink in an xterm, see
3309 |xterm-blink|.
3310 {group-name}
3311 a highlight group name, that sets the color and font
3312 for the cursor
3313 {group-name}/{group-name}
3314 Two highlight group names, the first is used when
3315 no language mappings are used, the other when they
3316 are. |language-mapping|
3317
3318 Examples of parts:
3319 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3320 block cursor with colors from the "nCursor"
3321 highlight group
3322 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3323 In Insert and Command-line Insert mode, use a
3324 30% vertical bar cursor with colors from the
3325 "iCursor" highlight group. Blink a bit
3326 faster.
3327
3328 The 'a' mode is different. It will set the given argument-list for
3329 all modes. It does not reset anything to defaults. This can be used
3330 to do a common setting for all modes. For example, to switch off
3331 blinking: "a:blinkon0"
3332
3333 Examples of cursor highlighting: >
3334 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3335 :highlight Cursor gui=NONE guifg=bg guibg=fg
3336<
3337 *'guifont'* *'gfn'*
3338 *E235* *E596* *E610* *E611*
3339'guifont' 'gfn' string (default "")
3340 global
3341 {not in Vi}
3342 {only available when compiled with GUI enabled}
3343 This is a list of fonts which will be used for the GUI version of Vim.
3344 In its simplest form the value is just one font name. When
3345 the font cannot be found you will get an error message. To try other
3346 font names a list can be specified, font names separated with commas.
3347 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003348
Bram Moolenaar05159a02005-02-26 23:04:13 +00003349 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3350 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003351
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 Spaces after a comma are ignored. To include a comma in a font name
3353 precede it with a backslash. Setting an option requires an extra
3354 backslash before a space and a backslash. See also
3355 |option-backslash|. For example: >
3356 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003357< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003359
3360 If none of the fonts can be loaded, Vim will keep the current setting.
3361 If an empty font list is given, Vim will try using other resource
3362 settings (for X, it will use the Vim.font resource), and finally it
3363 will try some builtin default which should always be there ("7x13" in
3364 the case of X). The font names given should be "normal" fonts. Vim
3365 will try to find the related bold and italic fonts.
3366
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003367 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003368 :set guifont=*
3369< will bring up a font requester, where you can pick the font you want.
3370
3371 The font name depends on the GUI used. See |setting-guifont| for a
3372 way to set 'guifont' for various systems.
3373
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 For the GTK+ 2 GUI the font name looks like this: >
3375 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003376< That's all. XLFDs are not used. For Chinese this is reported to work
3377 well: >
3378 if has("gui_gtk2")
3379 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3380 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3381 endif
3382<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003383 For Mac OSX you can use something like this: >
3384 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003385< Also see 'macatsui', it can help fix display problems.
3386 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003388 width). An exception is GTK 2: all fonts are accepted, but
3389 mono-spaced fonts look best.
3390
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 To preview a font on X11, you might be able to use the "xfontsel"
3392 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003393
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 For the Win32 GUI *E244* *E245*
3395 - takes these options in the font name:
3396 hXX - height is XX (points, can be floating-point)
3397 wXX - width is XX (points, can be floating-point)
3398 b - bold
3399 i - italic
3400 u - underline
3401 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003402 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3404 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3405 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003406 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407
3408 Use a ':' to separate the options.
3409 - A '_' can be used in the place of a space, so you don't need to use
3410 backslashes to escape the spaces.
3411 - Examples: >
3412 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3413 :set guifont=Andale_Mono:h7.5:w4.5
3414< See also |font-sizes|.
3415
3416 *'guifontset'* *'gfs'*
3417 *E250* *E252* *E234* *E597* *E598*
3418'guifontset' 'gfs' string (default "")
3419 global
3420 {not in Vi}
3421 {only available when compiled with GUI enabled and
3422 with the |+xfontset| feature}
3423 {not available in the GTK+ 2 GUI}
3424 When not empty, specifies two (or more) fonts to be used. The first
3425 one for normal English, the second one for your special language. See
3426 |xfontset|.
3427 Setting this option also means that all font names will be handled as
3428 a fontset name. Also the ones used for the "font" argument of the
3429 |:highlight| command.
3430 The fonts must match with the current locale. If fonts for the
3431 character sets that the current locale uses are not included, setting
3432 'guifontset' will fail.
3433 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3434 the comma-separated names are alternative names, one of which will be
3435 used. In 'guifontset' the whole string is one fontset name,
3436 including the commas. It is not possible to specify alternative
3437 fontset names.
3438 This example works on many X11 systems: >
3439 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3440<
3441 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3442'guifontwide' 'gfw' string (default "")
3443 global
3444 {not in Vi}
3445 {only available when compiled with GUI enabled}
3446 When not empty, specifies a comma-separated list of fonts to be used
3447 for double-width characters. The first font that can be loaded is
3448 used.
3449 Note: The size of these fonts must be exactly twice as wide as the one
3450 specified with 'guifont' and the same height.
3451
3452 All GUI versions but GTK+ 2:
3453
3454 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3455 'guifontset' is empty or invalid.
3456 When 'guifont' is set and a valid font is found in it and
3457 'guifontwide' is empty Vim will attempt to find a matching
3458 double-width font and set 'guifontwide' to it.
3459
3460 GTK+ 2 GUI only: *guifontwide_gtk2*
3461
3462 If set and valid, 'guifontwide' is always used for double width
3463 characters, even if 'encoding' is not set to "utf-8".
3464 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003465 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466 font for characters not available in 'guifont'. Thus you do not need
3467 to set 'guifontwide' at all unless you want to override the choice
3468 made by Pango/Xft.
3469
3470 *'guiheadroom'* *'ghr'*
3471'guiheadroom' 'ghr' number (default 50)
3472 global
3473 {not in Vi} {only for GTK and X11 GUI}
3474 The number of pixels subtracted from the screen height when fitting
3475 the GUI window on the screen. Set this before the GUI is started,
3476 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003477 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 lines will be left for window decorations and other items on the
3479 screen. Set it to a negative value to allow windows taller than the
3480 screen.
3481
3482 *'guioptions'* *'go'*
3483'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003484 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 global
3486 {not in Vi}
3487 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003488 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 sequence of letters which describes what components and options of the
3490 GUI should be used.
3491 To avoid problems with flags that are added in the future, use the
3492 "+=" and "-=" feature of ":set" |add-option-flags|.
3493
3494 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003495 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 'a' Autoselect: If present, then whenever VISUAL mode is started,
3497 or the Visual area extended, Vim tries to become the owner of
3498 the windowing system's global selection. This means that the
3499 Visually highlighted text is available for pasting into other
3500 applications as well as into Vim itself. When the Visual mode
3501 ends, possibly due to an operation on the text, or when an
3502 application wants to paste the selection, the highlighted text
3503 is automatically yanked into the "* selection register.
3504 Thus the selection is still available for pasting into other
3505 applications after the VISUAL mode has ended.
3506 If not present, then Vim won't become the owner of the
3507 windowing system's global selection unless explicitly told to
3508 by a yank or delete operation for the "* register.
3509 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003510 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003511 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512 applies to the modeless selection.
3513
3514 'guioptions' autoselect Visual autoselect modeless ~
3515 "" - -
3516 "a" yes yes
3517 "A" - yes
3518 "aA" yes yes
3519
Bram Moolenaar02467872007-05-06 13:22:01 +00003520 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 'c' Use console dialogs instead of popup dialogs for simple
3522 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003523 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003524 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003525 'guitablabel' can be used to change the text in the labels.
3526 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003527 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003528 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003529 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 'f' Foreground: Don't use fork() to detach the GUI from the shell
3531 where it was started. Use this for programs that wait for the
3532 editor to finish (e.g., an e-mail program). Alternatively you
3533 can use "gvim -f" or ":gui -f" to start the GUI in the
3534 foreground. |gui-fork|
3535 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003536 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003537 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3539 corner of the window. It's black&white on non-GTK, because of
3540 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003541 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003543 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003544 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003546 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 file is sourced the system menu has already been loaded; the
3548 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003549 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 'g' Grey menu items: Make menu items that are not active grey. If
3551 'g' is not included inactive menu items are not shown at all.
3552 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003553 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554 't' Include tearoff menu items. Currently only works for Win32,
3555 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003556 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003557 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003558 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003559 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003561 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 'R' Right-hand scrollbar is present when there is a vertically
3563 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003564 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003565 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003566 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 'L' Left-hand scrollbar is present when there is a vertically
3568 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003569 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3571 the longest visible line, or on the cursor line if the 'h'
3572 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003573 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 'h' Limit horizontal scrollbar size to the length of the cursor
3575 line. Reduces computations. |gui-horiz-scroll|
3576
3577 And yes, you may even have scrollbars on the left AND the right if
3578 you really want to :-). See |gui-scrollbars| for more information.
3579
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003580 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 'v' Use a vertical button layout for dialogs. When not included,
3582 a horizontal layout is preferred, but when it doesn't fit a
3583 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003584 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 'p' Use Pointer callbacks for X11 GUI. This is required for some
3586 window managers. If the cursor is not blinking or hollow at
3587 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003588 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003590 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003591 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592
Bram Moolenaar02467872007-05-06 13:22:01 +00003593
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 *'guipty'* *'noguipty'*
3595'guipty' boolean (default on)
3596 global
3597 {not in Vi}
3598 {only available when compiled with GUI enabled}
3599 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3600 I/O to/from shell commands. See |gui-pty|.
3601
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003602 *'guitablabel'* *'gtl'*
3603'guitablabel' 'gtl' string (default empty)
3604 global
3605 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003606 {only available when compiled with GUI enabled and
3607 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003608 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003609 pages line. When empty and when the result is empty Vim will use a
3610 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003611
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003612 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003613 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003614
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003615 Only used when the GUI tab pages line is displayed. 'e' must be
3616 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3617 used.
3618
Bram Moolenaar57657d82006-04-21 22:12:41 +00003619 *'guitabtooltip'* *'gtt'*
3620'guitabtooltip' 'gtt' string (default empty)
3621 global
3622 {not in Vi}
3623 {only available when compiled with GUI enabled and
3624 with the +windows feature}
3625 When nonempty describes the text to use in a tooltip for the GUI tab
3626 pages line. When empty Vim will use a default tooltip.
3627 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003628 You can include a line break. Simplest method is to use |:let|: >
3629 :let &guitabtooltip = "line one\nline two"
3630<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003631
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 *'helpfile'* *'hf'*
3633'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3634 (others) "$VIMRUNTIME/doc/help.txt")
3635 global
3636 {not in Vi}
3637 Name of the main help file. All distributed help files should be
3638 placed together in one directory. Additionally, all "doc" directories
3639 in 'runtimepath' will be used.
3640 Environment variables are expanded |:set_env|. For example:
3641 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003642 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643 spaces and backslashes.
3644 This option cannot be set from a |modeline| or in the |sandbox|, for
3645 security reasons.
3646
3647 *'helpheight'* *'hh'*
3648'helpheight' 'hh' number (default 20)
3649 global
3650 {not in Vi}
3651 {not available when compiled without the +windows
3652 feature}
3653 Minimal initial height of the help window when it is opened with the
3654 ":help" command. The initial height of the help window is half of the
3655 current window, or (when the 'ea' option is on) the same as other
3656 windows. When the height is less than 'helpheight', the height is
3657 set to 'helpheight'. Set to zero to disable.
3658
3659 *'helplang'* *'hlg'*
3660'helplang' 'hlg' string (default: messages language or empty)
3661 global
3662 {only available when compiled with the |+multi_lang|
3663 feature}
3664 {not in Vi}
3665 Comma separated list of languages. Vim will use the first language
3666 for which the desired help can be found. The English help will always
3667 be used as a last resort. You can add "en" to prefer English over
3668 another language, but that will only find tags that exist in that
3669 language and not in the English help.
3670 Example: >
3671 :set helplang=de,it
3672< This will first search German, then Italian and finally English help
3673 files.
3674 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3675 try to find the tag in the current language before using this option.
3676 See |help-translated|.
3677
3678 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3679'hidden' 'hid' boolean (default off)
3680 global
3681 {not in Vi}
3682 When off a buffer is unloaded when it is |abandon|ed. When on a
3683 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3684 displayed in another window, it does not become hidden, of course.
3685 The commands that move through the buffer list sometimes make a buffer
3686 hidden although the 'hidden' option is off: When the buffer is
3687 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003688 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003689 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 This option is set for one command with ":hide {command}" |:hide|.
3691 WARNING: It's easy to forget that you have changes in hidden buffers.
3692 Think twice when using ":q!" or ":qa!".
3693
3694 *'highlight'* *'hl'*
3695'highlight' 'hl' string (default (as a single string):
3696 "8:SpecialKey,@:NonText,d:Directory,
3697 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3698 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003699 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3701 f:Folded,F:FoldColumn,A:DiffAdd,
3702 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003703 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003704 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003705 +:Pmenu,=:PmenuSel,
3706 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 global
3708 {not in Vi}
3709 This option can be used to set highlighting mode for various
3710 occasions. It is a comma separated list of character pairs. The
3711 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003712 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3714 |hl-NonText| @ '~' and '@' at the end of the window and
3715 characters from 'showbreak'
3716 |hl-Directory| d directories in CTRL-D listing and other special
3717 things in listings
3718 |hl-ErrorMsg| e error messages
3719 h (obsolete, ignored)
3720 |hl-IncSearch| i 'incsearch' highlighting
3721 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3722 |hl-MoreMsg| m |more-prompt|
3723 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003724 |hl-LineNr| n line number for ":number" and ":#" commands, and
3725 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 |hl-Question| r |hit-enter| prompt and yes/no questions
3727 |hl-StatusLine| s status line of current window |status-line|
3728 |hl-StatusLineNC| S status lines of not-current windows
3729 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3730 |hl-VertSplit| c column used to separate vertically split windows
3731 |hl-Visual| v Visual mode
3732 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3733 Selection" Only X11 Gui's |gui-x11| and
3734 |xterm-clipboard|.
3735 |hl-WarningMsg| w warning messages
3736 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3737 |hl-Folded| f line used for closed folds
3738 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003739 |hl-DiffAdd| A added line in diff mode
3740 |hl-DiffChange| C changed line in diff mode
3741 |hl-DiffDelete| D deleted line in diff mode
3742 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003744 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003745 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003746 |hl-SpellRare| R rare word |spell|
3747 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003748 |hl-Conceal| - the placeholders used for concealed characters
3749 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003750 |hl-Pmenu| + popup menu normal line
3751 |hl-PmenuSel| = popup menu normal line
3752 |hl-PmenuSbar| x popup menu scrollbar
3753 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754
3755 The display modes are:
3756 r reverse (termcap entry "mr" and "me")
3757 i italic (termcap entry "ZH" and "ZR")
3758 b bold (termcap entry "md" and "me")
3759 s standout (termcap entry "so" and "se")
3760 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003761 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762 n no highlighting
3763 - no highlighting
3764 : use a highlight group
3765 The default is used for occasions that are not included.
3766 If you want to change what the display modes do, see |dos-colors|
3767 for an example.
3768 When using the ':' display mode, this must be followed by the name of
3769 a highlight group. A highlight group can be used to define any type
3770 of highlighting, including using color. See |:highlight| on how to
3771 define one. The default uses a different group for each occasion.
3772 See |highlight-default| for the default highlight groups.
3773
3774 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3775'hlsearch' 'hls' boolean (default off)
3776 global
3777 {not in Vi}
3778 {not available when compiled without the
3779 |+extra_search| feature}
3780 When there is a previous search pattern, highlight all its matches.
3781 The type of highlighting used can be set with the 'l' occasion in the
3782 'highlight' option. This uses the "Search" highlight group by
3783 default. Note that only the matching text is highlighted, any offsets
3784 are not applied.
3785 See also: 'incsearch' and |:match|.
3786 When you get bored looking at the highlighted matches, you can turn it
3787 off with |:nohlsearch|. As soon as you use a search command, the
3788 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003789 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 When the search pattern can match an end-of-line, Vim will try to
3791 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003792 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003793 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003794 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 NOTE: This option is reset when 'compatible' is set.
3796
3797 *'history'* *'hi'*
3798'history' 'hi' number (Vim default: 20, Vi default: 0)
3799 global
3800 {not in Vi}
3801 A history of ":" commands, and a history of previous search patterns
3802 are remembered. This option decides how many entries may be stored in
3803 each of these histories (see |cmdline-editing|).
3804 NOTE: This option is set to the Vi default value when 'compatible' is
3805 set and to the Vim default value when 'compatible' is reset.
3806
3807 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3808'hkmap' 'hk' boolean (default off)
3809 global
3810 {not in Vi}
3811 {only available when compiled with the |+rightleft|
3812 feature}
3813 When on, the keyboard is mapped for the Hebrew character set.
3814 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3815 toggle this option. See |rileft.txt|.
3816 NOTE: This option is reset when 'compatible' is set.
3817
3818 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3819'hkmapp' 'hkp' boolean (default off)
3820 global
3821 {not in Vi}
3822 {only available when compiled with the |+rightleft|
3823 feature}
3824 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3825 This is useful if you have a non-Hebrew keyboard.
3826 See |rileft.txt|.
3827 NOTE: This option is reset when 'compatible' is set.
3828
3829 *'icon'* *'noicon'*
3830'icon' boolean (default off, on when title can be restored)
3831 global
3832 {not in Vi}
3833 {not available when compiled without the |+title|
3834 feature}
3835 When on, the icon text of the window will be set to the value of
3836 'iconstring' (if it is not empty), or to the name of the file
3837 currently being edited. Only the last part of the name is used.
3838 Overridden by the 'iconstring' option.
3839 Only works if the terminal supports setting window icons (currently
3840 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3841 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3842 builtin termcap).
3843 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003844 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845 X11.
3846
3847 *'iconstring'*
3848'iconstring' string (default "")
3849 global
3850 {not in Vi}
3851 {not available when compiled without the |+title|
3852 feature}
3853 When this option is not empty, it will be used for the icon text of
3854 the window. This happens only when the 'icon' option is on.
3855 Only works if the terminal supports setting window icon text
3856 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3857 Does not work for MS Windows.
3858 When Vim was compiled with HAVE_X11 defined, the original icon will be
3859 restored if possible |X11|.
3860 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003861 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862 'titlestring' for example settings.
3863 {not available when compiled without the |+statusline| feature}
3864
3865 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3866'ignorecase' 'ic' boolean (default off)
3867 global
3868 Ignore case in search patterns. Also used when searching in the tags
3869 file.
3870 Also see 'smartcase'.
3871 Can be overruled by using "\c" or "\C" in the pattern, see
3872 |/ignorecase|.
3873
3874 *'imactivatekey'* *'imak'*
3875'imactivatekey' 'imak' string (default "")
3876 global
3877 {not in Vi}
3878 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003879 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 Specifies the key that your Input Method in X-Windows uses for
3881 activation. When this is specified correctly, vim can fully control
3882 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3883 You can't use this option to change the activation key, the option
3884 tells Vim what the key is.
3885 Format:
3886 [MODIFIER_FLAG-]KEY_STRING
3887
3888 These characters can be used for MODIFIER_FLAG (case is ignored):
3889 S Shift key
3890 L Lock key
3891 C Control key
3892 1 Mod1 key
3893 2 Mod2 key
3894 3 Mod3 key
3895 4 Mod4 key
3896 5 Mod5 key
3897 Combinations are allowed, for example "S-C-space" or "SC-space" are
3898 both shift+ctrl+space.
3899 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3900
3901 Example: >
3902 :set imactivatekey=S-space
3903< "S-space" means shift+space. This is the activation key for kinput2 +
3904 canna (Japanese), and ami (Korean).
3905
3906 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3907'imcmdline' 'imc' boolean (default off)
3908 global
3909 {not in Vi}
3910 {only available when compiled with the |+xim|
3911 |+multi_byte_ime| or |global-ime| feature}
3912 When set the Input Method is always on when starting to edit a command
3913 line, unless entering a search pattern (see 'imsearch' for that).
3914 Setting this option is useful when your input method allows entering
3915 English characters directly, e.g., when it's used to type accented
3916 characters with dead keys.
3917
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003918 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3920 global
3921 {not in Vi}
3922 {only available when compiled with the |+xim|
3923 |+multi_byte_ime| or |global-ime| feature}
3924 When set the Input Method is never used. This is useful to disable
3925 the IM when it doesn't work properly.
3926 Currently this option is on by default for SGI/IRIX machines. This
3927 may change in later releases.
3928
3929 *'iminsert'* *'imi'*
3930'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3931 local to buffer
3932 {not in Vi}
3933 Specifies whether :lmap or an Input Method (IM) is to be used in
3934 Insert mode. Valid values:
3935 0 :lmap is off and IM is off
3936 1 :lmap is ON and IM is off
3937 2 :lmap is off and IM is ON
3938 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3939 or |global-ime|.
3940 To always reset the option to zero when leaving Insert mode with <Esc>
3941 this can be used: >
3942 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3943< This makes :lmap and IM turn off automatically when leaving Insert
3944 mode.
3945 Note that this option changes when using CTRL-^ in Insert mode
3946 |i_CTRL-^|.
3947 The value is set to 1 when setting 'keymap' to a valid keymap name.
3948 It is also used for the argument of commands like "r" and "f".
3949 The value 0 may not work correctly with Athena and Motif with some XIM
3950 methods. Use 'imdisable' to disable XIM then.
3951
3952 *'imsearch'* *'ims'*
3953'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3954 local to buffer
3955 {not in Vi}
3956 Specifies whether :lmap or an Input Method (IM) is to be used when
3957 entering a search pattern. Valid values:
3958 -1 the value of 'iminsert' is used, makes it look like
3959 'iminsert' is also used when typing a search pattern
3960 0 :lmap is off and IM is off
3961 1 :lmap is ON and IM is off
3962 2 :lmap is off and IM is ON
3963 Note that this option changes when using CTRL-^ in Command-line mode
3964 |c_CTRL-^|.
3965 The value is set to 1 when it is not -1 and setting the 'keymap'
3966 option to a valid keymap name.
3967 The value 0 may not work correctly with Athena and Motif with some XIM
3968 methods. Use 'imdisable' to disable XIM then.
3969
3970 *'include'* *'inc'*
3971'include' 'inc' string (default "^\s*#\s*include")
3972 global or local to buffer |global-local|
3973 {not in Vi}
3974 {not available when compiled without the
3975 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003976 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 pattern, just like for the "/" command (See |pattern|). The default
3978 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003979 "]I", "[d", etc.
3980 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003981 comes after the matched pattern. But if "\zs" appears in the pattern
3982 then the text matched from "\zs" to the end, or until "\ze" if it
3983 appears, is used as the file name. Use this to include characters
3984 that are not in 'isfname', such as a space. You can then use
3985 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003986 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987
3988 *'includeexpr'* *'inex'*
3989'includeexpr' 'inex' string (default "")
3990 local to buffer
3991 {not in Vi}
3992 {not available when compiled without the
3993 |+find_in_path| or |+eval| feature}
3994 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003995 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 :set includeexpr=substitute(v:fname,'\\.','/','g')
3997< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003998
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004000 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 Also used for |<cfile>|.
4002
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004003 The expression may be evaluated in the |sandbox|, see
4004 |sandbox-option|.
4005
4006 It is not allowed to change text or jump to another window while
4007 evaluating 'includeexpr' |textlock|.
4008
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4010'incsearch' 'is' boolean (default off)
4011 global
4012 {not in Vi}
4013 {not available when compiled without the
4014 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004015 While typing a search command, show where the pattern, as it was typed
4016 so far, matches. The matched string is highlighted. If the pattern
4017 is invalid or not found, nothing is shown. The screen will be updated
4018 often, this is only useful on fast terminals.
4019 Note that the match will be shown, but the cursor will return to its
4020 original position when no match is found and when pressing <Esc>. You
4021 still need to finish the search command with <Enter> to move the
4022 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004023 When compiled with the |+reltime| feature Vim only searches for about
4024 half a second. With a complicated pattern and/or a lot of text the
4025 match may not be found. This is to avoid that Vim hangs while you
4026 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004027 The highlighting can be set with the 'i' flag in 'highlight'.
4028 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004029 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004030 to the command line. If 'ignorecase' and 'smartcase' are set and the
4031 command line has no uppercase characters, the added character is
4032 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004033 CTRL-R CTRL-W can be used to add the word at the end of the current
4034 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 NOTE: This option is reset when 'compatible' is set.
4036
4037 *'indentexpr'* *'inde'*
4038'indentexpr' 'inde' string (default "")
4039 local to buffer
4040 {not in Vi}
4041 {not available when compiled without the |+cindent|
4042 or |+eval| features}
4043 Expression which is evaluated to obtain the proper indent for a line.
4044 It is used when a new line is created, for the |=| operator and
4045 in Insert mode as specified with the 'indentkeys' option.
4046 When this option is not empty, it overrules the 'cindent' and
4047 'smartindent' indenting.
4048 When 'paste' is set this option is not used for indenting.
4049 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004050 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051 when the expression is evaluated (but it may be moved around).
4052 The expression must return the number of spaces worth of indent. It
4053 can return "-1" to keep the current indent (this means 'autoindent' is
4054 used for the indent).
4055 Functions useful for computing the indent are |indent()|, |cindent()|
4056 and |lispindent()|.
4057 The evaluation of the expression must not have side effects! It must
4058 not change the text, jump to another window, etc. Afterwards the
4059 cursor position is always restored, thus the cursor may be moved.
4060 Normally this option would be set to call a function: >
4061 :set indentexpr=GetMyIndent()
4062< Error messages will be suppressed, unless the 'debug' option contains
4063 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004064 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065 NOTE: This option is made empty when 'compatible' is set.
4066
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004067 The expression may be evaluated in the |sandbox|, see
4068 |sandbox-option|.
4069
4070 It is not allowed to change text or jump to another window while
4071 evaluating 'indentexpr' |textlock|.
4072
4073
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074 *'indentkeys'* *'indk'*
4075'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4076 local to buffer
4077 {not in Vi}
4078 {not available when compiled without the |+cindent|
4079 feature}
4080 A list of keys that, when typed in Insert mode, cause reindenting of
4081 the current line. Only happens if 'indentexpr' isn't empty.
4082 The format is identical to 'cinkeys', see |indentkeys-format|.
4083 See |C-indenting| and |indent-expression|.
4084
4085 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4086'infercase' 'inf' boolean (default off)
4087 local to buffer
4088 {not in Vi}
4089 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004090 'ignorecase' is also on, the case of the match is adjusted depending
4091 on the typed text. If the typed text contains a lowercase letter
4092 where the match has an upper case letter, the completed part is made
4093 lowercase. If the typed text has no lowercase letters and the match
4094 has a lowercase letter where the typed text has an uppercase letter,
4095 and there is a letter before it, the completed part is made uppercase.
4096 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097
4098 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4099'insertmode' 'im' boolean (default off)
4100 global
4101 {not in Vi}
4102 Makes Vim work in a way that Insert mode is the default mode. Useful
4103 if you want to use Vim as a modeless editor. Used for |evim|.
4104 These Insert mode commands will be useful:
4105 - Use the cursor keys to move around.
4106 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4107 this is a mapping, it is executed as if 'insertmode' was off.
4108 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004110 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4111 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112
4113 These items change when 'insertmode' is set:
4114 - when starting to edit of a file, Vim goes to Insert mode.
4115 - <Esc> in Insert mode is a no-op and beeps.
4116 - <Esc> in Normal mode makes Vim go to Insert mode.
4117 - CTRL-L in Insert mode is a command, it is not inserted.
4118 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4119 However, when <Esc> is used inside a mapping, it behaves like
4120 'insertmode' was not set. This was done to be able to use the same
4121 mappings with 'insertmode' set or not set.
4122 When executing commands with |:normal| 'insertmode' is not used.
4123
4124 NOTE: This option is reset when 'compatible' is set.
4125
4126 *'isfname'* *'isf'*
4127'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4128 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4129 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4130 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4131 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4132 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4133 global
4134 {not in Vi}
4135 The characters specified by this option are included in file names and
4136 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004137 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 Multi-byte characters 256 and above are always included, only the
4139 characters up to 255 are specified with this option.
4140 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004141 Think twice before adding white space to this option. Although a
4142 space may appear inside a file name, the effect will be that Vim
4143 doesn't know where a file name starts or ends when doing completion.
4144 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145
4146 Note that on systems using a backslash as path separator, Vim tries to
4147 do its best to make it work as you would expect. That is a bit
4148 tricky, since Vi originally used the backslash to escape special
4149 characters. Vim will not remove a backslash in front of a normal file
4150 name character on these systems, but it will on Unix and alikes. The
4151 '&' and '^' are not included by default, because these are special for
4152 cmd.exe.
4153
4154 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004155 Each part can be a single character number or a range. A range is two
4156 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 decimal number between 0 and 255 or the ASCII character itself (does
4158 not work for digits). Example:
4159 "_,-,128-140,#-43" (include '_' and '-' and the range
4160 128 to 140 and '#' to 43)
4161 If a part starts with '^', the following character number or range
4162 will be excluded from the option. The option is interpreted from left
4163 to right. Put the excluded character after the range where it is
4164 included. To include '^' itself use it as the last character of the
4165 option or the end of a range. Example:
4166 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4167 If the character is '@', all characters where isalpha() returns TRUE
4168 are included. Normally these are the characters a to z and A to Z,
4169 plus accented characters. To include '@' itself use "@-@". Examples:
4170 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004171 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 "a-z,A-Z,@-@" All letters plus the '@' character.
4173 A comma can be included by using it where a character number is
4174 expected. Example:
4175 "48-57,,,_" Digits, comma and underscore.
4176 A comma can be excluded by prepending a '^'. Example:
4177 " -~,^,,9" All characters from space to '~', excluding
4178 comma, plus <Tab>.
4179 See |option-backslash| about including spaces and backslashes.
4180
4181 *'isident'* *'isi'*
4182'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4183 "@,48-57,_,128-167,224-235"
4184 otherwise: "@,48-57,_,192-255")
4185 global
4186 {not in Vi}
4187 The characters given by this option are included in identifiers.
4188 Identifiers are used in recognizing environment variables and after a
4189 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004190 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 option.
4192 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004193 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4195
4196 *'iskeyword'* *'isk'*
4197'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4198 "@,48-57,_,128-167,224-235"
4199 otherwise: "@,48-57,_,192-255"
4200 Vi default: "@,48-57,_")
4201 local to buffer
4202 {not in Vi}
4203 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004204 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 'isfname' for a description of the format of this option. For C
4206 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4207 For a help file it is set to all non-blank printable characters except
4208 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4209 command).
4210 When the 'lisp' option is on the '-' character is always included.
4211 NOTE: This option is set to the Vi default value when 'compatible' is
4212 set and to the Vim default value when 'compatible' is reset.
4213
4214 *'isprint'* *'isp'*
4215'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4216 "@,~-255"; otherwise: "@,161-255")
4217 global
4218 {not in Vi}
4219 The characters given by this option are displayed directly on the
4220 screen. It is also used for "\p" in a |pattern|. The characters from
4221 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4222 even when they are not included in 'isprint' or excluded. See
4223 'isfname' for a description of the format of this option.
4224
4225 Non-printable characters are displayed with two characters:
4226 0 - 31 "^@" - "^_"
4227 32 - 126 always single characters
4228 127 "^?"
4229 128 - 159 "~@" - "~_"
4230 160 - 254 "| " - "|~"
4231 255 "~?"
4232 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4233 displayed as <xx>, with the hexadecimal value of the byte.
4234 When 'display' contains "uhex" all unprintable characters are
4235 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004236 The SpecialKey highlighting will be used for unprintable characters.
4237 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238
4239 Multi-byte characters 256 and above are always included, only the
4240 characters up to 255 are specified with this option. When a character
4241 is printable but it is not available in the current font, a
4242 replacement character will be shown.
4243 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4244 There is no option to specify these characters.
4245
4246 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4247'joinspaces' 'js' boolean (default on)
4248 global
4249 {not in Vi}
4250 Insert two spaces after a '.', '?' and '!' with a join command.
4251 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4252 Otherwise only one space is inserted.
4253 NOTE: This option is set when 'compatible' is set.
4254
4255 *'key'*
4256'key' string (default "")
4257 local to buffer
4258 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004259 {only available when compiled with the |+cryptv|
4260 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004262 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 Careful: Do not set the key value by hand, someone might see the typed
4264 key. Use the |:X| command. But you can make 'key' empty: >
4265 :set key=
4266< It is not possible to get the value of this option with ":set key" or
4267 "echo &key". This is to avoid showing it to someone who shouldn't
4268 know. It also means you cannot see it yourself once you have set it,
4269 be careful not to make a typing error!
4270
4271 *'keymap'* *'kmp'* *E544*
4272'keymap' 'kmp' string (default "")
4273 local to buffer
4274 {not in Vi}
4275 {only available when compiled with the |+keymap|
4276 feature}
4277 Name of a keyboard mapping. See |mbyte-keymap|.
4278 Setting this option to a valid keymap name has the side effect of
4279 setting 'iminsert' to one, so that the keymap becomes effective.
4280 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004281 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282
4283 *'keymodel'* *'km'*
4284'keymodel' 'km' string (default "")
4285 global
4286 {not in Vi}
4287 List of comma separated words, which enable special things that keys
4288 can do. These values can be used:
4289 startsel Using a shifted special key starts selection (either
4290 Select mode or Visual mode, depending on "key" being
4291 present in 'selectmode').
4292 stopsel Using a not-shifted special key stops selection.
4293 Special keys in this context are the cursor keys, <End>, <Home>,
4294 <PageUp> and <PageDown>.
4295 The 'keymodel' option is set by the |:behave| command.
4296
4297 *'keywordprg'* *'kp'*
4298'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4299 OS/2: "view /", VMS: "help")
4300 global or local to buffer |global-local|
4301 {not in Vi}
4302 Program to use for the |K| command. Environment variables are
4303 expanded |:set_env|. ":help" may be used to access the Vim internal
4304 help. (Note that previously setting the global option to the empty
4305 value did this, which is now deprecated.)
4306 When "man" is used, Vim will automatically translate a count for the
4307 "K" command to a section number. Also for "man -s", in which case the
4308 "-s" is removed when there is no count.
4309 See |option-backslash| about including spaces and backslashes.
4310 Example: >
4311 :set keywordprg=man\ -s
4312< This option cannot be set from a |modeline| or in the |sandbox|, for
4313 security reasons.
4314
4315 *'langmap'* *'lmap'* *E357* *E358*
4316'langmap' 'lmap' string (default "")
4317 global
4318 {not in Vi}
4319 {only available when compiled with the |+langmap|
4320 feature}
4321 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004322 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004323 inserted directly. When in command mode the 'langmap' option takes
4324 care of translating these special characters to the original meaning
4325 of the key. This means you don't have to change the keyboard mode to
4326 be able to execute Normal mode commands.
4327 This is the opposite of the 'keymap' option, where characters are
4328 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004330 Example (for Greek, in UTF-8): *greek* >
4331 :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 +00004332< Example (exchanges meaning of z and y for commands): >
4333 :set langmap=zy,yz,ZY,YZ
4334<
4335 The 'langmap' option is a list of parts, separated with commas. Each
4336 part can be in one of two forms:
4337 1. A list of pairs. Each pair is a "from" character immediately
4338 followed by the "to" character. Examples: "aA", "aAbBcC".
4339 2. A list of "from" characters, a semi-colon and a list of "to"
4340 characters. Example: "abc;ABC"
4341 Example: "aA,fgh;FGH,cCdDeE"
4342 Special characters need to be preceded with a backslash. These are
4343 ";", ',' and backslash itself.
4344
4345 This will allow you to activate vim actions without having to switch
4346 back and forth between the languages. Your language characters will
4347 be understood as normal vim English characters (according to the
4348 langmap mappings) in the following cases:
4349 o Normal/Visual mode (commands, buffer/register names, user mappings)
4350 o Insert/Replace Mode: Register names after CTRL-R
4351 o Insert/Replace Mode: Mappings
4352 Characters entered in Command-line mode will NOT be affected by
4353 this option. Note that this option can be changed at any time
4354 allowing to switch between mappings for different languages/encodings.
4355 Use a mapping to avoid having to type it each time!
4356
4357 *'langmenu'* *'lm'*
4358'langmenu' 'lm' string (default "")
4359 global
4360 {not in Vi}
4361 {only available when compiled with the |+menu| and
4362 |+multi_lang| features}
4363 Language to use for menu translation. Tells which file is loaded
4364 from the "lang" directory in 'runtimepath': >
4365 "lang/menu_" . &langmenu . ".vim"
4366< (without the spaces). For example, to always use the Dutch menus, no
4367 matter what $LANG is set to: >
4368 :set langmenu=nl_NL.ISO_8859-1
4369< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004370 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371 If your $LANG is set to a non-English language but you do want to use
4372 the English menus: >
4373 :set langmenu=none
4374< This option must be set before loading menus, switching on filetype
4375 detection or syntax highlighting. Once the menus are defined setting
4376 this option has no effect. But you could do this: >
4377 :source $VIMRUNTIME/delmenu.vim
4378 :set langmenu=de_DE.ISO_8859-1
4379 :source $VIMRUNTIME/menu.vim
4380< Warning: This deletes all menus that you defined yourself!
4381
4382 *'laststatus'* *'ls'*
4383'laststatus' 'ls' number (default 1)
4384 global
4385 {not in Vi}
4386 The value of this option influences when the last window will have a
4387 status line:
4388 0: never
4389 1: only if there are at least two windows
4390 2: always
4391 The screen looks nicer with a status line if you have several
4392 windows, but it takes another screen line. |status-line|
4393
4394 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4395'lazyredraw' 'lz' boolean (default off)
4396 global
4397 {not in Vi}
4398 When this option is set, the screen will not be redrawn while
4399 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004400 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401 update use |:redraw|.
4402
4403 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4404'linebreak' 'lbr' boolean (default off)
4405 local to window
4406 {not in Vi}
4407 {not available when compiled without the |+linebreak|
4408 feature}
4409 If on Vim will wrap long lines at a character in 'breakat' rather
4410 than at the last character that fits on the screen. Unlike
4411 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4412 it only affects the way the file is displayed, not its contents. The
4413 value of 'showbreak' is used to put in front of wrapped lines.
4414 This option is not used when the 'wrap' option is off or 'list' is on.
4415 Note that <Tab> characters after an <EOL> are mostly not displayed
4416 with the right amount of white space.
4417
4418 *'lines'* *E593*
4419'lines' number (default 24 or terminal height)
4420 global
4421 Number of lines of the Vim window.
4422 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004423 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 When Vim is running in the GUI or in a resizable window, setting this
4425 option will cause the window size to be changed. When you only want
4426 to use the size for the GUI, put the command in your |gvimrc| file.
4427 Vim limits the number of lines to what fits on the screen. You can
4428 use this command to get the tallest window possible: >
4429 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004430< Minimum value is 2, maximum value is 1000.
4431 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 When you set this option and Vim is unable to change the physical
4433 number of lines of the display, the display may be messed up.
4434
4435 *'linespace'* *'lsp'*
4436'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4437 global
4438 {not in Vi}
4439 {only in the GUI}
4440 Number of pixel lines inserted between characters. Useful if the font
4441 uses the full character cell height, making lines touch each other.
4442 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004443 With some fonts there can be too much room between lines (to have
4444 space for ascents and descents). Then it makes sense to set
4445 'linespace' to a negative value. This may cause display problems
4446 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447
4448 *'lisp'* *'nolisp'*
4449'lisp' boolean (default off)
4450 local to buffer
4451 {not available when compiled without the |+lispindent|
4452 feature}
4453 Lisp mode: When <Enter> is typed in insert mode set the indent for
4454 the next line to Lisp standards (well, sort of). Also happens with
4455 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4456 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4457 better. Also see 'lispwords'.
4458 The '-' character is included in keyword characters. Redefines the
4459 "=" operator to use this same indentation algorithm rather than
4460 calling an external program if 'equalprg' is empty.
4461 This option is not used when 'paste' is set.
4462 {Vi: Does it a little bit differently}
4463
4464 *'lispwords'* *'lw'*
4465'lispwords' 'lw' string (default is very long)
4466 global
4467 {not in Vi}
4468 {not available when compiled without the |+lispindent|
4469 feature}
4470 Comma separated list of words that influence the Lisp indenting.
4471 |'lisp'|
4472
4473 *'list'* *'nolist'*
4474'list' boolean (default off)
4475 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004476 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4477 line. Useful to see the difference between tabs and spaces and for
4478 trailing blanks. Further changed by the 'listchars' option.
4479
4480 The cursor is displayed at the start of the space a Tab character
4481 occupies, not at the end as usual in Normal mode. To get this cursor
4482 position while displaying Tabs with spaces, use: >
4483 :set list lcs=tab\ \
4484<
4485 Note that list mode will also affect formatting (set with 'textwidth'
4486 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 changing the way tabs are displayed.
4488
4489 *'listchars'* *'lcs'*
4490'listchars' 'lcs' string (default "eol:$")
4491 global
4492 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004493 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 settings.
4495 eol:c Character to show at the end of each line. When
4496 omitted, there is no extra character at the end of the
4497 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004498 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004500 fill the space that the tab normally occupies.
4501 "tab:>-" will show a tab that takes four spaces as
4502 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004503 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 trailing spaces are blank.
4505 extends:c Character to show in the last column, when 'wrap' is
4506 off and the line continues beyond the right of the
4507 screen.
4508 precedes:c Character to show in the first column, when 'wrap'
4509 is off and there is text preceding the character
4510 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004511 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004512 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004513 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004514 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004516 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004518 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519
4520 Examples: >
4521 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004522 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 :set lcs=extends:>,precedes:<
4524< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004525 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004526 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527
4528 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4529'loadplugins' 'lpl' boolean (default on)
4530 global
4531 {not in Vi}
4532 When on the plugin scripts are loaded when starting up |load-plugins|.
4533 This option can be reset in your |vimrc| file to disable the loading
4534 of plugins.
4535 Note that using the "-u NONE" and "--noplugin" command line arguments
4536 reset this option. |-u| |--noplugin|
4537
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004538 *'macatsui'* *'nomacatsui'*
4539'macatsui' boolean (default on)
4540 global
4541 {only available in Mac GUI version}
4542 This is a workaround for when drawing doesn't work properly. When set
4543 and compiled with multi-byte support ATSUI text drawing is used. When
4544 not set ATSUI text drawing is not used. Switch this option off when
4545 you experience drawing problems. In a future version the problems may
4546 be solved and this option becomes obsolete. Therefore use this method
4547 to unset it: >
4548 if exists('&macatsui')
4549 set nomacatsui
4550 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004551< Another option to check if you have drawing problems is
4552 'termencoding'.
4553
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 *'magic'* *'nomagic'*
4555'magic' boolean (default on)
4556 global
4557 Changes the special characters that can be used in search patterns.
4558 See |pattern|.
4559 NOTE: To avoid portability problems with using patterns, always keep
4560 this option at the default "on". Only switch it off when working with
4561 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004562 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563
4564 *'makeef'* *'mef'*
4565'makeef' 'mef' string (default: "")
4566 global
4567 {not in Vi}
4568 {not available when compiled without the |+quickfix|
4569 feature}
4570 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4571 and the |:grep| command.
4572 When it is empty, an internally generated temp file will be used.
4573 When "##" is included, it is replaced by a number to make the name
4574 unique. This makes sure that the ":make" command doesn't overwrite an
4575 existing file.
4576 NOT used for the ":cf" command. See 'errorfile' for that.
4577 Environment variables are expanded |:set_env|.
4578 See |option-backslash| about including spaces and backslashes.
4579 This option cannot be set from a |modeline| or in the |sandbox|, for
4580 security reasons.
4581
4582 *'makeprg'* *'mp'*
4583'makeprg' 'mp' string (default "make", VMS: "MMS")
4584 global or local to buffer |global-local|
4585 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004586 Program to use for the ":make" command. See |:make_makeprg|.
4587 This option may contain '%' and '#' characters, which are expanded to
4588 the current and alternate file name. |:_%| |:_#|
4589 Environment variables are expanded |:set_env|. See |option-backslash|
4590 about including spaces and backslashes.
4591 Note that a '|' must be escaped twice: once for ":set" and once for
4592 the interpretation of a command. When you use a filter called
4593 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 :set makeprg=gmake\ \\\|\ myfilter
4595< The placeholder "$*" can be given (even multiple times) to specify
4596 where the arguments will be included, for example: >
4597 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4598< This option cannot be set from a |modeline| or in the |sandbox|, for
4599 security reasons.
4600
Bram Moolenaar1a384422010-07-14 19:53:30 +02004601 *'colorcolumn'* *'cc'*
4602'colorcolumn' 'cc' string (default "")
4603 local to window
4604 {not in Vi}
4605 {not available when compiled without the |+syntax|
4606 feature}
4607 'colorcolumn' is a comma separated list of screen columns that are
4608 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
4609 text. Will make screen redrawing slower.
4610 The screen column can be an absolute number, or a number preceded with
4611 '+' or '-', which is added to or subtracted from 'textwidth'. >
4612
4613 :set cc=+1 " highlight column after 'textwidth'
4614 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
4615 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
4616<
4617 When 'textwidth' is zero then the items with '-' and '+' are not used.
4618 A maximum of 256 columns are highlighted.
4619
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 *'matchpairs'* *'mps'*
4621'matchpairs' 'mps' string (default "(:),{:},[:]")
4622 local to buffer
4623 {not in Vi}
4624 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004625 other. Currently only single byte character pairs are allowed, and
4626 they must be different. The characters must be separated by a colon.
4627 The pairs must be separated by a comma. Example for including '<' and
4628 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 :set mps+=<:>
4630
4631< A more exotic example, to jump between the '=' and ';' in an
4632 assignment, useful for languages like C and Java: >
4633 :au FileType c,cpp,java set mps+==:;
4634
4635< For a more advanced way of using "%", see the matchit.vim plugin in
4636 the $VIMRUNTIME/macros directory. |add-local-help|
4637
4638 *'matchtime'* *'mat'*
4639'matchtime' 'mat' number (default 5)
4640 global
4641 {not in Vi}{in Nvi}
4642 Tenths of a second to show the matching paren, when 'showmatch' is
4643 set. Note that this is not in milliseconds, like other options that
4644 set a time. This is to be compatible with Nvi.
4645
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004646 *'maxcombine'* *'mco'*
4647'maxcombine' 'mco' number (default 2)
4648 global
4649 {not in Vi}
4650 {only available when compiled with the |+multi_byte|
4651 feature}
4652 The maximum number of combining characters supported for displaying.
4653 Only used when 'encoding' is "utf-8".
4654 The default is OK for most languages. Hebrew may require 4.
4655 Maximum value is 6.
4656 Even when this option is set to 2 you can still edit text with more
4657 combining characters, you just can't see them. Use |g8| or |ga|.
4658 See |mbyte-combining|.
4659
Bram Moolenaar071d4272004-06-13 20:20:40 +00004660 *'maxfuncdepth'* *'mfd'*
4661'maxfuncdepth' 'mfd' number (default 100)
4662 global
4663 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004664 {not available when compiled without the +eval
4665 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666 Maximum depth of function calls for user functions. This normally
4667 catches endless recursion. When using a recursive function with
4668 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4669 more memory, there is the danger of failing when memory is exhausted.
4670 See also |:function|.
4671
4672 *'maxmapdepth'* *'mmd'* *E223*
4673'maxmapdepth' 'mmd' number (default 1000)
4674 global
4675 {not in Vi}
4676 Maximum number of times a mapping is done without resulting in a
4677 character to be used. This normally catches endless mappings, like
4678 ":map x y" with ":map y x". It still does not catch ":map g wg",
4679 because the 'w' is used before the next mapping is done. See also
4680 |key-mapping|.
4681
4682 *'maxmem'* *'mm'*
4683'maxmem' 'mm' number (default between 256 to 5120 (system
4684 dependent) or half the amount of memory
4685 available)
4686 global
4687 {not in Vi}
4688 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4689 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004690 other memory to be freed. The maximum usable value is about 2000000.
4691 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004693 *'maxmempattern'* *'mmp'*
4694'maxmempattern' 'mmp' number (default 1000)
4695 global
4696 {not in Vi}
4697 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004698 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004699 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004700 When Vim runs into the limit it gives an error message and mostly
4701 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004702 Running into the limit often means that the pattern is very
4703 inefficient or too complex. This may already happen with the pattern
4704 "\(.\)*" on a very long line. ".*" works much better.
4705 Vim may run out of memory before hitting the 'maxmempattern' limit.
4706
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 *'maxmemtot'* *'mmt'*
4708'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4709 dependent) or half the amount of memory
4710 available)
4711 global
4712 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004713 Maximum amount of memory in Kbyte to use for all buffers together.
4714 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4715 without a limit. On 64 bit machines higher values might work. But
4716 hey, do you really need more than 2 Gbyte for text editing?
4717 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718
4719 *'menuitems'* *'mis'*
4720'menuitems' 'mis' number (default 25)
4721 global
4722 {not in Vi}
4723 {not available when compiled without the |+menu|
4724 feature}
4725 Maximum number of items to use in a menu. Used for menus that are
4726 generated from a list of items, e.g., the Buffers menu. Changing this
4727 option has no direct effect, the menu must be refreshed first.
4728
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004729 *'mkspellmem'* *'msm'*
4730'mkspellmem' 'msm' string (default "460000,2000,500")
4731 global
4732 {not in Vi}
4733 {not available when compiled without the |+syntax|
4734 feature}
4735 Parameters for |:mkspell|. This tunes when to start compressing the
4736 word tree. Compression can be slow when there are many words, but
4737 it's needed to avoid running out of memory. The amount of memory used
4738 per word depends very much on how similar the words are, that's why
4739 this tuning is complicated.
4740
4741 There are three numbers, separated by commas:
4742 {start},{inc},{added}
4743
4744 For most languages the uncompressed word tree fits in memory. {start}
4745 gives the amount of memory in Kbyte that can be used before any
4746 compression is done. It should be a bit smaller than the amount of
4747 memory that is available to Vim.
4748
4749 When going over the {start} limit the {inc} number specifies the
4750 amount of memory in Kbyte that can be allocated before another
4751 compression is done. A low number means compression is done after
4752 less words are added, which is slow. A high number means more memory
4753 will be allocated.
4754
4755 After doing compression, {added} times 1024 words can be added before
4756 the {inc} limit is ignored and compression is done when any extra
4757 amount of memory is needed. A low number means there is a smaller
4758 chance of hitting the {inc} limit, less memory is used but it's
4759 slower.
4760
4761 The languages for which these numbers are important are Italian and
4762 Hungarian. The default works for when you have about 512 Mbyte. If
4763 you have 1 Gbyte you could use: >
4764 :set mkspellmem=900000,3000,800
4765< If you have less than 512 Mbyte |:mkspell| may fail for some
4766 languages, no matter what you set 'mkspellmem' to.
4767
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004769'modeline' 'ml' boolean (Vim default: on (off for root),
4770 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771 local to buffer
4772 *'modelines'* *'mls'*
4773'modelines' 'mls' number (default 5)
4774 global
4775 {not in Vi}
4776 If 'modeline' is on 'modelines' gives the number of lines that is
4777 checked for set commands. If 'modeline' is off or 'modelines' is zero
4778 no lines are checked. See |modeline|.
4779 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4780 set and to the Vim default value when 'compatible' is reset.
4781
4782 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4783'modifiable' 'ma' boolean (default on)
4784 local to buffer
4785 {not in Vi} *E21*
4786 When off the buffer contents cannot be changed. The 'fileformat' and
4787 'fileencoding' options also can't be changed.
4788 Can be reset with the |-M| command line argument.
4789
4790 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4791'modified' 'mod' boolean (default off)
4792 local to buffer
4793 {not in Vi}
4794 When on, the buffer is considered to be modified. This option is set
4795 when:
4796 1. A change was made to the text since it was last written. Using the
4797 |undo| command to go back to the original text will reset the
4798 option. But undoing changes that were made before writing the
4799 buffer will set the option again, since the text is different from
4800 when it was written.
4801 2. 'fileformat' or 'fileencoding' is different from its original
4802 value. The original value is set when the buffer is read or
4803 written. A ":set nomodified" command also resets the original
4804 values to the current values and the 'modified' option will be
4805 reset.
4806 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4807 will be ignored.
4808
4809 *'more'* *'nomore'*
4810'more' boolean (Vim default: on, Vi default: off)
4811 global
4812 {not in Vi}
4813 When on, listings pause when the whole screen is filled. You will get
4814 the |more-prompt|. When this option is off there are no pauses, the
4815 listing continues until finished.
4816 NOTE: This option is set to the Vi default value when 'compatible' is
4817 set and to the Vim default value when 'compatible' is reset.
4818
4819 *'mouse'* *E538*
4820'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4821 global
4822 {not in Vi}
4823 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004824 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4825 sysmouse and Linux console with gpm). For using the mouse in the
4826 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004827 The mouse can be enabled for different modes:
4828 n Normal mode
4829 v Visual mode
4830 i Insert mode
4831 c Command-line mode
4832 h all previous modes when editing a help file
4833 a all previous modes
4834 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 Normally you would enable the mouse in all four modes with: >
4836 :set mouse=a
4837< When the mouse is not enabled, the GUI will still use the mouse for
4838 modeless selection. This doesn't move the text cursor.
4839
4840 See |mouse-using|. Also see |'clipboard'|.
4841
4842 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004843 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 the mouse buttons can still be used by keeping the shift key pressed.
4845 Also see the 'clipboard' option.
4846
4847 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4848'mousefocus' 'mousef' boolean (default off)
4849 global
4850 {not in Vi}
4851 {only works in the GUI}
4852 The window that the mouse pointer is on is automatically activated.
4853 When changing the window layout or window focus in another way, the
4854 mouse pointer is moved to the window with keyboard focus. Off is the
4855 default because it makes using the pull down menus a little goofy, as
4856 a pointer transit may activate a window unintentionally.
4857
4858 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4859'mousehide' 'mh' boolean (default on)
4860 global
4861 {not in Vi}
4862 {only works in the GUI}
4863 When on, the mouse pointer is hidden when characters are typed.
4864 The mouse pointer is restored when the mouse is moved.
4865
4866 *'mousemodel'* *'mousem'*
4867'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4868 global
4869 {not in Vi}
4870 Sets the model to use for the mouse. The name mostly specifies what
4871 the right mouse button is used for:
4872 extend Right mouse button extends a selection. This works
4873 like in an xterm.
4874 popup Right mouse button pops up a menu. The shifted left
4875 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004876 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 popup_setpos Like "popup", but the cursor will be moved to the
4878 position where the mouse was clicked, and thus the
4879 selected operation will act upon the clicked object.
4880 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004881 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882 course, that right clicking outside a selection will
4883 end Visual mode.
4884 Overview of what button does what for each model:
4885 mouse extend popup(_setpos) ~
4886 left click place cursor place cursor
4887 left drag start selection start selection
4888 shift-left search word extend selection
4889 right click extend selection popup menu (place cursor)
4890 right drag extend selection -
4891 middle click paste paste
4892
4893 In the "popup" model the right mouse button produces a pop-up menu.
4894 You need to define this first, see |popup-menu|.
4895
4896 Note that you can further refine the meaning of buttons with mappings.
4897 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4898 selection (because that's handled in the GUI code directly).
4899
4900 The 'mousemodel' option is set by the |:behave| command.
4901
4902 *'mouseshape'* *'mouses'* *E547*
4903'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004904 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905 global
4906 {not in Vi}
4907 {only available when compiled with the |+mouseshape|
4908 feature}
4909 This option tells Vim what the mouse pointer should look like in
4910 different modes. The option is a comma separated list of parts, much
4911 like used for 'guicursor'. Each part consist of a mode/location-list
4912 and an argument-list:
4913 mode-list:shape,mode-list:shape,..
4914 The mode-list is a dash separated list of these modes/locations:
4915 In a normal window: ~
4916 n Normal mode
4917 v Visual mode
4918 ve Visual mode with 'selection' "exclusive" (same as 'v',
4919 if not specified)
4920 o Operator-pending mode
4921 i Insert mode
4922 r Replace mode
4923
4924 Others: ~
4925 c appending to the command-line
4926 ci inserting in the command-line
4927 cr replacing in the command-line
4928 m at the 'Hit ENTER' or 'More' prompts
4929 ml idem, but cursor in the last line
4930 e any mode, pointer below last window
4931 s any mode, pointer on a status line
4932 sd any mode, while dragging a status line
4933 vs any mode, pointer on a vertical separator line
4934 vd any mode, while dragging a vertical separator line
4935 a everywhere
4936
4937 The shape is one of the following:
4938 avail name looks like ~
4939 w x arrow Normal mouse pointer
4940 w x blank no pointer at all (use with care!)
4941 w x beam I-beam
4942 w x updown up-down sizing arrows
4943 w x leftright left-right sizing arrows
4944 w x busy The system's usual busy pointer
4945 w x no The system's usual 'no input' pointer
4946 x udsizing indicates up-down resizing
4947 x lrsizing indicates left-right resizing
4948 x crosshair like a big thin +
4949 x hand1 black hand
4950 x hand2 white hand
4951 x pencil what you write with
4952 x question big ?
4953 x rightup-arrow arrow pointing right-up
4954 w x up-arrow arrow pointing up
4955 x <number> any X11 pointer number (see X11/cursorfont.h)
4956
4957 The "avail" column contains a 'w' if the shape is available for Win32,
4958 x for X11.
4959 Any modes not specified or shapes not available use the normal mouse
4960 pointer.
4961
4962 Example: >
4963 :set mouseshape=s:udsizing,m:no
4964< will make the mouse turn to a sizing arrow over the status lines and
4965 indicate no input when the hit-enter prompt is displayed (since
4966 clicking the mouse has no effect in this state.)
4967
4968 *'mousetime'* *'mouset'*
4969'mousetime' 'mouset' number (default 500)
4970 global
4971 {not in Vi}
4972 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4973 time in msec between two mouse clicks for the second click to be
4974 recognized as a multi click.
4975
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004976 *'mzquantum'* *'mzq'*
4977'mzquantum' 'mzq' number (default 100)
4978 global
4979 {not in Vi}
4980 {not available when compiled without the |+mzscheme|
4981 feature}
4982 The number of milliseconds between polls for MzScheme threads.
4983 Negative or zero value means no thread scheduling.
4984
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985 *'nrformats'* *'nf'*
4986'nrformats' 'nf' string (default "octal,hex")
4987 local to buffer
4988 {not in Vi}
4989 This defines what bases Vim will consider for numbers when using the
4990 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4991 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004992 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02004994 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00004995 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004997 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 considered to be hexadecimal. Example: Using CTRL-X on
4999 "0x100" results in "0x0ff".
5000 Numbers which simply begin with a digit in the range 1-9 are always
5001 considered decimal. This also happens for numbers that are not
5002 recognized as octal or hex.
5003
5004 *'number'* *'nu'* *'nonumber'* *'nonu'*
5005'number' 'nu' boolean (default off)
5006 local to window
5007 Print the line number in front of each line. When the 'n' option is
5008 excluded from 'cpoptions' a wrapped line will not use the column of
5009 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005010 The 'numberwidth' option can be used to set the room used for the line
5011 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 When a long, wrapped line doesn't start with the first character, '-'
5013 characters are put before the number.
5014 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005015 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005017 *'numberwidth'* *'nuw'*
5018'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5019 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005020 {not in Vi}
5021 {only available when compiled with the |+linebreak|
5022 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005023 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005024 when the 'number' or 'relativenumber' option is set or printing lines
5025 with a line number. Since one space is always between the number and
5026 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005027 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005028 fit the highest line number in the buffer respectively the number of
5029 rows in the window, depending on whether 'number' or 'relativenumber'
5030 is set. Thus with the Vim default of 4 there is room for a line number
5031 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005032 The minimum value is 1, the maximum value is 10.
5033 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5034
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005035 *'omnifunc'* *'ofu'*
5036'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005037 local to buffer
5038 {not in Vi}
5039 {not available when compiled without the +eval
5040 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005041 This option specifies a function to be used for Insert mode omni
5042 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005043 See |complete-functions| for an explanation of how the function is
5044 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005045 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005046 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005047
5048
Bram Moolenaar02467872007-05-06 13:22:01 +00005049 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005050'opendevice' 'odev' boolean (default off)
5051 global
5052 {not in Vi}
5053 {only for MS-DOS, MS-Windows and OS/2}
5054 Enable reading and writing from devices. This may get Vim stuck on a
5055 device that can be opened but doesn't actually do the I/O. Therefore
5056 it is off by default.
5057 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5058 result in editing a device.
5059
5060
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005061 *'operatorfunc'* *'opfunc'*
5062'operatorfunc' 'opfunc' string (default: empty)
5063 global
5064 {not in Vi}
5065 This option specifies a function to be called by the |g@| operator.
5066 See |:map-operator| for more info and an example.
5067
5068 This option cannot be set from a |modeline| or in the |sandbox|, for
5069 security reasons.
5070
5071
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 *'osfiletype'* *'oft'* *E366*
5073'osfiletype' 'oft' string (RISC-OS default: "Text",
5074 others default: "")
5075 local to buffer
5076 {not in Vi}
5077 {only available when compiled with the |+osfiletype|
5078 feature}
5079 Some operating systems store extra information about files besides
5080 name, datestamp and permissions. This option contains the extra
5081 information, the nature of which will vary between systems.
5082 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005083 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 It can affect the pattern matching of the automatic commands.
5085 |autocmd-osfiletypes|
5086
5087 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005088'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 global
5090 Specifies the nroff macros that separate paragraphs. These are pairs
5091 of two letters (see |object-motions|).
5092
5093 *'paste'* *'nopaste'*
5094'paste' boolean (default off)
5095 global
5096 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005097 Put Vim in Paste mode. This is useful if you want to cut or copy
5098 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099 unexpected effects.
5100 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005101 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 knows about pasting and will mostly do the right thing without 'paste'
5103 being set. The same is true for a terminal where Vim handles the
5104 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005105 This option is reset when starting the GUI. Thus if you set it in
5106 your .vimrc it will work in a terminal, but not in the GUI. Setting
5107 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5108 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109 When the 'paste' option is switched on (also when it was already on):
5110 - mapping in Insert mode and Command-line mode is disabled
5111 - abbreviations are disabled
5112 - 'textwidth' is set to 0
5113 - 'wrapmargin' is set to 0
5114 - 'autoindent' is reset
5115 - 'smartindent' is reset
5116 - 'softtabstop' is set to 0
5117 - 'revins' is reset
5118 - 'ruler' is reset
5119 - 'showmatch' is reset
5120 - 'formatoptions' is used like it is empty
5121 These options keep their value, but their effect is disabled:
5122 - 'lisp'
5123 - 'indentexpr'
5124 - 'cindent'
5125 NOTE: When you start editing another file while the 'paste' option is
5126 on, settings from the modelines or autocommands may change the
5127 settings again, causing trouble when pasting text. You might want to
5128 set the 'paste' option again.
5129 When the 'paste' option is reset the mentioned options are restored to
5130 the value before the moment 'paste' was switched from off to on.
5131 Resetting 'paste' before ever setting it does not have any effect.
5132 Since mapping doesn't work while 'paste' is active, you need to use
5133 the 'pastetoggle' option to toggle the 'paste' option with some key.
5134
5135 *'pastetoggle'* *'pt'*
5136'pastetoggle' 'pt' string (default "")
5137 global
5138 {not in Vi}
5139 When non-empty, specifies the key sequence that toggles the 'paste'
5140 option. This is like specifying a mapping: >
5141 :map {keys} :set invpaste<CR>
5142< Where {keys} is the value of 'pastetoggle'.
5143 The difference is that it will work even when 'paste' is set.
5144 'pastetoggle' works in Insert mode and Normal mode, but not in
5145 Command-line mode.
5146 Mappings are checked first, thus overrule 'pastetoggle'. However,
5147 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5148 this: >
5149 :map <F10> :set paste<CR>
5150 :map <F11> :set nopaste<CR>
5151 :imap <F10> <C-O>:set paste<CR>
5152 :imap <F11> <nop>
5153 :set pastetoggle=<F11>
5154< This will make <F10> start paste mode and <F11> stop paste mode.
5155 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5156 mode everything is inserted literally, except the 'pastetoggle' key
5157 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005158 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159
5160 *'pex'* *'patchexpr'*
5161'patchexpr' 'pex' string (default "")
5162 global
5163 {not in Vi}
5164 {not available when compiled without the |+diff|
5165 feature}
5166 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005167 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168
5169 *'patchmode'* *'pm'* *E206*
5170'patchmode' 'pm' string (default "")
5171 global
5172 {not in Vi}
5173 When non-empty the oldest version of a file is kept. This can be used
5174 to keep the original version of a file if you are changing files in a
5175 source distribution. Only the first time that a file is written a
5176 copy of the original file will be kept. The name of the copy is the
5177 name of the original file with the string in the 'patchmode' option
5178 appended. This option should start with a dot. Use a string like
5179 ".org". 'backupdir' must not be empty for this to work (Detail: The
5180 backup file is renamed to the patchmode file after the new file has
5181 been successfully written, that's why it must be possible to write a
5182 backup file). If there was no file to be backed up, an empty file is
5183 created.
5184 When the 'backupskip' pattern matches, a patchmode file is not made.
5185 Using 'patchmode' for compressed files appends the extension at the
5186 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5187 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005188 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189
5190 *'path'* *'pa'* *E343* *E345* *E347*
5191'path' 'pa' string (default on Unix: ".,/usr/include,,"
5192 on OS/2: ".,/emx/include,,"
5193 other systems: ".,,")
5194 global or local to buffer |global-local|
5195 {not in Vi}
5196 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005197 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5198 provided that the file being searched for has a relative path (not
5199 starting with "/", "./" or "../"). The directories in the 'path'
5200 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201 - Use commas to separate directory names: >
5202 :set path=.,/usr/local/include,/usr/include
5203< - Spaces can also be used to separate directory names (for backwards
5204 compatibility with version 3.0). To have a space in a directory
5205 name, precede it with an extra backslash, and escape the space: >
5206 :set path=.,/dir/with\\\ space
5207< - To include a comma in a directory name precede it with an extra
5208 backslash: >
5209 :set path=.,/dir/with\\,comma
5210< - To search relative to the directory of the current file, use: >
5211 :set path=.
5212< - To search in the current directory use an empty string between two
5213 commas: >
5214 :set path=,,
5215< - A directory name may end in a ':' or '/'.
5216 - Environment variables are expanded |:set_env|.
5217 - When using |netrw.vim| URLs can be used. For example, adding
5218 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005219 - Search upwards and downwards in a directory tree using "*", "**" and
5220 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 {not available when compiled without the |+path_extra| feature}
5222 - Careful with '\' characters, type two to get one in the option: >
5223 :set path=.,c:\\include
5224< Or just use '/' instead: >
5225 :set path=.,c:/include
5226< Don't forget "." or files won't even be found in the same directory as
5227 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005228 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229 it is something like 256 or 1024 characters.
5230 You can check if all the include files are found, using the value of
5231 'path', see |:checkpath|.
5232 The use of |:set+=| and |:set-=| is preferred when adding or removing
5233 directories from the list. This avoids problems when a future version
5234 uses another default. To remove the current directory use: >
5235 :set path-=
5236< To add the current directory use: >
5237 :set path+=
5238< To use an environment variable, you probably need to replace the
5239 separator. Here is an example to append $INCL, in which directory
5240 names are separated with a semi-colon: >
5241 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5242< Replace the ';' with a ':' or whatever separator is used. Note that
5243 this doesn't work when $INCL contains a comma or white space.
5244
5245 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5246'preserveindent' 'pi' boolean (default off)
5247 local to buffer
5248 {not in Vi}
5249 When changing the indent of the current line, preserve as much of the
5250 indent structure as possible. Normally the indent is replaced by a
5251 series of tabs followed by spaces as required (unless |'expandtab'| is
5252 enabled, in which case only spaces are used). Enabling this option
5253 means the indent will preserve as many existing characters as possible
5254 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005255 'expandtab' does not apply to the preserved white space, a Tab remains
5256 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257 NOTE: When using ">>" multiple times the resulting indent is a mix of
5258 tabs and spaces. You might not like this.
5259 NOTE: 'preserveindent' is reset when 'compatible' is set.
5260 Also see 'copyindent'.
5261 Use |:retab| to clean up white space.
5262
5263 *'previewheight'* *'pvh'*
5264'previewheight' 'pvh' number (default 12)
5265 global
5266 {not in Vi}
5267 {not available when compiled without the |+windows| or
5268 |+quickfix| feature}
5269 Default height for a preview window. Used for |:ptag| and associated
5270 commands. Used for |CTRL-W_}| when no count is given.
5271
5272 *'previewwindow'* *'nopreviewwindow'*
5273 *'pvw'* *'nopvw'* *E590*
5274'previewwindow' 'pvw' boolean (default off)
5275 local to window
5276 {not in Vi}
5277 {not available when compiled without the |+windows| or
5278 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005279 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 set. It's normally not set directly, but by using one of the commands
5281 |:ptag|, |:pedit|, etc.
5282
5283 *'printdevice'* *'pdev'*
5284'printdevice' 'pdev' string (default empty)
5285 global
5286 {not in Vi}
5287 {only available when compiled with the |+printer|
5288 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005289 The name of the printer to be used for |:hardcopy|.
5290 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005291 This option cannot be set from a |modeline| or in the |sandbox|, for
5292 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293
Bram Moolenaar8299df92004-07-10 09:47:34 +00005294 *'printencoding'* *'penc'*
5295'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005296 global
5297 {not in Vi}
5298 {only available when compiled with the |+printer|
5299 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005300 Sets the character encoding used when printing.
5301 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005302
5303 *'printexpr'* *'pexpr'*
5304'printexpr' 'pexpr' String (default: see below)
5305 global
5306 {not in Vi}
5307 {only available when compiled with the |+printer|
5308 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005309 Expression used to print the PostScript produced with |:hardcopy|.
5310 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311
Bram Moolenaar8299df92004-07-10 09:47:34 +00005312 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313'printfont' 'pfn' string (default "courier")
5314 global
5315 {not in Vi}
5316 {only available when compiled with the |+printer|
5317 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005318 The name of the font that will be used for |:hardcopy|.
5319 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320
5321 *'printheader'* *'pheader'*
5322'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5323 global
5324 {not in Vi}
5325 {only available when compiled with the |+printer|
5326 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005327 The format of the header produced in |:hardcopy| output.
5328 See |pheader-option|.
5329
5330 *'printmbcharset'* *'pmbcs'*
5331'printmbcharset' 'pmbcs' string (default "")
5332 global
5333 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005334 {only available when compiled with the |+printer|,
5335 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005336 The CJK character set to be used for CJK output from |:hardcopy|.
5337 See |pmbcs-option|.
5338
5339 *'printmbfont'* *'pmbfn'*
5340'printmbfont' 'pmbfn' string (default "")
5341 global
5342 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005343 {only available when compiled with the |+printer|,
5344 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005345 List of font names to be used for CJK output from |:hardcopy|.
5346 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347
5348 *'printoptions'* *'popt'*
5349'printoptions' 'popt' string (default "")
5350 global
5351 {not in Vi}
5352 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005353 List of items that control the format of the output of |:hardcopy|.
5354 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005356 *'prompt'* *'noprompt'*
5357'prompt' boolean (default on)
5358 global
5359 When on a ":" prompt is used in Ex mode.
5360
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005361 *'pumheight'* *'ph'*
5362'pumheight' 'ph' number (default 0)
5363 global
5364 {not available when compiled without the
5365 |+insert_expand| feature}
5366 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005367 Determines the maximum number of items to show in the popup menu for
5368 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005369 |ins-completion-menu|.
5370
5371
Bram Moolenaar677ee682005-01-27 14:41:15 +00005372 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005373'quoteescape' 'qe' string (default "\")
5374 local to buffer
5375 {not in Vi}
5376 The characters that are used to escape quotes in a string. Used for
5377 objects like a', a" and a` |a'|.
5378 When one of the characters in this option is found inside a string,
5379 the following character will be skipped. The default value makes the
5380 text "foo\"bar\\" considered to be one string.
5381
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5383'readonly' 'ro' boolean (default off)
5384 local to buffer
5385 If on, writes fail unless you use a '!'. Protects you from
5386 accidentally overwriting a file. Default on when Vim is started
5387 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005388 When using ":w!" the 'readonly' option is reset for the current
5389 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005391 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005393 *'redrawtime'* *'rdt'*
5394'redrawtime' 'rdt' number (default 2000)
5395 global
5396 {not in Vi}
5397 {only available when compiled with the |+reltime|
5398 feature}
5399 The time in milliseconds for redrawing the display. This applies to
5400 searching for patterns for 'hlsearch' and |:match| highlighting.
5401 When redrawing takes more than this many milliseconds no further
5402 matches will be highlighted. This is used to avoid that Vim hangs
5403 when using a very complicated pattern.
5404
Bram Moolenaar64486672010-05-16 15:46:46 +02005405 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5406'relativenumber' 'rnu' boolean (default off)
5407 local to window
5408 {not in Vi}
5409 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005410 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005411 precede some vertical motion commands (e.g. j k + -) with, without
5412 having to calculate it yourself. Especially useful in combination with
5413 other commands (e.g. y d c < > gq gw =).
5414 When the 'n' option is excluded from 'cpoptions' a wrapped
5415 line will not use the column of line numbers (this is the default when
5416 'compatible' isn't set).
5417 The 'numberwidth' option can be used to set the room used for the line
5418 number.
5419 When a long, wrapped line doesn't start with the first character, '-'
5420 characters are put before the number.
5421 See |hl-LineNr| for the highlighting used for the number.
5422 When setting this option, 'number' is reset.
5423
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424 *'remap'* *'noremap'*
5425'remap' boolean (default on)
5426 global
5427 Allows for mappings to work recursively. If you do not want this for
5428 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005429 NOTE: To avoid portability problems with Vim scripts, always keep
5430 this option at the default "on". Only switch it off when working with
5431 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432
5433 *'report'*
5434'report' number (default 2)
5435 global
5436 Threshold for reporting number of lines changed. When the number of
5437 changed lines is more than 'report' a message will be given for most
5438 ":" commands. If you want it always, set 'report' to 0.
5439 For the ":substitute" command the number of substitutions is used
5440 instead of the number of lines.
5441
5442 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5443'restorescreen' 'rs' boolean (default on)
5444 global
5445 {not in Vi} {only in Windows 95/NT console version}
5446 When set, the screen contents is restored when exiting Vim. This also
5447 happens when executing external commands.
5448
5449 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5450 options in your .vimrc. To disable restoring:
5451 set t_ti= t_te=
5452 To enable restoring (for an xterm):
5453 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5454 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5455
5456 *'revins'* *'ri'* *'norevins'* *'nori'*
5457'revins' 'ri' boolean (default off)
5458 global
5459 {not in Vi}
5460 {only available when compiled with the |+rightleft|
5461 feature}
5462 Inserting characters in Insert mode will work backwards. See "typing
5463 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5464 command in Insert mode, when 'allowrevins' is set.
5465 NOTE: This option is reset when 'compatible' or 'paste' is set.
5466
5467 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5468'rightleft' 'rl' boolean (default off)
5469 local to window
5470 {not in Vi}
5471 {only available when compiled with the |+rightleft|
5472 feature}
5473 When on, display orientation becomes right-to-left, i.e., characters
5474 that are stored in the file appear from the right to the left.
5475 Using this option, it is possible to edit files for languages that
5476 are written from the right to the left such as Hebrew and Arabic.
5477 This option is per window, so it is possible to edit mixed files
5478 simultaneously, or to view the same file in both ways (this is
5479 useful whenever you have a mixed text file with both right-to-left
5480 and left-to-right strings so that both sets are displayed properly
5481 in different windows). Also see |rileft.txt|.
5482
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005483 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484'rightleftcmd' 'rlc' string (default "search")
5485 local to window
5486 {not in Vi}
5487 {only available when compiled with the |+rightleft|
5488 feature}
5489 Each word in this option enables the command line editing to work in
5490 right-to-left mode for a group of commands:
5491
5492 search "/" and "?" commands
5493
5494 This is useful for languages such as Hebrew, Arabic and Farsi.
5495 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5496
5497 *'ruler'* *'ru'* *'noruler'* *'noru'*
5498'ruler' 'ru' boolean (default off)
5499 global
5500 {not in Vi}
5501 {not available when compiled without the
5502 |+cmdline_info| feature}
5503 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005504 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 text in the file is shown on the far right:
5506 Top first line is visible
5507 Bot last line is visible
5508 All first and last line are visible
5509 45% relative position in the file
5510 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005511 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005513 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514 this option takes precedence over 'ruler' and 'rulerformat'
5515 If the number of characters displayed is different from the number of
5516 bytes in the text (e.g., for a TAB or a multi-byte character), both
5517 the text column (byte number) and the screen column are shown,
5518 separated with a dash.
5519 For an empty line "0-1" is shown.
5520 For an empty buffer the line number will also be zero: "0,0-1".
5521 This option is reset when the 'paste' option is set.
5522 If you don't want to see the ruler all the time but want to know where
5523 you are, use "g CTRL-G" |g_CTRL-G|.
5524 NOTE: This option is reset when 'compatible' is set.
5525
5526 *'rulerformat'* *'ruf'*
5527'rulerformat' 'ruf' string (default empty)
5528 global
5529 {not in Vi}
5530 {not available when compiled without the |+statusline|
5531 feature}
5532 When this option is not empty, it determines the content of the ruler
5533 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005534 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 The default ruler width is 17 characters. To make the ruler 15
5536 characters wide, put "%15(" at the start and "%)" at the end.
5537 Example: >
5538 :set rulerformat=%15(%c%V\ %p%%%)
5539<
5540 *'runtimepath'* *'rtp'* *vimfiles*
5541'runtimepath' 'rtp' string (default:
5542 Unix: "$HOME/.vim,
5543 $VIM/vimfiles,
5544 $VIMRUNTIME,
5545 $VIM/vimfiles/after,
5546 $HOME/.vim/after"
5547 Amiga: "home:vimfiles,
5548 $VIM/vimfiles,
5549 $VIMRUNTIME,
5550 $VIM/vimfiles/after,
5551 home:vimfiles/after"
5552 PC, OS/2: "$HOME/vimfiles,
5553 $VIM/vimfiles,
5554 $VIMRUNTIME,
5555 $VIM/vimfiles/after,
5556 $HOME/vimfiles/after"
5557 Macintosh: "$VIM:vimfiles,
5558 $VIMRUNTIME,
5559 $VIM:vimfiles:after"
5560 RISC-OS: "Choices:vimfiles,
5561 $VIMRUNTIME,
5562 Choices:vimfiles/after"
5563 VMS: "sys$login:vimfiles,
5564 $VIM/vimfiles,
5565 $VIMRUNTIME,
5566 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005567 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 global
5569 {not in Vi}
5570 This is a list of directories which will be searched for runtime
5571 files:
5572 filetype.vim filetypes by file name |new-filetype|
5573 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005574 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005575 colors/ color scheme files |:colorscheme|
5576 compiler/ compiler files |:compiler|
5577 doc/ documentation |write-local-help|
5578 ftplugin/ filetype plugins |write-filetype-plugin|
5579 indent/ indent scripts |indent-expression|
5580 keymap/ key mapping files |mbyte-keymap|
5581 lang/ menu translations |:menutrans|
5582 menu.vim GUI menus |menu.vim|
5583 plugin/ plugin scripts |write-plugin|
5584 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005585 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586 syntax/ syntax files |mysyntaxfile|
5587 tutor/ files for vimtutor |tutor|
5588
5589 And any other file searched for with the |:runtime| command.
5590
5591 The defaults for most systems are setup to search five locations:
5592 1. In your home directory, for your personal preferences.
5593 2. In a system-wide Vim directory, for preferences from the system
5594 administrator.
5595 3. In $VIMRUNTIME, for files distributed with Vim.
5596 *after-directory*
5597 4. In the "after" directory in the system-wide Vim directory. This is
5598 for the system administrator to overrule or add to the distributed
5599 defaults (rarely needed)
5600 5. In the "after" directory in your home directory. This is for
5601 personal preferences to overrule or add to the distributed defaults
5602 or system-wide settings (rarely needed).
5603
5604 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5605 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005606 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 wildcards.
5608 See |:runtime|.
5609 Example: >
5610 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5611< This will use the directory "~/vimruntime" first (containing your
5612 personal Vim runtime files), then "/mygroup/vim" (shared between a
5613 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5614 files).
5615 You probably should always include $VIMRUNTIME somewhere, to use the
5616 distributed runtime files. You can put a directory before $VIMRUNTIME
5617 to find files which replace a distributed runtime files. You can put
5618 a directory after $VIMRUNTIME to find files which add to distributed
5619 runtime files.
5620 This option cannot be set from a |modeline| or in the |sandbox|, for
5621 security reasons.
5622
5623 *'scroll'* *'scr'*
5624'scroll' 'scr' number (default: half the window height)
5625 local to window
5626 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5627 set to half the number of lines in the window when the window size
5628 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005629 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5631 the number of screen lines instead of file lines, makes a difference
5632 when lines wrap}
5633
5634 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5635'scrollbind' 'scb' boolean (default off)
5636 local to window
5637 {not in Vi}
5638 {not available when compiled without the |+scrollbind|
5639 feature}
5640 See also |scroll-binding|. When this option is set, the current
5641 window scrolls as other scrollbind windows (windows that also have
5642 this option set) scroll. This option is useful for viewing the
5643 differences between two versions of a file, see 'diff'.
5644 See |'scrollopt'| for options that determine how this option should be
5645 interpreted.
5646 This option is mostly reset when splitting a window to edit another
5647 file. This means that ":split | edit file" results in two windows
5648 with scroll-binding, but ":split file" does not.
5649
5650 *'scrolljump'* *'sj'*
5651'scrolljump' 'sj' number (default 1)
5652 global
5653 {not in Vi}
5654 Minimal number of lines to scroll when the cursor gets off the
5655 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5656 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005657 When set to a negative number from -1 to -100 this is used as the
5658 percentage of the window height. Thus -50 scrolls half the window
5659 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005660 NOTE: This option is set to 1 when 'compatible' is set.
5661
5662 *'scrolloff'* *'so'*
5663'scrolloff' 'so' number (default 0)
5664 global
5665 {not in Vi}
5666 Minimal number of screen lines to keep above and below the cursor.
5667 This will make some context visible around where you are working. If
5668 you set it to a very large value (999) the cursor line will always be
5669 in the middle of the window (except at the start or end of the file or
5670 when long lines wrap).
5671 For scrolling horizontally see 'sidescrolloff'.
5672 NOTE: This option is set to 0 when 'compatible' is set.
5673
5674 *'scrollopt'* *'sbo'*
5675'scrollopt' 'sbo' string (default "ver,jump")
5676 global
5677 {not available when compiled without the |+scrollbind|
5678 feature}
5679 {not in Vi}
5680 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005681 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5682 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005683 The following words are available:
5684 ver Bind vertical scrolling for 'scrollbind' windows
5685 hor Bind horizontal scrolling for 'scrollbind' windows
5686 jump Applies to the offset between two windows for vertical
5687 scrolling. This offset is the difference in the first
5688 displayed line of the bound windows. When moving
5689 around in a window, another 'scrollbind' window may
5690 reach a position before the start or after the end of
5691 the buffer. The offset is not changed though, when
5692 moving back the 'scrollbind' window will try to scroll
5693 to the desired position when possible.
5694 When now making that window the current one, two
5695 things can be done with the relative offset:
5696 1. When "jump" is not included, the relative offset is
5697 adjusted for the scroll position in the new current
5698 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005699 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 2. When "jump" is included, the other windows are
5701 scrolled to keep the same relative offset. When
5702 going back to the other window, it still uses the
5703 same relative offset.
5704 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005705 When 'diff' mode is active there always is vertical scroll binding,
5706 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707
5708 *'sections'* *'sect'*
5709'sections' 'sect' string (default "SHNHH HUnhsh")
5710 global
5711 Specifies the nroff macros that separate sections. These are pairs of
5712 two letters (See |object-motions|). The default makes a section start
5713 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5714
5715 *'secure'* *'nosecure'* *E523*
5716'secure' boolean (default off)
5717 global
5718 {not in Vi}
5719 When on, ":autocmd", shell and write commands are not allowed in
5720 ".vimrc" and ".exrc" in the current directory and map commands are
5721 displayed. Switch it off only if you know that you will not run into
5722 problems, or when the 'exrc' option is off. On Unix this option is
5723 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005724 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725 'secure' at the end of your ~/.vimrc then.
5726 This option cannot be set from a |modeline| or in the |sandbox|, for
5727 security reasons.
5728
5729 *'selection'* *'sel'*
5730'selection' 'sel' string (default "inclusive")
5731 global
5732 {not in Vi}
5733 This option defines the behavior of the selection. It is only used
5734 in Visual and Select mode.
5735 Possible values:
5736 value past line inclusive ~
5737 old no yes
5738 inclusive yes yes
5739 exclusive yes no
5740 "past line" means that the cursor is allowed to be positioned one
5741 character past the line.
5742 "inclusive" means that the last character of the selection is included
5743 in an operation. For example, when "x" is used to delete the
5744 selection.
5745 Note that when "exclusive" is used and selecting from the end
5746 backwards, you cannot include the last character of a line, when
5747 starting in Normal mode and 'virtualedit' empty.
5748
5749 The 'selection' option is set by the |:behave| command.
5750
5751 *'selectmode'* *'slm'*
5752'selectmode' 'slm' string (default "")
5753 global
5754 {not in Vi}
5755 This is a comma separated list of words, which specifies when to start
5756 Select mode instead of Visual mode, when a selection is started.
5757 Possible values:
5758 mouse when using the mouse
5759 key when using shifted special keys
5760 cmd when using "v", "V" or CTRL-V
5761 See |Select-mode|.
5762 The 'selectmode' option is set by the |:behave| command.
5763
5764 *'sessionoptions'* *'ssop'*
5765'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005766 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 global
5768 {not in Vi}
5769 {not available when compiled without the +mksession
5770 feature}
5771 Changes the effect of the |:mksession| command. It is a comma
5772 separated list of words. Each word enables saving and restoring
5773 something:
5774 word save and restore ~
5775 blank empty windows
5776 buffers hidden and unloaded buffers, not just those in windows
5777 curdir the current directory
5778 folds manually created folds, opened/closed folds and local
5779 fold options
5780 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005781 and contain at least one lowercase letter. Only
5782 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 help the help window
5784 localoptions options and mappings local to a window or buffer (not
5785 global values for local options)
5786 options all options and mappings (also global values for local
5787 options)
5788 resize size of the Vim window: 'lines' and 'columns'
5789 sesdir the directory in which the session file is located
5790 will become the current directory (useful with
5791 projects accessed over a network from different
5792 systems)
5793 slash backslashes in file names replaced with forward
5794 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005795 tabpages all tab pages; without this only the current tab page
5796 is restored, so that you can make a session for each
5797 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005798 unix with Unix end-of-line format (single <NL>), even when
5799 on Windows or DOS
5800 winpos position of the whole Vim window
5801 winsize window sizes
5802
5803 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005804 When neither "curdir" nor "sesdir" is included, file names are stored
5805 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005806 "slash" and "unix" are useful on Windows when sharing session files
5807 with Unix. The Unix version of Vim cannot source dos format scripts,
5808 but the Windows version of Vim can source unix format scripts.
5809
5810 *'shell'* *'sh'* *E91*
5811'shell' 'sh' string (default $SHELL or "sh",
5812 MS-DOS and Win32: "command.com" or
5813 "cmd.exe", OS/2: "cmd")
5814 global
5815 Name of the shell to use for ! and :! commands. When changing the
5816 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5817 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005818 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819 See |option-backslash| about including spaces and backslashes.
5820 Environment variables are expanded |:set_env|.
5821 If the name of the shell contains a space, you might need to enclose
5822 it in quotes. Example: >
5823 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5824< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005825 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826 "-f" is not inside the quotes, because it is not part of the command
5827 name. And Vim automagically recognizes the backslashes that are path
5828 separators.
5829 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5830 variable to change the way external commands are executed. See the
5831 libc.inf file of DJGPP.
5832 Under MS-Windows, when the executable ends in ".com" it must be
5833 included. Thus setting the shell to "command.com" or "4dos.com"
5834 works, but "command" and "4dos" do not work for all commands (e.g.,
5835 filtering).
5836 For unknown reasons, when using "4dos.com" the current directory is
5837 changed to "C:\". To avoid this set 'shell' like this: >
5838 :set shell=command.com\ /c\ 4dos
5839< This option cannot be set from a |modeline| or in the |sandbox|, for
5840 security reasons.
5841
5842 *'shellcmdflag'* *'shcf'*
5843'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5844 does not contain "sh" somewhere: "/c")
5845 global
5846 {not in Vi}
5847 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5848 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5849 systems, the default is set according to the value of 'shell', to
5850 reduce the need to set this option by the user. It's not used for
5851 OS/2 (EMX figures this out itself). See |option-backslash| about
5852 including spaces and backslashes. See |dos-shell|.
5853 This option cannot be set from a |modeline| or in the |sandbox|, for
5854 security reasons.
5855
5856 *'shellpipe'* *'sp'*
5857'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5858 global
5859 {not in Vi}
5860 {not available when compiled without the |+quickfix|
5861 feature}
5862 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005863 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005864 including spaces and backslashes.
5865 The name of the temporary file can be represented by "%s" if necessary
5866 (the file name is appended automatically if no %s appears in the value
5867 of this option).
5868 For the Amiga and MS-DOS the default is ">". The output is directly
5869 saved in a file and not echoed to the screen.
5870 For Unix the default it "| tee". The stdout of the compiler is saved
5871 in a file and echoed to the screen. If the 'shell' option is "csh" or
5872 "tcsh" after initializations, the default becomes "|& tee". If the
5873 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005874 "2>&1| tee". This means that stderr is also included. Before using
5875 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005876 The initialization of this option is done after reading the ".vimrc"
5877 and the other initializations, so that when the 'shell' option is set
5878 there, the 'shellpipe' option changes automatically, unless it was
5879 explicitly set before.
5880 When 'shellpipe' is set to an empty string, no redirection of the
5881 ":make" output will be done. This is useful if you use a 'makeprg'
5882 that writes to 'makeef' by itself. If you want no piping, but do
5883 want to include the 'makeef', set 'shellpipe' to a single space.
5884 Don't forget to precede the space with a backslash: ":set sp=\ ".
5885 In the future pipes may be used for filtering and this option will
5886 become obsolete (at least for Unix).
5887 This option cannot be set from a |modeline| or in the |sandbox|, for
5888 security reasons.
5889
5890 *'shellquote'* *'shq'*
5891'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5892 contains "sh" somewhere: "\"")
5893 global
5894 {not in Vi}
5895 Quoting character(s), put around the command passed to the shell, for
5896 the "!" and ":!" commands. The redirection is kept outside of the
5897 quoting. See 'shellxquote' to include the redirection. It's
5898 probably not useful to set both options.
5899 This is an empty string by default. Only known to be useful for
5900 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5901 or bash, where it should be "\"". The default is adjusted according
5902 the value of 'shell', to reduce the need to set this option by the
5903 user. See |dos-shell|.
5904 This option cannot be set from a |modeline| or in the |sandbox|, for
5905 security reasons.
5906
5907 *'shellredir'* *'srr'*
5908'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5909 global
5910 {not in Vi}
5911 String to be used to put the output of a filter command in a temporary
5912 file. See also |:!|. See |option-backslash| about including spaces
5913 and backslashes.
5914 The name of the temporary file can be represented by "%s" if necessary
5915 (the file name is appended automatically if no %s appears in the value
5916 of this option).
5917 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5918 or "zsh" during initializations, the default becomes ">&". If the
5919 'shell' option is "sh", "ksh" or "bash" the default becomes
5920 ">%s 2>&1". This means that stderr is also included.
5921 For Win32, the Unix checks are done and additionally "cmd" is checked
5922 for, which makes the default ">%s 2>&1". Also, the same names with
5923 ".exe" appended are checked for.
5924 The initialization of this option is done after reading the ".vimrc"
5925 and the other initializations, so that when the 'shell' option is set
5926 there, the 'shellredir' option changes automatically unless it was
5927 explicitly set before.
5928 In the future pipes may be used for filtering and this option will
5929 become obsolete (at least for Unix).
5930 This option cannot be set from a |modeline| or in the |sandbox|, for
5931 security reasons.
5932
5933 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5934'shellslash' 'ssl' boolean (default off)
5935 global
5936 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5937 When set, a forward slash is used when expanding file names. This is
5938 useful when a Unix-like shell is used instead of command.com or
5939 cmd.exe. Backward slashes can still be typed, but they are changed to
5940 forward slashes by Vim.
5941 Note that setting or resetting this option has no effect for some
5942 existing file names, thus this option needs to be set before opening
5943 any file for best results. This might change in the future.
5944 'shellslash' only works when a backslash can be used as a path
5945 separator. To test if this is so use: >
5946 if exists('+shellslash')
5947<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005948 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5949'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5950 global
5951 {not in Vi}
5952 When on, use temp files for shell commands. When off use a pipe.
5953 When using a pipe is not possible temp files are used anyway.
5954 Currently a pipe is only supported on Unix. You can check it with: >
5955 :if has("filterpipe")
5956< The advantage of using a pipe is that nobody can read the temp file
5957 and the 'shell' command does not need to support redirection.
5958 The advantage of using a temp file is that the file type and encoding
5959 can be detected.
5960 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5961 |FilterWritePost| autocommands event are not triggered when
5962 'shelltemp' is off.
5963
Bram Moolenaar071d4272004-06-13 20:20:40 +00005964 *'shelltype'* *'st'*
5965'shelltype' 'st' number (default 0)
5966 global
5967 {not in Vi} {only for the Amiga}
5968 On the Amiga this option influences the way how the commands work
5969 which use a shell.
5970 0 and 1: always use the shell
5971 2 and 3: use the shell only to filter lines
5972 4 and 5: use shell only for ':sh' command
5973 When not using the shell, the command is executed directly.
5974
5975 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5976 1 and 3: use "shell cmd" to start external commands
5977
5978 *'shellxquote'* *'sxq'*
5979'shellxquote' 'sxq' string (default: "";
5980 for Win32, when 'shell' contains "sh"
5981 somewhere: "\""
5982 for Unix, when using system(): "\"")
5983 global
5984 {not in Vi}
5985 Quoting character(s), put around the command passed to the shell, for
5986 the "!" and ":!" commands. Includes the redirection. See
5987 'shellquote' to exclude the redirection. It's probably not useful
5988 to set both options.
5989 This is an empty string by default. Known to be useful for
5990 third-party shells when using the Win32 version, such as the MKS Korn
5991 Shell or bash, where it should be "\"". The default is adjusted
5992 according the value of 'shell', to reduce the need to set this option
5993 by the user. See |dos-shell|.
5994 This option cannot be set from a |modeline| or in the |sandbox|, for
5995 security reasons.
5996
5997 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5998'shiftround' 'sr' boolean (default off)
5999 global
6000 {not in Vi}
6001 Round indent to multiple of 'shiftwidth'. Applies to > and <
6002 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6003 a multiple of 'shiftwidth' (this is Vi compatible).
6004 NOTE: This option is reset when 'compatible' is set.
6005
6006 *'shiftwidth'* *'sw'*
6007'shiftwidth' 'sw' number (default 8)
6008 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006009 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 |'cindent'|, |>>|, |<<|, etc.
6011
6012 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006013'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6014 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 global
6016 {not in Vi}
6017 This option helps to avoid all the |hit-enter| prompts caused by file
6018 messages, for example with CTRL-G, and to avoid some other messages.
6019 It is a list of flags:
6020 flag meaning when present ~
6021 f use "(3 of 5)" instead of "(file 3 of 5)"
6022 i use "[noeol]" instead of "[Incomplete last line]"
6023 l use "999L, 888C" instead of "999 lines, 888 characters"
6024 m use "[+]" instead of "[Modified]"
6025 n use "[New]" instead of "[New File]"
6026 r use "[RO]" instead of "[readonly]"
6027 w use "[w]" instead of "written" for file write message
6028 and "[a]" instead of "appended" for ':w >> file' command
6029 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6030 "[unix format]" and "[mac]" instead of "[mac format]".
6031 a all of the above abbreviations
6032
6033 o overwrite message for writing a file with subsequent message
6034 for reading a file (useful for ":wn" or when 'autowrite' on)
6035 O message for reading a file overwrites any previous message.
6036 Also for quickfix message (e.g., ":cn").
6037 s don't give "search hit BOTTOM, continuing at TOP" or "search
6038 hit TOP, continuing at BOTTOM" messages
6039 t truncate file message at the start if it is too long to fit
6040 on the command-line, "<" will appear in the left most column.
6041 Ignored in Ex mode.
6042 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006043 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044 Ignored in Ex mode.
6045 W don't give "written" or "[w]" when writing a file
6046 A don't give the "ATTENTION" message when an existing swap file
6047 is found.
6048 I don't give the intro message when starting Vim |:intro|.
6049
6050 This gives you the opportunity to avoid that a change between buffers
6051 requires you to hit <Enter>, but still gives as useful a message as
6052 possible for the space available. To get the whole message that you
6053 would have got with 'shm' empty, use ":file!"
6054 Useful values:
6055 shm= No abbreviation of message.
6056 shm=a Abbreviation, but no loss of information.
6057 shm=at Abbreviation, and truncate message when necessary.
6058
6059 NOTE: This option is set to the Vi default value when 'compatible' is
6060 set and to the Vim default value when 'compatible' is reset.
6061
6062 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6063'shortname' 'sn' boolean (default off)
6064 local to buffer
6065 {not in Vi, not in MS-DOS versions}
6066 Filenames are assumed to be 8 characters plus one extension of 3
6067 characters. Multiple dots in file names are not allowed. When this
6068 option is on, dots in file names are replaced with underscores when
6069 adding an extension (".~" or ".swp"). This option is not available
6070 for MS-DOS, because then it would always be on. This option is useful
6071 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6072 or crossdos. When running the Win32 GUI version under Win32s, this
6073 option is always on by default.
6074
6075 *'showbreak'* *'sbr'* *E595*
6076'showbreak' 'sbr' string (default "")
6077 global
6078 {not in Vi}
6079 {not available when compiled without the |+linebreak|
6080 feature}
6081 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006082 values are "> " or "+++ ": >
6083 :set showbreak=>\
6084< Note the backslash to escape the trailing space. It's easier like
6085 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006086 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006087< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006088 comma (in a future version the comma might be used to separate the
6089 part that is shown at the end and at the start of a line).
6090 The characters are highlighted according to the '@' flag in
6091 'highlight'.
6092 Note that tabs after the showbreak will be displayed differently.
6093 If you want the 'showbreak' to appear in between line numbers, add the
6094 "n" flag to 'cpoptions'.
6095
6096 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6097'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6098 off)
6099 global
6100 {not in Vi}
6101 {not available when compiled without the
6102 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006103 Show (partial) command in the last line of the screen. Set this
6104 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105 In Visual mode the size of the selected area is shown:
6106 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006107 If the number of bytes is different it is also displayed: "2-6"
6108 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006109 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006110 - When selecting a block, the size in screen characters:
6111 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006112 NOTE: This option is set to the Vi default value when 'compatible' is
6113 set and to the Vim default value when 'compatible' is reset.
6114
6115 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6116'showfulltag' 'sft' boolean (default off)
6117 global
6118 {not in Vi}
6119 When completing a word in insert mode (see |ins-completion|) from the
6120 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006121 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122 matched a C function, you can see a template for what arguments are
6123 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006124 Note that this doesn't work well together with having "longest" in
6125 'completeopt', because the completion from the search pattern may not
6126 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127
6128 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6129'showmatch' 'sm' boolean (default off)
6130 global
6131 When a bracket is inserted, briefly jump to the matching one. The
6132 jump is only done if the match can be seen on the screen. The time to
6133 show the match can be set with 'matchtime'.
6134 A Beep is given if there is no match (no matter if the match can be
6135 seen or not). This option is reset when the 'paste' option is set.
6136 When the 'm' flag is not included in 'cpoptions', typing a character
6137 will immediately move the cursor back to where it belongs.
6138 See the "sm" field in 'guicursor' for setting the cursor shape and
6139 blinking when showing the match.
6140 The 'matchpairs' option can be used to specify the characters to show
6141 matches for. 'rightleft' and 'revins' are used to look for opposite
6142 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006143 Also see the matchparen plugin for highlighting the match when moving
6144 around |pi_paren.txt|.
6145 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146
6147 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6148'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6149 global
6150 If in Insert, Replace or Visual mode put a message on the last line.
6151 Use the 'M' flag in 'highlight' to set the type of highlighting for
6152 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006153 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006154 doesn't mean XIM is really active, especially when 'imactivatekey' is
6155 not set.
6156 NOTE: This option is set to the Vi default value when 'compatible' is
6157 set and to the Vim default value when 'compatible' is reset.
6158
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006159 *'showtabline'* *'stal'*
6160'showtabline' 'stal' number (default 1)
6161 global
6162 {not in Vi}
6163 {not available when compiled without the +windows
6164 feature}
6165 The value of this option specifies when the line with tab page labels
6166 will be displayed:
6167 0: never
6168 1: only if there are at least two tab pages
6169 2: always
6170 This is both for the GUI and non-GUI implementation of the tab pages
6171 line.
6172 See |tab-page| for more information about tab pages.
6173
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 *'sidescroll'* *'ss'*
6175'sidescroll' 'ss' number (default 0)
6176 global
6177 {not in Vi}
6178 The minimal number of columns to scroll horizontally. Used only when
6179 the 'wrap' option is off and the cursor is moved off of the screen.
6180 When it is zero the cursor will be put in the middle of the screen.
6181 When using a slow terminal set it to a large number or 0. When using
6182 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6183 commands.
6184
6185 *'sidescrolloff'* *'siso'*
6186'sidescrolloff' 'siso' number (default 0)
6187 global
6188 {not in Vi}
6189 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006190 right of the cursor if 'nowrap' is set. Setting this option to a
6191 value greater than 0 while having |'sidescroll'| also at a non-zero
6192 value makes some context visible in the line you are scrolling in
6193 horizontally (except at beginning of the line). Setting this option
6194 to a large value (like 999) has the effect of keeping the cursor
6195 horizontally centered in the window, as long as one does not come too
6196 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 NOTE: This option is set to 0 when 'compatible' is set.
6198
6199 Example: Try this together with 'sidescroll' and 'listchars' as
6200 in the following example to never allow the cursor to move
6201 onto the "extends" character:
6202
6203 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6204 :set sidescrolloff=1
6205
6206
6207 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6208'smartcase' 'scs' boolean (default off)
6209 global
6210 {not in Vi}
6211 Override the 'ignorecase' option if the search pattern contains upper
6212 case characters. Only used when the search pattern is typed and
6213 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006214 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6216 recalling the search pattern from history and hitting <Enter>.
6217 NOTE: This option is reset when 'compatible' is set.
6218
6219 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6220'smartindent' 'si' boolean (default off)
6221 local to buffer
6222 {not in Vi}
6223 {not available when compiled without the
6224 |+smartindent| feature}
6225 Do smart autoindenting when starting a new line. Works for C-like
6226 programs, but can also be used for other languages. 'cindent' does
6227 something like this, works better in most cases, but is more strict,
6228 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6229 'indentexpr' is a more advanced alternative.
6230 Normally 'autoindent' should also be on when using 'smartindent'.
6231 An indent is automatically inserted:
6232 - After a line ending in '{'.
6233 - After a line starting with a keyword from 'cinwords'.
6234 - Before a line starting with '}' (only with the "O" command).
6235 When typing '}' as the first character in a new line, that line is
6236 given the same indent as the matching '{'.
6237 When typing '#' as the first character in a new line, the indent for
6238 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006239 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006240 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6241 When using the ">>" command, lines starting with '#' are not shifted
6242 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006243 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244 is set smart indenting is disabled.
6245
6246 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6247'smarttab' 'sta' boolean (default off)
6248 global
6249 {not in Vi}
6250 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006251 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6252 <BS> will delete a 'shiftwidth' worth of space at the start of the
6253 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006254 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006255 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6256 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006257 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006259 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 NOTE: This option is reset when 'compatible' is set.
6261
6262 *'softtabstop'* *'sts'*
6263'softtabstop' 'sts' number (default 0)
6264 local to buffer
6265 {not in Vi}
6266 Number of spaces that a <Tab> counts for while performing editing
6267 operations, like inserting a <Tab> or using <BS>. It "feels" like
6268 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6269 used. This is useful to keep the 'ts' setting at its standard value
6270 of 8, while being able to edit like it is set to 'sts'. However,
6271 commands like "x" still work on the actual characters.
6272 When 'sts' is zero, this feature is off.
6273 'softtabstop' is set to 0 when the 'paste' option is set.
6274 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6275 spaces is minimized by using <Tab>s.
6276 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6277 set.
6278 NOTE: This option is set to 0 when 'compatible' is set.
6279
Bram Moolenaar217ad922005-03-20 22:37:15 +00006280 *'spell'* *'nospell'*
6281'spell' boolean (default off)
6282 local to window
6283 {not in Vi}
6284 {not available when compiled without the |+syntax|
6285 feature}
6286 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006287 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006288
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006289 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006290'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006291 local to buffer
6292 {not in Vi}
6293 {not available when compiled without the |+syntax|
6294 feature}
6295 Pattern to locate the end of a sentence. The following word will be
6296 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006297 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006298 When this check is not wanted make this option empty.
6299 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006300 Be careful with special characters, see |option-backslash| about
6301 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006302 To set this option automatically depending on the language, see
6303 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006304
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006305 *'spellfile'* *'spf'*
6306'spellfile' 'spf' string (default empty)
6307 local to buffer
6308 {not in Vi}
6309 {not available when compiled without the |+syntax|
6310 feature}
6311 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006312 commands. It must end in ".{encoding}.add". You need to include the
6313 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006314 *E765*
6315 It may also be a comma separated list of names. A count before the
6316 |zg| and |zw| commands can be used to access each. This allows using
6317 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006318 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006319 you: Using the first directory in 'runtimepath' that is writable. If
6320 there is no "spell" directory yet it will be created. For the file
6321 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006322 ignoring the region.
6323 The resulting ".spl" file will be used for spell checking, it does not
6324 have to appear in 'spelllang'.
6325 Normally one file is used for all regions, but you can add the region
6326 name if you want to. However, it will then only be used when
6327 'spellfile' is set to it, for entries in 'spelllang' only files
6328 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006329 This option cannot be set from a |modeline| or in the |sandbox|, for
6330 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006331
Bram Moolenaar217ad922005-03-20 22:37:15 +00006332 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006333'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006334 local to buffer
6335 {not in Vi}
6336 {not available when compiled without the |+syntax|
6337 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006338 A comma separated list of word list names. When the 'spell' option is
6339 on spellchecking will be done for these languages. Example: >
6340 set spelllang=en_us,nl,medical
6341< This means US English, Dutch and medical words are recognized. Words
6342 that are not recognized will be highlighted.
6343 The word list name must not include a comma or dot. Using a dash is
6344 recommended to separate the two letter language name from a
6345 specification. Thus "en-rare" is used for rare English words.
6346 A region name must come last and have the form "_xx", where "xx" is
6347 the two-letter, lower case region name. You can use more than one
6348 region by listing them: "en_us,en_ca" supports both US and Canadian
6349 English, but not words specific for Australia, New Zealand or Great
6350 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006351 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006352 As a special case the name of a .spl file can be given as-is. The
6353 first "_xx" in the name is removed and used as the region name
6354 (_xx is an underscore, two letters and followed by a non-letter).
6355 This is mainly for testing purposes. You must make sure the correct
6356 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006357 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006358 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6359 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006360 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006361
Bram Moolenaar98692072006-02-04 00:57:42 +00006362 If the |spellfile.vim| plugin is active and you use a language name
6363 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6364 will ask you if you want to download the file.
6365
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006366 After this option has been set successfully, Vim will source the files
6367 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006368 up to the first comma, dot or underscore.
6369 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006370
6371
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006372 *'spellsuggest'* *'sps'*
6373'spellsuggest' 'sps' string (default "best")
6374 global
6375 {not in Vi}
6376 {not available when compiled without the |+syntax|
6377 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006378 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006379 the |spellsuggest()| function. This is a comma-separated list of
6380 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006381
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006382 best Internal method that works best for English. Finds
6383 changes like "fast" and uses a bit of sound-a-like
6384 scoring to improve the ordering.
6385
6386 double Internal method that uses two methods and mixes the
6387 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006388 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006389 word. That only works when the language specifies
6390 sound folding. Can be slow and doesn't always give
6391 better results.
6392
6393 fast Internal method that only checks for simple changes:
6394 character inserts/deletes/swaps. Works well for
6395 simple typing mistakes.
6396
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006397 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006398 Not used for |spellsuggest()|. The number of
6399 suggestions is never more than the value of 'lines'
6400 minus two.
6401
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006402 file:{filename} Read file {filename}, which must have two columns,
6403 separated by a slash. The first column contains the
6404 bad word, the second column the suggested good word.
6405 Example:
6406 theribal/terrible ~
6407 Use this for common mistakes that do not appear at the
6408 top of the suggestion list with the internal methods.
6409 Lines without a slash are ignored, use this for
6410 comments.
6411 The file is used for all languages.
6412
6413 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6414 trouble with spaces. |v:val| holds the badly spelled
6415 word. The expression must evaluate to a List of
6416 Lists, each with a suggestion and a score.
6417 Example:
6418 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006419 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006420 internal methods use. A lower score is better.
6421 This may invoke |spellsuggest()| if you temporarily
6422 set 'spellsuggest' to exclude the "expr:" part.
6423 Errors are silently ignored, unless you set the
6424 'verbose' option to a non-zero value.
6425
6426 Only one of "best", "double" or "fast" may be used. The others may
6427 appear several times in any order. Example: >
6428 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6429<
6430 This option cannot be set from a |modeline| or in the |sandbox|, for
6431 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006432
6433
Bram Moolenaar071d4272004-06-13 20:20:40 +00006434 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6435'splitbelow' 'sb' boolean (default off)
6436 global
6437 {not in Vi}
6438 {not available when compiled without the +windows
6439 feature}
6440 When on, splitting a window will put the new window below the current
6441 one. |:split|
6442
6443 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6444'splitright' 'spr' boolean (default off)
6445 global
6446 {not in Vi}
6447 {not available when compiled without the +vertsplit
6448 feature}
6449 When on, splitting a window will put the new window right of the
6450 current one. |:vsplit|
6451
6452 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6453'startofline' 'sol' boolean (default on)
6454 global
6455 {not in Vi}
6456 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006457 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006458 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006459 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460 with a linewise operator, with "%" with a count and to buffer changing
6461 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6462 only has a line number, e.g., ":25" or ":+".
6463 In case of buffer changing commands the cursor is placed at the column
6464 where it was the last time the buffer was edited.
6465 NOTE: This option is set when 'compatible' is set.
6466
6467 *'statusline'* *'stl'* *E540* *E541* *E542*
6468'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006469 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 {not in Vi}
6471 {not available when compiled without the |+statusline|
6472 feature}
6473 When nonempty, this option determines the content of the status line.
6474 Also see |status-line|.
6475
6476 The option consists of printf style '%' items interspersed with
6477 normal text. Each status line item is of the form:
6478 %-0{minwid}.{maxwid}{item}
6479 All fields except the {item} is optional. A single percent sign can
6480 be given as "%%". Up to 80 items can be specified.
6481
Bram Moolenaar238a5642006-02-21 22:12:05 +00006482 When the option starts with "%!" then it is used as an expression,
6483 evaluated and the result is used as the option value. Example: >
6484 :set statusline=%!MyStatusLine()
6485< The result can contain %{} items that will be evaluated too.
6486
6487 When there is error while evaluating the option then it will be made
6488 empty to avoid further errors. Otherwise screen updating would loop.
6489
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 Note that the only effect of 'ruler' when this option is set (and
6491 'laststatus' is 2) is controlling the output of |CTRL-G|.
6492
6493 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006494 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006496 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006497 minwid Minimum width of the item, padding as set by '-' & '0'.
6498 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006499 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 on the left for text items. Numeric items will be
6501 shifted down to maxwid-2 digits followed by '>'number
6502 where number is the amount of missing digits, much like
6503 an exponential notation.
6504 item A one letter code as described below.
6505
6506 Following is a description of the possible statusline items. The
6507 second character in "item" is the type:
6508 N for number
6509 S for string
6510 F for flags as described below
6511 - not applicable
6512
6513 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006514 f S Path to the file in the buffer, as typed or relative to current
6515 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 F S Full path to the file in the buffer.
6517 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006518 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006520 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006522 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006524 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006526 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6528 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006529 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6531 being used: "<keymap>"
6532 n N Buffer number.
6533 b N Value of byte under cursor.
6534 B N As above, in hexadecimal.
6535 o N Byte number in file of byte under cursor, first byte is 1.
6536 Mnemonic: Offset from start of file (with one added)
6537 {not available when compiled without |+byte_offset| feature}
6538 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006539 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 l N Line number.
6541 L N Number of lines in buffer.
6542 c N Column number.
6543 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006544 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545 p N Percentage through file in lines as in |CTRL-G|.
6546 P S Percentage through file of displayed window. This is like the
6547 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006548 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006550 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006551 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006552 ( - Start of item group. Can be used for setting the width and
6553 alignment of a section. Must be followed by %) somewhere.
6554 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006555 T N For 'tabline': start of tab page N label. Use %T after the last
6556 label. This information is used for mouse clicks.
6557 X N For 'tabline': start of close tab N label. Use %X after the
6558 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6559 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006560 < - Where to truncate line if too long. Default is at the start.
6561 No width fields allowed.
6562 = - Separation point between left and right aligned items.
6563 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006564 # - Set highlight group. The name must follow and then a # again.
6565 Thus use %#HLname# for highlight group HLname. The same
6566 highlighting is used, also for the statusline of non-current
6567 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006569 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 The difference between User{N} and StatusLine will be applied
6571 to StatusLineNC for the statusline of non-current windows.
6572 The number N must be between 1 and 9. See |hl-User1..9|
6573
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006574 When displaying a flag, Vim removes the leading comma, if any, when
6575 that flag comes right after plaintext. This will make a nice display
6576 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577
Bram Moolenaar582fd852005-03-28 20:58:01 +00006578 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579 not set) and a minwid is not set for the group, the whole group will
6580 become empty. This will make a group like the following disappear
6581 completely from the statusline when none of the flags are set. >
6582 :set statusline=...%(\ [%M%R%H]%)...
6583<
6584 Beware that an expression is evaluated each and every time the status
6585 line is displayed. The current buffer and current window will be set
6586 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006587 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006589 real current buffer.
6590
6591 The 'statusline' option may be evaluated in the |sandbox|, see
6592 |sandbox-option|.
6593
6594 It is not allowed to change text or jump to another window while
6595 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596
6597 If the statusline is not updated when you want it (e.g., after setting
6598 a variable that's used in an expression), you can force an update by
6599 setting an option without changing its value. Example: >
6600 :let &ro = &ro
6601
6602< A result of all digits is regarded a number for display purposes.
6603 Otherwise the result is taken as flag text and applied to the rules
6604 described above.
6605
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006606 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6608 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6609
6610 Examples:
6611 Emulate standard status line with 'ruler' set >
6612 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6613< Similar, but add ASCII value of char under the cursor (like "ga") >
6614 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6615< Display byte count and byte value, modified flag in red. >
6616 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6617 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6618< Display a ,GZ flag if a compressed file is loaded >
6619 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6620< In the |:autocmd|'s: >
6621 :let b:gzflag = 1
6622< And: >
6623 :unlet b:gzflag
6624< And define this function: >
6625 :function VarExists(var, val)
6626 : if exists(a:var) | return a:val | else | return '' | endif
6627 :endfunction
6628<
6629 *'suffixes'* *'su'*
6630'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6631 global
6632 {not in Vi}
6633 Files with these suffixes get a lower priority when multiple files
6634 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006635 suffixes. Spaces after the comma are ignored. A dot is also seen as
6636 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 separator, precede it with a backslash (see |option-backslash| about
6638 including spaces and backslashes).
6639 See 'wildignore' for completely ignoring files.
6640 The use of |:set+=| and |:set-=| is preferred when adding or removing
6641 suffixes from the list. This avoids problems when a future version
6642 uses another default.
6643
6644 *'suffixesadd'* *'sua'*
6645'suffixesadd' 'sua' string (default "")
6646 local to buffer
6647 {not in Vi}
6648 {not available when compiled without the
6649 |+file_in_path| feature}
6650 Comma separated list of suffixes, which are used when searching for a
6651 file for the "gf", "[I", etc. commands. Example: >
6652 :set suffixesadd=.java
6653<
6654 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6655'swapfile' 'swf' boolean (default on)
6656 local to buffer
6657 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006658 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659 swapfile is not wanted for a specific buffer. For example, with
6660 confidential information that even root must not be able to access.
6661 Careful: All text will be in memory:
6662 - Don't use this for big files.
6663 - Recovery will be impossible!
6664 A swapfile will only be present when |'updatecount'| is non-zero and
6665 'swapfile' is set.
6666 When 'swapfile' is reset, the swap file for the current buffer is
6667 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6668 non-zero, a swap file is immediately created.
6669 Also see |swap-file| and |'swapsync'|.
6670
6671 This option is used together with 'bufhidden' and 'buftype' to
6672 specify special kinds of buffers. See |special-buffers|.
6673
6674 *'swapsync'* *'sws'*
6675'swapsync' 'sws' string (default "fsync")
6676 global
6677 {not in Vi}
6678 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006679 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 When this option is empty parts of the swap file may be in memory and
6681 not written to disk. When the system crashes you may lose more work.
6682 On Unix the system does a sync now and then without Vim asking for it,
6683 so the disadvantage of setting this option off is small. On some
6684 systems the swap file will not be written at all. For a unix system
6685 setting it to "sync" will use the sync() call instead of the default
6686 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006687 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688
6689 *'switchbuf'* *'swb'*
6690'switchbuf' 'swb' string (default "")
6691 global
6692 {not in Vi}
6693 This option controls the behavior when switching between buffers.
6694 Possible values (comma separated list):
6695 useopen If included, jump to the first open window that
6696 contains the specified buffer (if there is one).
6697 Otherwise: Do not examine other windows.
6698 This setting is checked with |quickfix| commands, when
6699 jumping to errors (":cc", ":cn", "cp", etc.). It is
6700 also used in all buffer related split commands, for
6701 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006702 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006703 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006705 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006707 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006708 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006710 *'synmaxcol'* *'smc'*
6711'synmaxcol' 'smc' number (default 3000)
6712 local to buffer
6713 {not in Vi}
6714 {not available when compiled without the |+syntax|
6715 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006716 Maximum column in which to search for syntax items. In long lines the
6717 text after this column is not highlighted and following lines may not
6718 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006719 This helps to avoid very slow redrawing for an XML file that is one
6720 long line.
6721 Set to zero to remove the limit.
6722
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 *'syntax'* *'syn'*
6724'syntax' 'syn' string (default empty)
6725 local to buffer
6726 {not in Vi}
6727 {not available when compiled without the |+syntax|
6728 feature}
6729 When this option is set, the syntax with this name is loaded, unless
6730 syntax highlighting has been switched off with ":syntax off".
6731 Otherwise this option does not always reflect the current syntax (the
6732 b:current_syntax variable does).
6733 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006734 not automatically recognized. Example, in an IDL file:
6735 /* vim: set syntax=idl : */ ~
6736 When a dot appears in the value then this separates two filetype
6737 names. Example:
6738 /* vim: set syntax=c.doxygen : */ ~
6739 This will use the "c" syntax first, then the "doxygen" syntax.
6740 Note that the second one must be prepared to be loaded as an addition,
6741 otherwise it will be skipped. More than one dot may appear.
6742 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 :set syntax=OFF
6744< To switch syntax highlighting on according to the current value of the
6745 'filetype' option: >
6746 :set syntax=ON
6747< What actually happens when setting the 'syntax' option is that the
6748 Syntax autocommand event is triggered with the value as argument.
6749 This option is not copied to another buffer, independent of the 's' or
6750 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006751 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006753 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006754'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006755 global
6756 {not in Vi}
6757 {not available when compiled without the +windows
6758 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006759 When nonempty, this option determines the content of the tab pages
6760 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006761 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006762
6763 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006764 option and only when there is no GUI tab line. When 'e' is in
6765 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6766 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006767
6768 The value is evaluated like with 'statusline'. You can use
6769 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006770 the text to be displayed. Use "%1T" for the first label, "%2T" for
6771 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006772
6773 Keep in mind that only one of the tab pages is the current one, others
6774 are invisible and you can't jump to their windows.
6775
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006776
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006777 *'tabpagemax'* *'tpm'*
6778'tabpagemax' 'tpm' number (default 10)
6779 global
6780 {not in Vi}
6781 {not available when compiled without the +windows
6782 feature}
6783 Maximum number of tab pages to be opened by the |-p| command line
6784 argument or the ":tab all" command. |tabpage|
6785
6786
6787 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788'tabstop' 'ts' number (default 8)
6789 local to buffer
6790 Number of spaces that a <Tab> in the file counts for. Also see
6791 |:retab| command, and 'softtabstop' option.
6792
6793 Note: Setting 'tabstop' to any other value than 8 can make your file
6794 appear wrong in many places (e.g., when printing it).
6795
6796 There are four main ways to use tabs in Vim:
6797 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6798 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006799 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800 behave like a tab appears every 4 (or 3) characters.
6801 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6802 'expandtab'. This way you will always insert spaces. The
6803 formatting will never be messed up when 'tabstop' is changed.
6804 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006805 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 works when using Vim to edit the file.
6807 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6808 'noexpandtab'. This should then work (for initial indents only)
6809 for any tabstop setting that people use. It might be nice to have
6810 tabs after the first non-blank inserted as spaces if you do this
6811 though. Otherwise aligned comments will be wrong when 'tabstop' is
6812 changed.
6813
6814 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6815'tagbsearch' 'tbs' boolean (default on)
6816 global
6817 {not in Vi}
6818 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006819 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820 searching makes searching for a tag a LOT faster, but a linear search
6821 will find more tags if the tags file wasn't properly sorted.
6822 Vim normally assumes that your tags files are sorted, or indicate that
6823 they are not sorted. Only when this is not the case does the
6824 'tagbsearch' option need to be switched off.
6825
6826 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006827 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 certain files, or retry all files with a linear search. When
6829 'tagbsearch' is off, only a linear search is done.
6830
6831 Linear searching is done anyway, for one file, when Vim finds a line
6832 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006833 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834< [The whitespace before and after the '0' must be a single <Tab>]
6835
6836 When a binary search was done and no match was found in any of the
6837 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6838 instead of a normal tag name, a retry is done with a linear search.
6839 Tags in unsorted tags files, and matches with different case will only
6840 be found in the retry.
6841
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006842 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 linear search can be avoided for the 'ignorecase' case. Use a value
6844 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6845 case-fold sorted with the -f switch to "sort" in most unices, as in
6846 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006847 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6848 for this as well. Note that case must be folded to uppercase for this
6849 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006850
6851 When 'tagbsearch' is off, tags searching is slower when a full match
6852 exists, but faster when no full match exists. Tags in unsorted tags
6853 files may only be found with 'tagbsearch' off.
6854 When the tags file is not sorted, or sorted in a wrong way (not on
6855 ASCII byte value), 'tagbsearch' should be off, or the line given above
6856 must be included in the tags file.
6857 This option doesn't affect commands that find all matching tags (e.g.,
6858 command-line completion and ":help").
6859 {Vi: always uses binary search in some versions}
6860
6861 *'taglength'* *'tl'*
6862'taglength' 'tl' number (default 0)
6863 global
6864 If non-zero, tags are significant up to this number of characters.
6865
6866 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6867'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6868 global
6869 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006870 If on and using a tags file in another directory, file names in that
6871 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 NOTE: This option is set to the Vi default value when 'compatible' is
6873 set and to the Vim default value when 'compatible' is reset.
6874
6875 *'tags'* *'tag'* *E433*
6876'tags' 'tag' string (default "./tags,tags", when compiled with
6877 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6878 global or local to buffer |global-local|
6879 Filenames for the tag command, separated by spaces or commas. To
6880 include a space or comma in a file name, precede it with a backslash
6881 (see |option-backslash| about including spaces and backslashes).
6882 When a file name starts with "./", the '.' is replaced with the path
6883 of the current file. But only when the 'd' flag is not included in
6884 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6885 |tags-option|.
6886 "*", "**" and other wildcards can be used to search for tags files in
6887 a directory tree. See |file-searching|. {not available when compiled
6888 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006889 The |tagfiles()| function can be used to get a list of the file names
6890 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6892 files are also supported. They are automatically recognized. The
6893 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6894 differences are ignored (MS-Windows). |emacs-tags|
6895 The use of |:set+=| and |:set-=| is preferred when adding or removing
6896 file names from the list. This avoids problems when a future version
6897 uses another default.
6898 {Vi: default is "tags /usr/lib/tags"}
6899
6900 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6901'tagstack' 'tgst' boolean (default on)
6902 global
6903 {not in all versions of Vi}
6904 When on, the |tagstack| is used normally. When off, a ":tag" or
6905 ":tselect" command with an argument will not push the tag onto the
6906 tagstack. A following ":tag" without an argument, a ":pop" command or
6907 any other command that uses the tagstack will use the unmodified
6908 tagstack, but does change the pointer to the active entry.
6909 Resetting this option is useful when using a ":tag" command in a
6910 mapping which should not change the tagstack.
6911
6912 *'term'* *E529* *E530* *E531*
6913'term' string (default is $TERM, if that fails:
6914 in the GUI: "builtin_gui"
6915 on Amiga: "amiga"
6916 on BeOS: "beos-ansi"
6917 on Mac: "mac-ansi"
6918 on MiNT: "vt52"
6919 on MS-DOS: "pcterm"
6920 on OS/2: "os2ansi"
6921 on Unix: "ansi"
6922 on VMS: "ansi"
6923 on Win 32: "win32")
6924 global
6925 Name of the terminal. Used for choosing the terminal control
6926 characters. Environment variables are expanded |:set_env|.
6927 For example: >
6928 :set term=$TERM
6929< See |termcap|.
6930
6931 *'termbidi'* *'tbidi'*
6932 *'notermbidi'* *'notbidi'*
6933'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6934 global
6935 {not in Vi}
6936 {only available when compiled with the |+arabic|
6937 feature}
6938 The terminal is in charge of Bi-directionality of text (as specified
6939 by Unicode). The terminal is also expected to do the required shaping
6940 that some languages (such as Arabic) require.
6941 Setting this option implies that 'rightleft' will not be set when
6942 'arabic' is set and the value of 'arabicshape' will be ignored.
6943 Note that setting 'termbidi' has the immediate effect that
6944 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6945 This option is reset when the GUI is started.
6946 For further details see |arabic.txt|.
6947
6948 *'termencoding'* *'tenc'*
6949'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6950 Macintosh GUI: "macroman")
6951 global
6952 {only available when compiled with the |+multi_byte|
6953 feature}
6954 {not in Vi}
6955 Encoding used for the terminal. This specifies what character
6956 encoding the keyboard produces and the display will understand. For
6957 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006958 display). Except for the Mac when 'macatsui' is off, then
6959 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 In the Win32 console version the default value is the console codepage
6961 when it differs from the ANSI codepage.
6962 *E617*
6963 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6964 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6965 Any attempts to set a different value will be rejected, and an error
6966 message is shown.
6967 For the Win32 GUI 'termencoding' is not used for typed characters,
6968 because the Win32 system always passes Unicode characters.
6969 When empty, the same encoding is used as for the 'encoding' option.
6970 This is the normal value.
6971 Not all combinations for 'termencoding' and 'encoding' are valid. See
6972 |encoding-table|.
6973 The value for this option must be supported by internal conversions or
6974 iconv(). When this is not possible no conversion will be done and you
6975 will probably experience problems with non-ASCII characters.
6976 Example: You are working with the locale set to euc-jp (Japanese) and
6977 want to edit a UTF-8 file: >
6978 :let &termencoding = &encoding
6979 :set encoding=utf-8
6980< You need to do this when your system has no locale support for UTF-8.
6981
6982 *'terse'* *'noterse'*
6983'terse' boolean (default off)
6984 global
6985 When set: Add 's' flag to 'shortmess' option (this makes the message
6986 for a search that hits the start or end of the file not being
6987 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6988 shortens a lot of messages}
6989
6990 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6991'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6992 global
6993 {not in Vi}
6994 This option is obsolete. Use 'fileformats'.
6995 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6996 set to the default value for the current system. When 'textauto' is
6997 reset, 'fileformats' is made empty.
6998 NOTE: This option is set to the Vi default value when 'compatible' is
6999 set and to the Vim default value when 'compatible' is reset.
7000
7001 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7002'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7003 others: default off)
7004 local to buffer
7005 {not in Vi}
7006 This option is obsolete. Use 'fileformat'.
7007 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7008 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7009 "unix".
7010
7011 *'textwidth'* *'tw'*
7012'textwidth' 'tw' number (default 0)
7013 local to buffer
7014 {not in Vi}
7015 Maximum width of text that is being inserted. A longer line will be
7016 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007017 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7018 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007020 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 NOTE: This option is set to 0 when 'compatible' is set.
7022
7023 *'thesaurus'* *'tsr'*
7024'thesaurus' 'tsr' string (default "")
7025 global or local to buffer |global-local|
7026 {not in Vi}
7027 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007028 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 the file should contain words with similar meaning, separated by
7030 non-keyword characters (white space is preferred). Maximum line
7031 length is 510 bytes.
7032 To obtain a file to be used here, check out the wordlist FAQ at
7033 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007034 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 after a comma are ignored, otherwise spaces are included in the file
7036 name. See |option-backslash| about using backslashes.
7037 The use of |:set+=| and |:set-=| is preferred when adding or removing
7038 directories from the list. This avoids problems when a future version
7039 uses another default.
7040 Backticks cannot be used in this option for security reasons.
7041
7042 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7043'tildeop' 'top' boolean (default off)
7044 global
7045 {not in Vi}
7046 When on: The tilde command "~" behaves like an operator.
7047 NOTE: This option is reset when 'compatible' is set.
7048
7049 *'timeout'* *'to'* *'notimeout'* *'noto'*
7050'timeout' 'to' boolean (default on)
7051 global
7052 *'ttimeout'* *'nottimeout'*
7053'ttimeout' boolean (default off)
7054 global
7055 {not in Vi}
7056 These two options together determine the behavior when part of a
7057 mapped key sequence or keyboard code has been received:
7058
7059 'timeout' 'ttimeout' action ~
7060 off off do not time out
7061 on on or off time out on :mappings and key codes
7062 off on time out on key codes
7063
7064 If both options are off, Vim will wait until either the complete
7065 mapping or key sequence has been received, or it is clear that there
7066 is no mapping or key sequence for the received characters. For
7067 example: if you have mapped "vl" and Vim has received 'v', the next
7068 character is needed to see if the 'v' is followed by an 'l'.
7069 When one of the options is on, Vim will wait for about 1 second for
7070 the next character to arrive. After that the already received
7071 characters are interpreted as single characters. The waiting time can
7072 be changed with the 'timeoutlen' option.
7073 On slow terminals or very busy systems timing out may cause
7074 malfunctioning cursor keys. If both options are off, Vim waits
7075 forever after an entered <Esc> if there are key codes that start
7076 with <Esc>. You will have to type <Esc> twice. If you do not have
7077 problems with key codes, but would like to have :mapped key
7078 sequences not timing out in 1 second, set the 'ttimeout' option and
7079 reset the 'timeout' option.
7080
7081 NOTE: 'ttimeout' is reset when 'compatible' is set.
7082
7083 *'timeoutlen'* *'tm'*
7084'timeoutlen' 'tm' number (default 1000)
7085 global
7086 {not in all versions of Vi}
7087 *'ttimeoutlen'* *'ttm'*
7088'ttimeoutlen' 'ttm' number (default -1)
7089 global
7090 {not in Vi}
7091 The time in milliseconds that is waited for a key code or mapped key
7092 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7093 when part of a command has been typed.
7094 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7095 different timeout value for key codes is desired set 'ttimeoutlen' to
7096 a non-negative number.
7097
7098 ttimeoutlen mapping delay key code delay ~
7099 < 0 'timeoutlen' 'timeoutlen'
7100 >= 0 'timeoutlen' 'ttimeoutlen'
7101
7102 The timeout only happens when the 'timeout' and 'ttimeout' options
7103 tell so. A useful setting would be >
7104 :set timeout timeoutlen=3000 ttimeoutlen=100
7105< (time out on mapping after three seconds, time out on key codes after
7106 a tenth of a second).
7107
7108 *'title'* *'notitle'*
7109'title' boolean (default off, on when title can be restored)
7110 global
7111 {not in Vi}
7112 {not available when compiled without the |+title|
7113 feature}
7114 When on, the title of the window will be set to the value of
7115 'titlestring' (if it is not empty), or to:
7116 filename [+=-] (path) - VIM
7117 Where:
7118 filename the name of the file being edited
7119 - indicates the file cannot be modified, 'ma' off
7120 + indicates the file was modified
7121 = indicates the file is read-only
7122 =+ indicates the file is read-only and modified
7123 (path) is the path of the file being edited
7124 - VIM the server name |v:servername| or "VIM"
7125 Only works if the terminal supports setting window titles
7126 (currently Amiga console, Win32 console, all GUI versions and
7127 terminals with a non- empty 't_ts' option - these are Unix xterm and
7128 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7129 *X11*
7130 When Vim was compiled with HAVE_X11 defined, the original title will
7131 be restored if possible. The output of ":version" will include "+X11"
7132 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7133 works for the icon name |'icon'|.
7134 But: When Vim was started with the |-X| argument, restoring the title
7135 will not work (except in the GUI).
7136 If the title cannot be restored, it is set to the value of 'titleold'.
7137 You might want to restore the title outside of Vim then.
7138 When using an xterm from a remote machine you can use this command:
7139 rsh machine_name xterm -display $DISPLAY &
7140 then the WINDOWID environment variable should be inherited and the
7141 title of the window should change back to what it should be after
7142 exiting Vim.
7143
7144 *'titlelen'*
7145'titlelen' number (default 85)
7146 global
7147 {not in Vi}
7148 {not available when compiled without the |+title|
7149 feature}
7150 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007151 title. When the title is longer, only the end of the path name is
7152 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 Using a percentage makes this adapt to the width of the window. But
7154 it won't work perfectly, because the actual number of characters
7155 available also depends on the font used and other things in the title
7156 bar. When 'titlelen' is zero the full path is used. Otherwise,
7157 values from 1 to 30000 percent can be used.
7158 'titlelen' is also used for the 'titlestring' option.
7159
7160 *'titleold'*
7161'titleold' string (default "Thanks for flying Vim")
7162 global
7163 {not in Vi}
7164 {only available when compiled with the |+title|
7165 feature}
7166 This option will be used for the window title when exiting Vim if the
7167 original title cannot be restored. Only happens if 'title' is on or
7168 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007169 This option cannot be set from a |modeline| or in the |sandbox|, for
7170 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007171 *'titlestring'*
7172'titlestring' string (default "")
7173 global
7174 {not in Vi}
7175 {not available when compiled without the |+title|
7176 feature}
7177 When this option is not empty, it will be used for the title of the
7178 window. This happens only when the 'title' option is on.
7179 Only works if the terminal supports setting window titles (currently
7180 Amiga console, Win32 console, all GUI versions and terminals with a
7181 non-empty 't_ts' option).
7182 When Vim was compiled with HAVE_X11 defined, the original title will
7183 be restored if possible |X11|.
7184 When this option contains printf-style '%' items, they will be
7185 expanded according to the rules used for 'statusline'.
7186 Example: >
7187 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7188 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7189< The value of 'titlelen' is used to align items in the middle or right
7190 of the available space.
7191 Some people prefer to have the file name first: >
7192 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7193< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007194 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007195 separating space only when needed.
7196 NOTE: Use of special characters in 'titlestring' may cause the display
7197 to be garbled (e.g., when it contains a CR or NL character).
7198 {not available when compiled without the |+statusline| feature}
7199
7200 *'toolbar'* *'tb'*
7201'toolbar' 'tb' string (default "icons,tooltips")
7202 global
7203 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7204 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007205 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 possible values are:
7207 icons Toolbar buttons are shown with icons.
7208 text Toolbar buttons shown with text.
7209 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007210 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 tooltips Tooltips are active for toolbar buttons.
7212 Tooltips refer to the popup help text which appears after the mouse
7213 cursor is placed over a toolbar button for a brief moment.
7214
7215 If you want the toolbar to be shown with icons as well as text, do the
7216 following: >
7217 :set tb=icons,text
7218< Motif and Athena cannot display icons and text at the same time. They
7219 will show icons if both are requested.
7220
7221 If none of the strings specified in 'toolbar' are valid or if
7222 'toolbar' is empty, this option is ignored. If you want to disable
7223 the toolbar, you need to set the 'guioptions' option. For example: >
7224 :set guioptions-=T
7225< Also see |gui-toolbar|.
7226
7227 *'toolbariconsize'* *'tbis'*
7228'toolbariconsize' 'tbis' string (default "small")
7229 global
7230 {not in Vi}
7231 {only in the GTK+ 2 GUI}
7232 Controls the size of toolbar icons. The possible values are:
7233 tiny Use tiny toolbar icons.
7234 small Use small toolbar icons (default).
7235 medium Use medium-sized toolbar icons.
7236 large Use large toolbar icons.
7237 The exact dimensions in pixels of the various icon sizes depend on
7238 the current theme. Common dimensions are large=32x32, medium=24x24,
7239 small=20x20 and tiny=16x16.
7240
7241 If 'toolbariconsize' is empty, the global default size as determined
7242 by user preferences or the current theme is used.
7243
7244 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7245'ttybuiltin' 'tbi' boolean (default on)
7246 global
7247 {not in Vi}
7248 When on, the builtin termcaps are searched before the external ones.
7249 When off the builtin termcaps are searched after the external ones.
7250 When this option is changed, you should set the 'term' option next for
7251 the change to take effect, for example: >
7252 :set notbi term=$TERM
7253< See also |termcap|.
7254 Rationale: The default for this option is "on", because the builtin
7255 termcap entries are generally better (many systems contain faulty
7256 xterm entries...).
7257
7258 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7259'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7260 sun-cmd, screen, rxvt, dtterm or
7261 iris-ansi; also on when running Vim in
7262 a DOS console)
7263 global
7264 {not in Vi}
7265 Indicates a fast terminal connection. More characters will be sent to
7266 the screen for redrawing, instead of using insert/delete line
7267 commands. Improves smoothness of redrawing when there are multiple
7268 windows and the terminal does not support a scrolling region.
7269 Also enables the extra writing of characters at the end of each screen
7270 line for lines that wrap. This helps when using copy/paste with the
7271 mouse in an xterm and other terminals.
7272
7273 *'ttymouse'* *'ttym'*
7274'ttymouse' 'ttym' string (default depends on 'term')
7275 global
7276 {not in Vi}
7277 {only in Unix and VMS, doesn't work in the GUI; not
7278 available when compiled without |+mouse|}
7279 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007280 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 *xterm-mouse*
7282 xterm xterm-like mouse handling. The mouse generates
7283 "<Esc>[Mscr", where "scr" is three bytes:
7284 "s" = button state
7285 "c" = column plus 33
7286 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007287 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007288 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007289 xterm2 Works like "xterm", but with the xterm reporting the
7290 mouse position while the mouse is dragged. This works
7291 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007292 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007293 work. See below for how Vim detects this
7294 automatically.
7295 *netterm-mouse*
7296 netterm NetTerm mouse handling. The mouse generates
7297 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7298 for the row and column.
7299 *dec-mouse*
7300 dec DEC terminal mouse handling. The mouse generates a
7301 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007302 This is also available for an Xterm, if it was
7303 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304 *jsbterm-mouse*
7305 jsbterm JSB term mouse handling.
7306 *pterm-mouse*
7307 pterm QNX pterm mouse handling.
7308
7309 The mouse handling must be enabled at compile time |+mouse_xterm|
7310 |+mouse_dec| |+mouse_netterm|.
7311 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7312 recognized, if enabled at compile time. DEC terminal mouse codes
7313 are recognized if enabled at compile time, and 'ttymouse' is not
7314 "xterm" (because the xterm and dec mouse codes conflict).
7315 This option is automatically set to "xterm", when the 'term' option is
7316 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7317 or "xterm2" already. The main use of this option is to set it to
7318 "xterm", when the terminal name doesn't start with "xterm", but it can
7319 handle xterm mouse codes.
7320 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007321 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007322 feature and if |t_RV| is set to the escape sequence to request the
7323 xterm version number. Otherwise "xterm2" must be set explicitly.
7324 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7325 t_RV to an empty string: >
7326 :set t_RV=
7327<
7328 *'ttyscroll'* *'tsl'*
7329'ttyscroll' 'tsl' number (default 999)
7330 global
7331 Maximum number of lines to scroll the screen. If there are more lines
7332 to scroll the window is redrawn. For terminals where scrolling is
7333 very slow and redrawing is not slow this can be set to a small number,
7334 e.g., 3, to speed up displaying.
7335
7336 *'ttytype'* *'tty'*
7337'ttytype' 'tty' string (default from $TERM)
7338 global
7339 Alias for 'term', see above.
7340
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007341 *'undodir'* *'udir'*
7342'undodir' 'udir' string (default ".")
7343 global
7344 {not in Vi}
7345 {only when compiled with the +persistent_undo feature}
7346 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007347 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007348 "." means using the directory of the file. The undo file name for
7349 "file.txt" is ".file.txt.un~".
7350 For other directories the file name is the full path of the edited
7351 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007352 When writing: The first directory that exists is used. "." always
7353 works, no directories after "." will be used for writing.
7354 When reading all entries are tried to find an undo file. The first
7355 undo file that exists is used. When it cannot be read an error is
7356 given, no further entry is used.
7357 See |undo-persistence|.
7358
7359 *'undofile'* *'udf'*
7360'undofile' 'udf' boolean (default off)
7361 local to buffer
7362 {not in Vi}
7363 {only when compiled with the +persistent_undo feature}
7364 When on, Vim automatically saves undo history to an undo file when
7365 writing a buffer to a file, and restores undo history from the same
7366 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007367 The directory where the undo file is stored is specified by 'undodir'.
7368 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007369 The undo file is not read when 'undoreload' causes the buffer from
7370 before a reload to be saved for undo.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007371 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007372
Bram Moolenaar071d4272004-06-13 20:20:40 +00007373 *'undolevels'* *'ul'*
7374'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7375 Win32 and OS/2)
7376 global
7377 {not in Vi}
7378 Maximum number of changes that can be undone. Since undo information
7379 is kept in memory, higher numbers will cause more memory to be used
7380 (nevertheless, a single change can use an unlimited amount of memory).
7381 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7382 itself: >
7383 set ul=0
7384< But you can also get Vi compatibility by including the 'u' flag in
7385 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007386 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007387 Set to a negative number for no undo at all: >
7388 set ul=-1
7389< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007390 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007391
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007392 *'undoreload'* *'ur'*
7393'undoreload' 'ur' number (default 10000)
7394 global
7395 {not in Vi}
7396 Save the whole buffer for undo when reloading it. This applies to the
7397 ":e!" command and reloading for when the buffer changed outside of
7398 Vim. |FileChangedShell|
7399 The save only happens when this options is negative or when the number
7400 of lines is smaller than the value of this option.
7401 Set this option to zero to disable undo for a reload.
7402
7403 When saving undo for a reload, any undo file is not read.
7404
7405 Note that this causes the whole buffer to be stored in memory. Set
7406 this option to a lower value if you run out of memory.
7407
Bram Moolenaar071d4272004-06-13 20:20:40 +00007408 *'updatecount'* *'uc'*
7409'updatecount' 'uc' number (default: 200)
7410 global
7411 {not in Vi}
7412 After typing this many characters the swap file will be written to
7413 disk. When zero, no swap file will be created at all (see chapter on
7414 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7415 Vim with the "-n" option, see |startup|. When editing in readonly
7416 mode this option will be initialized to 10000.
7417 The swapfile can be disabled per buffer with |'swapfile'|.
7418 When 'updatecount' is set from zero to non-zero, swap files are
7419 created for all buffers that have 'swapfile' set. When 'updatecount'
7420 is set to zero, existing swap files are not deleted.
7421 Also see |'swapsync'|.
7422 This option has no meaning in buffers where |'buftype'| is "nofile"
7423 or "nowrite".
7424
7425 *'updatetime'* *'ut'*
7426'updatetime' 'ut' number (default 4000)
7427 global
7428 {not in Vi}
7429 If this many milliseconds nothing is typed the swap file will be
7430 written to disk (see |crash-recovery|). Also used for the
7431 |CursorHold| autocommand event.
7432
7433 *'verbose'* *'vbs'*
7434'verbose' 'vbs' number (default 0)
7435 global
7436 {not in Vi, although some versions have a boolean
7437 verbose option}
7438 When bigger than zero, Vim will give messages about what it is doing.
7439 Currently, these messages are given:
7440 >= 1 When the viminfo file is read or written.
7441 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007442 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 >= 8 Files for which a group of autocommands is executed.
7444 >= 9 Every executed autocommand.
7445 >= 12 Every executed function.
7446 >= 13 When an exception is thrown, caught, finished, or discarded.
7447 >= 14 Anything pending in a ":finally" clause.
7448 >= 15 Every executed Ex command (truncated at 200 characters).
7449
7450 This option can also be set with the "-V" argument. See |-V|.
7451 This option is also set by the |:verbose| command.
7452
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007453 When the 'verbosefile' option is set then the verbose messages are not
7454 displayed.
7455
7456 *'verbosefile'* *'vfile'*
7457'verbosefile' 'vfile' string (default empty)
7458 global
7459 {not in Vi}
7460 When not empty all messages are written in a file with this name.
7461 When the file exists messages are appended.
7462 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007463 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007464 Setting 'verbosefile' to a new value is like making it empty first.
7465 The difference with |:redir| is that verbose messages are not
7466 displayed when 'verbosefile' is set.
7467
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 *'viewdir'* *'vdir'*
7469'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7470 "$VIM/vimfiles/view",
7471 for Unix: "~/.vim/view",
7472 for Macintosh: "$VIM:vimfiles:view"
7473 for VMS: "sys$login:vimfiles/view"
7474 for RiscOS: "Choices:vimfiles/view")
7475 global
7476 {not in Vi}
7477 {not available when compiled without the +mksession
7478 feature}
7479 Name of the directory where to store files for |:mkview|.
7480 This option cannot be set from a |modeline| or in the |sandbox|, for
7481 security reasons.
7482
7483 *'viewoptions'* *'vop'*
7484'viewoptions' 'vop' string (default: "folds,options,cursor")
7485 global
7486 {not in Vi}
7487 {not available when compiled without the +mksession
7488 feature}
7489 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007490 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007491 word save and restore ~
7492 cursor cursor position in file and in window
7493 folds manually created folds, opened/closed folds and local
7494 fold options
7495 options options and mappings local to a window or buffer (not
7496 global values for local options)
7497 slash backslashes in file names replaced with forward
7498 slashes
7499 unix with Unix end-of-line format (single <NL>), even when
7500 on Windows or DOS
7501
7502 "slash" and "unix" are useful on Windows when sharing view files
7503 with Unix. The Unix version of Vim cannot source dos format scripts,
7504 but the Windows version of Vim can source unix format scripts.
7505
7506 *'viminfo'* *'vi'* *E526* *E527* *E528*
7507'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007508 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7509 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7510 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511 global
7512 {not in Vi}
7513 {not available when compiled without the |+viminfo|
7514 feature}
7515 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007516 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517 separated list of parameters, each consisting of a single character
7518 identifying the particular parameter, followed by a number or string
7519 which specifies the value of that parameter. If a particular
7520 character is left out, then the default value is used for that
7521 parameter. The following is a list of the identifying characters and
7522 the effect of their value.
7523 CHAR VALUE ~
7524 ! When included, save and restore global variables that start
7525 with an uppercase letter, and don't contain a lowercase
7526 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007527 and "_K_L_M" are not. Only String and Number types are
7528 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 " Maximum number of lines saved for each register. Old name of
7530 the '<' item, with the disadvantage that you need to put a
7531 backslash before the ", otherwise it will be recognized as the
7532 start of a comment!
7533 % When included, save and restore the buffer list. If Vim is
7534 started with a file name argument, the buffer list is not
7535 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007536 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537 without a file name and buffers for help files are not written
7538 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007539 When followed by a number, the number specifies the maximum
7540 number of buffers that are stored. Without a number all
7541 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542 ' Maximum number of previously edited files for which the marks
7543 are remembered. This parameter must always be included when
7544 'viminfo' is non-empty.
7545 Including this item also means that the |jumplist| and the
7546 |changelist| are stored in the viminfo file.
7547 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007548 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007549 patterns are also saved. When not included, the value of
7550 'history' is used.
7551 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007552 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553 < Maximum number of lines saved for each register. If zero then
7554 registers are not saved. When not included, all lines are
7555 saved. '"' is the old name for this item.
7556 Also see the 's' item below: limit specified in Kbyte.
7557 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007558 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007559 c When included, convert the text in the viminfo file from the
7560 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007561 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 f Whether file marks need to be stored. If zero, file marks ('0
7563 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007564 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007565 cursor position (when exiting or when doing ":wviminfo").
7566 h Disable the effect of 'hlsearch' when loading the viminfo
7567 file. When not included, it depends on whether ":nohlsearch"
7568 has been used since the last search command.
7569 n Name of the viminfo file. The name must immediately follow
7570 the 'n'. Must be the last one! If the "-i" argument was
7571 given when starting Vim, that file name overrides the one
7572 given here with 'viminfo'. Environment variables are expanded
7573 when opening the file, not when setting the option.
7574 r Removable media. The argument is a string (up to the next
7575 ','). This parameter can be given several times. Each
7576 specifies the start of a path for which no marks will be
7577 stored. This is to avoid removable media. For MS-DOS you
7578 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7579 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7580 ignored. Maximum length of each 'r' argument is 50
7581 characters.
7582 s Maximum size of an item in Kbyte. If zero then registers are
7583 not saved. Currently only applies to registers. The default
7584 "s10" will exclude registers with more than 10 Kbyte of text.
7585 Also see the '<' item above: line count limit.
7586
7587 Example: >
7588 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7589<
7590 '50 Marks will be remembered for the last 50 files you
7591 edited.
7592 <1000 Contents of registers (up to 1000 lines each) will be
7593 remembered.
7594 s100 Registers with more than 100 Kbyte text are skipped.
7595 :0 Command-line history will not be saved.
7596 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7597 no / Since '/' is not specified, the default will be used,
7598 that is, save all of the search history, and also the
7599 previous search and substitute patterns.
7600 no % The buffer list will not be saved nor read back.
7601 no h 'hlsearch' highlighting will be restored.
7602
7603 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7604 load the contents of the file, this is not done automatically.
7605
7606 This option cannot be set from a |modeline| or in the |sandbox|, for
7607 security reasons.
7608
7609 *'virtualedit'* *'ve'*
7610'virtualedit' 've' string (default "")
7611 global
7612 {not in Vi}
7613 {not available when compiled without the
7614 |+virtualedit| feature}
7615 A comma separated list of these words:
7616 block Allow virtual editing in Visual block mode.
7617 insert Allow virtual editing in Insert mode.
7618 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007619 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007620
Bram Moolenaar071d4272004-06-13 20:20:40 +00007621 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007622 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007623 of the line. Useful for selecting a rectangle in Visual mode and
7624 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007625 "onemore" is not the same, it will only allow moving the cursor just
7626 after the last character of the line. This makes some commands more
7627 consistent. Previously the cursor was always past the end of the line
7628 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007629 break some plugins or Vim scripts. For example because |l| can move
7630 the cursor after the last character. Use with care!
7631 Using the |$| command will move to the last character in the line, not
7632 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007633 It doesn't make sense to combine "all" with "onemore", but you will
7634 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635
7636 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7637'visualbell' 'vb' boolean (default off)
7638 global
7639 {not in Vi}
7640 Use visual bell instead of beeping. The terminal code to display the
7641 visual bell is given with 't_vb'. When no beep or flash is wanted,
7642 use ":set vb t_vb=".
7643 Note: When the GUI starts, 't_vb' is reset to its default value. You
7644 might want to set it again in your |gvimrc|.
7645 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7646 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7647 where 40 is the time in msec.
7648 Does not work on the Amiga, you always get a screen flash.
7649 Also see 'errorbells'.
7650
7651 *'warn'* *'nowarn'*
7652'warn' boolean (default on)
7653 global
7654 Give a warning message when a shell command is used while the buffer
7655 has been changed.
7656
7657 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7658'weirdinvert' 'wiv' boolean (default off)
7659 global
7660 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007661 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662 It is provided for backwards compatibility with version 4.x.
7663 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7664 vice versa. Has no effect when the GUI is running.
7665
7666 *'whichwrap'* *'ww'*
7667'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7668 global
7669 {not in Vi}
7670 Allow specified keys that move the cursor left/right to move to the
7671 previous/next line when the cursor is on the first/last character in
7672 the line. Concatenate characters to allow this for these keys:
7673 char key mode ~
7674 b <BS> Normal and Visual
7675 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007676 h "h" Normal and Visual (not recommended)
7677 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007678 < <Left> Normal and Visual
7679 > <Right> Normal and Visual
7680 ~ "~" Normal
7681 [ <Left> Insert and Replace
7682 ] <Right> Insert and Replace
7683 For example: >
7684 :set ww=<,>,[,]
7685< allows wrap only when cursor keys are used.
7686 When the movement keys are used in combination with a delete or change
7687 operator, the <EOL> also counts for a character. This makes "3h"
7688 different from "3dh" when the cursor crosses the end of a line. This
7689 is also true for "x" and "X", because they do the same as "dl" and
7690 "dh". If you use this, you may also want to use the mapping
7691 ":map <BS> X" to make backspace delete the character in front of the
7692 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007693 When 'l' is included and it is used after an operator at the end of a
7694 line then it will not move to the next line. This makes "dl", "cl",
7695 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007696 NOTE: This option is set to the Vi default value when 'compatible' is
7697 set and to the Vim default value when 'compatible' is reset.
7698
7699 *'wildchar'* *'wc'*
7700'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7701 global
7702 {not in Vi}
7703 Character you have to type to start wildcard expansion in the
7704 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007705 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007706 The character is not recognized when used inside a macro. See
7707 'wildcharm' for that.
7708 Although 'wc' is a number option, you can set it to a special key: >
7709 :set wc=<Esc>
7710< NOTE: This option is set to the Vi default value when 'compatible' is
7711 set and to the Vim default value when 'compatible' is reset.
7712
7713 *'wildcharm'* *'wcm'*
7714'wildcharm' 'wcm' number (default: none (0))
7715 global
7716 {not in Vi}
7717 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007718 recognized when used inside a macro. You can find "spare" command-line
7719 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007720 you'll never actually type 'wildcharm', just use it in mappings that
7721 automatically invoke completion mode, e.g.: >
7722 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007723 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007724< Then after typing :ss you can use CTRL-P & CTRL-N.
7725
7726 *'wildignore'* *'wig'*
7727'wildignore' 'wig' string (default "")
7728 global
7729 {not in Vi}
7730 {not available when compiled without the |+wildignore|
7731 feature}
7732 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007733 patterns is ignored when completing file or directory names, and
7734 influences the result of |expand()|, |glob()| and |globpath()| unless
7735 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007736 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7737 Also see 'suffixes'.
7738 Example: >
7739 :set wildignore=*.o,*.obj
7740< The use of |:set+=| and |:set-=| is preferred when adding or removing
7741 a pattern from the list. This avoids problems when a future version
7742 uses another default.
7743
7744 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7745'wildmenu' 'wmnu' boolean (default off)
7746 global
7747 {not in Vi}
7748 {not available if compiled without the |+wildmenu|
7749 feature}
7750 When 'wildmenu' is on, command-line completion operates in an enhanced
7751 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7752 the possible matches are shown just above the command line, with the
7753 first match highlighted (overwriting the status line, if there is
7754 one). Keys that show the previous/next match, such as <Tab> or
7755 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7756 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7757 specified. "longest" and "list" do not start "wildmenu" mode.
7758 If there are more matches than can fit in the line, a ">" is shown on
7759 the right and/or a "<" is shown on the left. The status line scrolls
7760 as needed.
7761 The "wildmenu" mode is abandoned when a key is hit that is not used
7762 for selecting a completion.
7763 While the "wildmenu" is active the following keys have special
7764 meanings:
7765
7766 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7767 <Down> - in filename/menu name completion: move into a
7768 subdirectory or submenu.
7769 <CR> - in menu completion, when the cursor is just after a
7770 dot: move into a submenu.
7771 <Up> - in filename/menu name completion: move up into
7772 parent directory or parent menu.
7773
7774 This makes the menus accessible from the console |console-menus|.
7775
7776 If you prefer the <Left> and <Right> keys to move the cursor instead
7777 of selecting a different match, use this: >
7778 :cnoremap <Left> <Space><BS><Left>
7779 :cnoremap <Right> <Space><BS><Right>
7780<
7781 The "WildMenu" highlighting is used for displaying the current match
7782 |hl-WildMenu|.
7783
7784 *'wildmode'* *'wim'*
7785'wildmode' 'wim' string (Vim default: "full")
7786 global
7787 {not in Vi}
7788 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007789 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007790 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007791 first part specifies the behavior for the first use of 'wildchar',
7792 The second part for the second use, etc.
7793 These are the possible values for each part:
7794 "" Complete only the first match.
7795 "full" Complete the next full match. After the last match,
7796 the original string is used and then the first match
7797 again.
7798 "longest" Complete till longest common string. If this doesn't
7799 result in a longer string, use the next part.
7800 "longest:full" Like "longest", but also start 'wildmenu' if it is
7801 enabled.
7802 "list" When more than one match, list all matches.
7803 "list:full" When more than one match, list all matches and
7804 complete first match.
7805 "list:longest" When more than one match, list all matches and
7806 complete till longest common string.
7807 When there is only a single match, it is fully completed in all cases.
7808
7809 Examples: >
7810 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007811< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 :set wildmode=longest,full
7813< Complete longest common string, then each full match >
7814 :set wildmode=list:full
7815< List all matches and complete each full match >
7816 :set wildmode=list,full
7817< List all matches without completing, then each full match >
7818 :set wildmode=longest,list
7819< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007820 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007822 *'wildoptions'* *'wop'*
7823'wildoptions' 'wop' string (default "")
7824 global
7825 {not in Vi}
7826 {not available when compiled without the |+wildignore|
7827 feature}
7828 A list of words that change how command line completion is done.
7829 Currently only one word is allowed:
7830 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007831 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007832 is displayed per line. Often used tag kinds are:
7833 d #define
7834 f function
7835 Also see |cmdline-completion|.
7836
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837 *'winaltkeys'* *'wak'*
7838'winaltkeys' 'wak' string (default "menu")
7839 global
7840 {not in Vi}
7841 {only used in Win32, Motif, GTK and Photon GUI}
7842 Some GUI versions allow the access to menu entries by using the ALT
7843 key in combination with a character that appears underlined in the
7844 menu. This conflicts with the use of the ALT key for mappings and
7845 entering special characters. This option tells what to do:
7846 no Don't use ALT keys for menus. ALT key combinations can be
7847 mapped, but there is no automatic handling. This can then be
7848 done with the |:simalt| command.
7849 yes ALT key handling is done by the windowing system. ALT key
7850 combinations cannot be mapped.
7851 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007852 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007853 keys can be mapped.
7854 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7855 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007856 This option is not used for <F10>; on Win32 and with GTK <F10> will
7857 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007858
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007859 *'window'* *'wi'*
7860'window' 'wi' number (default screen height - 1)
7861 global
7862 Window height. Do not confuse this with the height of the Vim window,
7863 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007864 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7865 value is smaller than 'lines' minus one. The screen will scroll
7866 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007867 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7868 in a much smarter way, taking care of wrapping lines.
7869 When resizing the Vim window, the value is smaller than 1 or more than
7870 or equal to 'lines' it will be set to 'lines' minus 1.
7871 {Vi also uses the option to specify the number of displayed lines}
7872
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873 *'winheight'* *'wh'* *E591*
7874'winheight' 'wh' number (default 1)
7875 global
7876 {not in Vi}
7877 {not available when compiled without the +windows
7878 feature}
7879 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007880 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007881 focus goes to a window that is smaller, its size is increased, at the
7882 cost of the height of other windows.
7883 Set 'winheight' to a small number for normal editing.
7884 Set it to 999 to make the current window fill most of the screen.
7885 Other windows will be only 'winminheight' high. This has the drawback
7886 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7887 to create only two windows, set the option after startup is done,
7888 using the |VimEnter| event: >
7889 au VimEnter * set winheight=999
7890< Minimum value is 1.
7891 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 height of the current window.
7893 'winheight' applies to the current window. Use 'winminheight' to set
7894 the minimal height for other windows.
7895
7896 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7897'winfixheight' 'wfh' boolean (default off)
7898 local to window
7899 {not in Vi}
7900 {not available when compiled without the +windows
7901 feature}
7902 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007903 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7904 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007905 The height may be changed anyway when running out of room.
7906
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007907 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7908'winfixwidth' 'wfw' boolean (default off)
7909 local to window
7910 {not in Vi}
7911 {not available when compiled without the +windows
7912 feature}
7913 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007914 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007915 The width may be changed anyway when running out of room.
7916
Bram Moolenaar071d4272004-06-13 20:20:40 +00007917 *'winminheight'* *'wmh'*
7918'winminheight' 'wmh' number (default 1)
7919 global
7920 {not in Vi}
7921 {not available when compiled without the +windows
7922 feature}
7923 The minimal height of a window, when it's not the current window.
7924 This is a hard minimum, windows will never become smaller.
7925 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7926 status bar) if necessary. They will return to at least one line when
7927 they become active (since the cursor has to have somewhere to go.)
7928 Use 'winheight' to set the minimal height of the current window.
7929 This option is only checked when making a window smaller. Don't use a
7930 large number, it will cause errors when opening more than a few
7931 windows. A value of 0 to 3 is reasonable.
7932
7933 *'winminwidth'* *'wmw'*
7934'winminwidth' 'wmw' number (default 1)
7935 global
7936 {not in Vi}
7937 {not available when compiled without the +vertsplit
7938 feature}
7939 The minimal width of a window, when it's not the current window.
7940 This is a hard minimum, windows will never become smaller.
7941 When set to zero, windows may be "squashed" to zero columns (i.e. just
7942 a vertical separator) if necessary. They will return to at least one
7943 line when they become active (since the cursor has to have somewhere
7944 to go.)
7945 Use 'winwidth' to set the minimal width of the current window.
7946 This option is only checked when making a window smaller. Don't use a
7947 large number, it will cause errors when opening more than a few
7948 windows. A value of 0 to 12 is reasonable.
7949
7950 *'winwidth'* *'wiw'* *E592*
7951'winwidth' 'wiw' number (default 20)
7952 global
7953 {not in Vi}
7954 {not available when compiled without the +vertsplit
7955 feature}
7956 Minimal number of columns for the current window. This is not a hard
7957 minimum, Vim will use fewer columns if there is not enough room. If
7958 the current window is smaller, its size is increased, at the cost of
7959 the width of other windows. Set it to 999 to make the current window
7960 always fill the screen. Set it to a small number for normal editing.
7961 The width is not adjusted after one of the commands to change the
7962 width of the current window.
7963 'winwidth' applies to the current window. Use 'winminwidth' to set
7964 the minimal width for other windows.
7965
7966 *'wrap'* *'nowrap'*
7967'wrap' boolean (default on)
7968 local to window
7969 {not in Vi}
7970 This option changes how text is displayed. It doesn't change the text
7971 in the buffer, see 'textwidth' for that.
7972 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007973 displaying continues on the next line. When off lines will not wrap
7974 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 moved to a part that is not shown, the screen will scroll
7976 horizontally.
7977 The line will be broken in the middle of a word if necessary. See
7978 'linebreak' to get the break at a word boundary.
7979 To make scrolling horizontally a bit more useful, try this: >
7980 :set sidescroll=5
7981 :set listchars+=precedes:<,extends:>
7982< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007983 This option can't be set from a |modeline| when the 'diff' option is
7984 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007985
7986 *'wrapmargin'* *'wm'*
7987'wrapmargin' 'wm' number (default 0)
7988 local to buffer
7989 Number of characters from the right window border where wrapping
7990 starts. When typing text beyond this limit, an <EOL> will be inserted
7991 and inserting continues on the next line.
7992 Options that add a margin, such as 'number' and 'foldcolumn', cause
7993 the text width to be further reduced. This is Vi compatible.
7994 When 'textwidth' is non-zero, this option is not used.
7995 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7996 and less usefully}
7997
7998 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7999'wrapscan' 'ws' boolean (default on) *E384* *E385*
8000 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008001 Searches wrap around the end of the file. Also applies to |]s| and
8002 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008003
8004 *'write'* *'nowrite'*
8005'write' boolean (default on)
8006 global
8007 {not in Vi}
8008 Allows writing files. When not set, writing a file is not allowed.
8009 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008010 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011 argument. Filtering text is still possible, even though this requires
8012 writing a temporary file.
8013
8014 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8015'writeany' 'wa' boolean (default off)
8016 global
8017 Allows writing to any file with no need for "!" override.
8018
8019 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8020'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8021 otherwise)
8022 global
8023 {not in Vi}
8024 Make a backup before overwriting a file. The backup is removed after
8025 the file was successfully written, unless the 'backup' option is
8026 also on. Reset this option if your file system is almost full. See
8027 |backup-table| for another explanation.
8028 When the 'backupskip' pattern matches, a backup is not made anyway.
8029 NOTE: This option is set to the default value when 'compatible' is
8030 set.
8031
8032 *'writedelay'* *'wd'*
8033'writedelay' 'wd' number (default 0)
8034 global
8035 {not in Vi}
8036 The number of microseconds to wait for each character sent to the
8037 screen. When non-zero, characters are sent to the terminal one by
8038 one. For MS-DOS pcterm this does not work. For debugging purposes.
8039
8040 vim:tw=78:ts=8:ft=help:norl: