blob: 297939fbe1ab9977828d6c98f7d6b420dbe6a51a [file] [log] [blame]
Bram Moolenaarb8521962010-07-20 22:45:13 +02001*options.txt* For Vim version 7.3b. Last change: 2010 Jul 20
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'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002077'cryptmethod' string (default "zip")
2078 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002079 {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 Moolenaar49771f42010-07-20 17:32:38 +02002082 zip 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 Moolenaar49771f42010-07-20 17:32:38 +02002085 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002086 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
Bram Moolenaar49771f42010-07-20 17:32:38 +02002094 explicitly write it, you don't get a warning unless there are other
2095 modifications. Also see |:X|.
2096
2097 When setting the global value to an empty string, it will end up with
2098 the value "zip". When setting the local value to an empty string the
2099 buffer will use the global value.
2100
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002101 When a new encryption method is added in a later version of Vim, and
2102 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002103 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002104
2105
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106 *'cscopepathcomp'* *'cspc'*
2107'cscopepathcomp' 'cspc' number (default 0)
2108 global
2109 {not available when compiled without the |+cscope|
2110 feature}
2111 {not in Vi}
2112 Determines how many components of the path to show in a list of tags.
2113 See |cscopepathcomp|.
2114
2115 *'cscopeprg'* *'csprg'*
2116'cscopeprg' 'csprg' string (default "cscope")
2117 global
2118 {not available when compiled without the |+cscope|
2119 feature}
2120 {not in Vi}
2121 Specifies the command to execute cscope. See |cscopeprg|.
2122 This option cannot be set from a |modeline| or in the |sandbox|, for
2123 security reasons.
2124
2125 *'cscopequickfix'* *'csqf'*
2126'cscopequickfix' 'csqf' string (default "")
2127 global
2128 {not available when compiled without the |+cscope|
2129 or |+quickfix| features}
2130 {not in Vi}
2131 Specifies whether to use quickfix window to show cscope results.
2132 See |cscopequickfix|.
2133
2134 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2135'cscopetag' 'cst' boolean (default off)
2136 global
2137 {not available when compiled without the |+cscope|
2138 feature}
2139 {not in Vi}
2140 Use cscope for tag commands. See |cscope-options|.
2141 NOTE: This option is reset when 'compatible' is set.
2142
2143 *'cscopetagorder'* *'csto'*
2144'cscopetagorder' 'csto' number (default 0)
2145 global
2146 {not available when compiled without the |+cscope|
2147 feature}
2148 {not in Vi}
2149 Determines the order in which ":cstag" performs a search. See
2150 |cscopetagorder|.
2151 NOTE: This option is set to 0 when 'compatible' is set.
2152
2153 *'cscopeverbose'* *'csverb'*
2154 *'nocscopeverbose'* *'nocsverb'*
2155'cscopeverbose' 'csverb' boolean (default off)
2156 global
2157 {not available when compiled without the |+cscope|
2158 feature}
2159 {not in Vi}
2160 Give messages when adding a cscope database. See |cscopeverbose|.
2161 NOTE: This option is reset when 'compatible' is set.
2162
Bram Moolenaar860cae12010-06-05 23:22:07 +02002163 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2164'cursorbind' 'crb' boolean (default off)
2165 local to window
2166 {not in Vi}
2167 {not available when compiled without the |+cursorbind|
2168 feature}
2169 When this option is set, as the cursor in the current
2170 window moves other cursorbound windows (windows that also have
2171 this option set) move their cursors to the corresponding line and
2172 column. This option is useful for viewing the
2173 differences between two versions of a file (see 'diff'); in diff mode,
2174 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002175 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002176
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002177
2178 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2179'cursorcolumn' 'cuc' boolean (default off)
2180 local to window
2181 {not in Vi}
2182 {not available when compiled without the |+syntax|
2183 feature}
2184 Highlight the screen column of the cursor with CursorColumn
2185 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2186 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002187 If you only want the highlighting in the current window you can use
2188 these autocommands: >
2189 au WinLeave * set nocursorline nocursorcolumn
2190 au WinEnter * set cursorline cursorcolumn
2191<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002192
2193 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2194'cursorline' 'cul' boolean (default off)
2195 local to window
2196 {not in Vi}
2197 {not available when compiled without the |+syntax|
2198 feature}
2199 Highlight the screen line of the cursor with CursorLine
2200 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2201 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002202 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002203 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002204
2205
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206 *'debug'*
2207'debug' string (default "")
2208 global
2209 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002210 These values can be used:
2211 msg Error messages that would otherwise be omitted will be given
2212 anyway.
2213 throw Error messages that would otherwise be omitted will be given
2214 anyway and also throw an exception and set |v:errmsg|.
2215 beep A message will be given when otherwise only a beep would be
2216 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002217 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002218 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2219 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220
2221 *'define'* *'def'*
2222'define' 'def' string (default "^\s*#\s*define")
2223 global or local to buffer |global-local|
2224 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002225 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 pattern, just like for the "/" command. This option is used for the
2227 commands like "[i" and "[d" |include-search|. The 'isident' option is
2228 used to recognize the defined name after the match:
2229 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2230 See |option-backslash| about inserting backslashes to include a space
2231 or backslash.
2232 The default value is for C programs. For C++ this value would be
2233 useful, to include const type declarations: >
2234 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2235< When using the ":set" command, you need to double the backslashes!
2236
2237 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2238'delcombine' 'deco' boolean (default off)
2239 global
2240 {not in Vi}
2241 {only available when compiled with the |+multi_byte|
2242 feature}
2243 If editing Unicode and this option is set, backspace and Normal mode
2244 "x" delete each combining character on its own. When it is off (the
2245 default) the character along with its combining characters are
2246 deleted.
2247 Note: When 'delcombine' is set "xx" may work different from "2x"!
2248
2249 This is useful for Arabic, Hebrew and many other languages where one
2250 may have combining characters overtop of base characters, and want
2251 to remove only the combining ones.
2252
2253 *'dictionary'* *'dict'*
2254'dictionary' 'dict' string (default "")
2255 global or local to buffer |global-local|
2256 {not in Vi}
2257 List of file names, separated by commas, that are used to lookup words
2258 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2259 contain a list of words. This can be one word per line, or several
2260 words per line, separated by non-keyword characters (white space is
2261 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002262 When this option is empty, or an entry "spell" is present, spell
2263 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002264 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 after a comma are ignored, otherwise spaces are included in the file
2266 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002267 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 Where to find a list of words?
2269 - On FreeBSD, there is the file "/usr/share/dict/words".
2270 - In the Simtel archive, look in the "msdos/linguist" directory.
2271 - In "miscfiles" of the GNU collection.
2272 The use of |:set+=| and |:set-=| is preferred when adding or removing
2273 directories from the list. This avoids problems when a future version
2274 uses another default.
2275 Backticks cannot be used in this option for security reasons.
2276
2277 *'diff'* *'nodiff'*
2278'diff' boolean (default off)
2279 local to window
2280 {not in Vi}
2281 {not available when compiled without the |+diff|
2282 feature}
2283 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002284 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285
2286 *'dex'* *'diffexpr'*
2287'diffexpr' 'dex' string (default "")
2288 global
2289 {not in Vi}
2290 {not available when compiled without the |+diff|
2291 feature}
2292 Expression which is evaluated to obtain an ed-style diff file from two
2293 versions of a file. See |diff-diffexpr|.
2294 This option cannot be set from a |modeline| or in the |sandbox|, for
2295 security reasons.
2296
2297 *'dip'* *'diffopt'*
2298'diffopt' 'dip' string (default "filler")
2299 global
2300 {not in Vi}
2301 {not available when compiled without the |+diff|
2302 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002303 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002304 All are optional. Items must be separated by a comma.
2305
2306 filler Show filler lines, to keep the text
2307 synchronized with a window that has inserted
2308 lines at the same position. Mostly useful
2309 when windows are side-by-side and 'scrollbind'
2310 is set.
2311
2312 context:{n} Use a context of {n} lines between a change
2313 and a fold that contains unchanged lines.
2314 When omitted a context of six lines is used.
2315 See |fold-diff|.
2316
2317 icase Ignore changes in case of text. "a" and "A"
2318 are considered the same. Adds the "-i" flag
2319 to the "diff" command if 'diffexpr' is empty.
2320
2321 iwhite Ignore changes in amount of white space. Adds
2322 the "-b" flag to the "diff" command if
2323 'diffexpr' is empty. Check the documentation
2324 of the "diff" command for what this does
2325 exactly. It should ignore adding trailing
2326 white space, but not leading white space.
2327
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002328 horizontal Start diff mode with horizontal splits (unless
2329 explicitly specified otherwise).
2330
2331 vertical Start diff mode with vertical splits (unless
2332 explicitly specified otherwise).
2333
2334 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2335 starting diff mode. Without this 2 is used.
2336
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 Examples: >
2338
2339 :set diffopt=filler,context:4
2340 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002341 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002342<
2343 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2344'digraph' 'dg' boolean (default off)
2345 global
2346 {not in Vi}
2347 {not available when compiled without the |+digraphs|
2348 feature}
2349 Enable the entering of digraphs in Insert mode with {char1} <BS>
2350 {char2}. See |digraphs|.
2351 NOTE: This option is reset when 'compatible' is set.
2352
2353 *'directory'* *'dir'*
2354'directory' 'dir' string (default for Amiga: ".,t:",
2355 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2356 for Unix: ".,~/tmp,/var/tmp,/tmp")
2357 global
2358 List of directory names for the swap file, separated with commas.
2359 - The swap file will be created in the first directory where this is
2360 possible.
2361 - Empty means that no swap file will be used (recovery is
2362 impossible!).
2363 - A directory "." means to put the swap file in the same directory as
2364 the edited file. On Unix, a dot is prepended to the file name, so
2365 it doesn't show in a directory listing. On MS-Windows the "hidden"
2366 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002367 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368 put the swap file relative to where the edited file is. The leading
2369 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002370 - For Unix and Win32, if a directory ends in two path separators "//"
2371 or "\\", the swap file name will be built from the complete path to
2372 the file with all path separators substituted to percent '%' signs.
2373 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002374 On Win32, when a separating comma is following, you must use "//",
2375 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376 - Spaces after the comma are ignored, other spaces are considered part
2377 of the directory name. To have a space at the start of a directory
2378 name, precede it with a backslash.
2379 - To include a comma in a directory name precede it with a backslash.
2380 - A directory name may end in an ':' or '/'.
2381 - Environment variables are expanded |:set_env|.
2382 - Careful with '\' characters, type one before a space, type two to
2383 get one in the option (see |option-backslash|), for example: >
2384 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2385< - For backwards compatibility with Vim version 3.0 a '>' at the start
2386 of the option is removed.
2387 Using "." first in the list is recommended. This means that editing
2388 the same file twice will result in a warning. Using "/tmp" on Unix is
2389 discouraged: When the system crashes you lose the swap file.
2390 "/var/tmp" is often not cleared when rebooting, thus is a better
2391 choice than "/tmp". But it can contain a lot of files, your swap
2392 files get lost in the crowd. That is why a "tmp" directory in your
2393 home directory is tried first.
2394 The use of |:set+=| and |:set-=| is preferred when adding or removing
2395 directories from the list. This avoids problems when a future version
2396 uses another default.
2397 This option cannot be set from a |modeline| or in the |sandbox|, for
2398 security reasons.
2399 {Vi: directory to put temp file in, defaults to "/tmp"}
2400
2401 *'display'* *'dy'*
2402'display' 'dy' string (default "")
2403 global
2404 {not in Vi}
2405 Change the way text is displayed. This is comma separated list of
2406 flags:
2407 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002408 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409 last line that doesn't fit is replaced with "@" lines.
2410 uhex Show unprintable characters hexadecimal as <xx>
2411 instead of using ^C and ~C.
2412
2413 *'eadirection'* *'ead'*
2414'eadirection' 'ead' string (default "both")
2415 global
2416 {not in Vi}
2417 {not available when compiled without the +vertsplit
2418 feature}
2419 Tells when the 'equalalways' option applies:
2420 ver vertically, width of windows is not affected
2421 hor horizontally, height of windows is not affected
2422 both width and height of windows is affected
2423
2424 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2425'edcompatible' 'ed' boolean (default off)
2426 global
2427 Makes the 'g' and 'c' flags of the ":substitute" command to be
2428 toggled each time the flag is given. See |complex-change|. See
2429 also 'gdefault' option.
2430 Switching this option on is discouraged!
2431
2432 *'encoding'* *'enc'* *E543*
2433'encoding' 'enc' string (default: "latin1" or value from $LANG)
2434 global
2435 {only available when compiled with the |+multi_byte|
2436 feature}
2437 {not in Vi}
2438 Sets the character encoding used inside Vim. It applies to text in
2439 the buffers, registers, Strings in expressions, text stored in the
2440 viminfo file, etc. It sets the kind of characters which Vim can work
2441 with. See |encoding-names| for the possible values.
2442
2443 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002444 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002445 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002446 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447
Bram Moolenaar865242e2010-07-14 21:12:05 +02002448 This option cannot be set from a |modeline|. It would most likely
2449 corrupt the text.
2450
Bram Moolenaar071d4272004-06-13 20:20:40 +00002451 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2452 "utf-8". Although care has been taken to allow different values of
2453 'encoding', "utf-8" is the natural choice for the environment and
2454 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002455 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456 versions, and to avoid changing the encoding of newly created files
2457 without your knowledge (in case 'fileencodings' is empty).
2458
2459 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002460 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002461 iconv() or as specified with 'charconvert'.
2462
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002463 If you need to know whether 'encoding' is a multi-byte encoding, you
2464 can use: >
2465 if has("multi_byte_encoding")
2466<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467 Normally 'encoding' will be equal to your current locale. This will
2468 be the default if Vim recognizes your environment settings. If
2469 'encoding' is not set to the current locale, 'termencoding' must be
2470 set to convert typed and displayed text. See |encoding-table|.
2471
2472 When you set this option, it fires the |EncodingChanged| autocommand
2473 event so that you can set up fonts if necessary.
2474
2475 When the option is set, the value is converted to lowercase. Thus
2476 you can set it with uppercase values too. Underscores are translated
2477 to '-' signs.
2478 When the encoding is recognized, it is changed to the standard name.
2479 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2480 "iso-8859-2" and "utf8" becomes "utf-8".
2481
2482 Note: "latin1" is also used when the encoding could not be detected.
2483 This only works when editing files in the same encoding! When the
2484 actual character set is not latin1, make sure 'fileencoding' and
2485 'fileencodings' are empty. When conversion is needed, switch to using
2486 utf-8.
2487
2488 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2489 You don't notice this while editing, but it does matter for the
2490 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2491 setting 'encoding' to one of these values instead of utf-8 only has
2492 effect for encoding used for files when 'fileencoding' is empty.
2493
Bram Moolenaar661b1822005-07-28 22:36:45 +00002494 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2495 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496
2497 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2498'endofline' 'eol' boolean (default on)
2499 local to buffer
2500 {not in Vi}
2501 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002502 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002503 option is automatically set when starting to edit a new file, unless
2504 the file does not have an <EOL> for the last line in the file, in
2505 which case it is reset. Normally you don't have to set or reset this
2506 option. When 'binary' is off the value is not used when writing the
2507 file. When 'binary' is on it is used to remember the presence of a
2508 <EOL> for the last line in the file, so that when you write the file
2509 the situation from the original file can be kept. But you can change
2510 it if you want to.
2511
2512 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2513'equalalways' 'ea' boolean (default on)
2514 global
2515 {not in Vi}
2516 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002517 splitting or closing a window. This also happens the moment the
2518 option is switched on. When off, splitting a window will reduce the
2519 size of the current window and leave the other windows the same. When
2520 closing a window the extra lines are given to the window next to it
2521 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 When mixing vertically and horizontally split windows, a minimal size
2523 is computed and some windows may be larger if there is room. The
2524 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002525 Changing the height and width of a window can be avoided by setting
2526 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002527 If a window size is specified when creating a new window sizes are
2528 currently not equalized (it's complicated, but may be implemented in
2529 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530
2531 *'equalprg'* *'ep'*
2532'equalprg' 'ep' string (default "")
2533 global or local to buffer |global-local|
2534 {not in Vi}
2535 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002536 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002537 or 'indentexpr'. When Vim was compiled without internal formatting,
2538 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002539 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 about including spaces and backslashes.
2541 This option cannot be set from a |modeline| or in the |sandbox|, for
2542 security reasons.
2543
2544 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2545'errorbells' 'eb' boolean (default off)
2546 global
2547 Ring the bell (beep or screen flash) for error messages. This only
2548 makes a difference for error messages, the bell will be used always
2549 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002550 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551 screen flash or do nothing.
2552
2553 *'errorfile'* *'ef'*
2554'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2555 others: "errors.err")
2556 global
2557 {not in Vi}
2558 {not available when compiled without the |+quickfix|
2559 feature}
2560 Name of the errorfile for the QuickFix mode (see |:cf|).
2561 When the "-q" command-line argument is used, 'errorfile' is set to the
2562 following argument. See |-q|.
2563 NOT used for the ":make" command. See 'makeef' for that.
2564 Environment variables are expanded |:set_env|.
2565 See |option-backslash| about including spaces and backslashes.
2566 This option cannot be set from a |modeline| or in the |sandbox|, for
2567 security reasons.
2568
2569 *'errorformat'* *'efm'*
2570'errorformat' 'efm' string (default is very long)
2571 global or local to buffer |global-local|
2572 {not in Vi}
2573 {not available when compiled without the |+quickfix|
2574 feature}
2575 Scanf-like description of the format for the lines in the error file
2576 (see |errorformat|).
2577
2578 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2579'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2580 global
2581 {not in Vi}
2582 Function keys that start with an <Esc> are recognized in Insert
2583 mode. When this option is off, the cursor and function keys cannot be
2584 used in Insert mode if they start with an <Esc>. The advantage of
2585 this is that the single <Esc> is recognized immediately, instead of
2586 after one second. Instead of resetting this option, you might want to
2587 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2588 when 'esckeys' is off, you can still map anything, but the cursor keys
2589 won't work by default.
2590 NOTE: This option is set to the Vi default value when 'compatible' is
2591 set and to the Vim default value when 'compatible' is reset.
2592
2593 *'eventignore'* *'ei'*
2594'eventignore' 'ei' string (default "")
2595 global
2596 {not in Vi}
2597 {not available when compiled without the |+autocmd|
2598 feature}
2599 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002600 When set to "all" or when "all" is one of the items, all autocommand
2601 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 Otherwise this is a comma separated list of event names. Example: >
2603 :set ei=WinEnter,WinLeave
2604<
2605 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2606'expandtab' 'et' boolean (default off)
2607 local to buffer
2608 {not in Vi}
2609 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002610 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2612 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2613 NOTE: This option is reset when 'compatible' is set.
2614
2615 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2616'exrc' 'ex' boolean (default off)
2617 global
2618 {not in Vi}
2619 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2620 directory. If you switch this option on you should also consider
2621 setting the 'secure' option (see |initialization|). Using a local
2622 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2623 also see |.vimrc| and |gui-init|.
2624 This option cannot be set from a |modeline| or in the |sandbox|, for
2625 security reasons.
2626
2627 *'fileencoding'* *'fenc'* *E213*
2628'fileencoding' 'fenc' string (default: "")
2629 local to buffer
2630 {only available when compiled with the |+multi_byte|
2631 feature}
2632 {not in Vi}
2633 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002634
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002636 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 When 'fileencoding' is empty, the same value as 'encoding' will be
2638 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002639 Conversion will also be done when 'encoding' and 'fileencoding' are
2640 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2641 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002642 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002643 'encoding' is "utf-8" or another Unicode encoding, conversion
2644 is most likely done in a way that the reverse conversion
2645 results in the same text. When 'encoding' is not "utf-8" some
2646 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002647
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648 See 'encoding' for the possible values. Additionally, values may be
2649 specified that can be handled by the converter, see
2650 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002651
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 When reading a file 'fileencoding' will be set from 'fileencodings'.
2653 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002654 'fileencoding', use the |++enc| argument. One exception: when
2655 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002656 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002657
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2659 When the option is set, the value is converted to lowercase. Thus
2660 you can set it with uppercase values too. '_' characters are
2661 replaced with '-'. If a name is recognized from the list for
2662 'encoding', it is replaced by the standard name. For example
2663 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002664
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 When this option is set, after starting to edit a file, the 'modified'
2666 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002667
2668 Keep in mind that changing 'fenc' from a modeline happens
2669 AFTER the text has been read, thus it applies to when the file will be
2670 written. If you do set 'fenc' in a modeline, you might want to set
2671 'nomodified' to avoid not being able to ":q".
2672
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673 This option can not be changed when 'modifiable' is off.
2674
2675 *'fe'*
2676 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002677 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 old short name was 'fe', which is no longer used.
2679
2680 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002681'fileencodings' 'fencs' string (default: "ucs-bom",
2682 "ucs-bom,utf-8,default,latin1" when
2683 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 global
2685 {only available when compiled with the |+multi_byte|
2686 feature}
2687 {not in Vi}
2688 This is a list of character encodings considered when starting to edit
2689 an existing file. When a file is read, Vim tries to use the first
2690 mentioned character encoding. If an error is detected, the next one
2691 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002692 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693 an empty string, which means the value of 'encoding' is used.
2694 WARNING: Conversion can cause loss of information! When
2695 'encoding' is "utf-8" (or one of the other Unicode variants)
2696 conversion is most likely done in a way that the reverse
2697 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002698 "utf-8" some non-ASCII characters may be lost! You can use
2699 the |++bad| argument to specify what is done with characters
2700 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 For an empty file or a file with only ASCII characters most encodings
2702 will work and the first entry of 'fileencodings' will be used (except
2703 "ucs-bom", which requires the BOM to be present). If you prefer
2704 another encoding use an BufReadPost autocommand event to test if your
2705 preferred encoding is to be used. Example: >
2706 au BufReadPost * if search('\S', 'w') == 0 |
2707 \ set fenc=iso-2022-jp | endif
2708< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2709 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002710 When the |++enc| argument is used then the value of 'fileencodings' is
2711 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002712 Note that 'fileencodings' is not used for a new file, the global value
2713 of 'fileencoding' is used instead. You can set it with: >
2714 :setglobal fenc=iso-8859-2
2715< This means that a non-existing file may get a different encoding than
2716 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717 The special value "ucs-bom" can be used to check for a Unicode BOM
2718 (Byte Order Mark) at the start of the file. It must not be preceded
2719 by "utf-8" or another Unicode encoding for this to work properly.
2720 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2721 because Vim cannot detect an error, thus the encoding is always
2722 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002723 The special value "default" can be used for the encoding from the
2724 environment. This is the default value for 'encoding'. It is useful
2725 when 'encoding' is set to "utf-8" and your environment uses a
2726 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002727 When 'encoding' is "utf-8" and a file contains an illegal byte
2728 sequence it won't be recognized as UTF-8. You can use the |8g8|
2729 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 WRONG VALUES: WHAT'S WRONG:
2731 latin1,utf-8 "latin1" will always be used
2732 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2733 file
2734 cp1250,latin1 "cp1250" will always be used
2735 If 'fileencodings' is empty, 'fileencoding' is not modified.
2736 See 'fileencoding' for the possible values.
2737 Setting this option does not have an effect until the next time a file
2738 is read.
2739
2740 *'fileformat'* *'ff'*
2741'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2742 Unix default: "unix",
2743 Macintosh default: "mac")
2744 local to buffer
2745 {not in Vi}
2746 This gives the <EOL> of the current buffer, which is used for
2747 reading/writing the buffer from/to a file:
2748 dos <CR> <NL>
2749 unix <NL>
2750 mac <CR>
2751 When "dos" is used, CTRL-Z at the end of a file is ignored.
2752 See |file-formats| and |file-read|.
2753 For the character encoding of the file see 'fileencoding'.
2754 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2755 works like it was set to "unix'.
2756 This option is set automatically when starting to edit a file and
2757 'fileformats' is not empty and 'binary' is off.
2758 When this option is set, after starting to edit a file, the 'modified'
2759 option is set, because the file would be different when written.
2760 This option can not be changed when 'modifiable' is off.
2761 For backwards compatibility: When this option is set to "dos",
2762 'textmode' is set, otherwise 'textmode' is reset.
2763
2764 *'fileformats'* *'ffs'*
2765'fileformats' 'ffs' string (default:
2766 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2767 Vim Unix: "unix,dos",
2768 Vim Mac: "mac,unix,dos",
2769 Vi Cygwin: "unix,dos",
2770 Vi others: "")
2771 global
2772 {not in Vi}
2773 This gives the end-of-line (<EOL>) formats that will be tried when
2774 starting to edit a new buffer and when reading a file into an existing
2775 buffer:
2776 - When empty, the format defined with 'fileformat' will be used
2777 always. It is not set automatically.
2778 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002779 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 'fileformats' name will be used when a file is read into an existing
2781 buffer, no matter what 'fileformat' for that buffer is set to.
2782 - When more than one name is present, separated by commas, automatic
2783 <EOL> detection will be done when reading a file. When starting to
2784 edit a file, a check is done for the <EOL>:
2785 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2786 'fileformat' is set to "dos".
2787 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002788 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 preceding <CR>, "unix" is preferred over "dos".
2790 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2791 This means that "mac" is only chosen when "unix" is not present,
2792 or when no <NL> is found in the file, and when "dos" is not
2793 present, or no <CR><NL> is present in the file.
2794 Also if "unix" was first chosen, but the first <CR> is before
2795 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2796 the file, then 'fileformat' is set to "mac".
2797 4. If 'fileformat' is still not set, the first name from
2798 'fileformats' is used.
2799 When reading a file into an existing buffer, the same is done, but
2800 this happens like 'fileformat' has been set appropriately for that
2801 file only, the option is not changed.
2802 When 'binary' is set, the value of 'fileformats' is not used.
2803
2804 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2805 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2806 done:
2807 - When 'fileformats' is empty, there is no automatic detection. Dos
2808 format will be used.
2809 - When 'fileformats' is set to one or more names, automatic detection
2810 is done. This is based on the first <NL> in the file: If there is a
2811 <CR> in front of it, Dos format is used, otherwise Unix format is
2812 used.
2813 Also see |file-formats|.
2814 For backwards compatibility: When this option is set to an empty
2815 string or one format (no comma is included), 'textauto' is reset,
2816 otherwise 'textauto' is set.
2817 NOTE: This option is set to the Vi default value when 'compatible' is
2818 set and to the Vim default value when 'compatible' is reset.
2819
2820 *'filetype'* *'ft'*
2821'filetype' 'ft' string (default: "")
2822 local to buffer
2823 {not in Vi}
2824 {not available when compiled without the |+autocmd|
2825 feature}
2826 When this option is set, the FileType autocommand event is triggered.
2827 All autocommands that match with the value of this option will be
2828 executed. Thus the value of 'filetype' is used in place of the file
2829 name.
2830 Otherwise this option does not always reflect the current file type.
2831 This option is normally set when the file type is detected. To enable
2832 this use the ":filetype on" command. |:filetype|
2833 Setting this option to a different value is most useful in a modeline,
2834 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002835 Example, for in an IDL file:
2836 /* vim: set filetype=idl : */ ~
2837 |FileType| |filetypes|
2838 When a dot appears in the value then this separates two filetype
2839 names. Example:
2840 /* vim: set filetype=c.doxygen : */ ~
2841 This will use the "c" filetype first, then the "doxygen" filetype.
2842 This works both for filetype plugins and for syntax files. More than
2843 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002844 Do not confuse this option with 'osfiletype', which is for the file
2845 type that is actually stored with the file.
2846 This option is not copied to another buffer, independent of the 's' or
2847 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002848 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849
2850 *'fillchars'* *'fcs'*
2851'fillchars' 'fcs' string (default "vert:|,fold:-")
2852 global
2853 {not in Vi}
2854 {not available when compiled without the |+windows|
2855 and |+folding| features}
2856 Characters to fill the statuslines and vertical separators.
2857 It is a comma separated list of items:
2858
2859 item default Used for ~
2860 stl:c ' ' or '^' statusline of the current window
2861 stlnc:c ' ' or '-' statusline of the non-current windows
2862 vert:c '|' vertical separators |:vsplit|
2863 fold:c '-' filling 'foldtext'
2864 diff:c '-' deleted lines of the 'diff' option
2865
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002866 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 "stlnc" the space will be used when there is highlighting, '^' or '-'
2868 otherwise.
2869
2870 Example: >
2871 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2872< This is similar to the default, except that these characters will also
2873 be used when there is highlighting.
2874
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002875 for "stl" and "stlnc" only single-byte values are supported.
2876
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 The highlighting used for these items:
2878 item highlight group ~
2879 stl:c StatusLine |hl-StatusLine|
2880 stlnc:c StatusLineNC |hl-StatusLineNC|
2881 vert:c VertSplit |hl-VertSplit|
2882 fold:c Folded |hl-Folded|
2883 diff:c DiffDelete |hl-DiffDelete|
2884
2885 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2886'fkmap' 'fk' boolean (default off) *E198*
2887 global
2888 {not in Vi}
2889 {only available when compiled with the |+rightleft|
2890 feature}
2891 When on, the keyboard is mapped for the Farsi character set.
2892 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002893 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894
2895 *'foldclose'* *'fcl'*
2896'foldclose' 'fcl' string (default "")
2897 global
2898 {not in Vi}
2899 {not available when compiled without the |+folding|
2900 feature}
2901 When set to "all", a fold is closed when the cursor isn't in it and
2902 its level is higher than 'foldlevel'. Useful if you want folds to
2903 automatically close when moving out of them.
2904
2905 *'foldcolumn'* *'fdc'*
2906'foldcolumn' 'fdc' number (default 0)
2907 local to window
2908 {not in Vi}
2909 {not available when compiled without the |+folding|
2910 feature}
2911 When non-zero, a column with the specified width is shown at the side
2912 of the window which indicates open and closed folds. The maximum
2913 value is 12.
2914 See |folding|.
2915
2916 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2917'foldenable' 'fen' boolean (default on)
2918 local to window
2919 {not in Vi}
2920 {not available when compiled without the |+folding|
2921 feature}
2922 When off, all folds are open. This option can be used to quickly
2923 switch between showing all text unfolded and viewing the text with
2924 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002925 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926 'foldenable' is off.
2927 This option is set by commands that create a new fold or close a fold.
2928 See |folding|.
2929
2930 *'foldexpr'* *'fde'*
2931'foldexpr' 'fde' string (default: "0")
2932 local to window
2933 {not in Vi}
2934 {not available when compiled without the |+folding|
2935 or |+eval| feature}
2936 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002937 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002938
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002939 The expression may be evaluated in the |sandbox|, see
2940 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002941 This option can't be set from a |modeline| when the 'diff' option is
2942 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002943
2944 It is not allowed to change text or jump to another window while
2945 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946
2947 *'foldignore'* *'fdi'*
2948'foldignore' 'fdi' string (default: "#")
2949 local to window
2950 {not in Vi}
2951 {not available when compiled without the |+folding|
2952 feature}
2953 Used only when 'foldmethod' is "indent". Lines starting with
2954 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002955 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 The default "#" works well for C programs. See |fold-indent|.
2957
2958 *'foldlevel'* *'fdl'*
2959'foldlevel' 'fdl' number (default: 0)
2960 local to window
2961 {not in Vi}
2962 {not available when compiled without the |+folding|
2963 feature}
2964 Sets the fold level: Folds with a higher level will be closed.
2965 Setting this option to zero will close all folds. Higher numbers will
2966 close fewer folds.
2967 This option is set by commands like |zm|, |zM| and |zR|.
2968 See |fold-foldlevel|.
2969
2970 *'foldlevelstart'* *'fdls'*
2971'foldlevelstart' 'fdls' number (default: -1)
2972 global
2973 {not in Vi}
2974 {not available when compiled without the |+folding|
2975 feature}
2976 Sets 'foldlevel' when starting to edit another buffer in a window.
2977 Useful to always start editing with all folds closed (value zero),
2978 some folds closed (one) or no folds closed (99).
2979 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002980 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 ignores this option and closes all folds.
2982 It is also done before BufReadPre autocommands, to allow an autocmd to
2983 overrule the 'foldlevel' value for specific files.
2984 When the value is negative, it is not used.
2985
2986 *'foldmarker'* *'fmr'* *E536*
2987'foldmarker' 'fmr' string (default: "{{{,}}}")
2988 local to window
2989 {not in Vi}
2990 {not available when compiled without the |+folding|
2991 feature}
2992 The start and end marker used when 'foldmethod' is "marker". There
2993 must be one comma, which separates the start and end marker. The
2994 marker is a literal string (a regular expression would be too slow).
2995 See |fold-marker|.
2996
2997 *'foldmethod'* *'fdm'*
2998'foldmethod' 'fdm' string (default: "manual")
2999 local to window
3000 {not in Vi}
3001 {not available when compiled without the |+folding|
3002 feature}
3003 The kind of folding used for the current window. Possible values:
3004 |fold-manual| manual Folds are created manually.
3005 |fold-indent| indent Lines with equal indent form a fold.
3006 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3007 |fold-marker| marker Markers are used to specify folds.
3008 |fold-syntax| syntax Syntax highlighting items specify folds.
3009 |fold-diff| diff Fold text that is not changed.
3010
3011 *'foldminlines'* *'fml'*
3012'foldminlines' 'fml' number (default: 1)
3013 local to window
3014 {not in Vi}
3015 {not available when compiled without the |+folding|
3016 feature}
3017 Sets the minimum number of screen lines for a fold to be displayed
3018 closed. Also for manually closed folds.
3019 Note that this only has an effect of what is displayed. After using
3020 "zc" to close a fold, which is displayed open because it's smaller
3021 than 'foldminlines', a following "zc" may close a containing fold.
3022
3023 *'foldnestmax'* *'fdn'*
3024'foldnestmax' 'fdn' number (default: 20)
3025 local to window
3026 {not in Vi}
3027 {not available when compiled without the |+folding|
3028 feature}
3029 Sets the maximum nesting of folds for the "indent" and "syntax"
3030 methods. This avoids that too many folds will be created. Using more
3031 than 20 doesn't work, because the internal limit is 20.
3032
3033 *'foldopen'* *'fdo'*
3034'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3035 search,tag,undo")
3036 global
3037 {not in Vi}
3038 {not available when compiled without the |+folding|
3039 feature}
3040 Specifies for which type of commands folds will be opened, if the
3041 command moves the cursor into a closed fold. It is a comma separated
3042 list of items.
3043 item commands ~
3044 all any
3045 block "(", "{", "[[", "[{", etc.
3046 hor horizontal movements: "l", "w", "fx", etc.
3047 insert any command in Insert mode
3048 jump far jumps: "G", "gg", etc.
3049 mark jumping to a mark: "'m", CTRL-O, etc.
3050 percent "%"
3051 quickfix ":cn", ":crew", ":make", etc.
3052 search search for a pattern: "/", "n", "*", "gd", etc.
3053 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003054 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 tag jumping to a tag: ":ta", CTRL-T, etc.
3056 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003057 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058 the |zv| command to the mapping to get the same effect.
3059 When a movement command is used for an operator (e.g., "dl" or "y%")
3060 this option is not used. This means the operator will include the
3061 whole closed fold.
3062 Note that vertical movements are not here, because it would make it
3063 very difficult to move onto a closed fold.
3064 In insert mode the folds containing the cursor will always be open
3065 when text is inserted.
3066 To close folds you can re-apply 'foldlevel' with the |zx| command or
3067 set the 'foldclose' option to "all".
3068
3069 *'foldtext'* *'fdt'*
3070'foldtext' 'fdt' string (default: "foldtext()")
3071 local to window
3072 {not in Vi}
3073 {not available when compiled without the |+folding|
3074 feature}
3075 An expression which is used to specify the text displayed for a closed
3076 fold. See |fold-foldtext|.
3077
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003078 The expression may be evaluated in the |sandbox|, see
3079 |sandbox-option|.
3080
3081 It is not allowed to change text or jump to another window while
3082 evaluating 'foldtext' |textlock|.
3083
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 *'formatoptions'* *'fo'*
3085'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3086 local to buffer
3087 {not in Vi}
3088 This is a sequence of letters which describes how automatic
3089 formatting is to be done. See |fo-table|. When the 'paste' option is
3090 on, no formatting is done (like 'formatoptions' is empty). Commas can
3091 be inserted for readability.
3092 To avoid problems with flags that are added in the future, use the
3093 "+=" and "-=" feature of ":set" |add-option-flags|.
3094 NOTE: This option is set to the Vi default value when 'compatible' is
3095 set and to the Vim default value when 'compatible' is reset.
3096
Bram Moolenaar86b68352004-12-27 21:59:20 +00003097 *'formatlistpat'* *'flp'*
3098'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3099 local to buffer
3100 {not in Vi}
3101 A pattern that is used to recognize a list header. This is used for
3102 the "n" flag in 'formatoptions'.
3103 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003104 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003105 while still checking more characters. There must be a character
3106 following the pattern, when it matches the whole line it is handled
3107 like there is no match.
3108 The default recognizes a number, followed by an optional punctuation
3109 character and white space.
3110
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 *'formatprg'* *'fp'*
3112'formatprg' 'fp' string (default "")
3113 global
3114 {not in Vi}
3115 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003116 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003118 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003119 If the 'formatexpr' option is not empty it will be used instead.
3120 Otherwise, if 'formatprg' option is an empty string, the internal
3121 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003122 Environment variables are expanded |:set_env|. See |option-backslash|
3123 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003124 The expression may be evaluated in the |sandbox|, see
3125 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003127 *'formatexpr'* *'fex'*
3128'formatexpr' 'fex' string (default "")
3129 local to buffer
3130 {not in Vi}
3131 {not available when compiled without the |+eval|
3132 feature}
3133 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003134 operator or automatic formatting (see 'formatoptions'). When this
3135 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003136
3137 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003138 The |v:count| variable holds the number of lines to be formatted.
3139 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003140 inserted if the expression is being evaluated due to
3141 automatic formatting. This can be empty. Don't insert
3142 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003143
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003144 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003145 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003146< This will invoke the mylang#Format() function in the
3147 autoload/mylang.vim file in 'runtimepath'. |autoload|
3148
3149 The expression is also evaluated when 'textwidth' is set and adding
3150 text beyond that limit. This happens under the same conditions as
3151 when internal formatting is used. Make sure the cursor is kept in the
3152 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003153 return "i" or "R" in this situation.
3154
3155 When the expression evaluates to non-zero Vim will fall back to using
3156 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003157
3158 The expression may be evaluated in the |sandbox|, see
3159 |sandbox-option|.
3160
3161 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003162'fsync' 'fs' boolean (default on)
3163 global
3164 {not in Vi}
3165 When on, the library function fsync() will be called after writing a
3166 file. This will flush a file to disk, ensuring that it is safely
3167 written even on filesystems which do metadata-only journaling. This
3168 will force the harddrive to spin up on Linux systems running in laptop
3169 mode, so it may be undesirable in some situations. Be warned that
3170 turning this off increases the chances of data loss after a crash. On
3171 systems without an fsync() implementation, this variable is always
3172 off.
3173 Also see 'swapsync' for controlling fsync() on swap files.
3174
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3176'gdefault' 'gd' boolean (default off)
3177 global
3178 {not in Vi}
3179 When on, the ":substitute" flag 'g' is default on. This means that
3180 all matches in a line are substituted instead of one. When a 'g' flag
3181 is given to a ":substitute" command, this will toggle the substitution
3182 of all or one match. See |complex-change|.
3183
3184 command 'gdefault' on 'gdefault' off ~
3185 :s/// subst. all subst. one
3186 :s///g subst. one subst. all
3187 :s///gg subst. all subst. one
3188
3189 NOTE: This option is reset when 'compatible' is set.
3190
3191 *'grepformat'* *'gfm'*
3192'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3193 global
3194 {not in Vi}
3195 Format to recognize for the ":grep" command output.
3196 This is a scanf-like string that uses the same format as the
3197 'errorformat' option: see |errorformat|.
3198
3199 *'grepprg'* *'gp'*
3200'grepprg' 'gp' string (default "grep -n ",
3201 Unix: "grep -n $* /dev/null",
3202 Win32: "findstr /n" or "grep -n",
3203 VMS: "SEARCH/NUMBERS ")
3204 global or local to buffer |global-local|
3205 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003206 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 and '#' characters, which are expanded like when used in a command-
3208 line. The placeholder "$*" is allowed to specify where the arguments
3209 will be included. Environment variables are expanded |:set_env|. See
3210 |option-backslash| about including spaces and backslashes.
3211 When your "grep" accepts the "-H" argument, use this to make ":grep"
3212 also work well with a single file: >
3213 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003214< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003215 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3216 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003217 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 apply equally to 'grepprg'.
3219 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3220 otherwise it's "grep -n".
3221 This option cannot be set from a |modeline| or in the |sandbox|, for
3222 security reasons.
3223
3224 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3225'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3226 ve:ver35-Cursor,
3227 o:hor50-Cursor,
3228 i-ci:ver25-Cursor/lCursor,
3229 r-cr:hor20-Cursor/lCursor,
3230 sm:block-Cursor
3231 -blinkwait175-blinkoff150-blinkon175",
3232 for MS-DOS and Win32 console:
3233 "n-v-c:block,o:hor50,i-ci:hor15,
3234 r-cr:hor30,sm:block")
3235 global
3236 {not in Vi}
3237 {only available when compiled with GUI enabled, and
3238 for MS-DOS and Win32 console}
3239 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003240 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 the height of the cursor can be changed. This can be done by
3242 specifying a block cursor, or a percentage for a vertical or
3243 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003244 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003246 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 mode-list and an argument-list:
3248 mode-list:argument-list,mode-list:argument-list,..
3249 The mode-list is a dash separated list of these modes:
3250 n Normal mode
3251 v Visual mode
3252 ve Visual mode with 'selection' "exclusive" (same as 'v',
3253 if not specified)
3254 o Operator-pending mode
3255 i Insert mode
3256 r Replace mode
3257 c Command-line Normal (append) mode
3258 ci Command-line Insert mode
3259 cr Command-line Replace mode
3260 sm showmatch in Insert mode
3261 a all modes
3262 The argument-list is a dash separated list of these arguments:
3263 hor{N} horizontal bar, {N} percent of the character height
3264 ver{N} vertical bar, {N} percent of the character width
3265 block block cursor, fills the whole character
3266 [only one of the above three should be present]
3267 blinkwait{N} *cursor-blinking*
3268 blinkon{N}
3269 blinkoff{N}
3270 blink times for cursor: blinkwait is the delay before
3271 the cursor starts blinking, blinkon is the time that
3272 the cursor is shown and blinkoff is the time that the
3273 cursor is not shown. The times are in msec. When one
3274 of the numbers is zero, there is no blinking. The
3275 default is: "blinkwait700-blinkon400-blinkoff250".
3276 These numbers are used for a missing entry. This
3277 means that blinking is enabled by default. To switch
3278 blinking off you can use "blinkon0". The cursor only
3279 blinks when Vim is waiting for input, not while
3280 executing a command.
3281 To make the cursor blink in an xterm, see
3282 |xterm-blink|.
3283 {group-name}
3284 a highlight group name, that sets the color and font
3285 for the cursor
3286 {group-name}/{group-name}
3287 Two highlight group names, the first is used when
3288 no language mappings are used, the other when they
3289 are. |language-mapping|
3290
3291 Examples of parts:
3292 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3293 block cursor with colors from the "nCursor"
3294 highlight group
3295 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3296 In Insert and Command-line Insert mode, use a
3297 30% vertical bar cursor with colors from the
3298 "iCursor" highlight group. Blink a bit
3299 faster.
3300
3301 The 'a' mode is different. It will set the given argument-list for
3302 all modes. It does not reset anything to defaults. This can be used
3303 to do a common setting for all modes. For example, to switch off
3304 blinking: "a:blinkon0"
3305
3306 Examples of cursor highlighting: >
3307 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3308 :highlight Cursor gui=NONE guifg=bg guibg=fg
3309<
3310 *'guifont'* *'gfn'*
3311 *E235* *E596* *E610* *E611*
3312'guifont' 'gfn' string (default "")
3313 global
3314 {not in Vi}
3315 {only available when compiled with GUI enabled}
3316 This is a list of fonts which will be used for the GUI version of Vim.
3317 In its simplest form the value is just one font name. When
3318 the font cannot be found you will get an error message. To try other
3319 font names a list can be specified, font names separated with commas.
3320 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003321
Bram Moolenaar05159a02005-02-26 23:04:13 +00003322 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3323 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003324
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 Spaces after a comma are ignored. To include a comma in a font name
3326 precede it with a backslash. Setting an option requires an extra
3327 backslash before a space and a backslash. See also
3328 |option-backslash|. For example: >
3329 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003330< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003332
3333 If none of the fonts can be loaded, Vim will keep the current setting.
3334 If an empty font list is given, Vim will try using other resource
3335 settings (for X, it will use the Vim.font resource), and finally it
3336 will try some builtin default which should always be there ("7x13" in
3337 the case of X). The font names given should be "normal" fonts. Vim
3338 will try to find the related bold and italic fonts.
3339
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003340 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003341 :set guifont=*
3342< will bring up a font requester, where you can pick the font you want.
3343
3344 The font name depends on the GUI used. See |setting-guifont| for a
3345 way to set 'guifont' for various systems.
3346
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 For the GTK+ 2 GUI the font name looks like this: >
3348 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003349< That's all. XLFDs are not used. For Chinese this is reported to work
3350 well: >
3351 if has("gui_gtk2")
3352 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3353 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3354 endif
3355<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003356 For Mac OSX you can use something like this: >
3357 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003358< Also see 'macatsui', it can help fix display problems.
3359 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003361 width). An exception is GTK 2: all fonts are accepted, but
3362 mono-spaced fonts look best.
3363
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 To preview a font on X11, you might be able to use the "xfontsel"
3365 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003366
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 For the Win32 GUI *E244* *E245*
3368 - takes these options in the font name:
3369 hXX - height is XX (points, can be floating-point)
3370 wXX - width is XX (points, can be floating-point)
3371 b - bold
3372 i - italic
3373 u - underline
3374 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003375 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3377 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3378 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003379 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380
3381 Use a ':' to separate the options.
3382 - A '_' can be used in the place of a space, so you don't need to use
3383 backslashes to escape the spaces.
3384 - Examples: >
3385 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3386 :set guifont=Andale_Mono:h7.5:w4.5
3387< See also |font-sizes|.
3388
3389 *'guifontset'* *'gfs'*
3390 *E250* *E252* *E234* *E597* *E598*
3391'guifontset' 'gfs' string (default "")
3392 global
3393 {not in Vi}
3394 {only available when compiled with GUI enabled and
3395 with the |+xfontset| feature}
3396 {not available in the GTK+ 2 GUI}
3397 When not empty, specifies two (or more) fonts to be used. The first
3398 one for normal English, the second one for your special language. See
3399 |xfontset|.
3400 Setting this option also means that all font names will be handled as
3401 a fontset name. Also the ones used for the "font" argument of the
3402 |:highlight| command.
3403 The fonts must match with the current locale. If fonts for the
3404 character sets that the current locale uses are not included, setting
3405 'guifontset' will fail.
3406 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3407 the comma-separated names are alternative names, one of which will be
3408 used. In 'guifontset' the whole string is one fontset name,
3409 including the commas. It is not possible to specify alternative
3410 fontset names.
3411 This example works on many X11 systems: >
3412 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3413<
3414 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3415'guifontwide' 'gfw' string (default "")
3416 global
3417 {not in Vi}
3418 {only available when compiled with GUI enabled}
3419 When not empty, specifies a comma-separated list of fonts to be used
3420 for double-width characters. The first font that can be loaded is
3421 used.
3422 Note: The size of these fonts must be exactly twice as wide as the one
3423 specified with 'guifont' and the same height.
3424
3425 All GUI versions but GTK+ 2:
3426
3427 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3428 'guifontset' is empty or invalid.
3429 When 'guifont' is set and a valid font is found in it and
3430 'guifontwide' is empty Vim will attempt to find a matching
3431 double-width font and set 'guifontwide' to it.
3432
3433 GTK+ 2 GUI only: *guifontwide_gtk2*
3434
3435 If set and valid, 'guifontwide' is always used for double width
3436 characters, even if 'encoding' is not set to "utf-8".
3437 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003438 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 font for characters not available in 'guifont'. Thus you do not need
3440 to set 'guifontwide' at all unless you want to override the choice
3441 made by Pango/Xft.
3442
3443 *'guiheadroom'* *'ghr'*
3444'guiheadroom' 'ghr' number (default 50)
3445 global
3446 {not in Vi} {only for GTK and X11 GUI}
3447 The number of pixels subtracted from the screen height when fitting
3448 the GUI window on the screen. Set this before the GUI is started,
3449 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003450 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 lines will be left for window decorations and other items on the
3452 screen. Set it to a negative value to allow windows taller than the
3453 screen.
3454
3455 *'guioptions'* *'go'*
3456'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003457 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458 global
3459 {not in Vi}
3460 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003461 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462 sequence of letters which describes what components and options of the
3463 GUI should be used.
3464 To avoid problems with flags that are added in the future, use the
3465 "+=" and "-=" feature of ":set" |add-option-flags|.
3466
3467 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003468 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 'a' Autoselect: If present, then whenever VISUAL mode is started,
3470 or the Visual area extended, Vim tries to become the owner of
3471 the windowing system's global selection. This means that the
3472 Visually highlighted text is available for pasting into other
3473 applications as well as into Vim itself. When the Visual mode
3474 ends, possibly due to an operation on the text, or when an
3475 application wants to paste the selection, the highlighted text
3476 is automatically yanked into the "* selection register.
3477 Thus the selection is still available for pasting into other
3478 applications after the VISUAL mode has ended.
3479 If not present, then Vim won't become the owner of the
3480 windowing system's global selection unless explicitly told to
3481 by a yank or delete operation for the "* register.
3482 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003483 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003484 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 applies to the modeless selection.
3486
3487 'guioptions' autoselect Visual autoselect modeless ~
3488 "" - -
3489 "a" yes yes
3490 "A" - yes
3491 "aA" yes yes
3492
Bram Moolenaar02467872007-05-06 13:22:01 +00003493 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 'c' Use console dialogs instead of popup dialogs for simple
3495 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003496 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003497 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003498 'guitablabel' can be used to change the text in the labels.
3499 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003500 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003501 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003502 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 'f' Foreground: Don't use fork() to detach the GUI from the shell
3504 where it was started. Use this for programs that wait for the
3505 editor to finish (e.g., an e-mail program). Alternatively you
3506 can use "gvim -f" or ":gui -f" to start the GUI in the
3507 foreground. |gui-fork|
3508 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003509 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003510 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3512 corner of the window. It's black&white on non-GTK, because of
3513 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003514 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003516 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003517 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003519 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 file is sourced the system menu has already been loaded; the
3521 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003522 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523 'g' Grey menu items: Make menu items that are not active grey. If
3524 'g' is not included inactive menu items are not shown at all.
3525 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003526 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 't' Include tearoff menu items. Currently only works for Win32,
3528 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003529 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003530 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003531 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003532 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003534 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 'R' Right-hand scrollbar is present when there is a vertically
3536 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003537 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003539 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 'L' Left-hand scrollbar is present when there is a vertically
3541 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003542 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3544 the longest visible line, or on the cursor line if the 'h'
3545 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003546 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 'h' Limit horizontal scrollbar size to the length of the cursor
3548 line. Reduces computations. |gui-horiz-scroll|
3549
3550 And yes, you may even have scrollbars on the left AND the right if
3551 you really want to :-). See |gui-scrollbars| for more information.
3552
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003553 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554 'v' Use a vertical button layout for dialogs. When not included,
3555 a horizontal layout is preferred, but when it doesn't fit a
3556 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003557 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 'p' Use Pointer callbacks for X11 GUI. This is required for some
3559 window managers. If the cursor is not blinking or hollow at
3560 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003561 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003563 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003564 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003565
Bram Moolenaar02467872007-05-06 13:22:01 +00003566
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 *'guipty'* *'noguipty'*
3568'guipty' boolean (default on)
3569 global
3570 {not in Vi}
3571 {only available when compiled with GUI enabled}
3572 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3573 I/O to/from shell commands. See |gui-pty|.
3574
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003575 *'guitablabel'* *'gtl'*
3576'guitablabel' 'gtl' string (default empty)
3577 global
3578 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003579 {only available when compiled with GUI enabled and
3580 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003581 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003582 pages line. When empty and when the result is empty Vim will use a
3583 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003584
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003585 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003586 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003587
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003588 Only used when the GUI tab pages line is displayed. 'e' must be
3589 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3590 used.
3591
Bram Moolenaar57657d82006-04-21 22:12:41 +00003592 *'guitabtooltip'* *'gtt'*
3593'guitabtooltip' 'gtt' string (default empty)
3594 global
3595 {not in Vi}
3596 {only available when compiled with GUI enabled and
3597 with the +windows feature}
3598 When nonempty describes the text to use in a tooltip for the GUI tab
3599 pages line. When empty Vim will use a default tooltip.
3600 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003601 You can include a line break. Simplest method is to use |:let|: >
3602 :let &guitabtooltip = "line one\nline two"
3603<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003604
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 *'helpfile'* *'hf'*
3606'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3607 (others) "$VIMRUNTIME/doc/help.txt")
3608 global
3609 {not in Vi}
3610 Name of the main help file. All distributed help files should be
3611 placed together in one directory. Additionally, all "doc" directories
3612 in 'runtimepath' will be used.
3613 Environment variables are expanded |:set_env|. For example:
3614 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003615 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 spaces and backslashes.
3617 This option cannot be set from a |modeline| or in the |sandbox|, for
3618 security reasons.
3619
3620 *'helpheight'* *'hh'*
3621'helpheight' 'hh' number (default 20)
3622 global
3623 {not in Vi}
3624 {not available when compiled without the +windows
3625 feature}
3626 Minimal initial height of the help window when it is opened with the
3627 ":help" command. The initial height of the help window is half of the
3628 current window, or (when the 'ea' option is on) the same as other
3629 windows. When the height is less than 'helpheight', the height is
3630 set to 'helpheight'. Set to zero to disable.
3631
3632 *'helplang'* *'hlg'*
3633'helplang' 'hlg' string (default: messages language or empty)
3634 global
3635 {only available when compiled with the |+multi_lang|
3636 feature}
3637 {not in Vi}
3638 Comma separated list of languages. Vim will use the first language
3639 for which the desired help can be found. The English help will always
3640 be used as a last resort. You can add "en" to prefer English over
3641 another language, but that will only find tags that exist in that
3642 language and not in the English help.
3643 Example: >
3644 :set helplang=de,it
3645< This will first search German, then Italian and finally English help
3646 files.
3647 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3648 try to find the tag in the current language before using this option.
3649 See |help-translated|.
3650
3651 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3652'hidden' 'hid' boolean (default off)
3653 global
3654 {not in Vi}
3655 When off a buffer is unloaded when it is |abandon|ed. When on a
3656 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3657 displayed in another window, it does not become hidden, of course.
3658 The commands that move through the buffer list sometimes make a buffer
3659 hidden although the 'hidden' option is off: When the buffer is
3660 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003661 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003662 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 This option is set for one command with ":hide {command}" |:hide|.
3664 WARNING: It's easy to forget that you have changes in hidden buffers.
3665 Think twice when using ":q!" or ":qa!".
3666
3667 *'highlight'* *'hl'*
3668'highlight' 'hl' string (default (as a single string):
3669 "8:SpecialKey,@:NonText,d:Directory,
3670 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3671 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003672 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3674 f:Folded,F:FoldColumn,A:DiffAdd,
3675 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003676 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003677 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003678 +:Pmenu,=:PmenuSel,
3679 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 global
3681 {not in Vi}
3682 This option can be used to set highlighting mode for various
3683 occasions. It is a comma separated list of character pairs. The
3684 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003685 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3687 |hl-NonText| @ '~' and '@' at the end of the window and
3688 characters from 'showbreak'
3689 |hl-Directory| d directories in CTRL-D listing and other special
3690 things in listings
3691 |hl-ErrorMsg| e error messages
3692 h (obsolete, ignored)
3693 |hl-IncSearch| i 'incsearch' highlighting
3694 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3695 |hl-MoreMsg| m |more-prompt|
3696 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003697 |hl-LineNr| n line number for ":number" and ":#" commands, and
3698 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 |hl-Question| r |hit-enter| prompt and yes/no questions
3700 |hl-StatusLine| s status line of current window |status-line|
3701 |hl-StatusLineNC| S status lines of not-current windows
3702 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3703 |hl-VertSplit| c column used to separate vertically split windows
3704 |hl-Visual| v Visual mode
3705 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3706 Selection" Only X11 Gui's |gui-x11| and
3707 |xterm-clipboard|.
3708 |hl-WarningMsg| w warning messages
3709 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3710 |hl-Folded| f line used for closed folds
3711 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003712 |hl-DiffAdd| A added line in diff mode
3713 |hl-DiffChange| C changed line in diff mode
3714 |hl-DiffDelete| D deleted line in diff mode
3715 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003717 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003718 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003719 |hl-SpellRare| R rare word |spell|
3720 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003721 |hl-Conceal| - the placeholders used for concealed characters
3722 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003723 |hl-Pmenu| + popup menu normal line
3724 |hl-PmenuSel| = popup menu normal line
3725 |hl-PmenuSbar| x popup menu scrollbar
3726 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727
3728 The display modes are:
3729 r reverse (termcap entry "mr" and "me")
3730 i italic (termcap entry "ZH" and "ZR")
3731 b bold (termcap entry "md" and "me")
3732 s standout (termcap entry "so" and "se")
3733 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003734 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 n no highlighting
3736 - no highlighting
3737 : use a highlight group
3738 The default is used for occasions that are not included.
3739 If you want to change what the display modes do, see |dos-colors|
3740 for an example.
3741 When using the ':' display mode, this must be followed by the name of
3742 a highlight group. A highlight group can be used to define any type
3743 of highlighting, including using color. See |:highlight| on how to
3744 define one. The default uses a different group for each occasion.
3745 See |highlight-default| for the default highlight groups.
3746
3747 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3748'hlsearch' 'hls' boolean (default off)
3749 global
3750 {not in Vi}
3751 {not available when compiled without the
3752 |+extra_search| feature}
3753 When there is a previous search pattern, highlight all its matches.
3754 The type of highlighting used can be set with the 'l' occasion in the
3755 'highlight' option. This uses the "Search" highlight group by
3756 default. Note that only the matching text is highlighted, any offsets
3757 are not applied.
3758 See also: 'incsearch' and |:match|.
3759 When you get bored looking at the highlighted matches, you can turn it
3760 off with |:nohlsearch|. As soon as you use a search command, the
3761 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003762 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 When the search pattern can match an end-of-line, Vim will try to
3764 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003765 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003767 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 NOTE: This option is reset when 'compatible' is set.
3769
3770 *'history'* *'hi'*
3771'history' 'hi' number (Vim default: 20, Vi default: 0)
3772 global
3773 {not in Vi}
3774 A history of ":" commands, and a history of previous search patterns
3775 are remembered. This option decides how many entries may be stored in
3776 each of these histories (see |cmdline-editing|).
3777 NOTE: This option is set to the Vi default value when 'compatible' is
3778 set and to the Vim default value when 'compatible' is reset.
3779
3780 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3781'hkmap' 'hk' boolean (default off)
3782 global
3783 {not in Vi}
3784 {only available when compiled with the |+rightleft|
3785 feature}
3786 When on, the keyboard is mapped for the Hebrew character set.
3787 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3788 toggle this option. See |rileft.txt|.
3789 NOTE: This option is reset when 'compatible' is set.
3790
3791 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3792'hkmapp' 'hkp' boolean (default off)
3793 global
3794 {not in Vi}
3795 {only available when compiled with the |+rightleft|
3796 feature}
3797 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3798 This is useful if you have a non-Hebrew keyboard.
3799 See |rileft.txt|.
3800 NOTE: This option is reset when 'compatible' is set.
3801
3802 *'icon'* *'noicon'*
3803'icon' boolean (default off, on when title can be restored)
3804 global
3805 {not in Vi}
3806 {not available when compiled without the |+title|
3807 feature}
3808 When on, the icon text of the window will be set to the value of
3809 'iconstring' (if it is not empty), or to the name of the file
3810 currently being edited. Only the last part of the name is used.
3811 Overridden by the 'iconstring' option.
3812 Only works if the terminal supports setting window icons (currently
3813 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3814 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3815 builtin termcap).
3816 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003817 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 X11.
3819
3820 *'iconstring'*
3821'iconstring' string (default "")
3822 global
3823 {not in Vi}
3824 {not available when compiled without the |+title|
3825 feature}
3826 When this option is not empty, it will be used for the icon text of
3827 the window. This happens only when the 'icon' option is on.
3828 Only works if the terminal supports setting window icon text
3829 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3830 Does not work for MS Windows.
3831 When Vim was compiled with HAVE_X11 defined, the original icon will be
3832 restored if possible |X11|.
3833 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003834 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 'titlestring' for example settings.
3836 {not available when compiled without the |+statusline| feature}
3837
3838 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3839'ignorecase' 'ic' boolean (default off)
3840 global
3841 Ignore case in search patterns. Also used when searching in the tags
3842 file.
3843 Also see 'smartcase'.
3844 Can be overruled by using "\c" or "\C" in the pattern, see
3845 |/ignorecase|.
3846
3847 *'imactivatekey'* *'imak'*
3848'imactivatekey' 'imak' string (default "")
3849 global
3850 {not in Vi}
3851 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003852 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 Specifies the key that your Input Method in X-Windows uses for
3854 activation. When this is specified correctly, vim can fully control
3855 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3856 You can't use this option to change the activation key, the option
3857 tells Vim what the key is.
3858 Format:
3859 [MODIFIER_FLAG-]KEY_STRING
3860
3861 These characters can be used for MODIFIER_FLAG (case is ignored):
3862 S Shift key
3863 L Lock key
3864 C Control key
3865 1 Mod1 key
3866 2 Mod2 key
3867 3 Mod3 key
3868 4 Mod4 key
3869 5 Mod5 key
3870 Combinations are allowed, for example "S-C-space" or "SC-space" are
3871 both shift+ctrl+space.
3872 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3873
3874 Example: >
3875 :set imactivatekey=S-space
3876< "S-space" means shift+space. This is the activation key for kinput2 +
3877 canna (Japanese), and ami (Korean).
3878
3879 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3880'imcmdline' 'imc' boolean (default off)
3881 global
3882 {not in Vi}
3883 {only available when compiled with the |+xim|
3884 |+multi_byte_ime| or |global-ime| feature}
3885 When set the Input Method is always on when starting to edit a command
3886 line, unless entering a search pattern (see 'imsearch' for that).
3887 Setting this option is useful when your input method allows entering
3888 English characters directly, e.g., when it's used to type accented
3889 characters with dead keys.
3890
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003891 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003892'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3893 global
3894 {not in Vi}
3895 {only available when compiled with the |+xim|
3896 |+multi_byte_ime| or |global-ime| feature}
3897 When set the Input Method is never used. This is useful to disable
3898 the IM when it doesn't work properly.
3899 Currently this option is on by default for SGI/IRIX machines. This
3900 may change in later releases.
3901
3902 *'iminsert'* *'imi'*
3903'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3904 local to buffer
3905 {not in Vi}
3906 Specifies whether :lmap or an Input Method (IM) is to be used in
3907 Insert mode. Valid values:
3908 0 :lmap is off and IM is off
3909 1 :lmap is ON and IM is off
3910 2 :lmap is off and IM is ON
3911 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3912 or |global-ime|.
3913 To always reset the option to zero when leaving Insert mode with <Esc>
3914 this can be used: >
3915 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3916< This makes :lmap and IM turn off automatically when leaving Insert
3917 mode.
3918 Note that this option changes when using CTRL-^ in Insert mode
3919 |i_CTRL-^|.
3920 The value is set to 1 when setting 'keymap' to a valid keymap name.
3921 It is also used for the argument of commands like "r" and "f".
3922 The value 0 may not work correctly with Athena and Motif with some XIM
3923 methods. Use 'imdisable' to disable XIM then.
3924
3925 *'imsearch'* *'ims'*
3926'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3927 local to buffer
3928 {not in Vi}
3929 Specifies whether :lmap or an Input Method (IM) is to be used when
3930 entering a search pattern. Valid values:
3931 -1 the value of 'iminsert' is used, makes it look like
3932 'iminsert' is also used when typing a search pattern
3933 0 :lmap is off and IM is off
3934 1 :lmap is ON and IM is off
3935 2 :lmap is off and IM is ON
3936 Note that this option changes when using CTRL-^ in Command-line mode
3937 |c_CTRL-^|.
3938 The value is set to 1 when it is not -1 and setting the 'keymap'
3939 option to a valid keymap name.
3940 The value 0 may not work correctly with Athena and Motif with some XIM
3941 methods. Use 'imdisable' to disable XIM then.
3942
3943 *'include'* *'inc'*
3944'include' 'inc' string (default "^\s*#\s*include")
3945 global or local to buffer |global-local|
3946 {not in Vi}
3947 {not available when compiled without the
3948 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003949 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 pattern, just like for the "/" command (See |pattern|). The default
3951 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003952 "]I", "[d", etc.
3953 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003954 comes after the matched pattern. But if "\zs" appears in the pattern
3955 then the text matched from "\zs" to the end, or until "\ze" if it
3956 appears, is used as the file name. Use this to include characters
3957 that are not in 'isfname', such as a space. You can then use
3958 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003959 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960
3961 *'includeexpr'* *'inex'*
3962'includeexpr' 'inex' string (default "")
3963 local to buffer
3964 {not in Vi}
3965 {not available when compiled without the
3966 |+find_in_path| or |+eval| feature}
3967 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003968 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 :set includeexpr=substitute(v:fname,'\\.','/','g')
3970< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003971
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003973 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974 Also used for |<cfile>|.
3975
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003976 The expression may be evaluated in the |sandbox|, see
3977 |sandbox-option|.
3978
3979 It is not allowed to change text or jump to another window while
3980 evaluating 'includeexpr' |textlock|.
3981
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3983'incsearch' 'is' boolean (default off)
3984 global
3985 {not in Vi}
3986 {not available when compiled without the
3987 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003988 While typing a search command, show where the pattern, as it was typed
3989 so far, matches. The matched string is highlighted. If the pattern
3990 is invalid or not found, nothing is shown. The screen will be updated
3991 often, this is only useful on fast terminals.
3992 Note that the match will be shown, but the cursor will return to its
3993 original position when no match is found and when pressing <Esc>. You
3994 still need to finish the search command with <Enter> to move the
3995 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003996 When compiled with the |+reltime| feature Vim only searches for about
3997 half a second. With a complicated pattern and/or a lot of text the
3998 match may not be found. This is to avoid that Vim hangs while you
3999 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004000 The highlighting can be set with the 'i' flag in 'highlight'.
4001 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004002 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004003 to the command line. If 'ignorecase' and 'smartcase' are set and the
4004 command line has no uppercase characters, the added character is
4005 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004006 CTRL-R CTRL-W can be used to add the word at the end of the current
4007 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 NOTE: This option is reset when 'compatible' is set.
4009
4010 *'indentexpr'* *'inde'*
4011'indentexpr' 'inde' string (default "")
4012 local to buffer
4013 {not in Vi}
4014 {not available when compiled without the |+cindent|
4015 or |+eval| features}
4016 Expression which is evaluated to obtain the proper indent for a line.
4017 It is used when a new line is created, for the |=| operator and
4018 in Insert mode as specified with the 'indentkeys' option.
4019 When this option is not empty, it overrules the 'cindent' and
4020 'smartindent' indenting.
4021 When 'paste' is set this option is not used for indenting.
4022 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004023 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024 when the expression is evaluated (but it may be moved around).
4025 The expression must return the number of spaces worth of indent. It
4026 can return "-1" to keep the current indent (this means 'autoindent' is
4027 used for the indent).
4028 Functions useful for computing the indent are |indent()|, |cindent()|
4029 and |lispindent()|.
4030 The evaluation of the expression must not have side effects! It must
4031 not change the text, jump to another window, etc. Afterwards the
4032 cursor position is always restored, thus the cursor may be moved.
4033 Normally this option would be set to call a function: >
4034 :set indentexpr=GetMyIndent()
4035< Error messages will be suppressed, unless the 'debug' option contains
4036 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004037 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 NOTE: This option is made empty when 'compatible' is set.
4039
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004040 The expression may be evaluated in the |sandbox|, see
4041 |sandbox-option|.
4042
4043 It is not allowed to change text or jump to another window while
4044 evaluating 'indentexpr' |textlock|.
4045
4046
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 *'indentkeys'* *'indk'*
4048'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4049 local to buffer
4050 {not in Vi}
4051 {not available when compiled without the |+cindent|
4052 feature}
4053 A list of keys that, when typed in Insert mode, cause reindenting of
4054 the current line. Only happens if 'indentexpr' isn't empty.
4055 The format is identical to 'cinkeys', see |indentkeys-format|.
4056 See |C-indenting| and |indent-expression|.
4057
4058 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4059'infercase' 'inf' boolean (default off)
4060 local to buffer
4061 {not in Vi}
4062 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004063 'ignorecase' is also on, the case of the match is adjusted depending
4064 on the typed text. If the typed text contains a lowercase letter
4065 where the match has an upper case letter, the completed part is made
4066 lowercase. If the typed text has no lowercase letters and the match
4067 has a lowercase letter where the typed text has an uppercase letter,
4068 and there is a letter before it, the completed part is made uppercase.
4069 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070
4071 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4072'insertmode' 'im' boolean (default off)
4073 global
4074 {not in Vi}
4075 Makes Vim work in a way that Insert mode is the default mode. Useful
4076 if you want to use Vim as a modeless editor. Used for |evim|.
4077 These Insert mode commands will be useful:
4078 - Use the cursor keys to move around.
4079 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4080 this is a mapping, it is executed as if 'insertmode' was off.
4081 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004083 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4084 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085
4086 These items change when 'insertmode' is set:
4087 - when starting to edit of a file, Vim goes to Insert mode.
4088 - <Esc> in Insert mode is a no-op and beeps.
4089 - <Esc> in Normal mode makes Vim go to Insert mode.
4090 - CTRL-L in Insert mode is a command, it is not inserted.
4091 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4092 However, when <Esc> is used inside a mapping, it behaves like
4093 'insertmode' was not set. This was done to be able to use the same
4094 mappings with 'insertmode' set or not set.
4095 When executing commands with |:normal| 'insertmode' is not used.
4096
4097 NOTE: This option is reset when 'compatible' is set.
4098
4099 *'isfname'* *'isf'*
4100'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4101 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4102 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4103 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4104 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4105 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4106 global
4107 {not in Vi}
4108 The characters specified by this option are included in file names and
4109 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004110 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 Multi-byte characters 256 and above are always included, only the
4112 characters up to 255 are specified with this option.
4113 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004114 Think twice before adding white space to this option. Although a
4115 space may appear inside a file name, the effect will be that Vim
4116 doesn't know where a file name starts or ends when doing completion.
4117 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118
4119 Note that on systems using a backslash as path separator, Vim tries to
4120 do its best to make it work as you would expect. That is a bit
4121 tricky, since Vi originally used the backslash to escape special
4122 characters. Vim will not remove a backslash in front of a normal file
4123 name character on these systems, but it will on Unix and alikes. The
4124 '&' and '^' are not included by default, because these are special for
4125 cmd.exe.
4126
4127 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004128 Each part can be a single character number or a range. A range is two
4129 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 decimal number between 0 and 255 or the ASCII character itself (does
4131 not work for digits). Example:
4132 "_,-,128-140,#-43" (include '_' and '-' and the range
4133 128 to 140 and '#' to 43)
4134 If a part starts with '^', the following character number or range
4135 will be excluded from the option. The option is interpreted from left
4136 to right. Put the excluded character after the range where it is
4137 included. To include '^' itself use it as the last character of the
4138 option or the end of a range. Example:
4139 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4140 If the character is '@', all characters where isalpha() returns TRUE
4141 are included. Normally these are the characters a to z and A to Z,
4142 plus accented characters. To include '@' itself use "@-@". Examples:
4143 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004144 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 "a-z,A-Z,@-@" All letters plus the '@' character.
4146 A comma can be included by using it where a character number is
4147 expected. Example:
4148 "48-57,,,_" Digits, comma and underscore.
4149 A comma can be excluded by prepending a '^'. Example:
4150 " -~,^,,9" All characters from space to '~', excluding
4151 comma, plus <Tab>.
4152 See |option-backslash| about including spaces and backslashes.
4153
4154 *'isident'* *'isi'*
4155'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4156 "@,48-57,_,128-167,224-235"
4157 otherwise: "@,48-57,_,192-255")
4158 global
4159 {not in Vi}
4160 The characters given by this option are included in identifiers.
4161 Identifiers are used in recognizing environment variables and after a
4162 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004163 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 option.
4165 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004166 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4168
4169 *'iskeyword'* *'isk'*
4170'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4171 "@,48-57,_,128-167,224-235"
4172 otherwise: "@,48-57,_,192-255"
4173 Vi default: "@,48-57,_")
4174 local to buffer
4175 {not in Vi}
4176 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004177 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178 'isfname' for a description of the format of this option. For C
4179 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4180 For a help file it is set to all non-blank printable characters except
4181 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4182 command).
4183 When the 'lisp' option is on the '-' character is always included.
4184 NOTE: This option is set to the Vi default value when 'compatible' is
4185 set and to the Vim default value when 'compatible' is reset.
4186
4187 *'isprint'* *'isp'*
4188'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4189 "@,~-255"; otherwise: "@,161-255")
4190 global
4191 {not in Vi}
4192 The characters given by this option are displayed directly on the
4193 screen. It is also used for "\p" in a |pattern|. The characters from
4194 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4195 even when they are not included in 'isprint' or excluded. See
4196 'isfname' for a description of the format of this option.
4197
4198 Non-printable characters are displayed with two characters:
4199 0 - 31 "^@" - "^_"
4200 32 - 126 always single characters
4201 127 "^?"
4202 128 - 159 "~@" - "~_"
4203 160 - 254 "| " - "|~"
4204 255 "~?"
4205 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4206 displayed as <xx>, with the hexadecimal value of the byte.
4207 When 'display' contains "uhex" all unprintable characters are
4208 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004209 The SpecialKey highlighting will be used for unprintable characters.
4210 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211
4212 Multi-byte characters 256 and above are always included, only the
4213 characters up to 255 are specified with this option. When a character
4214 is printable but it is not available in the current font, a
4215 replacement character will be shown.
4216 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4217 There is no option to specify these characters.
4218
4219 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4220'joinspaces' 'js' boolean (default on)
4221 global
4222 {not in Vi}
4223 Insert two spaces after a '.', '?' and '!' with a join command.
4224 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4225 Otherwise only one space is inserted.
4226 NOTE: This option is set when 'compatible' is set.
4227
4228 *'key'*
4229'key' string (default "")
4230 local to buffer
4231 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004232 {only available when compiled with the |+cryptv|
4233 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004235 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 Careful: Do not set the key value by hand, someone might see the typed
4237 key. Use the |:X| command. But you can make 'key' empty: >
4238 :set key=
4239< It is not possible to get the value of this option with ":set key" or
4240 "echo &key". This is to avoid showing it to someone who shouldn't
4241 know. It also means you cannot see it yourself once you have set it,
4242 be careful not to make a typing error!
4243
4244 *'keymap'* *'kmp'* *E544*
4245'keymap' 'kmp' string (default "")
4246 local to buffer
4247 {not in Vi}
4248 {only available when compiled with the |+keymap|
4249 feature}
4250 Name of a keyboard mapping. See |mbyte-keymap|.
4251 Setting this option to a valid keymap name has the side effect of
4252 setting 'iminsert' to one, so that the keymap becomes effective.
4253 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004254 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004255
4256 *'keymodel'* *'km'*
4257'keymodel' 'km' string (default "")
4258 global
4259 {not in Vi}
4260 List of comma separated words, which enable special things that keys
4261 can do. These values can be used:
4262 startsel Using a shifted special key starts selection (either
4263 Select mode or Visual mode, depending on "key" being
4264 present in 'selectmode').
4265 stopsel Using a not-shifted special key stops selection.
4266 Special keys in this context are the cursor keys, <End>, <Home>,
4267 <PageUp> and <PageDown>.
4268 The 'keymodel' option is set by the |:behave| command.
4269
4270 *'keywordprg'* *'kp'*
4271'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4272 OS/2: "view /", VMS: "help")
4273 global or local to buffer |global-local|
4274 {not in Vi}
4275 Program to use for the |K| command. Environment variables are
4276 expanded |:set_env|. ":help" may be used to access the Vim internal
4277 help. (Note that previously setting the global option to the empty
4278 value did this, which is now deprecated.)
4279 When "man" is used, Vim will automatically translate a count for the
4280 "K" command to a section number. Also for "man -s", in which case the
4281 "-s" is removed when there is no count.
4282 See |option-backslash| about including spaces and backslashes.
4283 Example: >
4284 :set keywordprg=man\ -s
4285< This option cannot be set from a |modeline| or in the |sandbox|, for
4286 security reasons.
4287
4288 *'langmap'* *'lmap'* *E357* *E358*
4289'langmap' 'lmap' string (default "")
4290 global
4291 {not in Vi}
4292 {only available when compiled with the |+langmap|
4293 feature}
4294 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004295 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 inserted directly. When in command mode the 'langmap' option takes
4297 care of translating these special characters to the original meaning
4298 of the key. This means you don't have to change the keyboard mode to
4299 be able to execute Normal mode commands.
4300 This is the opposite of the 'keymap' option, where characters are
4301 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004303 Example (for Greek, in UTF-8): *greek* >
4304 :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 +00004305< Example (exchanges meaning of z and y for commands): >
4306 :set langmap=zy,yz,ZY,YZ
4307<
4308 The 'langmap' option is a list of parts, separated with commas. Each
4309 part can be in one of two forms:
4310 1. A list of pairs. Each pair is a "from" character immediately
4311 followed by the "to" character. Examples: "aA", "aAbBcC".
4312 2. A list of "from" characters, a semi-colon and a list of "to"
4313 characters. Example: "abc;ABC"
4314 Example: "aA,fgh;FGH,cCdDeE"
4315 Special characters need to be preceded with a backslash. These are
4316 ";", ',' and backslash itself.
4317
4318 This will allow you to activate vim actions without having to switch
4319 back and forth between the languages. Your language characters will
4320 be understood as normal vim English characters (according to the
4321 langmap mappings) in the following cases:
4322 o Normal/Visual mode (commands, buffer/register names, user mappings)
4323 o Insert/Replace Mode: Register names after CTRL-R
4324 o Insert/Replace Mode: Mappings
4325 Characters entered in Command-line mode will NOT be affected by
4326 this option. Note that this option can be changed at any time
4327 allowing to switch between mappings for different languages/encodings.
4328 Use a mapping to avoid having to type it each time!
4329
4330 *'langmenu'* *'lm'*
4331'langmenu' 'lm' string (default "")
4332 global
4333 {not in Vi}
4334 {only available when compiled with the |+menu| and
4335 |+multi_lang| features}
4336 Language to use for menu translation. Tells which file is loaded
4337 from the "lang" directory in 'runtimepath': >
4338 "lang/menu_" . &langmenu . ".vim"
4339< (without the spaces). For example, to always use the Dutch menus, no
4340 matter what $LANG is set to: >
4341 :set langmenu=nl_NL.ISO_8859-1
4342< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004343 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 If your $LANG is set to a non-English language but you do want to use
4345 the English menus: >
4346 :set langmenu=none
4347< This option must be set before loading menus, switching on filetype
4348 detection or syntax highlighting. Once the menus are defined setting
4349 this option has no effect. But you could do this: >
4350 :source $VIMRUNTIME/delmenu.vim
4351 :set langmenu=de_DE.ISO_8859-1
4352 :source $VIMRUNTIME/menu.vim
4353< Warning: This deletes all menus that you defined yourself!
4354
4355 *'laststatus'* *'ls'*
4356'laststatus' 'ls' number (default 1)
4357 global
4358 {not in Vi}
4359 The value of this option influences when the last window will have a
4360 status line:
4361 0: never
4362 1: only if there are at least two windows
4363 2: always
4364 The screen looks nicer with a status line if you have several
4365 windows, but it takes another screen line. |status-line|
4366
4367 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4368'lazyredraw' 'lz' boolean (default off)
4369 global
4370 {not in Vi}
4371 When this option is set, the screen will not be redrawn while
4372 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004373 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 update use |:redraw|.
4375
4376 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4377'linebreak' 'lbr' boolean (default off)
4378 local to window
4379 {not in Vi}
4380 {not available when compiled without the |+linebreak|
4381 feature}
4382 If on Vim will wrap long lines at a character in 'breakat' rather
4383 than at the last character that fits on the screen. Unlike
4384 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4385 it only affects the way the file is displayed, not its contents. The
4386 value of 'showbreak' is used to put in front of wrapped lines.
4387 This option is not used when the 'wrap' option is off or 'list' is on.
4388 Note that <Tab> characters after an <EOL> are mostly not displayed
4389 with the right amount of white space.
4390
4391 *'lines'* *E593*
4392'lines' number (default 24 or terminal height)
4393 global
4394 Number of lines of the Vim window.
4395 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004396 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 When Vim is running in the GUI or in a resizable window, setting this
4398 option will cause the window size to be changed. When you only want
4399 to use the size for the GUI, put the command in your |gvimrc| file.
4400 Vim limits the number of lines to what fits on the screen. You can
4401 use this command to get the tallest window possible: >
4402 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004403< Minimum value is 2, maximum value is 1000.
4404 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 When you set this option and Vim is unable to change the physical
4406 number of lines of the display, the display may be messed up.
4407
4408 *'linespace'* *'lsp'*
4409'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4410 global
4411 {not in Vi}
4412 {only in the GUI}
4413 Number of pixel lines inserted between characters. Useful if the font
4414 uses the full character cell height, making lines touch each other.
4415 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004416 With some fonts there can be too much room between lines (to have
4417 space for ascents and descents). Then it makes sense to set
4418 'linespace' to a negative value. This may cause display problems
4419 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420
4421 *'lisp'* *'nolisp'*
4422'lisp' boolean (default off)
4423 local to buffer
4424 {not available when compiled without the |+lispindent|
4425 feature}
4426 Lisp mode: When <Enter> is typed in insert mode set the indent for
4427 the next line to Lisp standards (well, sort of). Also happens with
4428 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4429 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4430 better. Also see 'lispwords'.
4431 The '-' character is included in keyword characters. Redefines the
4432 "=" operator to use this same indentation algorithm rather than
4433 calling an external program if 'equalprg' is empty.
4434 This option is not used when 'paste' is set.
4435 {Vi: Does it a little bit differently}
4436
4437 *'lispwords'* *'lw'*
4438'lispwords' 'lw' string (default is very long)
4439 global
4440 {not in Vi}
4441 {not available when compiled without the |+lispindent|
4442 feature}
4443 Comma separated list of words that influence the Lisp indenting.
4444 |'lisp'|
4445
4446 *'list'* *'nolist'*
4447'list' boolean (default off)
4448 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004449 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4450 line. Useful to see the difference between tabs and spaces and for
4451 trailing blanks. Further changed by the 'listchars' option.
4452
4453 The cursor is displayed at the start of the space a Tab character
4454 occupies, not at the end as usual in Normal mode. To get this cursor
4455 position while displaying Tabs with spaces, use: >
4456 :set list lcs=tab\ \
4457<
4458 Note that list mode will also affect formatting (set with 'textwidth'
4459 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 changing the way tabs are displayed.
4461
4462 *'listchars'* *'lcs'*
4463'listchars' 'lcs' string (default "eol:$")
4464 global
4465 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004466 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004467 settings.
4468 eol:c Character to show at the end of each line. When
4469 omitted, there is no extra character at the end of the
4470 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004471 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004473 fill the space that the tab normally occupies.
4474 "tab:>-" will show a tab that takes four spaces as
4475 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004476 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 trailing spaces are blank.
4478 extends:c Character to show in the last column, when 'wrap' is
4479 off and the line continues beyond the right of the
4480 screen.
4481 precedes:c Character to show in the first column, when 'wrap'
4482 is off and there is text preceding the character
4483 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004484 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004485 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004486 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004487 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004489 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004491 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492
4493 Examples: >
4494 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004495 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 :set lcs=extends:>,precedes:<
4497< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004498 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004499 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500
4501 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4502'loadplugins' 'lpl' boolean (default on)
4503 global
4504 {not in Vi}
4505 When on the plugin scripts are loaded when starting up |load-plugins|.
4506 This option can be reset in your |vimrc| file to disable the loading
4507 of plugins.
4508 Note that using the "-u NONE" and "--noplugin" command line arguments
4509 reset this option. |-u| |--noplugin|
4510
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004511 *'macatsui'* *'nomacatsui'*
4512'macatsui' boolean (default on)
4513 global
4514 {only available in Mac GUI version}
4515 This is a workaround for when drawing doesn't work properly. When set
4516 and compiled with multi-byte support ATSUI text drawing is used. When
4517 not set ATSUI text drawing is not used. Switch this option off when
4518 you experience drawing problems. In a future version the problems may
4519 be solved and this option becomes obsolete. Therefore use this method
4520 to unset it: >
4521 if exists('&macatsui')
4522 set nomacatsui
4523 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004524< Another option to check if you have drawing problems is
4525 'termencoding'.
4526
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 *'magic'* *'nomagic'*
4528'magic' boolean (default on)
4529 global
4530 Changes the special characters that can be used in search patterns.
4531 See |pattern|.
4532 NOTE: To avoid portability problems with using patterns, always keep
4533 this option at the default "on". Only switch it off when working with
4534 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004535 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536
4537 *'makeef'* *'mef'*
4538'makeef' 'mef' string (default: "")
4539 global
4540 {not in Vi}
4541 {not available when compiled without the |+quickfix|
4542 feature}
4543 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4544 and the |:grep| command.
4545 When it is empty, an internally generated temp file will be used.
4546 When "##" is included, it is replaced by a number to make the name
4547 unique. This makes sure that the ":make" command doesn't overwrite an
4548 existing file.
4549 NOT used for the ":cf" command. See 'errorfile' for that.
4550 Environment variables are expanded |:set_env|.
4551 See |option-backslash| about including spaces and backslashes.
4552 This option cannot be set from a |modeline| or in the |sandbox|, for
4553 security reasons.
4554
4555 *'makeprg'* *'mp'*
4556'makeprg' 'mp' string (default "make", VMS: "MMS")
4557 global or local to buffer |global-local|
4558 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004559 Program to use for the ":make" command. See |:make_makeprg|.
4560 This option may contain '%' and '#' characters, which are expanded to
4561 the current and alternate file name. |:_%| |:_#|
4562 Environment variables are expanded |:set_env|. See |option-backslash|
4563 about including spaces and backslashes.
4564 Note that a '|' must be escaped twice: once for ":set" and once for
4565 the interpretation of a command. When you use a filter called
4566 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 :set makeprg=gmake\ \\\|\ myfilter
4568< The placeholder "$*" can be given (even multiple times) to specify
4569 where the arguments will be included, for example: >
4570 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4571< This option cannot be set from a |modeline| or in the |sandbox|, for
4572 security reasons.
4573
Bram Moolenaar1a384422010-07-14 19:53:30 +02004574 *'colorcolumn'* *'cc'*
4575'colorcolumn' 'cc' string (default "")
4576 local to window
4577 {not in Vi}
4578 {not available when compiled without the |+syntax|
4579 feature}
4580 'colorcolumn' is a comma separated list of screen columns that are
4581 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
4582 text. Will make screen redrawing slower.
4583 The screen column can be an absolute number, or a number preceded with
4584 '+' or '-', which is added to or subtracted from 'textwidth'. >
4585
4586 :set cc=+1 " highlight column after 'textwidth'
4587 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
4588 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
4589<
4590 When 'textwidth' is zero then the items with '-' and '+' are not used.
4591 A maximum of 256 columns are highlighted.
4592
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 *'matchpairs'* *'mps'*
4594'matchpairs' 'mps' string (default "(:),{:},[:]")
4595 local to buffer
4596 {not in Vi}
4597 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004598 other. Currently only single byte character pairs are allowed, and
4599 they must be different. The characters must be separated by a colon.
4600 The pairs must be separated by a comma. Example for including '<' and
4601 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 :set mps+=<:>
4603
4604< A more exotic example, to jump between the '=' and ';' in an
4605 assignment, useful for languages like C and Java: >
4606 :au FileType c,cpp,java set mps+==:;
4607
4608< For a more advanced way of using "%", see the matchit.vim plugin in
4609 the $VIMRUNTIME/macros directory. |add-local-help|
4610
4611 *'matchtime'* *'mat'*
4612'matchtime' 'mat' number (default 5)
4613 global
4614 {not in Vi}{in Nvi}
4615 Tenths of a second to show the matching paren, when 'showmatch' is
4616 set. Note that this is not in milliseconds, like other options that
4617 set a time. This is to be compatible with Nvi.
4618
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004619 *'maxcombine'* *'mco'*
4620'maxcombine' 'mco' number (default 2)
4621 global
4622 {not in Vi}
4623 {only available when compiled with the |+multi_byte|
4624 feature}
4625 The maximum number of combining characters supported for displaying.
4626 Only used when 'encoding' is "utf-8".
4627 The default is OK for most languages. Hebrew may require 4.
4628 Maximum value is 6.
4629 Even when this option is set to 2 you can still edit text with more
4630 combining characters, you just can't see them. Use |g8| or |ga|.
4631 See |mbyte-combining|.
4632
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 *'maxfuncdepth'* *'mfd'*
4634'maxfuncdepth' 'mfd' number (default 100)
4635 global
4636 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004637 {not available when compiled without the +eval
4638 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639 Maximum depth of function calls for user functions. This normally
4640 catches endless recursion. When using a recursive function with
4641 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4642 more memory, there is the danger of failing when memory is exhausted.
4643 See also |:function|.
4644
4645 *'maxmapdepth'* *'mmd'* *E223*
4646'maxmapdepth' 'mmd' number (default 1000)
4647 global
4648 {not in Vi}
4649 Maximum number of times a mapping is done without resulting in a
4650 character to be used. This normally catches endless mappings, like
4651 ":map x y" with ":map y x". It still does not catch ":map g wg",
4652 because the 'w' is used before the next mapping is done. See also
4653 |key-mapping|.
4654
4655 *'maxmem'* *'mm'*
4656'maxmem' 'mm' number (default between 256 to 5120 (system
4657 dependent) or half the amount of memory
4658 available)
4659 global
4660 {not in Vi}
4661 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4662 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004663 other memory to be freed. The maximum usable value is about 2000000.
4664 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004666 *'maxmempattern'* *'mmp'*
4667'maxmempattern' 'mmp' number (default 1000)
4668 global
4669 {not in Vi}
4670 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004671 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004672 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004673 When Vim runs into the limit it gives an error message and mostly
4674 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004675 Running into the limit often means that the pattern is very
4676 inefficient or too complex. This may already happen with the pattern
4677 "\(.\)*" on a very long line. ".*" works much better.
4678 Vim may run out of memory before hitting the 'maxmempattern' limit.
4679
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 *'maxmemtot'* *'mmt'*
4681'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4682 dependent) or half the amount of memory
4683 available)
4684 global
4685 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004686 Maximum amount of memory in Kbyte to use for all buffers together.
4687 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4688 without a limit. On 64 bit machines higher values might work. But
4689 hey, do you really need more than 2 Gbyte for text editing?
4690 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691
4692 *'menuitems'* *'mis'*
4693'menuitems' 'mis' number (default 25)
4694 global
4695 {not in Vi}
4696 {not available when compiled without the |+menu|
4697 feature}
4698 Maximum number of items to use in a menu. Used for menus that are
4699 generated from a list of items, e.g., the Buffers menu. Changing this
4700 option has no direct effect, the menu must be refreshed first.
4701
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004702 *'mkspellmem'* *'msm'*
4703'mkspellmem' 'msm' string (default "460000,2000,500")
4704 global
4705 {not in Vi}
4706 {not available when compiled without the |+syntax|
4707 feature}
4708 Parameters for |:mkspell|. This tunes when to start compressing the
4709 word tree. Compression can be slow when there are many words, but
4710 it's needed to avoid running out of memory. The amount of memory used
4711 per word depends very much on how similar the words are, that's why
4712 this tuning is complicated.
4713
4714 There are three numbers, separated by commas:
4715 {start},{inc},{added}
4716
4717 For most languages the uncompressed word tree fits in memory. {start}
4718 gives the amount of memory in Kbyte that can be used before any
4719 compression is done. It should be a bit smaller than the amount of
4720 memory that is available to Vim.
4721
4722 When going over the {start} limit the {inc} number specifies the
4723 amount of memory in Kbyte that can be allocated before another
4724 compression is done. A low number means compression is done after
4725 less words are added, which is slow. A high number means more memory
4726 will be allocated.
4727
4728 After doing compression, {added} times 1024 words can be added before
4729 the {inc} limit is ignored and compression is done when any extra
4730 amount of memory is needed. A low number means there is a smaller
4731 chance of hitting the {inc} limit, less memory is used but it's
4732 slower.
4733
4734 The languages for which these numbers are important are Italian and
4735 Hungarian. The default works for when you have about 512 Mbyte. If
4736 you have 1 Gbyte you could use: >
4737 :set mkspellmem=900000,3000,800
4738< If you have less than 512 Mbyte |:mkspell| may fail for some
4739 languages, no matter what you set 'mkspellmem' to.
4740
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004742'modeline' 'ml' boolean (Vim default: on (off for root),
4743 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 local to buffer
4745 *'modelines'* *'mls'*
4746'modelines' 'mls' number (default 5)
4747 global
4748 {not in Vi}
4749 If 'modeline' is on 'modelines' gives the number of lines that is
4750 checked for set commands. If 'modeline' is off or 'modelines' is zero
4751 no lines are checked. See |modeline|.
4752 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4753 set and to the Vim default value when 'compatible' is reset.
4754
4755 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4756'modifiable' 'ma' boolean (default on)
4757 local to buffer
4758 {not in Vi} *E21*
4759 When off the buffer contents cannot be changed. The 'fileformat' and
4760 'fileencoding' options also can't be changed.
4761 Can be reset with the |-M| command line argument.
4762
4763 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4764'modified' 'mod' boolean (default off)
4765 local to buffer
4766 {not in Vi}
4767 When on, the buffer is considered to be modified. This option is set
4768 when:
4769 1. A change was made to the text since it was last written. Using the
4770 |undo| command to go back to the original text will reset the
4771 option. But undoing changes that were made before writing the
4772 buffer will set the option again, since the text is different from
4773 when it was written.
4774 2. 'fileformat' or 'fileencoding' is different from its original
4775 value. The original value is set when the buffer is read or
4776 written. A ":set nomodified" command also resets the original
4777 values to the current values and the 'modified' option will be
4778 reset.
4779 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4780 will be ignored.
4781
4782 *'more'* *'nomore'*
4783'more' boolean (Vim default: on, Vi default: off)
4784 global
4785 {not in Vi}
4786 When on, listings pause when the whole screen is filled. You will get
4787 the |more-prompt|. When this option is off there are no pauses, the
4788 listing continues until finished.
4789 NOTE: This option is set to the Vi default value when 'compatible' is
4790 set and to the Vim default value when 'compatible' is reset.
4791
4792 *'mouse'* *E538*
4793'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4794 global
4795 {not in Vi}
4796 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004797 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4798 sysmouse and Linux console with gpm). For using the mouse in the
4799 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 The mouse can be enabled for different modes:
4801 n Normal mode
4802 v Visual mode
4803 i Insert mode
4804 c Command-line mode
4805 h all previous modes when editing a help file
4806 a all previous modes
4807 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808 Normally you would enable the mouse in all four modes with: >
4809 :set mouse=a
4810< When the mouse is not enabled, the GUI will still use the mouse for
4811 modeless selection. This doesn't move the text cursor.
4812
4813 See |mouse-using|. Also see |'clipboard'|.
4814
4815 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004816 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817 the mouse buttons can still be used by keeping the shift key pressed.
4818 Also see the 'clipboard' option.
4819
4820 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4821'mousefocus' 'mousef' boolean (default off)
4822 global
4823 {not in Vi}
4824 {only works in the GUI}
4825 The window that the mouse pointer is on is automatically activated.
4826 When changing the window layout or window focus in another way, the
4827 mouse pointer is moved to the window with keyboard focus. Off is the
4828 default because it makes using the pull down menus a little goofy, as
4829 a pointer transit may activate a window unintentionally.
4830
4831 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4832'mousehide' 'mh' boolean (default on)
4833 global
4834 {not in Vi}
4835 {only works in the GUI}
4836 When on, the mouse pointer is hidden when characters are typed.
4837 The mouse pointer is restored when the mouse is moved.
4838
4839 *'mousemodel'* *'mousem'*
4840'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4841 global
4842 {not in Vi}
4843 Sets the model to use for the mouse. The name mostly specifies what
4844 the right mouse button is used for:
4845 extend Right mouse button extends a selection. This works
4846 like in an xterm.
4847 popup Right mouse button pops up a menu. The shifted left
4848 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004849 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850 popup_setpos Like "popup", but the cursor will be moved to the
4851 position where the mouse was clicked, and thus the
4852 selected operation will act upon the clicked object.
4853 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004854 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855 course, that right clicking outside a selection will
4856 end Visual mode.
4857 Overview of what button does what for each model:
4858 mouse extend popup(_setpos) ~
4859 left click place cursor place cursor
4860 left drag start selection start selection
4861 shift-left search word extend selection
4862 right click extend selection popup menu (place cursor)
4863 right drag extend selection -
4864 middle click paste paste
4865
4866 In the "popup" model the right mouse button produces a pop-up menu.
4867 You need to define this first, see |popup-menu|.
4868
4869 Note that you can further refine the meaning of buttons with mappings.
4870 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4871 selection (because that's handled in the GUI code directly).
4872
4873 The 'mousemodel' option is set by the |:behave| command.
4874
4875 *'mouseshape'* *'mouses'* *E547*
4876'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004877 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878 global
4879 {not in Vi}
4880 {only available when compiled with the |+mouseshape|
4881 feature}
4882 This option tells Vim what the mouse pointer should look like in
4883 different modes. The option is a comma separated list of parts, much
4884 like used for 'guicursor'. Each part consist of a mode/location-list
4885 and an argument-list:
4886 mode-list:shape,mode-list:shape,..
4887 The mode-list is a dash separated list of these modes/locations:
4888 In a normal window: ~
4889 n Normal mode
4890 v Visual mode
4891 ve Visual mode with 'selection' "exclusive" (same as 'v',
4892 if not specified)
4893 o Operator-pending mode
4894 i Insert mode
4895 r Replace mode
4896
4897 Others: ~
4898 c appending to the command-line
4899 ci inserting in the command-line
4900 cr replacing in the command-line
4901 m at the 'Hit ENTER' or 'More' prompts
4902 ml idem, but cursor in the last line
4903 e any mode, pointer below last window
4904 s any mode, pointer on a status line
4905 sd any mode, while dragging a status line
4906 vs any mode, pointer on a vertical separator line
4907 vd any mode, while dragging a vertical separator line
4908 a everywhere
4909
4910 The shape is one of the following:
4911 avail name looks like ~
4912 w x arrow Normal mouse pointer
4913 w x blank no pointer at all (use with care!)
4914 w x beam I-beam
4915 w x updown up-down sizing arrows
4916 w x leftright left-right sizing arrows
4917 w x busy The system's usual busy pointer
4918 w x no The system's usual 'no input' pointer
4919 x udsizing indicates up-down resizing
4920 x lrsizing indicates left-right resizing
4921 x crosshair like a big thin +
4922 x hand1 black hand
4923 x hand2 white hand
4924 x pencil what you write with
4925 x question big ?
4926 x rightup-arrow arrow pointing right-up
4927 w x up-arrow arrow pointing up
4928 x <number> any X11 pointer number (see X11/cursorfont.h)
4929
4930 The "avail" column contains a 'w' if the shape is available for Win32,
4931 x for X11.
4932 Any modes not specified or shapes not available use the normal mouse
4933 pointer.
4934
4935 Example: >
4936 :set mouseshape=s:udsizing,m:no
4937< will make the mouse turn to a sizing arrow over the status lines and
4938 indicate no input when the hit-enter prompt is displayed (since
4939 clicking the mouse has no effect in this state.)
4940
4941 *'mousetime'* *'mouset'*
4942'mousetime' 'mouset' number (default 500)
4943 global
4944 {not in Vi}
4945 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4946 time in msec between two mouse clicks for the second click to be
4947 recognized as a multi click.
4948
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004949 *'mzquantum'* *'mzq'*
4950'mzquantum' 'mzq' number (default 100)
4951 global
4952 {not in Vi}
4953 {not available when compiled without the |+mzscheme|
4954 feature}
4955 The number of milliseconds between polls for MzScheme threads.
4956 Negative or zero value means no thread scheduling.
4957
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 *'nrformats'* *'nf'*
4959'nrformats' 'nf' string (default "octal,hex")
4960 local to buffer
4961 {not in Vi}
4962 This defines what bases Vim will consider for numbers when using the
4963 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4964 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004965 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02004967 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00004968 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004970 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004971 considered to be hexadecimal. Example: Using CTRL-X on
4972 "0x100" results in "0x0ff".
4973 Numbers which simply begin with a digit in the range 1-9 are always
4974 considered decimal. This also happens for numbers that are not
4975 recognized as octal or hex.
4976
4977 *'number'* *'nu'* *'nonumber'* *'nonu'*
4978'number' 'nu' boolean (default off)
4979 local to window
4980 Print the line number in front of each line. When the 'n' option is
4981 excluded from 'cpoptions' a wrapped line will not use the column of
4982 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004983 The 'numberwidth' option can be used to set the room used for the line
4984 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985 When a long, wrapped line doesn't start with the first character, '-'
4986 characters are put before the number.
4987 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02004988 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004990 *'numberwidth'* *'nuw'*
4991'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4992 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004993 {not in Vi}
4994 {only available when compiled with the |+linebreak|
4995 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004996 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02004997 when the 'number' or 'relativenumber' option is set or printing lines
4998 with a line number. Since one space is always between the number and
4999 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005000 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005001 fit the highest line number in the buffer respectively the number of
5002 rows in the window, depending on whether 'number' or 'relativenumber'
5003 is set. Thus with the Vim default of 4 there is room for a line number
5004 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005005 The minimum value is 1, the maximum value is 10.
5006 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5007
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005008 *'omnifunc'* *'ofu'*
5009'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005010 local to buffer
5011 {not in Vi}
5012 {not available when compiled without the +eval
5013 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005014 This option specifies a function to be used for Insert mode omni
5015 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005016 See |complete-functions| for an explanation of how the function is
5017 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005018 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005019 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005020
5021
Bram Moolenaar02467872007-05-06 13:22:01 +00005022 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005023'opendevice' 'odev' boolean (default off)
5024 global
5025 {not in Vi}
5026 {only for MS-DOS, MS-Windows and OS/2}
5027 Enable reading and writing from devices. This may get Vim stuck on a
5028 device that can be opened but doesn't actually do the I/O. Therefore
5029 it is off by default.
5030 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5031 result in editing a device.
5032
5033
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005034 *'operatorfunc'* *'opfunc'*
5035'operatorfunc' 'opfunc' string (default: empty)
5036 global
5037 {not in Vi}
5038 This option specifies a function to be called by the |g@| operator.
5039 See |:map-operator| for more info and an example.
5040
5041 This option cannot be set from a |modeline| or in the |sandbox|, for
5042 security reasons.
5043
5044
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045 *'osfiletype'* *'oft'* *E366*
5046'osfiletype' 'oft' string (RISC-OS default: "Text",
5047 others default: "")
5048 local to buffer
5049 {not in Vi}
5050 {only available when compiled with the |+osfiletype|
5051 feature}
5052 Some operating systems store extra information about files besides
5053 name, datestamp and permissions. This option contains the extra
5054 information, the nature of which will vary between systems.
5055 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005056 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005057 It can affect the pattern matching of the automatic commands.
5058 |autocmd-osfiletypes|
5059
5060 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005061'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 global
5063 Specifies the nroff macros that separate paragraphs. These are pairs
5064 of two letters (see |object-motions|).
5065
5066 *'paste'* *'nopaste'*
5067'paste' boolean (default off)
5068 global
5069 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005070 Put Vim in Paste mode. This is useful if you want to cut or copy
5071 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 unexpected effects.
5073 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005074 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 knows about pasting and will mostly do the right thing without 'paste'
5076 being set. The same is true for a terminal where Vim handles the
5077 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005078 This option is reset when starting the GUI. Thus if you set it in
5079 your .vimrc it will work in a terminal, but not in the GUI. Setting
5080 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5081 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 When the 'paste' option is switched on (also when it was already on):
5083 - mapping in Insert mode and Command-line mode is disabled
5084 - abbreviations are disabled
5085 - 'textwidth' is set to 0
5086 - 'wrapmargin' is set to 0
5087 - 'autoindent' is reset
5088 - 'smartindent' is reset
5089 - 'softtabstop' is set to 0
5090 - 'revins' is reset
5091 - 'ruler' is reset
5092 - 'showmatch' is reset
5093 - 'formatoptions' is used like it is empty
5094 These options keep their value, but their effect is disabled:
5095 - 'lisp'
5096 - 'indentexpr'
5097 - 'cindent'
5098 NOTE: When you start editing another file while the 'paste' option is
5099 on, settings from the modelines or autocommands may change the
5100 settings again, causing trouble when pasting text. You might want to
5101 set the 'paste' option again.
5102 When the 'paste' option is reset the mentioned options are restored to
5103 the value before the moment 'paste' was switched from off to on.
5104 Resetting 'paste' before ever setting it does not have any effect.
5105 Since mapping doesn't work while 'paste' is active, you need to use
5106 the 'pastetoggle' option to toggle the 'paste' option with some key.
5107
5108 *'pastetoggle'* *'pt'*
5109'pastetoggle' 'pt' string (default "")
5110 global
5111 {not in Vi}
5112 When non-empty, specifies the key sequence that toggles the 'paste'
5113 option. This is like specifying a mapping: >
5114 :map {keys} :set invpaste<CR>
5115< Where {keys} is the value of 'pastetoggle'.
5116 The difference is that it will work even when 'paste' is set.
5117 'pastetoggle' works in Insert mode and Normal mode, but not in
5118 Command-line mode.
5119 Mappings are checked first, thus overrule 'pastetoggle'. However,
5120 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5121 this: >
5122 :map <F10> :set paste<CR>
5123 :map <F11> :set nopaste<CR>
5124 :imap <F10> <C-O>:set paste<CR>
5125 :imap <F11> <nop>
5126 :set pastetoggle=<F11>
5127< This will make <F10> start paste mode and <F11> stop paste mode.
5128 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5129 mode everything is inserted literally, except the 'pastetoggle' key
5130 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005131 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132
5133 *'pex'* *'patchexpr'*
5134'patchexpr' 'pex' string (default "")
5135 global
5136 {not in Vi}
5137 {not available when compiled without the |+diff|
5138 feature}
5139 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005140 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141
5142 *'patchmode'* *'pm'* *E206*
5143'patchmode' 'pm' string (default "")
5144 global
5145 {not in Vi}
5146 When non-empty the oldest version of a file is kept. This can be used
5147 to keep the original version of a file if you are changing files in a
5148 source distribution. Only the first time that a file is written a
5149 copy of the original file will be kept. The name of the copy is the
5150 name of the original file with the string in the 'patchmode' option
5151 appended. This option should start with a dot. Use a string like
5152 ".org". 'backupdir' must not be empty for this to work (Detail: The
5153 backup file is renamed to the patchmode file after the new file has
5154 been successfully written, that's why it must be possible to write a
5155 backup file). If there was no file to be backed up, an empty file is
5156 created.
5157 When the 'backupskip' pattern matches, a patchmode file is not made.
5158 Using 'patchmode' for compressed files appends the extension at the
5159 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5160 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005161 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162
5163 *'path'* *'pa'* *E343* *E345* *E347*
5164'path' 'pa' string (default on Unix: ".,/usr/include,,"
5165 on OS/2: ".,/emx/include,,"
5166 other systems: ".,,")
5167 global or local to buffer |global-local|
5168 {not in Vi}
5169 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005170 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5171 provided that the file being searched for has a relative path (not
5172 starting with "/", "./" or "../"). The directories in the 'path'
5173 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174 - Use commas to separate directory names: >
5175 :set path=.,/usr/local/include,/usr/include
5176< - Spaces can also be used to separate directory names (for backwards
5177 compatibility with version 3.0). To have a space in a directory
5178 name, precede it with an extra backslash, and escape the space: >
5179 :set path=.,/dir/with\\\ space
5180< - To include a comma in a directory name precede it with an extra
5181 backslash: >
5182 :set path=.,/dir/with\\,comma
5183< - To search relative to the directory of the current file, use: >
5184 :set path=.
5185< - To search in the current directory use an empty string between two
5186 commas: >
5187 :set path=,,
5188< - A directory name may end in a ':' or '/'.
5189 - Environment variables are expanded |:set_env|.
5190 - When using |netrw.vim| URLs can be used. For example, adding
5191 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005192 - Search upwards and downwards in a directory tree using "*", "**" and
5193 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194 {not available when compiled without the |+path_extra| feature}
5195 - Careful with '\' characters, type two to get one in the option: >
5196 :set path=.,c:\\include
5197< Or just use '/' instead: >
5198 :set path=.,c:/include
5199< Don't forget "." or files won't even be found in the same directory as
5200 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005201 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 it is something like 256 or 1024 characters.
5203 You can check if all the include files are found, using the value of
5204 'path', see |:checkpath|.
5205 The use of |:set+=| and |:set-=| is preferred when adding or removing
5206 directories from the list. This avoids problems when a future version
5207 uses another default. To remove the current directory use: >
5208 :set path-=
5209< To add the current directory use: >
5210 :set path+=
5211< To use an environment variable, you probably need to replace the
5212 separator. Here is an example to append $INCL, in which directory
5213 names are separated with a semi-colon: >
5214 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5215< Replace the ';' with a ':' or whatever separator is used. Note that
5216 this doesn't work when $INCL contains a comma or white space.
5217
5218 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5219'preserveindent' 'pi' boolean (default off)
5220 local to buffer
5221 {not in Vi}
5222 When changing the indent of the current line, preserve as much of the
5223 indent structure as possible. Normally the indent is replaced by a
5224 series of tabs followed by spaces as required (unless |'expandtab'| is
5225 enabled, in which case only spaces are used). Enabling this option
5226 means the indent will preserve as many existing characters as possible
5227 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005228 'expandtab' does not apply to the preserved white space, a Tab remains
5229 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005230 NOTE: When using ">>" multiple times the resulting indent is a mix of
5231 tabs and spaces. You might not like this.
5232 NOTE: 'preserveindent' is reset when 'compatible' is set.
5233 Also see 'copyindent'.
5234 Use |:retab| to clean up white space.
5235
5236 *'previewheight'* *'pvh'*
5237'previewheight' 'pvh' number (default 12)
5238 global
5239 {not in Vi}
5240 {not available when compiled without the |+windows| or
5241 |+quickfix| feature}
5242 Default height for a preview window. Used for |:ptag| and associated
5243 commands. Used for |CTRL-W_}| when no count is given.
5244
5245 *'previewwindow'* *'nopreviewwindow'*
5246 *'pvw'* *'nopvw'* *E590*
5247'previewwindow' 'pvw' boolean (default off)
5248 local to window
5249 {not in Vi}
5250 {not available when compiled without the |+windows| or
5251 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005252 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 set. It's normally not set directly, but by using one of the commands
5254 |:ptag|, |:pedit|, etc.
5255
5256 *'printdevice'* *'pdev'*
5257'printdevice' 'pdev' string (default empty)
5258 global
5259 {not in Vi}
5260 {only available when compiled with the |+printer|
5261 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005262 The name of the printer to be used for |:hardcopy|.
5263 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005264 This option cannot be set from a |modeline| or in the |sandbox|, for
5265 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266
Bram Moolenaar8299df92004-07-10 09:47:34 +00005267 *'printencoding'* *'penc'*
5268'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269 global
5270 {not in Vi}
5271 {only available when compiled with the |+printer|
5272 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005273 Sets the character encoding used when printing.
5274 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275
5276 *'printexpr'* *'pexpr'*
5277'printexpr' 'pexpr' String (default: see below)
5278 global
5279 {not in Vi}
5280 {only available when compiled with the |+printer|
5281 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005282 Expression used to print the PostScript produced with |:hardcopy|.
5283 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284
Bram Moolenaar8299df92004-07-10 09:47:34 +00005285 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005286'printfont' 'pfn' string (default "courier")
5287 global
5288 {not in Vi}
5289 {only available when compiled with the |+printer|
5290 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005291 The name of the font that will be used for |:hardcopy|.
5292 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293
5294 *'printheader'* *'pheader'*
5295'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5296 global
5297 {not in Vi}
5298 {only available when compiled with the |+printer|
5299 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005300 The format of the header produced in |:hardcopy| output.
5301 See |pheader-option|.
5302
5303 *'printmbcharset'* *'pmbcs'*
5304'printmbcharset' 'pmbcs' string (default "")
5305 global
5306 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005307 {only available when compiled with the |+printer|,
5308 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005309 The CJK character set to be used for CJK output from |:hardcopy|.
5310 See |pmbcs-option|.
5311
5312 *'printmbfont'* *'pmbfn'*
5313'printmbfont' 'pmbfn' string (default "")
5314 global
5315 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005316 {only available when compiled with the |+printer|,
5317 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005318 List of font names to be used for CJK output from |:hardcopy|.
5319 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320
5321 *'printoptions'* *'popt'*
5322'printoptions' 'popt' string (default "")
5323 global
5324 {not in Vi}
5325 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005326 List of items that control the format of the output of |:hardcopy|.
5327 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005329 *'prompt'* *'noprompt'*
5330'prompt' boolean (default on)
5331 global
5332 When on a ":" prompt is used in Ex mode.
5333
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005334 *'pumheight'* *'ph'*
5335'pumheight' 'ph' number (default 0)
5336 global
5337 {not available when compiled without the
5338 |+insert_expand| feature}
5339 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005340 Determines the maximum number of items to show in the popup menu for
5341 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005342 |ins-completion-menu|.
5343
5344
Bram Moolenaar677ee682005-01-27 14:41:15 +00005345 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005346'quoteescape' 'qe' string (default "\")
5347 local to buffer
5348 {not in Vi}
5349 The characters that are used to escape quotes in a string. Used for
5350 objects like a', a" and a` |a'|.
5351 When one of the characters in this option is found inside a string,
5352 the following character will be skipped. The default value makes the
5353 text "foo\"bar\\" considered to be one string.
5354
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5356'readonly' 'ro' boolean (default off)
5357 local to buffer
5358 If on, writes fail unless you use a '!'. Protects you from
5359 accidentally overwriting a file. Default on when Vim is started
5360 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005361 When using ":w!" the 'readonly' option is reset for the current
5362 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005364 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005365
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005366 *'redrawtime'* *'rdt'*
5367'redrawtime' 'rdt' number (default 2000)
5368 global
5369 {not in Vi}
5370 {only available when compiled with the |+reltime|
5371 feature}
5372 The time in milliseconds for redrawing the display. This applies to
5373 searching for patterns for 'hlsearch' and |:match| highlighting.
5374 When redrawing takes more than this many milliseconds no further
5375 matches will be highlighted. This is used to avoid that Vim hangs
5376 when using a very complicated pattern.
5377
Bram Moolenaar64486672010-05-16 15:46:46 +02005378 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5379'relativenumber' 'rnu' boolean (default off)
5380 local to window
5381 {not in Vi}
5382 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005383 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005384 precede some vertical motion commands (e.g. j k + -) with, without
5385 having to calculate it yourself. Especially useful in combination with
5386 other commands (e.g. y d c < > gq gw =).
5387 When the 'n' option is excluded from 'cpoptions' a wrapped
5388 line will not use the column of line numbers (this is the default when
5389 'compatible' isn't set).
5390 The 'numberwidth' option can be used to set the room used for the line
5391 number.
5392 When a long, wrapped line doesn't start with the first character, '-'
5393 characters are put before the number.
5394 See |hl-LineNr| for the highlighting used for the number.
5395 When setting this option, 'number' is reset.
5396
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397 *'remap'* *'noremap'*
5398'remap' boolean (default on)
5399 global
5400 Allows for mappings to work recursively. If you do not want this for
5401 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005402 NOTE: To avoid portability problems with Vim scripts, always keep
5403 this option at the default "on". Only switch it off when working with
5404 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405
5406 *'report'*
5407'report' number (default 2)
5408 global
5409 Threshold for reporting number of lines changed. When the number of
5410 changed lines is more than 'report' a message will be given for most
5411 ":" commands. If you want it always, set 'report' to 0.
5412 For the ":substitute" command the number of substitutions is used
5413 instead of the number of lines.
5414
5415 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5416'restorescreen' 'rs' boolean (default on)
5417 global
5418 {not in Vi} {only in Windows 95/NT console version}
5419 When set, the screen contents is restored when exiting Vim. This also
5420 happens when executing external commands.
5421
5422 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5423 options in your .vimrc. To disable restoring:
5424 set t_ti= t_te=
5425 To enable restoring (for an xterm):
5426 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5427 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5428
5429 *'revins'* *'ri'* *'norevins'* *'nori'*
5430'revins' 'ri' boolean (default off)
5431 global
5432 {not in Vi}
5433 {only available when compiled with the |+rightleft|
5434 feature}
5435 Inserting characters in Insert mode will work backwards. See "typing
5436 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5437 command in Insert mode, when 'allowrevins' is set.
5438 NOTE: This option is reset when 'compatible' or 'paste' is set.
5439
5440 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5441'rightleft' 'rl' boolean (default off)
5442 local to window
5443 {not in Vi}
5444 {only available when compiled with the |+rightleft|
5445 feature}
5446 When on, display orientation becomes right-to-left, i.e., characters
5447 that are stored in the file appear from the right to the left.
5448 Using this option, it is possible to edit files for languages that
5449 are written from the right to the left such as Hebrew and Arabic.
5450 This option is per window, so it is possible to edit mixed files
5451 simultaneously, or to view the same file in both ways (this is
5452 useful whenever you have a mixed text file with both right-to-left
5453 and left-to-right strings so that both sets are displayed properly
5454 in different windows). Also see |rileft.txt|.
5455
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005456 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457'rightleftcmd' 'rlc' string (default "search")
5458 local to window
5459 {not in Vi}
5460 {only available when compiled with the |+rightleft|
5461 feature}
5462 Each word in this option enables the command line editing to work in
5463 right-to-left mode for a group of commands:
5464
5465 search "/" and "?" commands
5466
5467 This is useful for languages such as Hebrew, Arabic and Farsi.
5468 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5469
5470 *'ruler'* *'ru'* *'noruler'* *'noru'*
5471'ruler' 'ru' boolean (default off)
5472 global
5473 {not in Vi}
5474 {not available when compiled without the
5475 |+cmdline_info| feature}
5476 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005477 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005478 text in the file is shown on the far right:
5479 Top first line is visible
5480 Bot last line is visible
5481 All first and last line are visible
5482 45% relative position in the file
5483 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005484 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005485 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005486 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487 this option takes precedence over 'ruler' and 'rulerformat'
5488 If the number of characters displayed is different from the number of
5489 bytes in the text (e.g., for a TAB or a multi-byte character), both
5490 the text column (byte number) and the screen column are shown,
5491 separated with a dash.
5492 For an empty line "0-1" is shown.
5493 For an empty buffer the line number will also be zero: "0,0-1".
5494 This option is reset when the 'paste' option is set.
5495 If you don't want to see the ruler all the time but want to know where
5496 you are, use "g CTRL-G" |g_CTRL-G|.
5497 NOTE: This option is reset when 'compatible' is set.
5498
5499 *'rulerformat'* *'ruf'*
5500'rulerformat' 'ruf' string (default empty)
5501 global
5502 {not in Vi}
5503 {not available when compiled without the |+statusline|
5504 feature}
5505 When this option is not empty, it determines the content of the ruler
5506 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005507 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 The default ruler width is 17 characters. To make the ruler 15
5509 characters wide, put "%15(" at the start and "%)" at the end.
5510 Example: >
5511 :set rulerformat=%15(%c%V\ %p%%%)
5512<
5513 *'runtimepath'* *'rtp'* *vimfiles*
5514'runtimepath' 'rtp' string (default:
5515 Unix: "$HOME/.vim,
5516 $VIM/vimfiles,
5517 $VIMRUNTIME,
5518 $VIM/vimfiles/after,
5519 $HOME/.vim/after"
5520 Amiga: "home:vimfiles,
5521 $VIM/vimfiles,
5522 $VIMRUNTIME,
5523 $VIM/vimfiles/after,
5524 home:vimfiles/after"
5525 PC, OS/2: "$HOME/vimfiles,
5526 $VIM/vimfiles,
5527 $VIMRUNTIME,
5528 $VIM/vimfiles/after,
5529 $HOME/vimfiles/after"
5530 Macintosh: "$VIM:vimfiles,
5531 $VIMRUNTIME,
5532 $VIM:vimfiles:after"
5533 RISC-OS: "Choices:vimfiles,
5534 $VIMRUNTIME,
5535 Choices:vimfiles/after"
5536 VMS: "sys$login:vimfiles,
5537 $VIM/vimfiles,
5538 $VIMRUNTIME,
5539 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005540 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541 global
5542 {not in Vi}
5543 This is a list of directories which will be searched for runtime
5544 files:
5545 filetype.vim filetypes by file name |new-filetype|
5546 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005547 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 colors/ color scheme files |:colorscheme|
5549 compiler/ compiler files |:compiler|
5550 doc/ documentation |write-local-help|
5551 ftplugin/ filetype plugins |write-filetype-plugin|
5552 indent/ indent scripts |indent-expression|
5553 keymap/ key mapping files |mbyte-keymap|
5554 lang/ menu translations |:menutrans|
5555 menu.vim GUI menus |menu.vim|
5556 plugin/ plugin scripts |write-plugin|
5557 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005558 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559 syntax/ syntax files |mysyntaxfile|
5560 tutor/ files for vimtutor |tutor|
5561
5562 And any other file searched for with the |:runtime| command.
5563
5564 The defaults for most systems are setup to search five locations:
5565 1. In your home directory, for your personal preferences.
5566 2. In a system-wide Vim directory, for preferences from the system
5567 administrator.
5568 3. In $VIMRUNTIME, for files distributed with Vim.
5569 *after-directory*
5570 4. In the "after" directory in the system-wide Vim directory. This is
5571 for the system administrator to overrule or add to the distributed
5572 defaults (rarely needed)
5573 5. In the "after" directory in your home directory. This is for
5574 personal preferences to overrule or add to the distributed defaults
5575 or system-wide settings (rarely needed).
5576
5577 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5578 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005579 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 wildcards.
5581 See |:runtime|.
5582 Example: >
5583 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5584< This will use the directory "~/vimruntime" first (containing your
5585 personal Vim runtime files), then "/mygroup/vim" (shared between a
5586 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5587 files).
5588 You probably should always include $VIMRUNTIME somewhere, to use the
5589 distributed runtime files. You can put a directory before $VIMRUNTIME
5590 to find files which replace a distributed runtime files. You can put
5591 a directory after $VIMRUNTIME to find files which add to distributed
5592 runtime files.
5593 This option cannot be set from a |modeline| or in the |sandbox|, for
5594 security reasons.
5595
5596 *'scroll'* *'scr'*
5597'scroll' 'scr' number (default: half the window height)
5598 local to window
5599 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5600 set to half the number of lines in the window when the window size
5601 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005602 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5604 the number of screen lines instead of file lines, makes a difference
5605 when lines wrap}
5606
5607 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5608'scrollbind' 'scb' boolean (default off)
5609 local to window
5610 {not in Vi}
5611 {not available when compiled without the |+scrollbind|
5612 feature}
5613 See also |scroll-binding|. When this option is set, the current
5614 window scrolls as other scrollbind windows (windows that also have
5615 this option set) scroll. This option is useful for viewing the
5616 differences between two versions of a file, see 'diff'.
5617 See |'scrollopt'| for options that determine how this option should be
5618 interpreted.
5619 This option is mostly reset when splitting a window to edit another
5620 file. This means that ":split | edit file" results in two windows
5621 with scroll-binding, but ":split file" does not.
5622
5623 *'scrolljump'* *'sj'*
5624'scrolljump' 'sj' number (default 1)
5625 global
5626 {not in Vi}
5627 Minimal number of lines to scroll when the cursor gets off the
5628 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5629 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005630 When set to a negative number from -1 to -100 this is used as the
5631 percentage of the window height. Thus -50 scrolls half the window
5632 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 NOTE: This option is set to 1 when 'compatible' is set.
5634
5635 *'scrolloff'* *'so'*
5636'scrolloff' 'so' number (default 0)
5637 global
5638 {not in Vi}
5639 Minimal number of screen lines to keep above and below the cursor.
5640 This will make some context visible around where you are working. If
5641 you set it to a very large value (999) the cursor line will always be
5642 in the middle of the window (except at the start or end of the file or
5643 when long lines wrap).
5644 For scrolling horizontally see 'sidescrolloff'.
5645 NOTE: This option is set to 0 when 'compatible' is set.
5646
5647 *'scrollopt'* *'sbo'*
5648'scrollopt' 'sbo' string (default "ver,jump")
5649 global
5650 {not available when compiled without the |+scrollbind|
5651 feature}
5652 {not in Vi}
5653 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005654 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5655 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005656 The following words are available:
5657 ver Bind vertical scrolling for 'scrollbind' windows
5658 hor Bind horizontal scrolling for 'scrollbind' windows
5659 jump Applies to the offset between two windows for vertical
5660 scrolling. This offset is the difference in the first
5661 displayed line of the bound windows. When moving
5662 around in a window, another 'scrollbind' window may
5663 reach a position before the start or after the end of
5664 the buffer. The offset is not changed though, when
5665 moving back the 'scrollbind' window will try to scroll
5666 to the desired position when possible.
5667 When now making that window the current one, two
5668 things can be done with the relative offset:
5669 1. When "jump" is not included, the relative offset is
5670 adjusted for the scroll position in the new current
5671 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005672 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673 2. When "jump" is included, the other windows are
5674 scrolled to keep the same relative offset. When
5675 going back to the other window, it still uses the
5676 same relative offset.
5677 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005678 When 'diff' mode is active there always is vertical scroll binding,
5679 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680
5681 *'sections'* *'sect'*
5682'sections' 'sect' string (default "SHNHH HUnhsh")
5683 global
5684 Specifies the nroff macros that separate sections. These are pairs of
5685 two letters (See |object-motions|). The default makes a section start
5686 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5687
5688 *'secure'* *'nosecure'* *E523*
5689'secure' boolean (default off)
5690 global
5691 {not in Vi}
5692 When on, ":autocmd", shell and write commands are not allowed in
5693 ".vimrc" and ".exrc" in the current directory and map commands are
5694 displayed. Switch it off only if you know that you will not run into
5695 problems, or when the 'exrc' option is off. On Unix this option is
5696 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005697 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 'secure' at the end of your ~/.vimrc then.
5699 This option cannot be set from a |modeline| or in the |sandbox|, for
5700 security reasons.
5701
5702 *'selection'* *'sel'*
5703'selection' 'sel' string (default "inclusive")
5704 global
5705 {not in Vi}
5706 This option defines the behavior of the selection. It is only used
5707 in Visual and Select mode.
5708 Possible values:
5709 value past line inclusive ~
5710 old no yes
5711 inclusive yes yes
5712 exclusive yes no
5713 "past line" means that the cursor is allowed to be positioned one
5714 character past the line.
5715 "inclusive" means that the last character of the selection is included
5716 in an operation. For example, when "x" is used to delete the
5717 selection.
5718 Note that when "exclusive" is used and selecting from the end
5719 backwards, you cannot include the last character of a line, when
5720 starting in Normal mode and 'virtualedit' empty.
5721
5722 The 'selection' option is set by the |:behave| command.
5723
5724 *'selectmode'* *'slm'*
5725'selectmode' 'slm' string (default "")
5726 global
5727 {not in Vi}
5728 This is a comma separated list of words, which specifies when to start
5729 Select mode instead of Visual mode, when a selection is started.
5730 Possible values:
5731 mouse when using the mouse
5732 key when using shifted special keys
5733 cmd when using "v", "V" or CTRL-V
5734 See |Select-mode|.
5735 The 'selectmode' option is set by the |:behave| command.
5736
5737 *'sessionoptions'* *'ssop'*
5738'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005739 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 global
5741 {not in Vi}
5742 {not available when compiled without the +mksession
5743 feature}
5744 Changes the effect of the |:mksession| command. It is a comma
5745 separated list of words. Each word enables saving and restoring
5746 something:
5747 word save and restore ~
5748 blank empty windows
5749 buffers hidden and unloaded buffers, not just those in windows
5750 curdir the current directory
5751 folds manually created folds, opened/closed folds and local
5752 fold options
5753 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005754 and contain at least one lowercase letter. Only
5755 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 help the help window
5757 localoptions options and mappings local to a window or buffer (not
5758 global values for local options)
5759 options all options and mappings (also global values for local
5760 options)
5761 resize size of the Vim window: 'lines' and 'columns'
5762 sesdir the directory in which the session file is located
5763 will become the current directory (useful with
5764 projects accessed over a network from different
5765 systems)
5766 slash backslashes in file names replaced with forward
5767 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005768 tabpages all tab pages; without this only the current tab page
5769 is restored, so that you can make a session for each
5770 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 unix with Unix end-of-line format (single <NL>), even when
5772 on Windows or DOS
5773 winpos position of the whole Vim window
5774 winsize window sizes
5775
5776 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005777 When neither "curdir" nor "sesdir" is included, file names are stored
5778 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005779 "slash" and "unix" are useful on Windows when sharing session files
5780 with Unix. The Unix version of Vim cannot source dos format scripts,
5781 but the Windows version of Vim can source unix format scripts.
5782
5783 *'shell'* *'sh'* *E91*
5784'shell' 'sh' string (default $SHELL or "sh",
5785 MS-DOS and Win32: "command.com" or
5786 "cmd.exe", OS/2: "cmd")
5787 global
5788 Name of the shell to use for ! and :! commands. When changing the
5789 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5790 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005791 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792 See |option-backslash| about including spaces and backslashes.
5793 Environment variables are expanded |:set_env|.
5794 If the name of the shell contains a space, you might need to enclose
5795 it in quotes. Example: >
5796 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5797< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005798 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005799 "-f" is not inside the quotes, because it is not part of the command
5800 name. And Vim automagically recognizes the backslashes that are path
5801 separators.
5802 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5803 variable to change the way external commands are executed. See the
5804 libc.inf file of DJGPP.
5805 Under MS-Windows, when the executable ends in ".com" it must be
5806 included. Thus setting the shell to "command.com" or "4dos.com"
5807 works, but "command" and "4dos" do not work for all commands (e.g.,
5808 filtering).
5809 For unknown reasons, when using "4dos.com" the current directory is
5810 changed to "C:\". To avoid this set 'shell' like this: >
5811 :set shell=command.com\ /c\ 4dos
5812< This option cannot be set from a |modeline| or in the |sandbox|, for
5813 security reasons.
5814
5815 *'shellcmdflag'* *'shcf'*
5816'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5817 does not contain "sh" somewhere: "/c")
5818 global
5819 {not in Vi}
5820 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5821 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5822 systems, the default is set according to the value of 'shell', to
5823 reduce the need to set this option by the user. It's not used for
5824 OS/2 (EMX figures this out itself). See |option-backslash| about
5825 including spaces and backslashes. See |dos-shell|.
5826 This option cannot be set from a |modeline| or in the |sandbox|, for
5827 security reasons.
5828
5829 *'shellpipe'* *'sp'*
5830'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5831 global
5832 {not in Vi}
5833 {not available when compiled without the |+quickfix|
5834 feature}
5835 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005836 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837 including spaces and backslashes.
5838 The name of the temporary file can be represented by "%s" if necessary
5839 (the file name is appended automatically if no %s appears in the value
5840 of this option).
5841 For the Amiga and MS-DOS the default is ">". The output is directly
5842 saved in a file and not echoed to the screen.
5843 For Unix the default it "| tee". The stdout of the compiler is saved
5844 in a file and echoed to the screen. If the 'shell' option is "csh" or
5845 "tcsh" after initializations, the default becomes "|& tee". If the
5846 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005847 "2>&1| tee". This means that stderr is also included. Before using
5848 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849 The initialization of this option is done after reading the ".vimrc"
5850 and the other initializations, so that when the 'shell' option is set
5851 there, the 'shellpipe' option changes automatically, unless it was
5852 explicitly set before.
5853 When 'shellpipe' is set to an empty string, no redirection of the
5854 ":make" output will be done. This is useful if you use a 'makeprg'
5855 that writes to 'makeef' by itself. If you want no piping, but do
5856 want to include the 'makeef', set 'shellpipe' to a single space.
5857 Don't forget to precede the space with a backslash: ":set sp=\ ".
5858 In the future pipes may be used for filtering and this option will
5859 become obsolete (at least for Unix).
5860 This option cannot be set from a |modeline| or in the |sandbox|, for
5861 security reasons.
5862
5863 *'shellquote'* *'shq'*
5864'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5865 contains "sh" somewhere: "\"")
5866 global
5867 {not in Vi}
5868 Quoting character(s), put around the command passed to the shell, for
5869 the "!" and ":!" commands. The redirection is kept outside of the
5870 quoting. See 'shellxquote' to include the redirection. It's
5871 probably not useful to set both options.
5872 This is an empty string by default. Only known to be useful for
5873 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5874 or bash, where it should be "\"". The default is adjusted according
5875 the value of 'shell', to reduce the need to set this option by the
5876 user. See |dos-shell|.
5877 This option cannot be set from a |modeline| or in the |sandbox|, for
5878 security reasons.
5879
5880 *'shellredir'* *'srr'*
5881'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5882 global
5883 {not in Vi}
5884 String to be used to put the output of a filter command in a temporary
5885 file. See also |:!|. See |option-backslash| about including spaces
5886 and backslashes.
5887 The name of the temporary file can be represented by "%s" if necessary
5888 (the file name is appended automatically if no %s appears in the value
5889 of this option).
5890 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5891 or "zsh" during initializations, the default becomes ">&". If the
5892 'shell' option is "sh", "ksh" or "bash" the default becomes
5893 ">%s 2>&1". This means that stderr is also included.
5894 For Win32, the Unix checks are done and additionally "cmd" is checked
5895 for, which makes the default ">%s 2>&1". Also, the same names with
5896 ".exe" appended are checked for.
5897 The initialization of this option is done after reading the ".vimrc"
5898 and the other initializations, so that when the 'shell' option is set
5899 there, the 'shellredir' option changes automatically unless it was
5900 explicitly set before.
5901 In the future pipes may be used for filtering and this option will
5902 become obsolete (at least for Unix).
5903 This option cannot be set from a |modeline| or in the |sandbox|, for
5904 security reasons.
5905
5906 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5907'shellslash' 'ssl' boolean (default off)
5908 global
5909 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5910 When set, a forward slash is used when expanding file names. This is
5911 useful when a Unix-like shell is used instead of command.com or
5912 cmd.exe. Backward slashes can still be typed, but they are changed to
5913 forward slashes by Vim.
5914 Note that setting or resetting this option has no effect for some
5915 existing file names, thus this option needs to be set before opening
5916 any file for best results. This might change in the future.
5917 'shellslash' only works when a backslash can be used as a path
5918 separator. To test if this is so use: >
5919 if exists('+shellslash')
5920<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005921 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5922'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5923 global
5924 {not in Vi}
5925 When on, use temp files for shell commands. When off use a pipe.
5926 When using a pipe is not possible temp files are used anyway.
5927 Currently a pipe is only supported on Unix. You can check it with: >
5928 :if has("filterpipe")
5929< The advantage of using a pipe is that nobody can read the temp file
5930 and the 'shell' command does not need to support redirection.
5931 The advantage of using a temp file is that the file type and encoding
5932 can be detected.
5933 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5934 |FilterWritePost| autocommands event are not triggered when
5935 'shelltemp' is off.
5936
Bram Moolenaar071d4272004-06-13 20:20:40 +00005937 *'shelltype'* *'st'*
5938'shelltype' 'st' number (default 0)
5939 global
5940 {not in Vi} {only for the Amiga}
5941 On the Amiga this option influences the way how the commands work
5942 which use a shell.
5943 0 and 1: always use the shell
5944 2 and 3: use the shell only to filter lines
5945 4 and 5: use shell only for ':sh' command
5946 When not using the shell, the command is executed directly.
5947
5948 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5949 1 and 3: use "shell cmd" to start external commands
5950
5951 *'shellxquote'* *'sxq'*
5952'shellxquote' 'sxq' string (default: "";
5953 for Win32, when 'shell' contains "sh"
5954 somewhere: "\""
5955 for Unix, when using system(): "\"")
5956 global
5957 {not in Vi}
5958 Quoting character(s), put around the command passed to the shell, for
5959 the "!" and ":!" commands. Includes the redirection. See
5960 'shellquote' to exclude the redirection. It's probably not useful
5961 to set both options.
5962 This is an empty string by default. Known to be useful for
5963 third-party shells when using the Win32 version, such as the MKS Korn
5964 Shell or bash, where it should be "\"". The default is adjusted
5965 according the value of 'shell', to reduce the need to set this option
5966 by the user. See |dos-shell|.
5967 This option cannot be set from a |modeline| or in the |sandbox|, for
5968 security reasons.
5969
5970 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5971'shiftround' 'sr' boolean (default off)
5972 global
5973 {not in Vi}
5974 Round indent to multiple of 'shiftwidth'. Applies to > and <
5975 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5976 a multiple of 'shiftwidth' (this is Vi compatible).
5977 NOTE: This option is reset when 'compatible' is set.
5978
5979 *'shiftwidth'* *'sw'*
5980'shiftwidth' 'sw' number (default 8)
5981 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005982 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005983 |'cindent'|, |>>|, |<<|, etc.
5984
5985 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005986'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5987 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988 global
5989 {not in Vi}
5990 This option helps to avoid all the |hit-enter| prompts caused by file
5991 messages, for example with CTRL-G, and to avoid some other messages.
5992 It is a list of flags:
5993 flag meaning when present ~
5994 f use "(3 of 5)" instead of "(file 3 of 5)"
5995 i use "[noeol]" instead of "[Incomplete last line]"
5996 l use "999L, 888C" instead of "999 lines, 888 characters"
5997 m use "[+]" instead of "[Modified]"
5998 n use "[New]" instead of "[New File]"
5999 r use "[RO]" instead of "[readonly]"
6000 w use "[w]" instead of "written" for file write message
6001 and "[a]" instead of "appended" for ':w >> file' command
6002 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6003 "[unix format]" and "[mac]" instead of "[mac format]".
6004 a all of the above abbreviations
6005
6006 o overwrite message for writing a file with subsequent message
6007 for reading a file (useful for ":wn" or when 'autowrite' on)
6008 O message for reading a file overwrites any previous message.
6009 Also for quickfix message (e.g., ":cn").
6010 s don't give "search hit BOTTOM, continuing at TOP" or "search
6011 hit TOP, continuing at BOTTOM" messages
6012 t truncate file message at the start if it is too long to fit
6013 on the command-line, "<" will appear in the left most column.
6014 Ignored in Ex mode.
6015 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006016 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017 Ignored in Ex mode.
6018 W don't give "written" or "[w]" when writing a file
6019 A don't give the "ATTENTION" message when an existing swap file
6020 is found.
6021 I don't give the intro message when starting Vim |:intro|.
6022
6023 This gives you the opportunity to avoid that a change between buffers
6024 requires you to hit <Enter>, but still gives as useful a message as
6025 possible for the space available. To get the whole message that you
6026 would have got with 'shm' empty, use ":file!"
6027 Useful values:
6028 shm= No abbreviation of message.
6029 shm=a Abbreviation, but no loss of information.
6030 shm=at Abbreviation, and truncate message when necessary.
6031
6032 NOTE: This option is set to the Vi default value when 'compatible' is
6033 set and to the Vim default value when 'compatible' is reset.
6034
6035 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6036'shortname' 'sn' boolean (default off)
6037 local to buffer
6038 {not in Vi, not in MS-DOS versions}
6039 Filenames are assumed to be 8 characters plus one extension of 3
6040 characters. Multiple dots in file names are not allowed. When this
6041 option is on, dots in file names are replaced with underscores when
6042 adding an extension (".~" or ".swp"). This option is not available
6043 for MS-DOS, because then it would always be on. This option is useful
6044 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6045 or crossdos. When running the Win32 GUI version under Win32s, this
6046 option is always on by default.
6047
6048 *'showbreak'* *'sbr'* *E595*
6049'showbreak' 'sbr' string (default "")
6050 global
6051 {not in Vi}
6052 {not available when compiled without the |+linebreak|
6053 feature}
6054 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006055 values are "> " or "+++ ": >
6056 :set showbreak=>\
6057< Note the backslash to escape the trailing space. It's easier like
6058 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006059 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006060< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061 comma (in a future version the comma might be used to separate the
6062 part that is shown at the end and at the start of a line).
6063 The characters are highlighted according to the '@' flag in
6064 'highlight'.
6065 Note that tabs after the showbreak will be displayed differently.
6066 If you want the 'showbreak' to appear in between line numbers, add the
6067 "n" flag to 'cpoptions'.
6068
6069 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6070'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6071 off)
6072 global
6073 {not in Vi}
6074 {not available when compiled without the
6075 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006076 Show (partial) command in the last line of the screen. Set this
6077 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006078 In Visual mode the size of the selected area is shown:
6079 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006080 If the number of bytes is different it is also displayed: "2-6"
6081 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006083 - When selecting a block, the size in screen characters:
6084 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 NOTE: This option is set to the Vi default value when 'compatible' is
6086 set and to the Vim default value when 'compatible' is reset.
6087
6088 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6089'showfulltag' 'sft' boolean (default off)
6090 global
6091 {not in Vi}
6092 When completing a word in insert mode (see |ins-completion|) from the
6093 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006094 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 matched a C function, you can see a template for what arguments are
6096 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006097 Note that this doesn't work well together with having "longest" in
6098 'completeopt', because the completion from the search pattern may not
6099 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100
6101 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6102'showmatch' 'sm' boolean (default off)
6103 global
6104 When a bracket is inserted, briefly jump to the matching one. The
6105 jump is only done if the match can be seen on the screen. The time to
6106 show the match can be set with 'matchtime'.
6107 A Beep is given if there is no match (no matter if the match can be
6108 seen or not). This option is reset when the 'paste' option is set.
6109 When the 'm' flag is not included in 'cpoptions', typing a character
6110 will immediately move the cursor back to where it belongs.
6111 See the "sm" field in 'guicursor' for setting the cursor shape and
6112 blinking when showing the match.
6113 The 'matchpairs' option can be used to specify the characters to show
6114 matches for. 'rightleft' and 'revins' are used to look for opposite
6115 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006116 Also see the matchparen plugin for highlighting the match when moving
6117 around |pi_paren.txt|.
6118 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119
6120 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6121'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6122 global
6123 If in Insert, Replace or Visual mode put a message on the last line.
6124 Use the 'M' flag in 'highlight' to set the type of highlighting for
6125 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006126 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127 doesn't mean XIM is really active, especially when 'imactivatekey' is
6128 not set.
6129 NOTE: This option is set to the Vi default value when 'compatible' is
6130 set and to the Vim default value when 'compatible' is reset.
6131
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006132 *'showtabline'* *'stal'*
6133'showtabline' 'stal' number (default 1)
6134 global
6135 {not in Vi}
6136 {not available when compiled without the +windows
6137 feature}
6138 The value of this option specifies when the line with tab page labels
6139 will be displayed:
6140 0: never
6141 1: only if there are at least two tab pages
6142 2: always
6143 This is both for the GUI and non-GUI implementation of the tab pages
6144 line.
6145 See |tab-page| for more information about tab pages.
6146
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 *'sidescroll'* *'ss'*
6148'sidescroll' 'ss' number (default 0)
6149 global
6150 {not in Vi}
6151 The minimal number of columns to scroll horizontally. Used only when
6152 the 'wrap' option is off and the cursor is moved off of the screen.
6153 When it is zero the cursor will be put in the middle of the screen.
6154 When using a slow terminal set it to a large number or 0. When using
6155 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6156 commands.
6157
6158 *'sidescrolloff'* *'siso'*
6159'sidescrolloff' 'siso' number (default 0)
6160 global
6161 {not in Vi}
6162 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006163 right of the cursor if 'nowrap' is set. Setting this option to a
6164 value greater than 0 while having |'sidescroll'| also at a non-zero
6165 value makes some context visible in the line you are scrolling in
6166 horizontally (except at beginning of the line). Setting this option
6167 to a large value (like 999) has the effect of keeping the cursor
6168 horizontally centered in the window, as long as one does not come too
6169 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170 NOTE: This option is set to 0 when 'compatible' is set.
6171
6172 Example: Try this together with 'sidescroll' and 'listchars' as
6173 in the following example to never allow the cursor to move
6174 onto the "extends" character:
6175
6176 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6177 :set sidescrolloff=1
6178
6179
6180 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6181'smartcase' 'scs' boolean (default off)
6182 global
6183 {not in Vi}
6184 Override the 'ignorecase' option if the search pattern contains upper
6185 case characters. Only used when the search pattern is typed and
6186 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006187 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6189 recalling the search pattern from history and hitting <Enter>.
6190 NOTE: This option is reset when 'compatible' is set.
6191
6192 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6193'smartindent' 'si' boolean (default off)
6194 local to buffer
6195 {not in Vi}
6196 {not available when compiled without the
6197 |+smartindent| feature}
6198 Do smart autoindenting when starting a new line. Works for C-like
6199 programs, but can also be used for other languages. 'cindent' does
6200 something like this, works better in most cases, but is more strict,
6201 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6202 'indentexpr' is a more advanced alternative.
6203 Normally 'autoindent' should also be on when using 'smartindent'.
6204 An indent is automatically inserted:
6205 - After a line ending in '{'.
6206 - After a line starting with a keyword from 'cinwords'.
6207 - Before a line starting with '}' (only with the "O" command).
6208 When typing '}' as the first character in a new line, that line is
6209 given the same indent as the matching '{'.
6210 When typing '#' as the first character in a new line, the indent for
6211 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006212 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6214 When using the ">>" command, lines starting with '#' are not shifted
6215 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006216 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 is set smart indenting is disabled.
6218
6219 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6220'smarttab' 'sta' boolean (default off)
6221 global
6222 {not in Vi}
6223 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006224 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6225 <BS> will delete a 'shiftwidth' worth of space at the start of the
6226 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006227 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006228 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6229 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006230 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006232 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233 NOTE: This option is reset when 'compatible' is set.
6234
6235 *'softtabstop'* *'sts'*
6236'softtabstop' 'sts' number (default 0)
6237 local to buffer
6238 {not in Vi}
6239 Number of spaces that a <Tab> counts for while performing editing
6240 operations, like inserting a <Tab> or using <BS>. It "feels" like
6241 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6242 used. This is useful to keep the 'ts' setting at its standard value
6243 of 8, while being able to edit like it is set to 'sts'. However,
6244 commands like "x" still work on the actual characters.
6245 When 'sts' is zero, this feature is off.
6246 'softtabstop' is set to 0 when the 'paste' option is set.
6247 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6248 spaces is minimized by using <Tab>s.
6249 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6250 set.
6251 NOTE: This option is set to 0 when 'compatible' is set.
6252
Bram Moolenaar217ad922005-03-20 22:37:15 +00006253 *'spell'* *'nospell'*
6254'spell' boolean (default off)
6255 local to window
6256 {not in Vi}
6257 {not available when compiled without the |+syntax|
6258 feature}
6259 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006260 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006261
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006262 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006263'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006264 local to buffer
6265 {not in Vi}
6266 {not available when compiled without the |+syntax|
6267 feature}
6268 Pattern to locate the end of a sentence. The following word will be
6269 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006270 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006271 When this check is not wanted make this option empty.
6272 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006273 Be careful with special characters, see |option-backslash| about
6274 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006275 To set this option automatically depending on the language, see
6276 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006277
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006278 *'spellfile'* *'spf'*
6279'spellfile' 'spf' string (default empty)
6280 local to buffer
6281 {not in Vi}
6282 {not available when compiled without the |+syntax|
6283 feature}
6284 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006285 commands. It must end in ".{encoding}.add". You need to include the
6286 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006287 *E765*
6288 It may also be a comma separated list of names. A count before the
6289 |zg| and |zw| commands can be used to access each. This allows using
6290 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006291 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006292 you: Using the first directory in 'runtimepath' that is writable. If
6293 there is no "spell" directory yet it will be created. For the file
6294 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006295 ignoring the region.
6296 The resulting ".spl" file will be used for spell checking, it does not
6297 have to appear in 'spelllang'.
6298 Normally one file is used for all regions, but you can add the region
6299 name if you want to. However, it will then only be used when
6300 'spellfile' is set to it, for entries in 'spelllang' only files
6301 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006302 This option cannot be set from a |modeline| or in the |sandbox|, for
6303 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006304
Bram Moolenaar217ad922005-03-20 22:37:15 +00006305 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006306'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006307 local to buffer
6308 {not in Vi}
6309 {not available when compiled without the |+syntax|
6310 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006311 A comma separated list of word list names. When the 'spell' option is
6312 on spellchecking will be done for these languages. Example: >
6313 set spelllang=en_us,nl,medical
6314< This means US English, Dutch and medical words are recognized. Words
6315 that are not recognized will be highlighted.
6316 The word list name must not include a comma or dot. Using a dash is
6317 recommended to separate the two letter language name from a
6318 specification. Thus "en-rare" is used for rare English words.
6319 A region name must come last and have the form "_xx", where "xx" is
6320 the two-letter, lower case region name. You can use more than one
6321 region by listing them: "en_us,en_ca" supports both US and Canadian
6322 English, but not words specific for Australia, New Zealand or Great
6323 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006324 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006325 As a special case the name of a .spl file can be given as-is. The
6326 first "_xx" in the name is removed and used as the region name
6327 (_xx is an underscore, two letters and followed by a non-letter).
6328 This is mainly for testing purposes. You must make sure the correct
6329 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006330 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006331 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6332 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006333 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006334
Bram Moolenaar98692072006-02-04 00:57:42 +00006335 If the |spellfile.vim| plugin is active and you use a language name
6336 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6337 will ask you if you want to download the file.
6338
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006339 After this option has been set successfully, Vim will source the files
6340 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006341 up to the first comma, dot or underscore.
6342 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006343
6344
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006345 *'spellsuggest'* *'sps'*
6346'spellsuggest' 'sps' string (default "best")
6347 global
6348 {not in Vi}
6349 {not available when compiled without the |+syntax|
6350 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006351 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006352 the |spellsuggest()| function. This is a comma-separated list of
6353 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006354
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006355 best Internal method that works best for English. Finds
6356 changes like "fast" and uses a bit of sound-a-like
6357 scoring to improve the ordering.
6358
6359 double Internal method that uses two methods and mixes the
6360 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006361 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006362 word. That only works when the language specifies
6363 sound folding. Can be slow and doesn't always give
6364 better results.
6365
6366 fast Internal method that only checks for simple changes:
6367 character inserts/deletes/swaps. Works well for
6368 simple typing mistakes.
6369
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006370 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006371 Not used for |spellsuggest()|. The number of
6372 suggestions is never more than the value of 'lines'
6373 minus two.
6374
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006375 file:{filename} Read file {filename}, which must have two columns,
6376 separated by a slash. The first column contains the
6377 bad word, the second column the suggested good word.
6378 Example:
6379 theribal/terrible ~
6380 Use this for common mistakes that do not appear at the
6381 top of the suggestion list with the internal methods.
6382 Lines without a slash are ignored, use this for
6383 comments.
6384 The file is used for all languages.
6385
6386 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6387 trouble with spaces. |v:val| holds the badly spelled
6388 word. The expression must evaluate to a List of
6389 Lists, each with a suggestion and a score.
6390 Example:
6391 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006392 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006393 internal methods use. A lower score is better.
6394 This may invoke |spellsuggest()| if you temporarily
6395 set 'spellsuggest' to exclude the "expr:" part.
6396 Errors are silently ignored, unless you set the
6397 'verbose' option to a non-zero value.
6398
6399 Only one of "best", "double" or "fast" may be used. The others may
6400 appear several times in any order. Example: >
6401 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6402<
6403 This option cannot be set from a |modeline| or in the |sandbox|, for
6404 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006405
6406
Bram Moolenaar071d4272004-06-13 20:20:40 +00006407 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6408'splitbelow' 'sb' boolean (default off)
6409 global
6410 {not in Vi}
6411 {not available when compiled without the +windows
6412 feature}
6413 When on, splitting a window will put the new window below the current
6414 one. |:split|
6415
6416 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6417'splitright' 'spr' boolean (default off)
6418 global
6419 {not in Vi}
6420 {not available when compiled without the +vertsplit
6421 feature}
6422 When on, splitting a window will put the new window right of the
6423 current one. |:vsplit|
6424
6425 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6426'startofline' 'sol' boolean (default on)
6427 global
6428 {not in Vi}
6429 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006430 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006431 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006432 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 with a linewise operator, with "%" with a count and to buffer changing
6434 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6435 only has a line number, e.g., ":25" or ":+".
6436 In case of buffer changing commands the cursor is placed at the column
6437 where it was the last time the buffer was edited.
6438 NOTE: This option is set when 'compatible' is set.
6439
6440 *'statusline'* *'stl'* *E540* *E541* *E542*
6441'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006442 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443 {not in Vi}
6444 {not available when compiled without the |+statusline|
6445 feature}
6446 When nonempty, this option determines the content of the status line.
6447 Also see |status-line|.
6448
6449 The option consists of printf style '%' items interspersed with
6450 normal text. Each status line item is of the form:
6451 %-0{minwid}.{maxwid}{item}
6452 All fields except the {item} is optional. A single percent sign can
6453 be given as "%%". Up to 80 items can be specified.
6454
Bram Moolenaar238a5642006-02-21 22:12:05 +00006455 When the option starts with "%!" then it is used as an expression,
6456 evaluated and the result is used as the option value. Example: >
6457 :set statusline=%!MyStatusLine()
6458< The result can contain %{} items that will be evaluated too.
6459
6460 When there is error while evaluating the option then it will be made
6461 empty to avoid further errors. Otherwise screen updating would loop.
6462
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 Note that the only effect of 'ruler' when this option is set (and
6464 'laststatus' is 2) is controlling the output of |CTRL-G|.
6465
6466 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006467 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006469 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 minwid Minimum width of the item, padding as set by '-' & '0'.
6471 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006472 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 on the left for text items. Numeric items will be
6474 shifted down to maxwid-2 digits followed by '>'number
6475 where number is the amount of missing digits, much like
6476 an exponential notation.
6477 item A one letter code as described below.
6478
6479 Following is a description of the possible statusline items. The
6480 second character in "item" is the type:
6481 N for number
6482 S for string
6483 F for flags as described below
6484 - not applicable
6485
6486 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006487 f S Path to the file in the buffer, as typed or relative to current
6488 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006489 F S Full path to the file in the buffer.
6490 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006491 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006493 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006495 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006497 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006499 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6501 {not available when compiled without |+autocmd| feature}
6502 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6503 being used: "<keymap>"
6504 n N Buffer number.
6505 b N Value of byte under cursor.
6506 B N As above, in hexadecimal.
6507 o N Byte number in file of byte under cursor, first byte is 1.
6508 Mnemonic: Offset from start of file (with one added)
6509 {not available when compiled without |+byte_offset| feature}
6510 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006511 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512 l N Line number.
6513 L N Number of lines in buffer.
6514 c N Column number.
6515 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006516 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517 p N Percentage through file in lines as in |CTRL-G|.
6518 P S Percentage through file of displayed window. This is like the
6519 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006520 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006522 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006523 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 ( - Start of item group. Can be used for setting the width and
6525 alignment of a section. Must be followed by %) somewhere.
6526 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006527 T N For 'tabline': start of tab page N label. Use %T after the last
6528 label. This information is used for mouse clicks.
6529 X N For 'tabline': start of close tab N label. Use %X after the
6530 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6531 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 < - Where to truncate line if too long. Default is at the start.
6533 No width fields allowed.
6534 = - Separation point between left and right aligned items.
6535 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006536 # - Set highlight group. The name must follow and then a # again.
6537 Thus use %#HLname# for highlight group HLname. The same
6538 highlighting is used, also for the statusline of non-current
6539 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006541 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006542 The difference between User{N} and StatusLine will be applied
6543 to StatusLineNC for the statusline of non-current windows.
6544 The number N must be between 1 and 9. See |hl-User1..9|
6545
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006546 When displaying a flag, Vim removes the leading comma, if any, when
6547 that flag comes right after plaintext. This will make a nice display
6548 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549
Bram Moolenaar582fd852005-03-28 20:58:01 +00006550 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551 not set) and a minwid is not set for the group, the whole group will
6552 become empty. This will make a group like the following disappear
6553 completely from the statusline when none of the flags are set. >
6554 :set statusline=...%(\ [%M%R%H]%)...
6555<
6556 Beware that an expression is evaluated each and every time the status
6557 line is displayed. The current buffer and current window will be set
6558 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006559 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006560 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006561 real current buffer.
6562
6563 The 'statusline' option may be evaluated in the |sandbox|, see
6564 |sandbox-option|.
6565
6566 It is not allowed to change text or jump to another window while
6567 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568
6569 If the statusline is not updated when you want it (e.g., after setting
6570 a variable that's used in an expression), you can force an update by
6571 setting an option without changing its value. Example: >
6572 :let &ro = &ro
6573
6574< A result of all digits is regarded a number for display purposes.
6575 Otherwise the result is taken as flag text and applied to the rules
6576 described above.
6577
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006578 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6580 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6581
6582 Examples:
6583 Emulate standard status line with 'ruler' set >
6584 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6585< Similar, but add ASCII value of char under the cursor (like "ga") >
6586 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6587< Display byte count and byte value, modified flag in red. >
6588 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6589 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6590< Display a ,GZ flag if a compressed file is loaded >
6591 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6592< In the |:autocmd|'s: >
6593 :let b:gzflag = 1
6594< And: >
6595 :unlet b:gzflag
6596< And define this function: >
6597 :function VarExists(var, val)
6598 : if exists(a:var) | return a:val | else | return '' | endif
6599 :endfunction
6600<
6601 *'suffixes'* *'su'*
6602'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6603 global
6604 {not in Vi}
6605 Files with these suffixes get a lower priority when multiple files
6606 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006607 suffixes. Spaces after the comma are ignored. A dot is also seen as
6608 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006609 separator, precede it with a backslash (see |option-backslash| about
6610 including spaces and backslashes).
6611 See 'wildignore' for completely ignoring files.
6612 The use of |:set+=| and |:set-=| is preferred when adding or removing
6613 suffixes from the list. This avoids problems when a future version
6614 uses another default.
6615
6616 *'suffixesadd'* *'sua'*
6617'suffixesadd' 'sua' string (default "")
6618 local to buffer
6619 {not in Vi}
6620 {not available when compiled without the
6621 |+file_in_path| feature}
6622 Comma separated list of suffixes, which are used when searching for a
6623 file for the "gf", "[I", etc. commands. Example: >
6624 :set suffixesadd=.java
6625<
6626 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6627'swapfile' 'swf' boolean (default on)
6628 local to buffer
6629 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006630 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 swapfile is not wanted for a specific buffer. For example, with
6632 confidential information that even root must not be able to access.
6633 Careful: All text will be in memory:
6634 - Don't use this for big files.
6635 - Recovery will be impossible!
6636 A swapfile will only be present when |'updatecount'| is non-zero and
6637 'swapfile' is set.
6638 When 'swapfile' is reset, the swap file for the current buffer is
6639 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6640 non-zero, a swap file is immediately created.
6641 Also see |swap-file| and |'swapsync'|.
6642
6643 This option is used together with 'bufhidden' and 'buftype' to
6644 specify special kinds of buffers. See |special-buffers|.
6645
6646 *'swapsync'* *'sws'*
6647'swapsync' 'sws' string (default "fsync")
6648 global
6649 {not in Vi}
6650 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006651 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 When this option is empty parts of the swap file may be in memory and
6653 not written to disk. When the system crashes you may lose more work.
6654 On Unix the system does a sync now and then without Vim asking for it,
6655 so the disadvantage of setting this option off is small. On some
6656 systems the swap file will not be written at all. For a unix system
6657 setting it to "sync" will use the sync() call instead of the default
6658 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006659 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660
6661 *'switchbuf'* *'swb'*
6662'switchbuf' 'swb' string (default "")
6663 global
6664 {not in Vi}
6665 This option controls the behavior when switching between buffers.
6666 Possible values (comma separated list):
6667 useopen If included, jump to the first open window that
6668 contains the specified buffer (if there is one).
6669 Otherwise: Do not examine other windows.
6670 This setting is checked with |quickfix| commands, when
6671 jumping to errors (":cc", ":cn", "cp", etc.). It is
6672 also used in all buffer related split commands, for
6673 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006674 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006675 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006677 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006679 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006680 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006682 *'synmaxcol'* *'smc'*
6683'synmaxcol' 'smc' number (default 3000)
6684 local to buffer
6685 {not in Vi}
6686 {not available when compiled without the |+syntax|
6687 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006688 Maximum column in which to search for syntax items. In long lines the
6689 text after this column is not highlighted and following lines may not
6690 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006691 This helps to avoid very slow redrawing for an XML file that is one
6692 long line.
6693 Set to zero to remove the limit.
6694
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695 *'syntax'* *'syn'*
6696'syntax' 'syn' string (default empty)
6697 local to buffer
6698 {not in Vi}
6699 {not available when compiled without the |+syntax|
6700 feature}
6701 When this option is set, the syntax with this name is loaded, unless
6702 syntax highlighting has been switched off with ":syntax off".
6703 Otherwise this option does not always reflect the current syntax (the
6704 b:current_syntax variable does).
6705 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006706 not automatically recognized. Example, in an IDL file:
6707 /* vim: set syntax=idl : */ ~
6708 When a dot appears in the value then this separates two filetype
6709 names. Example:
6710 /* vim: set syntax=c.doxygen : */ ~
6711 This will use the "c" syntax first, then the "doxygen" syntax.
6712 Note that the second one must be prepared to be loaded as an addition,
6713 otherwise it will be skipped. More than one dot may appear.
6714 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 :set syntax=OFF
6716< To switch syntax highlighting on according to the current value of the
6717 'filetype' option: >
6718 :set syntax=ON
6719< What actually happens when setting the 'syntax' option is that the
6720 Syntax autocommand event is triggered with the value as argument.
6721 This option is not copied to another buffer, independent of the 's' or
6722 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006723 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006725 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006726'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006727 global
6728 {not in Vi}
6729 {not available when compiled without the +windows
6730 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006731 When nonempty, this option determines the content of the tab pages
6732 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006733 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006734
6735 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006736 option and only when there is no GUI tab line. When 'e' is in
6737 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6738 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006739
6740 The value is evaluated like with 'statusline'. You can use
6741 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006742 the text to be displayed. Use "%1T" for the first label, "%2T" for
6743 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006744
6745 Keep in mind that only one of the tab pages is the current one, others
6746 are invisible and you can't jump to their windows.
6747
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006748
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006749 *'tabpagemax'* *'tpm'*
6750'tabpagemax' 'tpm' number (default 10)
6751 global
6752 {not in Vi}
6753 {not available when compiled without the +windows
6754 feature}
6755 Maximum number of tab pages to be opened by the |-p| command line
6756 argument or the ":tab all" command. |tabpage|
6757
6758
6759 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760'tabstop' 'ts' number (default 8)
6761 local to buffer
6762 Number of spaces that a <Tab> in the file counts for. Also see
6763 |:retab| command, and 'softtabstop' option.
6764
6765 Note: Setting 'tabstop' to any other value than 8 can make your file
6766 appear wrong in many places (e.g., when printing it).
6767
6768 There are four main ways to use tabs in Vim:
6769 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6770 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006771 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 behave like a tab appears every 4 (or 3) characters.
6773 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6774 'expandtab'. This way you will always insert spaces. The
6775 formatting will never be messed up when 'tabstop' is changed.
6776 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006777 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006778 works when using Vim to edit the file.
6779 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6780 'noexpandtab'. This should then work (for initial indents only)
6781 for any tabstop setting that people use. It might be nice to have
6782 tabs after the first non-blank inserted as spaces if you do this
6783 though. Otherwise aligned comments will be wrong when 'tabstop' is
6784 changed.
6785
6786 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6787'tagbsearch' 'tbs' boolean (default on)
6788 global
6789 {not in Vi}
6790 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006791 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792 searching makes searching for a tag a LOT faster, but a linear search
6793 will find more tags if the tags file wasn't properly sorted.
6794 Vim normally assumes that your tags files are sorted, or indicate that
6795 they are not sorted. Only when this is not the case does the
6796 'tagbsearch' option need to be switched off.
6797
6798 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006799 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800 certain files, or retry all files with a linear search. When
6801 'tagbsearch' is off, only a linear search is done.
6802
6803 Linear searching is done anyway, for one file, when Vim finds a line
6804 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006805 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806< [The whitespace before and after the '0' must be a single <Tab>]
6807
6808 When a binary search was done and no match was found in any of the
6809 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6810 instead of a normal tag name, a retry is done with a linear search.
6811 Tags in unsorted tags files, and matches with different case will only
6812 be found in the retry.
6813
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006814 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006815 linear search can be avoided for the 'ignorecase' case. Use a value
6816 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6817 case-fold sorted with the -f switch to "sort" in most unices, as in
6818 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006819 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6820 for this as well. Note that case must be folded to uppercase for this
6821 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822
6823 When 'tagbsearch' is off, tags searching is slower when a full match
6824 exists, but faster when no full match exists. Tags in unsorted tags
6825 files may only be found with 'tagbsearch' off.
6826 When the tags file is not sorted, or sorted in a wrong way (not on
6827 ASCII byte value), 'tagbsearch' should be off, or the line given above
6828 must be included in the tags file.
6829 This option doesn't affect commands that find all matching tags (e.g.,
6830 command-line completion and ":help").
6831 {Vi: always uses binary search in some versions}
6832
6833 *'taglength'* *'tl'*
6834'taglength' 'tl' number (default 0)
6835 global
6836 If non-zero, tags are significant up to this number of characters.
6837
6838 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6839'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6840 global
6841 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006842 If on and using a tags file in another directory, file names in that
6843 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 NOTE: This option is set to the Vi default value when 'compatible' is
6845 set and to the Vim default value when 'compatible' is reset.
6846
6847 *'tags'* *'tag'* *E433*
6848'tags' 'tag' string (default "./tags,tags", when compiled with
6849 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6850 global or local to buffer |global-local|
6851 Filenames for the tag command, separated by spaces or commas. To
6852 include a space or comma in a file name, precede it with a backslash
6853 (see |option-backslash| about including spaces and backslashes).
6854 When a file name starts with "./", the '.' is replaced with the path
6855 of the current file. But only when the 'd' flag is not included in
6856 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6857 |tags-option|.
6858 "*", "**" and other wildcards can be used to search for tags files in
6859 a directory tree. See |file-searching|. {not available when compiled
6860 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006861 The |tagfiles()| function can be used to get a list of the file names
6862 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6864 files are also supported. They are automatically recognized. The
6865 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6866 differences are ignored (MS-Windows). |emacs-tags|
6867 The use of |:set+=| and |:set-=| is preferred when adding or removing
6868 file names from the list. This avoids problems when a future version
6869 uses another default.
6870 {Vi: default is "tags /usr/lib/tags"}
6871
6872 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6873'tagstack' 'tgst' boolean (default on)
6874 global
6875 {not in all versions of Vi}
6876 When on, the |tagstack| is used normally. When off, a ":tag" or
6877 ":tselect" command with an argument will not push the tag onto the
6878 tagstack. A following ":tag" without an argument, a ":pop" command or
6879 any other command that uses the tagstack will use the unmodified
6880 tagstack, but does change the pointer to the active entry.
6881 Resetting this option is useful when using a ":tag" command in a
6882 mapping which should not change the tagstack.
6883
6884 *'term'* *E529* *E530* *E531*
6885'term' string (default is $TERM, if that fails:
6886 in the GUI: "builtin_gui"
6887 on Amiga: "amiga"
6888 on BeOS: "beos-ansi"
6889 on Mac: "mac-ansi"
6890 on MiNT: "vt52"
6891 on MS-DOS: "pcterm"
6892 on OS/2: "os2ansi"
6893 on Unix: "ansi"
6894 on VMS: "ansi"
6895 on Win 32: "win32")
6896 global
6897 Name of the terminal. Used for choosing the terminal control
6898 characters. Environment variables are expanded |:set_env|.
6899 For example: >
6900 :set term=$TERM
6901< See |termcap|.
6902
6903 *'termbidi'* *'tbidi'*
6904 *'notermbidi'* *'notbidi'*
6905'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6906 global
6907 {not in Vi}
6908 {only available when compiled with the |+arabic|
6909 feature}
6910 The terminal is in charge of Bi-directionality of text (as specified
6911 by Unicode). The terminal is also expected to do the required shaping
6912 that some languages (such as Arabic) require.
6913 Setting this option implies that 'rightleft' will not be set when
6914 'arabic' is set and the value of 'arabicshape' will be ignored.
6915 Note that setting 'termbidi' has the immediate effect that
6916 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6917 This option is reset when the GUI is started.
6918 For further details see |arabic.txt|.
6919
6920 *'termencoding'* *'tenc'*
6921'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6922 Macintosh GUI: "macroman")
6923 global
6924 {only available when compiled with the |+multi_byte|
6925 feature}
6926 {not in Vi}
6927 Encoding used for the terminal. This specifies what character
6928 encoding the keyboard produces and the display will understand. For
6929 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006930 display). Except for the Mac when 'macatsui' is off, then
6931 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 In the Win32 console version the default value is the console codepage
6933 when it differs from the ANSI codepage.
6934 *E617*
6935 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6936 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6937 Any attempts to set a different value will be rejected, and an error
6938 message is shown.
6939 For the Win32 GUI 'termencoding' is not used for typed characters,
6940 because the Win32 system always passes Unicode characters.
6941 When empty, the same encoding is used as for the 'encoding' option.
6942 This is the normal value.
6943 Not all combinations for 'termencoding' and 'encoding' are valid. See
6944 |encoding-table|.
6945 The value for this option must be supported by internal conversions or
6946 iconv(). When this is not possible no conversion will be done and you
6947 will probably experience problems with non-ASCII characters.
6948 Example: You are working with the locale set to euc-jp (Japanese) and
6949 want to edit a UTF-8 file: >
6950 :let &termencoding = &encoding
6951 :set encoding=utf-8
6952< You need to do this when your system has no locale support for UTF-8.
6953
6954 *'terse'* *'noterse'*
6955'terse' boolean (default off)
6956 global
6957 When set: Add 's' flag to 'shortmess' option (this makes the message
6958 for a search that hits the start or end of the file not being
6959 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6960 shortens a lot of messages}
6961
6962 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6963'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6964 global
6965 {not in Vi}
6966 This option is obsolete. Use 'fileformats'.
6967 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6968 set to the default value for the current system. When 'textauto' is
6969 reset, 'fileformats' is made empty.
6970 NOTE: This option is set to the Vi default value when 'compatible' is
6971 set and to the Vim default value when 'compatible' is reset.
6972
6973 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6974'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6975 others: default off)
6976 local to buffer
6977 {not in Vi}
6978 This option is obsolete. Use 'fileformat'.
6979 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6980 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6981 "unix".
6982
6983 *'textwidth'* *'tw'*
6984'textwidth' 'tw' number (default 0)
6985 local to buffer
6986 {not in Vi}
6987 Maximum width of text that is being inserted. A longer line will be
6988 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006989 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6990 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00006992 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 NOTE: This option is set to 0 when 'compatible' is set.
6994
6995 *'thesaurus'* *'tsr'*
6996'thesaurus' 'tsr' string (default "")
6997 global or local to buffer |global-local|
6998 {not in Vi}
6999 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007000 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001 the file should contain words with similar meaning, separated by
7002 non-keyword characters (white space is preferred). Maximum line
7003 length is 510 bytes.
7004 To obtain a file to be used here, check out the wordlist FAQ at
7005 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007006 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007007 after a comma are ignored, otherwise spaces are included in the file
7008 name. See |option-backslash| about using backslashes.
7009 The use of |:set+=| and |:set-=| is preferred when adding or removing
7010 directories from the list. This avoids problems when a future version
7011 uses another default.
7012 Backticks cannot be used in this option for security reasons.
7013
7014 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7015'tildeop' 'top' boolean (default off)
7016 global
7017 {not in Vi}
7018 When on: The tilde command "~" behaves like an operator.
7019 NOTE: This option is reset when 'compatible' is set.
7020
7021 *'timeout'* *'to'* *'notimeout'* *'noto'*
7022'timeout' 'to' boolean (default on)
7023 global
7024 *'ttimeout'* *'nottimeout'*
7025'ttimeout' boolean (default off)
7026 global
7027 {not in Vi}
7028 These two options together determine the behavior when part of a
7029 mapped key sequence or keyboard code has been received:
7030
7031 'timeout' 'ttimeout' action ~
7032 off off do not time out
7033 on on or off time out on :mappings and key codes
7034 off on time out on key codes
7035
7036 If both options are off, Vim will wait until either the complete
7037 mapping or key sequence has been received, or it is clear that there
7038 is no mapping or key sequence for the received characters. For
7039 example: if you have mapped "vl" and Vim has received 'v', the next
7040 character is needed to see if the 'v' is followed by an 'l'.
7041 When one of the options is on, Vim will wait for about 1 second for
7042 the next character to arrive. After that the already received
7043 characters are interpreted as single characters. The waiting time can
7044 be changed with the 'timeoutlen' option.
7045 On slow terminals or very busy systems timing out may cause
7046 malfunctioning cursor keys. If both options are off, Vim waits
7047 forever after an entered <Esc> if there are key codes that start
7048 with <Esc>. You will have to type <Esc> twice. If you do not have
7049 problems with key codes, but would like to have :mapped key
7050 sequences not timing out in 1 second, set the 'ttimeout' option and
7051 reset the 'timeout' option.
7052
7053 NOTE: 'ttimeout' is reset when 'compatible' is set.
7054
7055 *'timeoutlen'* *'tm'*
7056'timeoutlen' 'tm' number (default 1000)
7057 global
7058 {not in all versions of Vi}
7059 *'ttimeoutlen'* *'ttm'*
7060'ttimeoutlen' 'ttm' number (default -1)
7061 global
7062 {not in Vi}
7063 The time in milliseconds that is waited for a key code or mapped key
7064 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7065 when part of a command has been typed.
7066 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7067 different timeout value for key codes is desired set 'ttimeoutlen' to
7068 a non-negative number.
7069
7070 ttimeoutlen mapping delay key code delay ~
7071 < 0 'timeoutlen' 'timeoutlen'
7072 >= 0 'timeoutlen' 'ttimeoutlen'
7073
7074 The timeout only happens when the 'timeout' and 'ttimeout' options
7075 tell so. A useful setting would be >
7076 :set timeout timeoutlen=3000 ttimeoutlen=100
7077< (time out on mapping after three seconds, time out on key codes after
7078 a tenth of a second).
7079
7080 *'title'* *'notitle'*
7081'title' boolean (default off, on when title can be restored)
7082 global
7083 {not in Vi}
7084 {not available when compiled without the |+title|
7085 feature}
7086 When on, the title of the window will be set to the value of
7087 'titlestring' (if it is not empty), or to:
7088 filename [+=-] (path) - VIM
7089 Where:
7090 filename the name of the file being edited
7091 - indicates the file cannot be modified, 'ma' off
7092 + indicates the file was modified
7093 = indicates the file is read-only
7094 =+ indicates the file is read-only and modified
7095 (path) is the path of the file being edited
7096 - VIM the server name |v:servername| or "VIM"
7097 Only works if the terminal supports setting window titles
7098 (currently Amiga console, Win32 console, all GUI versions and
7099 terminals with a non- empty 't_ts' option - these are Unix xterm and
7100 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7101 *X11*
7102 When Vim was compiled with HAVE_X11 defined, the original title will
7103 be restored if possible. The output of ":version" will include "+X11"
7104 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7105 works for the icon name |'icon'|.
7106 But: When Vim was started with the |-X| argument, restoring the title
7107 will not work (except in the GUI).
7108 If the title cannot be restored, it is set to the value of 'titleold'.
7109 You might want to restore the title outside of Vim then.
7110 When using an xterm from a remote machine you can use this command:
7111 rsh machine_name xterm -display $DISPLAY &
7112 then the WINDOWID environment variable should be inherited and the
7113 title of the window should change back to what it should be after
7114 exiting Vim.
7115
7116 *'titlelen'*
7117'titlelen' number (default 85)
7118 global
7119 {not in Vi}
7120 {not available when compiled without the |+title|
7121 feature}
7122 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007123 title. When the title is longer, only the end of the path name is
7124 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 Using a percentage makes this adapt to the width of the window. But
7126 it won't work perfectly, because the actual number of characters
7127 available also depends on the font used and other things in the title
7128 bar. When 'titlelen' is zero the full path is used. Otherwise,
7129 values from 1 to 30000 percent can be used.
7130 'titlelen' is also used for the 'titlestring' option.
7131
7132 *'titleold'*
7133'titleold' string (default "Thanks for flying Vim")
7134 global
7135 {not in Vi}
7136 {only available when compiled with the |+title|
7137 feature}
7138 This option will be used for the window title when exiting Vim if the
7139 original title cannot be restored. Only happens if 'title' is on or
7140 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007141 This option cannot be set from a |modeline| or in the |sandbox|, for
7142 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 *'titlestring'*
7144'titlestring' string (default "")
7145 global
7146 {not in Vi}
7147 {not available when compiled without the |+title|
7148 feature}
7149 When this option is not empty, it will be used for the title of the
7150 window. This happens only when the 'title' option is on.
7151 Only works if the terminal supports setting window titles (currently
7152 Amiga console, Win32 console, all GUI versions and terminals with a
7153 non-empty 't_ts' option).
7154 When Vim was compiled with HAVE_X11 defined, the original title will
7155 be restored if possible |X11|.
7156 When this option contains printf-style '%' items, they will be
7157 expanded according to the rules used for 'statusline'.
7158 Example: >
7159 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7160 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7161< The value of 'titlelen' is used to align items in the middle or right
7162 of the available space.
7163 Some people prefer to have the file name first: >
7164 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7165< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007166 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007167 separating space only when needed.
7168 NOTE: Use of special characters in 'titlestring' may cause the display
7169 to be garbled (e.g., when it contains a CR or NL character).
7170 {not available when compiled without the |+statusline| feature}
7171
7172 *'toolbar'* *'tb'*
7173'toolbar' 'tb' string (default "icons,tooltips")
7174 global
7175 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7176 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007177 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178 possible values are:
7179 icons Toolbar buttons are shown with icons.
7180 text Toolbar buttons shown with text.
7181 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007182 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007183 tooltips Tooltips are active for toolbar buttons.
7184 Tooltips refer to the popup help text which appears after the mouse
7185 cursor is placed over a toolbar button for a brief moment.
7186
7187 If you want the toolbar to be shown with icons as well as text, do the
7188 following: >
7189 :set tb=icons,text
7190< Motif and Athena cannot display icons and text at the same time. They
7191 will show icons if both are requested.
7192
7193 If none of the strings specified in 'toolbar' are valid or if
7194 'toolbar' is empty, this option is ignored. If you want to disable
7195 the toolbar, you need to set the 'guioptions' option. For example: >
7196 :set guioptions-=T
7197< Also see |gui-toolbar|.
7198
7199 *'toolbariconsize'* *'tbis'*
7200'toolbariconsize' 'tbis' string (default "small")
7201 global
7202 {not in Vi}
7203 {only in the GTK+ 2 GUI}
7204 Controls the size of toolbar icons. The possible values are:
7205 tiny Use tiny toolbar icons.
7206 small Use small toolbar icons (default).
7207 medium Use medium-sized toolbar icons.
7208 large Use large toolbar icons.
7209 The exact dimensions in pixels of the various icon sizes depend on
7210 the current theme. Common dimensions are large=32x32, medium=24x24,
7211 small=20x20 and tiny=16x16.
7212
7213 If 'toolbariconsize' is empty, the global default size as determined
7214 by user preferences or the current theme is used.
7215
7216 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7217'ttybuiltin' 'tbi' boolean (default on)
7218 global
7219 {not in Vi}
7220 When on, the builtin termcaps are searched before the external ones.
7221 When off the builtin termcaps are searched after the external ones.
7222 When this option is changed, you should set the 'term' option next for
7223 the change to take effect, for example: >
7224 :set notbi term=$TERM
7225< See also |termcap|.
7226 Rationale: The default for this option is "on", because the builtin
7227 termcap entries are generally better (many systems contain faulty
7228 xterm entries...).
7229
7230 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7231'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7232 sun-cmd, screen, rxvt, dtterm or
7233 iris-ansi; also on when running Vim in
7234 a DOS console)
7235 global
7236 {not in Vi}
7237 Indicates a fast terminal connection. More characters will be sent to
7238 the screen for redrawing, instead of using insert/delete line
7239 commands. Improves smoothness of redrawing when there are multiple
7240 windows and the terminal does not support a scrolling region.
7241 Also enables the extra writing of characters at the end of each screen
7242 line for lines that wrap. This helps when using copy/paste with the
7243 mouse in an xterm and other terminals.
7244
7245 *'ttymouse'* *'ttym'*
7246'ttymouse' 'ttym' string (default depends on 'term')
7247 global
7248 {not in Vi}
7249 {only in Unix and VMS, doesn't work in the GUI; not
7250 available when compiled without |+mouse|}
7251 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007252 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 *xterm-mouse*
7254 xterm xterm-like mouse handling. The mouse generates
7255 "<Esc>[Mscr", where "scr" is three bytes:
7256 "s" = button state
7257 "c" = column plus 33
7258 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007259 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007260 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007261 xterm2 Works like "xterm", but with the xterm reporting the
7262 mouse position while the mouse is dragged. This works
7263 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007264 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265 work. See below for how Vim detects this
7266 automatically.
7267 *netterm-mouse*
7268 netterm NetTerm mouse handling. The mouse generates
7269 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7270 for the row and column.
7271 *dec-mouse*
7272 dec DEC terminal mouse handling. The mouse generates a
7273 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007274 This is also available for an Xterm, if it was
7275 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276 *jsbterm-mouse*
7277 jsbterm JSB term mouse handling.
7278 *pterm-mouse*
7279 pterm QNX pterm mouse handling.
7280
7281 The mouse handling must be enabled at compile time |+mouse_xterm|
7282 |+mouse_dec| |+mouse_netterm|.
7283 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7284 recognized, if enabled at compile time. DEC terminal mouse codes
7285 are recognized if enabled at compile time, and 'ttymouse' is not
7286 "xterm" (because the xterm and dec mouse codes conflict).
7287 This option is automatically set to "xterm", when the 'term' option is
7288 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7289 or "xterm2" already. The main use of this option is to set it to
7290 "xterm", when the terminal name doesn't start with "xterm", but it can
7291 handle xterm mouse codes.
7292 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007293 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007294 feature and if |t_RV| is set to the escape sequence to request the
7295 xterm version number. Otherwise "xterm2" must be set explicitly.
7296 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7297 t_RV to an empty string: >
7298 :set t_RV=
7299<
7300 *'ttyscroll'* *'tsl'*
7301'ttyscroll' 'tsl' number (default 999)
7302 global
7303 Maximum number of lines to scroll the screen. If there are more lines
7304 to scroll the window is redrawn. For terminals where scrolling is
7305 very slow and redrawing is not slow this can be set to a small number,
7306 e.g., 3, to speed up displaying.
7307
7308 *'ttytype'* *'tty'*
7309'ttytype' 'tty' string (default from $TERM)
7310 global
7311 Alias for 'term', see above.
7312
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007313 *'undodir'* *'udir'*
7314'undodir' 'udir' string (default ".")
7315 global
7316 {not in Vi}
7317 {only when compiled with the +persistent_undo feature}
7318 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007319 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007320 "." means using the directory of the file. The undo file name for
7321 "file.txt" is ".file.txt.un~".
7322 For other directories the file name is the full path of the edited
7323 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007324 When writing: The first directory that exists is used. "." always
7325 works, no directories after "." will be used for writing.
7326 When reading all entries are tried to find an undo file. The first
7327 undo file that exists is used. When it cannot be read an error is
7328 given, no further entry is used.
7329 See |undo-persistence|.
7330
7331 *'undofile'* *'udf'*
7332'undofile' 'udf' boolean (default off)
7333 local to buffer
7334 {not in Vi}
7335 {only when compiled with the +persistent_undo feature}
7336 When on, Vim automatically saves undo history to an undo file when
7337 writing a buffer to a file, and restores undo history from the same
7338 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007339 The directory where the undo file is stored is specified by 'undodir'.
7340 For more information about this feature see |undo-persistence|.
7341 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007342
Bram Moolenaar071d4272004-06-13 20:20:40 +00007343 *'undolevels'* *'ul'*
7344'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7345 Win32 and OS/2)
7346 global
7347 {not in Vi}
7348 Maximum number of changes that can be undone. Since undo information
7349 is kept in memory, higher numbers will cause more memory to be used
7350 (nevertheless, a single change can use an unlimited amount of memory).
7351 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7352 itself: >
7353 set ul=0
7354< But you can also get Vi compatibility by including the 'u' flag in
7355 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007356 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357 Set to a negative number for no undo at all: >
7358 set ul=-1
7359< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007360 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361
7362 *'updatecount'* *'uc'*
7363'updatecount' 'uc' number (default: 200)
7364 global
7365 {not in Vi}
7366 After typing this many characters the swap file will be written to
7367 disk. When zero, no swap file will be created at all (see chapter on
7368 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7369 Vim with the "-n" option, see |startup|. When editing in readonly
7370 mode this option will be initialized to 10000.
7371 The swapfile can be disabled per buffer with |'swapfile'|.
7372 When 'updatecount' is set from zero to non-zero, swap files are
7373 created for all buffers that have 'swapfile' set. When 'updatecount'
7374 is set to zero, existing swap files are not deleted.
7375 Also see |'swapsync'|.
7376 This option has no meaning in buffers where |'buftype'| is "nofile"
7377 or "nowrite".
7378
7379 *'updatetime'* *'ut'*
7380'updatetime' 'ut' number (default 4000)
7381 global
7382 {not in Vi}
7383 If this many milliseconds nothing is typed the swap file will be
7384 written to disk (see |crash-recovery|). Also used for the
7385 |CursorHold| autocommand event.
7386
7387 *'verbose'* *'vbs'*
7388'verbose' 'vbs' number (default 0)
7389 global
7390 {not in Vi, although some versions have a boolean
7391 verbose option}
7392 When bigger than zero, Vim will give messages about what it is doing.
7393 Currently, these messages are given:
7394 >= 1 When the viminfo file is read or written.
7395 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007396 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397 >= 8 Files for which a group of autocommands is executed.
7398 >= 9 Every executed autocommand.
7399 >= 12 Every executed function.
7400 >= 13 When an exception is thrown, caught, finished, or discarded.
7401 >= 14 Anything pending in a ":finally" clause.
7402 >= 15 Every executed Ex command (truncated at 200 characters).
7403
7404 This option can also be set with the "-V" argument. See |-V|.
7405 This option is also set by the |:verbose| command.
7406
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007407 When the 'verbosefile' option is set then the verbose messages are not
7408 displayed.
7409
7410 *'verbosefile'* *'vfile'*
7411'verbosefile' 'vfile' string (default empty)
7412 global
7413 {not in Vi}
7414 When not empty all messages are written in a file with this name.
7415 When the file exists messages are appended.
7416 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007417 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007418 Setting 'verbosefile' to a new value is like making it empty first.
7419 The difference with |:redir| is that verbose messages are not
7420 displayed when 'verbosefile' is set.
7421
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422 *'viewdir'* *'vdir'*
7423'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7424 "$VIM/vimfiles/view",
7425 for Unix: "~/.vim/view",
7426 for Macintosh: "$VIM:vimfiles:view"
7427 for VMS: "sys$login:vimfiles/view"
7428 for RiscOS: "Choices:vimfiles/view")
7429 global
7430 {not in Vi}
7431 {not available when compiled without the +mksession
7432 feature}
7433 Name of the directory where to store files for |:mkview|.
7434 This option cannot be set from a |modeline| or in the |sandbox|, for
7435 security reasons.
7436
7437 *'viewoptions'* *'vop'*
7438'viewoptions' 'vop' string (default: "folds,options,cursor")
7439 global
7440 {not in Vi}
7441 {not available when compiled without the +mksession
7442 feature}
7443 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007444 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007445 word save and restore ~
7446 cursor cursor position in file and in window
7447 folds manually created folds, opened/closed folds and local
7448 fold options
7449 options options and mappings local to a window or buffer (not
7450 global values for local options)
7451 slash backslashes in file names replaced with forward
7452 slashes
7453 unix with Unix end-of-line format (single <NL>), even when
7454 on Windows or DOS
7455
7456 "slash" and "unix" are useful on Windows when sharing view files
7457 with Unix. The Unix version of Vim cannot source dos format scripts,
7458 but the Windows version of Vim can source unix format scripts.
7459
7460 *'viminfo'* *'vi'* *E526* *E527* *E528*
7461'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007462 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7463 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7464 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 global
7466 {not in Vi}
7467 {not available when compiled without the |+viminfo|
7468 feature}
7469 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007470 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 separated list of parameters, each consisting of a single character
7472 identifying the particular parameter, followed by a number or string
7473 which specifies the value of that parameter. If a particular
7474 character is left out, then the default value is used for that
7475 parameter. The following is a list of the identifying characters and
7476 the effect of their value.
7477 CHAR VALUE ~
7478 ! When included, save and restore global variables that start
7479 with an uppercase letter, and don't contain a lowercase
7480 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007481 and "_K_L_M" are not. Only String and Number types are
7482 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007483 " Maximum number of lines saved for each register. Old name of
7484 the '<' item, with the disadvantage that you need to put a
7485 backslash before the ", otherwise it will be recognized as the
7486 start of a comment!
7487 % When included, save and restore the buffer list. If Vim is
7488 started with a file name argument, the buffer list is not
7489 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007490 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007491 without a file name and buffers for help files are not written
7492 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007493 When followed by a number, the number specifies the maximum
7494 number of buffers that are stored. Without a number all
7495 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 ' Maximum number of previously edited files for which the marks
7497 are remembered. This parameter must always be included when
7498 'viminfo' is non-empty.
7499 Including this item also means that the |jumplist| and the
7500 |changelist| are stored in the viminfo file.
7501 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007502 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503 patterns are also saved. When not included, the value of
7504 'history' is used.
7505 : Maximum number of items in the command-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 < Maximum number of lines saved for each register. If zero then
7508 registers are not saved. When not included, all lines are
7509 saved. '"' is the old name for this item.
7510 Also see the 's' item below: limit specified in Kbyte.
7511 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007512 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 c When included, convert the text in the viminfo file from the
7514 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007515 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007516 f Whether file marks need to be stored. If zero, file marks ('0
7517 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007518 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 cursor position (when exiting or when doing ":wviminfo").
7520 h Disable the effect of 'hlsearch' when loading the viminfo
7521 file. When not included, it depends on whether ":nohlsearch"
7522 has been used since the last search command.
7523 n Name of the viminfo file. The name must immediately follow
7524 the 'n'. Must be the last one! If the "-i" argument was
7525 given when starting Vim, that file name overrides the one
7526 given here with 'viminfo'. Environment variables are expanded
7527 when opening the file, not when setting the option.
7528 r Removable media. The argument is a string (up to the next
7529 ','). This parameter can be given several times. Each
7530 specifies the start of a path for which no marks will be
7531 stored. This is to avoid removable media. For MS-DOS you
7532 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7533 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7534 ignored. Maximum length of each 'r' argument is 50
7535 characters.
7536 s Maximum size of an item in Kbyte. If zero then registers are
7537 not saved. Currently only applies to registers. The default
7538 "s10" will exclude registers with more than 10 Kbyte of text.
7539 Also see the '<' item above: line count limit.
7540
7541 Example: >
7542 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7543<
7544 '50 Marks will be remembered for the last 50 files you
7545 edited.
7546 <1000 Contents of registers (up to 1000 lines each) will be
7547 remembered.
7548 s100 Registers with more than 100 Kbyte text are skipped.
7549 :0 Command-line history will not be saved.
7550 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7551 no / Since '/' is not specified, the default will be used,
7552 that is, save all of the search history, and also the
7553 previous search and substitute patterns.
7554 no % The buffer list will not be saved nor read back.
7555 no h 'hlsearch' highlighting will be restored.
7556
7557 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7558 load the contents of the file, this is not done automatically.
7559
7560 This option cannot be set from a |modeline| or in the |sandbox|, for
7561 security reasons.
7562
7563 *'virtualedit'* *'ve'*
7564'virtualedit' 've' string (default "")
7565 global
7566 {not in Vi}
7567 {not available when compiled without the
7568 |+virtualedit| feature}
7569 A comma separated list of these words:
7570 block Allow virtual editing in Visual block mode.
7571 insert Allow virtual editing in Insert mode.
7572 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007573 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007574
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007576 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 of the line. Useful for selecting a rectangle in Visual mode and
7578 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007579 "onemore" is not the same, it will only allow moving the cursor just
7580 after the last character of the line. This makes some commands more
7581 consistent. Previously the cursor was always past the end of the line
7582 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007583 break some plugins or Vim scripts. For example because |l| can move
7584 the cursor after the last character. Use with care!
7585 Using the |$| command will move to the last character in the line, not
7586 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007587 It doesn't make sense to combine "all" with "onemore", but you will
7588 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589
7590 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7591'visualbell' 'vb' boolean (default off)
7592 global
7593 {not in Vi}
7594 Use visual bell instead of beeping. The terminal code to display the
7595 visual bell is given with 't_vb'. When no beep or flash is wanted,
7596 use ":set vb t_vb=".
7597 Note: When the GUI starts, 't_vb' is reset to its default value. You
7598 might want to set it again in your |gvimrc|.
7599 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7600 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7601 where 40 is the time in msec.
7602 Does not work on the Amiga, you always get a screen flash.
7603 Also see 'errorbells'.
7604
7605 *'warn'* *'nowarn'*
7606'warn' boolean (default on)
7607 global
7608 Give a warning message when a shell command is used while the buffer
7609 has been changed.
7610
7611 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7612'weirdinvert' 'wiv' boolean (default off)
7613 global
7614 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007615 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 It is provided for backwards compatibility with version 4.x.
7617 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7618 vice versa. Has no effect when the GUI is running.
7619
7620 *'whichwrap'* *'ww'*
7621'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7622 global
7623 {not in Vi}
7624 Allow specified keys that move the cursor left/right to move to the
7625 previous/next line when the cursor is on the first/last character in
7626 the line. Concatenate characters to allow this for these keys:
7627 char key mode ~
7628 b <BS> Normal and Visual
7629 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007630 h "h" Normal and Visual (not recommended)
7631 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632 < <Left> Normal and Visual
7633 > <Right> Normal and Visual
7634 ~ "~" Normal
7635 [ <Left> Insert and Replace
7636 ] <Right> Insert and Replace
7637 For example: >
7638 :set ww=<,>,[,]
7639< allows wrap only when cursor keys are used.
7640 When the movement keys are used in combination with a delete or change
7641 operator, the <EOL> also counts for a character. This makes "3h"
7642 different from "3dh" when the cursor crosses the end of a line. This
7643 is also true for "x" and "X", because they do the same as "dl" and
7644 "dh". If you use this, you may also want to use the mapping
7645 ":map <BS> X" to make backspace delete the character in front of the
7646 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007647 When 'l' is included and it is used after an operator at the end of a
7648 line then it will not move to the next line. This makes "dl", "cl",
7649 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650 NOTE: This option is set to the Vi default value when 'compatible' is
7651 set and to the Vim default value when 'compatible' is reset.
7652
7653 *'wildchar'* *'wc'*
7654'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7655 global
7656 {not in Vi}
7657 Character you have to type to start wildcard expansion in the
7658 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007659 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007660 The character is not recognized when used inside a macro. See
7661 'wildcharm' for that.
7662 Although 'wc' is a number option, you can set it to a special key: >
7663 :set wc=<Esc>
7664< NOTE: This option is set to the Vi default value when 'compatible' is
7665 set and to the Vim default value when 'compatible' is reset.
7666
7667 *'wildcharm'* *'wcm'*
7668'wildcharm' 'wcm' number (default: none (0))
7669 global
7670 {not in Vi}
7671 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007672 recognized when used inside a macro. You can find "spare" command-line
7673 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007674 you'll never actually type 'wildcharm', just use it in mappings that
7675 automatically invoke completion mode, e.g.: >
7676 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007677 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007678< Then after typing :ss you can use CTRL-P & CTRL-N.
7679
7680 *'wildignore'* *'wig'*
7681'wildignore' 'wig' string (default "")
7682 global
7683 {not in Vi}
7684 {not available when compiled without the |+wildignore|
7685 feature}
7686 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007687 patterns is ignored when completing file or directory names, and
7688 influences the result of |expand()|, |glob()| and |globpath()| unless
7689 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7691 Also see 'suffixes'.
7692 Example: >
7693 :set wildignore=*.o,*.obj
7694< The use of |:set+=| and |:set-=| is preferred when adding or removing
7695 a pattern from the list. This avoids problems when a future version
7696 uses another default.
7697
7698 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7699'wildmenu' 'wmnu' boolean (default off)
7700 global
7701 {not in Vi}
7702 {not available if compiled without the |+wildmenu|
7703 feature}
7704 When 'wildmenu' is on, command-line completion operates in an enhanced
7705 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7706 the possible matches are shown just above the command line, with the
7707 first match highlighted (overwriting the status line, if there is
7708 one). Keys that show the previous/next match, such as <Tab> or
7709 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7710 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7711 specified. "longest" and "list" do not start "wildmenu" mode.
7712 If there are more matches than can fit in the line, a ">" is shown on
7713 the right and/or a "<" is shown on the left. The status line scrolls
7714 as needed.
7715 The "wildmenu" mode is abandoned when a key is hit that is not used
7716 for selecting a completion.
7717 While the "wildmenu" is active the following keys have special
7718 meanings:
7719
7720 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7721 <Down> - in filename/menu name completion: move into a
7722 subdirectory or submenu.
7723 <CR> - in menu completion, when the cursor is just after a
7724 dot: move into a submenu.
7725 <Up> - in filename/menu name completion: move up into
7726 parent directory or parent menu.
7727
7728 This makes the menus accessible from the console |console-menus|.
7729
7730 If you prefer the <Left> and <Right> keys to move the cursor instead
7731 of selecting a different match, use this: >
7732 :cnoremap <Left> <Space><BS><Left>
7733 :cnoremap <Right> <Space><BS><Right>
7734<
7735 The "WildMenu" highlighting is used for displaying the current match
7736 |hl-WildMenu|.
7737
7738 *'wildmode'* *'wim'*
7739'wildmode' 'wim' string (Vim default: "full")
7740 global
7741 {not in Vi}
7742 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007743 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007744 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 first part specifies the behavior for the first use of 'wildchar',
7746 The second part for the second use, etc.
7747 These are the possible values for each part:
7748 "" Complete only the first match.
7749 "full" Complete the next full match. After the last match,
7750 the original string is used and then the first match
7751 again.
7752 "longest" Complete till longest common string. If this doesn't
7753 result in a longer string, use the next part.
7754 "longest:full" Like "longest", but also start 'wildmenu' if it is
7755 enabled.
7756 "list" When more than one match, list all matches.
7757 "list:full" When more than one match, list all matches and
7758 complete first match.
7759 "list:longest" When more than one match, list all matches and
7760 complete till longest common string.
7761 When there is only a single match, it is fully completed in all cases.
7762
7763 Examples: >
7764 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007765< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007766 :set wildmode=longest,full
7767< Complete longest common string, then each full match >
7768 :set wildmode=list:full
7769< List all matches and complete each full match >
7770 :set wildmode=list,full
7771< List all matches without completing, then each full match >
7772 :set wildmode=longest,list
7773< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007774 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007775
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007776 *'wildoptions'* *'wop'*
7777'wildoptions' 'wop' string (default "")
7778 global
7779 {not in Vi}
7780 {not available when compiled without the |+wildignore|
7781 feature}
7782 A list of words that change how command line completion is done.
7783 Currently only one word is allowed:
7784 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007785 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007786 is displayed per line. Often used tag kinds are:
7787 d #define
7788 f function
7789 Also see |cmdline-completion|.
7790
Bram Moolenaar071d4272004-06-13 20:20:40 +00007791 *'winaltkeys'* *'wak'*
7792'winaltkeys' 'wak' string (default "menu")
7793 global
7794 {not in Vi}
7795 {only used in Win32, Motif, GTK and Photon GUI}
7796 Some GUI versions allow the access to menu entries by using the ALT
7797 key in combination with a character that appears underlined in the
7798 menu. This conflicts with the use of the ALT key for mappings and
7799 entering special characters. This option tells what to do:
7800 no Don't use ALT keys for menus. ALT key combinations can be
7801 mapped, but there is no automatic handling. This can then be
7802 done with the |:simalt| command.
7803 yes ALT key handling is done by the windowing system. ALT key
7804 combinations cannot be mapped.
7805 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007806 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 keys can be mapped.
7808 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7809 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007810 This option is not used for <F10>; on Win32 and with GTK <F10> will
7811 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007813 *'window'* *'wi'*
7814'window' 'wi' number (default screen height - 1)
7815 global
7816 Window height. Do not confuse this with the height of the Vim window,
7817 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007818 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7819 value is smaller than 'lines' minus one. The screen will scroll
7820 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007821 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7822 in a much smarter way, taking care of wrapping lines.
7823 When resizing the Vim window, the value is smaller than 1 or more than
7824 or equal to 'lines' it will be set to 'lines' minus 1.
7825 {Vi also uses the option to specify the number of displayed lines}
7826
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 *'winheight'* *'wh'* *E591*
7828'winheight' 'wh' number (default 1)
7829 global
7830 {not in Vi}
7831 {not available when compiled without the +windows
7832 feature}
7833 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007834 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007835 focus goes to a window that is smaller, its size is increased, at the
7836 cost of the height of other windows.
7837 Set 'winheight' to a small number for normal editing.
7838 Set it to 999 to make the current window fill most of the screen.
7839 Other windows will be only 'winminheight' high. This has the drawback
7840 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7841 to create only two windows, set the option after startup is done,
7842 using the |VimEnter| event: >
7843 au VimEnter * set winheight=999
7844< Minimum value is 1.
7845 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007846 height of the current window.
7847 'winheight' applies to the current window. Use 'winminheight' to set
7848 the minimal height for other windows.
7849
7850 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7851'winfixheight' 'wfh' boolean (default off)
7852 local to window
7853 {not in Vi}
7854 {not available when compiled without the +windows
7855 feature}
7856 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007857 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7858 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859 The height may be changed anyway when running out of room.
7860
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007861 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7862'winfixwidth' 'wfw' boolean (default off)
7863 local to window
7864 {not in Vi}
7865 {not available when compiled without the +windows
7866 feature}
7867 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007868 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007869 The width may be changed anyway when running out of room.
7870
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871 *'winminheight'* *'wmh'*
7872'winminheight' 'wmh' number (default 1)
7873 global
7874 {not in Vi}
7875 {not available when compiled without the +windows
7876 feature}
7877 The minimal height of a window, when it's not the current window.
7878 This is a hard minimum, windows will never become smaller.
7879 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7880 status bar) if necessary. They will return to at least one line when
7881 they become active (since the cursor has to have somewhere to go.)
7882 Use 'winheight' to set the minimal height of the current window.
7883 This option is only checked when making a window smaller. Don't use a
7884 large number, it will cause errors when opening more than a few
7885 windows. A value of 0 to 3 is reasonable.
7886
7887 *'winminwidth'* *'wmw'*
7888'winminwidth' 'wmw' number (default 1)
7889 global
7890 {not in Vi}
7891 {not available when compiled without the +vertsplit
7892 feature}
7893 The minimal width of a window, when it's not the current window.
7894 This is a hard minimum, windows will never become smaller.
7895 When set to zero, windows may be "squashed" to zero columns (i.e. just
7896 a vertical separator) if necessary. They will return to at least one
7897 line when they become active (since the cursor has to have somewhere
7898 to go.)
7899 Use 'winwidth' to set the minimal width of the current window.
7900 This option is only checked when making a window smaller. Don't use a
7901 large number, it will cause errors when opening more than a few
7902 windows. A value of 0 to 12 is reasonable.
7903
7904 *'winwidth'* *'wiw'* *E592*
7905'winwidth' 'wiw' number (default 20)
7906 global
7907 {not in Vi}
7908 {not available when compiled without the +vertsplit
7909 feature}
7910 Minimal number of columns for the current window. This is not a hard
7911 minimum, Vim will use fewer columns if there is not enough room. If
7912 the current window is smaller, its size is increased, at the cost of
7913 the width of other windows. Set it to 999 to make the current window
7914 always fill the screen. Set it to a small number for normal editing.
7915 The width is not adjusted after one of the commands to change the
7916 width of the current window.
7917 'winwidth' applies to the current window. Use 'winminwidth' to set
7918 the minimal width for other windows.
7919
7920 *'wrap'* *'nowrap'*
7921'wrap' boolean (default on)
7922 local to window
7923 {not in Vi}
7924 This option changes how text is displayed. It doesn't change the text
7925 in the buffer, see 'textwidth' for that.
7926 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007927 displaying continues on the next line. When off lines will not wrap
7928 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929 moved to a part that is not shown, the screen will scroll
7930 horizontally.
7931 The line will be broken in the middle of a word if necessary. See
7932 'linebreak' to get the break at a word boundary.
7933 To make scrolling horizontally a bit more useful, try this: >
7934 :set sidescroll=5
7935 :set listchars+=precedes:<,extends:>
7936< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007937 This option can't be set from a |modeline| when the 'diff' option is
7938 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939
7940 *'wrapmargin'* *'wm'*
7941'wrapmargin' 'wm' number (default 0)
7942 local to buffer
7943 Number of characters from the right window border where wrapping
7944 starts. When typing text beyond this limit, an <EOL> will be inserted
7945 and inserting continues on the next line.
7946 Options that add a margin, such as 'number' and 'foldcolumn', cause
7947 the text width to be further reduced. This is Vi compatible.
7948 When 'textwidth' is non-zero, this option is not used.
7949 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7950 and less usefully}
7951
7952 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7953'wrapscan' 'ws' boolean (default on) *E384* *E385*
7954 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007955 Searches wrap around the end of the file. Also applies to |]s| and
7956 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957
7958 *'write'* *'nowrite'*
7959'write' boolean (default on)
7960 global
7961 {not in Vi}
7962 Allows writing files. When not set, writing a file is not allowed.
7963 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007964 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007965 argument. Filtering text is still possible, even though this requires
7966 writing a temporary file.
7967
7968 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7969'writeany' 'wa' boolean (default off)
7970 global
7971 Allows writing to any file with no need for "!" override.
7972
7973 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7974'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7975 otherwise)
7976 global
7977 {not in Vi}
7978 Make a backup before overwriting a file. The backup is removed after
7979 the file was successfully written, unless the 'backup' option is
7980 also on. Reset this option if your file system is almost full. See
7981 |backup-table| for another explanation.
7982 When the 'backupskip' pattern matches, a backup is not made anyway.
7983 NOTE: This option is set to the default value when 'compatible' is
7984 set.
7985
7986 *'writedelay'* *'wd'*
7987'writedelay' 'wd' number (default 0)
7988 global
7989 {not in Vi}
7990 The number of microseconds to wait for each character sent to the
7991 screen. When non-zero, characters are sent to the terminal one by
7992 one. For MS-DOS pcterm this does not work. For debugging purposes.
7993
7994 vim:tw=78:ts=8:ft=help:norl: