blob: 776717771a88eaa9920660da27499f5906f9402c [file] [log] [blame]
Bram Moolenaard28478b2010-07-18 23:29:58 +02001*options.txt* For Vim version 7.3b. Last change: 2010 May 13
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
53:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000054 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 'columns' are not changed. {not in Vi}
56
57 *:set-args* *E487* *E521*
58:se[t] {option}={value} or
59:se[t] {option}:{value}
60 Set string or number option to {value}.
61 For numeric options the value can be given in decimal,
62 hex (preceded with 0x) or octal (preceded with '0')
63 (hex and octal are only available for machines which
64 have the strtol() function).
65 The old value can be inserted by typing 'wildchar' (by
66 default this is a <Tab> or CTRL-E if 'compatible' is
67 set). See |cmdline-completion|.
68 White space between {option} and '=' is allowed and
69 will be ignored. White space between '=' and {value}
70 is not allowed.
71 See |option-backslash| for using white space and
72 backslashes in {value}.
73
74:se[t] {option}+={value} *:set+=*
75 Add the {value} to a number option, or append the
76 {value} to a string option. When the option is a
77 comma separated list, a comma is added, unless the
78 value was empty.
79 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000080 are removed. When adding a flag that was already
81 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000082 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 {not in Vi}
84
85:se[t] {option}^={value} *:set^=*
86 Multiply the {value} to a number option, or prepend
87 the {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 Also see |:set-args| above.
91 {not in Vi}
92
93:se[t] {option}-={value} *:set-=*
94 Subtract the {value} from a number option, or remove
95 the {value} from a string option, if it is there.
96 If the {value} is not found in a string option, there
97 is no error or warning. When the option is a comma
98 separated list, a comma is deleted, unless the option
99 becomes empty.
100 When the option is a list of flags, {value} must be
101 exactly as they appear in the option. Remove flags
102 one by one to avoid problems.
103 Also see |:set-args| above.
104 {not in Vi}
105
106The {option} arguments to ":set" may be repeated. For example: >
107 :set ai nosi sw=3 ts=3
108If you make an error in one of the arguments, an error message will be given
109and the following arguments will be ignored.
110
111 *:set-verbose*
112When 'verbose' is non-zero, displaying an option value will also tell where it
113was last set. Example: >
114 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000115< shiftwidth=4 ~
116 Last set from modeline ~
117 cindent ~
118 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
119This is only done when specific option values are requested, not for ":verbose
120set all" or ":verbose set" without an argument.
121When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122When the option was set while executing a function, user command or
123autocommand, the script in which it was defined is reported.
124Note that an option may also have been set as a side effect of setting
125'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000126A few special texts:
127 Last set from modeline ~
128 Option was set in a |modeline|.
129 Last set from --cmd argument ~
130 Option was set with command line argument |--cmd| or +.
131 Last set from -c argument ~
132 Option was set with command line argument |-c|, +, |-S| or
133 |-q|.
134 Last set from environment variable ~
135 Option was set from an environment variable, $VIMINIT,
136 $GVIMINIT or $EXINIT.
137 Last set from error handler ~
138 Option was cleared when evaluating it resulted in an error.
139
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140{not available when compiled without the +eval feature}
141
142 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000143For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144override the value from the termcap. You can then use it in a mapping. If
145the "xx" part contains special characters, use the <t_xx> form: >
146 :set <t_#4>=^[Ot
147This can also be used to translate a special code for a normal key. For
148example, if Alt-b produces <Esc>b, use this: >
149 :set <M-b>=^[b
150(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
151The advantage over a mapping is that it works in all situations.
152
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000153The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
154security reasons.
155
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000157at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158"set all" probably does not fit on the screen, causing Vim to give the
159|more-prompt|.
160
161 *option-backslash*
162To include white space in a string option value it has to be preceded with a
163backslash. To include a backslash you have to use two. Effectively this
164means that the number of backslashes in an option value is halved (rounded
165down).
166A few examples: >
167 :set tags=tags\ /usr/tags results in "tags /usr/tags"
168 :set tags=tags\\,file results in "tags\,file"
169 :set tags=tags\\\ file results in "tags\ file"
170
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000171The "|" character separates a ":set" command from a following command. To
172include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173'titlestring' option to "hi|there": >
174 :set titlestring=hi\|there
175This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
176 :set titlestring=hi|set iconstring=there
177
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000178Similarly, the double quote character starts a comment. To include the '"' in
179the option value, use '\"' instead. This example sets the 'titlestring'
180option to 'hi "there"': >
181 :set titlestring=hi\ \"there\"
182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000183For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184precise: For options that expect a file name (those where environment
185variables are expanded) a backslash before a normal file name character is not
186removed. But a backslash before a special character (space, backslash, comma,
187etc.) is used like explained above.
188There is one special situation, when the value starts with "\\": >
189 :set dir=\\machine\path results in "\\machine\path"
190 :set dir=\\\\machine\\path results in "\\machine\path"
191 :set dir=\\path\\file results in "\\path\file" (wrong!)
192For the first one the start is kept, but for the second one the backslashes
193are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000194halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195result which is probably not what you want. Avoid it.
196
197 *add-option-flags* *remove-option-flags*
198 *E539* *E550* *E551* *E552*
199Some options are a list of flags. When you want to add a flag to such an
200option, without changing the existing ones, you can do it like this: >
201 :set guioptions+=a
202Remove a flag from an option like this: >
203 :set guioptions-=a
204This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000205Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
207doesn't appear.
208
209 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000210Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211environment variable exists the '$' and the following environment variable
212name is replaced with its value. If it does not exist the '$' and the name
213are not modified. Any non-id character (not a letter, digit or '_') may
214follow the environment variable name. That character and what follows is
215appended to the value of the environment variable. Examples: >
216 :set term=$TERM.new
217 :set path=/usr/$INCLUDE,$HOME/include,.
218When adding or removing a string from an option with ":set opt-=val" or ":set
219opt+=val" the expansion is done before the adding or removing.
220
221
222Handling of local options *local-options*
223
224Some of the options only apply to a window or buffer. Each window or buffer
225has its own copy of this option, thus can each have their own value. This
226allows you to set 'list' in one window but not in another. And set
227'shiftwidth' to 3 in one buffer and 4 in another.
228
229The following explains what happens to these local options in specific
230situations. You don't really need to know all of this, since Vim mostly uses
231the option values you would expect. Unfortunately, doing what the user
232expects is a bit complicated...
233
234When splitting a window, the local options are copied to the new window. Thus
235right after the split the contents of the two windows look the same.
236
237When editing a new buffer, its local option values must be initialized. Since
238the local options of the current buffer might be specifically for that buffer,
239these are not used. Instead, for each buffer-local option there also is a
240global value, which is used for new buffers. With ":set" both the local and
241global value is changed. With "setlocal" only the local value is changed,
242thus this value is not used when editing a new buffer.
243
244When editing a buffer that has been edited before, the last used window
245options are used again. If this buffer has been edited in this window, the
246values from back then are used. Otherwise the values from the window where
247the buffer was edited last are used.
248
249It's possible to set a local window option specifically for a type of buffer.
250When you edit another buffer in the same window, you don't want to keep
251using these local window options. Therefore Vim keeps a global value of the
252local window options, which is used when editing another buffer. Each window
253has its own copy of these values. Thus these are local to the window, but
254global to all buffers in the window. With this you can do: >
255 :e one
256 :set list
257 :e two
258Now the 'list' option will also be set in "two", since with the ":set list"
259command you have also set the global value. >
260 :set nolist
261 :e one
262 :setlocal list
263 :e two
264Now the 'list' option is not set, because ":set nolist" resets the global
265value, ":setlocal list" only changes the local value and ":e two" gets the
266global value. Note that if you do this next: >
267 :e one
268You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000269"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270
271 *:setl* *:setlocal*
272:setl[ocal] ... Like ":set" but set only the value local to the
273 current buffer or window. Not all options have a
274 local value. If the option does not have a local
275 value the global value is set.
276 With the "all" argument: display all local option's
277 local values.
278 Without argument: Display all local option's local
279 values which are different from the default.
280 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000281 local value. For a global/local boolean option, when
282 the global value is being used, "--" is displayed
283 before the option name.
284 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285 shown (but that might change in the future).
286 {not in Vi}
287
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000288:setl[ocal] {option}< Set the local value of {option} to its global value by
289 copying the value.
290 {not in Vi}
291
292:se[t] {option}< Set the local value of {option} to its global value by
293 making it empty. Only makes sense for |global-local|
294 options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 {not in Vi}
296
297 *:setg* *:setglobal*
298:setg[lobal] ... Like ":set" but set only the global value for a local
299 option without changing the local value.
300 When displaying an option, the global value is shown.
301 With the "all" argument: display all local option's
302 global values.
303 Without argument: display all local option's global
304 values which are different from the default.
305 {not in Vi}
306
307For buffer-local and window-local options:
308 Command global value local value ~
309 :set option=value set set
310 :setlocal option=value - set
311:setglobal option=value set -
312 :set option? - display
313 :setlocal option? - display
314:setglobal option? display -
315
316
317Global options with a local value *global-local*
318
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000319Options are global when you mostly use one value for all buffers and windows.
320For some global options it's useful to sometimes have a different local value.
321You can set the local value with ":setlocal". That buffer or window will then
322use the local value, while other buffers and windows continue using the global
323value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324
325For example, you have two windows, both on C source code. They use the global
326'makeprg' option. If you do this in one of the two windows: >
327 :set makeprg=gmake
328then the other window will switch to the same value. There is no need to set
329the 'makeprg' option in the other C source window too.
330However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000331another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000332files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333 :setlocal makeprg=perlmake
334You can switch back to using the global value by making the local value empty: >
335 :setlocal makeprg=
336This only works for a string option. For a boolean option you need to use the
337"<" flag, like this: >
338 :setlocal autoread<
339Note that for non-boolean options using "<" copies the global value to the
340local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000341when the global value changes later). You can also use: >
342 :set path<
343This will make the local value of 'path' empty, so that the global value is
344used. Thus it does the same as: >
345 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346Note: In the future more global options can be made global-local. Using
347":setlocal" on a global option might work differently then.
348
349
350Setting the filetype
351
352:setf[iletype] {filetype} *:setf* *:setfiletype*
353 Set the 'filetype' option to {filetype}, but only if
354 not done yet in a sequence of (nested) autocommands.
355 This is short for: >
356 :if !did_filetype()
357 : setlocal filetype={filetype}
358 :endif
359< This command is used in a filetype.vim file to avoid
360 setting the 'filetype' option twice, causing different
361 settings and syntax files to be loaded.
362 {not in Vi}
363
364:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
365:opt[ions] Open a window for viewing and setting all options.
366 Options are grouped by function.
367 Offers short help for each option. Hit <CR> on the
368 short help to open a help window with more help for
369 the option.
370 Modify the value of the option and hit <CR> on the
371 "set" line to set the new value. For window and
372 buffer specific options, the last accessed window is
373 used to set the option value in, unless this is a help
374 window, in which case the window below help window is
375 used (skipping the option-window).
376 {not available when compiled without the |+eval| or
377 |+autocmd| features}
378
379 *$HOME*
380Using "~" is like using "$HOME", but it is only recognized at the start of an
381option and after a space or comma.
382
383On Unix systems "~user" can be used too. It is replaced by the home directory
384of user "user". Example: >
385 :set path=~mool/include,/usr/include,.
386
387On Unix systems the form "${HOME}" can be used too. The name between {} can
388contain non-id characters then. Note that if you want to use this for the
389"gf" command, you need to add the '{' and '}' characters to 'isfname'.
390
391NOTE: expanding environment variables and "~/" is only done with the ":set"
392command, not when assigning a value to an option with ":let".
393
394
395Note the maximum length of an expanded option is limited. How much depends on
396the system, mostly it is something like 256 or 1024 characters.
397
398 *:fix* *:fixdel*
399:fix[del] Set the value of 't_kD':
400 't_kb' is 't_kD' becomes ~
401 CTRL-? CTRL-H
402 not CTRL-? CTRL-?
403
404 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
405
406 If your delete key terminal code is wrong, but the
407 code for backspace is alright, you can put this in
408 your .vimrc: >
409 :fixdel
410< This works no matter what the actual code for
411 backspace is.
412
413 If the backspace key terminal code is wrong you can
414 use this: >
415 :if &term == "termname"
416 : set t_kb=^V<BS>
417 : fixdel
418 :endif
419< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000420 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421 with your terminal name.
422
423 If your <Delete> key sends a strange key sequence (not
424 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
425 :if &term == "termname"
426 : set t_kD=^V<Delete>
427 :endif
428< Where "^V" is CTRL-V and "<Delete>" is the delete key
429 (don't type eight characters!). Replace "termname"
430 with your terminal name.
431
432 *Linux-backspace*
433 Note about Linux: By default the backspace key
434 produces CTRL-?, which is wrong. You can fix it by
435 putting this line in your rc.local: >
436 echo "keycode 14 = BackSpace" | loadkeys
437<
438 *NetBSD-backspace*
439 Note about NetBSD: If your backspace doesn't produce
440 the right code, try this: >
441 xmodmap -e "keycode 22 = BackSpace"
442< If this works, add this in your .Xmodmap file: >
443 keysym 22 = BackSpace
444< You need to restart for this to take effect.
445
446==============================================================================
4472. Automatically setting options *auto-setting*
448
449Besides changing options with the ":set" command, there are three alternatives
450to set options automatically for one or more files:
451
4521. When starting Vim initializations are read from various places. See
453 |initialization|. Most of them are performed for all editing sessions,
454 and some of them depend on the directory where Vim is started.
455 You can create an initialization file with |:mkvimrc|, |:mkview| and
456 |:mksession|.
4572. If you start editing a new file, the automatic commands are executed.
458 This can be used to set options for files matching a particular pattern and
459 many other things. See |autocommand|.
4603. If you start editing a new file, and the 'modeline' option is on, a
461 number of lines at the beginning and end of the file are checked for
462 modelines. This is explained here.
463
464 *modeline* *vim:* *vi:* *ex:* *E520*
465There are two forms of modelines. The first form:
466 [text]{white}{vi:|vim:|ex:}[white]{options}
467
468[text] any text or empty
469{white} at least one blank character (<Space> or <Tab>)
470{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
471[white] optional white space
472{options} a list of option settings, separated with white space or ':',
473 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000474 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000476Example:
477 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478
479The second form (this is compatible with some versions of Vi):
480
481 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
482
483[text] any text or empty
484{white} at least one blank character (<Space> or <Tab>)
485{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
486[white] optional white space
487se[t] the string "set " or "se " (note the space)
488{options} a list of options, separated with white space, which is the
489 argument for a ":set" command
490: a colon
491[text] any text or empty
492
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000493Example:
494 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495
496The white space before {vi:|vim:|ex:} is required. This minimizes the chance
497that a normal word like "lex:" is caught. There is one exception: "vi:" and
498"vim:" can also be at the start of the line (for compatibility with version
4993.0). Using "ex:" at the start of the line will be ignored (this could be
500short for "example:").
501
502 *modeline-local*
503The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000504buffer and window that contain the file. Although it's possible to set global
505options from a modeline, this is unusual. If you have two windows open and
506the files in it set the same global option to a different value, the result
507depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000509When editing a file that was already loaded, only the window-local options
510from the modeline are used. Thus if you manually changed a buffer-local
511option after opening the file, it won't be changed if you edit the same buffer
512in another window. But window-local options will be set.
513
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514 *modeline-version*
515If the modeline is only to be used for some versions of Vim, the version
516number can be specified where "vim:" is used:
517 vim{vers}: version {vers} or later
518 vim<{vers}: version before {vers}
519 vim={vers}: version {vers}
520 vim>{vers}: version after {vers}
521{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000522For example, to use a modeline only for Vim 6.0 and later:
523 /* vim600: set foldmethod=marker: */ ~
524To use a modeline for Vim before version 5.7:
525 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526There can be no blanks between "vim" and the ":".
527
528
529The number of lines that are checked can be set with the 'modelines' option.
530If 'modeline' is off or 'modelines' is 0 no lines are checked.
531
532Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000533like:
534 /* vi:ts=4: */ ~
535will give an error message for the trailing "*/". This line is OK:
536 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538If an error is detected the rest of the line is skipped.
539
540If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000541backslash in front of the ':' will be removed. Example:
542 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543This sets the 'dir' option to "c:\tmp". Only a single backslash before the
544':' is removed. Thus to include "\:" you have to specify "\\:".
545
546No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000547might create a Trojan horse text file with modelines). And not all options
548can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000549|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000550causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
551are wrapped unexpectedly. So disable modelines before editing untrusted text.
552The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553
554Hint: If you would like to do something else than setting an option, you could
555define an autocommand that checks the file for a specific string. For
556example: >
557 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
558And define a function SetVar() that does something with the line containing
559"VAR".
560
561==============================================================================
5623. Options summary *option-summary*
563
564In the list below all the options are mentioned with their full name and with
565an abbreviation if there is one. Both forms may be used.
566
567In this document when a boolean option is "set" that means that ":set option"
568is entered. When an option is "reset", ":set nooption" is used.
569
570For some options there are two default values: The "Vim default", which is
571used when 'compatible' is not set, and the "Vi default", which is used when
572'compatible' is set.
573
574Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000575are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576different value in each window. For example the 'list' option can be set in
577one window and reset in another for the same text, giving both types of view
578at the same time. There are a few options that are specific to a certain
579file. These can have a different value for each file or buffer. For example
580the 'textwidth' option can be 78 for a normal text file and 0 for a C
581program.
582
583 global one option for all buffers and windows
584 local to window each window has its own copy of this option
585 local to buffer each buffer has its own copy of this option
586
587When creating a new window the option values from the currently active window
588are used as a default value for the window-specific options. For the
589buffer-specific options this depends on the 's' and 'S' flags in the
590'cpoptions' option. If 's' is included (which is the default) the values for
591buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000592first entered. If 'S' is present the options are copied each time the buffer
593is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594present, the options are copied from the currently active buffer when the
595buffer is created.
596
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000597Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000599Not all options are supported in all versions. This depends on the supported
600features and sometimes on the system. A remark about this is in curly braces
601below. When an option is not supported it may still be set without getting an
602error, this is called a hidden option. You can't get the value of a hidden
603option though, it is not stored.
604
605To test if option "foo" can be used with ":set" use something like this: >
606 if exists('&foo')
607This also returns true for a hidden option. To test if option "foo" is really
608supported use something like this: >
609 if exists('+foo')
610<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 *E355*
612A jump table for the options with a short description can be found at |Q_op|.
613
614 *'aleph'* *'al'* *aleph* *Aleph*
615'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
616 global
617 {not in Vi}
618 {only available when compiled with the |+rightleft|
619 feature}
620 The ASCII code for the first letter of the Hebrew alphabet. The
621 routine that maps the keyboard in Hebrew mode, both in Insert mode
622 (when hkmap is set) and on the command-line (when hitting CTRL-_)
623 outputs the Hebrew characters in the range [aleph..aleph+26].
624 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
625 See |rileft.txt|.
626
627 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
628'allowrevins' 'ari' boolean (default off)
629 global
630 {not in Vi}
631 {only available when compiled with the |+rightleft|
632 feature}
633 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
634 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
635 into reverse Insert mode, and don't know how to get out. See
636 'revins'.
637 NOTE: This option is reset when 'compatible' is set.
638
639 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
640'altkeymap' 'akm' boolean (default off)
641 global
642 {not in Vi}
643 {only available when compiled with the |+farsi|
644 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000645 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 the keyboard map between Farsi and English, when 'allowrevins' set.
647
Bram Moolenaar582fd852005-03-28 20:58:01 +0000648 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 is useful to start the Vim in native mode i.e. English (left-to-right
650 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000651 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
653 *'ambiwidth'* *'ambw'*
654'ambiwidth' 'ambw' string (default: "single")
655 global
656 {not in Vi}
657 {only available when compiled with the |+multi_byte|
658 feature}
659 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
660 Tells Vim what to do with characters with East Asian Width Class
661 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
662 letters, Cyrillic letters).
663
664 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000665 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 expected by most users.
667 "double": Use twice the width of ASCII characters.
668
669 There are a number of CJK fonts for which the width of glyphs for
670 those characters are solely based on how many octets they take in
671 legacy/traditional CJK encodings. In those encodings, Euro,
672 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000673 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000675 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 Vim is running inside a terminal (emulators) that uses a CJK font
677 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
678 this option should be set to "double" to match the width perceived
679 by Vim with the width of glyphs in the font. Perhaps it also has
680 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
681 when the system locale is set to one of CJK locales. See Unicode
682 Standard Annex #11 (http://www.unicode.org/reports/tr11).
683
684 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
685'antialias' 'anti' boolean (default: off)
686 global
687 {not in Vi}
688 {only available when compiled with GUI enabled
689 on Mac OS X}
690 This option only has an effect in the GUI version of Vim on Mac OS X
691 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
692 which can be easier to read at certain sizes on certain displays.
693 Setting this option can sometimes cause problems if 'guifont' is set
694 to its default (empty string).
695
696 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
697'autochdir' 'acd' boolean (default off)
698 global
699 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200700 {only available when compiled with it, use
701 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000702 When on, Vim will change the current working directory whenever you
703 open a file, switch buffers, delete a buffer or open/close a window.
704 It will change to the directory containing the file which was opened
705 or selected.
706 This option is provided for backward compatibility with the Vim
707 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000708 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709
710 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
711'arabic' 'arab' boolean (default off)
712 local to window
713 {not in Vi}
714 {only available when compiled with the |+arabic|
715 feature}
716 This option can be set to start editing Arabic text.
717 Setting this option will:
718 - Set the 'rightleft' option, unless 'termbidi' is set.
719 - Set the 'arabicshape' option, unless 'termbidi' is set.
720 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
721 between typing English and Arabic key mapping.
722 - Set the 'delcombine' option
723 Note that 'encoding' must be "utf-8" for working with Arabic text.
724
725 Resetting this option will:
726 - Reset the 'rightleft' option.
727 - Disable the use of 'keymap' (without changing its value).
728 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
729 option.
730 Also see |arabic.txt|.
731
732 *'arabicshape'* *'arshape'*
733 *'noarabicshape'* *'noarshape'*
734'arabicshape' 'arshape' boolean (default on)
735 global
736 {not in Vi}
737 {only available when compiled with the |+arabic|
738 feature}
739 When on and 'termbidi' is off, the required visual character
740 corrections that need to take place for displaying the Arabic language
741 take affect. Shaping, in essence, gets enabled; the term is a broad
742 one which encompasses:
743 a) the changing/morphing of characters based on their location
744 within a word (initial, medial, final and stand-alone).
745 b) the enabling of the ability to compose characters
746 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100747 When disabled the display shows each character's true stand-alone
748 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 Arabic is a complex language which requires other settings, for
750 further details see |arabic.txt|.
751
752 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
753'autoindent' 'ai' boolean (default off)
754 local to buffer
755 Copy indent from current line when starting a new line (typing <CR>
756 in Insert mode or when using the "o" or "O" command). If you do not
757 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000758 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
759 to another line has the same effect, unless the 'I' flag is included
760 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000761 When autoindent is on, formatting (with the "gq" command or when you
762 reach 'textwidth' in Insert mode) uses the indentation of the first
763 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 When 'smartindent' or 'cindent' is on the indent is changed in
765 a different way.
766 The 'autoindent' option is reset when the 'paste' option is set.
767 {small difference from Vi: After the indent is deleted when typing
768 <Esc> or <CR>, the cursor position when moving up or down is after the
769 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
770
771 *'autoread'* *'ar'* *'noautoread'* *'noar'*
772'autoread' 'ar' boolean (default off)
773 global or local to buffer |global-local|
774 {not in Vi}
775 When a file has been detected to have been changed outside of Vim and
776 it has not been changed inside of Vim, automatically read it again.
777 When the file has been deleted this is not done. |timestamp|
778 If this option has a local value, use this command to switch back to
779 using the global value: >
780 :set autoread<
781<
782 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
783'autowrite' 'aw' boolean (default off)
784 global
785 Write the contents of the file, if it has been modified, on each
786 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000787 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
789 Note that for some commands the 'autowrite' option is not used, see
790 'autowriteall' for that.
791
792 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
793'autowriteall' 'awa' boolean (default off)
794 global
795 {not in Vi}
796 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
797 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
798 Setting this option also implies that Vim behaves like 'autowrite' has
799 been set.
800
801 *'background'* *'bg'*
802'background' 'bg' string (default "dark" or "light")
803 global
804 {not in Vi}
805 When set to "dark", Vim will try to use colors that look good on a
806 dark background. When set to "light", Vim will try to use colors that
807 look good on a light background. Any other value is illegal.
808 Vim tries to set the default value according to the terminal used.
809 This will not always be correct.
810 Setting this option does not change the background color, it tells Vim
811 what the background color looks like. For changing the background
812 color, see |:hi-normal|.
813
814 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000815 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000816 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100817 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 setting 'background' will cause the color scheme to be reloaded. If
819 the color scheme adjusts to the value of 'background' this will work.
820 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100821 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822
823 When setting 'background' to the default value with: >
824 :set background&
825< Vim will guess the value. In the GUI this should work correctly,
826 in other cases Vim might not be able to guess the right value.
827
828 When starting the GUI, the default value for 'background' will be
829 "light". When the value is not set in the .gvimrc, and Vim detects
830 that the background is actually quite dark, 'background' is set to
831 "dark". But this happens only AFTER the .gvimrc file has been read
832 (because the window needs to be opened to find the actual background
833 color). To get around this, force the GUI window to be opened by
834 putting a ":gui" command in the .gvimrc file, before where the value
835 of 'background' is used (e.g., before ":syntax on").
836 Normally this option would be set in the .vimrc file. Possibly
837 depending on the terminal name. Example: >
838 :if &term == "pcterm"
839 : set background=dark
840 :endif
841< When this option is set, the default settings for the highlight groups
842 will change. To use other settings, place ":highlight" commands AFTER
843 the setting of the 'background' option.
844 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
845 to select the colors for syntax highlighting. After changing this
846 option, you must load syntax.vim again to see the result. This can be
847 done with ":syntax on".
848
849 *'backspace'* *'bs'*
850'backspace' 'bs' string (default "")
851 global
852 {not in Vi}
853 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
854 mode. This is a list of items, separated by commas. Each item allows
855 a way to backspace over something:
856 value effect ~
857 indent allow backspacing over autoindent
858 eol allow backspacing over line breaks (join lines)
859 start allow backspacing over the start of insert; CTRL-W and CTRL-U
860 stop once at the start of insert.
861
862 When the value is empty, Vi compatible backspacing is used.
863
864 For backwards compatibility with version 5.4 and earlier:
865 value effect ~
866 0 same as ":set backspace=" (Vi compatible)
867 1 same as ":set backspace=indent,eol"
868 2 same as ":set backspace=indent,eol,start"
869
870 See |:fixdel| if your <BS> or <Del> key does not do what you want.
871 NOTE: This option is set to "" when 'compatible' is set.
872
873 *'backup'* *'bk'* *'nobackup'* *'nobk'*
874'backup' 'bk' boolean (default off)
875 global
876 {not in Vi}
877 Make a backup before overwriting a file. Leave it around after the
878 file has been successfully written. If you do not want to keep the
879 backup file, but you do want a backup while the file is being
880 written, reset this option and set the 'writebackup' option (this is
881 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000882 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 |backup-table| for more explanations.
884 When the 'backupskip' pattern matches, a backup is not made anyway.
885 When 'patchmode' is set, the backup may be renamed to become the
886 oldest version of a file.
887 NOTE: This option is reset when 'compatible' is set.
888
889 *'backupcopy'* *'bkc'*
890'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
891 global
892 {not in Vi}
893 When writing a file and a backup is made, this option tells how it's
894 done. This is a comma separated list of words.
895
896 The main values are:
897 "yes" make a copy of the file and overwrite the original one
898 "no" rename the file and write a new one
899 "auto" one of the previous, what works best
900
901 Extra values that can be combined with the ones above are:
902 "breaksymlink" always break symlinks when writing
903 "breakhardlink" always break hardlinks when writing
904
905 Making a copy and overwriting the original file:
906 - Takes extra time to copy the file.
907 + When the file has special attributes, is a (hard/symbolic) link or
908 has a resource fork, all this is preserved.
909 - When the file is a link the backup will have the name of the link,
910 not of the real file.
911
912 Renaming the file and writing a new one:
913 + It's fast.
914 - Sometimes not all attributes of the file can be copied to the new
915 file.
916 - When the file is a link the new file will not be a link.
917
918 The "auto" value is the middle way: When Vim sees that renaming file
919 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000920 the file is not a link) that is used. When problems are expected, a
921 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922
923 The "breaksymlink" and "breakhardlink" values can be used in
924 combination with any of "yes", "no" and "auto". When included, they
925 force Vim to always break either symbolic or hard links by doing
926 exactly what the "no" option does, renaming the original file to
927 become the backup and writing a new file in its place. This can be
928 useful for example in source trees where all the files are symbolic or
929 hard links and any changes should stay in the local source tree, not
930 be propagated back to the original source.
931 *crontab*
932 One situation where "no" and "auto" will cause problems: A program
933 that opens a file, invokes Vim to edit that file, and then tests if
934 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000935 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 example.
937
938 When a copy is made, the original file is truncated and then filled
939 with the new text. This means that protection bits, owner and
940 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000941 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 group of the backup is set to the group of the original file. If this
943 fails, the protection bits for the group are made the same as for
944 others.
945
946 When the file is renamed this is the other way around: The backup has
947 the same attributes of the original file, and the newly written file
948 is owned by the current user. When the file was a (hard/symbolic)
949 link, the new file will not! That's why the "auto" value doesn't
950 rename when the file is a link. The owner and group of the newly
951 written file will be set to the same ones as the original file, but
952 the system may refuse to do this. In that case the "auto" value will
953 again not rename the file.
954
955 *'backupdir'* *'bdir'*
956'backupdir' 'bdir' string (default for Amiga: ".,t:",
957 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
958 for Unix: ".,~/tmp,~/")
959 global
960 {not in Vi}
961 List of directories for the backup file, separated with commas.
962 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100963 where this is possible. The directory must exist, Vim will not
964 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 - Empty means that no backup file will be created ('patchmode' is
966 impossible!). Writing may fail because of this.
967 - A directory "." means to put the backup file in the same directory
968 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000969 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 put the backup file relative to where the edited file is. The
971 leading "." is replaced with the path name of the edited file.
972 ("." inside a directory name has no special meaning).
973 - Spaces after the comma are ignored, other spaces are considered part
974 of the directory name. To have a space at the start of a directory
975 name, precede it with a backslash.
976 - To include a comma in a directory name precede it with a backslash.
977 - A directory name may end in an '/'.
978 - Environment variables are expanded |:set_env|.
979 - Careful with '\' characters, type one before a space, type two to
980 get one in the option (see |option-backslash|), for example: >
981 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
982< - For backwards compatibility with Vim version 3.0 a '>' at the start
983 of the option is removed.
984 See also 'backup' and 'writebackup' options.
985 If you want to hide your backup files on Unix, consider this value: >
986 :set backupdir=./.backup,~/.backup,.,/tmp
987< You must create a ".backup" directory in each directory and in your
988 home directory for this to work properly.
989 The use of |:set+=| and |:set-=| is preferred when adding or removing
990 directories from the list. This avoids problems when a future version
991 uses another default.
992 This option cannot be set from a |modeline| or in the |sandbox|, for
993 security reasons.
994
995 *'backupext'* *'bex'* *E589*
996'backupext' 'bex' string (default "~", for VMS: "_")
997 global
998 {not in Vi}
999 String which is appended to a file name to make the name of the
1000 backup file. The default is quite unusual, because this avoids
1001 accidentally overwriting existing files with a backup file. You might
1002 prefer using ".bak", but make sure that you don't have files with
1003 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001004 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001006 If you like to keep a lot of backups, you could use a BufWritePre
1007 autocommand to change 'backupext' just before writing the file to
1008 include a timestamp. >
1009 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1010< Use 'backupdir' to put the backup in a different directory.
1011
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 *'backupskip'* *'bsk'*
1013'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1014 global
1015 {not in Vi}
1016 {not available when compiled without the |+wildignore|
1017 feature}
1018 A list of file patterns. When one of the patterns matches with the
1019 name of the file which is written, no backup file is created. Both
1020 the specified file name and the full path name of the file are used.
1021 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1022 Watch out for special characters, see |option-backslash|.
1023 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001024 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001025
1026 Note that environment variables are not expanded. If you want to use
1027 $HOME you must expand it explicitly, e.g.: >
1028 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1029
1030< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001031 backup would be made by renaming the original file crontab won't see
1032 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033
1034 *'balloondelay'* *'bdlay'*
1035'balloondelay' 'bdlay' number (default: 600)
1036 global
1037 {not in Vi}
1038 {only available when compiled with the |+balloon_eval|
1039 feature}
1040 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1041
1042 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1043'ballooneval' 'beval' boolean (default off)
1044 global
1045 {not in Vi}
1046 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001047 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 Switch on the |balloon-eval| functionality.
1049
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001050 *'balloonexpr'* *'bexpr'*
1051'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001052 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001053 {not in Vi}
1054 {only available when compiled with the |+balloon_eval|
1055 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001056 Expression for text to show in evaluation balloon. It is only used
1057 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001058
1059 v:beval_bufnr number of the buffer in which balloon is going to show
1060 v:beval_winnr number of the window
1061 v:beval_lnum line number
1062 v:beval_col column number (byte index)
1063 v:beval_text word under or after the mouse pointer
1064
1065 The evaluation of the expression must not have side effects!
1066 Example: >
1067 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001068 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001069 \', column ' . v:beval_col .
1070 \ ' of file ' . bufname(v:beval_bufnr) .
1071 \ ' on word "' . v:beval_text . '"'
1072 endfunction
1073 set bexpr=MyBalloonExpr()
1074 set ballooneval
1075<
1076 NOTE: The balloon is displayed only if the cursor is on a text
1077 character. If the result of evaluating 'balloonexpr' is not empty,
1078 Vim does not try to send a message to an external debugger (Netbeans
1079 or Sun Workshop).
1080
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001081 The expression may be evaluated in the |sandbox|, see
1082 |sandbox-option|.
1083
1084 It is not allowed to change text or jump to another window while
1085 evaluating 'balloonexpr' |textlock|.
1086
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001087 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001088 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001089< When they are supported "\n" characters will start a new line. If the
1090 expression evaluates to a |List| this is equal to using each List item
1091 as a string and putting "\n" in between them.
1092
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1094'binary' 'bin' boolean (default off)
1095 local to buffer
1096 {not in Vi}
1097 This option should be set before editing a binary file. You can also
1098 use the |-b| Vim argument. When this option is switched on a few
1099 options will be changed (also when it already was on):
1100 'textwidth' will be set to 0
1101 'wrapmargin' will be set to 0
1102 'modeline' will be off
1103 'expandtab' will be off
1104 Also, 'fileformat' and 'fileformats' options will not be used, the
1105 file is read and written like 'fileformat' was "unix" (a single <NL>
1106 separates lines).
1107 The 'fileencoding' and 'fileencodings' options will not be used, the
1108 file is read without conversion.
1109 NOTE: When you start editing a(nother) file while the 'bin' option is
1110 on, settings from autocommands may change the settings again (e.g.,
1111 'textwidth'), causing trouble when editing. You might want to set
1112 'bin' again when the file has been loaded.
1113 The previous values of these options are remembered and restored when
1114 'bin' is switched from on to off. Each buffer has its own set of
1115 saved option values.
1116 To edit a file with 'binary' set you can use the |++bin| argument.
1117 This avoids you have to do ":set bin", which would have effect for all
1118 files you edit.
1119 When writing a file the <EOL> for the last line is only written if
1120 there was one in the original file (normally Vim appends an <EOL> to
1121 the last line if there is none; this would make the file longer). See
1122 the 'endofline' option.
1123
1124 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1125'bioskey' 'biosk' boolean (default on)
1126 global
1127 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001128 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129 better to detect CTRL-C, but only works for the console. When using a
1130 terminal over a serial port reset this option.
1131 Also see |'conskey'|.
1132
1133 *'bomb'* *'nobomb'*
1134'bomb' boolean (default off)
1135 local to buffer
1136 {not in Vi}
1137 {only available when compiled with the |+multi_byte|
1138 feature}
1139 When writing a file and the following conditions are met, a BOM (Byte
1140 Order Mark) is prepended to the file:
1141 - this option is on
1142 - the 'binary' option is off
1143 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1144 endian variants.
1145 Some applications use the BOM to recognize the encoding of the file.
1146 Often used for UCS-2 files on MS-Windows. For other applications it
1147 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001148 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1150 check for the presence of the BOM is done and 'bomb' set accordingly.
1151 Unless 'binary' is set, it is removed from the first line, so that you
1152 don't see it when editing. When you don't change the options, the BOM
1153 will be restored when writing the file.
1154
1155 *'breakat'* *'brk'*
1156'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1157 global
1158 {not in Vi}
1159 {not available when compiled without the |+linebreak|
1160 feature}
1161 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001162 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1163 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164
1165 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001166'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001168 {not in Vi} {only for Motif, Athena, GTK, Mac and
1169 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001171 last Use same directory as with last file browser, where a
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 Moolenaar860cae12010-06-05 23:22:07 +02001710'conceallevel' 'conc' *'conceallevel'* *'conc'*
1711 number (default 0)
1712 local to window
1713 {not in Vi}
1714 {not available when compiled without the |+conceal|
1715 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001716 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1717 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001718
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001719 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001720 0 Text is shown normally
1721 1 Each block of concealed text is replaced with the
1722 character defined in 'listchars' (default is a dash)
1723 and highlighted with the "Conceal" highlight group.
1724 2 Concealed text is completely hidden unless it has a
1725 custom replacement character defined (see
1726 |:syn-cchar|.
Bram Moolenaara7781e02010-07-19 20:13:22 +02001727 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001728
Bram Moolenaara7781e02010-07-19 20:13:22 +02001729 Note: in the cursor line concealed text is not hidden, so that you can
1730 edit and copy the text.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001731
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1733'confirm' 'cf' boolean (default off)
1734 global
1735 {not in Vi}
1736 When 'confirm' is on, certain operations that would normally
1737 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1738 instead raise a |dialog| asking if you wish to save the current
1739 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1740 If 'confirm' is off you can still activate confirmation for one
1741 command only (this is most useful in mappings) with the |:confirm|
1742 command.
1743 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1744
1745 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1746'conskey' 'consk' boolean (default off)
1747 global
1748 {not in Vi} {only for MS-DOS}
1749 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001750 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751 three methods of console input are available:
1752 'conskey' 'bioskey' action ~
1753 on on or off direct console input
1754 off on BIOS
1755 off off STDIN
1756
1757 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1758'copyindent' 'ci' boolean (default off)
1759 local to buffer
1760 {not in Vi}
1761 Copy the structure of the existing lines indent when autoindenting a
1762 new line. Normally the new indent is reconstructed by a series of
1763 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1764 in which case only spaces are used). Enabling this option makes the
1765 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001766 existing line. 'expandtab' has no effect on these characters, a Tab
1767 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768 line, the remaining space is filled in the normal manner.
1769 NOTE: 'copyindent' is reset when 'compatible' is set.
1770 Also see 'preserveindent'.
1771
1772 *'cpoptions'* *'cpo'*
1773'cpoptions' 'cpo' string (Vim default: "aABceFs",
1774 Vi default: all flags)
1775 global
1776 {not in Vi}
1777 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001778 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 not being vi-compatible is mostly or sometimes preferred.
1780 'cpoptions' stands for "compatible-options".
1781 Commas can be added for readability.
1782 To avoid problems with flags that are added in the future, use the
1783 "+=" and "-=" feature of ":set" |add-option-flags|.
1784 NOTE: This option is set to the Vi default value when 'compatible' is
1785 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001786 NOTE: This option is set to the POSIX default value at startup when
1787 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001788 variable exists |posix|. This means Vim tries to behave like the
1789 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790
1791 contains behavior ~
1792 *cpo-a*
1793 a When included, a ":read" command with a file name
1794 argument will set the alternate file name for the
1795 current window.
1796 *cpo-A*
1797 A When included, a ":write" command with a file name
1798 argument will set the alternate file name for the
1799 current window.
1800 *cpo-b*
1801 b "\|" in a ":map" command is recognized as the end of
1802 the map command. The '\' is included in the mapping,
1803 the text after the '|' is interpreted as the next
1804 command. Use a CTRL-V instead of a backslash to
1805 include the '|' in the mapping. Applies to all
1806 mapping, abbreviation, menu and autocmd commands.
1807 See also |map_bar|.
1808 *cpo-B*
1809 B A backslash has no special meaning in mappings,
1810 abbreviations and the "to" part of the menu commands.
1811 Remove this flag to be able to use a backslash like a
1812 CTRL-V. For example, the command ":map X \<Esc>"
1813 results in X being mapped to:
1814 'B' included: "\^[" (^[ is a real <Esc>)
1815 'B' excluded: "<Esc>" (5 characters)
1816 ('<' excluded in both cases)
1817 *cpo-c*
1818 c Searching continues at the end of any match at the
1819 cursor position, but not further than the start of the
1820 next line. When not present searching continues
1821 one character from the cursor position. With 'c'
1822 "abababababab" only gets three matches when repeating
1823 "/abab", without 'c' there are five matches.
1824 *cpo-C*
1825 C Do not concatenate sourced lines that start with a
1826 backslash. See |line-continuation|.
1827 *cpo-d*
1828 d Using "./" in the 'tags' option doesn't mean to use
1829 the tags file relative to the current file, but the
1830 tags file in the current directory.
1831 *cpo-D*
1832 D Can't use CTRL-K to enter a digraph after Normal mode
1833 commands with a character argument, like |r|, |f| and
1834 |t|.
1835 *cpo-e*
1836 e When executing a register with ":@r", always add a
1837 <CR> to the last line, also when the register is not
1838 linewise. If this flag is not present, the register
1839 is not linewise and the last line does not end in a
1840 <CR>, then the last line is put on the command-line
1841 and can be edited before hitting <CR>.
1842 *cpo-E*
1843 E It is an error when using "y", "d", "c", "g~", "gu" or
1844 "gU" on an Empty region. The operators only work when
1845 at least one character is to be operate on. Example:
1846 This makes "y0" fail in the first column.
1847 *cpo-f*
1848 f When included, a ":read" command with a file name
1849 argument will set the file name for the current buffer,
1850 if the current buffer doesn't have a file name yet.
1851 *cpo-F*
1852 F When included, a ":write" command with a file name
1853 argument will set the file name for the current
1854 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001855 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 *cpo-g*
1857 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001858 *cpo-H*
1859 H When using "I" on a line with only blanks, insert
1860 before the last blank. Without this flag insert after
1861 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862 *cpo-i*
1863 i When included, interrupting the reading of a file will
1864 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001865 *cpo-I*
1866 I When moving the cursor up or down just after inserting
1867 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868 *cpo-j*
1869 j When joining lines, only add two spaces after a '.',
1870 not after '!' or '?'. Also see 'joinspaces'.
1871 *cpo-J*
1872 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001873 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874 white space.
1875 *cpo-k*
1876 k Disable the recognition of raw key codes in
1877 mappings, abbreviations, and the "to" part of menu
1878 commands. For example, if <Key> sends ^[OA (where ^[
1879 is <Esc>), the command ":map X ^[OA" results in X
1880 being mapped to:
1881 'k' included: "^[OA" (3 characters)
1882 'k' excluded: "<Key>" (one key code)
1883 Also see the '<' flag below.
1884 *cpo-K*
1885 K Don't wait for a key code to complete when it is
1886 halfway a mapping. This breaks mapping <F1><F1> when
1887 only part of the second <F1> has been read. It
1888 enables cancelling the mapping by typing <F1><Esc>.
1889 *cpo-l*
1890 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001891 literally, only "\]", "\^", "\-" and "\\" are special.
1892 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1894 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001895 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 *cpo-L*
1897 L When the 'list' option is set, 'wrapmargin',
1898 'textwidth', 'softtabstop' and Virtual Replace mode
1899 (see |gR|) count a <Tab> as two characters, instead of
1900 the normal behavior of a <Tab>.
1901 *cpo-m*
1902 m When included, a showmatch will always wait half a
1903 second. When not included, a showmatch will wait half
1904 a second or until a character is typed. |'showmatch'|
1905 *cpo-M*
1906 M When excluded, "%" matching will take backslashes into
1907 account. Thus in "( \( )" and "\( ( \)" the outer
1908 parenthesis match. When included "%" ignores
1909 backslashes, which is Vi compatible.
1910 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001911 n When included, the column used for 'number' and
1912 'relativenumber' will also be used for text of wrapped
1913 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 *cpo-o*
1915 o Line offset to search command is not remembered for
1916 next search.
1917 *cpo-O*
1918 O Don't complain if a file is being overwritten, even
1919 when it didn't exist when editing it. This is a
1920 protection against a file unexpectedly created by
1921 someone else. Vi didn't complain about this.
1922 *cpo-p*
1923 p Vi compatible Lisp indenting. When not present, a
1924 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001925 *cpo-P*
1926 P When included, a ":write" command that appends to a
1927 file will set the file name for the current buffer, if
1928 the current buffer doesn't have a file name yet and
1929 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001930 *cpo-q*
1931 q When joining multiple lines leave the cursor at the
1932 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 *cpo-r*
1934 r Redo ("." command) uses "/" to repeat a search
1935 command, instead of the actually used search string.
1936 *cpo-R*
1937 R Remove marks from filtered lines. Without this flag
1938 marks are kept like |:keepmarks| was used.
1939 *cpo-s*
1940 s Set buffer options when entering the buffer for the
1941 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001942 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 set when the buffer is created.
1944 *cpo-S*
1945 S Set buffer options always when entering a buffer
1946 (except 'readonly', 'fileformat', 'filetype' and
1947 'syntax'). This is the (most) Vi compatible setting.
1948 The options are set to the values in the current
1949 buffer. When you change an option and go to another
1950 buffer, the value is copied. Effectively makes the
1951 buffer options global to all buffers.
1952
1953 's' 'S' copy buffer options
1954 no no when buffer created
1955 yes no when buffer first entered (default)
1956 X yes each time when buffer entered (vi comp.)
1957 *cpo-t*
1958 t Search pattern for the tag command is remembered for
1959 "n" command. Otherwise Vim only puts the pattern in
1960 the history for search pattern, but doesn't change the
1961 last used search pattern.
1962 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001963 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964 *cpo-v*
1965 v Backspaced characters remain visible on the screen in
1966 Insert mode. Without this flag the characters are
1967 erased from the screen right away. With this flag the
1968 screen newly typed text overwrites backspaced
1969 characters.
1970 *cpo-w*
1971 w When using "cw" on a blank character, only change one
1972 character and not all blanks until the start of the
1973 next word.
1974 *cpo-W*
1975 W Don't overwrite a readonly file. When omitted, ":w!"
1976 overwrites a readonly file, if possible.
1977 *cpo-x*
1978 x <Esc> on the command-line executes the command-line.
1979 The default in Vim is to abandon the command-line,
1980 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001981 *cpo-X*
1982 X When using a count with "R" the replaced text is
1983 deleted only once. Also when repeating "R" with "."
1984 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001985 *cpo-y*
1986 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001987 *cpo-Z*
1988 Z When using "w!" while the 'readonly' option is set,
1989 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990 *cpo-!*
1991 ! When redoing a filter command, use the last used
1992 external command, whatever it was. Otherwise the last
1993 used -filter- command is used.
1994 *cpo-$*
1995 $ When making a change to one line, don't redisplay the
1996 line, but put a '$' at the end of the changed text.
1997 The changed text will be overwritten when you type the
1998 new text. The line is redisplayed if you type any
1999 command that moves the cursor from the insertion
2000 point.
2001 *cpo-%*
2002 % Vi-compatible matching is done for the "%" command.
2003 Does not recognize "#if", "#endif", etc.
2004 Does not recognize "/*" and "*/".
2005 Parens inside single and double quotes are also
2006 counted, causing a string that contains a paren to
2007 disturb the matching. For example, in a line like
2008 "if (strcmp("foo(", s))" the first paren does not
2009 match the last one. When this flag is not included,
2010 parens inside single and double quotes are treated
2011 specially. When matching a paren outside of quotes,
2012 everything inside quotes is ignored. When matching a
2013 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002014 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002015 This flag is also used for other features, such as
2016 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002017 *cpo--*
2018 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002019 it would go above the first line or below the last
2020 line. Without it the cursor moves to the first or
2021 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002022 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002023 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002024 *cpo-+*
2025 + When included, a ":write file" command will reset the
2026 'modified' flag of the buffer, even though the buffer
2027 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002028 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 * Use ":*" in the same way as ":@". When not included,
2030 ":*" is an alias for ":'<,'>", select the Visual area.
2031 *cpo-<*
2032 < Disable the recognition of special key codes in |<>|
2033 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002034 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035 ":map X <Tab>" results in X being mapped to:
2036 '<' included: "<Tab>" (5 characters)
2037 '<' excluded: "^I" (^I is a real <Tab>)
2038 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002039 *cpo->*
2040 > When appending to a register, put a line break before
2041 the appended text.
2042
2043 POSIX flags. These are not included in the Vi default value, except
2044 when $VIM_POSIX was set on startup. |posix|
2045
2046 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002047 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002048 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002049 *cpo-&*
2050 & When ":preserve" was used keep the swap file when
2051 exiting normally while this buffer is still loaded.
2052 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002053 *cpo-\*
2054 \ Backslash in a [] range in a search pattern is taken
2055 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002056 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2057 '\' excluded: "/[ \-]" finds <Space> and '-'
2058 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002059 *cpo-/*
2060 / When "%" is used as the replacement string in a |:s|
2061 command, use the previous replacement string. |:s%|
2062 *cpo-{*
2063 { The |{| and |}| commands also stop at a "{" character
2064 at the start of a line.
2065 *cpo-.*
2066 . The ":chdir" and ":cd" commands fail if the current
2067 buffer is modified, unless ! is used. Vim doesn't
2068 need this, since it remembers the full path of an
2069 opened file.
2070 *cpo-bar*
2071 | The value of the $LINES and $COLUMNS environment
2072 variables overrule the terminal size values obtained
2073 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002074
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002076 *'cryptmethod'* *'cm'*
2077'cryptmethod' number (default 0)
2078 local to buffer
2079 {not in Vi}
2080 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002081 *pkzip*
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002082 0 PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002083 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002084 *blowfish*
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002085 1 Blowfish method. Strong encryption. Requires Vim 7.3
2086 or later, files can NOT be read by Vim 7.2 and older.
2087 This adds a "seed" to the file, every time you write
2088 the file the encrypted bytes will be different.
2089
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002090 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002091 to the detected method of the file being read. Thus if you write it
2092 without changing 'cryptmethod' the same method will be used.
2093 Changing 'cryptmethod' does not mark the file as modified, you have to
2094 explicitly write it when not making modifications.
2095 Also see |:X|.
2096 When a new encryption method is added in a later version of Vim, and
2097 the current version does not recognize it, you will get *E821* .
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002098
2099
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100 *'cscopepathcomp'* *'cspc'*
2101'cscopepathcomp' 'cspc' number (default 0)
2102 global
2103 {not available when compiled without the |+cscope|
2104 feature}
2105 {not in Vi}
2106 Determines how many components of the path to show in a list of tags.
2107 See |cscopepathcomp|.
2108
2109 *'cscopeprg'* *'csprg'*
2110'cscopeprg' 'csprg' string (default "cscope")
2111 global
2112 {not available when compiled without the |+cscope|
2113 feature}
2114 {not in Vi}
2115 Specifies the command to execute cscope. See |cscopeprg|.
2116 This option cannot be set from a |modeline| or in the |sandbox|, for
2117 security reasons.
2118
2119 *'cscopequickfix'* *'csqf'*
2120'cscopequickfix' 'csqf' string (default "")
2121 global
2122 {not available when compiled without the |+cscope|
2123 or |+quickfix| features}
2124 {not in Vi}
2125 Specifies whether to use quickfix window to show cscope results.
2126 See |cscopequickfix|.
2127
2128 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2129'cscopetag' 'cst' boolean (default off)
2130 global
2131 {not available when compiled without the |+cscope|
2132 feature}
2133 {not in Vi}
2134 Use cscope for tag commands. See |cscope-options|.
2135 NOTE: This option is reset when 'compatible' is set.
2136
2137 *'cscopetagorder'* *'csto'*
2138'cscopetagorder' 'csto' number (default 0)
2139 global
2140 {not available when compiled without the |+cscope|
2141 feature}
2142 {not in Vi}
2143 Determines the order in which ":cstag" performs a search. See
2144 |cscopetagorder|.
2145 NOTE: This option is set to 0 when 'compatible' is set.
2146
2147 *'cscopeverbose'* *'csverb'*
2148 *'nocscopeverbose'* *'nocsverb'*
2149'cscopeverbose' 'csverb' boolean (default off)
2150 global
2151 {not available when compiled without the |+cscope|
2152 feature}
2153 {not in Vi}
2154 Give messages when adding a cscope database. See |cscopeverbose|.
2155 NOTE: This option is reset when 'compatible' is set.
2156
Bram Moolenaar860cae12010-06-05 23:22:07 +02002157 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2158'cursorbind' 'crb' boolean (default off)
2159 local to window
2160 {not in Vi}
2161 {not available when compiled without the |+cursorbind|
2162 feature}
2163 When this option is set, as the cursor in the current
2164 window moves other cursorbound windows (windows that also have
2165 this option set) move their cursors to the corresponding line and
2166 column. This option is useful for viewing the
2167 differences between two versions of a file (see 'diff'); in diff mode,
2168 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002169 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002170
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002171
2172 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2173'cursorcolumn' 'cuc' boolean (default off)
2174 local to window
2175 {not in Vi}
2176 {not available when compiled without the |+syntax|
2177 feature}
2178 Highlight the screen column of the cursor with CursorColumn
2179 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2180 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002181 If you only want the highlighting in the current window you can use
2182 these autocommands: >
2183 au WinLeave * set nocursorline nocursorcolumn
2184 au WinEnter * set cursorline cursorcolumn
2185<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002186
2187 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2188'cursorline' 'cul' boolean (default off)
2189 local to window
2190 {not in Vi}
2191 {not available when compiled without the |+syntax|
2192 feature}
2193 Highlight the screen line of the cursor with CursorLine
2194 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2195 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002196 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002197 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002198
2199
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200 *'debug'*
2201'debug' string (default "")
2202 global
2203 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002204 These values can be used:
2205 msg Error messages that would otherwise be omitted will be given
2206 anyway.
2207 throw Error messages that would otherwise be omitted will be given
2208 anyway and also throw an exception and set |v:errmsg|.
2209 beep A message will be given when otherwise only a beep would be
2210 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002211 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002212 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2213 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214
2215 *'define'* *'def'*
2216'define' 'def' string (default "^\s*#\s*define")
2217 global or local to buffer |global-local|
2218 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002219 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220 pattern, just like for the "/" command. This option is used for the
2221 commands like "[i" and "[d" |include-search|. The 'isident' option is
2222 used to recognize the defined name after the match:
2223 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2224 See |option-backslash| about inserting backslashes to include a space
2225 or backslash.
2226 The default value is for C programs. For C++ this value would be
2227 useful, to include const type declarations: >
2228 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2229< When using the ":set" command, you need to double the backslashes!
2230
2231 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2232'delcombine' 'deco' boolean (default off)
2233 global
2234 {not in Vi}
2235 {only available when compiled with the |+multi_byte|
2236 feature}
2237 If editing Unicode and this option is set, backspace and Normal mode
2238 "x" delete each combining character on its own. When it is off (the
2239 default) the character along with its combining characters are
2240 deleted.
2241 Note: When 'delcombine' is set "xx" may work different from "2x"!
2242
2243 This is useful for Arabic, Hebrew and many other languages where one
2244 may have combining characters overtop of base characters, and want
2245 to remove only the combining ones.
2246
2247 *'dictionary'* *'dict'*
2248'dictionary' 'dict' string (default "")
2249 global or local to buffer |global-local|
2250 {not in Vi}
2251 List of file names, separated by commas, that are used to lookup words
2252 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2253 contain a list of words. This can be one word per line, or several
2254 words per line, separated by non-keyword characters (white space is
2255 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002256 When this option is empty, or an entry "spell" is present, spell
2257 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002258 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 after a comma are ignored, otherwise spaces are included in the file
2260 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002261 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262 Where to find a list of words?
2263 - On FreeBSD, there is the file "/usr/share/dict/words".
2264 - In the Simtel archive, look in the "msdos/linguist" directory.
2265 - In "miscfiles" of the GNU collection.
2266 The use of |:set+=| and |:set-=| is preferred when adding or removing
2267 directories from the list. This avoids problems when a future version
2268 uses another default.
2269 Backticks cannot be used in this option for security reasons.
2270
2271 *'diff'* *'nodiff'*
2272'diff' boolean (default off)
2273 local to window
2274 {not in Vi}
2275 {not available when compiled without the |+diff|
2276 feature}
2277 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002278 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279
2280 *'dex'* *'diffexpr'*
2281'diffexpr' 'dex' string (default "")
2282 global
2283 {not in Vi}
2284 {not available when compiled without the |+diff|
2285 feature}
2286 Expression which is evaluated to obtain an ed-style diff file from two
2287 versions of a file. See |diff-diffexpr|.
2288 This option cannot be set from a |modeline| or in the |sandbox|, for
2289 security reasons.
2290
2291 *'dip'* *'diffopt'*
2292'diffopt' 'dip' string (default "filler")
2293 global
2294 {not in Vi}
2295 {not available when compiled without the |+diff|
2296 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002297 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002298 All are optional. Items must be separated by a comma.
2299
2300 filler Show filler lines, to keep the text
2301 synchronized with a window that has inserted
2302 lines at the same position. Mostly useful
2303 when windows are side-by-side and 'scrollbind'
2304 is set.
2305
2306 context:{n} Use a context of {n} lines between a change
2307 and a fold that contains unchanged lines.
2308 When omitted a context of six lines is used.
2309 See |fold-diff|.
2310
2311 icase Ignore changes in case of text. "a" and "A"
2312 are considered the same. Adds the "-i" flag
2313 to the "diff" command if 'diffexpr' is empty.
2314
2315 iwhite Ignore changes in amount of white space. Adds
2316 the "-b" flag to the "diff" command if
2317 'diffexpr' is empty. Check the documentation
2318 of the "diff" command for what this does
2319 exactly. It should ignore adding trailing
2320 white space, but not leading white space.
2321
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002322 horizontal Start diff mode with horizontal splits (unless
2323 explicitly specified otherwise).
2324
2325 vertical Start diff mode with vertical splits (unless
2326 explicitly specified otherwise).
2327
2328 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2329 starting diff mode. Without this 2 is used.
2330
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331 Examples: >
2332
2333 :set diffopt=filler,context:4
2334 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002335 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336<
2337 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2338'digraph' 'dg' boolean (default off)
2339 global
2340 {not in Vi}
2341 {not available when compiled without the |+digraphs|
2342 feature}
2343 Enable the entering of digraphs in Insert mode with {char1} <BS>
2344 {char2}. See |digraphs|.
2345 NOTE: This option is reset when 'compatible' is set.
2346
2347 *'directory'* *'dir'*
2348'directory' 'dir' string (default for Amiga: ".,t:",
2349 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2350 for Unix: ".,~/tmp,/var/tmp,/tmp")
2351 global
2352 List of directory names for the swap file, separated with commas.
2353 - The swap file will be created in the first directory where this is
2354 possible.
2355 - Empty means that no swap file will be used (recovery is
2356 impossible!).
2357 - A directory "." means to put the swap file in the same directory as
2358 the edited file. On Unix, a dot is prepended to the file name, so
2359 it doesn't show in a directory listing. On MS-Windows the "hidden"
2360 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002361 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002362 put the swap file relative to where the edited file is. The leading
2363 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002364 - For Unix and Win32, if a directory ends in two path separators "//"
2365 or "\\", the swap file name will be built from the complete path to
2366 the file with all path separators substituted to percent '%' signs.
2367 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002368 On Win32, when a separating comma is following, you must use "//",
2369 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370 - Spaces after the comma are ignored, other spaces are considered part
2371 of the directory name. To have a space at the start of a directory
2372 name, precede it with a backslash.
2373 - To include a comma in a directory name precede it with a backslash.
2374 - A directory name may end in an ':' or '/'.
2375 - Environment variables are expanded |:set_env|.
2376 - Careful with '\' characters, type one before a space, type two to
2377 get one in the option (see |option-backslash|), for example: >
2378 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2379< - For backwards compatibility with Vim version 3.0 a '>' at the start
2380 of the option is removed.
2381 Using "." first in the list is recommended. This means that editing
2382 the same file twice will result in a warning. Using "/tmp" on Unix is
2383 discouraged: When the system crashes you lose the swap file.
2384 "/var/tmp" is often not cleared when rebooting, thus is a better
2385 choice than "/tmp". But it can contain a lot of files, your swap
2386 files get lost in the crowd. That is why a "tmp" directory in your
2387 home directory is tried first.
2388 The use of |:set+=| and |:set-=| is preferred when adding or removing
2389 directories from the list. This avoids problems when a future version
2390 uses another default.
2391 This option cannot be set from a |modeline| or in the |sandbox|, for
2392 security reasons.
2393 {Vi: directory to put temp file in, defaults to "/tmp"}
2394
2395 *'display'* *'dy'*
2396'display' 'dy' string (default "")
2397 global
2398 {not in Vi}
2399 Change the way text is displayed. This is comma separated list of
2400 flags:
2401 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002402 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403 last line that doesn't fit is replaced with "@" lines.
2404 uhex Show unprintable characters hexadecimal as <xx>
2405 instead of using ^C and ~C.
2406
2407 *'eadirection'* *'ead'*
2408'eadirection' 'ead' string (default "both")
2409 global
2410 {not in Vi}
2411 {not available when compiled without the +vertsplit
2412 feature}
2413 Tells when the 'equalalways' option applies:
2414 ver vertically, width of windows is not affected
2415 hor horizontally, height of windows is not affected
2416 both width and height of windows is affected
2417
2418 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2419'edcompatible' 'ed' boolean (default off)
2420 global
2421 Makes the 'g' and 'c' flags of the ":substitute" command to be
2422 toggled each time the flag is given. See |complex-change|. See
2423 also 'gdefault' option.
2424 Switching this option on is discouraged!
2425
2426 *'encoding'* *'enc'* *E543*
2427'encoding' 'enc' string (default: "latin1" or value from $LANG)
2428 global
2429 {only available when compiled with the |+multi_byte|
2430 feature}
2431 {not in Vi}
2432 Sets the character encoding used inside Vim. It applies to text in
2433 the buffers, registers, Strings in expressions, text stored in the
2434 viminfo file, etc. It sets the kind of characters which Vim can work
2435 with. See |encoding-names| for the possible values.
2436
2437 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002438 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002440 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002441
Bram Moolenaar865242e2010-07-14 21:12:05 +02002442 This option cannot be set from a |modeline|. It would most likely
2443 corrupt the text.
2444
Bram Moolenaar071d4272004-06-13 20:20:40 +00002445 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2446 "utf-8". Although care has been taken to allow different values of
2447 'encoding', "utf-8" is the natural choice for the environment and
2448 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002449 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450 versions, and to avoid changing the encoding of newly created files
2451 without your knowledge (in case 'fileencodings' is empty).
2452
2453 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002454 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455 iconv() or as specified with 'charconvert'.
2456
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002457 If you need to know whether 'encoding' is a multi-byte encoding, you
2458 can use: >
2459 if has("multi_byte_encoding")
2460<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002461 Normally 'encoding' will be equal to your current locale. This will
2462 be the default if Vim recognizes your environment settings. If
2463 'encoding' is not set to the current locale, 'termencoding' must be
2464 set to convert typed and displayed text. See |encoding-table|.
2465
2466 When you set this option, it fires the |EncodingChanged| autocommand
2467 event so that you can set up fonts if necessary.
2468
2469 When the option is set, the value is converted to lowercase. Thus
2470 you can set it with uppercase values too. Underscores are translated
2471 to '-' signs.
2472 When the encoding is recognized, it is changed to the standard name.
2473 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2474 "iso-8859-2" and "utf8" becomes "utf-8".
2475
2476 Note: "latin1" is also used when the encoding could not be detected.
2477 This only works when editing files in the same encoding! When the
2478 actual character set is not latin1, make sure 'fileencoding' and
2479 'fileencodings' are empty. When conversion is needed, switch to using
2480 utf-8.
2481
2482 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2483 You don't notice this while editing, but it does matter for the
2484 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2485 setting 'encoding' to one of these values instead of utf-8 only has
2486 effect for encoding used for files when 'fileencoding' is empty.
2487
Bram Moolenaar661b1822005-07-28 22:36:45 +00002488 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2489 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002490
2491 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2492'endofline' 'eol' boolean (default on)
2493 local to buffer
2494 {not in Vi}
2495 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002496 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497 option is automatically set when starting to edit a new file, unless
2498 the file does not have an <EOL> for the last line in the file, in
2499 which case it is reset. Normally you don't have to set or reset this
2500 option. When 'binary' is off the value is not used when writing the
2501 file. When 'binary' is on it is used to remember the presence of a
2502 <EOL> for the last line in the file, so that when you write the file
2503 the situation from the original file can be kept. But you can change
2504 it if you want to.
2505
2506 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2507'equalalways' 'ea' boolean (default on)
2508 global
2509 {not in Vi}
2510 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002511 splitting or closing a window. This also happens the moment the
2512 option is switched on. When off, splitting a window will reduce the
2513 size of the current window and leave the other windows the same. When
2514 closing a window the extra lines are given to the window next to it
2515 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 When mixing vertically and horizontally split windows, a minimal size
2517 is computed and some windows may be larger if there is room. The
2518 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002519 Changing the height and width of a window can be avoided by setting
2520 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002521 If a window size is specified when creating a new window sizes are
2522 currently not equalized (it's complicated, but may be implemented in
2523 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524
2525 *'equalprg'* *'ep'*
2526'equalprg' 'ep' string (default "")
2527 global or local to buffer |global-local|
2528 {not in Vi}
2529 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002530 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002531 or 'indentexpr'. When Vim was compiled without internal formatting,
2532 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002533 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 about including spaces and backslashes.
2535 This option cannot be set from a |modeline| or in the |sandbox|, for
2536 security reasons.
2537
2538 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2539'errorbells' 'eb' boolean (default off)
2540 global
2541 Ring the bell (beep or screen flash) for error messages. This only
2542 makes a difference for error messages, the bell will be used always
2543 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002544 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545 screen flash or do nothing.
2546
2547 *'errorfile'* *'ef'*
2548'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2549 others: "errors.err")
2550 global
2551 {not in Vi}
2552 {not available when compiled without the |+quickfix|
2553 feature}
2554 Name of the errorfile for the QuickFix mode (see |:cf|).
2555 When the "-q" command-line argument is used, 'errorfile' is set to the
2556 following argument. See |-q|.
2557 NOT used for the ":make" command. See 'makeef' for that.
2558 Environment variables are expanded |:set_env|.
2559 See |option-backslash| about including spaces and backslashes.
2560 This option cannot be set from a |modeline| or in the |sandbox|, for
2561 security reasons.
2562
2563 *'errorformat'* *'efm'*
2564'errorformat' 'efm' string (default is very long)
2565 global or local to buffer |global-local|
2566 {not in Vi}
2567 {not available when compiled without the |+quickfix|
2568 feature}
2569 Scanf-like description of the format for the lines in the error file
2570 (see |errorformat|).
2571
2572 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2573'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2574 global
2575 {not in Vi}
2576 Function keys that start with an <Esc> are recognized in Insert
2577 mode. When this option is off, the cursor and function keys cannot be
2578 used in Insert mode if they start with an <Esc>. The advantage of
2579 this is that the single <Esc> is recognized immediately, instead of
2580 after one second. Instead of resetting this option, you might want to
2581 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2582 when 'esckeys' is off, you can still map anything, but the cursor keys
2583 won't work by default.
2584 NOTE: This option is set to the Vi default value when 'compatible' is
2585 set and to the Vim default value when 'compatible' is reset.
2586
2587 *'eventignore'* *'ei'*
2588'eventignore' 'ei' string (default "")
2589 global
2590 {not in Vi}
2591 {not available when compiled without the |+autocmd|
2592 feature}
2593 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002594 When set to "all" or when "all" is one of the items, all autocommand
2595 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 Otherwise this is a comma separated list of event names. Example: >
2597 :set ei=WinEnter,WinLeave
2598<
2599 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2600'expandtab' 'et' boolean (default off)
2601 local to buffer
2602 {not in Vi}
2603 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002604 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2606 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2607 NOTE: This option is reset when 'compatible' is set.
2608
2609 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2610'exrc' 'ex' boolean (default off)
2611 global
2612 {not in Vi}
2613 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2614 directory. If you switch this option on you should also consider
2615 setting the 'secure' option (see |initialization|). Using a local
2616 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2617 also see |.vimrc| and |gui-init|.
2618 This option cannot be set from a |modeline| or in the |sandbox|, for
2619 security reasons.
2620
2621 *'fileencoding'* *'fenc'* *E213*
2622'fileencoding' 'fenc' string (default: "")
2623 local to buffer
2624 {only available when compiled with the |+multi_byte|
2625 feature}
2626 {not in Vi}
2627 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002628
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002630 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631 When 'fileencoding' is empty, the same value as 'encoding' will be
2632 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002633 Conversion will also be done when 'encoding' and 'fileencoding' are
2634 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2635 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002637 'encoding' is "utf-8" or another Unicode encoding, conversion
2638 is most likely done in a way that the reverse conversion
2639 results in the same text. When 'encoding' is not "utf-8" some
2640 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002641
Bram Moolenaar071d4272004-06-13 20:20:40 +00002642 See 'encoding' for the possible values. Additionally, values may be
2643 specified that can be handled by the converter, see
2644 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002645
Bram Moolenaar071d4272004-06-13 20:20:40 +00002646 When reading a file 'fileencoding' will be set from 'fileencodings'.
2647 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002648 'fileencoding', use the |++enc| argument. One exception: when
2649 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002650 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002651
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2653 When the option is set, the value is converted to lowercase. Thus
2654 you can set it with uppercase values too. '_' characters are
2655 replaced with '-'. If a name is recognized from the list for
2656 'encoding', it is replaced by the standard name. For example
2657 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002658
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659 When this option is set, after starting to edit a file, the 'modified'
2660 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002661
2662 Keep in mind that changing 'fenc' from a modeline happens
2663 AFTER the text has been read, thus it applies to when the file will be
2664 written. If you do set 'fenc' in a modeline, you might want to set
2665 'nomodified' to avoid not being able to ":q".
2666
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 This option can not be changed when 'modifiable' is off.
2668
2669 *'fe'*
2670 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002671 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672 old short name was 'fe', which is no longer used.
2673
2674 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002675'fileencodings' 'fencs' string (default: "ucs-bom",
2676 "ucs-bom,utf-8,default,latin1" when
2677 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 global
2679 {only available when compiled with the |+multi_byte|
2680 feature}
2681 {not in Vi}
2682 This is a list of character encodings considered when starting to edit
2683 an existing file. When a file is read, Vim tries to use the first
2684 mentioned character encoding. If an error is detected, the next one
2685 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002686 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 an empty string, which means the value of 'encoding' is used.
2688 WARNING: Conversion can cause loss of information! When
2689 'encoding' is "utf-8" (or one of the other Unicode variants)
2690 conversion is most likely done in a way that the reverse
2691 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002692 "utf-8" some non-ASCII characters may be lost! You can use
2693 the |++bad| argument to specify what is done with characters
2694 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 For an empty file or a file with only ASCII characters most encodings
2696 will work and the first entry of 'fileencodings' will be used (except
2697 "ucs-bom", which requires the BOM to be present). If you prefer
2698 another encoding use an BufReadPost autocommand event to test if your
2699 preferred encoding is to be used. Example: >
2700 au BufReadPost * if search('\S', 'w') == 0 |
2701 \ set fenc=iso-2022-jp | endif
2702< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2703 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002704 When the |++enc| argument is used then the value of 'fileencodings' is
2705 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002706 Note that 'fileencodings' is not used for a new file, the global value
2707 of 'fileencoding' is used instead. You can set it with: >
2708 :setglobal fenc=iso-8859-2
2709< This means that a non-existing file may get a different encoding than
2710 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 The special value "ucs-bom" can be used to check for a Unicode BOM
2712 (Byte Order Mark) at the start of the file. It must not be preceded
2713 by "utf-8" or another Unicode encoding for this to work properly.
2714 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2715 because Vim cannot detect an error, thus the encoding is always
2716 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002717 The special value "default" can be used for the encoding from the
2718 environment. This is the default value for 'encoding'. It is useful
2719 when 'encoding' is set to "utf-8" and your environment uses a
2720 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002721 When 'encoding' is "utf-8" and a file contains an illegal byte
2722 sequence it won't be recognized as UTF-8. You can use the |8g8|
2723 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 WRONG VALUES: WHAT'S WRONG:
2725 latin1,utf-8 "latin1" will always be used
2726 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2727 file
2728 cp1250,latin1 "cp1250" will always be used
2729 If 'fileencodings' is empty, 'fileencoding' is not modified.
2730 See 'fileencoding' for the possible values.
2731 Setting this option does not have an effect until the next time a file
2732 is read.
2733
2734 *'fileformat'* *'ff'*
2735'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2736 Unix default: "unix",
2737 Macintosh default: "mac")
2738 local to buffer
2739 {not in Vi}
2740 This gives the <EOL> of the current buffer, which is used for
2741 reading/writing the buffer from/to a file:
2742 dos <CR> <NL>
2743 unix <NL>
2744 mac <CR>
2745 When "dos" is used, CTRL-Z at the end of a file is ignored.
2746 See |file-formats| and |file-read|.
2747 For the character encoding of the file see 'fileencoding'.
2748 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2749 works like it was set to "unix'.
2750 This option is set automatically when starting to edit a file and
2751 'fileformats' is not empty and 'binary' is off.
2752 When this option is set, after starting to edit a file, the 'modified'
2753 option is set, because the file would be different when written.
2754 This option can not be changed when 'modifiable' is off.
2755 For backwards compatibility: When this option is set to "dos",
2756 'textmode' is set, otherwise 'textmode' is reset.
2757
2758 *'fileformats'* *'ffs'*
2759'fileformats' 'ffs' string (default:
2760 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2761 Vim Unix: "unix,dos",
2762 Vim Mac: "mac,unix,dos",
2763 Vi Cygwin: "unix,dos",
2764 Vi others: "")
2765 global
2766 {not in Vi}
2767 This gives the end-of-line (<EOL>) formats that will be tried when
2768 starting to edit a new buffer and when reading a file into an existing
2769 buffer:
2770 - When empty, the format defined with 'fileformat' will be used
2771 always. It is not set automatically.
2772 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002773 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 'fileformats' name will be used when a file is read into an existing
2775 buffer, no matter what 'fileformat' for that buffer is set to.
2776 - When more than one name is present, separated by commas, automatic
2777 <EOL> detection will be done when reading a file. When starting to
2778 edit a file, a check is done for the <EOL>:
2779 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2780 'fileformat' is set to "dos".
2781 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002782 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 preceding <CR>, "unix" is preferred over "dos".
2784 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2785 This means that "mac" is only chosen when "unix" is not present,
2786 or when no <NL> is found in the file, and when "dos" is not
2787 present, or no <CR><NL> is present in the file.
2788 Also if "unix" was first chosen, but the first <CR> is before
2789 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2790 the file, then 'fileformat' is set to "mac".
2791 4. If 'fileformat' is still not set, the first name from
2792 'fileformats' is used.
2793 When reading a file into an existing buffer, the same is done, but
2794 this happens like 'fileformat' has been set appropriately for that
2795 file only, the option is not changed.
2796 When 'binary' is set, the value of 'fileformats' is not used.
2797
2798 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2799 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2800 done:
2801 - When 'fileformats' is empty, there is no automatic detection. Dos
2802 format will be used.
2803 - When 'fileformats' is set to one or more names, automatic detection
2804 is done. This is based on the first <NL> in the file: If there is a
2805 <CR> in front of it, Dos format is used, otherwise Unix format is
2806 used.
2807 Also see |file-formats|.
2808 For backwards compatibility: When this option is set to an empty
2809 string or one format (no comma is included), 'textauto' is reset,
2810 otherwise 'textauto' is set.
2811 NOTE: This option is set to the Vi default value when 'compatible' is
2812 set and to the Vim default value when 'compatible' is reset.
2813
2814 *'filetype'* *'ft'*
2815'filetype' 'ft' string (default: "")
2816 local to buffer
2817 {not in Vi}
2818 {not available when compiled without the |+autocmd|
2819 feature}
2820 When this option is set, the FileType autocommand event is triggered.
2821 All autocommands that match with the value of this option will be
2822 executed. Thus the value of 'filetype' is used in place of the file
2823 name.
2824 Otherwise this option does not always reflect the current file type.
2825 This option is normally set when the file type is detected. To enable
2826 this use the ":filetype on" command. |:filetype|
2827 Setting this option to a different value is most useful in a modeline,
2828 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002829 Example, for in an IDL file:
2830 /* vim: set filetype=idl : */ ~
2831 |FileType| |filetypes|
2832 When a dot appears in the value then this separates two filetype
2833 names. Example:
2834 /* vim: set filetype=c.doxygen : */ ~
2835 This will use the "c" filetype first, then the "doxygen" filetype.
2836 This works both for filetype plugins and for syntax files. More than
2837 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838 Do not confuse this option with 'osfiletype', which is for the file
2839 type that is actually stored with the file.
2840 This option is not copied to another buffer, independent of the 's' or
2841 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002842 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843
2844 *'fillchars'* *'fcs'*
2845'fillchars' 'fcs' string (default "vert:|,fold:-")
2846 global
2847 {not in Vi}
2848 {not available when compiled without the |+windows|
2849 and |+folding| features}
2850 Characters to fill the statuslines and vertical separators.
2851 It is a comma separated list of items:
2852
2853 item default Used for ~
2854 stl:c ' ' or '^' statusline of the current window
2855 stlnc:c ' ' or '-' statusline of the non-current windows
2856 vert:c '|' vertical separators |:vsplit|
2857 fold:c '-' filling 'foldtext'
2858 diff:c '-' deleted lines of the 'diff' option
2859
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002860 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861 "stlnc" the space will be used when there is highlighting, '^' or '-'
2862 otherwise.
2863
2864 Example: >
2865 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2866< This is similar to the default, except that these characters will also
2867 be used when there is highlighting.
2868
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002869 for "stl" and "stlnc" only single-byte values are supported.
2870
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 The highlighting used for these items:
2872 item highlight group ~
2873 stl:c StatusLine |hl-StatusLine|
2874 stlnc:c StatusLineNC |hl-StatusLineNC|
2875 vert:c VertSplit |hl-VertSplit|
2876 fold:c Folded |hl-Folded|
2877 diff:c DiffDelete |hl-DiffDelete|
2878
2879 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2880'fkmap' 'fk' boolean (default off) *E198*
2881 global
2882 {not in Vi}
2883 {only available when compiled with the |+rightleft|
2884 feature}
2885 When on, the keyboard is mapped for the Farsi character set.
2886 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002887 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888
2889 *'foldclose'* *'fcl'*
2890'foldclose' 'fcl' string (default "")
2891 global
2892 {not in Vi}
2893 {not available when compiled without the |+folding|
2894 feature}
2895 When set to "all", a fold is closed when the cursor isn't in it and
2896 its level is higher than 'foldlevel'. Useful if you want folds to
2897 automatically close when moving out of them.
2898
2899 *'foldcolumn'* *'fdc'*
2900'foldcolumn' 'fdc' number (default 0)
2901 local to window
2902 {not in Vi}
2903 {not available when compiled without the |+folding|
2904 feature}
2905 When non-zero, a column with the specified width is shown at the side
2906 of the window which indicates open and closed folds. The maximum
2907 value is 12.
2908 See |folding|.
2909
2910 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2911'foldenable' 'fen' boolean (default on)
2912 local to window
2913 {not in Vi}
2914 {not available when compiled without the |+folding|
2915 feature}
2916 When off, all folds are open. This option can be used to quickly
2917 switch between showing all text unfolded and viewing the text with
2918 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002919 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 'foldenable' is off.
2921 This option is set by commands that create a new fold or close a fold.
2922 See |folding|.
2923
2924 *'foldexpr'* *'fde'*
2925'foldexpr' 'fde' string (default: "0")
2926 local to window
2927 {not in Vi}
2928 {not available when compiled without the |+folding|
2929 or |+eval| feature}
2930 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002931 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002932
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002933 The expression may be evaluated in the |sandbox|, see
2934 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002935 This option can't be set from a |modeline| when the 'diff' option is
2936 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002937
2938 It is not allowed to change text or jump to another window while
2939 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940
2941 *'foldignore'* *'fdi'*
2942'foldignore' 'fdi' string (default: "#")
2943 local to window
2944 {not in Vi}
2945 {not available when compiled without the |+folding|
2946 feature}
2947 Used only when 'foldmethod' is "indent". Lines starting with
2948 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002949 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 The default "#" works well for C programs. See |fold-indent|.
2951
2952 *'foldlevel'* *'fdl'*
2953'foldlevel' 'fdl' number (default: 0)
2954 local to window
2955 {not in Vi}
2956 {not available when compiled without the |+folding|
2957 feature}
2958 Sets the fold level: Folds with a higher level will be closed.
2959 Setting this option to zero will close all folds. Higher numbers will
2960 close fewer folds.
2961 This option is set by commands like |zm|, |zM| and |zR|.
2962 See |fold-foldlevel|.
2963
2964 *'foldlevelstart'* *'fdls'*
2965'foldlevelstart' 'fdls' number (default: -1)
2966 global
2967 {not in Vi}
2968 {not available when compiled without the |+folding|
2969 feature}
2970 Sets 'foldlevel' when starting to edit another buffer in a window.
2971 Useful to always start editing with all folds closed (value zero),
2972 some folds closed (one) or no folds closed (99).
2973 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002974 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 ignores this option and closes all folds.
2976 It is also done before BufReadPre autocommands, to allow an autocmd to
2977 overrule the 'foldlevel' value for specific files.
2978 When the value is negative, it is not used.
2979
2980 *'foldmarker'* *'fmr'* *E536*
2981'foldmarker' 'fmr' string (default: "{{{,}}}")
2982 local to window
2983 {not in Vi}
2984 {not available when compiled without the |+folding|
2985 feature}
2986 The start and end marker used when 'foldmethod' is "marker". There
2987 must be one comma, which separates the start and end marker. The
2988 marker is a literal string (a regular expression would be too slow).
2989 See |fold-marker|.
2990
2991 *'foldmethod'* *'fdm'*
2992'foldmethod' 'fdm' string (default: "manual")
2993 local to window
2994 {not in Vi}
2995 {not available when compiled without the |+folding|
2996 feature}
2997 The kind of folding used for the current window. Possible values:
2998 |fold-manual| manual Folds are created manually.
2999 |fold-indent| indent Lines with equal indent form a fold.
3000 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3001 |fold-marker| marker Markers are used to specify folds.
3002 |fold-syntax| syntax Syntax highlighting items specify folds.
3003 |fold-diff| diff Fold text that is not changed.
3004
3005 *'foldminlines'* *'fml'*
3006'foldminlines' 'fml' number (default: 1)
3007 local to window
3008 {not in Vi}
3009 {not available when compiled without the |+folding|
3010 feature}
3011 Sets the minimum number of screen lines for a fold to be displayed
3012 closed. Also for manually closed folds.
3013 Note that this only has an effect of what is displayed. After using
3014 "zc" to close a fold, which is displayed open because it's smaller
3015 than 'foldminlines', a following "zc" may close a containing fold.
3016
3017 *'foldnestmax'* *'fdn'*
3018'foldnestmax' 'fdn' number (default: 20)
3019 local to window
3020 {not in Vi}
3021 {not available when compiled without the |+folding|
3022 feature}
3023 Sets the maximum nesting of folds for the "indent" and "syntax"
3024 methods. This avoids that too many folds will be created. Using more
3025 than 20 doesn't work, because the internal limit is 20.
3026
3027 *'foldopen'* *'fdo'*
3028'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3029 search,tag,undo")
3030 global
3031 {not in Vi}
3032 {not available when compiled without the |+folding|
3033 feature}
3034 Specifies for which type of commands folds will be opened, if the
3035 command moves the cursor into a closed fold. It is a comma separated
3036 list of items.
3037 item commands ~
3038 all any
3039 block "(", "{", "[[", "[{", etc.
3040 hor horizontal movements: "l", "w", "fx", etc.
3041 insert any command in Insert mode
3042 jump far jumps: "G", "gg", etc.
3043 mark jumping to a mark: "'m", CTRL-O, etc.
3044 percent "%"
3045 quickfix ":cn", ":crew", ":make", etc.
3046 search search for a pattern: "/", "n", "*", "gd", etc.
3047 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003048 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 tag jumping to a tag: ":ta", CTRL-T, etc.
3050 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003051 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 the |zv| command to the mapping to get the same effect.
3053 When a movement command is used for an operator (e.g., "dl" or "y%")
3054 this option is not used. This means the operator will include the
3055 whole closed fold.
3056 Note that vertical movements are not here, because it would make it
3057 very difficult to move onto a closed fold.
3058 In insert mode the folds containing the cursor will always be open
3059 when text is inserted.
3060 To close folds you can re-apply 'foldlevel' with the |zx| command or
3061 set the 'foldclose' option to "all".
3062
3063 *'foldtext'* *'fdt'*
3064'foldtext' 'fdt' string (default: "foldtext()")
3065 local to window
3066 {not in Vi}
3067 {not available when compiled without the |+folding|
3068 feature}
3069 An expression which is used to specify the text displayed for a closed
3070 fold. See |fold-foldtext|.
3071
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003072 The expression may be evaluated in the |sandbox|, see
3073 |sandbox-option|.
3074
3075 It is not allowed to change text or jump to another window while
3076 evaluating 'foldtext' |textlock|.
3077
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 *'formatoptions'* *'fo'*
3079'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3080 local to buffer
3081 {not in Vi}
3082 This is a sequence of letters which describes how automatic
3083 formatting is to be done. See |fo-table|. When the 'paste' option is
3084 on, no formatting is done (like 'formatoptions' is empty). Commas can
3085 be inserted for readability.
3086 To avoid problems with flags that are added in the future, use the
3087 "+=" and "-=" feature of ":set" |add-option-flags|.
3088 NOTE: This option is set to the Vi default value when 'compatible' is
3089 set and to the Vim default value when 'compatible' is reset.
3090
Bram Moolenaar86b68352004-12-27 21:59:20 +00003091 *'formatlistpat'* *'flp'*
3092'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3093 local to buffer
3094 {not in Vi}
3095 A pattern that is used to recognize a list header. This is used for
3096 the "n" flag in 'formatoptions'.
3097 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003098 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003099 while still checking more characters. There must be a character
3100 following the pattern, when it matches the whole line it is handled
3101 like there is no match.
3102 The default recognizes a number, followed by an optional punctuation
3103 character and white space.
3104
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 *'formatprg'* *'fp'*
3106'formatprg' 'fp' string (default "")
3107 global
3108 {not in Vi}
3109 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003110 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003112 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003113 If the 'formatexpr' option is not empty it will be used instead.
3114 Otherwise, if 'formatprg' option is an empty string, the internal
3115 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003116 Environment variables are expanded |:set_env|. See |option-backslash|
3117 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003118 The expression may be evaluated in the |sandbox|, see
3119 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003121 *'formatexpr'* *'fex'*
3122'formatexpr' 'fex' string (default "")
3123 local to buffer
3124 {not in Vi}
3125 {not available when compiled without the |+eval|
3126 feature}
3127 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003128 operator or automatic formatting (see 'formatoptions'). When this
3129 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003130
3131 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003132 The |v:count| variable holds the number of lines to be formatted.
3133 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003134 inserted if the expression is being evaluated due to
3135 automatic formatting. This can be empty. Don't insert
3136 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003137
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003138 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003139 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003140< This will invoke the mylang#Format() function in the
3141 autoload/mylang.vim file in 'runtimepath'. |autoload|
3142
3143 The expression is also evaluated when 'textwidth' is set and adding
3144 text beyond that limit. This happens under the same conditions as
3145 when internal formatting is used. Make sure the cursor is kept in the
3146 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003147 return "i" or "R" in this situation.
3148
3149 When the expression evaluates to non-zero Vim will fall back to using
3150 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003151
3152 The expression may be evaluated in the |sandbox|, see
3153 |sandbox-option|.
3154
3155 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003156'fsync' 'fs' boolean (default on)
3157 global
3158 {not in Vi}
3159 When on, the library function fsync() will be called after writing a
3160 file. This will flush a file to disk, ensuring that it is safely
3161 written even on filesystems which do metadata-only journaling. This
3162 will force the harddrive to spin up on Linux systems running in laptop
3163 mode, so it may be undesirable in some situations. Be warned that
3164 turning this off increases the chances of data loss after a crash. On
3165 systems without an fsync() implementation, this variable is always
3166 off.
3167 Also see 'swapsync' for controlling fsync() on swap files.
3168
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3170'gdefault' 'gd' boolean (default off)
3171 global
3172 {not in Vi}
3173 When on, the ":substitute" flag 'g' is default on. This means that
3174 all matches in a line are substituted instead of one. When a 'g' flag
3175 is given to a ":substitute" command, this will toggle the substitution
3176 of all or one match. See |complex-change|.
3177
3178 command 'gdefault' on 'gdefault' off ~
3179 :s/// subst. all subst. one
3180 :s///g subst. one subst. all
3181 :s///gg subst. all subst. one
3182
3183 NOTE: This option is reset when 'compatible' is set.
3184
3185 *'grepformat'* *'gfm'*
3186'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3187 global
3188 {not in Vi}
3189 Format to recognize for the ":grep" command output.
3190 This is a scanf-like string that uses the same format as the
3191 'errorformat' option: see |errorformat|.
3192
3193 *'grepprg'* *'gp'*
3194'grepprg' 'gp' string (default "grep -n ",
3195 Unix: "grep -n $* /dev/null",
3196 Win32: "findstr /n" or "grep -n",
3197 VMS: "SEARCH/NUMBERS ")
3198 global or local to buffer |global-local|
3199 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003200 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 and '#' characters, which are expanded like when used in a command-
3202 line. The placeholder "$*" is allowed to specify where the arguments
3203 will be included. Environment variables are expanded |:set_env|. See
3204 |option-backslash| about including spaces and backslashes.
3205 When your "grep" accepts the "-H" argument, use this to make ":grep"
3206 also work well with a single file: >
3207 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003208< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003209 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3210 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003211 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 apply equally to 'grepprg'.
3213 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3214 otherwise it's "grep -n".
3215 This option cannot be set from a |modeline| or in the |sandbox|, for
3216 security reasons.
3217
3218 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3219'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3220 ve:ver35-Cursor,
3221 o:hor50-Cursor,
3222 i-ci:ver25-Cursor/lCursor,
3223 r-cr:hor20-Cursor/lCursor,
3224 sm:block-Cursor
3225 -blinkwait175-blinkoff150-blinkon175",
3226 for MS-DOS and Win32 console:
3227 "n-v-c:block,o:hor50,i-ci:hor15,
3228 r-cr:hor30,sm:block")
3229 global
3230 {not in Vi}
3231 {only available when compiled with GUI enabled, and
3232 for MS-DOS and Win32 console}
3233 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003234 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 the height of the cursor can be changed. This can be done by
3236 specifying a block cursor, or a percentage for a vertical or
3237 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003238 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003240 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 mode-list and an argument-list:
3242 mode-list:argument-list,mode-list:argument-list,..
3243 The mode-list is a dash separated list of these modes:
3244 n Normal mode
3245 v Visual mode
3246 ve Visual mode with 'selection' "exclusive" (same as 'v',
3247 if not specified)
3248 o Operator-pending mode
3249 i Insert mode
3250 r Replace mode
3251 c Command-line Normal (append) mode
3252 ci Command-line Insert mode
3253 cr Command-line Replace mode
3254 sm showmatch in Insert mode
3255 a all modes
3256 The argument-list is a dash separated list of these arguments:
3257 hor{N} horizontal bar, {N} percent of the character height
3258 ver{N} vertical bar, {N} percent of the character width
3259 block block cursor, fills the whole character
3260 [only one of the above three should be present]
3261 blinkwait{N} *cursor-blinking*
3262 blinkon{N}
3263 blinkoff{N}
3264 blink times for cursor: blinkwait is the delay before
3265 the cursor starts blinking, blinkon is the time that
3266 the cursor is shown and blinkoff is the time that the
3267 cursor is not shown. The times are in msec. When one
3268 of the numbers is zero, there is no blinking. The
3269 default is: "blinkwait700-blinkon400-blinkoff250".
3270 These numbers are used for a missing entry. This
3271 means that blinking is enabled by default. To switch
3272 blinking off you can use "blinkon0". The cursor only
3273 blinks when Vim is waiting for input, not while
3274 executing a command.
3275 To make the cursor blink in an xterm, see
3276 |xterm-blink|.
3277 {group-name}
3278 a highlight group name, that sets the color and font
3279 for the cursor
3280 {group-name}/{group-name}
3281 Two highlight group names, the first is used when
3282 no language mappings are used, the other when they
3283 are. |language-mapping|
3284
3285 Examples of parts:
3286 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3287 block cursor with colors from the "nCursor"
3288 highlight group
3289 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3290 In Insert and Command-line Insert mode, use a
3291 30% vertical bar cursor with colors from the
3292 "iCursor" highlight group. Blink a bit
3293 faster.
3294
3295 The 'a' mode is different. It will set the given argument-list for
3296 all modes. It does not reset anything to defaults. This can be used
3297 to do a common setting for all modes. For example, to switch off
3298 blinking: "a:blinkon0"
3299
3300 Examples of cursor highlighting: >
3301 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3302 :highlight Cursor gui=NONE guifg=bg guibg=fg
3303<
3304 *'guifont'* *'gfn'*
3305 *E235* *E596* *E610* *E611*
3306'guifont' 'gfn' string (default "")
3307 global
3308 {not in Vi}
3309 {only available when compiled with GUI enabled}
3310 This is a list of fonts which will be used for the GUI version of Vim.
3311 In its simplest form the value is just one font name. When
3312 the font cannot be found you will get an error message. To try other
3313 font names a list can be specified, font names separated with commas.
3314 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003315
Bram Moolenaar05159a02005-02-26 23:04:13 +00003316 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3317 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003318
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 Spaces after a comma are ignored. To include a comma in a font name
3320 precede it with a backslash. Setting an option requires an extra
3321 backslash before a space and a backslash. See also
3322 |option-backslash|. For example: >
3323 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003324< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003326
3327 If none of the fonts can be loaded, Vim will keep the current setting.
3328 If an empty font list is given, Vim will try using other resource
3329 settings (for X, it will use the Vim.font resource), and finally it
3330 will try some builtin default which should always be there ("7x13" in
3331 the case of X). The font names given should be "normal" fonts. Vim
3332 will try to find the related bold and italic fonts.
3333
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003334 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003335 :set guifont=*
3336< will bring up a font requester, where you can pick the font you want.
3337
3338 The font name depends on the GUI used. See |setting-guifont| for a
3339 way to set 'guifont' for various systems.
3340
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 For the GTK+ 2 GUI the font name looks like this: >
3342 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003343< That's all. XLFDs are not used. For Chinese this is reported to work
3344 well: >
3345 if has("gui_gtk2")
3346 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3347 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3348 endif
3349<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003350 For Mac OSX you can use something like this: >
3351 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003352< Also see 'macatsui', it can help fix display problems.
3353 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003355 width). An exception is GTK 2: all fonts are accepted, but
3356 mono-spaced fonts look best.
3357
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 To preview a font on X11, you might be able to use the "xfontsel"
3359 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003360
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 For the Win32 GUI *E244* *E245*
3362 - takes these options in the font name:
3363 hXX - height is XX (points, can be floating-point)
3364 wXX - width is XX (points, can be floating-point)
3365 b - bold
3366 i - italic
3367 u - underline
3368 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003369 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3371 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3372 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003373 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374
3375 Use a ':' to separate the options.
3376 - A '_' can be used in the place of a space, so you don't need to use
3377 backslashes to escape the spaces.
3378 - Examples: >
3379 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3380 :set guifont=Andale_Mono:h7.5:w4.5
3381< See also |font-sizes|.
3382
3383 *'guifontset'* *'gfs'*
3384 *E250* *E252* *E234* *E597* *E598*
3385'guifontset' 'gfs' string (default "")
3386 global
3387 {not in Vi}
3388 {only available when compiled with GUI enabled and
3389 with the |+xfontset| feature}
3390 {not available in the GTK+ 2 GUI}
3391 When not empty, specifies two (or more) fonts to be used. The first
3392 one for normal English, the second one for your special language. See
3393 |xfontset|.
3394 Setting this option also means that all font names will be handled as
3395 a fontset name. Also the ones used for the "font" argument of the
3396 |:highlight| command.
3397 The fonts must match with the current locale. If fonts for the
3398 character sets that the current locale uses are not included, setting
3399 'guifontset' will fail.
3400 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3401 the comma-separated names are alternative names, one of which will be
3402 used. In 'guifontset' the whole string is one fontset name,
3403 including the commas. It is not possible to specify alternative
3404 fontset names.
3405 This example works on many X11 systems: >
3406 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3407<
3408 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3409'guifontwide' 'gfw' string (default "")
3410 global
3411 {not in Vi}
3412 {only available when compiled with GUI enabled}
3413 When not empty, specifies a comma-separated list of fonts to be used
3414 for double-width characters. The first font that can be loaded is
3415 used.
3416 Note: The size of these fonts must be exactly twice as wide as the one
3417 specified with 'guifont' and the same height.
3418
3419 All GUI versions but GTK+ 2:
3420
3421 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3422 'guifontset' is empty or invalid.
3423 When 'guifont' is set and a valid font is found in it and
3424 'guifontwide' is empty Vim will attempt to find a matching
3425 double-width font and set 'guifontwide' to it.
3426
3427 GTK+ 2 GUI only: *guifontwide_gtk2*
3428
3429 If set and valid, 'guifontwide' is always used for double width
3430 characters, even if 'encoding' is not set to "utf-8".
3431 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003432 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 font for characters not available in 'guifont'. Thus you do not need
3434 to set 'guifontwide' at all unless you want to override the choice
3435 made by Pango/Xft.
3436
3437 *'guiheadroom'* *'ghr'*
3438'guiheadroom' 'ghr' number (default 50)
3439 global
3440 {not in Vi} {only for GTK and X11 GUI}
3441 The number of pixels subtracted from the screen height when fitting
3442 the GUI window on the screen. Set this before the GUI is started,
3443 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003444 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 lines will be left for window decorations and other items on the
3446 screen. Set it to a negative value to allow windows taller than the
3447 screen.
3448
3449 *'guioptions'* *'go'*
3450'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003451 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 global
3453 {not in Vi}
3454 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003455 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 sequence of letters which describes what components and options of the
3457 GUI should be used.
3458 To avoid problems with flags that are added in the future, use the
3459 "+=" and "-=" feature of ":set" |add-option-flags|.
3460
3461 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003462 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 'a' Autoselect: If present, then whenever VISUAL mode is started,
3464 or the Visual area extended, Vim tries to become the owner of
3465 the windowing system's global selection. This means that the
3466 Visually highlighted text is available for pasting into other
3467 applications as well as into Vim itself. When the Visual mode
3468 ends, possibly due to an operation on the text, or when an
3469 application wants to paste the selection, the highlighted text
3470 is automatically yanked into the "* selection register.
3471 Thus the selection is still available for pasting into other
3472 applications after the VISUAL mode has ended.
3473 If not present, then Vim won't become the owner of the
3474 windowing system's global selection unless explicitly told to
3475 by a yank or delete operation for the "* register.
3476 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003477 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003478 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 applies to the modeless selection.
3480
3481 'guioptions' autoselect Visual autoselect modeless ~
3482 "" - -
3483 "a" yes yes
3484 "A" - yes
3485 "aA" yes yes
3486
Bram Moolenaar02467872007-05-06 13:22:01 +00003487 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 'c' Use console dialogs instead of popup dialogs for simple
3489 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003490 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003491 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003492 'guitablabel' can be used to change the text in the labels.
3493 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003494 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003495 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003496 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 'f' Foreground: Don't use fork() to detach the GUI from the shell
3498 where it was started. Use this for programs that wait for the
3499 editor to finish (e.g., an e-mail program). Alternatively you
3500 can use "gvim -f" or ":gui -f" to start the GUI in the
3501 foreground. |gui-fork|
3502 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003503 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003504 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3506 corner of the window. It's black&white on non-GTK, because of
3507 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003508 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003510 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003511 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003513 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 file is sourced the system menu has already been loaded; the
3515 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003516 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517 'g' Grey menu items: Make menu items that are not active grey. If
3518 'g' is not included inactive menu items are not shown at all.
3519 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003520 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 't' Include tearoff menu items. Currently only works for Win32,
3522 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003523 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003524 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003525 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003526 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003528 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 'R' Right-hand scrollbar is present when there is a vertically
3530 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003531 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003533 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 'L' Left-hand scrollbar is present when there is a vertically
3535 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003536 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3538 the longest visible line, or on the cursor line if the 'h'
3539 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003540 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 'h' Limit horizontal scrollbar size to the length of the cursor
3542 line. Reduces computations. |gui-horiz-scroll|
3543
3544 And yes, you may even have scrollbars on the left AND the right if
3545 you really want to :-). See |gui-scrollbars| for more information.
3546
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003547 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 'v' Use a vertical button layout for dialogs. When not included,
3549 a horizontal layout is preferred, but when it doesn't fit a
3550 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003551 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 'p' Use Pointer callbacks for X11 GUI. This is required for some
3553 window managers. If the cursor is not blinking or hollow at
3554 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003555 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003557 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003558 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559
Bram Moolenaar02467872007-05-06 13:22:01 +00003560
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 *'guipty'* *'noguipty'*
3562'guipty' boolean (default on)
3563 global
3564 {not in Vi}
3565 {only available when compiled with GUI enabled}
3566 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3567 I/O to/from shell commands. See |gui-pty|.
3568
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003569 *'guitablabel'* *'gtl'*
3570'guitablabel' 'gtl' string (default empty)
3571 global
3572 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003573 {only available when compiled with GUI enabled and
3574 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003575 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003576 pages line. When empty and when the result is empty Vim will use a
3577 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003578
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003579 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003580 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003581
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003582 Only used when the GUI tab pages line is displayed. 'e' must be
3583 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3584 used.
3585
Bram Moolenaar57657d82006-04-21 22:12:41 +00003586 *'guitabtooltip'* *'gtt'*
3587'guitabtooltip' 'gtt' string (default empty)
3588 global
3589 {not in Vi}
3590 {only available when compiled with GUI enabled and
3591 with the +windows feature}
3592 When nonempty describes the text to use in a tooltip for the GUI tab
3593 pages line. When empty Vim will use a default tooltip.
3594 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003595 You can include a line break. Simplest method is to use |:let|: >
3596 :let &guitabtooltip = "line one\nline two"
3597<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003598
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 *'helpfile'* *'hf'*
3600'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3601 (others) "$VIMRUNTIME/doc/help.txt")
3602 global
3603 {not in Vi}
3604 Name of the main help file. All distributed help files should be
3605 placed together in one directory. Additionally, all "doc" directories
3606 in 'runtimepath' will be used.
3607 Environment variables are expanded |:set_env|. For example:
3608 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003609 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 spaces and backslashes.
3611 This option cannot be set from a |modeline| or in the |sandbox|, for
3612 security reasons.
3613
3614 *'helpheight'* *'hh'*
3615'helpheight' 'hh' number (default 20)
3616 global
3617 {not in Vi}
3618 {not available when compiled without the +windows
3619 feature}
3620 Minimal initial height of the help window when it is opened with the
3621 ":help" command. The initial height of the help window is half of the
3622 current window, or (when the 'ea' option is on) the same as other
3623 windows. When the height is less than 'helpheight', the height is
3624 set to 'helpheight'. Set to zero to disable.
3625
3626 *'helplang'* *'hlg'*
3627'helplang' 'hlg' string (default: messages language or empty)
3628 global
3629 {only available when compiled with the |+multi_lang|
3630 feature}
3631 {not in Vi}
3632 Comma separated list of languages. Vim will use the first language
3633 for which the desired help can be found. The English help will always
3634 be used as a last resort. You can add "en" to prefer English over
3635 another language, but that will only find tags that exist in that
3636 language and not in the English help.
3637 Example: >
3638 :set helplang=de,it
3639< This will first search German, then Italian and finally English help
3640 files.
3641 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3642 try to find the tag in the current language before using this option.
3643 See |help-translated|.
3644
3645 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3646'hidden' 'hid' boolean (default off)
3647 global
3648 {not in Vi}
3649 When off a buffer is unloaded when it is |abandon|ed. When on a
3650 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3651 displayed in another window, it does not become hidden, of course.
3652 The commands that move through the buffer list sometimes make a buffer
3653 hidden although the 'hidden' option is off: When the buffer is
3654 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003655 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003656 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657 This option is set for one command with ":hide {command}" |:hide|.
3658 WARNING: It's easy to forget that you have changes in hidden buffers.
3659 Think twice when using ":q!" or ":qa!".
3660
3661 *'highlight'* *'hl'*
3662'highlight' 'hl' string (default (as a single string):
3663 "8:SpecialKey,@:NonText,d:Directory,
3664 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3665 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003666 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3668 f:Folded,F:FoldColumn,A:DiffAdd,
3669 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003670 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003671 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003672 +:Pmenu,=:PmenuSel,
3673 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 global
3675 {not in Vi}
3676 This option can be used to set highlighting mode for various
3677 occasions. It is a comma separated list of character pairs. The
3678 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003679 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3681 |hl-NonText| @ '~' and '@' at the end of the window and
3682 characters from 'showbreak'
3683 |hl-Directory| d directories in CTRL-D listing and other special
3684 things in listings
3685 |hl-ErrorMsg| e error messages
3686 h (obsolete, ignored)
3687 |hl-IncSearch| i 'incsearch' highlighting
3688 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3689 |hl-MoreMsg| m |more-prompt|
3690 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003691 |hl-LineNr| n line number for ":number" and ":#" commands, and
3692 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 |hl-Question| r |hit-enter| prompt and yes/no questions
3694 |hl-StatusLine| s status line of current window |status-line|
3695 |hl-StatusLineNC| S status lines of not-current windows
3696 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3697 |hl-VertSplit| c column used to separate vertically split windows
3698 |hl-Visual| v Visual mode
3699 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3700 Selection" Only X11 Gui's |gui-x11| and
3701 |xterm-clipboard|.
3702 |hl-WarningMsg| w warning messages
3703 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3704 |hl-Folded| f line used for closed folds
3705 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003706 |hl-DiffAdd| A added line in diff mode
3707 |hl-DiffChange| C changed line in diff mode
3708 |hl-DiffDelete| D deleted line in diff mode
3709 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003711 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003712 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003713 |hl-SpellRare| R rare word |spell|
3714 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003715 |hl-Conceal| - the placeholders used for concealed characters
3716 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003717 |hl-Pmenu| + popup menu normal line
3718 |hl-PmenuSel| = popup menu normal line
3719 |hl-PmenuSbar| x popup menu scrollbar
3720 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721
3722 The display modes are:
3723 r reverse (termcap entry "mr" and "me")
3724 i italic (termcap entry "ZH" and "ZR")
3725 b bold (termcap entry "md" and "me")
3726 s standout (termcap entry "so" and "se")
3727 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003728 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 n no highlighting
3730 - no highlighting
3731 : use a highlight group
3732 The default is used for occasions that are not included.
3733 If you want to change what the display modes do, see |dos-colors|
3734 for an example.
3735 When using the ':' display mode, this must be followed by the name of
3736 a highlight group. A highlight group can be used to define any type
3737 of highlighting, including using color. See |:highlight| on how to
3738 define one. The default uses a different group for each occasion.
3739 See |highlight-default| for the default highlight groups.
3740
3741 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3742'hlsearch' 'hls' boolean (default off)
3743 global
3744 {not in Vi}
3745 {not available when compiled without the
3746 |+extra_search| feature}
3747 When there is a previous search pattern, highlight all its matches.
3748 The type of highlighting used can be set with the 'l' occasion in the
3749 'highlight' option. This uses the "Search" highlight group by
3750 default. Note that only the matching text is highlighted, any offsets
3751 are not applied.
3752 See also: 'incsearch' and |:match|.
3753 When you get bored looking at the highlighted matches, you can turn it
3754 off with |:nohlsearch|. As soon as you use a search command, the
3755 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003756 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 When the search pattern can match an end-of-line, Vim will try to
3758 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003759 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003761 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762 NOTE: This option is reset when 'compatible' is set.
3763
3764 *'history'* *'hi'*
3765'history' 'hi' number (Vim default: 20, Vi default: 0)
3766 global
3767 {not in Vi}
3768 A history of ":" commands, and a history of previous search patterns
3769 are remembered. This option decides how many entries may be stored in
3770 each of these histories (see |cmdline-editing|).
3771 NOTE: This option is set to the Vi default value when 'compatible' is
3772 set and to the Vim default value when 'compatible' is reset.
3773
3774 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3775'hkmap' 'hk' boolean (default off)
3776 global
3777 {not in Vi}
3778 {only available when compiled with the |+rightleft|
3779 feature}
3780 When on, the keyboard is mapped for the Hebrew character set.
3781 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3782 toggle this option. See |rileft.txt|.
3783 NOTE: This option is reset when 'compatible' is set.
3784
3785 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3786'hkmapp' 'hkp' boolean (default off)
3787 global
3788 {not in Vi}
3789 {only available when compiled with the |+rightleft|
3790 feature}
3791 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3792 This is useful if you have a non-Hebrew keyboard.
3793 See |rileft.txt|.
3794 NOTE: This option is reset when 'compatible' is set.
3795
3796 *'icon'* *'noicon'*
3797'icon' boolean (default off, on when title can be restored)
3798 global
3799 {not in Vi}
3800 {not available when compiled without the |+title|
3801 feature}
3802 When on, the icon text of the window will be set to the value of
3803 'iconstring' (if it is not empty), or to the name of the file
3804 currently being edited. Only the last part of the name is used.
3805 Overridden by the 'iconstring' option.
3806 Only works if the terminal supports setting window icons (currently
3807 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3808 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3809 builtin termcap).
3810 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003811 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 X11.
3813
3814 *'iconstring'*
3815'iconstring' string (default "")
3816 global
3817 {not in Vi}
3818 {not available when compiled without the |+title|
3819 feature}
3820 When this option is not empty, it will be used for the icon text of
3821 the window. This happens only when the 'icon' option is on.
3822 Only works if the terminal supports setting window icon text
3823 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3824 Does not work for MS Windows.
3825 When Vim was compiled with HAVE_X11 defined, the original icon will be
3826 restored if possible |X11|.
3827 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003828 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 'titlestring' for example settings.
3830 {not available when compiled without the |+statusline| feature}
3831
3832 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3833'ignorecase' 'ic' boolean (default off)
3834 global
3835 Ignore case in search patterns. Also used when searching in the tags
3836 file.
3837 Also see 'smartcase'.
3838 Can be overruled by using "\c" or "\C" in the pattern, see
3839 |/ignorecase|.
3840
3841 *'imactivatekey'* *'imak'*
3842'imactivatekey' 'imak' string (default "")
3843 global
3844 {not in Vi}
3845 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003846 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 Specifies the key that your Input Method in X-Windows uses for
3848 activation. When this is specified correctly, vim can fully control
3849 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3850 You can't use this option to change the activation key, the option
3851 tells Vim what the key is.
3852 Format:
3853 [MODIFIER_FLAG-]KEY_STRING
3854
3855 These characters can be used for MODIFIER_FLAG (case is ignored):
3856 S Shift key
3857 L Lock key
3858 C Control key
3859 1 Mod1 key
3860 2 Mod2 key
3861 3 Mod3 key
3862 4 Mod4 key
3863 5 Mod5 key
3864 Combinations are allowed, for example "S-C-space" or "SC-space" are
3865 both shift+ctrl+space.
3866 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3867
3868 Example: >
3869 :set imactivatekey=S-space
3870< "S-space" means shift+space. This is the activation key for kinput2 +
3871 canna (Japanese), and ami (Korean).
3872
3873 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3874'imcmdline' 'imc' boolean (default off)
3875 global
3876 {not in Vi}
3877 {only available when compiled with the |+xim|
3878 |+multi_byte_ime| or |global-ime| feature}
3879 When set the Input Method is always on when starting to edit a command
3880 line, unless entering a search pattern (see 'imsearch' for that).
3881 Setting this option is useful when your input method allows entering
3882 English characters directly, e.g., when it's used to type accented
3883 characters with dead keys.
3884
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003885 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3887 global
3888 {not in Vi}
3889 {only available when compiled with the |+xim|
3890 |+multi_byte_ime| or |global-ime| feature}
3891 When set the Input Method is never used. This is useful to disable
3892 the IM when it doesn't work properly.
3893 Currently this option is on by default for SGI/IRIX machines. This
3894 may change in later releases.
3895
3896 *'iminsert'* *'imi'*
3897'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3898 local to buffer
3899 {not in Vi}
3900 Specifies whether :lmap or an Input Method (IM) is to be used in
3901 Insert mode. Valid values:
3902 0 :lmap is off and IM is off
3903 1 :lmap is ON and IM is off
3904 2 :lmap is off and IM is ON
3905 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3906 or |global-ime|.
3907 To always reset the option to zero when leaving Insert mode with <Esc>
3908 this can be used: >
3909 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3910< This makes :lmap and IM turn off automatically when leaving Insert
3911 mode.
3912 Note that this option changes when using CTRL-^ in Insert mode
3913 |i_CTRL-^|.
3914 The value is set to 1 when setting 'keymap' to a valid keymap name.
3915 It is also used for the argument of commands like "r" and "f".
3916 The value 0 may not work correctly with Athena and Motif with some XIM
3917 methods. Use 'imdisable' to disable XIM then.
3918
3919 *'imsearch'* *'ims'*
3920'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3921 local to buffer
3922 {not in Vi}
3923 Specifies whether :lmap or an Input Method (IM) is to be used when
3924 entering a search pattern. Valid values:
3925 -1 the value of 'iminsert' is used, makes it look like
3926 'iminsert' is also used when typing a search pattern
3927 0 :lmap is off and IM is off
3928 1 :lmap is ON and IM is off
3929 2 :lmap is off and IM is ON
3930 Note that this option changes when using CTRL-^ in Command-line mode
3931 |c_CTRL-^|.
3932 The value is set to 1 when it is not -1 and setting the 'keymap'
3933 option to a valid keymap name.
3934 The value 0 may not work correctly with Athena and Motif with some XIM
3935 methods. Use 'imdisable' to disable XIM then.
3936
3937 *'include'* *'inc'*
3938'include' 'inc' string (default "^\s*#\s*include")
3939 global or local to buffer |global-local|
3940 {not in Vi}
3941 {not available when compiled without the
3942 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003943 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 pattern, just like for the "/" command (See |pattern|). The default
3945 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003946 "]I", "[d", etc.
3947 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003948 comes after the matched pattern. But if "\zs" appears in the pattern
3949 then the text matched from "\zs" to the end, or until "\ze" if it
3950 appears, is used as the file name. Use this to include characters
3951 that are not in 'isfname', such as a space. You can then use
3952 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003953 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954
3955 *'includeexpr'* *'inex'*
3956'includeexpr' 'inex' string (default "")
3957 local to buffer
3958 {not in Vi}
3959 {not available when compiled without the
3960 |+find_in_path| or |+eval| feature}
3961 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003962 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003963 :set includeexpr=substitute(v:fname,'\\.','/','g')
3964< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003965
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003967 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968 Also used for |<cfile>|.
3969
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003970 The expression may be evaluated in the |sandbox|, see
3971 |sandbox-option|.
3972
3973 It is not allowed to change text or jump to another window while
3974 evaluating 'includeexpr' |textlock|.
3975
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3977'incsearch' 'is' boolean (default off)
3978 global
3979 {not in Vi}
3980 {not available when compiled without the
3981 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003982 While typing a search command, show where the pattern, as it was typed
3983 so far, matches. The matched string is highlighted. If the pattern
3984 is invalid or not found, nothing is shown. The screen will be updated
3985 often, this is only useful on fast terminals.
3986 Note that the match will be shown, but the cursor will return to its
3987 original position when no match is found and when pressing <Esc>. You
3988 still need to finish the search command with <Enter> to move the
3989 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003990 When compiled with the |+reltime| feature Vim only searches for about
3991 half a second. With a complicated pattern and/or a lot of text the
3992 match may not be found. This is to avoid that Vim hangs while you
3993 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003994 The highlighting can be set with the 'i' flag in 'highlight'.
3995 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003996 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02003997 to the command line. If 'ignorecase' and 'smartcase' are set and the
3998 command line has no uppercase characters, the added character is
3999 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004000 CTRL-R CTRL-W can be used to add the word at the end of the current
4001 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 NOTE: This option is reset when 'compatible' is set.
4003
4004 *'indentexpr'* *'inde'*
4005'indentexpr' 'inde' string (default "")
4006 local to buffer
4007 {not in Vi}
4008 {not available when compiled without the |+cindent|
4009 or |+eval| features}
4010 Expression which is evaluated to obtain the proper indent for a line.
4011 It is used when a new line is created, for the |=| operator and
4012 in Insert mode as specified with the 'indentkeys' option.
4013 When this option is not empty, it overrules the 'cindent' and
4014 'smartindent' indenting.
4015 When 'paste' is set this option is not used for indenting.
4016 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004017 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 when the expression is evaluated (but it may be moved around).
4019 The expression must return the number of spaces worth of indent. It
4020 can return "-1" to keep the current indent (this means 'autoindent' is
4021 used for the indent).
4022 Functions useful for computing the indent are |indent()|, |cindent()|
4023 and |lispindent()|.
4024 The evaluation of the expression must not have side effects! It must
4025 not change the text, jump to another window, etc. Afterwards the
4026 cursor position is always restored, thus the cursor may be moved.
4027 Normally this option would be set to call a function: >
4028 :set indentexpr=GetMyIndent()
4029< Error messages will be suppressed, unless the 'debug' option contains
4030 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004031 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 NOTE: This option is made empty when 'compatible' is set.
4033
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004034 The expression may be evaluated in the |sandbox|, see
4035 |sandbox-option|.
4036
4037 It is not allowed to change text or jump to another window while
4038 evaluating 'indentexpr' |textlock|.
4039
4040
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 *'indentkeys'* *'indk'*
4042'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4043 local to buffer
4044 {not in Vi}
4045 {not available when compiled without the |+cindent|
4046 feature}
4047 A list of keys that, when typed in Insert mode, cause reindenting of
4048 the current line. Only happens if 'indentexpr' isn't empty.
4049 The format is identical to 'cinkeys', see |indentkeys-format|.
4050 See |C-indenting| and |indent-expression|.
4051
4052 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4053'infercase' 'inf' boolean (default off)
4054 local to buffer
4055 {not in Vi}
4056 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004057 'ignorecase' is also on, the case of the match is adjusted depending
4058 on the typed text. If the typed text contains a lowercase letter
4059 where the match has an upper case letter, the completed part is made
4060 lowercase. If the typed text has no lowercase letters and the match
4061 has a lowercase letter where the typed text has an uppercase letter,
4062 and there is a letter before it, the completed part is made uppercase.
4063 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004064
4065 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4066'insertmode' 'im' boolean (default off)
4067 global
4068 {not in Vi}
4069 Makes Vim work in a way that Insert mode is the default mode. Useful
4070 if you want to use Vim as a modeless editor. Used for |evim|.
4071 These Insert mode commands will be useful:
4072 - Use the cursor keys to move around.
4073 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4074 this is a mapping, it is executed as if 'insertmode' was off.
4075 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004077 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4078 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004079
4080 These items change when 'insertmode' is set:
4081 - when starting to edit of a file, Vim goes to Insert mode.
4082 - <Esc> in Insert mode is a no-op and beeps.
4083 - <Esc> in Normal mode makes Vim go to Insert mode.
4084 - CTRL-L in Insert mode is a command, it is not inserted.
4085 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4086 However, when <Esc> is used inside a mapping, it behaves like
4087 'insertmode' was not set. This was done to be able to use the same
4088 mappings with 'insertmode' set or not set.
4089 When executing commands with |:normal| 'insertmode' is not used.
4090
4091 NOTE: This option is reset when 'compatible' is set.
4092
4093 *'isfname'* *'isf'*
4094'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4095 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4096 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4097 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4098 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4099 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4100 global
4101 {not in Vi}
4102 The characters specified by this option are included in file names and
4103 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004104 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 Multi-byte characters 256 and above are always included, only the
4106 characters up to 255 are specified with this option.
4107 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004108 Think twice before adding white space to this option. Although a
4109 space may appear inside a file name, the effect will be that Vim
4110 doesn't know where a file name starts or ends when doing completion.
4111 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112
4113 Note that on systems using a backslash as path separator, Vim tries to
4114 do its best to make it work as you would expect. That is a bit
4115 tricky, since Vi originally used the backslash to escape special
4116 characters. Vim will not remove a backslash in front of a normal file
4117 name character on these systems, but it will on Unix and alikes. The
4118 '&' and '^' are not included by default, because these are special for
4119 cmd.exe.
4120
4121 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004122 Each part can be a single character number or a range. A range is two
4123 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 decimal number between 0 and 255 or the ASCII character itself (does
4125 not work for digits). Example:
4126 "_,-,128-140,#-43" (include '_' and '-' and the range
4127 128 to 140 and '#' to 43)
4128 If a part starts with '^', the following character number or range
4129 will be excluded from the option. The option is interpreted from left
4130 to right. Put the excluded character after the range where it is
4131 included. To include '^' itself use it as the last character of the
4132 option or the end of a range. Example:
4133 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4134 If the character is '@', all characters where isalpha() returns TRUE
4135 are included. Normally these are the characters a to z and A to Z,
4136 plus accented characters. To include '@' itself use "@-@". Examples:
4137 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004138 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 "a-z,A-Z,@-@" All letters plus the '@' character.
4140 A comma can be included by using it where a character number is
4141 expected. Example:
4142 "48-57,,,_" Digits, comma and underscore.
4143 A comma can be excluded by prepending a '^'. Example:
4144 " -~,^,,9" All characters from space to '~', excluding
4145 comma, plus <Tab>.
4146 See |option-backslash| about including spaces and backslashes.
4147
4148 *'isident'* *'isi'*
4149'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4150 "@,48-57,_,128-167,224-235"
4151 otherwise: "@,48-57,_,192-255")
4152 global
4153 {not in Vi}
4154 The characters given by this option are included in identifiers.
4155 Identifiers are used in recognizing environment variables and after a
4156 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004157 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 option.
4159 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004160 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4162
4163 *'iskeyword'* *'isk'*
4164'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4165 "@,48-57,_,128-167,224-235"
4166 otherwise: "@,48-57,_,192-255"
4167 Vi default: "@,48-57,_")
4168 local to buffer
4169 {not in Vi}
4170 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004171 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 'isfname' for a description of the format of this option. For C
4173 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4174 For a help file it is set to all non-blank printable characters except
4175 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4176 command).
4177 When the 'lisp' option is on the '-' character is always included.
4178 NOTE: This option is set to the Vi default value when 'compatible' is
4179 set and to the Vim default value when 'compatible' is reset.
4180
4181 *'isprint'* *'isp'*
4182'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4183 "@,~-255"; otherwise: "@,161-255")
4184 global
4185 {not in Vi}
4186 The characters given by this option are displayed directly on the
4187 screen. It is also used for "\p" in a |pattern|. The characters from
4188 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4189 even when they are not included in 'isprint' or excluded. See
4190 'isfname' for a description of the format of this option.
4191
4192 Non-printable characters are displayed with two characters:
4193 0 - 31 "^@" - "^_"
4194 32 - 126 always single characters
4195 127 "^?"
4196 128 - 159 "~@" - "~_"
4197 160 - 254 "| " - "|~"
4198 255 "~?"
4199 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4200 displayed as <xx>, with the hexadecimal value of the byte.
4201 When 'display' contains "uhex" all unprintable characters are
4202 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004203 The SpecialKey highlighting will be used for unprintable characters.
4204 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205
4206 Multi-byte characters 256 and above are always included, only the
4207 characters up to 255 are specified with this option. When a character
4208 is printable but it is not available in the current font, a
4209 replacement character will be shown.
4210 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4211 There is no option to specify these characters.
4212
4213 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4214'joinspaces' 'js' boolean (default on)
4215 global
4216 {not in Vi}
4217 Insert two spaces after a '.', '?' and '!' with a join command.
4218 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4219 Otherwise only one space is inserted.
4220 NOTE: This option is set when 'compatible' is set.
4221
4222 *'key'*
4223'key' string (default "")
4224 local to buffer
4225 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004226 {only available when compiled with the |+cryptv|
4227 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004229 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230 Careful: Do not set the key value by hand, someone might see the typed
4231 key. Use the |:X| command. But you can make 'key' empty: >
4232 :set key=
4233< It is not possible to get the value of this option with ":set key" or
4234 "echo &key". This is to avoid showing it to someone who shouldn't
4235 know. It also means you cannot see it yourself once you have set it,
4236 be careful not to make a typing error!
4237
4238 *'keymap'* *'kmp'* *E544*
4239'keymap' 'kmp' string (default "")
4240 local to buffer
4241 {not in Vi}
4242 {only available when compiled with the |+keymap|
4243 feature}
4244 Name of a keyboard mapping. See |mbyte-keymap|.
4245 Setting this option to a valid keymap name has the side effect of
4246 setting 'iminsert' to one, so that the keymap becomes effective.
4247 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004248 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004249
4250 *'keymodel'* *'km'*
4251'keymodel' 'km' string (default "")
4252 global
4253 {not in Vi}
4254 List of comma separated words, which enable special things that keys
4255 can do. These values can be used:
4256 startsel Using a shifted special key starts selection (either
4257 Select mode or Visual mode, depending on "key" being
4258 present in 'selectmode').
4259 stopsel Using a not-shifted special key stops selection.
4260 Special keys in this context are the cursor keys, <End>, <Home>,
4261 <PageUp> and <PageDown>.
4262 The 'keymodel' option is set by the |:behave| command.
4263
4264 *'keywordprg'* *'kp'*
4265'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4266 OS/2: "view /", VMS: "help")
4267 global or local to buffer |global-local|
4268 {not in Vi}
4269 Program to use for the |K| command. Environment variables are
4270 expanded |:set_env|. ":help" may be used to access the Vim internal
4271 help. (Note that previously setting the global option to the empty
4272 value did this, which is now deprecated.)
4273 When "man" is used, Vim will automatically translate a count for the
4274 "K" command to a section number. Also for "man -s", in which case the
4275 "-s" is removed when there is no count.
4276 See |option-backslash| about including spaces and backslashes.
4277 Example: >
4278 :set keywordprg=man\ -s
4279< This option cannot be set from a |modeline| or in the |sandbox|, for
4280 security reasons.
4281
4282 *'langmap'* *'lmap'* *E357* *E358*
4283'langmap' 'lmap' string (default "")
4284 global
4285 {not in Vi}
4286 {only available when compiled with the |+langmap|
4287 feature}
4288 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004289 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 inserted directly. When in command mode the 'langmap' option takes
4291 care of translating these special characters to the original meaning
4292 of the key. This means you don't have to change the keyboard mode to
4293 be able to execute Normal mode commands.
4294 This is the opposite of the 'keymap' option, where characters are
4295 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004297 Example (for Greek, in UTF-8): *greek* >
4298 :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 +00004299< Example (exchanges meaning of z and y for commands): >
4300 :set langmap=zy,yz,ZY,YZ
4301<
4302 The 'langmap' option is a list of parts, separated with commas. Each
4303 part can be in one of two forms:
4304 1. A list of pairs. Each pair is a "from" character immediately
4305 followed by the "to" character. Examples: "aA", "aAbBcC".
4306 2. A list of "from" characters, a semi-colon and a list of "to"
4307 characters. Example: "abc;ABC"
4308 Example: "aA,fgh;FGH,cCdDeE"
4309 Special characters need to be preceded with a backslash. These are
4310 ";", ',' and backslash itself.
4311
4312 This will allow you to activate vim actions without having to switch
4313 back and forth between the languages. Your language characters will
4314 be understood as normal vim English characters (according to the
4315 langmap mappings) in the following cases:
4316 o Normal/Visual mode (commands, buffer/register names, user mappings)
4317 o Insert/Replace Mode: Register names after CTRL-R
4318 o Insert/Replace Mode: Mappings
4319 Characters entered in Command-line mode will NOT be affected by
4320 this option. Note that this option can be changed at any time
4321 allowing to switch between mappings for different languages/encodings.
4322 Use a mapping to avoid having to type it each time!
4323
4324 *'langmenu'* *'lm'*
4325'langmenu' 'lm' string (default "")
4326 global
4327 {not in Vi}
4328 {only available when compiled with the |+menu| and
4329 |+multi_lang| features}
4330 Language to use for menu translation. Tells which file is loaded
4331 from the "lang" directory in 'runtimepath': >
4332 "lang/menu_" . &langmenu . ".vim"
4333< (without the spaces). For example, to always use the Dutch menus, no
4334 matter what $LANG is set to: >
4335 :set langmenu=nl_NL.ISO_8859-1
4336< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004337 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 If your $LANG is set to a non-English language but you do want to use
4339 the English menus: >
4340 :set langmenu=none
4341< This option must be set before loading menus, switching on filetype
4342 detection or syntax highlighting. Once the menus are defined setting
4343 this option has no effect. But you could do this: >
4344 :source $VIMRUNTIME/delmenu.vim
4345 :set langmenu=de_DE.ISO_8859-1
4346 :source $VIMRUNTIME/menu.vim
4347< Warning: This deletes all menus that you defined yourself!
4348
4349 *'laststatus'* *'ls'*
4350'laststatus' 'ls' number (default 1)
4351 global
4352 {not in Vi}
4353 The value of this option influences when the last window will have a
4354 status line:
4355 0: never
4356 1: only if there are at least two windows
4357 2: always
4358 The screen looks nicer with a status line if you have several
4359 windows, but it takes another screen line. |status-line|
4360
4361 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4362'lazyredraw' 'lz' boolean (default off)
4363 global
4364 {not in Vi}
4365 When this option is set, the screen will not be redrawn while
4366 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004367 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368 update use |:redraw|.
4369
4370 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4371'linebreak' 'lbr' boolean (default off)
4372 local to window
4373 {not in Vi}
4374 {not available when compiled without the |+linebreak|
4375 feature}
4376 If on Vim will wrap long lines at a character in 'breakat' rather
4377 than at the last character that fits on the screen. Unlike
4378 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4379 it only affects the way the file is displayed, not its contents. The
4380 value of 'showbreak' is used to put in front of wrapped lines.
4381 This option is not used when the 'wrap' option is off or 'list' is on.
4382 Note that <Tab> characters after an <EOL> are mostly not displayed
4383 with the right amount of white space.
4384
4385 *'lines'* *E593*
4386'lines' number (default 24 or terminal height)
4387 global
4388 Number of lines of the Vim window.
4389 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004390 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391 When Vim is running in the GUI or in a resizable window, setting this
4392 option will cause the window size to be changed. When you only want
4393 to use the size for the GUI, put the command in your |gvimrc| file.
4394 Vim limits the number of lines to what fits on the screen. You can
4395 use this command to get the tallest window possible: >
4396 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004397< Minimum value is 2, maximum value is 1000.
4398 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 When you set this option and Vim is unable to change the physical
4400 number of lines of the display, the display may be messed up.
4401
4402 *'linespace'* *'lsp'*
4403'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4404 global
4405 {not in Vi}
4406 {only in the GUI}
4407 Number of pixel lines inserted between characters. Useful if the font
4408 uses the full character cell height, making lines touch each other.
4409 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004410 With some fonts there can be too much room between lines (to have
4411 space for ascents and descents). Then it makes sense to set
4412 'linespace' to a negative value. This may cause display problems
4413 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414
4415 *'lisp'* *'nolisp'*
4416'lisp' boolean (default off)
4417 local to buffer
4418 {not available when compiled without the |+lispindent|
4419 feature}
4420 Lisp mode: When <Enter> is typed in insert mode set the indent for
4421 the next line to Lisp standards (well, sort of). Also happens with
4422 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4423 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4424 better. Also see 'lispwords'.
4425 The '-' character is included in keyword characters. Redefines the
4426 "=" operator to use this same indentation algorithm rather than
4427 calling an external program if 'equalprg' is empty.
4428 This option is not used when 'paste' is set.
4429 {Vi: Does it a little bit differently}
4430
4431 *'lispwords'* *'lw'*
4432'lispwords' 'lw' string (default is very long)
4433 global
4434 {not in Vi}
4435 {not available when compiled without the |+lispindent|
4436 feature}
4437 Comma separated list of words that influence the Lisp indenting.
4438 |'lisp'|
4439
4440 *'list'* *'nolist'*
4441'list' boolean (default off)
4442 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004443 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4444 line. Useful to see the difference between tabs and spaces and for
4445 trailing blanks. Further changed by the 'listchars' option.
4446
4447 The cursor is displayed at the start of the space a Tab character
4448 occupies, not at the end as usual in Normal mode. To get this cursor
4449 position while displaying Tabs with spaces, use: >
4450 :set list lcs=tab\ \
4451<
4452 Note that list mode will also affect formatting (set with 'textwidth'
4453 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 changing the way tabs are displayed.
4455
4456 *'listchars'* *'lcs'*
4457'listchars' 'lcs' string (default "eol:$")
4458 global
4459 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004460 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461 settings.
4462 eol:c Character to show at the end of each line. When
4463 omitted, there is no extra character at the end of the
4464 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004465 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004467 fill the space that the tab normally occupies.
4468 "tab:>-" will show a tab that takes four spaces as
4469 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004470 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 trailing spaces are blank.
4472 extends:c Character to show in the last column, when 'wrap' is
4473 off and the line continues beyond the right of the
4474 screen.
4475 precedes:c Character to show in the first column, when 'wrap'
4476 is off and there is text preceding the character
4477 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004478 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004479 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004480 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004481 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004483 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004485 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486
4487 Examples: >
4488 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004489 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 :set lcs=extends:>,precedes:<
4491< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004492 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004493 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494
4495 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4496'loadplugins' 'lpl' boolean (default on)
4497 global
4498 {not in Vi}
4499 When on the plugin scripts are loaded when starting up |load-plugins|.
4500 This option can be reset in your |vimrc| file to disable the loading
4501 of plugins.
4502 Note that using the "-u NONE" and "--noplugin" command line arguments
4503 reset this option. |-u| |--noplugin|
4504
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004505 *'macatsui'* *'nomacatsui'*
4506'macatsui' boolean (default on)
4507 global
4508 {only available in Mac GUI version}
4509 This is a workaround for when drawing doesn't work properly. When set
4510 and compiled with multi-byte support ATSUI text drawing is used. When
4511 not set ATSUI text drawing is not used. Switch this option off when
4512 you experience drawing problems. In a future version the problems may
4513 be solved and this option becomes obsolete. Therefore use this method
4514 to unset it: >
4515 if exists('&macatsui')
4516 set nomacatsui
4517 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004518< Another option to check if you have drawing problems is
4519 'termencoding'.
4520
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 *'magic'* *'nomagic'*
4522'magic' boolean (default on)
4523 global
4524 Changes the special characters that can be used in search patterns.
4525 See |pattern|.
4526 NOTE: To avoid portability problems with using patterns, always keep
4527 this option at the default "on". Only switch it off when working with
4528 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004529 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530
4531 *'makeef'* *'mef'*
4532'makeef' 'mef' string (default: "")
4533 global
4534 {not in Vi}
4535 {not available when compiled without the |+quickfix|
4536 feature}
4537 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4538 and the |:grep| command.
4539 When it is empty, an internally generated temp file will be used.
4540 When "##" is included, it is replaced by a number to make the name
4541 unique. This makes sure that the ":make" command doesn't overwrite an
4542 existing file.
4543 NOT used for the ":cf" command. See 'errorfile' for that.
4544 Environment variables are expanded |:set_env|.
4545 See |option-backslash| about including spaces and backslashes.
4546 This option cannot be set from a |modeline| or in the |sandbox|, for
4547 security reasons.
4548
4549 *'makeprg'* *'mp'*
4550'makeprg' 'mp' string (default "make", VMS: "MMS")
4551 global or local to buffer |global-local|
4552 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004553 Program to use for the ":make" command. See |:make_makeprg|.
4554 This option may contain '%' and '#' characters, which are expanded to
4555 the current and alternate file name. |:_%| |:_#|
4556 Environment variables are expanded |:set_env|. See |option-backslash|
4557 about including spaces and backslashes.
4558 Note that a '|' must be escaped twice: once for ":set" and once for
4559 the interpretation of a command. When you use a filter called
4560 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 :set makeprg=gmake\ \\\|\ myfilter
4562< The placeholder "$*" can be given (even multiple times) to specify
4563 where the arguments will be included, for example: >
4564 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4565< This option cannot be set from a |modeline| or in the |sandbox|, for
4566 security reasons.
4567
Bram Moolenaar1a384422010-07-14 19:53:30 +02004568 *'colorcolumn'* *'cc'*
4569'colorcolumn' 'cc' string (default "")
4570 local to window
4571 {not in Vi}
4572 {not available when compiled without the |+syntax|
4573 feature}
4574 'colorcolumn' is a comma separated list of screen columns that are
4575 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
4576 text. Will make screen redrawing slower.
4577 The screen column can be an absolute number, or a number preceded with
4578 '+' or '-', which is added to or subtracted from 'textwidth'. >
4579
4580 :set cc=+1 " highlight column after 'textwidth'
4581 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
4582 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
4583<
4584 When 'textwidth' is zero then the items with '-' and '+' are not used.
4585 A maximum of 256 columns are highlighted.
4586
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 *'matchpairs'* *'mps'*
4588'matchpairs' 'mps' string (default "(:),{:},[:]")
4589 local to buffer
4590 {not in Vi}
4591 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004592 other. Currently only single byte character pairs are allowed, and
4593 they must be different. The characters must be separated by a colon.
4594 The pairs must be separated by a comma. Example for including '<' and
4595 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596 :set mps+=<:>
4597
4598< A more exotic example, to jump between the '=' and ';' in an
4599 assignment, useful for languages like C and Java: >
4600 :au FileType c,cpp,java set mps+==:;
4601
4602< For a more advanced way of using "%", see the matchit.vim plugin in
4603 the $VIMRUNTIME/macros directory. |add-local-help|
4604
4605 *'matchtime'* *'mat'*
4606'matchtime' 'mat' number (default 5)
4607 global
4608 {not in Vi}{in Nvi}
4609 Tenths of a second to show the matching paren, when 'showmatch' is
4610 set. Note that this is not in milliseconds, like other options that
4611 set a time. This is to be compatible with Nvi.
4612
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004613 *'maxcombine'* *'mco'*
4614'maxcombine' 'mco' number (default 2)
4615 global
4616 {not in Vi}
4617 {only available when compiled with the |+multi_byte|
4618 feature}
4619 The maximum number of combining characters supported for displaying.
4620 Only used when 'encoding' is "utf-8".
4621 The default is OK for most languages. Hebrew may require 4.
4622 Maximum value is 6.
4623 Even when this option is set to 2 you can still edit text with more
4624 combining characters, you just can't see them. Use |g8| or |ga|.
4625 See |mbyte-combining|.
4626
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 *'maxfuncdepth'* *'mfd'*
4628'maxfuncdepth' 'mfd' number (default 100)
4629 global
4630 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004631 {not available when compiled without the +eval
4632 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 Maximum depth of function calls for user functions. This normally
4634 catches endless recursion. When using a recursive function with
4635 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4636 more memory, there is the danger of failing when memory is exhausted.
4637 See also |:function|.
4638
4639 *'maxmapdepth'* *'mmd'* *E223*
4640'maxmapdepth' 'mmd' number (default 1000)
4641 global
4642 {not in Vi}
4643 Maximum number of times a mapping is done without resulting in a
4644 character to be used. This normally catches endless mappings, like
4645 ":map x y" with ":map y x". It still does not catch ":map g wg",
4646 because the 'w' is used before the next mapping is done. See also
4647 |key-mapping|.
4648
4649 *'maxmem'* *'mm'*
4650'maxmem' 'mm' number (default between 256 to 5120 (system
4651 dependent) or half the amount of memory
4652 available)
4653 global
4654 {not in Vi}
4655 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4656 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004657 other memory to be freed. The maximum usable value is about 2000000.
4658 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004660 *'maxmempattern'* *'mmp'*
4661'maxmempattern' 'mmp' number (default 1000)
4662 global
4663 {not in Vi}
4664 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004665 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004666 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004667 When Vim runs into the limit it gives an error message and mostly
4668 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004669 Running into the limit often means that the pattern is very
4670 inefficient or too complex. This may already happen with the pattern
4671 "\(.\)*" on a very long line. ".*" works much better.
4672 Vim may run out of memory before hitting the 'maxmempattern' limit.
4673
Bram Moolenaar071d4272004-06-13 20:20:40 +00004674 *'maxmemtot'* *'mmt'*
4675'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4676 dependent) or half the amount of memory
4677 available)
4678 global
4679 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004680 Maximum amount of memory in Kbyte to use for all buffers together.
4681 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4682 without a limit. On 64 bit machines higher values might work. But
4683 hey, do you really need more than 2 Gbyte for text editing?
4684 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685
4686 *'menuitems'* *'mis'*
4687'menuitems' 'mis' number (default 25)
4688 global
4689 {not in Vi}
4690 {not available when compiled without the |+menu|
4691 feature}
4692 Maximum number of items to use in a menu. Used for menus that are
4693 generated from a list of items, e.g., the Buffers menu. Changing this
4694 option has no direct effect, the menu must be refreshed first.
4695
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004696 *'mkspellmem'* *'msm'*
4697'mkspellmem' 'msm' string (default "460000,2000,500")
4698 global
4699 {not in Vi}
4700 {not available when compiled without the |+syntax|
4701 feature}
4702 Parameters for |:mkspell|. This tunes when to start compressing the
4703 word tree. Compression can be slow when there are many words, but
4704 it's needed to avoid running out of memory. The amount of memory used
4705 per word depends very much on how similar the words are, that's why
4706 this tuning is complicated.
4707
4708 There are three numbers, separated by commas:
4709 {start},{inc},{added}
4710
4711 For most languages the uncompressed word tree fits in memory. {start}
4712 gives the amount of memory in Kbyte that can be used before any
4713 compression is done. It should be a bit smaller than the amount of
4714 memory that is available to Vim.
4715
4716 When going over the {start} limit the {inc} number specifies the
4717 amount of memory in Kbyte that can be allocated before another
4718 compression is done. A low number means compression is done after
4719 less words are added, which is slow. A high number means more memory
4720 will be allocated.
4721
4722 After doing compression, {added} times 1024 words can be added before
4723 the {inc} limit is ignored and compression is done when any extra
4724 amount of memory is needed. A low number means there is a smaller
4725 chance of hitting the {inc} limit, less memory is used but it's
4726 slower.
4727
4728 The languages for which these numbers are important are Italian and
4729 Hungarian. The default works for when you have about 512 Mbyte. If
4730 you have 1 Gbyte you could use: >
4731 :set mkspellmem=900000,3000,800
4732< If you have less than 512 Mbyte |:mkspell| may fail for some
4733 languages, no matter what you set 'mkspellmem' to.
4734
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004736'modeline' 'ml' boolean (Vim default: on (off for root),
4737 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 local to buffer
4739 *'modelines'* *'mls'*
4740'modelines' 'mls' number (default 5)
4741 global
4742 {not in Vi}
4743 If 'modeline' is on 'modelines' gives the number of lines that is
4744 checked for set commands. If 'modeline' is off or 'modelines' is zero
4745 no lines are checked. See |modeline|.
4746 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4747 set and to the Vim default value when 'compatible' is reset.
4748
4749 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4750'modifiable' 'ma' boolean (default on)
4751 local to buffer
4752 {not in Vi} *E21*
4753 When off the buffer contents cannot be changed. The 'fileformat' and
4754 'fileencoding' options also can't be changed.
4755 Can be reset with the |-M| command line argument.
4756
4757 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4758'modified' 'mod' boolean (default off)
4759 local to buffer
4760 {not in Vi}
4761 When on, the buffer is considered to be modified. This option is set
4762 when:
4763 1. A change was made to the text since it was last written. Using the
4764 |undo| command to go back to the original text will reset the
4765 option. But undoing changes that were made before writing the
4766 buffer will set the option again, since the text is different from
4767 when it was written.
4768 2. 'fileformat' or 'fileencoding' is different from its original
4769 value. The original value is set when the buffer is read or
4770 written. A ":set nomodified" command also resets the original
4771 values to the current values and the 'modified' option will be
4772 reset.
4773 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4774 will be ignored.
4775
4776 *'more'* *'nomore'*
4777'more' boolean (Vim default: on, Vi default: off)
4778 global
4779 {not in Vi}
4780 When on, listings pause when the whole screen is filled. You will get
4781 the |more-prompt|. When this option is off there are no pauses, the
4782 listing continues until finished.
4783 NOTE: This option is set to the Vi default value when 'compatible' is
4784 set and to the Vim default value when 'compatible' is reset.
4785
4786 *'mouse'* *E538*
4787'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4788 global
4789 {not in Vi}
4790 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004791 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4792 sysmouse and Linux console with gpm). For using the mouse in the
4793 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794 The mouse can be enabled for different modes:
4795 n Normal mode
4796 v Visual mode
4797 i Insert mode
4798 c Command-line mode
4799 h all previous modes when editing a help file
4800 a all previous modes
4801 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 Normally you would enable the mouse in all four modes with: >
4803 :set mouse=a
4804< When the mouse is not enabled, the GUI will still use the mouse for
4805 modeless selection. This doesn't move the text cursor.
4806
4807 See |mouse-using|. Also see |'clipboard'|.
4808
4809 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004810 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 the mouse buttons can still be used by keeping the shift key pressed.
4812 Also see the 'clipboard' option.
4813
4814 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4815'mousefocus' 'mousef' boolean (default off)
4816 global
4817 {not in Vi}
4818 {only works in the GUI}
4819 The window that the mouse pointer is on is automatically activated.
4820 When changing the window layout or window focus in another way, the
4821 mouse pointer is moved to the window with keyboard focus. Off is the
4822 default because it makes using the pull down menus a little goofy, as
4823 a pointer transit may activate a window unintentionally.
4824
4825 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4826'mousehide' 'mh' boolean (default on)
4827 global
4828 {not in Vi}
4829 {only works in the GUI}
4830 When on, the mouse pointer is hidden when characters are typed.
4831 The mouse pointer is restored when the mouse is moved.
4832
4833 *'mousemodel'* *'mousem'*
4834'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4835 global
4836 {not in Vi}
4837 Sets the model to use for the mouse. The name mostly specifies what
4838 the right mouse button is used for:
4839 extend Right mouse button extends a selection. This works
4840 like in an xterm.
4841 popup Right mouse button pops up a menu. The shifted left
4842 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004843 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 popup_setpos Like "popup", but the cursor will be moved to the
4845 position where the mouse was clicked, and thus the
4846 selected operation will act upon the clicked object.
4847 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004848 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849 course, that right clicking outside a selection will
4850 end Visual mode.
4851 Overview of what button does what for each model:
4852 mouse extend popup(_setpos) ~
4853 left click place cursor place cursor
4854 left drag start selection start selection
4855 shift-left search word extend selection
4856 right click extend selection popup menu (place cursor)
4857 right drag extend selection -
4858 middle click paste paste
4859
4860 In the "popup" model the right mouse button produces a pop-up menu.
4861 You need to define this first, see |popup-menu|.
4862
4863 Note that you can further refine the meaning of buttons with mappings.
4864 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4865 selection (because that's handled in the GUI code directly).
4866
4867 The 'mousemodel' option is set by the |:behave| command.
4868
4869 *'mouseshape'* *'mouses'* *E547*
4870'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004871 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 global
4873 {not in Vi}
4874 {only available when compiled with the |+mouseshape|
4875 feature}
4876 This option tells Vim what the mouse pointer should look like in
4877 different modes. The option is a comma separated list of parts, much
4878 like used for 'guicursor'. Each part consist of a mode/location-list
4879 and an argument-list:
4880 mode-list:shape,mode-list:shape,..
4881 The mode-list is a dash separated list of these modes/locations:
4882 In a normal window: ~
4883 n Normal mode
4884 v Visual mode
4885 ve Visual mode with 'selection' "exclusive" (same as 'v',
4886 if not specified)
4887 o Operator-pending mode
4888 i Insert mode
4889 r Replace mode
4890
4891 Others: ~
4892 c appending to the command-line
4893 ci inserting in the command-line
4894 cr replacing in the command-line
4895 m at the 'Hit ENTER' or 'More' prompts
4896 ml idem, but cursor in the last line
4897 e any mode, pointer below last window
4898 s any mode, pointer on a status line
4899 sd any mode, while dragging a status line
4900 vs any mode, pointer on a vertical separator line
4901 vd any mode, while dragging a vertical separator line
4902 a everywhere
4903
4904 The shape is one of the following:
4905 avail name looks like ~
4906 w x arrow Normal mouse pointer
4907 w x blank no pointer at all (use with care!)
4908 w x beam I-beam
4909 w x updown up-down sizing arrows
4910 w x leftright left-right sizing arrows
4911 w x busy The system's usual busy pointer
4912 w x no The system's usual 'no input' pointer
4913 x udsizing indicates up-down resizing
4914 x lrsizing indicates left-right resizing
4915 x crosshair like a big thin +
4916 x hand1 black hand
4917 x hand2 white hand
4918 x pencil what you write with
4919 x question big ?
4920 x rightup-arrow arrow pointing right-up
4921 w x up-arrow arrow pointing up
4922 x <number> any X11 pointer number (see X11/cursorfont.h)
4923
4924 The "avail" column contains a 'w' if the shape is available for Win32,
4925 x for X11.
4926 Any modes not specified or shapes not available use the normal mouse
4927 pointer.
4928
4929 Example: >
4930 :set mouseshape=s:udsizing,m:no
4931< will make the mouse turn to a sizing arrow over the status lines and
4932 indicate no input when the hit-enter prompt is displayed (since
4933 clicking the mouse has no effect in this state.)
4934
4935 *'mousetime'* *'mouset'*
4936'mousetime' 'mouset' number (default 500)
4937 global
4938 {not in Vi}
4939 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4940 time in msec between two mouse clicks for the second click to be
4941 recognized as a multi click.
4942
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004943 *'mzquantum'* *'mzq'*
4944'mzquantum' 'mzq' number (default 100)
4945 global
4946 {not in Vi}
4947 {not available when compiled without the |+mzscheme|
4948 feature}
4949 The number of milliseconds between polls for MzScheme threads.
4950 Negative or zero value means no thread scheduling.
4951
Bram Moolenaar071d4272004-06-13 20:20:40 +00004952 *'nrformats'* *'nf'*
4953'nrformats' 'nf' string (default "octal,hex")
4954 local to buffer
4955 {not in Vi}
4956 This defines what bases Vim will consider for numbers when using the
4957 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4958 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004959 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02004961 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00004962 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004963 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004964 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 considered to be hexadecimal. Example: Using CTRL-X on
4966 "0x100" results in "0x0ff".
4967 Numbers which simply begin with a digit in the range 1-9 are always
4968 considered decimal. This also happens for numbers that are not
4969 recognized as octal or hex.
4970
4971 *'number'* *'nu'* *'nonumber'* *'nonu'*
4972'number' 'nu' boolean (default off)
4973 local to window
4974 Print the line number in front of each line. When the 'n' option is
4975 excluded from 'cpoptions' a wrapped line will not use the column of
4976 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004977 The 'numberwidth' option can be used to set the room used for the line
4978 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 When a long, wrapped line doesn't start with the first character, '-'
4980 characters are put before the number.
4981 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02004982 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004984 *'numberwidth'* *'nuw'*
4985'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4986 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004987 {not in Vi}
4988 {only available when compiled with the |+linebreak|
4989 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004990 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02004991 when the 'number' or 'relativenumber' option is set or printing lines
4992 with a line number. Since one space is always between the number and
4993 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004994 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02004995 fit the highest line number in the buffer respectively the number of
4996 rows in the window, depending on whether 'number' or 'relativenumber'
4997 is set. Thus with the Vim default of 4 there is room for a line number
4998 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004999 The minimum value is 1, the maximum value is 10.
5000 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5001
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005002 *'omnifunc'* *'ofu'*
5003'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005004 local to buffer
5005 {not in Vi}
5006 {not available when compiled without the +eval
5007 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005008 This option specifies a function to be used for Insert mode omni
5009 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005010 See |complete-functions| for an explanation of how the function is
5011 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005012 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005013 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005014
5015
Bram Moolenaar02467872007-05-06 13:22:01 +00005016 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005017'opendevice' 'odev' boolean (default off)
5018 global
5019 {not in Vi}
5020 {only for MS-DOS, MS-Windows and OS/2}
5021 Enable reading and writing from devices. This may get Vim stuck on a
5022 device that can be opened but doesn't actually do the I/O. Therefore
5023 it is off by default.
5024 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5025 result in editing a device.
5026
5027
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005028 *'operatorfunc'* *'opfunc'*
5029'operatorfunc' 'opfunc' string (default: empty)
5030 global
5031 {not in Vi}
5032 This option specifies a function to be called by the |g@| operator.
5033 See |:map-operator| for more info and an example.
5034
5035 This option cannot be set from a |modeline| or in the |sandbox|, for
5036 security reasons.
5037
5038
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 *'osfiletype'* *'oft'* *E366*
5040'osfiletype' 'oft' string (RISC-OS default: "Text",
5041 others default: "")
5042 local to buffer
5043 {not in Vi}
5044 {only available when compiled with the |+osfiletype|
5045 feature}
5046 Some operating systems store extra information about files besides
5047 name, datestamp and permissions. This option contains the extra
5048 information, the nature of which will vary between systems.
5049 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005050 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 It can affect the pattern matching of the automatic commands.
5052 |autocmd-osfiletypes|
5053
5054 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005055'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 global
5057 Specifies the nroff macros that separate paragraphs. These are pairs
5058 of two letters (see |object-motions|).
5059
5060 *'paste'* *'nopaste'*
5061'paste' boolean (default off)
5062 global
5063 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005064 Put Vim in Paste mode. This is useful if you want to cut or copy
5065 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066 unexpected effects.
5067 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005068 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005069 knows about pasting and will mostly do the right thing without 'paste'
5070 being set. The same is true for a terminal where Vim handles the
5071 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005072 This option is reset when starting the GUI. Thus if you set it in
5073 your .vimrc it will work in a terminal, but not in the GUI. Setting
5074 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5075 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076 When the 'paste' option is switched on (also when it was already on):
5077 - mapping in Insert mode and Command-line mode is disabled
5078 - abbreviations are disabled
5079 - 'textwidth' is set to 0
5080 - 'wrapmargin' is set to 0
5081 - 'autoindent' is reset
5082 - 'smartindent' is reset
5083 - 'softtabstop' is set to 0
5084 - 'revins' is reset
5085 - 'ruler' is reset
5086 - 'showmatch' is reset
5087 - 'formatoptions' is used like it is empty
5088 These options keep their value, but their effect is disabled:
5089 - 'lisp'
5090 - 'indentexpr'
5091 - 'cindent'
5092 NOTE: When you start editing another file while the 'paste' option is
5093 on, settings from the modelines or autocommands may change the
5094 settings again, causing trouble when pasting text. You might want to
5095 set the 'paste' option again.
5096 When the 'paste' option is reset the mentioned options are restored to
5097 the value before the moment 'paste' was switched from off to on.
5098 Resetting 'paste' before ever setting it does not have any effect.
5099 Since mapping doesn't work while 'paste' is active, you need to use
5100 the 'pastetoggle' option to toggle the 'paste' option with some key.
5101
5102 *'pastetoggle'* *'pt'*
5103'pastetoggle' 'pt' string (default "")
5104 global
5105 {not in Vi}
5106 When non-empty, specifies the key sequence that toggles the 'paste'
5107 option. This is like specifying a mapping: >
5108 :map {keys} :set invpaste<CR>
5109< Where {keys} is the value of 'pastetoggle'.
5110 The difference is that it will work even when 'paste' is set.
5111 'pastetoggle' works in Insert mode and Normal mode, but not in
5112 Command-line mode.
5113 Mappings are checked first, thus overrule 'pastetoggle'. However,
5114 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5115 this: >
5116 :map <F10> :set paste<CR>
5117 :map <F11> :set nopaste<CR>
5118 :imap <F10> <C-O>:set paste<CR>
5119 :imap <F11> <nop>
5120 :set pastetoggle=<F11>
5121< This will make <F10> start paste mode and <F11> stop paste mode.
5122 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5123 mode everything is inserted literally, except the 'pastetoggle' key
5124 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005125 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126
5127 *'pex'* *'patchexpr'*
5128'patchexpr' 'pex' string (default "")
5129 global
5130 {not in Vi}
5131 {not available when compiled without the |+diff|
5132 feature}
5133 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005134 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005135
5136 *'patchmode'* *'pm'* *E206*
5137'patchmode' 'pm' string (default "")
5138 global
5139 {not in Vi}
5140 When non-empty the oldest version of a file is kept. This can be used
5141 to keep the original version of a file if you are changing files in a
5142 source distribution. Only the first time that a file is written a
5143 copy of the original file will be kept. The name of the copy is the
5144 name of the original file with the string in the 'patchmode' option
5145 appended. This option should start with a dot. Use a string like
5146 ".org". 'backupdir' must not be empty for this to work (Detail: The
5147 backup file is renamed to the patchmode file after the new file has
5148 been successfully written, that's why it must be possible to write a
5149 backup file). If there was no file to be backed up, an empty file is
5150 created.
5151 When the 'backupskip' pattern matches, a patchmode file is not made.
5152 Using 'patchmode' for compressed files appends the extension at the
5153 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5154 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005155 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156
5157 *'path'* *'pa'* *E343* *E345* *E347*
5158'path' 'pa' string (default on Unix: ".,/usr/include,,"
5159 on OS/2: ".,/emx/include,,"
5160 other systems: ".,,")
5161 global or local to buffer |global-local|
5162 {not in Vi}
5163 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005164 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5165 provided that the file being searched for has a relative path (not
5166 starting with "/", "./" or "../"). The directories in the 'path'
5167 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 - Use commas to separate directory names: >
5169 :set path=.,/usr/local/include,/usr/include
5170< - Spaces can also be used to separate directory names (for backwards
5171 compatibility with version 3.0). To have a space in a directory
5172 name, precede it with an extra backslash, and escape the space: >
5173 :set path=.,/dir/with\\\ space
5174< - To include a comma in a directory name precede it with an extra
5175 backslash: >
5176 :set path=.,/dir/with\\,comma
5177< - To search relative to the directory of the current file, use: >
5178 :set path=.
5179< - To search in the current directory use an empty string between two
5180 commas: >
5181 :set path=,,
5182< - A directory name may end in a ':' or '/'.
5183 - Environment variables are expanded |:set_env|.
5184 - When using |netrw.vim| URLs can be used. For example, adding
5185 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005186 - Search upwards and downwards in a directory tree using "*", "**" and
5187 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 {not available when compiled without the |+path_extra| feature}
5189 - Careful with '\' characters, type two to get one in the option: >
5190 :set path=.,c:\\include
5191< Or just use '/' instead: >
5192 :set path=.,c:/include
5193< Don't forget "." or files won't even be found in the same directory as
5194 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005195 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196 it is something like 256 or 1024 characters.
5197 You can check if all the include files are found, using the value of
5198 'path', see |:checkpath|.
5199 The use of |:set+=| and |:set-=| is preferred when adding or removing
5200 directories from the list. This avoids problems when a future version
5201 uses another default. To remove the current directory use: >
5202 :set path-=
5203< To add the current directory use: >
5204 :set path+=
5205< To use an environment variable, you probably need to replace the
5206 separator. Here is an example to append $INCL, in which directory
5207 names are separated with a semi-colon: >
5208 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5209< Replace the ';' with a ':' or whatever separator is used. Note that
5210 this doesn't work when $INCL contains a comma or white space.
5211
5212 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5213'preserveindent' 'pi' boolean (default off)
5214 local to buffer
5215 {not in Vi}
5216 When changing the indent of the current line, preserve as much of the
5217 indent structure as possible. Normally the indent is replaced by a
5218 series of tabs followed by spaces as required (unless |'expandtab'| is
5219 enabled, in which case only spaces are used). Enabling this option
5220 means the indent will preserve as many existing characters as possible
5221 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005222 'expandtab' does not apply to the preserved white space, a Tab remains
5223 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 NOTE: When using ">>" multiple times the resulting indent is a mix of
5225 tabs and spaces. You might not like this.
5226 NOTE: 'preserveindent' is reset when 'compatible' is set.
5227 Also see 'copyindent'.
5228 Use |:retab| to clean up white space.
5229
5230 *'previewheight'* *'pvh'*
5231'previewheight' 'pvh' number (default 12)
5232 global
5233 {not in Vi}
5234 {not available when compiled without the |+windows| or
5235 |+quickfix| feature}
5236 Default height for a preview window. Used for |:ptag| and associated
5237 commands. Used for |CTRL-W_}| when no count is given.
5238
5239 *'previewwindow'* *'nopreviewwindow'*
5240 *'pvw'* *'nopvw'* *E590*
5241'previewwindow' 'pvw' boolean (default off)
5242 local to window
5243 {not in Vi}
5244 {not available when compiled without the |+windows| or
5245 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005246 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247 set. It's normally not set directly, but by using one of the commands
5248 |:ptag|, |:pedit|, etc.
5249
5250 *'printdevice'* *'pdev'*
5251'printdevice' 'pdev' string (default empty)
5252 global
5253 {not in Vi}
5254 {only available when compiled with the |+printer|
5255 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005256 The name of the printer to be used for |:hardcopy|.
5257 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005258 This option cannot be set from a |modeline| or in the |sandbox|, for
5259 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260
Bram Moolenaar8299df92004-07-10 09:47:34 +00005261 *'printencoding'* *'penc'*
5262'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263 global
5264 {not in Vi}
5265 {only available when compiled with the |+printer|
5266 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005267 Sets the character encoding used when printing.
5268 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269
5270 *'printexpr'* *'pexpr'*
5271'printexpr' 'pexpr' String (default: see below)
5272 global
5273 {not in Vi}
5274 {only available when compiled with the |+printer|
5275 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005276 Expression used to print the PostScript produced with |:hardcopy|.
5277 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005278
Bram Moolenaar8299df92004-07-10 09:47:34 +00005279 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280'printfont' 'pfn' string (default "courier")
5281 global
5282 {not in Vi}
5283 {only available when compiled with the |+printer|
5284 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005285 The name of the font that will be used for |:hardcopy|.
5286 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287
5288 *'printheader'* *'pheader'*
5289'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5290 global
5291 {not in Vi}
5292 {only available when compiled with the |+printer|
5293 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005294 The format of the header produced in |:hardcopy| output.
5295 See |pheader-option|.
5296
5297 *'printmbcharset'* *'pmbcs'*
5298'printmbcharset' 'pmbcs' string (default "")
5299 global
5300 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005301 {only available when compiled with the |+printer|,
5302 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005303 The CJK character set to be used for CJK output from |:hardcopy|.
5304 See |pmbcs-option|.
5305
5306 *'printmbfont'* *'pmbfn'*
5307'printmbfont' 'pmbfn' string (default "")
5308 global
5309 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005310 {only available when compiled with the |+printer|,
5311 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005312 List of font names to be used for CJK output from |:hardcopy|.
5313 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314
5315 *'printoptions'* *'popt'*
5316'printoptions' 'popt' string (default "")
5317 global
5318 {not in Vi}
5319 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005320 List of items that control the format of the output of |:hardcopy|.
5321 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005322
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005323 *'prompt'* *'noprompt'*
5324'prompt' boolean (default on)
5325 global
5326 When on a ":" prompt is used in Ex mode.
5327
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005328 *'pumheight'* *'ph'*
5329'pumheight' 'ph' number (default 0)
5330 global
5331 {not available when compiled without the
5332 |+insert_expand| feature}
5333 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005334 Determines the maximum number of items to show in the popup menu for
5335 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005336 |ins-completion-menu|.
5337
5338
Bram Moolenaar677ee682005-01-27 14:41:15 +00005339 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005340'quoteescape' 'qe' string (default "\")
5341 local to buffer
5342 {not in Vi}
5343 The characters that are used to escape quotes in a string. Used for
5344 objects like a', a" and a` |a'|.
5345 When one of the characters in this option is found inside a string,
5346 the following character will be skipped. The default value makes the
5347 text "foo\"bar\\" considered to be one string.
5348
Bram Moolenaar071d4272004-06-13 20:20:40 +00005349 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5350'readonly' 'ro' boolean (default off)
5351 local to buffer
5352 If on, writes fail unless you use a '!'. Protects you from
5353 accidentally overwriting a file. Default on when Vim is started
5354 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005355 When using ":w!" the 'readonly' option is reset for the current
5356 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005358 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005360 *'redrawtime'* *'rdt'*
5361'redrawtime' 'rdt' number (default 2000)
5362 global
5363 {not in Vi}
5364 {only available when compiled with the |+reltime|
5365 feature}
5366 The time in milliseconds for redrawing the display. This applies to
5367 searching for patterns for 'hlsearch' and |:match| highlighting.
5368 When redrawing takes more than this many milliseconds no further
5369 matches will be highlighted. This is used to avoid that Vim hangs
5370 when using a very complicated pattern.
5371
Bram Moolenaar64486672010-05-16 15:46:46 +02005372 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5373'relativenumber' 'rnu' boolean (default off)
5374 local to window
5375 {not in Vi}
5376 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005377 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005378 precede some vertical motion commands (e.g. j k + -) with, without
5379 having to calculate it yourself. Especially useful in combination with
5380 other commands (e.g. y d c < > gq gw =).
5381 When the 'n' option is excluded from 'cpoptions' a wrapped
5382 line will not use the column of line numbers (this is the default when
5383 'compatible' isn't set).
5384 The 'numberwidth' option can be used to set the room used for the line
5385 number.
5386 When a long, wrapped line doesn't start with the first character, '-'
5387 characters are put before the number.
5388 See |hl-LineNr| for the highlighting used for the number.
5389 When setting this option, 'number' is reset.
5390
Bram Moolenaar071d4272004-06-13 20:20:40 +00005391 *'remap'* *'noremap'*
5392'remap' boolean (default on)
5393 global
5394 Allows for mappings to work recursively. If you do not want this for
5395 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005396 NOTE: To avoid portability problems with Vim scripts, always keep
5397 this option at the default "on". Only switch it off when working with
5398 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399
5400 *'report'*
5401'report' number (default 2)
5402 global
5403 Threshold for reporting number of lines changed. When the number of
5404 changed lines is more than 'report' a message will be given for most
5405 ":" commands. If you want it always, set 'report' to 0.
5406 For the ":substitute" command the number of substitutions is used
5407 instead of the number of lines.
5408
5409 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5410'restorescreen' 'rs' boolean (default on)
5411 global
5412 {not in Vi} {only in Windows 95/NT console version}
5413 When set, the screen contents is restored when exiting Vim. This also
5414 happens when executing external commands.
5415
5416 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5417 options in your .vimrc. To disable restoring:
5418 set t_ti= t_te=
5419 To enable restoring (for an xterm):
5420 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5421 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5422
5423 *'revins'* *'ri'* *'norevins'* *'nori'*
5424'revins' 'ri' boolean (default off)
5425 global
5426 {not in Vi}
5427 {only available when compiled with the |+rightleft|
5428 feature}
5429 Inserting characters in Insert mode will work backwards. See "typing
5430 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5431 command in Insert mode, when 'allowrevins' is set.
5432 NOTE: This option is reset when 'compatible' or 'paste' is set.
5433
5434 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5435'rightleft' 'rl' boolean (default off)
5436 local to window
5437 {not in Vi}
5438 {only available when compiled with the |+rightleft|
5439 feature}
5440 When on, display orientation becomes right-to-left, i.e., characters
5441 that are stored in the file appear from the right to the left.
5442 Using this option, it is possible to edit files for languages that
5443 are written from the right to the left such as Hebrew and Arabic.
5444 This option is per window, so it is possible to edit mixed files
5445 simultaneously, or to view the same file in both ways (this is
5446 useful whenever you have a mixed text file with both right-to-left
5447 and left-to-right strings so that both sets are displayed properly
5448 in different windows). Also see |rileft.txt|.
5449
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005450 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451'rightleftcmd' 'rlc' string (default "search")
5452 local to window
5453 {not in Vi}
5454 {only available when compiled with the |+rightleft|
5455 feature}
5456 Each word in this option enables the command line editing to work in
5457 right-to-left mode for a group of commands:
5458
5459 search "/" and "?" commands
5460
5461 This is useful for languages such as Hebrew, Arabic and Farsi.
5462 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5463
5464 *'ruler'* *'ru'* *'noruler'* *'noru'*
5465'ruler' 'ru' boolean (default off)
5466 global
5467 {not in Vi}
5468 {not available when compiled without the
5469 |+cmdline_info| feature}
5470 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005471 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005472 text in the file is shown on the far right:
5473 Top first line is visible
5474 Bot last line is visible
5475 All first and last line are visible
5476 45% relative position in the file
5477 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005478 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005480 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 this option takes precedence over 'ruler' and 'rulerformat'
5482 If the number of characters displayed is different from the number of
5483 bytes in the text (e.g., for a TAB or a multi-byte character), both
5484 the text column (byte number) and the screen column are shown,
5485 separated with a dash.
5486 For an empty line "0-1" is shown.
5487 For an empty buffer the line number will also be zero: "0,0-1".
5488 This option is reset when the 'paste' option is set.
5489 If you don't want to see the ruler all the time but want to know where
5490 you are, use "g CTRL-G" |g_CTRL-G|.
5491 NOTE: This option is reset when 'compatible' is set.
5492
5493 *'rulerformat'* *'ruf'*
5494'rulerformat' 'ruf' string (default empty)
5495 global
5496 {not in Vi}
5497 {not available when compiled without the |+statusline|
5498 feature}
5499 When this option is not empty, it determines the content of the ruler
5500 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005501 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005502 The default ruler width is 17 characters. To make the ruler 15
5503 characters wide, put "%15(" at the start and "%)" at the end.
5504 Example: >
5505 :set rulerformat=%15(%c%V\ %p%%%)
5506<
5507 *'runtimepath'* *'rtp'* *vimfiles*
5508'runtimepath' 'rtp' string (default:
5509 Unix: "$HOME/.vim,
5510 $VIM/vimfiles,
5511 $VIMRUNTIME,
5512 $VIM/vimfiles/after,
5513 $HOME/.vim/after"
5514 Amiga: "home:vimfiles,
5515 $VIM/vimfiles,
5516 $VIMRUNTIME,
5517 $VIM/vimfiles/after,
5518 home:vimfiles/after"
5519 PC, OS/2: "$HOME/vimfiles,
5520 $VIM/vimfiles,
5521 $VIMRUNTIME,
5522 $VIM/vimfiles/after,
5523 $HOME/vimfiles/after"
5524 Macintosh: "$VIM:vimfiles,
5525 $VIMRUNTIME,
5526 $VIM:vimfiles:after"
5527 RISC-OS: "Choices:vimfiles,
5528 $VIMRUNTIME,
5529 Choices:vimfiles/after"
5530 VMS: "sys$login:vimfiles,
5531 $VIM/vimfiles,
5532 $VIMRUNTIME,
5533 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005534 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 global
5536 {not in Vi}
5537 This is a list of directories which will be searched for runtime
5538 files:
5539 filetype.vim filetypes by file name |new-filetype|
5540 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005541 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542 colors/ color scheme files |:colorscheme|
5543 compiler/ compiler files |:compiler|
5544 doc/ documentation |write-local-help|
5545 ftplugin/ filetype plugins |write-filetype-plugin|
5546 indent/ indent scripts |indent-expression|
5547 keymap/ key mapping files |mbyte-keymap|
5548 lang/ menu translations |:menutrans|
5549 menu.vim GUI menus |menu.vim|
5550 plugin/ plugin scripts |write-plugin|
5551 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005552 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005553 syntax/ syntax files |mysyntaxfile|
5554 tutor/ files for vimtutor |tutor|
5555
5556 And any other file searched for with the |:runtime| command.
5557
5558 The defaults for most systems are setup to search five locations:
5559 1. In your home directory, for your personal preferences.
5560 2. In a system-wide Vim directory, for preferences from the system
5561 administrator.
5562 3. In $VIMRUNTIME, for files distributed with Vim.
5563 *after-directory*
5564 4. In the "after" directory in the system-wide Vim directory. This is
5565 for the system administrator to overrule or add to the distributed
5566 defaults (rarely needed)
5567 5. In the "after" directory in your home directory. This is for
5568 personal preferences to overrule or add to the distributed defaults
5569 or system-wide settings (rarely needed).
5570
5571 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5572 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005573 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574 wildcards.
5575 See |:runtime|.
5576 Example: >
5577 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5578< This will use the directory "~/vimruntime" first (containing your
5579 personal Vim runtime files), then "/mygroup/vim" (shared between a
5580 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5581 files).
5582 You probably should always include $VIMRUNTIME somewhere, to use the
5583 distributed runtime files. You can put a directory before $VIMRUNTIME
5584 to find files which replace a distributed runtime files. You can put
5585 a directory after $VIMRUNTIME to find files which add to distributed
5586 runtime files.
5587 This option cannot be set from a |modeline| or in the |sandbox|, for
5588 security reasons.
5589
5590 *'scroll'* *'scr'*
5591'scroll' 'scr' number (default: half the window height)
5592 local to window
5593 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5594 set to half the number of lines in the window when the window size
5595 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005596 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5598 the number of screen lines instead of file lines, makes a difference
5599 when lines wrap}
5600
5601 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5602'scrollbind' 'scb' boolean (default off)
5603 local to window
5604 {not in Vi}
5605 {not available when compiled without the |+scrollbind|
5606 feature}
5607 See also |scroll-binding|. When this option is set, the current
5608 window scrolls as other scrollbind windows (windows that also have
5609 this option set) scroll. This option is useful for viewing the
5610 differences between two versions of a file, see 'diff'.
5611 See |'scrollopt'| for options that determine how this option should be
5612 interpreted.
5613 This option is mostly reset when splitting a window to edit another
5614 file. This means that ":split | edit file" results in two windows
5615 with scroll-binding, but ":split file" does not.
5616
5617 *'scrolljump'* *'sj'*
5618'scrolljump' 'sj' number (default 1)
5619 global
5620 {not in Vi}
5621 Minimal number of lines to scroll when the cursor gets off the
5622 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5623 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005624 When set to a negative number from -1 to -100 this is used as the
5625 percentage of the window height. Thus -50 scrolls half the window
5626 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 NOTE: This option is set to 1 when 'compatible' is set.
5628
5629 *'scrolloff'* *'so'*
5630'scrolloff' 'so' number (default 0)
5631 global
5632 {not in Vi}
5633 Minimal number of screen lines to keep above and below the cursor.
5634 This will make some context visible around where you are working. If
5635 you set it to a very large value (999) the cursor line will always be
5636 in the middle of the window (except at the start or end of the file or
5637 when long lines wrap).
5638 For scrolling horizontally see 'sidescrolloff'.
5639 NOTE: This option is set to 0 when 'compatible' is set.
5640
5641 *'scrollopt'* *'sbo'*
5642'scrollopt' 'sbo' string (default "ver,jump")
5643 global
5644 {not available when compiled without the |+scrollbind|
5645 feature}
5646 {not in Vi}
5647 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005648 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5649 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650 The following words are available:
5651 ver Bind vertical scrolling for 'scrollbind' windows
5652 hor Bind horizontal scrolling for 'scrollbind' windows
5653 jump Applies to the offset between two windows for vertical
5654 scrolling. This offset is the difference in the first
5655 displayed line of the bound windows. When moving
5656 around in a window, another 'scrollbind' window may
5657 reach a position before the start or after the end of
5658 the buffer. The offset is not changed though, when
5659 moving back the 'scrollbind' window will try to scroll
5660 to the desired position when possible.
5661 When now making that window the current one, two
5662 things can be done with the relative offset:
5663 1. When "jump" is not included, the relative offset is
5664 adjusted for the scroll position in the new current
5665 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005666 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 2. When "jump" is included, the other windows are
5668 scrolled to keep the same relative offset. When
5669 going back to the other window, it still uses the
5670 same relative offset.
5671 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005672 When 'diff' mode is active there always is vertical scroll binding,
5673 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674
5675 *'sections'* *'sect'*
5676'sections' 'sect' string (default "SHNHH HUnhsh")
5677 global
5678 Specifies the nroff macros that separate sections. These are pairs of
5679 two letters (See |object-motions|). The default makes a section start
5680 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5681
5682 *'secure'* *'nosecure'* *E523*
5683'secure' boolean (default off)
5684 global
5685 {not in Vi}
5686 When on, ":autocmd", shell and write commands are not allowed in
5687 ".vimrc" and ".exrc" in the current directory and map commands are
5688 displayed. Switch it off only if you know that you will not run into
5689 problems, or when the 'exrc' option is off. On Unix this option is
5690 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005691 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 'secure' at the end of your ~/.vimrc then.
5693 This option cannot be set from a |modeline| or in the |sandbox|, for
5694 security reasons.
5695
5696 *'selection'* *'sel'*
5697'selection' 'sel' string (default "inclusive")
5698 global
5699 {not in Vi}
5700 This option defines the behavior of the selection. It is only used
5701 in Visual and Select mode.
5702 Possible values:
5703 value past line inclusive ~
5704 old no yes
5705 inclusive yes yes
5706 exclusive yes no
5707 "past line" means that the cursor is allowed to be positioned one
5708 character past the line.
5709 "inclusive" means that the last character of the selection is included
5710 in an operation. For example, when "x" is used to delete the
5711 selection.
5712 Note that when "exclusive" is used and selecting from the end
5713 backwards, you cannot include the last character of a line, when
5714 starting in Normal mode and 'virtualedit' empty.
5715
5716 The 'selection' option is set by the |:behave| command.
5717
5718 *'selectmode'* *'slm'*
5719'selectmode' 'slm' string (default "")
5720 global
5721 {not in Vi}
5722 This is a comma separated list of words, which specifies when to start
5723 Select mode instead of Visual mode, when a selection is started.
5724 Possible values:
5725 mouse when using the mouse
5726 key when using shifted special keys
5727 cmd when using "v", "V" or CTRL-V
5728 See |Select-mode|.
5729 The 'selectmode' option is set by the |:behave| command.
5730
5731 *'sessionoptions'* *'ssop'*
5732'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005733 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 global
5735 {not in Vi}
5736 {not available when compiled without the +mksession
5737 feature}
5738 Changes the effect of the |:mksession| command. It is a comma
5739 separated list of words. Each word enables saving and restoring
5740 something:
5741 word save and restore ~
5742 blank empty windows
5743 buffers hidden and unloaded buffers, not just those in windows
5744 curdir the current directory
5745 folds manually created folds, opened/closed folds and local
5746 fold options
5747 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005748 and contain at least one lowercase letter. Only
5749 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750 help the help window
5751 localoptions options and mappings local to a window or buffer (not
5752 global values for local options)
5753 options all options and mappings (also global values for local
5754 options)
5755 resize size of the Vim window: 'lines' and 'columns'
5756 sesdir the directory in which the session file is located
5757 will become the current directory (useful with
5758 projects accessed over a network from different
5759 systems)
5760 slash backslashes in file names replaced with forward
5761 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005762 tabpages all tab pages; without this only the current tab page
5763 is restored, so that you can make a session for each
5764 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005765 unix with Unix end-of-line format (single <NL>), even when
5766 on Windows or DOS
5767 winpos position of the whole Vim window
5768 winsize window sizes
5769
5770 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005771 When neither "curdir" nor "sesdir" is included, file names are stored
5772 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 "slash" and "unix" are useful on Windows when sharing session files
5774 with Unix. The Unix version of Vim cannot source dos format scripts,
5775 but the Windows version of Vim can source unix format scripts.
5776
5777 *'shell'* *'sh'* *E91*
5778'shell' 'sh' string (default $SHELL or "sh",
5779 MS-DOS and Win32: "command.com" or
5780 "cmd.exe", OS/2: "cmd")
5781 global
5782 Name of the shell to use for ! and :! commands. When changing the
5783 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5784 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005785 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005786 See |option-backslash| about including spaces and backslashes.
5787 Environment variables are expanded |:set_env|.
5788 If the name of the shell contains a space, you might need to enclose
5789 it in quotes. Example: >
5790 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5791< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005792 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 "-f" is not inside the quotes, because it is not part of the command
5794 name. And Vim automagically recognizes the backslashes that are path
5795 separators.
5796 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5797 variable to change the way external commands are executed. See the
5798 libc.inf file of DJGPP.
5799 Under MS-Windows, when the executable ends in ".com" it must be
5800 included. Thus setting the shell to "command.com" or "4dos.com"
5801 works, but "command" and "4dos" do not work for all commands (e.g.,
5802 filtering).
5803 For unknown reasons, when using "4dos.com" the current directory is
5804 changed to "C:\". To avoid this set 'shell' like this: >
5805 :set shell=command.com\ /c\ 4dos
5806< This option cannot be set from a |modeline| or in the |sandbox|, for
5807 security reasons.
5808
5809 *'shellcmdflag'* *'shcf'*
5810'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5811 does not contain "sh" somewhere: "/c")
5812 global
5813 {not in Vi}
5814 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5815 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5816 systems, the default is set according to the value of 'shell', to
5817 reduce the need to set this option by the user. It's not used for
5818 OS/2 (EMX figures this out itself). See |option-backslash| about
5819 including spaces and backslashes. See |dos-shell|.
5820 This option cannot be set from a |modeline| or in the |sandbox|, for
5821 security reasons.
5822
5823 *'shellpipe'* *'sp'*
5824'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5825 global
5826 {not in Vi}
5827 {not available when compiled without the |+quickfix|
5828 feature}
5829 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005830 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831 including spaces and backslashes.
5832 The name of the temporary file can be represented by "%s" if necessary
5833 (the file name is appended automatically if no %s appears in the value
5834 of this option).
5835 For the Amiga and MS-DOS the default is ">". The output is directly
5836 saved in a file and not echoed to the screen.
5837 For Unix the default it "| tee". The stdout of the compiler is saved
5838 in a file and echoed to the screen. If the 'shell' option is "csh" or
5839 "tcsh" after initializations, the default becomes "|& tee". If the
5840 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005841 "2>&1| tee". This means that stderr is also included. Before using
5842 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843 The initialization of this option is done after reading the ".vimrc"
5844 and the other initializations, so that when the 'shell' option is set
5845 there, the 'shellpipe' option changes automatically, unless it was
5846 explicitly set before.
5847 When 'shellpipe' is set to an empty string, no redirection of the
5848 ":make" output will be done. This is useful if you use a 'makeprg'
5849 that writes to 'makeef' by itself. If you want no piping, but do
5850 want to include the 'makeef', set 'shellpipe' to a single space.
5851 Don't forget to precede the space with a backslash: ":set sp=\ ".
5852 In the future pipes may be used for filtering and this option will
5853 become obsolete (at least for Unix).
5854 This option cannot be set from a |modeline| or in the |sandbox|, for
5855 security reasons.
5856
5857 *'shellquote'* *'shq'*
5858'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5859 contains "sh" somewhere: "\"")
5860 global
5861 {not in Vi}
5862 Quoting character(s), put around the command passed to the shell, for
5863 the "!" and ":!" commands. The redirection is kept outside of the
5864 quoting. See 'shellxquote' to include the redirection. It's
5865 probably not useful to set both options.
5866 This is an empty string by default. Only known to be useful for
5867 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5868 or bash, where it should be "\"". The default is adjusted according
5869 the value of 'shell', to reduce the need to set this option by the
5870 user. See |dos-shell|.
5871 This option cannot be set from a |modeline| or in the |sandbox|, for
5872 security reasons.
5873
5874 *'shellredir'* *'srr'*
5875'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5876 global
5877 {not in Vi}
5878 String to be used to put the output of a filter command in a temporary
5879 file. See also |:!|. See |option-backslash| about including spaces
5880 and backslashes.
5881 The name of the temporary file can be represented by "%s" if necessary
5882 (the file name is appended automatically if no %s appears in the value
5883 of this option).
5884 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5885 or "zsh" during initializations, the default becomes ">&". If the
5886 'shell' option is "sh", "ksh" or "bash" the default becomes
5887 ">%s 2>&1". This means that stderr is also included.
5888 For Win32, the Unix checks are done and additionally "cmd" is checked
5889 for, which makes the default ">%s 2>&1". Also, the same names with
5890 ".exe" appended are checked for.
5891 The initialization of this option is done after reading the ".vimrc"
5892 and the other initializations, so that when the 'shell' option is set
5893 there, the 'shellredir' option changes automatically unless it was
5894 explicitly set before.
5895 In the future pipes may be used for filtering and this option will
5896 become obsolete (at least for Unix).
5897 This option cannot be set from a |modeline| or in the |sandbox|, for
5898 security reasons.
5899
5900 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5901'shellslash' 'ssl' boolean (default off)
5902 global
5903 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5904 When set, a forward slash is used when expanding file names. This is
5905 useful when a Unix-like shell is used instead of command.com or
5906 cmd.exe. Backward slashes can still be typed, but they are changed to
5907 forward slashes by Vim.
5908 Note that setting or resetting this option has no effect for some
5909 existing file names, thus this option needs to be set before opening
5910 any file for best results. This might change in the future.
5911 'shellslash' only works when a backslash can be used as a path
5912 separator. To test if this is so use: >
5913 if exists('+shellslash')
5914<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005915 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5916'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5917 global
5918 {not in Vi}
5919 When on, use temp files for shell commands. When off use a pipe.
5920 When using a pipe is not possible temp files are used anyway.
5921 Currently a pipe is only supported on Unix. You can check it with: >
5922 :if has("filterpipe")
5923< The advantage of using a pipe is that nobody can read the temp file
5924 and the 'shell' command does not need to support redirection.
5925 The advantage of using a temp file is that the file type and encoding
5926 can be detected.
5927 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5928 |FilterWritePost| autocommands event are not triggered when
5929 'shelltemp' is off.
5930
Bram Moolenaar071d4272004-06-13 20:20:40 +00005931 *'shelltype'* *'st'*
5932'shelltype' 'st' number (default 0)
5933 global
5934 {not in Vi} {only for the Amiga}
5935 On the Amiga this option influences the way how the commands work
5936 which use a shell.
5937 0 and 1: always use the shell
5938 2 and 3: use the shell only to filter lines
5939 4 and 5: use shell only for ':sh' command
5940 When not using the shell, the command is executed directly.
5941
5942 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5943 1 and 3: use "shell cmd" to start external commands
5944
5945 *'shellxquote'* *'sxq'*
5946'shellxquote' 'sxq' string (default: "";
5947 for Win32, when 'shell' contains "sh"
5948 somewhere: "\""
5949 for Unix, when using system(): "\"")
5950 global
5951 {not in Vi}
5952 Quoting character(s), put around the command passed to the shell, for
5953 the "!" and ":!" commands. Includes the redirection. See
5954 'shellquote' to exclude the redirection. It's probably not useful
5955 to set both options.
5956 This is an empty string by default. Known to be useful for
5957 third-party shells when using the Win32 version, such as the MKS Korn
5958 Shell or bash, where it should be "\"". The default is adjusted
5959 according the value of 'shell', to reduce the need to set this option
5960 by the user. See |dos-shell|.
5961 This option cannot be set from a |modeline| or in the |sandbox|, for
5962 security reasons.
5963
5964 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5965'shiftround' 'sr' boolean (default off)
5966 global
5967 {not in Vi}
5968 Round indent to multiple of 'shiftwidth'. Applies to > and <
5969 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5970 a multiple of 'shiftwidth' (this is Vi compatible).
5971 NOTE: This option is reset when 'compatible' is set.
5972
5973 *'shiftwidth'* *'sw'*
5974'shiftwidth' 'sw' number (default 8)
5975 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005976 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005977 |'cindent'|, |>>|, |<<|, etc.
5978
5979 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005980'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5981 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005982 global
5983 {not in Vi}
5984 This option helps to avoid all the |hit-enter| prompts caused by file
5985 messages, for example with CTRL-G, and to avoid some other messages.
5986 It is a list of flags:
5987 flag meaning when present ~
5988 f use "(3 of 5)" instead of "(file 3 of 5)"
5989 i use "[noeol]" instead of "[Incomplete last line]"
5990 l use "999L, 888C" instead of "999 lines, 888 characters"
5991 m use "[+]" instead of "[Modified]"
5992 n use "[New]" instead of "[New File]"
5993 r use "[RO]" instead of "[readonly]"
5994 w use "[w]" instead of "written" for file write message
5995 and "[a]" instead of "appended" for ':w >> file' command
5996 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5997 "[unix format]" and "[mac]" instead of "[mac format]".
5998 a all of the above abbreviations
5999
6000 o overwrite message for writing a file with subsequent message
6001 for reading a file (useful for ":wn" or when 'autowrite' on)
6002 O message for reading a file overwrites any previous message.
6003 Also for quickfix message (e.g., ":cn").
6004 s don't give "search hit BOTTOM, continuing at TOP" or "search
6005 hit TOP, continuing at BOTTOM" messages
6006 t truncate file message at the start if it is too long to fit
6007 on the command-line, "<" will appear in the left most column.
6008 Ignored in Ex mode.
6009 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006010 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011 Ignored in Ex mode.
6012 W don't give "written" or "[w]" when writing a file
6013 A don't give the "ATTENTION" message when an existing swap file
6014 is found.
6015 I don't give the intro message when starting Vim |:intro|.
6016
6017 This gives you the opportunity to avoid that a change between buffers
6018 requires you to hit <Enter>, but still gives as useful a message as
6019 possible for the space available. To get the whole message that you
6020 would have got with 'shm' empty, use ":file!"
6021 Useful values:
6022 shm= No abbreviation of message.
6023 shm=a Abbreviation, but no loss of information.
6024 shm=at Abbreviation, and truncate message when necessary.
6025
6026 NOTE: This option is set to the Vi default value when 'compatible' is
6027 set and to the Vim default value when 'compatible' is reset.
6028
6029 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6030'shortname' 'sn' boolean (default off)
6031 local to buffer
6032 {not in Vi, not in MS-DOS versions}
6033 Filenames are assumed to be 8 characters plus one extension of 3
6034 characters. Multiple dots in file names are not allowed. When this
6035 option is on, dots in file names are replaced with underscores when
6036 adding an extension (".~" or ".swp"). This option is not available
6037 for MS-DOS, because then it would always be on. This option is useful
6038 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6039 or crossdos. When running the Win32 GUI version under Win32s, this
6040 option is always on by default.
6041
6042 *'showbreak'* *'sbr'* *E595*
6043'showbreak' 'sbr' string (default "")
6044 global
6045 {not in Vi}
6046 {not available when compiled without the |+linebreak|
6047 feature}
6048 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006049 values are "> " or "+++ ": >
6050 :set showbreak=>\
6051< Note the backslash to escape the trailing space. It's easier like
6052 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006053 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006054< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055 comma (in a future version the comma might be used to separate the
6056 part that is shown at the end and at the start of a line).
6057 The characters are highlighted according to the '@' flag in
6058 'highlight'.
6059 Note that tabs after the showbreak will be displayed differently.
6060 If you want the 'showbreak' to appear in between line numbers, add the
6061 "n" flag to 'cpoptions'.
6062
6063 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6064'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6065 off)
6066 global
6067 {not in Vi}
6068 {not available when compiled without the
6069 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006070 Show (partial) command in the last line of the screen. Set this
6071 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006072 In Visual mode the size of the selected area is shown:
6073 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006074 If the number of bytes is different it is also displayed: "2-6"
6075 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006076 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006077 - When selecting a block, the size in screen characters:
6078 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006079 NOTE: This option is set to the Vi default value when 'compatible' is
6080 set and to the Vim default value when 'compatible' is reset.
6081
6082 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6083'showfulltag' 'sft' boolean (default off)
6084 global
6085 {not in Vi}
6086 When completing a word in insert mode (see |ins-completion|) from the
6087 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006088 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089 matched a C function, you can see a template for what arguments are
6090 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006091 Note that this doesn't work well together with having "longest" in
6092 'completeopt', because the completion from the search pattern may not
6093 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094
6095 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6096'showmatch' 'sm' boolean (default off)
6097 global
6098 When a bracket is inserted, briefly jump to the matching one. The
6099 jump is only done if the match can be seen on the screen. The time to
6100 show the match can be set with 'matchtime'.
6101 A Beep is given if there is no match (no matter if the match can be
6102 seen or not). This option is reset when the 'paste' option is set.
6103 When the 'm' flag is not included in 'cpoptions', typing a character
6104 will immediately move the cursor back to where it belongs.
6105 See the "sm" field in 'guicursor' for setting the cursor shape and
6106 blinking when showing the match.
6107 The 'matchpairs' option can be used to specify the characters to show
6108 matches for. 'rightleft' and 'revins' are used to look for opposite
6109 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006110 Also see the matchparen plugin for highlighting the match when moving
6111 around |pi_paren.txt|.
6112 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006113
6114 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6115'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6116 global
6117 If in Insert, Replace or Visual mode put a message on the last line.
6118 Use the 'M' flag in 'highlight' to set the type of highlighting for
6119 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006120 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 doesn't mean XIM is really active, especially when 'imactivatekey' is
6122 not set.
6123 NOTE: This option is set to the Vi default value when 'compatible' is
6124 set and to the Vim default value when 'compatible' is reset.
6125
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006126 *'showtabline'* *'stal'*
6127'showtabline' 'stal' number (default 1)
6128 global
6129 {not in Vi}
6130 {not available when compiled without the +windows
6131 feature}
6132 The value of this option specifies when the line with tab page labels
6133 will be displayed:
6134 0: never
6135 1: only if there are at least two tab pages
6136 2: always
6137 This is both for the GUI and non-GUI implementation of the tab pages
6138 line.
6139 See |tab-page| for more information about tab pages.
6140
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 *'sidescroll'* *'ss'*
6142'sidescroll' 'ss' number (default 0)
6143 global
6144 {not in Vi}
6145 The minimal number of columns to scroll horizontally. Used only when
6146 the 'wrap' option is off and the cursor is moved off of the screen.
6147 When it is zero the cursor will be put in the middle of the screen.
6148 When using a slow terminal set it to a large number or 0. When using
6149 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6150 commands.
6151
6152 *'sidescrolloff'* *'siso'*
6153'sidescrolloff' 'siso' number (default 0)
6154 global
6155 {not in Vi}
6156 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006157 right of the cursor if 'nowrap' is set. Setting this option to a
6158 value greater than 0 while having |'sidescroll'| also at a non-zero
6159 value makes some context visible in the line you are scrolling in
6160 horizontally (except at beginning of the line). Setting this option
6161 to a large value (like 999) has the effect of keeping the cursor
6162 horizontally centered in the window, as long as one does not come too
6163 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164 NOTE: This option is set to 0 when 'compatible' is set.
6165
6166 Example: Try this together with 'sidescroll' and 'listchars' as
6167 in the following example to never allow the cursor to move
6168 onto the "extends" character:
6169
6170 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6171 :set sidescrolloff=1
6172
6173
6174 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6175'smartcase' 'scs' boolean (default off)
6176 global
6177 {not in Vi}
6178 Override the 'ignorecase' option if the search pattern contains upper
6179 case characters. Only used when the search pattern is typed and
6180 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006181 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6183 recalling the search pattern from history and hitting <Enter>.
6184 NOTE: This option is reset when 'compatible' is set.
6185
6186 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6187'smartindent' 'si' boolean (default off)
6188 local to buffer
6189 {not in Vi}
6190 {not available when compiled without the
6191 |+smartindent| feature}
6192 Do smart autoindenting when starting a new line. Works for C-like
6193 programs, but can also be used for other languages. 'cindent' does
6194 something like this, works better in most cases, but is more strict,
6195 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6196 'indentexpr' is a more advanced alternative.
6197 Normally 'autoindent' should also be on when using 'smartindent'.
6198 An indent is automatically inserted:
6199 - After a line ending in '{'.
6200 - After a line starting with a keyword from 'cinwords'.
6201 - Before a line starting with '}' (only with the "O" command).
6202 When typing '}' as the first character in a new line, that line is
6203 given the same indent as the matching '{'.
6204 When typing '#' as the first character in a new line, the indent for
6205 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006206 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006207 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6208 When using the ">>" command, lines starting with '#' are not shifted
6209 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006210 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211 is set smart indenting is disabled.
6212
6213 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6214'smarttab' 'sta' boolean (default off)
6215 global
6216 {not in Vi}
6217 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006218 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6219 <BS> will delete a 'shiftwidth' worth of space at the start of the
6220 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006221 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006222 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6223 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006224 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006226 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227 NOTE: This option is reset when 'compatible' is set.
6228
6229 *'softtabstop'* *'sts'*
6230'softtabstop' 'sts' number (default 0)
6231 local to buffer
6232 {not in Vi}
6233 Number of spaces that a <Tab> counts for while performing editing
6234 operations, like inserting a <Tab> or using <BS>. It "feels" like
6235 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6236 used. This is useful to keep the 'ts' setting at its standard value
6237 of 8, while being able to edit like it is set to 'sts'. However,
6238 commands like "x" still work on the actual characters.
6239 When 'sts' is zero, this feature is off.
6240 'softtabstop' is set to 0 when the 'paste' option is set.
6241 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6242 spaces is minimized by using <Tab>s.
6243 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6244 set.
6245 NOTE: This option is set to 0 when 'compatible' is set.
6246
Bram Moolenaar217ad922005-03-20 22:37:15 +00006247 *'spell'* *'nospell'*
6248'spell' boolean (default off)
6249 local to window
6250 {not in Vi}
6251 {not available when compiled without the |+syntax|
6252 feature}
6253 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006254 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006255
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006256 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006257'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006258 local to buffer
6259 {not in Vi}
6260 {not available when compiled without the |+syntax|
6261 feature}
6262 Pattern to locate the end of a sentence. The following word will be
6263 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006264 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006265 When this check is not wanted make this option empty.
6266 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006267 Be careful with special characters, see |option-backslash| about
6268 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006269 To set this option automatically depending on the language, see
6270 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006271
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006272 *'spellfile'* *'spf'*
6273'spellfile' 'spf' string (default empty)
6274 local to buffer
6275 {not in Vi}
6276 {not available when compiled without the |+syntax|
6277 feature}
6278 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006279 commands. It must end in ".{encoding}.add". You need to include the
6280 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006281 *E765*
6282 It may also be a comma separated list of names. A count before the
6283 |zg| and |zw| commands can be used to access each. This allows using
6284 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006285 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006286 you: Using the first directory in 'runtimepath' that is writable. If
6287 there is no "spell" directory yet it will be created. For the file
6288 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006289 ignoring the region.
6290 The resulting ".spl" file will be used for spell checking, it does not
6291 have to appear in 'spelllang'.
6292 Normally one file is used for all regions, but you can add the region
6293 name if you want to. However, it will then only be used when
6294 'spellfile' is set to it, for entries in 'spelllang' only files
6295 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006296 This option cannot be set from a |modeline| or in the |sandbox|, for
6297 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006298
Bram Moolenaar217ad922005-03-20 22:37:15 +00006299 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006300'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006301 local to buffer
6302 {not in Vi}
6303 {not available when compiled without the |+syntax|
6304 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006305 A comma separated list of word list names. When the 'spell' option is
6306 on spellchecking will be done for these languages. Example: >
6307 set spelllang=en_us,nl,medical
6308< This means US English, Dutch and medical words are recognized. Words
6309 that are not recognized will be highlighted.
6310 The word list name must not include a comma or dot. Using a dash is
6311 recommended to separate the two letter language name from a
6312 specification. Thus "en-rare" is used for rare English words.
6313 A region name must come last and have the form "_xx", where "xx" is
6314 the two-letter, lower case region name. You can use more than one
6315 region by listing them: "en_us,en_ca" supports both US and Canadian
6316 English, but not words specific for Australia, New Zealand or Great
6317 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006318 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006319 As a special case the name of a .spl file can be given as-is. The
6320 first "_xx" in the name is removed and used as the region name
6321 (_xx is an underscore, two letters and followed by a non-letter).
6322 This is mainly for testing purposes. You must make sure the correct
6323 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006324 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006325 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6326 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006327 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006328
Bram Moolenaar98692072006-02-04 00:57:42 +00006329 If the |spellfile.vim| plugin is active and you use a language name
6330 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6331 will ask you if you want to download the file.
6332
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006333 After this option has been set successfully, Vim will source the files
6334 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006335 up to the first comma, dot or underscore.
6336 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006337
6338
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006339 *'spellsuggest'* *'sps'*
6340'spellsuggest' 'sps' string (default "best")
6341 global
6342 {not in Vi}
6343 {not available when compiled without the |+syntax|
6344 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006345 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006346 the |spellsuggest()| function. This is a comma-separated list of
6347 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006348
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006349 best Internal method that works best for English. Finds
6350 changes like "fast" and uses a bit of sound-a-like
6351 scoring to improve the ordering.
6352
6353 double Internal method that uses two methods and mixes the
6354 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006355 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006356 word. That only works when the language specifies
6357 sound folding. Can be slow and doesn't always give
6358 better results.
6359
6360 fast Internal method that only checks for simple changes:
6361 character inserts/deletes/swaps. Works well for
6362 simple typing mistakes.
6363
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006364 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006365 Not used for |spellsuggest()|. The number of
6366 suggestions is never more than the value of 'lines'
6367 minus two.
6368
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006369 file:{filename} Read file {filename}, which must have two columns,
6370 separated by a slash. The first column contains the
6371 bad word, the second column the suggested good word.
6372 Example:
6373 theribal/terrible ~
6374 Use this for common mistakes that do not appear at the
6375 top of the suggestion list with the internal methods.
6376 Lines without a slash are ignored, use this for
6377 comments.
6378 The file is used for all languages.
6379
6380 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6381 trouble with spaces. |v:val| holds the badly spelled
6382 word. The expression must evaluate to a List of
6383 Lists, each with a suggestion and a score.
6384 Example:
6385 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006386 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006387 internal methods use. A lower score is better.
6388 This may invoke |spellsuggest()| if you temporarily
6389 set 'spellsuggest' to exclude the "expr:" part.
6390 Errors are silently ignored, unless you set the
6391 'verbose' option to a non-zero value.
6392
6393 Only one of "best", "double" or "fast" may be used. The others may
6394 appear several times in any order. Example: >
6395 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6396<
6397 This option cannot be set from a |modeline| or in the |sandbox|, for
6398 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006399
6400
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6402'splitbelow' 'sb' boolean (default off)
6403 global
6404 {not in Vi}
6405 {not available when compiled without the +windows
6406 feature}
6407 When on, splitting a window will put the new window below the current
6408 one. |:split|
6409
6410 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6411'splitright' 'spr' boolean (default off)
6412 global
6413 {not in Vi}
6414 {not available when compiled without the +vertsplit
6415 feature}
6416 When on, splitting a window will put the new window right of the
6417 current one. |:vsplit|
6418
6419 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6420'startofline' 'sol' boolean (default on)
6421 global
6422 {not in Vi}
6423 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006424 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006425 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006426 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 with a linewise operator, with "%" with a count and to buffer changing
6428 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6429 only has a line number, e.g., ":25" or ":+".
6430 In case of buffer changing commands the cursor is placed at the column
6431 where it was the last time the buffer was edited.
6432 NOTE: This option is set when 'compatible' is set.
6433
6434 *'statusline'* *'stl'* *E540* *E541* *E542*
6435'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006436 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 {not in Vi}
6438 {not available when compiled without the |+statusline|
6439 feature}
6440 When nonempty, this option determines the content of the status line.
6441 Also see |status-line|.
6442
6443 The option consists of printf style '%' items interspersed with
6444 normal text. Each status line item is of the form:
6445 %-0{minwid}.{maxwid}{item}
6446 All fields except the {item} is optional. A single percent sign can
6447 be given as "%%". Up to 80 items can be specified.
6448
Bram Moolenaar238a5642006-02-21 22:12:05 +00006449 When the option starts with "%!" then it is used as an expression,
6450 evaluated and the result is used as the option value. Example: >
6451 :set statusline=%!MyStatusLine()
6452< The result can contain %{} items that will be evaluated too.
6453
6454 When there is error while evaluating the option then it will be made
6455 empty to avoid further errors. Otherwise screen updating would loop.
6456
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457 Note that the only effect of 'ruler' when this option is set (and
6458 'laststatus' is 2) is controlling the output of |CTRL-G|.
6459
6460 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006461 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006463 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464 minwid Minimum width of the item, padding as set by '-' & '0'.
6465 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006466 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 on the left for text items. Numeric items will be
6468 shifted down to maxwid-2 digits followed by '>'number
6469 where number is the amount of missing digits, much like
6470 an exponential notation.
6471 item A one letter code as described below.
6472
6473 Following is a description of the possible statusline items. The
6474 second character in "item" is the type:
6475 N for number
6476 S for string
6477 F for flags as described below
6478 - not applicable
6479
6480 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006481 f S Path to the file in the buffer, as typed or relative to current
6482 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483 F S Full path to the file in the buffer.
6484 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006485 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006487 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006489 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006491 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006493 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6495 {not available when compiled without |+autocmd| feature}
6496 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6497 being used: "<keymap>"
6498 n N Buffer number.
6499 b N Value of byte under cursor.
6500 B N As above, in hexadecimal.
6501 o N Byte number in file of byte under cursor, first byte is 1.
6502 Mnemonic: Offset from start of file (with one added)
6503 {not available when compiled without |+byte_offset| feature}
6504 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006505 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 l N Line number.
6507 L N Number of lines in buffer.
6508 c N Column number.
6509 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006510 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511 p N Percentage through file in lines as in |CTRL-G|.
6512 P S Percentage through file of displayed window. This is like the
6513 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006514 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006516 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006517 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 ( - Start of item group. Can be used for setting the width and
6519 alignment of a section. Must be followed by %) somewhere.
6520 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006521 T N For 'tabline': start of tab page N label. Use %T after the last
6522 label. This information is used for mouse clicks.
6523 X N For 'tabline': start of close tab N label. Use %X after the
6524 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6525 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 < - Where to truncate line if too long. Default is at the start.
6527 No width fields allowed.
6528 = - Separation point between left and right aligned items.
6529 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006530 # - Set highlight group. The name must follow and then a # again.
6531 Thus use %#HLname# for highlight group HLname. The same
6532 highlighting is used, also for the statusline of non-current
6533 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006534 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006535 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 The difference between User{N} and StatusLine will be applied
6537 to StatusLineNC for the statusline of non-current windows.
6538 The number N must be between 1 and 9. See |hl-User1..9|
6539
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006540 When displaying a flag, Vim removes the leading comma, if any, when
6541 that flag comes right after plaintext. This will make a nice display
6542 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543
Bram Moolenaar582fd852005-03-28 20:58:01 +00006544 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545 not set) and a minwid is not set for the group, the whole group will
6546 become empty. This will make a group like the following disappear
6547 completely from the statusline when none of the flags are set. >
6548 :set statusline=...%(\ [%M%R%H]%)...
6549<
6550 Beware that an expression is evaluated each and every time the status
6551 line is displayed. The current buffer and current window will be set
6552 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006553 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006555 real current buffer.
6556
6557 The 'statusline' option may be evaluated in the |sandbox|, see
6558 |sandbox-option|.
6559
6560 It is not allowed to change text or jump to another window while
6561 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562
6563 If the statusline is not updated when you want it (e.g., after setting
6564 a variable that's used in an expression), you can force an update by
6565 setting an option without changing its value. Example: >
6566 :let &ro = &ro
6567
6568< A result of all digits is regarded a number for display purposes.
6569 Otherwise the result is taken as flag text and applied to the rules
6570 described above.
6571
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006572 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6574 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6575
6576 Examples:
6577 Emulate standard status line with 'ruler' set >
6578 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6579< Similar, but add ASCII value of char under the cursor (like "ga") >
6580 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6581< Display byte count and byte value, modified flag in red. >
6582 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6583 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6584< Display a ,GZ flag if a compressed file is loaded >
6585 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6586< In the |:autocmd|'s: >
6587 :let b:gzflag = 1
6588< And: >
6589 :unlet b:gzflag
6590< And define this function: >
6591 :function VarExists(var, val)
6592 : if exists(a:var) | return a:val | else | return '' | endif
6593 :endfunction
6594<
6595 *'suffixes'* *'su'*
6596'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6597 global
6598 {not in Vi}
6599 Files with these suffixes get a lower priority when multiple files
6600 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006601 suffixes. Spaces after the comma are ignored. A dot is also seen as
6602 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 separator, precede it with a backslash (see |option-backslash| about
6604 including spaces and backslashes).
6605 See 'wildignore' for completely ignoring files.
6606 The use of |:set+=| and |:set-=| is preferred when adding or removing
6607 suffixes from the list. This avoids problems when a future version
6608 uses another default.
6609
6610 *'suffixesadd'* *'sua'*
6611'suffixesadd' 'sua' string (default "")
6612 local to buffer
6613 {not in Vi}
6614 {not available when compiled without the
6615 |+file_in_path| feature}
6616 Comma separated list of suffixes, which are used when searching for a
6617 file for the "gf", "[I", etc. commands. Example: >
6618 :set suffixesadd=.java
6619<
6620 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6621'swapfile' 'swf' boolean (default on)
6622 local to buffer
6623 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006624 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006625 swapfile is not wanted for a specific buffer. For example, with
6626 confidential information that even root must not be able to access.
6627 Careful: All text will be in memory:
6628 - Don't use this for big files.
6629 - Recovery will be impossible!
6630 A swapfile will only be present when |'updatecount'| is non-zero and
6631 'swapfile' is set.
6632 When 'swapfile' is reset, the swap file for the current buffer is
6633 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6634 non-zero, a swap file is immediately created.
6635 Also see |swap-file| and |'swapsync'|.
6636
6637 This option is used together with 'bufhidden' and 'buftype' to
6638 specify special kinds of buffers. See |special-buffers|.
6639
6640 *'swapsync'* *'sws'*
6641'swapsync' 'sws' string (default "fsync")
6642 global
6643 {not in Vi}
6644 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006645 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006646 When this option is empty parts of the swap file may be in memory and
6647 not written to disk. When the system crashes you may lose more work.
6648 On Unix the system does a sync now and then without Vim asking for it,
6649 so the disadvantage of setting this option off is small. On some
6650 systems the swap file will not be written at all. For a unix system
6651 setting it to "sync" will use the sync() call instead of the default
6652 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006653 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654
6655 *'switchbuf'* *'swb'*
6656'switchbuf' 'swb' string (default "")
6657 global
6658 {not in Vi}
6659 This option controls the behavior when switching between buffers.
6660 Possible values (comma separated list):
6661 useopen If included, jump to the first open window that
6662 contains the specified buffer (if there is one).
6663 Otherwise: Do not examine other windows.
6664 This setting is checked with |quickfix| commands, when
6665 jumping to errors (":cc", ":cn", "cp", etc.). It is
6666 also used in all buffer related split commands, for
6667 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006668 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006669 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006671 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006673 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006674 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006676 *'synmaxcol'* *'smc'*
6677'synmaxcol' 'smc' number (default 3000)
6678 local to buffer
6679 {not in Vi}
6680 {not available when compiled without the |+syntax|
6681 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006682 Maximum column in which to search for syntax items. In long lines the
6683 text after this column is not highlighted and following lines may not
6684 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006685 This helps to avoid very slow redrawing for an XML file that is one
6686 long line.
6687 Set to zero to remove the limit.
6688
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 *'syntax'* *'syn'*
6690'syntax' 'syn' string (default empty)
6691 local to buffer
6692 {not in Vi}
6693 {not available when compiled without the |+syntax|
6694 feature}
6695 When this option is set, the syntax with this name is loaded, unless
6696 syntax highlighting has been switched off with ":syntax off".
6697 Otherwise this option does not always reflect the current syntax (the
6698 b:current_syntax variable does).
6699 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006700 not automatically recognized. Example, in an IDL file:
6701 /* vim: set syntax=idl : */ ~
6702 When a dot appears in the value then this separates two filetype
6703 names. Example:
6704 /* vim: set syntax=c.doxygen : */ ~
6705 This will use the "c" syntax first, then the "doxygen" syntax.
6706 Note that the second one must be prepared to be loaded as an addition,
6707 otherwise it will be skipped. More than one dot may appear.
6708 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 :set syntax=OFF
6710< To switch syntax highlighting on according to the current value of the
6711 'filetype' option: >
6712 :set syntax=ON
6713< What actually happens when setting the 'syntax' option is that the
6714 Syntax autocommand event is triggered with the value as argument.
6715 This option is not copied to another buffer, independent of the 's' or
6716 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006717 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006719 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006720'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006721 global
6722 {not in Vi}
6723 {not available when compiled without the +windows
6724 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006725 When nonempty, this option determines the content of the tab pages
6726 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006727 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006728
6729 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006730 option and only when there is no GUI tab line. When 'e' is in
6731 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6732 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006733
6734 The value is evaluated like with 'statusline'. You can use
6735 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006736 the text to be displayed. Use "%1T" for the first label, "%2T" for
6737 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006738
6739 Keep in mind that only one of the tab pages is the current one, others
6740 are invisible and you can't jump to their windows.
6741
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006742
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006743 *'tabpagemax'* *'tpm'*
6744'tabpagemax' 'tpm' number (default 10)
6745 global
6746 {not in Vi}
6747 {not available when compiled without the +windows
6748 feature}
6749 Maximum number of tab pages to be opened by the |-p| command line
6750 argument or the ":tab all" command. |tabpage|
6751
6752
6753 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754'tabstop' 'ts' number (default 8)
6755 local to buffer
6756 Number of spaces that a <Tab> in the file counts for. Also see
6757 |:retab| command, and 'softtabstop' option.
6758
6759 Note: Setting 'tabstop' to any other value than 8 can make your file
6760 appear wrong in many places (e.g., when printing it).
6761
6762 There are four main ways to use tabs in Vim:
6763 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6764 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006765 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766 behave like a tab appears every 4 (or 3) characters.
6767 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6768 'expandtab'. This way you will always insert spaces. The
6769 formatting will never be messed up when 'tabstop' is changed.
6770 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006771 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 works when using Vim to edit the file.
6773 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6774 'noexpandtab'. This should then work (for initial indents only)
6775 for any tabstop setting that people use. It might be nice to have
6776 tabs after the first non-blank inserted as spaces if you do this
6777 though. Otherwise aligned comments will be wrong when 'tabstop' is
6778 changed.
6779
6780 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6781'tagbsearch' 'tbs' boolean (default on)
6782 global
6783 {not in Vi}
6784 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006785 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 searching makes searching for a tag a LOT faster, but a linear search
6787 will find more tags if the tags file wasn't properly sorted.
6788 Vim normally assumes that your tags files are sorted, or indicate that
6789 they are not sorted. Only when this is not the case does the
6790 'tagbsearch' option need to be switched off.
6791
6792 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006793 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 certain files, or retry all files with a linear search. When
6795 'tagbsearch' is off, only a linear search is done.
6796
6797 Linear searching is done anyway, for one file, when Vim finds a line
6798 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006799 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800< [The whitespace before and after the '0' must be a single <Tab>]
6801
6802 When a binary search was done and no match was found in any of the
6803 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6804 instead of a normal tag name, a retry is done with a linear search.
6805 Tags in unsorted tags files, and matches with different case will only
6806 be found in the retry.
6807
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006808 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 linear search can be avoided for the 'ignorecase' case. Use a value
6810 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6811 case-fold sorted with the -f switch to "sort" in most unices, as in
6812 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006813 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6814 for this as well. Note that case must be folded to uppercase for this
6815 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816
6817 When 'tagbsearch' is off, tags searching is slower when a full match
6818 exists, but faster when no full match exists. Tags in unsorted tags
6819 files may only be found with 'tagbsearch' off.
6820 When the tags file is not sorted, or sorted in a wrong way (not on
6821 ASCII byte value), 'tagbsearch' should be off, or the line given above
6822 must be included in the tags file.
6823 This option doesn't affect commands that find all matching tags (e.g.,
6824 command-line completion and ":help").
6825 {Vi: always uses binary search in some versions}
6826
6827 *'taglength'* *'tl'*
6828'taglength' 'tl' number (default 0)
6829 global
6830 If non-zero, tags are significant up to this number of characters.
6831
6832 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6833'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6834 global
6835 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006836 If on and using a tags file in another directory, file names in that
6837 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 NOTE: This option is set to the Vi default value when 'compatible' is
6839 set and to the Vim default value when 'compatible' is reset.
6840
6841 *'tags'* *'tag'* *E433*
6842'tags' 'tag' string (default "./tags,tags", when compiled with
6843 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6844 global or local to buffer |global-local|
6845 Filenames for the tag command, separated by spaces or commas. To
6846 include a space or comma in a file name, precede it with a backslash
6847 (see |option-backslash| about including spaces and backslashes).
6848 When a file name starts with "./", the '.' is replaced with the path
6849 of the current file. But only when the 'd' flag is not included in
6850 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6851 |tags-option|.
6852 "*", "**" and other wildcards can be used to search for tags files in
6853 a directory tree. See |file-searching|. {not available when compiled
6854 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006855 The |tagfiles()| function can be used to get a list of the file names
6856 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006857 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6858 files are also supported. They are automatically recognized. The
6859 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6860 differences are ignored (MS-Windows). |emacs-tags|
6861 The use of |:set+=| and |:set-=| is preferred when adding or removing
6862 file names from the list. This avoids problems when a future version
6863 uses another default.
6864 {Vi: default is "tags /usr/lib/tags"}
6865
6866 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6867'tagstack' 'tgst' boolean (default on)
6868 global
6869 {not in all versions of Vi}
6870 When on, the |tagstack| is used normally. When off, a ":tag" or
6871 ":tselect" command with an argument will not push the tag onto the
6872 tagstack. A following ":tag" without an argument, a ":pop" command or
6873 any other command that uses the tagstack will use the unmodified
6874 tagstack, but does change the pointer to the active entry.
6875 Resetting this option is useful when using a ":tag" command in a
6876 mapping which should not change the tagstack.
6877
6878 *'term'* *E529* *E530* *E531*
6879'term' string (default is $TERM, if that fails:
6880 in the GUI: "builtin_gui"
6881 on Amiga: "amiga"
6882 on BeOS: "beos-ansi"
6883 on Mac: "mac-ansi"
6884 on MiNT: "vt52"
6885 on MS-DOS: "pcterm"
6886 on OS/2: "os2ansi"
6887 on Unix: "ansi"
6888 on VMS: "ansi"
6889 on Win 32: "win32")
6890 global
6891 Name of the terminal. Used for choosing the terminal control
6892 characters. Environment variables are expanded |:set_env|.
6893 For example: >
6894 :set term=$TERM
6895< See |termcap|.
6896
6897 *'termbidi'* *'tbidi'*
6898 *'notermbidi'* *'notbidi'*
6899'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6900 global
6901 {not in Vi}
6902 {only available when compiled with the |+arabic|
6903 feature}
6904 The terminal is in charge of Bi-directionality of text (as specified
6905 by Unicode). The terminal is also expected to do the required shaping
6906 that some languages (such as Arabic) require.
6907 Setting this option implies that 'rightleft' will not be set when
6908 'arabic' is set and the value of 'arabicshape' will be ignored.
6909 Note that setting 'termbidi' has the immediate effect that
6910 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6911 This option is reset when the GUI is started.
6912 For further details see |arabic.txt|.
6913
6914 *'termencoding'* *'tenc'*
6915'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6916 Macintosh GUI: "macroman")
6917 global
6918 {only available when compiled with the |+multi_byte|
6919 feature}
6920 {not in Vi}
6921 Encoding used for the terminal. This specifies what character
6922 encoding the keyboard produces and the display will understand. For
6923 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006924 display). Except for the Mac when 'macatsui' is off, then
6925 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926 In the Win32 console version the default value is the console codepage
6927 when it differs from the ANSI codepage.
6928 *E617*
6929 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6930 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6931 Any attempts to set a different value will be rejected, and an error
6932 message is shown.
6933 For the Win32 GUI 'termencoding' is not used for typed characters,
6934 because the Win32 system always passes Unicode characters.
6935 When empty, the same encoding is used as for the 'encoding' option.
6936 This is the normal value.
6937 Not all combinations for 'termencoding' and 'encoding' are valid. See
6938 |encoding-table|.
6939 The value for this option must be supported by internal conversions or
6940 iconv(). When this is not possible no conversion will be done and you
6941 will probably experience problems with non-ASCII characters.
6942 Example: You are working with the locale set to euc-jp (Japanese) and
6943 want to edit a UTF-8 file: >
6944 :let &termencoding = &encoding
6945 :set encoding=utf-8
6946< You need to do this when your system has no locale support for UTF-8.
6947
6948 *'terse'* *'noterse'*
6949'terse' boolean (default off)
6950 global
6951 When set: Add 's' flag to 'shortmess' option (this makes the message
6952 for a search that hits the start or end of the file not being
6953 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6954 shortens a lot of messages}
6955
6956 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6957'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6958 global
6959 {not in Vi}
6960 This option is obsolete. Use 'fileformats'.
6961 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6962 set to the default value for the current system. When 'textauto' is
6963 reset, 'fileformats' is made empty.
6964 NOTE: This option is set to the Vi default value when 'compatible' is
6965 set and to the Vim default value when 'compatible' is reset.
6966
6967 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6968'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6969 others: default off)
6970 local to buffer
6971 {not in Vi}
6972 This option is obsolete. Use 'fileformat'.
6973 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6974 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6975 "unix".
6976
6977 *'textwidth'* *'tw'*
6978'textwidth' 'tw' number (default 0)
6979 local to buffer
6980 {not in Vi}
6981 Maximum width of text that is being inserted. A longer line will be
6982 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006983 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6984 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00006986 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987 NOTE: This option is set to 0 when 'compatible' is set.
6988
6989 *'thesaurus'* *'tsr'*
6990'thesaurus' 'tsr' string (default "")
6991 global or local to buffer |global-local|
6992 {not in Vi}
6993 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006994 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006995 the file should contain words with similar meaning, separated by
6996 non-keyword characters (white space is preferred). Maximum line
6997 length is 510 bytes.
6998 To obtain a file to be used here, check out the wordlist FAQ at
6999 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007000 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001 after a comma are ignored, otherwise spaces are included in the file
7002 name. See |option-backslash| about using backslashes.
7003 The use of |:set+=| and |:set-=| is preferred when adding or removing
7004 directories from the list. This avoids problems when a future version
7005 uses another default.
7006 Backticks cannot be used in this option for security reasons.
7007
7008 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7009'tildeop' 'top' boolean (default off)
7010 global
7011 {not in Vi}
7012 When on: The tilde command "~" behaves like an operator.
7013 NOTE: This option is reset when 'compatible' is set.
7014
7015 *'timeout'* *'to'* *'notimeout'* *'noto'*
7016'timeout' 'to' boolean (default on)
7017 global
7018 *'ttimeout'* *'nottimeout'*
7019'ttimeout' boolean (default off)
7020 global
7021 {not in Vi}
7022 These two options together determine the behavior when part of a
7023 mapped key sequence or keyboard code has been received:
7024
7025 'timeout' 'ttimeout' action ~
7026 off off do not time out
7027 on on or off time out on :mappings and key codes
7028 off on time out on key codes
7029
7030 If both options are off, Vim will wait until either the complete
7031 mapping or key sequence has been received, or it is clear that there
7032 is no mapping or key sequence for the received characters. For
7033 example: if you have mapped "vl" and Vim has received 'v', the next
7034 character is needed to see if the 'v' is followed by an 'l'.
7035 When one of the options is on, Vim will wait for about 1 second for
7036 the next character to arrive. After that the already received
7037 characters are interpreted as single characters. The waiting time can
7038 be changed with the 'timeoutlen' option.
7039 On slow terminals or very busy systems timing out may cause
7040 malfunctioning cursor keys. If both options are off, Vim waits
7041 forever after an entered <Esc> if there are key codes that start
7042 with <Esc>. You will have to type <Esc> twice. If you do not have
7043 problems with key codes, but would like to have :mapped key
7044 sequences not timing out in 1 second, set the 'ttimeout' option and
7045 reset the 'timeout' option.
7046
7047 NOTE: 'ttimeout' is reset when 'compatible' is set.
7048
7049 *'timeoutlen'* *'tm'*
7050'timeoutlen' 'tm' number (default 1000)
7051 global
7052 {not in all versions of Vi}
7053 *'ttimeoutlen'* *'ttm'*
7054'ttimeoutlen' 'ttm' number (default -1)
7055 global
7056 {not in Vi}
7057 The time in milliseconds that is waited for a key code or mapped key
7058 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7059 when part of a command has been typed.
7060 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7061 different timeout value for key codes is desired set 'ttimeoutlen' to
7062 a non-negative number.
7063
7064 ttimeoutlen mapping delay key code delay ~
7065 < 0 'timeoutlen' 'timeoutlen'
7066 >= 0 'timeoutlen' 'ttimeoutlen'
7067
7068 The timeout only happens when the 'timeout' and 'ttimeout' options
7069 tell so. A useful setting would be >
7070 :set timeout timeoutlen=3000 ttimeoutlen=100
7071< (time out on mapping after three seconds, time out on key codes after
7072 a tenth of a second).
7073
7074 *'title'* *'notitle'*
7075'title' boolean (default off, on when title can be restored)
7076 global
7077 {not in Vi}
7078 {not available when compiled without the |+title|
7079 feature}
7080 When on, the title of the window will be set to the value of
7081 'titlestring' (if it is not empty), or to:
7082 filename [+=-] (path) - VIM
7083 Where:
7084 filename the name of the file being edited
7085 - indicates the file cannot be modified, 'ma' off
7086 + indicates the file was modified
7087 = indicates the file is read-only
7088 =+ indicates the file is read-only and modified
7089 (path) is the path of the file being edited
7090 - VIM the server name |v:servername| or "VIM"
7091 Only works if the terminal supports setting window titles
7092 (currently Amiga console, Win32 console, all GUI versions and
7093 terminals with a non- empty 't_ts' option - these are Unix xterm and
7094 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7095 *X11*
7096 When Vim was compiled with HAVE_X11 defined, the original title will
7097 be restored if possible. The output of ":version" will include "+X11"
7098 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7099 works for the icon name |'icon'|.
7100 But: When Vim was started with the |-X| argument, restoring the title
7101 will not work (except in the GUI).
7102 If the title cannot be restored, it is set to the value of 'titleold'.
7103 You might want to restore the title outside of Vim then.
7104 When using an xterm from a remote machine you can use this command:
7105 rsh machine_name xterm -display $DISPLAY &
7106 then the WINDOWID environment variable should be inherited and the
7107 title of the window should change back to what it should be after
7108 exiting Vim.
7109
7110 *'titlelen'*
7111'titlelen' number (default 85)
7112 global
7113 {not in Vi}
7114 {not available when compiled without the |+title|
7115 feature}
7116 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007117 title. When the title is longer, only the end of the path name is
7118 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119 Using a percentage makes this adapt to the width of the window. But
7120 it won't work perfectly, because the actual number of characters
7121 available also depends on the font used and other things in the title
7122 bar. When 'titlelen' is zero the full path is used. Otherwise,
7123 values from 1 to 30000 percent can be used.
7124 'titlelen' is also used for the 'titlestring' option.
7125
7126 *'titleold'*
7127'titleold' string (default "Thanks for flying Vim")
7128 global
7129 {not in Vi}
7130 {only available when compiled with the |+title|
7131 feature}
7132 This option will be used for the window title when exiting Vim if the
7133 original title cannot be restored. Only happens if 'title' is on or
7134 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007135 This option cannot be set from a |modeline| or in the |sandbox|, for
7136 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137 *'titlestring'*
7138'titlestring' string (default "")
7139 global
7140 {not in Vi}
7141 {not available when compiled without the |+title|
7142 feature}
7143 When this option is not empty, it will be used for the title of the
7144 window. This happens only when the 'title' option is on.
7145 Only works if the terminal supports setting window titles (currently
7146 Amiga console, Win32 console, all GUI versions and terminals with a
7147 non-empty 't_ts' option).
7148 When Vim was compiled with HAVE_X11 defined, the original title will
7149 be restored if possible |X11|.
7150 When this option contains printf-style '%' items, they will be
7151 expanded according to the rules used for 'statusline'.
7152 Example: >
7153 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7154 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7155< The value of 'titlelen' is used to align items in the middle or right
7156 of the available space.
7157 Some people prefer to have the file name first: >
7158 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7159< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007160 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161 separating space only when needed.
7162 NOTE: Use of special characters in 'titlestring' may cause the display
7163 to be garbled (e.g., when it contains a CR or NL character).
7164 {not available when compiled without the |+statusline| feature}
7165
7166 *'toolbar'* *'tb'*
7167'toolbar' 'tb' string (default "icons,tooltips")
7168 global
7169 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7170 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007171 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 possible values are:
7173 icons Toolbar buttons are shown with icons.
7174 text Toolbar buttons shown with text.
7175 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007176 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 tooltips Tooltips are active for toolbar buttons.
7178 Tooltips refer to the popup help text which appears after the mouse
7179 cursor is placed over a toolbar button for a brief moment.
7180
7181 If you want the toolbar to be shown with icons as well as text, do the
7182 following: >
7183 :set tb=icons,text
7184< Motif and Athena cannot display icons and text at the same time. They
7185 will show icons if both are requested.
7186
7187 If none of the strings specified in 'toolbar' are valid or if
7188 'toolbar' is empty, this option is ignored. If you want to disable
7189 the toolbar, you need to set the 'guioptions' option. For example: >
7190 :set guioptions-=T
7191< Also see |gui-toolbar|.
7192
7193 *'toolbariconsize'* *'tbis'*
7194'toolbariconsize' 'tbis' string (default "small")
7195 global
7196 {not in Vi}
7197 {only in the GTK+ 2 GUI}
7198 Controls the size of toolbar icons. The possible values are:
7199 tiny Use tiny toolbar icons.
7200 small Use small toolbar icons (default).
7201 medium Use medium-sized toolbar icons.
7202 large Use large toolbar icons.
7203 The exact dimensions in pixels of the various icon sizes depend on
7204 the current theme. Common dimensions are large=32x32, medium=24x24,
7205 small=20x20 and tiny=16x16.
7206
7207 If 'toolbariconsize' is empty, the global default size as determined
7208 by user preferences or the current theme is used.
7209
7210 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7211'ttybuiltin' 'tbi' boolean (default on)
7212 global
7213 {not in Vi}
7214 When on, the builtin termcaps are searched before the external ones.
7215 When off the builtin termcaps are searched after the external ones.
7216 When this option is changed, you should set the 'term' option next for
7217 the change to take effect, for example: >
7218 :set notbi term=$TERM
7219< See also |termcap|.
7220 Rationale: The default for this option is "on", because the builtin
7221 termcap entries are generally better (many systems contain faulty
7222 xterm entries...).
7223
7224 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7225'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7226 sun-cmd, screen, rxvt, dtterm or
7227 iris-ansi; also on when running Vim in
7228 a DOS console)
7229 global
7230 {not in Vi}
7231 Indicates a fast terminal connection. More characters will be sent to
7232 the screen for redrawing, instead of using insert/delete line
7233 commands. Improves smoothness of redrawing when there are multiple
7234 windows and the terminal does not support a scrolling region.
7235 Also enables the extra writing of characters at the end of each screen
7236 line for lines that wrap. This helps when using copy/paste with the
7237 mouse in an xterm and other terminals.
7238
7239 *'ttymouse'* *'ttym'*
7240'ttymouse' 'ttym' string (default depends on 'term')
7241 global
7242 {not in Vi}
7243 {only in Unix and VMS, doesn't work in the GUI; not
7244 available when compiled without |+mouse|}
7245 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007246 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 *xterm-mouse*
7248 xterm xterm-like mouse handling. The mouse generates
7249 "<Esc>[Mscr", where "scr" is three bytes:
7250 "s" = button state
7251 "c" = column plus 33
7252 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007253 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007254 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 xterm2 Works like "xterm", but with the xterm reporting the
7256 mouse position while the mouse is dragged. This works
7257 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007258 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259 work. See below for how Vim detects this
7260 automatically.
7261 *netterm-mouse*
7262 netterm NetTerm mouse handling. The mouse generates
7263 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7264 for the row and column.
7265 *dec-mouse*
7266 dec DEC terminal mouse handling. The mouse generates a
7267 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007268 This is also available for an Xterm, if it was
7269 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007270 *jsbterm-mouse*
7271 jsbterm JSB term mouse handling.
7272 *pterm-mouse*
7273 pterm QNX pterm mouse handling.
7274
7275 The mouse handling must be enabled at compile time |+mouse_xterm|
7276 |+mouse_dec| |+mouse_netterm|.
7277 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7278 recognized, if enabled at compile time. DEC terminal mouse codes
7279 are recognized if enabled at compile time, and 'ttymouse' is not
7280 "xterm" (because the xterm and dec mouse codes conflict).
7281 This option is automatically set to "xterm", when the 'term' option is
7282 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7283 or "xterm2" already. The main use of this option is to set it to
7284 "xterm", when the terminal name doesn't start with "xterm", but it can
7285 handle xterm mouse codes.
7286 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007287 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 feature and if |t_RV| is set to the escape sequence to request the
7289 xterm version number. Otherwise "xterm2" must be set explicitly.
7290 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7291 t_RV to an empty string: >
7292 :set t_RV=
7293<
7294 *'ttyscroll'* *'tsl'*
7295'ttyscroll' 'tsl' number (default 999)
7296 global
7297 Maximum number of lines to scroll the screen. If there are more lines
7298 to scroll the window is redrawn. For terminals where scrolling is
7299 very slow and redrawing is not slow this can be set to a small number,
7300 e.g., 3, to speed up displaying.
7301
7302 *'ttytype'* *'tty'*
7303'ttytype' 'tty' string (default from $TERM)
7304 global
7305 Alias for 'term', see above.
7306
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007307 *'undodir'* *'udir'*
7308'undodir' 'udir' string (default ".")
7309 global
7310 {not in Vi}
7311 {only when compiled with the +persistent_undo feature}
7312 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007313 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007314 "." means using the directory of the file. The undo file name for
7315 "file.txt" is ".file.txt.un~".
7316 For other directories the file name is the full path of the edited
7317 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007318 When writing: The first directory that exists is used. "." always
7319 works, no directories after "." will be used for writing.
7320 When reading all entries are tried to find an undo file. The first
7321 undo file that exists is used. When it cannot be read an error is
7322 given, no further entry is used.
7323 See |undo-persistence|.
7324
7325 *'undofile'* *'udf'*
7326'undofile' 'udf' boolean (default off)
7327 local to buffer
7328 {not in Vi}
7329 {only when compiled with the +persistent_undo feature}
7330 When on, Vim automatically saves undo history to an undo file when
7331 writing a buffer to a file, and restores undo history from the same
7332 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007333 The directory where the undo file is stored is specified by 'undodir'.
7334 For more information about this feature see |undo-persistence|.
7335 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007336
Bram Moolenaar071d4272004-06-13 20:20:40 +00007337 *'undolevels'* *'ul'*
7338'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7339 Win32 and OS/2)
7340 global
7341 {not in Vi}
7342 Maximum number of changes that can be undone. Since undo information
7343 is kept in memory, higher numbers will cause more memory to be used
7344 (nevertheless, a single change can use an unlimited amount of memory).
7345 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7346 itself: >
7347 set ul=0
7348< But you can also get Vi compatibility by including the 'u' flag in
7349 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007350 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 Set to a negative number for no undo at all: >
7352 set ul=-1
7353< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007354 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355
7356 *'updatecount'* *'uc'*
7357'updatecount' 'uc' number (default: 200)
7358 global
7359 {not in Vi}
7360 After typing this many characters the swap file will be written to
7361 disk. When zero, no swap file will be created at all (see chapter on
7362 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7363 Vim with the "-n" option, see |startup|. When editing in readonly
7364 mode this option will be initialized to 10000.
7365 The swapfile can be disabled per buffer with |'swapfile'|.
7366 When 'updatecount' is set from zero to non-zero, swap files are
7367 created for all buffers that have 'swapfile' set. When 'updatecount'
7368 is set to zero, existing swap files are not deleted.
7369 Also see |'swapsync'|.
7370 This option has no meaning in buffers where |'buftype'| is "nofile"
7371 or "nowrite".
7372
7373 *'updatetime'* *'ut'*
7374'updatetime' 'ut' number (default 4000)
7375 global
7376 {not in Vi}
7377 If this many milliseconds nothing is typed the swap file will be
7378 written to disk (see |crash-recovery|). Also used for the
7379 |CursorHold| autocommand event.
7380
7381 *'verbose'* *'vbs'*
7382'verbose' 'vbs' number (default 0)
7383 global
7384 {not in Vi, although some versions have a boolean
7385 verbose option}
7386 When bigger than zero, Vim will give messages about what it is doing.
7387 Currently, these messages are given:
7388 >= 1 When the viminfo file is read or written.
7389 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007390 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007391 >= 8 Files for which a group of autocommands is executed.
7392 >= 9 Every executed autocommand.
7393 >= 12 Every executed function.
7394 >= 13 When an exception is thrown, caught, finished, or discarded.
7395 >= 14 Anything pending in a ":finally" clause.
7396 >= 15 Every executed Ex command (truncated at 200 characters).
7397
7398 This option can also be set with the "-V" argument. See |-V|.
7399 This option is also set by the |:verbose| command.
7400
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007401 When the 'verbosefile' option is set then the verbose messages are not
7402 displayed.
7403
7404 *'verbosefile'* *'vfile'*
7405'verbosefile' 'vfile' string (default empty)
7406 global
7407 {not in Vi}
7408 When not empty all messages are written in a file with this name.
7409 When the file exists messages are appended.
7410 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007411 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007412 Setting 'verbosefile' to a new value is like making it empty first.
7413 The difference with |:redir| is that verbose messages are not
7414 displayed when 'verbosefile' is set.
7415
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 *'viewdir'* *'vdir'*
7417'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7418 "$VIM/vimfiles/view",
7419 for Unix: "~/.vim/view",
7420 for Macintosh: "$VIM:vimfiles:view"
7421 for VMS: "sys$login:vimfiles/view"
7422 for RiscOS: "Choices:vimfiles/view")
7423 global
7424 {not in Vi}
7425 {not available when compiled without the +mksession
7426 feature}
7427 Name of the directory where to store files for |:mkview|.
7428 This option cannot be set from a |modeline| or in the |sandbox|, for
7429 security reasons.
7430
7431 *'viewoptions'* *'vop'*
7432'viewoptions' 'vop' string (default: "folds,options,cursor")
7433 global
7434 {not in Vi}
7435 {not available when compiled without the +mksession
7436 feature}
7437 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007438 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 word save and restore ~
7440 cursor cursor position in file and in window
7441 folds manually created folds, opened/closed folds and local
7442 fold options
7443 options options and mappings local to a window or buffer (not
7444 global values for local options)
7445 slash backslashes in file names replaced with forward
7446 slashes
7447 unix with Unix end-of-line format (single <NL>), even when
7448 on Windows or DOS
7449
7450 "slash" and "unix" are useful on Windows when sharing view files
7451 with Unix. The Unix version of Vim cannot source dos format scripts,
7452 but the Windows version of Vim can source unix format scripts.
7453
7454 *'viminfo'* *'vi'* *E526* *E527* *E528*
7455'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007456 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7457 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7458 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459 global
7460 {not in Vi}
7461 {not available when compiled without the |+viminfo|
7462 feature}
7463 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007464 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 separated list of parameters, each consisting of a single character
7466 identifying the particular parameter, followed by a number or string
7467 which specifies the value of that parameter. If a particular
7468 character is left out, then the default value is used for that
7469 parameter. The following is a list of the identifying characters and
7470 the effect of their value.
7471 CHAR VALUE ~
7472 ! When included, save and restore global variables that start
7473 with an uppercase letter, and don't contain a lowercase
7474 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007475 and "_K_L_M" are not. Only String and Number types are
7476 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 " Maximum number of lines saved for each register. Old name of
7478 the '<' item, with the disadvantage that you need to put a
7479 backslash before the ", otherwise it will be recognized as the
7480 start of a comment!
7481 % When included, save and restore the buffer list. If Vim is
7482 started with a file name argument, the buffer list is not
7483 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007484 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 without a file name and buffers for help files are not written
7486 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007487 When followed by a number, the number specifies the maximum
7488 number of buffers that are stored. Without a number all
7489 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490 ' Maximum number of previously edited files for which the marks
7491 are remembered. This parameter must always be included when
7492 'viminfo' is non-empty.
7493 Including this item also means that the |jumplist| and the
7494 |changelist| are stored in the viminfo file.
7495 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007496 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007497 patterns are also saved. When not included, the value of
7498 'history' is used.
7499 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007500 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 < Maximum number of lines saved for each register. If zero then
7502 registers are not saved. When not included, all lines are
7503 saved. '"' is the old name for this item.
7504 Also see the 's' item below: limit specified in Kbyte.
7505 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007506 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 c When included, convert the text in the viminfo file from the
7508 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007509 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007510 f Whether file marks need to be stored. If zero, file marks ('0
7511 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007512 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 cursor position (when exiting or when doing ":wviminfo").
7514 h Disable the effect of 'hlsearch' when loading the viminfo
7515 file. When not included, it depends on whether ":nohlsearch"
7516 has been used since the last search command.
7517 n Name of the viminfo file. The name must immediately follow
7518 the 'n'. Must be the last one! If the "-i" argument was
7519 given when starting Vim, that file name overrides the one
7520 given here with 'viminfo'. Environment variables are expanded
7521 when opening the file, not when setting the option.
7522 r Removable media. The argument is a string (up to the next
7523 ','). This parameter can be given several times. Each
7524 specifies the start of a path for which no marks will be
7525 stored. This is to avoid removable media. For MS-DOS you
7526 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7527 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7528 ignored. Maximum length of each 'r' argument is 50
7529 characters.
7530 s Maximum size of an item in Kbyte. If zero then registers are
7531 not saved. Currently only applies to registers. The default
7532 "s10" will exclude registers with more than 10 Kbyte of text.
7533 Also see the '<' item above: line count limit.
7534
7535 Example: >
7536 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7537<
7538 '50 Marks will be remembered for the last 50 files you
7539 edited.
7540 <1000 Contents of registers (up to 1000 lines each) will be
7541 remembered.
7542 s100 Registers with more than 100 Kbyte text are skipped.
7543 :0 Command-line history will not be saved.
7544 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7545 no / Since '/' is not specified, the default will be used,
7546 that is, save all of the search history, and also the
7547 previous search and substitute patterns.
7548 no % The buffer list will not be saved nor read back.
7549 no h 'hlsearch' highlighting will be restored.
7550
7551 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7552 load the contents of the file, this is not done automatically.
7553
7554 This option cannot be set from a |modeline| or in the |sandbox|, for
7555 security reasons.
7556
7557 *'virtualedit'* *'ve'*
7558'virtualedit' 've' string (default "")
7559 global
7560 {not in Vi}
7561 {not available when compiled without the
7562 |+virtualedit| feature}
7563 A comma separated list of these words:
7564 block Allow virtual editing in Visual block mode.
7565 insert Allow virtual editing in Insert mode.
7566 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007567 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007568
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007570 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007571 of the line. Useful for selecting a rectangle in Visual mode and
7572 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007573 "onemore" is not the same, it will only allow moving the cursor just
7574 after the last character of the line. This makes some commands more
7575 consistent. Previously the cursor was always past the end of the line
7576 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007577 break some plugins or Vim scripts. For example because |l| can move
7578 the cursor after the last character. Use with care!
7579 Using the |$| command will move to the last character in the line, not
7580 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007581 It doesn't make sense to combine "all" with "onemore", but you will
7582 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007583
7584 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7585'visualbell' 'vb' boolean (default off)
7586 global
7587 {not in Vi}
7588 Use visual bell instead of beeping. The terminal code to display the
7589 visual bell is given with 't_vb'. When no beep or flash is wanted,
7590 use ":set vb t_vb=".
7591 Note: When the GUI starts, 't_vb' is reset to its default value. You
7592 might want to set it again in your |gvimrc|.
7593 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7594 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7595 where 40 is the time in msec.
7596 Does not work on the Amiga, you always get a screen flash.
7597 Also see 'errorbells'.
7598
7599 *'warn'* *'nowarn'*
7600'warn' boolean (default on)
7601 global
7602 Give a warning message when a shell command is used while the buffer
7603 has been changed.
7604
7605 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7606'weirdinvert' 'wiv' boolean (default off)
7607 global
7608 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007609 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007610 It is provided for backwards compatibility with version 4.x.
7611 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7612 vice versa. Has no effect when the GUI is running.
7613
7614 *'whichwrap'* *'ww'*
7615'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7616 global
7617 {not in Vi}
7618 Allow specified keys that move the cursor left/right to move to the
7619 previous/next line when the cursor is on the first/last character in
7620 the line. Concatenate characters to allow this for these keys:
7621 char key mode ~
7622 b <BS> Normal and Visual
7623 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007624 h "h" Normal and Visual (not recommended)
7625 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626 < <Left> Normal and Visual
7627 > <Right> Normal and Visual
7628 ~ "~" Normal
7629 [ <Left> Insert and Replace
7630 ] <Right> Insert and Replace
7631 For example: >
7632 :set ww=<,>,[,]
7633< allows wrap only when cursor keys are used.
7634 When the movement keys are used in combination with a delete or change
7635 operator, the <EOL> also counts for a character. This makes "3h"
7636 different from "3dh" when the cursor crosses the end of a line. This
7637 is also true for "x" and "X", because they do the same as "dl" and
7638 "dh". If you use this, you may also want to use the mapping
7639 ":map <BS> X" to make backspace delete the character in front of the
7640 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007641 When 'l' is included and it is used after an operator at the end of a
7642 line then it will not move to the next line. This makes "dl", "cl",
7643 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 NOTE: This option is set to the Vi default value when 'compatible' is
7645 set and to the Vim default value when 'compatible' is reset.
7646
7647 *'wildchar'* *'wc'*
7648'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7649 global
7650 {not in Vi}
7651 Character you have to type to start wildcard expansion in the
7652 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007653 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007654 The character is not recognized when used inside a macro. See
7655 'wildcharm' for that.
7656 Although 'wc' is a number option, you can set it to a special key: >
7657 :set wc=<Esc>
7658< NOTE: This option is set to the Vi default value when 'compatible' is
7659 set and to the Vim default value when 'compatible' is reset.
7660
7661 *'wildcharm'* *'wcm'*
7662'wildcharm' 'wcm' number (default: none (0))
7663 global
7664 {not in Vi}
7665 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007666 recognized when used inside a macro. You can find "spare" command-line
7667 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668 you'll never actually type 'wildcharm', just use it in mappings that
7669 automatically invoke completion mode, e.g.: >
7670 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007671 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007672< Then after typing :ss you can use CTRL-P & CTRL-N.
7673
7674 *'wildignore'* *'wig'*
7675'wildignore' 'wig' string (default "")
7676 global
7677 {not in Vi}
7678 {not available when compiled without the |+wildignore|
7679 feature}
7680 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007681 patterns is ignored when completing file or directory names, and
7682 influences the result of |expand()|, |glob()| and |globpath()| unless
7683 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7685 Also see 'suffixes'.
7686 Example: >
7687 :set wildignore=*.o,*.obj
7688< The use of |:set+=| and |:set-=| is preferred when adding or removing
7689 a pattern from the list. This avoids problems when a future version
7690 uses another default.
7691
7692 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7693'wildmenu' 'wmnu' boolean (default off)
7694 global
7695 {not in Vi}
7696 {not available if compiled without the |+wildmenu|
7697 feature}
7698 When 'wildmenu' is on, command-line completion operates in an enhanced
7699 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7700 the possible matches are shown just above the command line, with the
7701 first match highlighted (overwriting the status line, if there is
7702 one). Keys that show the previous/next match, such as <Tab> or
7703 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7704 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7705 specified. "longest" and "list" do not start "wildmenu" mode.
7706 If there are more matches than can fit in the line, a ">" is shown on
7707 the right and/or a "<" is shown on the left. The status line scrolls
7708 as needed.
7709 The "wildmenu" mode is abandoned when a key is hit that is not used
7710 for selecting a completion.
7711 While the "wildmenu" is active the following keys have special
7712 meanings:
7713
7714 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7715 <Down> - in filename/menu name completion: move into a
7716 subdirectory or submenu.
7717 <CR> - in menu completion, when the cursor is just after a
7718 dot: move into a submenu.
7719 <Up> - in filename/menu name completion: move up into
7720 parent directory or parent menu.
7721
7722 This makes the menus accessible from the console |console-menus|.
7723
7724 If you prefer the <Left> and <Right> keys to move the cursor instead
7725 of selecting a different match, use this: >
7726 :cnoremap <Left> <Space><BS><Left>
7727 :cnoremap <Right> <Space><BS><Right>
7728<
7729 The "WildMenu" highlighting is used for displaying the current match
7730 |hl-WildMenu|.
7731
7732 *'wildmode'* *'wim'*
7733'wildmode' 'wim' string (Vim default: "full")
7734 global
7735 {not in Vi}
7736 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007737 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007738 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739 first part specifies the behavior for the first use of 'wildchar',
7740 The second part for the second use, etc.
7741 These are the possible values for each part:
7742 "" Complete only the first match.
7743 "full" Complete the next full match. After the last match,
7744 the original string is used and then the first match
7745 again.
7746 "longest" Complete till longest common string. If this doesn't
7747 result in a longer string, use the next part.
7748 "longest:full" Like "longest", but also start 'wildmenu' if it is
7749 enabled.
7750 "list" When more than one match, list all matches.
7751 "list:full" When more than one match, list all matches and
7752 complete first match.
7753 "list:longest" When more than one match, list all matches and
7754 complete till longest common string.
7755 When there is only a single match, it is fully completed in all cases.
7756
7757 Examples: >
7758 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007759< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760 :set wildmode=longest,full
7761< Complete longest common string, then each full match >
7762 :set wildmode=list:full
7763< List all matches and complete each full match >
7764 :set wildmode=list,full
7765< List all matches without completing, then each full match >
7766 :set wildmode=longest,list
7767< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007768 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007769
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007770 *'wildoptions'* *'wop'*
7771'wildoptions' 'wop' string (default "")
7772 global
7773 {not in Vi}
7774 {not available when compiled without the |+wildignore|
7775 feature}
7776 A list of words that change how command line completion is done.
7777 Currently only one word is allowed:
7778 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007779 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007780 is displayed per line. Often used tag kinds are:
7781 d #define
7782 f function
7783 Also see |cmdline-completion|.
7784
Bram Moolenaar071d4272004-06-13 20:20:40 +00007785 *'winaltkeys'* *'wak'*
7786'winaltkeys' 'wak' string (default "menu")
7787 global
7788 {not in Vi}
7789 {only used in Win32, Motif, GTK and Photon GUI}
7790 Some GUI versions allow the access to menu entries by using the ALT
7791 key in combination with a character that appears underlined in the
7792 menu. This conflicts with the use of the ALT key for mappings and
7793 entering special characters. This option tells what to do:
7794 no Don't use ALT keys for menus. ALT key combinations can be
7795 mapped, but there is no automatic handling. This can then be
7796 done with the |:simalt| command.
7797 yes ALT key handling is done by the windowing system. ALT key
7798 combinations cannot be mapped.
7799 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007800 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007801 keys can be mapped.
7802 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7803 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007804 This option is not used for <F10>; on Win32 and with GTK <F10> will
7805 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007806
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007807 *'window'* *'wi'*
7808'window' 'wi' number (default screen height - 1)
7809 global
7810 Window height. Do not confuse this with the height of the Vim window,
7811 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007812 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7813 value is smaller than 'lines' minus one. The screen will scroll
7814 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007815 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7816 in a much smarter way, taking care of wrapping lines.
7817 When resizing the Vim window, the value is smaller than 1 or more than
7818 or equal to 'lines' it will be set to 'lines' minus 1.
7819 {Vi also uses the option to specify the number of displayed lines}
7820
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 *'winheight'* *'wh'* *E591*
7822'winheight' 'wh' number (default 1)
7823 global
7824 {not in Vi}
7825 {not available when compiled without the +windows
7826 feature}
7827 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007828 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007829 focus goes to a window that is smaller, its size is increased, at the
7830 cost of the height of other windows.
7831 Set 'winheight' to a small number for normal editing.
7832 Set it to 999 to make the current window fill most of the screen.
7833 Other windows will be only 'winminheight' high. This has the drawback
7834 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7835 to create only two windows, set the option after startup is done,
7836 using the |VimEnter| event: >
7837 au VimEnter * set winheight=999
7838< Minimum value is 1.
7839 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007840 height of the current window.
7841 'winheight' applies to the current window. Use 'winminheight' to set
7842 the minimal height for other windows.
7843
7844 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7845'winfixheight' 'wfh' boolean (default off)
7846 local to window
7847 {not in Vi}
7848 {not available when compiled without the +windows
7849 feature}
7850 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007851 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7852 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007853 The height may be changed anyway when running out of room.
7854
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007855 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7856'winfixwidth' 'wfw' boolean (default off)
7857 local to window
7858 {not in Vi}
7859 {not available when compiled without the +windows
7860 feature}
7861 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007862 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007863 The width may be changed anyway when running out of room.
7864
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 *'winminheight'* *'wmh'*
7866'winminheight' 'wmh' number (default 1)
7867 global
7868 {not in Vi}
7869 {not available when compiled without the +windows
7870 feature}
7871 The minimal height of a window, when it's not the current window.
7872 This is a hard minimum, windows will never become smaller.
7873 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7874 status bar) if necessary. They will return to at least one line when
7875 they become active (since the cursor has to have somewhere to go.)
7876 Use 'winheight' to set the minimal height of the current window.
7877 This option is only checked when making a window smaller. Don't use a
7878 large number, it will cause errors when opening more than a few
7879 windows. A value of 0 to 3 is reasonable.
7880
7881 *'winminwidth'* *'wmw'*
7882'winminwidth' 'wmw' number (default 1)
7883 global
7884 {not in Vi}
7885 {not available when compiled without the +vertsplit
7886 feature}
7887 The minimal width of a window, when it's not the current window.
7888 This is a hard minimum, windows will never become smaller.
7889 When set to zero, windows may be "squashed" to zero columns (i.e. just
7890 a vertical separator) if necessary. They will return to at least one
7891 line when they become active (since the cursor has to have somewhere
7892 to go.)
7893 Use 'winwidth' to set the minimal width of the current window.
7894 This option is only checked when making a window smaller. Don't use a
7895 large number, it will cause errors when opening more than a few
7896 windows. A value of 0 to 12 is reasonable.
7897
7898 *'winwidth'* *'wiw'* *E592*
7899'winwidth' 'wiw' number (default 20)
7900 global
7901 {not in Vi}
7902 {not available when compiled without the +vertsplit
7903 feature}
7904 Minimal number of columns for the current window. This is not a hard
7905 minimum, Vim will use fewer columns if there is not enough room. If
7906 the current window is smaller, its size is increased, at the cost of
7907 the width of other windows. Set it to 999 to make the current window
7908 always fill the screen. Set it to a small number for normal editing.
7909 The width is not adjusted after one of the commands to change the
7910 width of the current window.
7911 'winwidth' applies to the current window. Use 'winminwidth' to set
7912 the minimal width for other windows.
7913
7914 *'wrap'* *'nowrap'*
7915'wrap' boolean (default on)
7916 local to window
7917 {not in Vi}
7918 This option changes how text is displayed. It doesn't change the text
7919 in the buffer, see 'textwidth' for that.
7920 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007921 displaying continues on the next line. When off lines will not wrap
7922 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007923 moved to a part that is not shown, the screen will scroll
7924 horizontally.
7925 The line will be broken in the middle of a word if necessary. See
7926 'linebreak' to get the break at a word boundary.
7927 To make scrolling horizontally a bit more useful, try this: >
7928 :set sidescroll=5
7929 :set listchars+=precedes:<,extends:>
7930< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007931 This option can't be set from a |modeline| when the 'diff' option is
7932 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007933
7934 *'wrapmargin'* *'wm'*
7935'wrapmargin' 'wm' number (default 0)
7936 local to buffer
7937 Number of characters from the right window border where wrapping
7938 starts. When typing text beyond this limit, an <EOL> will be inserted
7939 and inserting continues on the next line.
7940 Options that add a margin, such as 'number' and 'foldcolumn', cause
7941 the text width to be further reduced. This is Vi compatible.
7942 When 'textwidth' is non-zero, this option is not used.
7943 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7944 and less usefully}
7945
7946 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7947'wrapscan' 'ws' boolean (default on) *E384* *E385*
7948 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007949 Searches wrap around the end of the file. Also applies to |]s| and
7950 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007951
7952 *'write'* *'nowrite'*
7953'write' boolean (default on)
7954 global
7955 {not in Vi}
7956 Allows writing files. When not set, writing a file is not allowed.
7957 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007958 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959 argument. Filtering text is still possible, even though this requires
7960 writing a temporary file.
7961
7962 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7963'writeany' 'wa' boolean (default off)
7964 global
7965 Allows writing to any file with no need for "!" override.
7966
7967 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7968'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7969 otherwise)
7970 global
7971 {not in Vi}
7972 Make a backup before overwriting a file. The backup is removed after
7973 the file was successfully written, unless the 'backup' option is
7974 also on. Reset this option if your file system is almost full. See
7975 |backup-table| for another explanation.
7976 When the 'backupskip' pattern matches, a backup is not made anyway.
7977 NOTE: This option is set to the default value when 'compatible' is
7978 set.
7979
7980 *'writedelay'* *'wd'*
7981'writedelay' 'wd' number (default 0)
7982 global
7983 {not in Vi}
7984 The number of microseconds to wait for each character sent to the
7985 screen. When non-zero, characters are sent to the terminal one by
7986 one. For MS-DOS pcterm this does not work. For debugging purposes.
7987
7988 vim:tw=78:ts=8:ft=help:norl: