blob: 1282a90d7284b05c79fa7d459bcba5d0c4136d71 [file] [log] [blame]
Bram Moolenaar7f036442010-08-15 15:24:20 +02001*options.txt* For Vim version 7.3. Last change: 2010 Aug 15
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 Moolenaardb84e452010-08-15 13:50:43 +0200140{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141
142 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000143For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144override the value from the termcap. You can then use it in a mapping. If
145the "xx" part contains special characters, use the <t_xx> form: >
146 :set <t_#4>=^[Ot
147This can also be used to translate a special code for a normal key. For
148example, if Alt-b produces <Esc>b, use this: >
149 :set <M-b>=^[b
150(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
151The advantage over a mapping is that it works in all situations.
152
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000153The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
154security reasons.
155
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000157at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158"set all" probably does not fit on the screen, causing Vim to give the
159|more-prompt|.
160
161 *option-backslash*
162To include white space in a string option value it has to be preceded with a
163backslash. To include a backslash you have to use two. Effectively this
164means that the number of backslashes in an option value is halved (rounded
165down).
166A few examples: >
167 :set tags=tags\ /usr/tags results in "tags /usr/tags"
168 :set tags=tags\\,file results in "tags\,file"
169 :set tags=tags\\\ file results in "tags\ file"
170
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000171The "|" character separates a ":set" command from a following command. To
172include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173'titlestring' option to "hi|there": >
174 :set titlestring=hi\|there
175This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
176 :set titlestring=hi|set iconstring=there
177
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000178Similarly, the double quote character starts a comment. To include the '"' in
179the option value, use '\"' instead. This example sets the 'titlestring'
180option to 'hi "there"': >
181 :set titlestring=hi\ \"there\"
182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000183For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184precise: For options that expect a file name (those where environment
185variables are expanded) a backslash before a normal file name character is not
186removed. But a backslash before a special character (space, backslash, comma,
187etc.) is used like explained above.
188There is one special situation, when the value starts with "\\": >
189 :set dir=\\machine\path results in "\\machine\path"
190 :set dir=\\\\machine\\path results in "\\machine\path"
191 :set dir=\\path\\file results in "\\path\file" (wrong!)
192For the first one the start is kept, but for the second one the backslashes
193are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000194halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195result which is probably not what you want. Avoid it.
196
197 *add-option-flags* *remove-option-flags*
198 *E539* *E550* *E551* *E552*
199Some options are a list of flags. When you want to add a flag to such an
200option, without changing the existing ones, you can do it like this: >
201 :set guioptions+=a
202Remove a flag from an option like this: >
203 :set guioptions-=a
204This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000205Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
207doesn't appear.
208
209 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000210Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211environment variable exists the '$' and the following environment variable
212name is replaced with its value. If it does not exist the '$' and the name
213are not modified. Any non-id character (not a letter, digit or '_') may
214follow the environment variable name. That character and what follows is
215appended to the value of the environment variable. Examples: >
216 :set term=$TERM.new
217 :set path=/usr/$INCLUDE,$HOME/include,.
218When adding or removing a string from an option with ":set opt-=val" or ":set
219opt+=val" the expansion is done before the adding or removing.
220
221
222Handling of local options *local-options*
223
224Some of the options only apply to a window or buffer. Each window or buffer
225has its own copy of this option, thus can each have their own value. This
226allows you to set 'list' in one window but not in another. And set
227'shiftwidth' to 3 in one buffer and 4 in another.
228
229The following explains what happens to these local options in specific
230situations. You don't really need to know all of this, since Vim mostly uses
231the option values you would expect. Unfortunately, doing what the user
232expects is a bit complicated...
233
234When splitting a window, the local options are copied to the new window. Thus
235right after the split the contents of the two windows look the same.
236
237When editing a new buffer, its local option values must be initialized. Since
238the local options of the current buffer might be specifically for that buffer,
239these are not used. Instead, for each buffer-local option there also is a
240global value, which is used for new buffers. With ":set" both the local and
241global value is changed. With "setlocal" only the local value is changed,
242thus this value is not used when editing a new buffer.
243
244When editing a buffer that has been edited before, the last used window
245options are used again. If this buffer has been edited in this window, the
246values from back then are used. Otherwise the values from the window where
247the buffer was edited last are used.
248
249It's possible to set a local window option specifically for a type of buffer.
250When you edit another buffer in the same window, you don't want to keep
251using these local window options. Therefore Vim keeps a global value of the
252local window options, which is used when editing another buffer. Each window
253has its own copy of these values. Thus these are local to the window, but
254global to all buffers in the window. With this you can do: >
255 :e one
256 :set list
257 :e two
258Now the 'list' option will also be set in "two", since with the ":set list"
259command you have also set the global value. >
260 :set nolist
261 :e one
262 :setlocal list
263 :e two
264Now the 'list' option is not set, because ":set nolist" resets the global
265value, ":setlocal list" only changes the local value and ":e two" gets the
266global value. Note that if you do this next: >
267 :e one
268You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000269"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270
271 *:setl* *:setlocal*
272:setl[ocal] ... Like ":set" but set only the value local to the
273 current buffer or window. Not all options have a
274 local value. If the option does not have a local
275 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200276 With the "all" argument: display local values for all
277 local options.
278 Without argument: Display local values for all local
279 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000281 local value. For a global/local boolean option, when
282 the global value is being used, "--" is displayed
283 before the option name.
284 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285 shown (but that might change in the future).
286 {not in Vi}
287
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000288:setl[ocal] {option}< Set the local value of {option} to its global value by
289 copying the value.
290 {not in Vi}
291
292:se[t] {option}< Set the local value of {option} to its global value by
293 making it empty. Only makes sense for |global-local|
294 options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 {not in Vi}
296
297 *:setg* *:setglobal*
298:setg[lobal] ... Like ":set" but set only the global value for a local
299 option without changing the local value.
300 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200301 With the "all" argument: display global values for all
302 local options.
303 Without argument: display global values for all local
304 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000305 {not in Vi}
306
307For buffer-local and window-local options:
308 Command global value local value ~
309 :set option=value set set
310 :setlocal option=value - set
311:setglobal option=value set -
312 :set option? - display
313 :setlocal option? - display
314:setglobal option? display -
315
316
317Global options with a local value *global-local*
318
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000319Options are global when you mostly use one value for all buffers and windows.
320For some global options it's useful to sometimes have a different local value.
321You can set the local value with ":setlocal". That buffer or window will then
322use the local value, while other buffers and windows continue using the global
323value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324
325For example, you have two windows, both on C source code. They use the global
326'makeprg' option. If you do this in one of the two windows: >
327 :set makeprg=gmake
328then the other window will switch to the same value. There is no need to set
329the 'makeprg' option in the other C source window too.
330However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000331another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000332files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333 :setlocal makeprg=perlmake
334You can switch back to using the global value by making the local value empty: >
335 :setlocal makeprg=
336This only works for a string option. For a boolean option you need to use the
337"<" flag, like this: >
338 :setlocal autoread<
339Note that for non-boolean options using "<" copies the global value to the
340local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000341when the global value changes later). You can also use: >
342 :set path<
343This will make the local value of 'path' empty, so that the global value is
344used. Thus it does the same as: >
345 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346Note: In the future more global options can be made global-local. Using
347":setlocal" on a global option might work differently then.
348
349
350Setting the filetype
351
352:setf[iletype] {filetype} *:setf* *:setfiletype*
353 Set the 'filetype' option to {filetype}, but only if
354 not done yet in a sequence of (nested) autocommands.
355 This is short for: >
356 :if !did_filetype()
357 : setlocal filetype={filetype}
358 :endif
359< This command is used in a filetype.vim file to avoid
360 setting the 'filetype' option twice, causing different
361 settings and syntax files to be loaded.
362 {not in Vi}
363
364:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
365:opt[ions] Open a window for viewing and setting all options.
366 Options are grouped by function.
367 Offers short help for each option. Hit <CR> on the
368 short help to open a help window with more help for
369 the option.
370 Modify the value of the option and hit <CR> on the
371 "set" line to set the new value. For window and
372 buffer specific options, the last accessed window is
373 used to set the option value in, unless this is a help
374 window, in which case the window below help window is
375 used (skipping the option-window).
376 {not available when compiled without the |+eval| or
377 |+autocmd| features}
378
379 *$HOME*
380Using "~" is like using "$HOME", but it is only recognized at the start of an
381option and after a space or comma.
382
383On Unix systems "~user" can be used too. It is replaced by the home directory
384of user "user". Example: >
385 :set path=~mool/include,/usr/include,.
386
387On Unix systems the form "${HOME}" can be used too. The name between {} can
388contain non-id characters then. Note that if you want to use this for the
389"gf" command, you need to add the '{' and '}' characters to 'isfname'.
390
391NOTE: expanding environment variables and "~/" is only done with the ":set"
392command, not when assigning a value to an option with ":let".
393
394
395Note the maximum length of an expanded option is limited. How much depends on
396the system, mostly it is something like 256 or 1024 characters.
397
398 *:fix* *:fixdel*
399:fix[del] Set the value of 't_kD':
400 't_kb' is 't_kD' becomes ~
401 CTRL-? CTRL-H
402 not CTRL-? CTRL-?
403
404 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
405
406 If your delete key terminal code is wrong, but the
407 code for backspace is alright, you can put this in
408 your .vimrc: >
409 :fixdel
410< This works no matter what the actual code for
411 backspace is.
412
413 If the backspace key terminal code is wrong you can
414 use this: >
415 :if &term == "termname"
416 : set t_kb=^V<BS>
417 : fixdel
418 :endif
419< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000420 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421 with your terminal name.
422
423 If your <Delete> key sends a strange key sequence (not
424 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
425 :if &term == "termname"
426 : set t_kD=^V<Delete>
427 :endif
428< Where "^V" is CTRL-V and "<Delete>" is the delete key
429 (don't type eight characters!). Replace "termname"
430 with your terminal name.
431
432 *Linux-backspace*
433 Note about Linux: By default the backspace key
434 produces CTRL-?, which is wrong. You can fix it by
435 putting this line in your rc.local: >
436 echo "keycode 14 = BackSpace" | loadkeys
437<
438 *NetBSD-backspace*
439 Note about NetBSD: If your backspace doesn't produce
440 the right code, try this: >
441 xmodmap -e "keycode 22 = BackSpace"
442< If this works, add this in your .Xmodmap file: >
443 keysym 22 = BackSpace
444< You need to restart for this to take effect.
445
446==============================================================================
4472. Automatically setting options *auto-setting*
448
449Besides changing options with the ":set" command, there are three alternatives
450to set options automatically for one or more files:
451
4521. When starting Vim initializations are read from various places. See
453 |initialization|. Most of them are performed for all editing sessions,
454 and some of them depend on the directory where Vim is started.
455 You can create an initialization file with |:mkvimrc|, |:mkview| and
456 |:mksession|.
4572. If you start editing a new file, the automatic commands are executed.
458 This can be used to set options for files matching a particular pattern and
459 many other things. See |autocommand|.
4603. If you start editing a new file, and the 'modeline' option is on, a
461 number of lines at the beginning and end of the file are checked for
462 modelines. This is explained here.
463
464 *modeline* *vim:* *vi:* *ex:* *E520*
465There are two forms of modelines. The first form:
466 [text]{white}{vi:|vim:|ex:}[white]{options}
467
468[text] any text or empty
469{white} at least one blank character (<Space> or <Tab>)
470{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
471[white] optional white space
472{options} a list of option settings, separated with white space or ':',
473 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000474 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000476Example:
477 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478
479The second form (this is compatible with some versions of Vi):
480
481 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
482
483[text] any text or empty
484{white} at least one blank character (<Space> or <Tab>)
485{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
486[white] optional white space
487se[t] the string "set " or "se " (note the space)
488{options} a list of options, separated with white space, which is the
489 argument for a ":set" command
490: a colon
491[text] any text or empty
492
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000493Example:
494 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495
496The white space before {vi:|vim:|ex:} is required. This minimizes the chance
497that a normal word like "lex:" is caught. There is one exception: "vi:" and
498"vim:" can also be at the start of the line (for compatibility with version
4993.0). Using "ex:" at the start of the line will be ignored (this could be
500short for "example:").
501
502 *modeline-local*
503The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000504buffer and window that contain the file. Although it's possible to set global
505options from a modeline, this is unusual. If you have two windows open and
506the files in it set the same global option to a different value, the result
507depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000509When editing a file that was already loaded, only the window-local options
510from the modeline are used. Thus if you manually changed a buffer-local
511option after opening the file, it won't be changed if you edit the same buffer
512in another window. But window-local options will be set.
513
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514 *modeline-version*
515If the modeline is only to be used for some versions of Vim, the version
516number can be specified where "vim:" is used:
517 vim{vers}: version {vers} or later
518 vim<{vers}: version before {vers}
519 vim={vers}: version {vers}
520 vim>{vers}: version after {vers}
521{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000522For example, to use a modeline only for Vim 6.0 and later:
523 /* vim600: set foldmethod=marker: */ ~
524To use a modeline for Vim before version 5.7:
525 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526There can be no blanks between "vim" and the ":".
527
528
529The number of lines that are checked can be set with the 'modelines' option.
530If 'modeline' is off or 'modelines' is 0 no lines are checked.
531
532Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000533like:
534 /* vi:ts=4: */ ~
535will give an error message for the trailing "*/". This line is OK:
536 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538If an error is detected the rest of the line is skipped.
539
540If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000541backslash in front of the ':' will be removed. Example:
542 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543This sets the 'dir' option to "c:\tmp". Only a single backslash before the
544':' is removed. Thus to include "\:" you have to specify "\\:".
545
546No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000547might create a Trojan horse text file with modelines). And not all options
548can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000549|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000550causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
551are wrapped unexpectedly. So disable modelines before editing untrusted text.
552The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553
554Hint: If you would like to do something else than setting an option, you could
555define an autocommand that checks the file for a specific string. For
556example: >
557 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
558And define a function SetVar() that does something with the line containing
559"VAR".
560
561==============================================================================
5623. Options summary *option-summary*
563
564In the list below all the options are mentioned with their full name and with
565an abbreviation if there is one. Both forms may be used.
566
567In this document when a boolean option is "set" that means that ":set option"
568is entered. When an option is "reset", ":set nooption" is used.
569
570For some options there are two default values: The "Vim default", which is
571used when 'compatible' is not set, and the "Vi default", which is used when
572'compatible' is set.
573
574Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000575are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576different value in each window. For example the 'list' option can be set in
577one window and reset in another for the same text, giving both types of view
578at the same time. There are a few options that are specific to a certain
579file. These can have a different value for each file or buffer. For example
580the 'textwidth' option can be 78 for a normal text file and 0 for a C
581program.
582
583 global one option for all buffers and windows
584 local to window each window has its own copy of this option
585 local to buffer each buffer has its own copy of this option
586
587When creating a new window the option values from the currently active window
588are used as a default value for the window-specific options. For the
589buffer-specific options this depends on the 's' and 'S' flags in the
590'cpoptions' option. If 's' is included (which is the default) the values for
591buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000592first entered. If 'S' is present the options are copied each time the buffer
593is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594present, the options are copied from the currently active buffer when the
595buffer is created.
596
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000597Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000599Not all options are supported in all versions. This depends on the supported
600features and sometimes on the system. A remark about this is in curly braces
601below. When an option is not supported it may still be set without getting an
602error, this is called a hidden option. You can't get the value of a hidden
603option though, it is not stored.
604
605To test if option "foo" can be used with ":set" use something like this: >
606 if exists('&foo')
607This also returns true for a hidden option. To test if option "foo" is really
608supported use something like this: >
609 if exists('+foo')
610<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 *E355*
612A jump table for the options with a short description can be found at |Q_op|.
613
614 *'aleph'* *'al'* *aleph* *Aleph*
615'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
616 global
617 {not in Vi}
618 {only available when compiled with the |+rightleft|
619 feature}
620 The ASCII code for the first letter of the Hebrew alphabet. The
621 routine that maps the keyboard in Hebrew mode, both in Insert mode
622 (when hkmap is set) and on the command-line (when hitting CTRL-_)
623 outputs the Hebrew characters in the range [aleph..aleph+26].
624 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
625 See |rileft.txt|.
626
627 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
628'allowrevins' 'ari' boolean (default off)
629 global
630 {not in Vi}
631 {only available when compiled with the |+rightleft|
632 feature}
633 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
634 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
635 into reverse Insert mode, and don't know how to get out. See
636 'revins'.
637 NOTE: This option is reset when 'compatible' is set.
638
639 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
640'altkeymap' 'akm' boolean (default off)
641 global
642 {not in Vi}
643 {only available when compiled with the |+farsi|
644 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000645 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 the keyboard map between Farsi and English, when 'allowrevins' set.
647
Bram Moolenaar582fd852005-03-28 20:58:01 +0000648 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 is useful to start the Vim in native mode i.e. English (left-to-right
650 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000651 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
653 *'ambiwidth'* *'ambw'*
654'ambiwidth' 'ambw' string (default: "single")
655 global
656 {not in Vi}
657 {only available when compiled with the |+multi_byte|
658 feature}
659 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
660 Tells Vim what to do with characters with East Asian Width Class
661 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
662 letters, Cyrillic letters).
663
664 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000665 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 expected by most users.
667 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200668 *E834* *E835*
669 The value "double" cannot be used if 'listchars' or 'fillchars'
670 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000671
672 There are a number of CJK fonts for which the width of glyphs for
673 those characters are solely based on how many octets they take in
674 legacy/traditional CJK encodings. In those encodings, Euro,
675 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000676 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000678 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679 Vim is running inside a terminal (emulators) that uses a CJK font
680 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
681 this option should be set to "double" to match the width perceived
682 by Vim with the width of glyphs in the font. Perhaps it also has
683 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
684 when the system locale is set to one of CJK locales. See Unicode
685 Standard Annex #11 (http://www.unicode.org/reports/tr11).
686
687 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
688'antialias' 'anti' boolean (default: off)
689 global
690 {not in Vi}
691 {only available when compiled with GUI enabled
692 on Mac OS X}
693 This option only has an effect in the GUI version of Vim on Mac OS X
694 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
695 which can be easier to read at certain sizes on certain displays.
696 Setting this option can sometimes cause problems if 'guifont' is set
697 to its default (empty string).
698
699 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
700'autochdir' 'acd' boolean (default off)
701 global
702 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200703 {only available when compiled with it, use
704 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000705 When on, Vim will change the current working directory whenever you
706 open a file, switch buffers, delete a buffer or open/close a window.
707 It will change to the directory containing the file which was opened
708 or selected.
709 This option is provided for backward compatibility with the Vim
710 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000711 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712
713 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
714'arabic' 'arab' boolean (default off)
715 local to window
716 {not in Vi}
717 {only available when compiled with the |+arabic|
718 feature}
719 This option can be set to start editing Arabic text.
720 Setting this option will:
721 - Set the 'rightleft' option, unless 'termbidi' is set.
722 - Set the 'arabicshape' option, unless 'termbidi' is set.
723 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
724 between typing English and Arabic key mapping.
725 - Set the 'delcombine' option
726 Note that 'encoding' must be "utf-8" for working with Arabic text.
727
728 Resetting this option will:
729 - Reset the 'rightleft' option.
730 - Disable the use of 'keymap' (without changing its value).
731 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
732 option.
733 Also see |arabic.txt|.
734
735 *'arabicshape'* *'arshape'*
736 *'noarabicshape'* *'noarshape'*
737'arabicshape' 'arshape' boolean (default on)
738 global
739 {not in Vi}
740 {only available when compiled with the |+arabic|
741 feature}
742 When on and 'termbidi' is off, the required visual character
743 corrections that need to take place for displaying the Arabic language
744 take affect. Shaping, in essence, gets enabled; the term is a broad
745 one which encompasses:
746 a) the changing/morphing of characters based on their location
747 within a word (initial, medial, final and stand-alone).
748 b) the enabling of the ability to compose characters
749 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100750 When disabled the display shows each character's true stand-alone
751 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 Arabic is a complex language which requires other settings, for
753 further details see |arabic.txt|.
754
755 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
756'autoindent' 'ai' boolean (default off)
757 local to buffer
758 Copy indent from current line when starting a new line (typing <CR>
759 in Insert mode or when using the "o" or "O" command). If you do not
760 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000761 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
762 to another line has the same effect, unless the 'I' flag is included
763 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000764 When autoindent is on, formatting (with the "gq" command or when you
765 reach 'textwidth' in Insert mode) uses the indentation of the first
766 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 When 'smartindent' or 'cindent' is on the indent is changed in
768 a different way.
769 The 'autoindent' option is reset when the 'paste' option is set.
770 {small difference from Vi: After the indent is deleted when typing
771 <Esc> or <CR>, the cursor position when moving up or down is after the
772 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
773
774 *'autoread'* *'ar'* *'noautoread'* *'noar'*
775'autoread' 'ar' boolean (default off)
776 global or local to buffer |global-local|
777 {not in Vi}
778 When a file has been detected to have been changed outside of Vim and
779 it has not been changed inside of Vim, automatically read it again.
780 When the file has been deleted this is not done. |timestamp|
781 If this option has a local value, use this command to switch back to
782 using the global value: >
783 :set autoread<
784<
785 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
786'autowrite' 'aw' boolean (default off)
787 global
788 Write the contents of the file, if it has been modified, on each
789 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000790 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
792 Note that for some commands the 'autowrite' option is not used, see
793 'autowriteall' for that.
794
795 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
796'autowriteall' 'awa' boolean (default off)
797 global
798 {not in Vi}
799 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
800 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
801 Setting this option also implies that Vim behaves like 'autowrite' has
802 been set.
803
804 *'background'* *'bg'*
805'background' 'bg' string (default "dark" or "light")
806 global
807 {not in Vi}
808 When set to "dark", Vim will try to use colors that look good on a
809 dark background. When set to "light", Vim will try to use colors that
810 look good on a light background. Any other value is illegal.
811 Vim tries to set the default value according to the terminal used.
812 This will not always be correct.
813 Setting this option does not change the background color, it tells Vim
814 what the background color looks like. For changing the background
815 color, see |:hi-normal|.
816
817 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000818 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000819 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100820 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821 setting 'background' will cause the color scheme to be reloaded. If
822 the color scheme adjusts to the value of 'background' this will work.
823 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100824 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
826 When setting 'background' to the default value with: >
827 :set background&
828< Vim will guess the value. In the GUI this should work correctly,
829 in other cases Vim might not be able to guess the right value.
830
831 When starting the GUI, the default value for 'background' will be
832 "light". When the value is not set in the .gvimrc, and Vim detects
833 that the background is actually quite dark, 'background' is set to
834 "dark". But this happens only AFTER the .gvimrc file has been read
835 (because the window needs to be opened to find the actual background
836 color). To get around this, force the GUI window to be opened by
837 putting a ":gui" command in the .gvimrc file, before where the value
838 of 'background' is used (e.g., before ":syntax on").
839 Normally this option would be set in the .vimrc file. Possibly
840 depending on the terminal name. Example: >
841 :if &term == "pcterm"
842 : set background=dark
843 :endif
844< When this option is set, the default settings for the highlight groups
845 will change. To use other settings, place ":highlight" commands AFTER
846 the setting of the 'background' option.
847 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
848 to select the colors for syntax highlighting. After changing this
849 option, you must load syntax.vim again to see the result. This can be
850 done with ":syntax on".
851
852 *'backspace'* *'bs'*
853'backspace' 'bs' string (default "")
854 global
855 {not in Vi}
856 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
857 mode. This is a list of items, separated by commas. Each item allows
858 a way to backspace over something:
859 value effect ~
860 indent allow backspacing over autoindent
861 eol allow backspacing over line breaks (join lines)
862 start allow backspacing over the start of insert; CTRL-W and CTRL-U
863 stop once at the start of insert.
864
865 When the value is empty, Vi compatible backspacing is used.
866
867 For backwards compatibility with version 5.4 and earlier:
868 value effect ~
869 0 same as ":set backspace=" (Vi compatible)
870 1 same as ":set backspace=indent,eol"
871 2 same as ":set backspace=indent,eol,start"
872
873 See |:fixdel| if your <BS> or <Del> key does not do what you want.
874 NOTE: This option is set to "" when 'compatible' is set.
875
876 *'backup'* *'bk'* *'nobackup'* *'nobk'*
877'backup' 'bk' boolean (default off)
878 global
879 {not in Vi}
880 Make a backup before overwriting a file. Leave it around after the
881 file has been successfully written. If you do not want to keep the
882 backup file, but you do want a backup while the file is being
883 written, reset this option and set the 'writebackup' option (this is
884 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000885 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886 |backup-table| for more explanations.
887 When the 'backupskip' pattern matches, a backup is not made anyway.
888 When 'patchmode' is set, the backup may be renamed to become the
889 oldest version of a file.
890 NOTE: This option is reset when 'compatible' is set.
891
892 *'backupcopy'* *'bkc'*
893'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
894 global
895 {not in Vi}
896 When writing a file and a backup is made, this option tells how it's
897 done. This is a comma separated list of words.
898
899 The main values are:
900 "yes" make a copy of the file and overwrite the original one
901 "no" rename the file and write a new one
902 "auto" one of the previous, what works best
903
904 Extra values that can be combined with the ones above are:
905 "breaksymlink" always break symlinks when writing
906 "breakhardlink" always break hardlinks when writing
907
908 Making a copy and overwriting the original file:
909 - Takes extra time to copy the file.
910 + When the file has special attributes, is a (hard/symbolic) link or
911 has a resource fork, all this is preserved.
912 - When the file is a link the backup will have the name of the link,
913 not of the real file.
914
915 Renaming the file and writing a new one:
916 + It's fast.
917 - Sometimes not all attributes of the file can be copied to the new
918 file.
919 - When the file is a link the new file will not be a link.
920
921 The "auto" value is the middle way: When Vim sees that renaming file
922 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000923 the file is not a link) that is used. When problems are expected, a
924 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925
926 The "breaksymlink" and "breakhardlink" values can be used in
927 combination with any of "yes", "no" and "auto". When included, they
928 force Vim to always break either symbolic or hard links by doing
929 exactly what the "no" option does, renaming the original file to
930 become the backup and writing a new file in its place. This can be
931 useful for example in source trees where all the files are symbolic or
932 hard links and any changes should stay in the local source tree, not
933 be propagated back to the original source.
934 *crontab*
935 One situation where "no" and "auto" will cause problems: A program
936 that opens a file, invokes Vim to edit that file, and then tests if
937 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000938 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 example.
940
941 When a copy is made, the original file is truncated and then filled
942 with the new text. This means that protection bits, owner and
943 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000944 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945 group of the backup is set to the group of the original file. If this
946 fails, the protection bits for the group are made the same as for
947 others.
948
949 When the file is renamed this is the other way around: The backup has
950 the same attributes of the original file, and the newly written file
951 is owned by the current user. When the file was a (hard/symbolic)
952 link, the new file will not! That's why the "auto" value doesn't
953 rename when the file is a link. The owner and group of the newly
954 written file will be set to the same ones as the original file, but
955 the system may refuse to do this. In that case the "auto" value will
956 again not rename the file.
957
958 *'backupdir'* *'bdir'*
959'backupdir' 'bdir' string (default for Amiga: ".,t:",
960 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
961 for Unix: ".,~/tmp,~/")
962 global
963 {not in Vi}
964 List of directories for the backup file, separated with commas.
965 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100966 where this is possible. The directory must exist, Vim will not
967 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968 - Empty means that no backup file will be created ('patchmode' is
969 impossible!). Writing may fail because of this.
970 - A directory "." means to put the backup file in the same directory
971 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000972 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000973 put the backup file relative to where the edited file is. The
974 leading "." is replaced with the path name of the edited file.
975 ("." inside a directory name has no special meaning).
976 - Spaces after the comma are ignored, other spaces are considered part
977 of the directory name. To have a space at the start of a directory
978 name, precede it with a backslash.
979 - To include a comma in a directory name precede it with a backslash.
980 - A directory name may end in an '/'.
981 - Environment variables are expanded |:set_env|.
982 - Careful with '\' characters, type one before a space, type two to
983 get one in the option (see |option-backslash|), for example: >
984 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
985< - For backwards compatibility with Vim version 3.0 a '>' at the start
986 of the option is removed.
987 See also 'backup' and 'writebackup' options.
988 If you want to hide your backup files on Unix, consider this value: >
989 :set backupdir=./.backup,~/.backup,.,/tmp
990< You must create a ".backup" directory in each directory and in your
991 home directory for this to work properly.
992 The use of |:set+=| and |:set-=| is preferred when adding or removing
993 directories from the list. This avoids problems when a future version
994 uses another default.
995 This option cannot be set from a |modeline| or in the |sandbox|, for
996 security reasons.
997
998 *'backupext'* *'bex'* *E589*
999'backupext' 'bex' string (default "~", for VMS: "_")
1000 global
1001 {not in Vi}
1002 String which is appended to a file name to make the name of the
1003 backup file. The default is quite unusual, because this avoids
1004 accidentally overwriting existing files with a backup file. You might
1005 prefer using ".bak", but make sure that you don't have files with
1006 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001007 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001009 If you like to keep a lot of backups, you could use a BufWritePre
1010 autocommand to change 'backupext' just before writing the file to
1011 include a timestamp. >
1012 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1013< Use 'backupdir' to put the backup in a different directory.
1014
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015 *'backupskip'* *'bsk'*
1016'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1017 global
1018 {not in Vi}
1019 {not available when compiled without the |+wildignore|
1020 feature}
1021 A list of file patterns. When one of the patterns matches with the
1022 name of the file which is written, no backup file is created. Both
1023 the specified file name and the full path name of the file are used.
1024 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1025 Watch out for special characters, see |option-backslash|.
1026 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001027 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001028
1029 Note that environment variables are not expanded. If you want to use
1030 $HOME you must expand it explicitly, e.g.: >
1031 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1032
1033< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001034 backup would be made by renaming the original file crontab won't see
1035 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036
1037 *'balloondelay'* *'bdlay'*
1038'balloondelay' 'bdlay' number (default: 600)
1039 global
1040 {not in Vi}
1041 {only available when compiled with the |+balloon_eval|
1042 feature}
1043 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1044
1045 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1046'ballooneval' 'beval' boolean (default off)
1047 global
1048 {not in Vi}
1049 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001050 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051 Switch on the |balloon-eval| functionality.
1052
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001053 *'balloonexpr'* *'bexpr'*
1054'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001055 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001056 {not in Vi}
1057 {only available when compiled with the |+balloon_eval|
1058 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001059 Expression for text to show in evaluation balloon. It is only used
1060 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001061
1062 v:beval_bufnr number of the buffer in which balloon is going to show
1063 v:beval_winnr number of the window
1064 v:beval_lnum line number
1065 v:beval_col column number (byte index)
1066 v:beval_text word under or after the mouse pointer
1067
1068 The evaluation of the expression must not have side effects!
1069 Example: >
1070 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001071 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001072 \', column ' . v:beval_col .
1073 \ ' of file ' . bufname(v:beval_bufnr) .
1074 \ ' on word "' . v:beval_text . '"'
1075 endfunction
1076 set bexpr=MyBalloonExpr()
1077 set ballooneval
1078<
1079 NOTE: The balloon is displayed only if the cursor is on a text
1080 character. If the result of evaluating 'balloonexpr' is not empty,
1081 Vim does not try to send a message to an external debugger (Netbeans
1082 or Sun Workshop).
1083
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001084 The expression may be evaluated in the |sandbox|, see
1085 |sandbox-option|.
1086
1087 It is not allowed to change text or jump to another window while
1088 evaluating 'balloonexpr' |textlock|.
1089
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001090 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001091 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001092< When they are supported "\n" characters will start a new line. If the
1093 expression evaluates to a |List| this is equal to using each List item
1094 as a string and putting "\n" in between them.
1095
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1097'binary' 'bin' boolean (default off)
1098 local to buffer
1099 {not in Vi}
1100 This option should be set before editing a binary file. You can also
1101 use the |-b| Vim argument. When this option is switched on a few
1102 options will be changed (also when it already was on):
1103 'textwidth' will be set to 0
1104 'wrapmargin' will be set to 0
1105 'modeline' will be off
1106 'expandtab' will be off
1107 Also, 'fileformat' and 'fileformats' options will not be used, the
1108 file is read and written like 'fileformat' was "unix" (a single <NL>
1109 separates lines).
1110 The 'fileencoding' and 'fileencodings' options will not be used, the
1111 file is read without conversion.
1112 NOTE: When you start editing a(nother) file while the 'bin' option is
1113 on, settings from autocommands may change the settings again (e.g.,
1114 'textwidth'), causing trouble when editing. You might want to set
1115 'bin' again when the file has been loaded.
1116 The previous values of these options are remembered and restored when
1117 'bin' is switched from on to off. Each buffer has its own set of
1118 saved option values.
1119 To edit a file with 'binary' set you can use the |++bin| argument.
1120 This avoids you have to do ":set bin", which would have effect for all
1121 files you edit.
1122 When writing a file the <EOL> for the last line is only written if
1123 there was one in the original file (normally Vim appends an <EOL> to
1124 the last line if there is none; this would make the file longer). See
1125 the 'endofline' option.
1126
1127 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1128'bioskey' 'biosk' boolean (default on)
1129 global
1130 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001131 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132 better to detect CTRL-C, but only works for the console. When using a
1133 terminal over a serial port reset this option.
1134 Also see |'conskey'|.
1135
1136 *'bomb'* *'nobomb'*
1137'bomb' boolean (default off)
1138 local to buffer
1139 {not in Vi}
1140 {only available when compiled with the |+multi_byte|
1141 feature}
1142 When writing a file and the following conditions are met, a BOM (Byte
1143 Order Mark) is prepended to the file:
1144 - this option is on
1145 - the 'binary' option is off
1146 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1147 endian variants.
1148 Some applications use the BOM to recognize the encoding of the file.
1149 Often used for UCS-2 files on MS-Windows. For other applications it
1150 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001151 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1153 check for the presence of the BOM is done and 'bomb' set accordingly.
1154 Unless 'binary' is set, it is removed from the first line, so that you
1155 don't see it when editing. When you don't change the options, the BOM
1156 will be restored when writing the file.
1157
1158 *'breakat'* *'brk'*
1159'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1160 global
1161 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001162 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 feature}
1164 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001165 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1166 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167
1168 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001169'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001171 {not in Vi} {only for Motif, Athena, GTK, Mac and
1172 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001174 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001175 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176 buffer Use the directory of the related buffer.
1177 current Use the current directory.
1178 {path} Use the specified directory
1179
1180 *'bufhidden'* *'bh'*
1181'bufhidden' 'bh' string (default: "")
1182 local to buffer
1183 {not in Vi}
1184 {not available when compiled without the |+quickfix|
1185 feature}
1186 This option specifies what happens when a buffer is no longer
1187 displayed in a window:
1188 <empty> follow the global 'hidden' option
1189 hide hide the buffer (don't unload it), also when 'hidden'
1190 is not set
1191 unload unload the buffer, also when 'hidden' is set or using
1192 |:hide|
1193 delete delete the buffer from the buffer list, also when
1194 'hidden' is set or using |:hide|, like using
1195 |:bdelete|
1196 wipe wipe out the buffer from the buffer list, also when
1197 'hidden' is set or using |:hide|, like using
1198 |:bwipeout|
1199
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001200 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1201 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202 This option is used together with 'buftype' and 'swapfile' to specify
1203 special kinds of buffers. See |special-buffers|.
1204
1205 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1206'buflisted' 'bl' boolean (default: on)
1207 local to buffer
1208 {not in Vi}
1209 When this option is set, the buffer shows up in the buffer list. If
1210 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1211 This option is reset by Vim for buffers that are only used to remember
1212 a file name or marks. Vim sets it when starting to edit a buffer.
1213 But not when moving to a buffer with ":buffer".
1214
1215 *'buftype'* *'bt'* *E382*
1216'buftype' 'bt' string (default: "")
1217 local to buffer
1218 {not in Vi}
1219 {not available when compiled without the |+quickfix|
1220 feature}
1221 The value of this option specifies the type of a buffer:
1222 <empty> normal buffer
1223 nofile buffer which is not related to a file and will not be
1224 written
1225 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001226 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001227 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001228 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001230 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231 help help buffer (you are not supposed to set this
1232 manually)
1233
1234 This option is used together with 'bufhidden' and 'swapfile' to
1235 specify special kinds of buffers. See |special-buffers|.
1236
1237 Be careful with changing this option, it can have many side effects!
1238
Bram Moolenaar280f1262006-01-30 00:14:18 +00001239 A "quickfix" buffer is only used for the error list and the location
1240 list. This value is set by the |:cwindow| and |:lwindow| commands and
1241 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242
1243 "nofile" and "nowrite" buffers are similar:
1244 both: The buffer is not to be written to disk, ":w" doesn't
1245 work (":w filename" does work though).
1246 both: The buffer is never considered to be |'modified'|.
1247 There is no warning when the changes will be lost, for
1248 example when you quit Vim.
1249 both: A swap file is only created when using too much memory
1250 (when 'swapfile' has been reset there is never a swap
1251 file).
1252 nofile only: The buffer name is fixed, it is not handled like a
1253 file name. It is not modified in response to a |:cd|
1254 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001255 *E676*
1256 "acwrite" implies that the buffer name is not related to a file, like
1257 "nofile", but it will be written. Thus, in contrast to "nofile" and
1258 "nowrite", ":w" does work and a modified buffer can't be abandoned
1259 without saving. For writing there must be matching |BufWriteCmd|,
1260 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261
1262 *'casemap'* *'cmp'*
1263'casemap' 'cmp' string (default: "internal,keepascii")
1264 global
1265 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001266 {only available when compiled with the |+multi_byte|
1267 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268 Specifies details about changing the case of letters. It may contain
1269 these words, separated by a comma:
1270 internal Use internal case mapping functions, the current
1271 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001272 matters when 'encoding' is a Unicode encoding,
1273 "latin1" or "iso-8859-15". When "internal" is
1274 omitted, the towupper() and towlower() system library
1275 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1277 case mapping, the current locale is not effective.
1278 This probably only matters for Turkish.
1279
1280 *'cdpath'* *'cd'* *E344* *E346*
1281'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1282 global
1283 {not in Vi}
1284 {not available when compiled without the
1285 |+file_in_path| feature}
1286 This is a list of directories which will be searched when using the
1287 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001288 for has a relative path, not an absolute part starting with "/", "./"
1289 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 The 'cdpath' option's value has the same form and semantics as
1291 |'path'|. Also see |file-searching|.
1292 The default value is taken from $CDPATH, with a "," prepended to look
1293 in the current directory first.
1294 If the default value taken from $CDPATH is not what you want, include
1295 a modified version of the following command in your vimrc file to
1296 override it: >
1297 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1298< This option cannot be set from a |modeline| or in the |sandbox|, for
1299 security reasons.
1300 (parts of 'cdpath' can be passed to the shell to expand file names).
1301
1302 *'cedit'*
1303'cedit' string (Vi default: "", Vim default: CTRL-F)
1304 global
1305 {not in Vi}
1306 {not available when compiled without the |+vertsplit|
1307 feature}
1308 The key used in Command-line Mode to open the command-line window.
1309 The default is CTRL-F when 'compatible' is off.
1310 Only non-printable keys are allowed.
1311 The key can be specified as a single character, but it is difficult to
1312 type. The preferred way is to use the <> notation. Examples: >
1313 :set cedit=<C-Y>
1314 :set cedit=<Esc>
1315< |Nvi| also has this option, but it only uses the first character.
1316 See |cmdwin|.
1317
1318 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1319'charconvert' 'ccv' string (default "")
1320 global
1321 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001322 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 {not in Vi}
1324 An expression that is used for character encoding conversion. It is
1325 evaluated when a file that is to be read or has been written has a
1326 different encoding from what is desired.
1327 'charconvert' is not used when the internal iconv() function is
1328 supported and is able to do the conversion. Using iconv() is
1329 preferred, because it is much faster.
1330 'charconvert' is not used when reading stdin |--|, because there is no
1331 file to convert from. You will have to save the text in a file first.
1332 The expression must return zero or an empty string for success,
1333 non-zero for failure.
1334 The possible encoding names encountered are in 'encoding'.
1335 Additionally, names given in 'fileencodings' and 'fileencoding' are
1336 used.
1337 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1338 is done internally by Vim, 'charconvert' is not used for this.
1339 'charconvert' is also used to convert the viminfo file, if the 'c'
1340 flag is present in 'viminfo'. Also used for Unicode conversion.
1341 Example: >
1342 set charconvert=CharConvert()
1343 fun CharConvert()
1344 system("recode "
1345 \ . v:charconvert_from . ".." . v:charconvert_to
1346 \ . " <" . v:fname_in . " >" v:fname_out)
1347 return v:shell_error
1348 endfun
1349< The related Vim variables are:
1350 v:charconvert_from name of the current encoding
1351 v:charconvert_to name of the desired encoding
1352 v:fname_in name of the input file
1353 v:fname_out name of the output file
1354 Note that v:fname_in and v:fname_out will never be the same.
1355 Note that v:charconvert_from and v:charconvert_to may be different
1356 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1357 Encryption is not done by Vim when using 'charconvert'. If you want
1358 to encrypt the file after conversion, 'charconvert' should take care
1359 of this.
1360 This option cannot be set from a |modeline| or in the |sandbox|, for
1361 security reasons.
1362
1363 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1364'cindent' 'cin' boolean (default off)
1365 local to buffer
1366 {not in Vi}
1367 {not available when compiled without the |+cindent|
1368 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001369 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370 that trigger reindenting in insert mode and 'cinoptions' to set your
1371 preferred indent style.
1372 If 'indentexpr' is not empty, it overrules 'cindent'.
1373 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1374 the "=" operator indents using this algorithm rather than calling an
1375 external program.
1376 See |C-indenting|.
1377 When you don't like the way 'cindent' works, try the 'smartindent'
1378 option or 'indentexpr'.
1379 This option is not used when 'paste' is set.
1380 NOTE: This option is reset when 'compatible' is set.
1381
1382 *'cinkeys'* *'cink'*
1383'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1384 local to buffer
1385 {not in Vi}
1386 {not available when compiled without the |+cindent|
1387 feature}
1388 A list of keys that, when typed in Insert mode, cause reindenting of
1389 the current line. Only used if 'cindent' is on and 'indentexpr' is
1390 empty.
1391 For the format of this option see |cinkeys-format|.
1392 See |C-indenting|.
1393
1394 *'cinoptions'* *'cino'*
1395'cinoptions' 'cino' string (default "")
1396 local to buffer
1397 {not in Vi}
1398 {not available when compiled without the |+cindent|
1399 feature}
1400 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1401 program. See |cinoptions-values| for the values of this option, and
1402 |C-indenting| for info on C indenting in general.
1403
1404
1405 *'cinwords'* *'cinw'*
1406'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1407 local to buffer
1408 {not in Vi}
1409 {not available when compiled without both the
1410 |+cindent| and the |+smartindent| features}
1411 These keywords start an extra indent in the next line when
1412 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1413 an appropriate place (inside {}).
1414 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1415 matter, include the keyword both the uppercase and lowercase:
1416 "if,If,IF".
1417
1418 *'clipboard'* *'cb'*
1419'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1420 for X-windows, "" otherwise)
1421 global
1422 {not in Vi}
1423 {only in GUI versions or when the |+xterm_clipboard|
1424 feature is included}
1425 This option is a list of comma separated names.
1426 These names are recognized:
1427
1428 unnamed When included, Vim will use the clipboard register '*'
1429 for all yank, delete, change and put operations which
1430 would normally go to the unnamed register. When a
1431 register is explicitly specified, it will always be
1432 used regardless of whether "unnamed" is in 'clipboard'
1433 or not. The clipboard register can always be
1434 explicitly accessed using the "* notation. Also see
1435 |gui-clipboard|.
1436
1437 autoselect Works like the 'a' flag in 'guioptions': If present,
1438 then whenever Visual mode is started, or the Visual
1439 area extended, Vim tries to become the owner of the
1440 windowing system's global selection or put the
1441 selected text on the clipboard used by the selection
1442 register "*. See |guioptions_a| and |quotestar| for
1443 details. When the GUI is active, the 'a' flag in
1444 'guioptions' is used, when the GUI is not active, this
1445 "autoselect" flag is used.
1446 Also applies to the modeless selection.
1447
1448 autoselectml Like "autoselect", but for the modeless selection
1449 only. Compare to the 'A' flag in 'guioptions'.
1450
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001451 html When the clipboard contains HTML, use this when
1452 pasting. When putting text on the clipboard, mark it
1453 as HTML. This works to copy rendered HTML from
1454 Firefox, paste it as raw HTML in Vim, select the HTML
1455 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001456 You probably want to add this only temporarily,
1457 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001458 Only supported for GTK version 2 and later.
1459 Only available with the |+multi_byte| feature.
1460
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461 exclude:{pattern}
1462 Defines a pattern that is matched against the name of
1463 the terminal 'term'. If there is a match, no
1464 connection will be made to the X server. This is
1465 useful in this situation:
1466 - Running Vim in a console.
1467 - $DISPLAY is set to start applications on another
1468 display.
1469 - You do not want to connect to the X server in the
1470 console, but do want this in a terminal emulator.
1471 To never connect to the X server use: >
1472 exclude:.*
1473< This has the same effect as using the |-X| argument.
1474 Note that when there is no connection to the X server
1475 the window title won't be restored and the clipboard
1476 cannot be accessed.
1477 The value of 'magic' is ignored, {pattern} is
1478 interpreted as if 'magic' was on.
1479 The rest of the option value will be used for
1480 {pattern}, this must be the last entry.
1481
1482 *'cmdheight'* *'ch'*
1483'cmdheight' 'ch' number (default 1)
1484 global
1485 {not in Vi}
1486 Number of screen lines to use for the command-line. Helps avoiding
1487 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001488 The value of this option is stored with the tab page, so that each tab
1489 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490
1491 *'cmdwinheight'* *'cwh'*
1492'cmdwinheight' 'cwh' number (default 7)
1493 global
1494 {not in Vi}
1495 {not available when compiled without the |+vertsplit|
1496 feature}
1497 Number of screen lines to use for the command-line window. |cmdwin|
1498
1499 *'columns'* *'co'* *E594*
1500'columns' 'co' number (default 80 or terminal width)
1501 global
1502 {not in Vi}
1503 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001504 initialization and does not have to be set by hand. Also see
1505 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506 When Vim is running in the GUI or in a resizable window, setting this
1507 option will cause the window size to be changed. When you only want
1508 to use the size for the GUI, put the command in your |gvimrc| file.
1509 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001510 number of columns of the display, the display may be messed up. For
1511 the GUI it is always possible and Vim limits the number of columns to
1512 what fits on the screen. You can use this command to get the widest
1513 window possible: >
1514 :set columns=9999
1515< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516
1517 *'comments'* *'com'* *E524* *E525*
1518'comments' 'com' string (default
1519 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1520 local to buffer
1521 {not in Vi}
1522 {not available when compiled without the |+comments|
1523 feature}
1524 A comma separated list of strings that can start a comment line. See
1525 |format-comments|. See |option-backslash| about using backslashes to
1526 insert a space.
1527
1528 *'commentstring'* *'cms'* *E537*
1529'commentstring' 'cms' string (default "/*%s*/")
1530 local to buffer
1531 {not in Vi}
1532 {not available when compiled without the |+folding|
1533 feature}
1534 A template for a comment. The "%s" in the value is replaced with the
1535 comment text. Currently only used to add markers for folding, see
1536 |fold-marker|.
1537
1538 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001539'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1540 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001541 global
1542 {not in Vi}
1543 This option has the effect of making Vim either more Vi-compatible, or
1544 make Vim behave in a more useful way.
1545 This is a special kind of option, because when it's set or reset,
1546 other options are also changed as a side effect. CAREFUL: Setting or
1547 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001548 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549 set this option in your vimrc file, you should probably put it at the
1550 very start.
1551 By default this option is on and the Vi defaults are used for the
1552 options. This default was chosen for those people who want to use Vim
1553 just like Vi, and don't even (want to) know about the 'compatible'
1554 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001555 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001556 this option is switched off, and all options that have not been
1557 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001558 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001559 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001560 happen for the system-wide vimrc or gvimrc file, nor for a file given
1561 with the |-u| argument). Also see |compatible-default| and
1562 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001563 You can also set this option with the "-C" argument, and reset it with
1564 "-N". See |-C| and |-N|.
1565 Switching this option off makes the Vim defaults be used for options
1566 that have a different Vi and Vim default value. See the options
1567 marked with a '+' below. Other options are not modified.
1568 At the moment this option is set, several other options will be set
1569 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001570 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 editing.
1572 See also 'cpoptions'.
1573
1574 option + set value effect ~
1575
1576 'allowrevins' off no CTRL-_ command
1577 'backupcopy' Unix: "yes" backup file is a copy
1578 others: "auto" copy or rename backup file
1579 'backspace' "" normal backspace
1580 'backup' off no backup file
1581 'cindent' off no C code indentation
1582 'cedit' + "" no key to open the |cmdwin|
1583 'cpoptions' + (all flags) Vi-compatible flags
1584 'cscopetag' off don't use cscope for ":tag"
1585 'cscopetagorder' 0 see |cscopetagorder|
1586 'cscopeverbose' off see |cscopeverbose|
1587 'digraph' off no digraphs
1588 'esckeys' + off no <Esc>-keys in Insert mode
1589 'expandtab' off tabs not expanded to spaces
1590 'fileformats' + "" no automatic file format detection,
1591 "dos,unix" except for DOS, Windows and OS/2
1592 'formatoptions' + "vt" Vi compatible formatting
1593 'gdefault' off no default 'g' flag for ":s"
1594 'history' + 0 no commandline history
1595 'hkmap' off no Hebrew keyboard mapping
1596 'hkmapp' off no phonetic Hebrew keyboard mapping
1597 'hlsearch' off no highlighting of search matches
1598 'incsearch' off no incremental searching
1599 'indentexpr' "" no indenting by expression
1600 'insertmode' off do not start in Insert mode
1601 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1602 characters and '_'
1603 'joinspaces' on insert 2 spaces after period
1604 'modeline' + off no modelines
1605 'more' + off no pauses in listings
1606 'revins' off no reverse insert
1607 'ruler' off no ruler
1608 'scrolljump' 1 no jump scroll
1609 'scrolloff' 0 no scroll offset
1610 'shiftround' off indent not rounded to shiftwidth
1611 'shortmess' + "" no shortening of messages
1612 'showcmd' + off command characters not shown
1613 'showmode' + off current mode not shown
1614 'smartcase' off no automatic ignore case switch
1615 'smartindent' off no smart indentation
1616 'smarttab' off no smart tab size
1617 'softtabstop' 0 tabs are always 'tabstop' positions
1618 'startofline' on goto startofline with some commands
1619 'tagrelative' + off tag file names are not relative
1620 'textauto' + off no automatic textmode detection
1621 'textwidth' 0 no automatic line wrap
1622 'tildeop' off tilde is not an operator
1623 'ttimeout' off no terminal timeout
1624 'whichwrap' + "" left-right movements don't wrap
1625 'wildchar' + CTRL-E only when the current value is <Tab>
1626 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001627 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628
1629 *'complete'* *'cpt'* *E535*
1630'complete' 'cpt' string (default: ".,w,b,u,t,i")
1631 local to buffer
1632 {not in Vi}
1633 This option specifies how keyword completion |ins-completion| works
1634 when CTRL-P or CTRL-N are used. It is also used for whole-line
1635 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1636 and the places to scan. It is a comma separated list of flags:
1637 . scan the current buffer ('wrapscan' is ignored)
1638 w scan buffers from other windows
1639 b scan other loaded buffers that are in the buffer list
1640 u scan the unloaded buffers that are in the buffer list
1641 U scan the buffers that are not in the buffer list
1642 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001643 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644 k{dict} scan the file {dict}. Several "k" flags can be given,
1645 patterns are valid too. For example: >
1646 :set cpt=k/usr/dict/*,k~/spanish
1647< s scan the files given with the 'thesaurus' option
1648 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1649 are valid too.
1650 i scan current and included files
1651 d scan current and included files for defined name or macro
1652 |i_CTRL-X_CTRL-D|
1653 ] tag completion
1654 t same as "]"
1655
1656 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1657 not executed, this may lead to unexpected completions from some files
1658 (gzipped files for example). Unloaded buffers are not scanned for
1659 whole-line completion.
1660
1661 The default is ".,w,b,u,t,i", which means to scan:
1662 1. the current buffer
1663 2. buffers in other windows
1664 3. other loaded buffers
1665 4. unloaded buffers
1666 5. tags
1667 6. included files
1668
1669 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001670 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1671 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001673 *'completefunc'* *'cfu'*
1674'completefunc' 'cfu' string (default: empty)
1675 local to buffer
1676 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001677 {not available when compiled without the |+eval|
1678 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001679 This option specifies a function to be used for Insert mode completion
1680 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001681 See |complete-functions| for an explanation of how the function is
1682 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001683
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001684
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001685 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001686'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001687 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001688 {not available when compiled without the
1689 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001690 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001691 A comma separated list of options for Insert mode completion
1692 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001693
1694 menu Use a popup menu to show the possible completions. The
1695 menu is only shown when there is more than one match and
1696 sufficient colors are available. |ins-completion-menu|
1697
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001698 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001699 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001700 match, e.g., what file it comes from.
1701
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001702 longest Only insert the longest common text of the matches. If
1703 the menu is displayed you can use CTRL-L to add more
1704 characters. Whether case is ignored depends on the kind
1705 of completion. For buffer text the 'ignorecase' option is
1706 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001707
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001708 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001709 completion in the preview window. Only works in
1710 combination with "menu" or "menuone".
1711
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001712
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001713 *'concealcursor'* *'cocu'*
1714'concealcursor' 'cocu' string (default: "")
1715 local to window
1716 {not in Vi}
1717 {not available when compiled without the |+conceal|
1718 feature}
1719 Sets the modes in which text in the cursor line can also be concealed.
1720 When the current mode is listed then concealing happens just like in
1721 other lines.
1722 n Normal mode
1723 v Visual mode
1724 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001725 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001726
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001727 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001728 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001729 are moving around text is concealed, but when starting to insert text
1730 or selecting a Visual area the concealed text is displayed, so that
1731 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001732 Keep in mind that the cursor position is not always where it's
1733 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001734
1735
1736'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001737 number (default 0)
1738 local to window
1739 {not in Vi}
1740 {not available when compiled without the |+conceal|
1741 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001742 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1743 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001744
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001745 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001746 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001747 1 Each block of concealed text is replaced with one
1748 character. If the syntax item does not have a custom
1749 replacement character defined (see |:syn-cchar|) the
1750 character defined in 'listchars' is used (default is a
1751 space).
1752 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001753 2 Concealed text is completely hidden unless it has a
1754 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001755 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001756 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001757
Bram Moolenaara7781e02010-07-19 20:13:22 +02001758 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001759 edit and copy the text. This can be changed with the 'concealcursor'
1760 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001761
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1763'confirm' 'cf' boolean (default off)
1764 global
1765 {not in Vi}
1766 When 'confirm' is on, certain operations that would normally
1767 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1768 instead raise a |dialog| asking if you wish to save the current
1769 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1770 If 'confirm' is off you can still activate confirmation for one
1771 command only (this is most useful in mappings) with the |:confirm|
1772 command.
1773 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1774
1775 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1776'conskey' 'consk' boolean (default off)
1777 global
1778 {not in Vi} {only for MS-DOS}
1779 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001780 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781 three methods of console input are available:
1782 'conskey' 'bioskey' action ~
1783 on on or off direct console input
1784 off on BIOS
1785 off off STDIN
1786
1787 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1788'copyindent' 'ci' boolean (default off)
1789 local to buffer
1790 {not in Vi}
1791 Copy the structure of the existing lines indent when autoindenting a
1792 new line. Normally the new indent is reconstructed by a series of
1793 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1794 in which case only spaces are used). Enabling this option makes the
1795 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001796 existing line. 'expandtab' has no effect on these characters, a Tab
1797 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 line, the remaining space is filled in the normal manner.
1799 NOTE: 'copyindent' is reset when 'compatible' is set.
1800 Also see 'preserveindent'.
1801
1802 *'cpoptions'* *'cpo'*
1803'cpoptions' 'cpo' string (Vim default: "aABceFs",
1804 Vi default: all flags)
1805 global
1806 {not in Vi}
1807 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001808 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809 not being vi-compatible is mostly or sometimes preferred.
1810 'cpoptions' stands for "compatible-options".
1811 Commas can be added for readability.
1812 To avoid problems with flags that are added in the future, use the
1813 "+=" and "-=" feature of ":set" |add-option-flags|.
1814 NOTE: This option is set to the Vi default value when 'compatible' is
1815 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001816 NOTE: This option is set to the POSIX default value at startup when
1817 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001818 variable exists |posix|. This means Vim tries to behave like the
1819 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820
1821 contains behavior ~
1822 *cpo-a*
1823 a When included, a ":read" command with a file name
1824 argument will set the alternate file name for the
1825 current window.
1826 *cpo-A*
1827 A When included, a ":write" command with a file name
1828 argument will set the alternate file name for the
1829 current window.
1830 *cpo-b*
1831 b "\|" in a ":map" command is recognized as the end of
1832 the map command. The '\' is included in the mapping,
1833 the text after the '|' is interpreted as the next
1834 command. Use a CTRL-V instead of a backslash to
1835 include the '|' in the mapping. Applies to all
1836 mapping, abbreviation, menu and autocmd commands.
1837 See also |map_bar|.
1838 *cpo-B*
1839 B A backslash has no special meaning in mappings,
1840 abbreviations and the "to" part of the menu commands.
1841 Remove this flag to be able to use a backslash like a
1842 CTRL-V. For example, the command ":map X \<Esc>"
1843 results in X being mapped to:
1844 'B' included: "\^[" (^[ is a real <Esc>)
1845 'B' excluded: "<Esc>" (5 characters)
1846 ('<' excluded in both cases)
1847 *cpo-c*
1848 c Searching continues at the end of any match at the
1849 cursor position, but not further than the start of the
1850 next line. When not present searching continues
1851 one character from the cursor position. With 'c'
1852 "abababababab" only gets three matches when repeating
1853 "/abab", without 'c' there are five matches.
1854 *cpo-C*
1855 C Do not concatenate sourced lines that start with a
1856 backslash. See |line-continuation|.
1857 *cpo-d*
1858 d Using "./" in the 'tags' option doesn't mean to use
1859 the tags file relative to the current file, but the
1860 tags file in the current directory.
1861 *cpo-D*
1862 D Can't use CTRL-K to enter a digraph after Normal mode
1863 commands with a character argument, like |r|, |f| and
1864 |t|.
1865 *cpo-e*
1866 e When executing a register with ":@r", always add a
1867 <CR> to the last line, also when the register is not
1868 linewise. If this flag is not present, the register
1869 is not linewise and the last line does not end in a
1870 <CR>, then the last line is put on the command-line
1871 and can be edited before hitting <CR>.
1872 *cpo-E*
1873 E It is an error when using "y", "d", "c", "g~", "gu" or
1874 "gU" on an Empty region. The operators only work when
1875 at least one character is to be operate on. Example:
1876 This makes "y0" fail in the first column.
1877 *cpo-f*
1878 f When included, a ":read" command with a file name
1879 argument will set the file name for the current buffer,
1880 if the current buffer doesn't have a file name yet.
1881 *cpo-F*
1882 F When included, a ":write" command with a file name
1883 argument will set the file name for the current
1884 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001885 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886 *cpo-g*
1887 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001888 *cpo-H*
1889 H When using "I" on a line with only blanks, insert
1890 before the last blank. Without this flag insert after
1891 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 *cpo-i*
1893 i When included, interrupting the reading of a file will
1894 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001895 *cpo-I*
1896 I When moving the cursor up or down just after inserting
1897 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001898 *cpo-j*
1899 j When joining lines, only add two spaces after a '.',
1900 not after '!' or '?'. Also see 'joinspaces'.
1901 *cpo-J*
1902 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001903 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904 white space.
1905 *cpo-k*
1906 k Disable the recognition of raw key codes in
1907 mappings, abbreviations, and the "to" part of menu
1908 commands. For example, if <Key> sends ^[OA (where ^[
1909 is <Esc>), the command ":map X ^[OA" results in X
1910 being mapped to:
1911 'k' included: "^[OA" (3 characters)
1912 'k' excluded: "<Key>" (one key code)
1913 Also see the '<' flag below.
1914 *cpo-K*
1915 K Don't wait for a key code to complete when it is
1916 halfway a mapping. This breaks mapping <F1><F1> when
1917 only part of the second <F1> has been read. It
1918 enables cancelling the mapping by typing <F1><Esc>.
1919 *cpo-l*
1920 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001921 literally, only "\]", "\^", "\-" and "\\" are special.
1922 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1924 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001925 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926 *cpo-L*
1927 L When the 'list' option is set, 'wrapmargin',
1928 'textwidth', 'softtabstop' and Virtual Replace mode
1929 (see |gR|) count a <Tab> as two characters, instead of
1930 the normal behavior of a <Tab>.
1931 *cpo-m*
1932 m When included, a showmatch will always wait half a
1933 second. When not included, a showmatch will wait half
1934 a second or until a character is typed. |'showmatch'|
1935 *cpo-M*
1936 M When excluded, "%" matching will take backslashes into
1937 account. Thus in "( \( )" and "\( ( \)" the outer
1938 parenthesis match. When included "%" ignores
1939 backslashes, which is Vi compatible.
1940 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001941 n When included, the column used for 'number' and
1942 'relativenumber' will also be used for text of wrapped
1943 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001944 *cpo-o*
1945 o Line offset to search command is not remembered for
1946 next search.
1947 *cpo-O*
1948 O Don't complain if a file is being overwritten, even
1949 when it didn't exist when editing it. This is a
1950 protection against a file unexpectedly created by
1951 someone else. Vi didn't complain about this.
1952 *cpo-p*
1953 p Vi compatible Lisp indenting. When not present, a
1954 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001955 *cpo-P*
1956 P When included, a ":write" command that appends to a
1957 file will set the file name for the current buffer, if
1958 the current buffer doesn't have a file name yet and
1959 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001960 *cpo-q*
1961 q When joining multiple lines leave the cursor at the
1962 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001963 *cpo-r*
1964 r Redo ("." command) uses "/" to repeat a search
1965 command, instead of the actually used search string.
1966 *cpo-R*
1967 R Remove marks from filtered lines. Without this flag
1968 marks are kept like |:keepmarks| was used.
1969 *cpo-s*
1970 s Set buffer options when entering the buffer for the
1971 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001972 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973 set when the buffer is created.
1974 *cpo-S*
1975 S Set buffer options always when entering a buffer
1976 (except 'readonly', 'fileformat', 'filetype' and
1977 'syntax'). This is the (most) Vi compatible setting.
1978 The options are set to the values in the current
1979 buffer. When you change an option and go to another
1980 buffer, the value is copied. Effectively makes the
1981 buffer options global to all buffers.
1982
1983 's' 'S' copy buffer options
1984 no no when buffer created
1985 yes no when buffer first entered (default)
1986 X yes each time when buffer entered (vi comp.)
1987 *cpo-t*
1988 t Search pattern for the tag command is remembered for
1989 "n" command. Otherwise Vim only puts the pattern in
1990 the history for search pattern, but doesn't change the
1991 last used search pattern.
1992 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001993 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001994 *cpo-v*
1995 v Backspaced characters remain visible on the screen in
1996 Insert mode. Without this flag the characters are
1997 erased from the screen right away. With this flag the
1998 screen newly typed text overwrites backspaced
1999 characters.
2000 *cpo-w*
2001 w When using "cw" on a blank character, only change one
2002 character and not all blanks until the start of the
2003 next word.
2004 *cpo-W*
2005 W Don't overwrite a readonly file. When omitted, ":w!"
2006 overwrites a readonly file, if possible.
2007 *cpo-x*
2008 x <Esc> on the command-line executes the command-line.
2009 The default in Vim is to abandon the command-line,
2010 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002011 *cpo-X*
2012 X When using a count with "R" the replaced text is
2013 deleted only once. Also when repeating "R" with "."
2014 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002015 *cpo-y*
2016 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002017 *cpo-Z*
2018 Z When using "w!" while the 'readonly' option is set,
2019 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 *cpo-!*
2021 ! When redoing a filter command, use the last used
2022 external command, whatever it was. Otherwise the last
2023 used -filter- command is used.
2024 *cpo-$*
2025 $ When making a change to one line, don't redisplay the
2026 line, but put a '$' at the end of the changed text.
2027 The changed text will be overwritten when you type the
2028 new text. The line is redisplayed if you type any
2029 command that moves the cursor from the insertion
2030 point.
2031 *cpo-%*
2032 % Vi-compatible matching is done for the "%" command.
2033 Does not recognize "#if", "#endif", etc.
2034 Does not recognize "/*" and "*/".
2035 Parens inside single and double quotes are also
2036 counted, causing a string that contains a paren to
2037 disturb the matching. For example, in a line like
2038 "if (strcmp("foo(", s))" the first paren does not
2039 match the last one. When this flag is not included,
2040 parens inside single and double quotes are treated
2041 specially. When matching a paren outside of quotes,
2042 everything inside quotes is ignored. When matching a
2043 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002044 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002045 This flag is also used for other features, such as
2046 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002047 *cpo--*
2048 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002049 it would go above the first line or below the last
2050 line. Without it the cursor moves to the first or
2051 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002052 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002053 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002054 *cpo-+*
2055 + When included, a ":write file" command will reset the
2056 'modified' flag of the buffer, even though the buffer
2057 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002058 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 * Use ":*" in the same way as ":@". When not included,
2060 ":*" is an alias for ":'<,'>", select the Visual area.
2061 *cpo-<*
2062 < Disable the recognition of special key codes in |<>|
2063 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002064 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065 ":map X <Tab>" results in X being mapped to:
2066 '<' included: "<Tab>" (5 characters)
2067 '<' excluded: "^I" (^I is a real <Tab>)
2068 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002069 *cpo->*
2070 > When appending to a register, put a line break before
2071 the appended text.
2072
2073 POSIX flags. These are not included in the Vi default value, except
2074 when $VIM_POSIX was set on startup. |posix|
2075
2076 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002077 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002078 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002079 *cpo-&*
2080 & When ":preserve" was used keep the swap file when
2081 exiting normally while this buffer is still loaded.
2082 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002083 *cpo-\*
2084 \ Backslash in a [] range in a search pattern is taken
2085 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002086 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2087 '\' excluded: "/[ \-]" finds <Space> and '-'
2088 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002089 *cpo-/*
2090 / When "%" is used as the replacement string in a |:s|
2091 command, use the previous replacement string. |:s%|
2092 *cpo-{*
2093 { The |{| and |}| commands also stop at a "{" character
2094 at the start of a line.
2095 *cpo-.*
2096 . The ":chdir" and ":cd" commands fail if the current
2097 buffer is modified, unless ! is used. Vim doesn't
2098 need this, since it remembers the full path of an
2099 opened file.
2100 *cpo-bar*
2101 | The value of the $LINES and $COLUMNS environment
2102 variables overrule the terminal size values obtained
2103 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002104
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002106 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002107'cryptmethod' string (default "zip")
2108 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002109 {not in Vi}
2110 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002111 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002112 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002113 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002114 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002115 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002116 or later, files can NOT be read by Vim 7.2 and older.
2117 This adds a "seed" to the file, every time you write
2118 the file the encrypted bytes will be different.
2119
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002120 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002121 to the detected method of the file being read. Thus if you write it
2122 without changing 'cryptmethod' the same method will be used.
2123 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002124 explicitly write it, you don't get a warning unless there are other
2125 modifications. Also see |:X|.
2126
2127 When setting the global value to an empty string, it will end up with
2128 the value "zip". When setting the local value to an empty string the
2129 buffer will use the global value.
2130
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002131 When a new encryption method is added in a later version of Vim, and
2132 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002133 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002134
2135
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 *'cscopepathcomp'* *'cspc'*
2137'cscopepathcomp' 'cspc' number (default 0)
2138 global
2139 {not available when compiled without the |+cscope|
2140 feature}
2141 {not in Vi}
2142 Determines how many components of the path to show in a list of tags.
2143 See |cscopepathcomp|.
2144
2145 *'cscopeprg'* *'csprg'*
2146'cscopeprg' 'csprg' string (default "cscope")
2147 global
2148 {not available when compiled without the |+cscope|
2149 feature}
2150 {not in Vi}
2151 Specifies the command to execute cscope. See |cscopeprg|.
2152 This option cannot be set from a |modeline| or in the |sandbox|, for
2153 security reasons.
2154
2155 *'cscopequickfix'* *'csqf'*
2156'cscopequickfix' 'csqf' string (default "")
2157 global
2158 {not available when compiled without the |+cscope|
2159 or |+quickfix| features}
2160 {not in Vi}
2161 Specifies whether to use quickfix window to show cscope results.
2162 See |cscopequickfix|.
2163
2164 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2165'cscopetag' 'cst' boolean (default off)
2166 global
2167 {not available when compiled without the |+cscope|
2168 feature}
2169 {not in Vi}
2170 Use cscope for tag commands. See |cscope-options|.
2171 NOTE: This option is reset when 'compatible' is set.
2172
2173 *'cscopetagorder'* *'csto'*
2174'cscopetagorder' 'csto' number (default 0)
2175 global
2176 {not available when compiled without the |+cscope|
2177 feature}
2178 {not in Vi}
2179 Determines the order in which ":cstag" performs a search. See
2180 |cscopetagorder|.
2181 NOTE: This option is set to 0 when 'compatible' is set.
2182
2183 *'cscopeverbose'* *'csverb'*
2184 *'nocscopeverbose'* *'nocsverb'*
2185'cscopeverbose' 'csverb' boolean (default off)
2186 global
2187 {not available when compiled without the |+cscope|
2188 feature}
2189 {not in Vi}
2190 Give messages when adding a cscope database. See |cscopeverbose|.
2191 NOTE: This option is reset when 'compatible' is set.
2192
Bram Moolenaar860cae12010-06-05 23:22:07 +02002193 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2194'cursorbind' 'crb' boolean (default off)
2195 local to window
2196 {not in Vi}
2197 {not available when compiled without the |+cursorbind|
2198 feature}
2199 When this option is set, as the cursor in the current
2200 window moves other cursorbound windows (windows that also have
2201 this option set) move their cursors to the corresponding line and
2202 column. This option is useful for viewing the
2203 differences between two versions of a file (see 'diff'); in diff mode,
2204 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002205 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002206
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002207
2208 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2209'cursorcolumn' 'cuc' boolean (default off)
2210 local to window
2211 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002212 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002213 feature}
2214 Highlight the screen column of the cursor with CursorColumn
2215 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2216 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002217 If you only want the highlighting in the current window you can use
2218 these autocommands: >
2219 au WinLeave * set nocursorline nocursorcolumn
2220 au WinEnter * set cursorline cursorcolumn
2221<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002222
2223 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2224'cursorline' 'cul' boolean (default off)
2225 local to window
2226 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002227 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002228 feature}
2229 Highlight the screen line of the cursor with CursorLine
2230 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2231 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002232 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002233 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002234
2235
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236 *'debug'*
2237'debug' string (default "")
2238 global
2239 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002240 These values can be used:
2241 msg Error messages that would otherwise be omitted will be given
2242 anyway.
2243 throw Error messages that would otherwise be omitted will be given
2244 anyway and also throw an exception and set |v:errmsg|.
2245 beep A message will be given when otherwise only a beep would be
2246 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002247 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002248 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2249 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250
2251 *'define'* *'def'*
2252'define' 'def' string (default "^\s*#\s*define")
2253 global or local to buffer |global-local|
2254 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002255 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256 pattern, just like for the "/" command. This option is used for the
2257 commands like "[i" and "[d" |include-search|. The 'isident' option is
2258 used to recognize the defined name after the match:
2259 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2260 See |option-backslash| about inserting backslashes to include a space
2261 or backslash.
2262 The default value is for C programs. For C++ this value would be
2263 useful, to include const type declarations: >
2264 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2265< When using the ":set" command, you need to double the backslashes!
2266
2267 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2268'delcombine' 'deco' boolean (default off)
2269 global
2270 {not in Vi}
2271 {only available when compiled with the |+multi_byte|
2272 feature}
2273 If editing Unicode and this option is set, backspace and Normal mode
2274 "x" delete each combining character on its own. When it is off (the
2275 default) the character along with its combining characters are
2276 deleted.
2277 Note: When 'delcombine' is set "xx" may work different from "2x"!
2278
2279 This is useful for Arabic, Hebrew and many other languages where one
2280 may have combining characters overtop of base characters, and want
2281 to remove only the combining ones.
2282
2283 *'dictionary'* *'dict'*
2284'dictionary' 'dict' string (default "")
2285 global or local to buffer |global-local|
2286 {not in Vi}
2287 List of file names, separated by commas, that are used to lookup words
2288 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2289 contain a list of words. This can be one word per line, or several
2290 words per line, separated by non-keyword characters (white space is
2291 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002292 When this option is empty, or an entry "spell" is present, spell
2293 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002294 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002295 after a comma are ignored, otherwise spaces are included in the file
2296 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002297 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002298 Where to find a list of words?
2299 - On FreeBSD, there is the file "/usr/share/dict/words".
2300 - In the Simtel archive, look in the "msdos/linguist" directory.
2301 - In "miscfiles" of the GNU collection.
2302 The use of |:set+=| and |:set-=| is preferred when adding or removing
2303 directories from the list. This avoids problems when a future version
2304 uses another default.
2305 Backticks cannot be used in this option for security reasons.
2306
2307 *'diff'* *'nodiff'*
2308'diff' boolean (default off)
2309 local to window
2310 {not in Vi}
2311 {not available when compiled without the |+diff|
2312 feature}
2313 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002314 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002315
2316 *'dex'* *'diffexpr'*
2317'diffexpr' 'dex' string (default "")
2318 global
2319 {not in Vi}
2320 {not available when compiled without the |+diff|
2321 feature}
2322 Expression which is evaluated to obtain an ed-style diff file from two
2323 versions of a file. See |diff-diffexpr|.
2324 This option cannot be set from a |modeline| or in the |sandbox|, for
2325 security reasons.
2326
2327 *'dip'* *'diffopt'*
2328'diffopt' 'dip' string (default "filler")
2329 global
2330 {not in Vi}
2331 {not available when compiled without the |+diff|
2332 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002333 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334 All are optional. Items must be separated by a comma.
2335
2336 filler Show filler lines, to keep the text
2337 synchronized with a window that has inserted
2338 lines at the same position. Mostly useful
2339 when windows are side-by-side and 'scrollbind'
2340 is set.
2341
2342 context:{n} Use a context of {n} lines between a change
2343 and a fold that contains unchanged lines.
2344 When omitted a context of six lines is used.
2345 See |fold-diff|.
2346
2347 icase Ignore changes in case of text. "a" and "A"
2348 are considered the same. Adds the "-i" flag
2349 to the "diff" command if 'diffexpr' is empty.
2350
2351 iwhite Ignore changes in amount of white space. Adds
2352 the "-b" flag to the "diff" command if
2353 'diffexpr' is empty. Check the documentation
2354 of the "diff" command for what this does
2355 exactly. It should ignore adding trailing
2356 white space, but not leading white space.
2357
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002358 horizontal Start diff mode with horizontal splits (unless
2359 explicitly specified otherwise).
2360
2361 vertical Start diff mode with vertical splits (unless
2362 explicitly specified otherwise).
2363
2364 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2365 starting diff mode. Without this 2 is used.
2366
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 Examples: >
2368
2369 :set diffopt=filler,context:4
2370 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002371 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372<
2373 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2374'digraph' 'dg' boolean (default off)
2375 global
2376 {not in Vi}
2377 {not available when compiled without the |+digraphs|
2378 feature}
2379 Enable the entering of digraphs in Insert mode with {char1} <BS>
2380 {char2}. See |digraphs|.
2381 NOTE: This option is reset when 'compatible' is set.
2382
2383 *'directory'* *'dir'*
2384'directory' 'dir' string (default for Amiga: ".,t:",
2385 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2386 for Unix: ".,~/tmp,/var/tmp,/tmp")
2387 global
2388 List of directory names for the swap file, separated with commas.
2389 - The swap file will be created in the first directory where this is
2390 possible.
2391 - Empty means that no swap file will be used (recovery is
2392 impossible!).
2393 - A directory "." means to put the swap file in the same directory as
2394 the edited file. On Unix, a dot is prepended to the file name, so
2395 it doesn't show in a directory listing. On MS-Windows the "hidden"
2396 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002397 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 put the swap file relative to where the edited file is. The leading
2399 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002400 - For Unix and Win32, if a directory ends in two path separators "//"
2401 or "\\", the swap file name will be built from the complete path to
2402 the file with all path separators substituted to percent '%' signs.
2403 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002404 On Win32, when a separating comma is following, you must use "//",
2405 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406 - Spaces after the comma are ignored, other spaces are considered part
2407 of the directory name. To have a space at the start of a directory
2408 name, precede it with a backslash.
2409 - To include a comma in a directory name precede it with a backslash.
2410 - A directory name may end in an ':' or '/'.
2411 - Environment variables are expanded |:set_env|.
2412 - Careful with '\' characters, type one before a space, type two to
2413 get one in the option (see |option-backslash|), for example: >
2414 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2415< - For backwards compatibility with Vim version 3.0 a '>' at the start
2416 of the option is removed.
2417 Using "." first in the list is recommended. This means that editing
2418 the same file twice will result in a warning. Using "/tmp" on Unix is
2419 discouraged: When the system crashes you lose the swap file.
2420 "/var/tmp" is often not cleared when rebooting, thus is a better
2421 choice than "/tmp". But it can contain a lot of files, your swap
2422 files get lost in the crowd. That is why a "tmp" directory in your
2423 home directory is tried first.
2424 The use of |:set+=| and |:set-=| is preferred when adding or removing
2425 directories from the list. This avoids problems when a future version
2426 uses another default.
2427 This option cannot be set from a |modeline| or in the |sandbox|, for
2428 security reasons.
2429 {Vi: directory to put temp file in, defaults to "/tmp"}
2430
2431 *'display'* *'dy'*
2432'display' 'dy' string (default "")
2433 global
2434 {not in Vi}
2435 Change the way text is displayed. This is comma separated list of
2436 flags:
2437 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002438 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439 last line that doesn't fit is replaced with "@" lines.
2440 uhex Show unprintable characters hexadecimal as <xx>
2441 instead of using ^C and ~C.
2442
2443 *'eadirection'* *'ead'*
2444'eadirection' 'ead' string (default "both")
2445 global
2446 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002447 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448 feature}
2449 Tells when the 'equalalways' option applies:
2450 ver vertically, width of windows is not affected
2451 hor horizontally, height of windows is not affected
2452 both width and height of windows is affected
2453
2454 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2455'edcompatible' 'ed' boolean (default off)
2456 global
2457 Makes the 'g' and 'c' flags of the ":substitute" command to be
2458 toggled each time the flag is given. See |complex-change|. See
2459 also 'gdefault' option.
2460 Switching this option on is discouraged!
2461
2462 *'encoding'* *'enc'* *E543*
2463'encoding' 'enc' string (default: "latin1" or value from $LANG)
2464 global
2465 {only available when compiled with the |+multi_byte|
2466 feature}
2467 {not in Vi}
2468 Sets the character encoding used inside Vim. It applies to text in
2469 the buffers, registers, Strings in expressions, text stored in the
2470 viminfo file, etc. It sets the kind of characters which Vim can work
2471 with. See |encoding-names| for the possible values.
2472
2473 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002474 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002475 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002476 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002477
Bram Moolenaar865242e2010-07-14 21:12:05 +02002478 This option cannot be set from a |modeline|. It would most likely
2479 corrupt the text.
2480
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2482 "utf-8". Although care has been taken to allow different values of
2483 'encoding', "utf-8" is the natural choice for the environment and
2484 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002485 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 versions, and to avoid changing the encoding of newly created files
2487 without your knowledge (in case 'fileencodings' is empty).
2488
2489 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002490 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491 iconv() or as specified with 'charconvert'.
2492
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002493 If you need to know whether 'encoding' is a multi-byte encoding, you
2494 can use: >
2495 if has("multi_byte_encoding")
2496<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497 Normally 'encoding' will be equal to your current locale. This will
2498 be the default if Vim recognizes your environment settings. If
2499 'encoding' is not set to the current locale, 'termencoding' must be
2500 set to convert typed and displayed text. See |encoding-table|.
2501
2502 When you set this option, it fires the |EncodingChanged| autocommand
2503 event so that you can set up fonts if necessary.
2504
2505 When the option is set, the value is converted to lowercase. Thus
2506 you can set it with uppercase values too. Underscores are translated
2507 to '-' signs.
2508 When the encoding is recognized, it is changed to the standard name.
2509 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2510 "iso-8859-2" and "utf8" becomes "utf-8".
2511
2512 Note: "latin1" is also used when the encoding could not be detected.
2513 This only works when editing files in the same encoding! When the
2514 actual character set is not latin1, make sure 'fileencoding' and
2515 'fileencodings' are empty. When conversion is needed, switch to using
2516 utf-8.
2517
2518 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2519 You don't notice this while editing, but it does matter for the
2520 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2521 setting 'encoding' to one of these values instead of utf-8 only has
2522 effect for encoding used for files when 'fileencoding' is empty.
2523
Bram Moolenaar661b1822005-07-28 22:36:45 +00002524 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2525 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526
2527 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2528'endofline' 'eol' boolean (default on)
2529 local to buffer
2530 {not in Vi}
2531 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002532 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002533 option is automatically set when starting to edit a new file, unless
2534 the file does not have an <EOL> for the last line in the file, in
2535 which case it is reset. Normally you don't have to set or reset this
2536 option. When 'binary' is off the value is not used when writing the
2537 file. When 'binary' is on it is used to remember the presence of a
2538 <EOL> for the last line in the file, so that when you write the file
2539 the situation from the original file can be kept. But you can change
2540 it if you want to.
2541
2542 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2543'equalalways' 'ea' boolean (default on)
2544 global
2545 {not in Vi}
2546 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002547 splitting or closing a window. This also happens the moment the
2548 option is switched on. When off, splitting a window will reduce the
2549 size of the current window and leave the other windows the same. When
2550 closing a window the extra lines are given to the window next to it
2551 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552 When mixing vertically and horizontally split windows, a minimal size
2553 is computed and some windows may be larger if there is room. The
2554 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002555 Changing the height and width of a window can be avoided by setting
2556 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002557 If a window size is specified when creating a new window sizes are
2558 currently not equalized (it's complicated, but may be implemented in
2559 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560
2561 *'equalprg'* *'ep'*
2562'equalprg' 'ep' string (default "")
2563 global or local to buffer |global-local|
2564 {not in Vi}
2565 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002566 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002567 or 'indentexpr'. When Vim was compiled without internal formatting,
2568 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002569 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 about including spaces and backslashes.
2571 This option cannot be set from a |modeline| or in the |sandbox|, for
2572 security reasons.
2573
2574 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2575'errorbells' 'eb' boolean (default off)
2576 global
2577 Ring the bell (beep or screen flash) for error messages. This only
2578 makes a difference for error messages, the bell will be used always
2579 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002580 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 screen flash or do nothing.
2582
2583 *'errorfile'* *'ef'*
2584'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2585 others: "errors.err")
2586 global
2587 {not in Vi}
2588 {not available when compiled without the |+quickfix|
2589 feature}
2590 Name of the errorfile for the QuickFix mode (see |:cf|).
2591 When the "-q" command-line argument is used, 'errorfile' is set to the
2592 following argument. See |-q|.
2593 NOT used for the ":make" command. See 'makeef' for that.
2594 Environment variables are expanded |:set_env|.
2595 See |option-backslash| about including spaces and backslashes.
2596 This option cannot be set from a |modeline| or in the |sandbox|, for
2597 security reasons.
2598
2599 *'errorformat'* *'efm'*
2600'errorformat' 'efm' string (default is very long)
2601 global or local to buffer |global-local|
2602 {not in Vi}
2603 {not available when compiled without the |+quickfix|
2604 feature}
2605 Scanf-like description of the format for the lines in the error file
2606 (see |errorformat|).
2607
2608 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2609'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2610 global
2611 {not in Vi}
2612 Function keys that start with an <Esc> are recognized in Insert
2613 mode. When this option is off, the cursor and function keys cannot be
2614 used in Insert mode if they start with an <Esc>. The advantage of
2615 this is that the single <Esc> is recognized immediately, instead of
2616 after one second. Instead of resetting this option, you might want to
2617 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2618 when 'esckeys' is off, you can still map anything, but the cursor keys
2619 won't work by default.
2620 NOTE: This option is set to the Vi default value when 'compatible' is
2621 set and to the Vim default value when 'compatible' is reset.
2622
2623 *'eventignore'* *'ei'*
2624'eventignore' 'ei' string (default "")
2625 global
2626 {not in Vi}
2627 {not available when compiled without the |+autocmd|
2628 feature}
2629 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002630 When set to "all" or when "all" is one of the items, all autocommand
2631 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632 Otherwise this is a comma separated list of event names. Example: >
2633 :set ei=WinEnter,WinLeave
2634<
2635 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2636'expandtab' 'et' boolean (default off)
2637 local to buffer
2638 {not in Vi}
2639 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002640 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002641 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2642 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2643 NOTE: This option is reset when 'compatible' is set.
2644
2645 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2646'exrc' 'ex' boolean (default off)
2647 global
2648 {not in Vi}
2649 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2650 directory. If you switch this option on you should also consider
2651 setting the 'secure' option (see |initialization|). Using a local
2652 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2653 also see |.vimrc| and |gui-init|.
2654 This option cannot be set from a |modeline| or in the |sandbox|, for
2655 security reasons.
2656
2657 *'fileencoding'* *'fenc'* *E213*
2658'fileencoding' 'fenc' string (default: "")
2659 local to buffer
2660 {only available when compiled with the |+multi_byte|
2661 feature}
2662 {not in Vi}
2663 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002664
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002666 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 When 'fileencoding' is empty, the same value as 'encoding' will be
2668 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002669 Conversion will also be done when 'encoding' and 'fileencoding' are
2670 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2671 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002673 'encoding' is "utf-8" or another Unicode encoding, conversion
2674 is most likely done in a way that the reverse conversion
2675 results in the same text. When 'encoding' is not "utf-8" some
2676 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002677
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 See 'encoding' for the possible values. Additionally, values may be
2679 specified that can be handled by the converter, see
2680 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002681
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682 When reading a file 'fileencoding' will be set from 'fileencodings'.
2683 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002684 'fileencoding', use the |++enc| argument. One exception: when
2685 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002686 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002687
Bram Moolenaar071d4272004-06-13 20:20:40 +00002688 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2689 When the option is set, the value is converted to lowercase. Thus
2690 you can set it with uppercase values too. '_' characters are
2691 replaced with '-'. If a name is recognized from the list for
2692 'encoding', it is replaced by the standard name. For example
2693 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002694
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 When this option is set, after starting to edit a file, the 'modified'
2696 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002697
2698 Keep in mind that changing 'fenc' from a modeline happens
2699 AFTER the text has been read, thus it applies to when the file will be
2700 written. If you do set 'fenc' in a modeline, you might want to set
2701 'nomodified' to avoid not being able to ":q".
2702
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 This option can not be changed when 'modifiable' is off.
2704
2705 *'fe'*
2706 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002707 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 old short name was 'fe', which is no longer used.
2709
2710 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002711'fileencodings' 'fencs' string (default: "ucs-bom",
2712 "ucs-bom,utf-8,default,latin1" when
2713 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 global
2715 {only available when compiled with the |+multi_byte|
2716 feature}
2717 {not in Vi}
2718 This is a list of character encodings considered when starting to edit
2719 an existing file. When a file is read, Vim tries to use the first
2720 mentioned character encoding. If an error is detected, the next one
2721 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002722 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 an empty string, which means the value of 'encoding' is used.
2724 WARNING: Conversion can cause loss of information! When
2725 'encoding' is "utf-8" (or one of the other Unicode variants)
2726 conversion is most likely done in a way that the reverse
2727 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002728 "utf-8" some non-ASCII characters may be lost! You can use
2729 the |++bad| argument to specify what is done with characters
2730 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731 For an empty file or a file with only ASCII characters most encodings
2732 will work and the first entry of 'fileencodings' will be used (except
2733 "ucs-bom", which requires the BOM to be present). If you prefer
2734 another encoding use an BufReadPost autocommand event to test if your
2735 preferred encoding is to be used. Example: >
2736 au BufReadPost * if search('\S', 'w') == 0 |
2737 \ set fenc=iso-2022-jp | endif
2738< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2739 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002740 When the |++enc| argument is used then the value of 'fileencodings' is
2741 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002742 Note that 'fileencodings' is not used for a new file, the global value
2743 of 'fileencoding' is used instead. You can set it with: >
2744 :setglobal fenc=iso-8859-2
2745< This means that a non-existing file may get a different encoding than
2746 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002747 The special value "ucs-bom" can be used to check for a Unicode BOM
2748 (Byte Order Mark) at the start of the file. It must not be preceded
2749 by "utf-8" or another Unicode encoding for this to work properly.
2750 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2751 because Vim cannot detect an error, thus the encoding is always
2752 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002753 The special value "default" can be used for the encoding from the
2754 environment. This is the default value for 'encoding'. It is useful
2755 when 'encoding' is set to "utf-8" and your environment uses a
2756 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002757 When 'encoding' is "utf-8" and a file contains an illegal byte
2758 sequence it won't be recognized as UTF-8. You can use the |8g8|
2759 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760 WRONG VALUES: WHAT'S WRONG:
2761 latin1,utf-8 "latin1" will always be used
2762 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2763 file
2764 cp1250,latin1 "cp1250" will always be used
2765 If 'fileencodings' is empty, 'fileencoding' is not modified.
2766 See 'fileencoding' for the possible values.
2767 Setting this option does not have an effect until the next time a file
2768 is read.
2769
2770 *'fileformat'* *'ff'*
2771'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2772 Unix default: "unix",
2773 Macintosh default: "mac")
2774 local to buffer
2775 {not in Vi}
2776 This gives the <EOL> of the current buffer, which is used for
2777 reading/writing the buffer from/to a file:
2778 dos <CR> <NL>
2779 unix <NL>
2780 mac <CR>
2781 When "dos" is used, CTRL-Z at the end of a file is ignored.
2782 See |file-formats| and |file-read|.
2783 For the character encoding of the file see 'fileencoding'.
2784 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2785 works like it was set to "unix'.
2786 This option is set automatically when starting to edit a file and
2787 'fileformats' is not empty and 'binary' is off.
2788 When this option is set, after starting to edit a file, the 'modified'
2789 option is set, because the file would be different when written.
2790 This option can not be changed when 'modifiable' is off.
2791 For backwards compatibility: When this option is set to "dos",
2792 'textmode' is set, otherwise 'textmode' is reset.
2793
2794 *'fileformats'* *'ffs'*
2795'fileformats' 'ffs' string (default:
2796 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2797 Vim Unix: "unix,dos",
2798 Vim Mac: "mac,unix,dos",
2799 Vi Cygwin: "unix,dos",
2800 Vi others: "")
2801 global
2802 {not in Vi}
2803 This gives the end-of-line (<EOL>) formats that will be tried when
2804 starting to edit a new buffer and when reading a file into an existing
2805 buffer:
2806 - When empty, the format defined with 'fileformat' will be used
2807 always. It is not set automatically.
2808 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002809 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 'fileformats' name will be used when a file is read into an existing
2811 buffer, no matter what 'fileformat' for that buffer is set to.
2812 - When more than one name is present, separated by commas, automatic
2813 <EOL> detection will be done when reading a file. When starting to
2814 edit a file, a check is done for the <EOL>:
2815 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2816 'fileformat' is set to "dos".
2817 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002818 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819 preceding <CR>, "unix" is preferred over "dos".
2820 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2821 This means that "mac" is only chosen when "unix" is not present,
2822 or when no <NL> is found in the file, and when "dos" is not
2823 present, or no <CR><NL> is present in the file.
2824 Also if "unix" was first chosen, but the first <CR> is before
2825 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2826 the file, then 'fileformat' is set to "mac".
2827 4. If 'fileformat' is still not set, the first name from
2828 'fileformats' is used.
2829 When reading a file into an existing buffer, the same is done, but
2830 this happens like 'fileformat' has been set appropriately for that
2831 file only, the option is not changed.
2832 When 'binary' is set, the value of 'fileformats' is not used.
2833
2834 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2835 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2836 done:
2837 - When 'fileformats' is empty, there is no automatic detection. Dos
2838 format will be used.
2839 - When 'fileformats' is set to one or more names, automatic detection
2840 is done. This is based on the first <NL> in the file: If there is a
2841 <CR> in front of it, Dos format is used, otherwise Unix format is
2842 used.
2843 Also see |file-formats|.
2844 For backwards compatibility: When this option is set to an empty
2845 string or one format (no comma is included), 'textauto' is reset,
2846 otherwise 'textauto' is set.
2847 NOTE: This option is set to the Vi default value when 'compatible' is
2848 set and to the Vim default value when 'compatible' is reset.
2849
2850 *'filetype'* *'ft'*
2851'filetype' 'ft' string (default: "")
2852 local to buffer
2853 {not in Vi}
2854 {not available when compiled without the |+autocmd|
2855 feature}
2856 When this option is set, the FileType autocommand event is triggered.
2857 All autocommands that match with the value of this option will be
2858 executed. Thus the value of 'filetype' is used in place of the file
2859 name.
2860 Otherwise this option does not always reflect the current file type.
2861 This option is normally set when the file type is detected. To enable
2862 this use the ":filetype on" command. |:filetype|
2863 Setting this option to a different value is most useful in a modeline,
2864 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002865 Example, for in an IDL file:
2866 /* vim: set filetype=idl : */ ~
2867 |FileType| |filetypes|
2868 When a dot appears in the value then this separates two filetype
2869 names. Example:
2870 /* vim: set filetype=c.doxygen : */ ~
2871 This will use the "c" filetype first, then the "doxygen" filetype.
2872 This works both for filetype plugins and for syntax files. More than
2873 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 Do not confuse this option with 'osfiletype', which is for the file
2875 type that is actually stored with the file.
2876 This option is not copied to another buffer, independent of the 's' or
2877 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002878 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879
2880 *'fillchars'* *'fcs'*
2881'fillchars' 'fcs' string (default "vert:|,fold:-")
2882 global
2883 {not in Vi}
2884 {not available when compiled without the |+windows|
2885 and |+folding| features}
2886 Characters to fill the statuslines and vertical separators.
2887 It is a comma separated list of items:
2888
2889 item default Used for ~
2890 stl:c ' ' or '^' statusline of the current window
2891 stlnc:c ' ' or '-' statusline of the non-current windows
2892 vert:c '|' vertical separators |:vsplit|
2893 fold:c '-' filling 'foldtext'
2894 diff:c '-' deleted lines of the 'diff' option
2895
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002896 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897 "stlnc" the space will be used when there is highlighting, '^' or '-'
2898 otherwise.
2899
2900 Example: >
2901 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2902< This is similar to the default, except that these characters will also
2903 be used when there is highlighting.
2904
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002905 for "stl" and "stlnc" only single-byte values are supported.
2906
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907 The highlighting used for these items:
2908 item highlight group ~
2909 stl:c StatusLine |hl-StatusLine|
2910 stlnc:c StatusLineNC |hl-StatusLineNC|
2911 vert:c VertSplit |hl-VertSplit|
2912 fold:c Folded |hl-Folded|
2913 diff:c DiffDelete |hl-DiffDelete|
2914
2915 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2916'fkmap' 'fk' boolean (default off) *E198*
2917 global
2918 {not in Vi}
2919 {only available when compiled with the |+rightleft|
2920 feature}
2921 When on, the keyboard is mapped for the Farsi character set.
2922 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002923 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924
2925 *'foldclose'* *'fcl'*
2926'foldclose' 'fcl' string (default "")
2927 global
2928 {not in Vi}
2929 {not available when compiled without the |+folding|
2930 feature}
2931 When set to "all", a fold is closed when the cursor isn't in it and
2932 its level is higher than 'foldlevel'. Useful if you want folds to
2933 automatically close when moving out of them.
2934
2935 *'foldcolumn'* *'fdc'*
2936'foldcolumn' 'fdc' number (default 0)
2937 local to window
2938 {not in Vi}
2939 {not available when compiled without the |+folding|
2940 feature}
2941 When non-zero, a column with the specified width is shown at the side
2942 of the window which indicates open and closed folds. The maximum
2943 value is 12.
2944 See |folding|.
2945
2946 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2947'foldenable' 'fen' boolean (default on)
2948 local to window
2949 {not in Vi}
2950 {not available when compiled without the |+folding|
2951 feature}
2952 When off, all folds are open. This option can be used to quickly
2953 switch between showing all text unfolded and viewing the text with
2954 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002955 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 'foldenable' is off.
2957 This option is set by commands that create a new fold or close a fold.
2958 See |folding|.
2959
2960 *'foldexpr'* *'fde'*
2961'foldexpr' 'fde' string (default: "0")
2962 local to window
2963 {not in Vi}
2964 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02002965 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002967 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002968
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002969 The expression may be evaluated in the |sandbox|, see
2970 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002971 This option can't be set from a |modeline| when the 'diff' option is
2972 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002973
2974 It is not allowed to change text or jump to another window while
2975 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976
2977 *'foldignore'* *'fdi'*
2978'foldignore' 'fdi' string (default: "#")
2979 local to window
2980 {not in Vi}
2981 {not available when compiled without the |+folding|
2982 feature}
2983 Used only when 'foldmethod' is "indent". Lines starting with
2984 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002985 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 The default "#" works well for C programs. See |fold-indent|.
2987
2988 *'foldlevel'* *'fdl'*
2989'foldlevel' 'fdl' number (default: 0)
2990 local to window
2991 {not in Vi}
2992 {not available when compiled without the |+folding|
2993 feature}
2994 Sets the fold level: Folds with a higher level will be closed.
2995 Setting this option to zero will close all folds. Higher numbers will
2996 close fewer folds.
2997 This option is set by commands like |zm|, |zM| and |zR|.
2998 See |fold-foldlevel|.
2999
3000 *'foldlevelstart'* *'fdls'*
3001'foldlevelstart' 'fdls' number (default: -1)
3002 global
3003 {not in Vi}
3004 {not available when compiled without the |+folding|
3005 feature}
3006 Sets 'foldlevel' when starting to edit another buffer in a window.
3007 Useful to always start editing with all folds closed (value zero),
3008 some folds closed (one) or no folds closed (99).
3009 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003010 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 ignores this option and closes all folds.
3012 It is also done before BufReadPre autocommands, to allow an autocmd to
3013 overrule the 'foldlevel' value for specific files.
3014 When the value is negative, it is not used.
3015
3016 *'foldmarker'* *'fmr'* *E536*
3017'foldmarker' 'fmr' string (default: "{{{,}}}")
3018 local to window
3019 {not in Vi}
3020 {not available when compiled without the |+folding|
3021 feature}
3022 The start and end marker used when 'foldmethod' is "marker". There
3023 must be one comma, which separates the start and end marker. The
3024 marker is a literal string (a regular expression would be too slow).
3025 See |fold-marker|.
3026
3027 *'foldmethod'* *'fdm'*
3028'foldmethod' 'fdm' string (default: "manual")
3029 local to window
3030 {not in Vi}
3031 {not available when compiled without the |+folding|
3032 feature}
3033 The kind of folding used for the current window. Possible values:
3034 |fold-manual| manual Folds are created manually.
3035 |fold-indent| indent Lines with equal indent form a fold.
3036 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3037 |fold-marker| marker Markers are used to specify folds.
3038 |fold-syntax| syntax Syntax highlighting items specify folds.
3039 |fold-diff| diff Fold text that is not changed.
3040
3041 *'foldminlines'* *'fml'*
3042'foldminlines' 'fml' number (default: 1)
3043 local to window
3044 {not in Vi}
3045 {not available when compiled without the |+folding|
3046 feature}
3047 Sets the minimum number of screen lines for a fold to be displayed
3048 closed. Also for manually closed folds.
3049 Note that this only has an effect of what is displayed. After using
3050 "zc" to close a fold, which is displayed open because it's smaller
3051 than 'foldminlines', a following "zc" may close a containing fold.
3052
3053 *'foldnestmax'* *'fdn'*
3054'foldnestmax' 'fdn' number (default: 20)
3055 local to window
3056 {not in Vi}
3057 {not available when compiled without the |+folding|
3058 feature}
3059 Sets the maximum nesting of folds for the "indent" and "syntax"
3060 methods. This avoids that too many folds will be created. Using more
3061 than 20 doesn't work, because the internal limit is 20.
3062
3063 *'foldopen'* *'fdo'*
3064'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3065 search,tag,undo")
3066 global
3067 {not in Vi}
3068 {not available when compiled without the |+folding|
3069 feature}
3070 Specifies for which type of commands folds will be opened, if the
3071 command moves the cursor into a closed fold. It is a comma separated
3072 list of items.
3073 item commands ~
3074 all any
3075 block "(", "{", "[[", "[{", etc.
3076 hor horizontal movements: "l", "w", "fx", etc.
3077 insert any command in Insert mode
3078 jump far jumps: "G", "gg", etc.
3079 mark jumping to a mark: "'m", CTRL-O, etc.
3080 percent "%"
3081 quickfix ":cn", ":crew", ":make", etc.
3082 search search for a pattern: "/", "n", "*", "gd", etc.
3083 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003084 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 tag jumping to a tag: ":ta", CTRL-T, etc.
3086 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003087 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 the |zv| command to the mapping to get the same effect.
3089 When a movement command is used for an operator (e.g., "dl" or "y%")
3090 this option is not used. This means the operator will include the
3091 whole closed fold.
3092 Note that vertical movements are not here, because it would make it
3093 very difficult to move onto a closed fold.
3094 In insert mode the folds containing the cursor will always be open
3095 when text is inserted.
3096 To close folds you can re-apply 'foldlevel' with the |zx| command or
3097 set the 'foldclose' option to "all".
3098
3099 *'foldtext'* *'fdt'*
3100'foldtext' 'fdt' string (default: "foldtext()")
3101 local to window
3102 {not in Vi}
3103 {not available when compiled without the |+folding|
3104 feature}
3105 An expression which is used to specify the text displayed for a closed
3106 fold. See |fold-foldtext|.
3107
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003108 The expression may be evaluated in the |sandbox|, see
3109 |sandbox-option|.
3110
3111 It is not allowed to change text or jump to another window while
3112 evaluating 'foldtext' |textlock|.
3113
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 *'formatoptions'* *'fo'*
3115'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3116 local to buffer
3117 {not in Vi}
3118 This is a sequence of letters which describes how automatic
3119 formatting is to be done. See |fo-table|. When the 'paste' option is
3120 on, no formatting is done (like 'formatoptions' is empty). Commas can
3121 be inserted for readability.
3122 To avoid problems with flags that are added in the future, use the
3123 "+=" and "-=" feature of ":set" |add-option-flags|.
3124 NOTE: This option is set to the Vi default value when 'compatible' is
3125 set and to the Vim default value when 'compatible' is reset.
3126
Bram Moolenaar86b68352004-12-27 21:59:20 +00003127 *'formatlistpat'* *'flp'*
3128'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3129 local to buffer
3130 {not in Vi}
3131 A pattern that is used to recognize a list header. This is used for
3132 the "n" flag in 'formatoptions'.
3133 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003134 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003135 while still checking more characters. There must be a character
3136 following the pattern, when it matches the whole line it is handled
3137 like there is no match.
3138 The default recognizes a number, followed by an optional punctuation
3139 character and white space.
3140
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 *'formatprg'* *'fp'*
3142'formatprg' 'fp' string (default "")
3143 global
3144 {not in Vi}
3145 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003146 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003148 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003149 If the 'formatexpr' option is not empty it will be used instead.
3150 Otherwise, if 'formatprg' option is an empty string, the internal
3151 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003152 Environment variables are expanded |:set_env|. See |option-backslash|
3153 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003154 The expression may be evaluated in the |sandbox|, see
3155 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003157 *'formatexpr'* *'fex'*
3158'formatexpr' 'fex' string (default "")
3159 local to buffer
3160 {not in Vi}
3161 {not available when compiled without the |+eval|
3162 feature}
3163 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003164 operator or automatic formatting (see 'formatoptions'). When this
3165 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003166
3167 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003168 The |v:count| variable holds the number of lines to be formatted.
3169 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003170 inserted if the expression is being evaluated due to
3171 automatic formatting. This can be empty. Don't insert
3172 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003173
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003174 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003175 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003176< This will invoke the mylang#Format() function in the
3177 autoload/mylang.vim file in 'runtimepath'. |autoload|
3178
3179 The expression is also evaluated when 'textwidth' is set and adding
3180 text beyond that limit. This happens under the same conditions as
3181 when internal formatting is used. Make sure the cursor is kept in the
3182 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003183 return "i" or "R" in this situation.
3184
3185 When the expression evaluates to non-zero Vim will fall back to using
3186 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003187
3188 The expression may be evaluated in the |sandbox|, see
3189 |sandbox-option|.
3190
3191 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003192'fsync' 'fs' boolean (default on)
3193 global
3194 {not in Vi}
3195 When on, the library function fsync() will be called after writing a
3196 file. This will flush a file to disk, ensuring that it is safely
3197 written even on filesystems which do metadata-only journaling. This
3198 will force the harddrive to spin up on Linux systems running in laptop
3199 mode, so it may be undesirable in some situations. Be warned that
3200 turning this off increases the chances of data loss after a crash. On
3201 systems without an fsync() implementation, this variable is always
3202 off.
3203 Also see 'swapsync' for controlling fsync() on swap files.
3204
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3206'gdefault' 'gd' boolean (default off)
3207 global
3208 {not in Vi}
3209 When on, the ":substitute" flag 'g' is default on. This means that
3210 all matches in a line are substituted instead of one. When a 'g' flag
3211 is given to a ":substitute" command, this will toggle the substitution
3212 of all or one match. See |complex-change|.
3213
3214 command 'gdefault' on 'gdefault' off ~
3215 :s/// subst. all subst. one
3216 :s///g subst. one subst. all
3217 :s///gg subst. all subst. one
3218
3219 NOTE: This option is reset when 'compatible' is set.
3220
3221 *'grepformat'* *'gfm'*
3222'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3223 global
3224 {not in Vi}
3225 Format to recognize for the ":grep" command output.
3226 This is a scanf-like string that uses the same format as the
3227 'errorformat' option: see |errorformat|.
3228
3229 *'grepprg'* *'gp'*
3230'grepprg' 'gp' string (default "grep -n ",
3231 Unix: "grep -n $* /dev/null",
3232 Win32: "findstr /n" or "grep -n",
3233 VMS: "SEARCH/NUMBERS ")
3234 global or local to buffer |global-local|
3235 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003236 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 and '#' characters, which are expanded like when used in a command-
3238 line. The placeholder "$*" is allowed to specify where the arguments
3239 will be included. Environment variables are expanded |:set_env|. See
3240 |option-backslash| about including spaces and backslashes.
3241 When your "grep" accepts the "-H" argument, use this to make ":grep"
3242 also work well with a single file: >
3243 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003244< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003245 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3246 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003247 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 apply equally to 'grepprg'.
3249 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3250 otherwise it's "grep -n".
3251 This option cannot be set from a |modeline| or in the |sandbox|, for
3252 security reasons.
3253
3254 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3255'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3256 ve:ver35-Cursor,
3257 o:hor50-Cursor,
3258 i-ci:ver25-Cursor/lCursor,
3259 r-cr:hor20-Cursor/lCursor,
3260 sm:block-Cursor
3261 -blinkwait175-blinkoff150-blinkon175",
3262 for MS-DOS and Win32 console:
3263 "n-v-c:block,o:hor50,i-ci:hor15,
3264 r-cr:hor30,sm:block")
3265 global
3266 {not in Vi}
3267 {only available when compiled with GUI enabled, and
3268 for MS-DOS and Win32 console}
3269 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003270 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 the height of the cursor can be changed. This can be done by
3272 specifying a block cursor, or a percentage for a vertical or
3273 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003274 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003276 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277 mode-list and an argument-list:
3278 mode-list:argument-list,mode-list:argument-list,..
3279 The mode-list is a dash separated list of these modes:
3280 n Normal mode
3281 v Visual mode
3282 ve Visual mode with 'selection' "exclusive" (same as 'v',
3283 if not specified)
3284 o Operator-pending mode
3285 i Insert mode
3286 r Replace mode
3287 c Command-line Normal (append) mode
3288 ci Command-line Insert mode
3289 cr Command-line Replace mode
3290 sm showmatch in Insert mode
3291 a all modes
3292 The argument-list is a dash separated list of these arguments:
3293 hor{N} horizontal bar, {N} percent of the character height
3294 ver{N} vertical bar, {N} percent of the character width
3295 block block cursor, fills the whole character
3296 [only one of the above three should be present]
3297 blinkwait{N} *cursor-blinking*
3298 blinkon{N}
3299 blinkoff{N}
3300 blink times for cursor: blinkwait is the delay before
3301 the cursor starts blinking, blinkon is the time that
3302 the cursor is shown and blinkoff is the time that the
3303 cursor is not shown. The times are in msec. When one
3304 of the numbers is zero, there is no blinking. The
3305 default is: "blinkwait700-blinkon400-blinkoff250".
3306 These numbers are used for a missing entry. This
3307 means that blinking is enabled by default. To switch
3308 blinking off you can use "blinkon0". The cursor only
3309 blinks when Vim is waiting for input, not while
3310 executing a command.
3311 To make the cursor blink in an xterm, see
3312 |xterm-blink|.
3313 {group-name}
3314 a highlight group name, that sets the color and font
3315 for the cursor
3316 {group-name}/{group-name}
3317 Two highlight group names, the first is used when
3318 no language mappings are used, the other when they
3319 are. |language-mapping|
3320
3321 Examples of parts:
3322 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3323 block cursor with colors from the "nCursor"
3324 highlight group
3325 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3326 In Insert and Command-line Insert mode, use a
3327 30% vertical bar cursor with colors from the
3328 "iCursor" highlight group. Blink a bit
3329 faster.
3330
3331 The 'a' mode is different. It will set the given argument-list for
3332 all modes. It does not reset anything to defaults. This can be used
3333 to do a common setting for all modes. For example, to switch off
3334 blinking: "a:blinkon0"
3335
3336 Examples of cursor highlighting: >
3337 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3338 :highlight Cursor gui=NONE guifg=bg guibg=fg
3339<
3340 *'guifont'* *'gfn'*
3341 *E235* *E596* *E610* *E611*
3342'guifont' 'gfn' string (default "")
3343 global
3344 {not in Vi}
3345 {only available when compiled with GUI enabled}
3346 This is a list of fonts which will be used for the GUI version of Vim.
3347 In its simplest form the value is just one font name. When
3348 the font cannot be found you will get an error message. To try other
3349 font names a list can be specified, font names separated with commas.
3350 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003351
Bram Moolenaar05159a02005-02-26 23:04:13 +00003352 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3353 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003354
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 Spaces after a comma are ignored. To include a comma in a font name
3356 precede it with a backslash. Setting an option requires an extra
3357 backslash before a space and a backslash. See also
3358 |option-backslash|. For example: >
3359 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003360< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003362
3363 If none of the fonts can be loaded, Vim will keep the current setting.
3364 If an empty font list is given, Vim will try using other resource
3365 settings (for X, it will use the Vim.font resource), and finally it
3366 will try some builtin default which should always be there ("7x13" in
3367 the case of X). The font names given should be "normal" fonts. Vim
3368 will try to find the related bold and italic fonts.
3369
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003370 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003371 :set guifont=*
3372< will bring up a font requester, where you can pick the font you want.
3373
3374 The font name depends on the GUI used. See |setting-guifont| for a
3375 way to set 'guifont' for various systems.
3376
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 For the GTK+ 2 GUI the font name looks like this: >
3378 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003379< That's all. XLFDs are not used. For Chinese this is reported to work
3380 well: >
3381 if has("gui_gtk2")
3382 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3383 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3384 endif
3385<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003386 For Mac OSX you can use something like this: >
3387 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003388< Also see 'macatsui', it can help fix display problems.
3389 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003391 width). An exception is GTK 2: all fonts are accepted, but
3392 mono-spaced fonts look best.
3393
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 To preview a font on X11, you might be able to use the "xfontsel"
3395 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003396
Bram Moolenaar071d4272004-06-13 20:20:40 +00003397 For the Win32 GUI *E244* *E245*
3398 - takes these options in the font name:
3399 hXX - height is XX (points, can be floating-point)
3400 wXX - width is XX (points, can be floating-point)
3401 b - bold
3402 i - italic
3403 u - underline
3404 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003405 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3407 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3408 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003409 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410
3411 Use a ':' to separate the options.
3412 - A '_' can be used in the place of a space, so you don't need to use
3413 backslashes to escape the spaces.
3414 - Examples: >
3415 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3416 :set guifont=Andale_Mono:h7.5:w4.5
3417< See also |font-sizes|.
3418
3419 *'guifontset'* *'gfs'*
3420 *E250* *E252* *E234* *E597* *E598*
3421'guifontset' 'gfs' string (default "")
3422 global
3423 {not in Vi}
3424 {only available when compiled with GUI enabled and
3425 with the |+xfontset| feature}
3426 {not available in the GTK+ 2 GUI}
3427 When not empty, specifies two (or more) fonts to be used. The first
3428 one for normal English, the second one for your special language. See
3429 |xfontset|.
3430 Setting this option also means that all font names will be handled as
3431 a fontset name. Also the ones used for the "font" argument of the
3432 |:highlight| command.
3433 The fonts must match with the current locale. If fonts for the
3434 character sets that the current locale uses are not included, setting
3435 'guifontset' will fail.
3436 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3437 the comma-separated names are alternative names, one of which will be
3438 used. In 'guifontset' the whole string is one fontset name,
3439 including the commas. It is not possible to specify alternative
3440 fontset names.
3441 This example works on many X11 systems: >
3442 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3443<
3444 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3445'guifontwide' 'gfw' string (default "")
3446 global
3447 {not in Vi}
3448 {only available when compiled with GUI enabled}
3449 When not empty, specifies a comma-separated list of fonts to be used
3450 for double-width characters. The first font that can be loaded is
3451 used.
3452 Note: The size of these fonts must be exactly twice as wide as the one
3453 specified with 'guifont' and the same height.
3454
3455 All GUI versions but GTK+ 2:
3456
3457 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3458 'guifontset' is empty or invalid.
3459 When 'guifont' is set and a valid font is found in it and
3460 'guifontwide' is empty Vim will attempt to find a matching
3461 double-width font and set 'guifontwide' to it.
3462
3463 GTK+ 2 GUI only: *guifontwide_gtk2*
3464
3465 If set and valid, 'guifontwide' is always used for double width
3466 characters, even if 'encoding' is not set to "utf-8".
3467 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003468 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 font for characters not available in 'guifont'. Thus you do not need
3470 to set 'guifontwide' at all unless you want to override the choice
3471 made by Pango/Xft.
3472
3473 *'guiheadroom'* *'ghr'*
3474'guiheadroom' 'ghr' number (default 50)
3475 global
3476 {not in Vi} {only for GTK and X11 GUI}
3477 The number of pixels subtracted from the screen height when fitting
3478 the GUI window on the screen. Set this before the GUI is started,
3479 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003480 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 lines will be left for window decorations and other items on the
3482 screen. Set it to a negative value to allow windows taller than the
3483 screen.
3484
3485 *'guioptions'* *'go'*
3486'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003487 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 global
3489 {not in Vi}
3490 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003491 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 sequence of letters which describes what components and options of the
3493 GUI should be used.
3494 To avoid problems with flags that are added in the future, use the
3495 "+=" and "-=" feature of ":set" |add-option-flags|.
3496
3497 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003498 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 'a' Autoselect: If present, then whenever VISUAL mode is started,
3500 or the Visual area extended, Vim tries to become the owner of
3501 the windowing system's global selection. This means that the
3502 Visually highlighted text is available for pasting into other
3503 applications as well as into Vim itself. When the Visual mode
3504 ends, possibly due to an operation on the text, or when an
3505 application wants to paste the selection, the highlighted text
3506 is automatically yanked into the "* selection register.
3507 Thus the selection is still available for pasting into other
3508 applications after the VISUAL mode has ended.
3509 If not present, then Vim won't become the owner of the
3510 windowing system's global selection unless explicitly told to
3511 by a yank or delete operation for the "* register.
3512 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003513 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003514 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 applies to the modeless selection.
3516
3517 'guioptions' autoselect Visual autoselect modeless ~
3518 "" - -
3519 "a" yes yes
3520 "A" - yes
3521 "aA" yes yes
3522
Bram Moolenaar02467872007-05-06 13:22:01 +00003523 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524 'c' Use console dialogs instead of popup dialogs for simple
3525 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003526 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003527 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003528 'guitablabel' can be used to change the text in the labels.
3529 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003530 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003531 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003532 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533 'f' Foreground: Don't use fork() to detach the GUI from the shell
3534 where it was started. Use this for programs that wait for the
3535 editor to finish (e.g., an e-mail program). Alternatively you
3536 can use "gvim -f" or ":gui -f" to start the GUI in the
3537 foreground. |gui-fork|
3538 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003539 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003540 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3542 corner of the window. It's black&white on non-GTK, because of
3543 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003544 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003546 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003547 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003549 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 file is sourced the system menu has already been loaded; the
3551 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003552 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 'g' Grey menu items: Make menu items that are not active grey. If
3554 'g' is not included inactive menu items are not shown at all.
3555 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003556 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 't' Include tearoff menu items. Currently only works for Win32,
3558 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003559 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003560 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003561 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003562 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003564 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003565 'R' Right-hand scrollbar is present when there is a vertically
3566 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003567 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003569 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 'L' Left-hand scrollbar is present when there is a vertically
3571 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003572 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3574 the longest visible line, or on the cursor line if the 'h'
3575 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003576 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 'h' Limit horizontal scrollbar size to the length of the cursor
3578 line. Reduces computations. |gui-horiz-scroll|
3579
3580 And yes, you may even have scrollbars on the left AND the right if
3581 you really want to :-). See |gui-scrollbars| for more information.
3582
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003583 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 'v' Use a vertical button layout for dialogs. When not included,
3585 a horizontal layout is preferred, but when it doesn't fit a
3586 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003587 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003588 'p' Use Pointer callbacks for X11 GUI. This is required for some
3589 window managers. If the cursor is not blinking or hollow at
3590 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003591 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003593 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003594 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595
Bram Moolenaar02467872007-05-06 13:22:01 +00003596
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597 *'guipty'* *'noguipty'*
3598'guipty' boolean (default on)
3599 global
3600 {not in Vi}
3601 {only available when compiled with GUI enabled}
3602 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3603 I/O to/from shell commands. See |gui-pty|.
3604
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003605 *'guitablabel'* *'gtl'*
3606'guitablabel' 'gtl' string (default empty)
3607 global
3608 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003609 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003610 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003611 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003612 pages line. When empty and when the result is empty Vim will use a
3613 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003614
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003615 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003616 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003617
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003618 Only used when the GUI tab pages line is displayed. 'e' must be
3619 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3620 used.
3621
Bram Moolenaar57657d82006-04-21 22:12:41 +00003622 *'guitabtooltip'* *'gtt'*
3623'guitabtooltip' 'gtt' string (default empty)
3624 global
3625 {not in Vi}
3626 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003627 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003628 When nonempty describes the text to use in a tooltip for the GUI tab
3629 pages line. When empty Vim will use a default tooltip.
3630 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003631 You can include a line break. Simplest method is to use |:let|: >
3632 :let &guitabtooltip = "line one\nline two"
3633<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003634
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 *'helpfile'* *'hf'*
3636'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3637 (others) "$VIMRUNTIME/doc/help.txt")
3638 global
3639 {not in Vi}
3640 Name of the main help file. All distributed help files should be
3641 placed together in one directory. Additionally, all "doc" directories
3642 in 'runtimepath' will be used.
3643 Environment variables are expanded |:set_env|. For example:
3644 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003645 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646 spaces and backslashes.
3647 This option cannot be set from a |modeline| or in the |sandbox|, for
3648 security reasons.
3649
3650 *'helpheight'* *'hh'*
3651'helpheight' 'hh' number (default 20)
3652 global
3653 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003654 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003655 feature}
3656 Minimal initial height of the help window when it is opened with the
3657 ":help" command. The initial height of the help window is half of the
3658 current window, or (when the 'ea' option is on) the same as other
3659 windows. When the height is less than 'helpheight', the height is
3660 set to 'helpheight'. Set to zero to disable.
3661
3662 *'helplang'* *'hlg'*
3663'helplang' 'hlg' string (default: messages language or empty)
3664 global
3665 {only available when compiled with the |+multi_lang|
3666 feature}
3667 {not in Vi}
3668 Comma separated list of languages. Vim will use the first language
3669 for which the desired help can be found. The English help will always
3670 be used as a last resort. You can add "en" to prefer English over
3671 another language, but that will only find tags that exist in that
3672 language and not in the English help.
3673 Example: >
3674 :set helplang=de,it
3675< This will first search German, then Italian and finally English help
3676 files.
3677 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3678 try to find the tag in the current language before using this option.
3679 See |help-translated|.
3680
3681 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3682'hidden' 'hid' boolean (default off)
3683 global
3684 {not in Vi}
3685 When off a buffer is unloaded when it is |abandon|ed. When on a
3686 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3687 displayed in another window, it does not become hidden, of course.
3688 The commands that move through the buffer list sometimes make a buffer
3689 hidden although the 'hidden' option is off: When the buffer is
3690 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003691 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003692 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 This option is set for one command with ":hide {command}" |:hide|.
3694 WARNING: It's easy to forget that you have changes in hidden buffers.
3695 Think twice when using ":q!" or ":qa!".
3696
3697 *'highlight'* *'hl'*
3698'highlight' 'hl' string (default (as a single string):
3699 "8:SpecialKey,@:NonText,d:Directory,
3700 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3701 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003702 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3704 f:Folded,F:FoldColumn,A:DiffAdd,
3705 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003706 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003707 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003708 +:Pmenu,=:PmenuSel,
3709 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 global
3711 {not in Vi}
3712 This option can be used to set highlighting mode for various
3713 occasions. It is a comma separated list of character pairs. The
3714 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003715 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3717 |hl-NonText| @ '~' and '@' at the end of the window and
3718 characters from 'showbreak'
3719 |hl-Directory| d directories in CTRL-D listing and other special
3720 things in listings
3721 |hl-ErrorMsg| e error messages
3722 h (obsolete, ignored)
3723 |hl-IncSearch| i 'incsearch' highlighting
3724 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3725 |hl-MoreMsg| m |more-prompt|
3726 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003727 |hl-LineNr| n line number for ":number" and ":#" commands, and
3728 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 |hl-Question| r |hit-enter| prompt and yes/no questions
3730 |hl-StatusLine| s status line of current window |status-line|
3731 |hl-StatusLineNC| S status lines of not-current windows
3732 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3733 |hl-VertSplit| c column used to separate vertically split windows
3734 |hl-Visual| v Visual mode
3735 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3736 Selection" Only X11 Gui's |gui-x11| and
3737 |xterm-clipboard|.
3738 |hl-WarningMsg| w warning messages
3739 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3740 |hl-Folded| f line used for closed folds
3741 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003742 |hl-DiffAdd| A added line in diff mode
3743 |hl-DiffChange| C changed line in diff mode
3744 |hl-DiffDelete| D deleted line in diff mode
3745 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003747 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003748 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003749 |hl-SpellRare| R rare word |spell|
3750 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003751 |hl-Conceal| - the placeholders used for concealed characters
3752 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003753 |hl-Pmenu| + popup menu normal line
3754 |hl-PmenuSel| = popup menu normal line
3755 |hl-PmenuSbar| x popup menu scrollbar
3756 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757
3758 The display modes are:
3759 r reverse (termcap entry "mr" and "me")
3760 i italic (termcap entry "ZH" and "ZR")
3761 b bold (termcap entry "md" and "me")
3762 s standout (termcap entry "so" and "se")
3763 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003764 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 n no highlighting
3766 - no highlighting
3767 : use a highlight group
3768 The default is used for occasions that are not included.
3769 If you want to change what the display modes do, see |dos-colors|
3770 for an example.
3771 When using the ':' display mode, this must be followed by the name of
3772 a highlight group. A highlight group can be used to define any type
3773 of highlighting, including using color. See |:highlight| on how to
3774 define one. The default uses a different group for each occasion.
3775 See |highlight-default| for the default highlight groups.
3776
3777 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3778'hlsearch' 'hls' boolean (default off)
3779 global
3780 {not in Vi}
3781 {not available when compiled without the
3782 |+extra_search| feature}
3783 When there is a previous search pattern, highlight all its matches.
3784 The type of highlighting used can be set with the 'l' occasion in the
3785 'highlight' option. This uses the "Search" highlight group by
3786 default. Note that only the matching text is highlighted, any offsets
3787 are not applied.
3788 See also: 'incsearch' and |:match|.
3789 When you get bored looking at the highlighted matches, you can turn it
3790 off with |:nohlsearch|. As soon as you use a search command, the
3791 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003792 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003793 When the search pattern can match an end-of-line, Vim will try to
3794 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003795 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003797 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 NOTE: This option is reset when 'compatible' is set.
3799
3800 *'history'* *'hi'*
3801'history' 'hi' number (Vim default: 20, Vi default: 0)
3802 global
3803 {not in Vi}
3804 A history of ":" commands, and a history of previous search patterns
3805 are remembered. This option decides how many entries may be stored in
3806 each of these histories (see |cmdline-editing|).
3807 NOTE: This option is set to the Vi default value when 'compatible' is
3808 set and to the Vim default value when 'compatible' is reset.
3809
3810 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3811'hkmap' 'hk' boolean (default off)
3812 global
3813 {not in Vi}
3814 {only available when compiled with the |+rightleft|
3815 feature}
3816 When on, the keyboard is mapped for the Hebrew character set.
3817 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3818 toggle this option. See |rileft.txt|.
3819 NOTE: This option is reset when 'compatible' is set.
3820
3821 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3822'hkmapp' 'hkp' boolean (default off)
3823 global
3824 {not in Vi}
3825 {only available when compiled with the |+rightleft|
3826 feature}
3827 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3828 This is useful if you have a non-Hebrew keyboard.
3829 See |rileft.txt|.
3830 NOTE: This option is reset when 'compatible' is set.
3831
3832 *'icon'* *'noicon'*
3833'icon' boolean (default off, on when title can be restored)
3834 global
3835 {not in Vi}
3836 {not available when compiled without the |+title|
3837 feature}
3838 When on, the icon text of the window will be set to the value of
3839 'iconstring' (if it is not empty), or to the name of the file
3840 currently being edited. Only the last part of the name is used.
3841 Overridden by the 'iconstring' option.
3842 Only works if the terminal supports setting window icons (currently
3843 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3844 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3845 builtin termcap).
3846 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003847 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003848 X11.
3849
3850 *'iconstring'*
3851'iconstring' string (default "")
3852 global
3853 {not in Vi}
3854 {not available when compiled without the |+title|
3855 feature}
3856 When this option is not empty, it will be used for the icon text of
3857 the window. This happens only when the 'icon' option is on.
3858 Only works if the terminal supports setting window icon text
3859 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3860 Does not work for MS Windows.
3861 When Vim was compiled with HAVE_X11 defined, the original icon will be
3862 restored if possible |X11|.
3863 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003864 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 'titlestring' for example settings.
3866 {not available when compiled without the |+statusline| feature}
3867
3868 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3869'ignorecase' 'ic' boolean (default off)
3870 global
3871 Ignore case in search patterns. Also used when searching in the tags
3872 file.
3873 Also see 'smartcase'.
3874 Can be overruled by using "\c" or "\C" in the pattern, see
3875 |/ignorecase|.
3876
3877 *'imactivatekey'* *'imak'*
3878'imactivatekey' 'imak' string (default "")
3879 global
3880 {not in Vi}
3881 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003882 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 Specifies the key that your Input Method in X-Windows uses for
3884 activation. When this is specified correctly, vim can fully control
3885 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3886 You can't use this option to change the activation key, the option
3887 tells Vim what the key is.
3888 Format:
3889 [MODIFIER_FLAG-]KEY_STRING
3890
3891 These characters can be used for MODIFIER_FLAG (case is ignored):
3892 S Shift key
3893 L Lock key
3894 C Control key
3895 1 Mod1 key
3896 2 Mod2 key
3897 3 Mod3 key
3898 4 Mod4 key
3899 5 Mod5 key
3900 Combinations are allowed, for example "S-C-space" or "SC-space" are
3901 both shift+ctrl+space.
3902 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3903
3904 Example: >
3905 :set imactivatekey=S-space
3906< "S-space" means shift+space. This is the activation key for kinput2 +
3907 canna (Japanese), and ami (Korean).
3908
3909 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3910'imcmdline' 'imc' boolean (default off)
3911 global
3912 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003913 {only available when compiled with the |+xim|,
3914 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 When set the Input Method is always on when starting to edit a command
3916 line, unless entering a search pattern (see 'imsearch' for that).
3917 Setting this option is useful when your input method allows entering
3918 English characters directly, e.g., when it's used to type accented
3919 characters with dead keys.
3920
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003921 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3923 global
3924 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003925 {only available when compiled with the |+xim|,
3926 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 When set the Input Method is never used. This is useful to disable
3928 the IM when it doesn't work properly.
3929 Currently this option is on by default for SGI/IRIX machines. This
3930 may change in later releases.
3931
3932 *'iminsert'* *'imi'*
3933'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3934 local to buffer
3935 {not in Vi}
3936 Specifies whether :lmap or an Input Method (IM) is to be used in
3937 Insert mode. Valid values:
3938 0 :lmap is off and IM is off
3939 1 :lmap is ON and IM is off
3940 2 :lmap is off and IM is ON
3941 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3942 or |global-ime|.
3943 To always reset the option to zero when leaving Insert mode with <Esc>
3944 this can be used: >
3945 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3946< This makes :lmap and IM turn off automatically when leaving Insert
3947 mode.
3948 Note that this option changes when using CTRL-^ in Insert mode
3949 |i_CTRL-^|.
3950 The value is set to 1 when setting 'keymap' to a valid keymap name.
3951 It is also used for the argument of commands like "r" and "f".
3952 The value 0 may not work correctly with Athena and Motif with some XIM
3953 methods. Use 'imdisable' to disable XIM then.
3954
3955 *'imsearch'* *'ims'*
3956'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3957 local to buffer
3958 {not in Vi}
3959 Specifies whether :lmap or an Input Method (IM) is to be used when
3960 entering a search pattern. Valid values:
3961 -1 the value of 'iminsert' is used, makes it look like
3962 'iminsert' is also used when typing a search pattern
3963 0 :lmap is off and IM is off
3964 1 :lmap is ON and IM is off
3965 2 :lmap is off and IM is ON
3966 Note that this option changes when using CTRL-^ in Command-line mode
3967 |c_CTRL-^|.
3968 The value is set to 1 when it is not -1 and setting the 'keymap'
3969 option to a valid keymap name.
3970 The value 0 may not work correctly with Athena and Motif with some XIM
3971 methods. Use 'imdisable' to disable XIM then.
3972
3973 *'include'* *'inc'*
3974'include' 'inc' string (default "^\s*#\s*include")
3975 global or local to buffer |global-local|
3976 {not in Vi}
3977 {not available when compiled without the
3978 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003979 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 pattern, just like for the "/" command (See |pattern|). The default
3981 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003982 "]I", "[d", etc.
3983 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003984 comes after the matched pattern. But if "\zs" appears in the pattern
3985 then the text matched from "\zs" to the end, or until "\ze" if it
3986 appears, is used as the file name. Use this to include characters
3987 that are not in 'isfname', such as a space. You can then use
3988 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003989 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990
3991 *'includeexpr'* *'inex'*
3992'includeexpr' 'inex' string (default "")
3993 local to buffer
3994 {not in Vi}
3995 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02003996 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003998 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 :set includeexpr=substitute(v:fname,'\\.','/','g')
4000< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004001
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004003 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 Also used for |<cfile>|.
4005
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004006 The expression may be evaluated in the |sandbox|, see
4007 |sandbox-option|.
4008
4009 It is not allowed to change text or jump to another window while
4010 evaluating 'includeexpr' |textlock|.
4011
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4013'incsearch' 'is' boolean (default off)
4014 global
4015 {not in Vi}
4016 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004017 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004018 While typing a search command, show where the pattern, as it was typed
4019 so far, matches. The matched string is highlighted. If the pattern
4020 is invalid or not found, nothing is shown. The screen will be updated
4021 often, this is only useful on fast terminals.
4022 Note that the match will be shown, but the cursor will return to its
4023 original position when no match is found and when pressing <Esc>. You
4024 still need to finish the search command with <Enter> to move the
4025 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004026 When compiled with the |+reltime| feature Vim only searches for about
4027 half a second. With a complicated pattern and/or a lot of text the
4028 match may not be found. This is to avoid that Vim hangs while you
4029 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004030 The highlighting can be set with the 'i' flag in 'highlight'.
4031 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004032 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004033 to the command line. If 'ignorecase' and 'smartcase' are set and the
4034 command line has no uppercase characters, the added character is
4035 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004036 CTRL-R CTRL-W can be used to add the word at the end of the current
4037 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 NOTE: This option is reset when 'compatible' is set.
4039
4040 *'indentexpr'* *'inde'*
4041'indentexpr' 'inde' string (default "")
4042 local to buffer
4043 {not in Vi}
4044 {not available when compiled without the |+cindent|
4045 or |+eval| features}
4046 Expression which is evaluated to obtain the proper indent for a line.
4047 It is used when a new line is created, for the |=| operator and
4048 in Insert mode as specified with the 'indentkeys' option.
4049 When this option is not empty, it overrules the 'cindent' and
4050 'smartindent' indenting.
4051 When 'paste' is set this option is not used for indenting.
4052 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004053 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054 when the expression is evaluated (but it may be moved around).
4055 The expression must return the number of spaces worth of indent. It
4056 can return "-1" to keep the current indent (this means 'autoindent' is
4057 used for the indent).
4058 Functions useful for computing the indent are |indent()|, |cindent()|
4059 and |lispindent()|.
4060 The evaluation of the expression must not have side effects! It must
4061 not change the text, jump to another window, etc. Afterwards the
4062 cursor position is always restored, thus the cursor may be moved.
4063 Normally this option would be set to call a function: >
4064 :set indentexpr=GetMyIndent()
4065< Error messages will be suppressed, unless the 'debug' option contains
4066 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004067 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068 NOTE: This option is made empty when 'compatible' is set.
4069
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004070 The expression may be evaluated in the |sandbox|, see
4071 |sandbox-option|.
4072
4073 It is not allowed to change text or jump to another window while
4074 evaluating 'indentexpr' |textlock|.
4075
4076
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 *'indentkeys'* *'indk'*
4078'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4079 local to buffer
4080 {not in Vi}
4081 {not available when compiled without the |+cindent|
4082 feature}
4083 A list of keys that, when typed in Insert mode, cause reindenting of
4084 the current line. Only happens if 'indentexpr' isn't empty.
4085 The format is identical to 'cinkeys', see |indentkeys-format|.
4086 See |C-indenting| and |indent-expression|.
4087
4088 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4089'infercase' 'inf' boolean (default off)
4090 local to buffer
4091 {not in Vi}
4092 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004093 'ignorecase' is also on, the case of the match is adjusted depending
4094 on the typed text. If the typed text contains a lowercase letter
4095 where the match has an upper case letter, the completed part is made
4096 lowercase. If the typed text has no lowercase letters and the match
4097 has a lowercase letter where the typed text has an uppercase letter,
4098 and there is a letter before it, the completed part is made uppercase.
4099 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100
4101 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4102'insertmode' 'im' boolean (default off)
4103 global
4104 {not in Vi}
4105 Makes Vim work in a way that Insert mode is the default mode. Useful
4106 if you want to use Vim as a modeless editor. Used for |evim|.
4107 These Insert mode commands will be useful:
4108 - Use the cursor keys to move around.
4109 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4110 this is a mapping, it is executed as if 'insertmode' was off.
4111 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004113 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4114 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004115
4116 These items change when 'insertmode' is set:
4117 - when starting to edit of a file, Vim goes to Insert mode.
4118 - <Esc> in Insert mode is a no-op and beeps.
4119 - <Esc> in Normal mode makes Vim go to Insert mode.
4120 - CTRL-L in Insert mode is a command, it is not inserted.
4121 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4122 However, when <Esc> is used inside a mapping, it behaves like
4123 'insertmode' was not set. This was done to be able to use the same
4124 mappings with 'insertmode' set or not set.
4125 When executing commands with |:normal| 'insertmode' is not used.
4126
4127 NOTE: This option is reset when 'compatible' is set.
4128
4129 *'isfname'* *'isf'*
4130'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4131 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4132 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4133 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4134 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4135 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4136 global
4137 {not in Vi}
4138 The characters specified by this option are included in file names and
4139 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004140 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141 Multi-byte characters 256 and above are always included, only the
4142 characters up to 255 are specified with this option.
4143 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004144 Think twice before adding white space to this option. Although a
4145 space may appear inside a file name, the effect will be that Vim
4146 doesn't know where a file name starts or ends when doing completion.
4147 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148
4149 Note that on systems using a backslash as path separator, Vim tries to
4150 do its best to make it work as you would expect. That is a bit
4151 tricky, since Vi originally used the backslash to escape special
4152 characters. Vim will not remove a backslash in front of a normal file
4153 name character on these systems, but it will on Unix and alikes. The
4154 '&' and '^' are not included by default, because these are special for
4155 cmd.exe.
4156
4157 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004158 Each part can be a single character number or a range. A range is two
4159 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 decimal number between 0 and 255 or the ASCII character itself (does
4161 not work for digits). Example:
4162 "_,-,128-140,#-43" (include '_' and '-' and the range
4163 128 to 140 and '#' to 43)
4164 If a part starts with '^', the following character number or range
4165 will be excluded from the option. The option is interpreted from left
4166 to right. Put the excluded character after the range where it is
4167 included. To include '^' itself use it as the last character of the
4168 option or the end of a range. Example:
4169 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4170 If the character is '@', all characters where isalpha() returns TRUE
4171 are included. Normally these are the characters a to z and A to Z,
4172 plus accented characters. To include '@' itself use "@-@". Examples:
4173 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004174 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175 "a-z,A-Z,@-@" All letters plus the '@' character.
4176 A comma can be included by using it where a character number is
4177 expected. Example:
4178 "48-57,,,_" Digits, comma and underscore.
4179 A comma can be excluded by prepending a '^'. Example:
4180 " -~,^,,9" All characters from space to '~', excluding
4181 comma, plus <Tab>.
4182 See |option-backslash| about including spaces and backslashes.
4183
4184 *'isident'* *'isi'*
4185'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4186 "@,48-57,_,128-167,224-235"
4187 otherwise: "@,48-57,_,192-255")
4188 global
4189 {not in Vi}
4190 The characters given by this option are included in identifiers.
4191 Identifiers are used in recognizing environment variables and after a
4192 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004193 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 option.
4195 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004196 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4198
4199 *'iskeyword'* *'isk'*
4200'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4201 "@,48-57,_,128-167,224-235"
4202 otherwise: "@,48-57,_,192-255"
4203 Vi default: "@,48-57,_")
4204 local to buffer
4205 {not in Vi}
4206 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004207 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 'isfname' for a description of the format of this option. For C
4209 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4210 For a help file it is set to all non-blank printable characters except
4211 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4212 command).
4213 When the 'lisp' option is on the '-' character is always included.
4214 NOTE: This option is set to the Vi default value when 'compatible' is
4215 set and to the Vim default value when 'compatible' is reset.
4216
4217 *'isprint'* *'isp'*
4218'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4219 "@,~-255"; otherwise: "@,161-255")
4220 global
4221 {not in Vi}
4222 The characters given by this option are displayed directly on the
4223 screen. It is also used for "\p" in a |pattern|. The characters from
4224 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4225 even when they are not included in 'isprint' or excluded. See
4226 'isfname' for a description of the format of this option.
4227
4228 Non-printable characters are displayed with two characters:
4229 0 - 31 "^@" - "^_"
4230 32 - 126 always single characters
4231 127 "^?"
4232 128 - 159 "~@" - "~_"
4233 160 - 254 "| " - "|~"
4234 255 "~?"
4235 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4236 displayed as <xx>, with the hexadecimal value of the byte.
4237 When 'display' contains "uhex" all unprintable characters are
4238 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004239 The SpecialKey highlighting will be used for unprintable characters.
4240 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004241
4242 Multi-byte characters 256 and above are always included, only the
4243 characters up to 255 are specified with this option. When a character
4244 is printable but it is not available in the current font, a
4245 replacement character will be shown.
4246 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4247 There is no option to specify these characters.
4248
4249 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4250'joinspaces' 'js' boolean (default on)
4251 global
4252 {not in Vi}
4253 Insert two spaces after a '.', '?' and '!' with a join command.
4254 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4255 Otherwise only one space is inserted.
4256 NOTE: This option is set when 'compatible' is set.
4257
4258 *'key'*
4259'key' string (default "")
4260 local to buffer
4261 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004262 {only available when compiled with the |+cryptv|
4263 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004265 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 Careful: Do not set the key value by hand, someone might see the typed
4267 key. Use the |:X| command. But you can make 'key' empty: >
4268 :set key=
4269< It is not possible to get the value of this option with ":set key" or
4270 "echo &key". This is to avoid showing it to someone who shouldn't
4271 know. It also means you cannot see it yourself once you have set it,
4272 be careful not to make a typing error!
4273
4274 *'keymap'* *'kmp'* *E544*
4275'keymap' 'kmp' string (default "")
4276 local to buffer
4277 {not in Vi}
4278 {only available when compiled with the |+keymap|
4279 feature}
4280 Name of a keyboard mapping. See |mbyte-keymap|.
4281 Setting this option to a valid keymap name has the side effect of
4282 setting 'iminsert' to one, so that the keymap becomes effective.
4283 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004284 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285
4286 *'keymodel'* *'km'*
4287'keymodel' 'km' string (default "")
4288 global
4289 {not in Vi}
4290 List of comma separated words, which enable special things that keys
4291 can do. These values can be used:
4292 startsel Using a shifted special key starts selection (either
4293 Select mode or Visual mode, depending on "key" being
4294 present in 'selectmode').
4295 stopsel Using a not-shifted special key stops selection.
4296 Special keys in this context are the cursor keys, <End>, <Home>,
4297 <PageUp> and <PageDown>.
4298 The 'keymodel' option is set by the |:behave| command.
4299
4300 *'keywordprg'* *'kp'*
4301'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4302 OS/2: "view /", VMS: "help")
4303 global or local to buffer |global-local|
4304 {not in Vi}
4305 Program to use for the |K| command. Environment variables are
4306 expanded |:set_env|. ":help" may be used to access the Vim internal
4307 help. (Note that previously setting the global option to the empty
4308 value did this, which is now deprecated.)
4309 When "man" is used, Vim will automatically translate a count for the
4310 "K" command to a section number. Also for "man -s", in which case the
4311 "-s" is removed when there is no count.
4312 See |option-backslash| about including spaces and backslashes.
4313 Example: >
4314 :set keywordprg=man\ -s
4315< This option cannot be set from a |modeline| or in the |sandbox|, for
4316 security reasons.
4317
4318 *'langmap'* *'lmap'* *E357* *E358*
4319'langmap' 'lmap' string (default "")
4320 global
4321 {not in Vi}
4322 {only available when compiled with the |+langmap|
4323 feature}
4324 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004325 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 inserted directly. When in command mode the 'langmap' option takes
4327 care of translating these special characters to the original meaning
4328 of the key. This means you don't have to change the keyboard mode to
4329 be able to execute Normal mode commands.
4330 This is the opposite of the 'keymap' option, where characters are
4331 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004332
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004333 Example (for Greek, in UTF-8): *greek* >
4334 :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 +00004335< Example (exchanges meaning of z and y for commands): >
4336 :set langmap=zy,yz,ZY,YZ
4337<
4338 The 'langmap' option is a list of parts, separated with commas. Each
4339 part can be in one of two forms:
4340 1. A list of pairs. Each pair is a "from" character immediately
4341 followed by the "to" character. Examples: "aA", "aAbBcC".
4342 2. A list of "from" characters, a semi-colon and a list of "to"
4343 characters. Example: "abc;ABC"
4344 Example: "aA,fgh;FGH,cCdDeE"
4345 Special characters need to be preceded with a backslash. These are
4346 ";", ',' and backslash itself.
4347
4348 This will allow you to activate vim actions without having to switch
4349 back and forth between the languages. Your language characters will
4350 be understood as normal vim English characters (according to the
4351 langmap mappings) in the following cases:
4352 o Normal/Visual mode (commands, buffer/register names, user mappings)
4353 o Insert/Replace Mode: Register names after CTRL-R
4354 o Insert/Replace Mode: Mappings
4355 Characters entered in Command-line mode will NOT be affected by
4356 this option. Note that this option can be changed at any time
4357 allowing to switch between mappings for different languages/encodings.
4358 Use a mapping to avoid having to type it each time!
4359
4360 *'langmenu'* *'lm'*
4361'langmenu' 'lm' string (default "")
4362 global
4363 {not in Vi}
4364 {only available when compiled with the |+menu| and
4365 |+multi_lang| features}
4366 Language to use for menu translation. Tells which file is loaded
4367 from the "lang" directory in 'runtimepath': >
4368 "lang/menu_" . &langmenu . ".vim"
4369< (without the spaces). For example, to always use the Dutch menus, no
4370 matter what $LANG is set to: >
4371 :set langmenu=nl_NL.ISO_8859-1
4372< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004373 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 If your $LANG is set to a non-English language but you do want to use
4375 the English menus: >
4376 :set langmenu=none
4377< This option must be set before loading menus, switching on filetype
4378 detection or syntax highlighting. Once the menus are defined setting
4379 this option has no effect. But you could do this: >
4380 :source $VIMRUNTIME/delmenu.vim
4381 :set langmenu=de_DE.ISO_8859-1
4382 :source $VIMRUNTIME/menu.vim
4383< Warning: This deletes all menus that you defined yourself!
4384
4385 *'laststatus'* *'ls'*
4386'laststatus' 'ls' number (default 1)
4387 global
4388 {not in Vi}
4389 The value of this option influences when the last window will have a
4390 status line:
4391 0: never
4392 1: only if there are at least two windows
4393 2: always
4394 The screen looks nicer with a status line if you have several
4395 windows, but it takes another screen line. |status-line|
4396
4397 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4398'lazyredraw' 'lz' boolean (default off)
4399 global
4400 {not in Vi}
4401 When this option is set, the screen will not be redrawn while
4402 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004403 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404 update use |:redraw|.
4405
4406 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4407'linebreak' 'lbr' boolean (default off)
4408 local to window
4409 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004410 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 feature}
4412 If on Vim will wrap long lines at a character in 'breakat' rather
4413 than at the last character that fits on the screen. Unlike
4414 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4415 it only affects the way the file is displayed, not its contents. The
4416 value of 'showbreak' is used to put in front of wrapped lines.
4417 This option is not used when the 'wrap' option is off or 'list' is on.
4418 Note that <Tab> characters after an <EOL> are mostly not displayed
4419 with the right amount of white space.
4420
4421 *'lines'* *E593*
4422'lines' number (default 24 or terminal height)
4423 global
4424 Number of lines of the Vim window.
4425 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004426 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 When Vim is running in the GUI or in a resizable window, setting this
4428 option will cause the window size to be changed. When you only want
4429 to use the size for the GUI, put the command in your |gvimrc| file.
4430 Vim limits the number of lines to what fits on the screen. You can
4431 use this command to get the tallest window possible: >
4432 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004433< Minimum value is 2, maximum value is 1000.
4434 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 When you set this option and Vim is unable to change the physical
4436 number of lines of the display, the display may be messed up.
4437
4438 *'linespace'* *'lsp'*
4439'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4440 global
4441 {not in Vi}
4442 {only in the GUI}
4443 Number of pixel lines inserted between characters. Useful if the font
4444 uses the full character cell height, making lines touch each other.
4445 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004446 With some fonts there can be too much room between lines (to have
4447 space for ascents and descents). Then it makes sense to set
4448 'linespace' to a negative value. This may cause display problems
4449 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450
4451 *'lisp'* *'nolisp'*
4452'lisp' boolean (default off)
4453 local to buffer
4454 {not available when compiled without the |+lispindent|
4455 feature}
4456 Lisp mode: When <Enter> is typed in insert mode set the indent for
4457 the next line to Lisp standards (well, sort of). Also happens with
4458 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4459 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4460 better. Also see 'lispwords'.
4461 The '-' character is included in keyword characters. Redefines the
4462 "=" operator to use this same indentation algorithm rather than
4463 calling an external program if 'equalprg' is empty.
4464 This option is not used when 'paste' is set.
4465 {Vi: Does it a little bit differently}
4466
4467 *'lispwords'* *'lw'*
4468'lispwords' 'lw' string (default is very long)
4469 global
4470 {not in Vi}
4471 {not available when compiled without the |+lispindent|
4472 feature}
4473 Comma separated list of words that influence the Lisp indenting.
4474 |'lisp'|
4475
4476 *'list'* *'nolist'*
4477'list' boolean (default off)
4478 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004479 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4480 line. Useful to see the difference between tabs and spaces and for
4481 trailing blanks. Further changed by the 'listchars' option.
4482
4483 The cursor is displayed at the start of the space a Tab character
4484 occupies, not at the end as usual in Normal mode. To get this cursor
4485 position while displaying Tabs with spaces, use: >
4486 :set list lcs=tab\ \
4487<
4488 Note that list mode will also affect formatting (set with 'textwidth'
4489 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 changing the way tabs are displayed.
4491
4492 *'listchars'* *'lcs'*
4493'listchars' 'lcs' string (default "eol:$")
4494 global
4495 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004496 Strings to use in 'list' mode and for the |:list| command. It is a
4497 comma separated list of string settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498 eol:c Character to show at the end of each line. When
4499 omitted, there is no extra character at the end of the
4500 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004501 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004503 fill the space that the tab normally occupies.
4504 "tab:>-" will show a tab that takes four spaces as
4505 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004506 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 trailing spaces are blank.
4508 extends:c Character to show in the last column, when 'wrap' is
4509 off and the line continues beyond the right of the
4510 screen.
4511 precedes:c Character to show in the first column, when 'wrap'
4512 is off and there is text preceding the character
4513 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004514 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004515 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004516 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004517 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004519 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004521 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522
4523 Examples: >
4524 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004525 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 :set lcs=extends:>,precedes:<
4527< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004528 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004529 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530
4531 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4532'loadplugins' 'lpl' boolean (default on)
4533 global
4534 {not in Vi}
4535 When on the plugin scripts are loaded when starting up |load-plugins|.
4536 This option can be reset in your |vimrc| file to disable the loading
4537 of plugins.
4538 Note that using the "-u NONE" and "--noplugin" command line arguments
4539 reset this option. |-u| |--noplugin|
4540
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004541 *'macatsui'* *'nomacatsui'*
4542'macatsui' boolean (default on)
4543 global
4544 {only available in Mac GUI version}
4545 This is a workaround for when drawing doesn't work properly. When set
4546 and compiled with multi-byte support ATSUI text drawing is used. When
4547 not set ATSUI text drawing is not used. Switch this option off when
4548 you experience drawing problems. In a future version the problems may
4549 be solved and this option becomes obsolete. Therefore use this method
4550 to unset it: >
4551 if exists('&macatsui')
4552 set nomacatsui
4553 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004554< Another option to check if you have drawing problems is
4555 'termencoding'.
4556
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 *'magic'* *'nomagic'*
4558'magic' boolean (default on)
4559 global
4560 Changes the special characters that can be used in search patterns.
4561 See |pattern|.
4562 NOTE: To avoid portability problems with using patterns, always keep
4563 this option at the default "on". Only switch it off when working with
4564 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004565 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566
4567 *'makeef'* *'mef'*
4568'makeef' 'mef' string (default: "")
4569 global
4570 {not in Vi}
4571 {not available when compiled without the |+quickfix|
4572 feature}
4573 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4574 and the |:grep| command.
4575 When it is empty, an internally generated temp file will be used.
4576 When "##" is included, it is replaced by a number to make the name
4577 unique. This makes sure that the ":make" command doesn't overwrite an
4578 existing file.
4579 NOT used for the ":cf" command. See 'errorfile' for that.
4580 Environment variables are expanded |:set_env|.
4581 See |option-backslash| about including spaces and backslashes.
4582 This option cannot be set from a |modeline| or in the |sandbox|, for
4583 security reasons.
4584
4585 *'makeprg'* *'mp'*
4586'makeprg' 'mp' string (default "make", VMS: "MMS")
4587 global or local to buffer |global-local|
4588 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004589 Program to use for the ":make" command. See |:make_makeprg|.
4590 This option may contain '%' and '#' characters, which are expanded to
4591 the current and alternate file name. |:_%| |:_#|
4592 Environment variables are expanded |:set_env|. See |option-backslash|
4593 about including spaces and backslashes.
4594 Note that a '|' must be escaped twice: once for ":set" and once for
4595 the interpretation of a command. When you use a filter called
4596 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597 :set makeprg=gmake\ \\\|\ myfilter
4598< The placeholder "$*" can be given (even multiple times) to specify
4599 where the arguments will be included, for example: >
4600 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4601< This option cannot be set from a |modeline| or in the |sandbox|, for
4602 security reasons.
4603
Bram Moolenaar1a384422010-07-14 19:53:30 +02004604 *'colorcolumn'* *'cc'*
4605'colorcolumn' 'cc' string (default "")
4606 local to window
4607 {not in Vi}
4608 {not available when compiled without the |+syntax|
4609 feature}
4610 'colorcolumn' is a comma separated list of screen columns that are
4611 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
4612 text. Will make screen redrawing slower.
4613 The screen column can be an absolute number, or a number preceded with
4614 '+' or '-', which is added to or subtracted from 'textwidth'. >
4615
4616 :set cc=+1 " highlight column after 'textwidth'
4617 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
4618 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
4619<
4620 When 'textwidth' is zero then the items with '-' and '+' are not used.
4621 A maximum of 256 columns are highlighted.
4622
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623 *'matchpairs'* *'mps'*
4624'matchpairs' 'mps' string (default "(:),{:},[:]")
4625 local to buffer
4626 {not in Vi}
4627 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004628 other. Currently only single byte character pairs are allowed, and
4629 they must be different. The characters must be separated by a colon.
4630 The pairs must be separated by a comma. Example for including '<' and
4631 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 :set mps+=<:>
4633
4634< A more exotic example, to jump between the '=' and ';' in an
4635 assignment, useful for languages like C and Java: >
4636 :au FileType c,cpp,java set mps+==:;
4637
4638< For a more advanced way of using "%", see the matchit.vim plugin in
4639 the $VIMRUNTIME/macros directory. |add-local-help|
4640
4641 *'matchtime'* *'mat'*
4642'matchtime' 'mat' number (default 5)
4643 global
4644 {not in Vi}{in Nvi}
4645 Tenths of a second to show the matching paren, when 'showmatch' is
4646 set. Note that this is not in milliseconds, like other options that
4647 set a time. This is to be compatible with Nvi.
4648
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004649 *'maxcombine'* *'mco'*
4650'maxcombine' 'mco' number (default 2)
4651 global
4652 {not in Vi}
4653 {only available when compiled with the |+multi_byte|
4654 feature}
4655 The maximum number of combining characters supported for displaying.
4656 Only used when 'encoding' is "utf-8".
4657 The default is OK for most languages. Hebrew may require 4.
4658 Maximum value is 6.
4659 Even when this option is set to 2 you can still edit text with more
4660 combining characters, you just can't see them. Use |g8| or |ga|.
4661 See |mbyte-combining|.
4662
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 *'maxfuncdepth'* *'mfd'*
4664'maxfuncdepth' 'mfd' number (default 100)
4665 global
4666 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004667 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004668 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669 Maximum depth of function calls for user functions. This normally
4670 catches endless recursion. When using a recursive function with
4671 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4672 more memory, there is the danger of failing when memory is exhausted.
4673 See also |:function|.
4674
4675 *'maxmapdepth'* *'mmd'* *E223*
4676'maxmapdepth' 'mmd' number (default 1000)
4677 global
4678 {not in Vi}
4679 Maximum number of times a mapping is done without resulting in a
4680 character to be used. This normally catches endless mappings, like
4681 ":map x y" with ":map y x". It still does not catch ":map g wg",
4682 because the 'w' is used before the next mapping is done. See also
4683 |key-mapping|.
4684
4685 *'maxmem'* *'mm'*
4686'maxmem' 'mm' number (default between 256 to 5120 (system
4687 dependent) or half the amount of memory
4688 available)
4689 global
4690 {not in Vi}
4691 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4692 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004693 other memory to be freed. The maximum usable value is about 2000000.
4694 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004696 *'maxmempattern'* *'mmp'*
4697'maxmempattern' 'mmp' number (default 1000)
4698 global
4699 {not in Vi}
4700 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004701 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004702 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004703 When Vim runs into the limit it gives an error message and mostly
4704 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004705 Running into the limit often means that the pattern is very
4706 inefficient or too complex. This may already happen with the pattern
4707 "\(.\)*" on a very long line. ".*" works much better.
4708 Vim may run out of memory before hitting the 'maxmempattern' limit.
4709
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 *'maxmemtot'* *'mmt'*
4711'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4712 dependent) or half the amount of memory
4713 available)
4714 global
4715 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004716 Maximum amount of memory in Kbyte to use for all buffers together.
4717 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4718 without a limit. On 64 bit machines higher values might work. But
4719 hey, do you really need more than 2 Gbyte for text editing?
4720 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721
4722 *'menuitems'* *'mis'*
4723'menuitems' 'mis' number (default 25)
4724 global
4725 {not in Vi}
4726 {not available when compiled without the |+menu|
4727 feature}
4728 Maximum number of items to use in a menu. Used for menus that are
4729 generated from a list of items, e.g., the Buffers menu. Changing this
4730 option has no direct effect, the menu must be refreshed first.
4731
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004732 *'mkspellmem'* *'msm'*
4733'mkspellmem' 'msm' string (default "460000,2000,500")
4734 global
4735 {not in Vi}
4736 {not available when compiled without the |+syntax|
4737 feature}
4738 Parameters for |:mkspell|. This tunes when to start compressing the
4739 word tree. Compression can be slow when there are many words, but
4740 it's needed to avoid running out of memory. The amount of memory used
4741 per word depends very much on how similar the words are, that's why
4742 this tuning is complicated.
4743
4744 There are three numbers, separated by commas:
4745 {start},{inc},{added}
4746
4747 For most languages the uncompressed word tree fits in memory. {start}
4748 gives the amount of memory in Kbyte that can be used before any
4749 compression is done. It should be a bit smaller than the amount of
4750 memory that is available to Vim.
4751
4752 When going over the {start} limit the {inc} number specifies the
4753 amount of memory in Kbyte that can be allocated before another
4754 compression is done. A low number means compression is done after
4755 less words are added, which is slow. A high number means more memory
4756 will be allocated.
4757
4758 After doing compression, {added} times 1024 words can be added before
4759 the {inc} limit is ignored and compression is done when any extra
4760 amount of memory is needed. A low number means there is a smaller
4761 chance of hitting the {inc} limit, less memory is used but it's
4762 slower.
4763
4764 The languages for which these numbers are important are Italian and
4765 Hungarian. The default works for when you have about 512 Mbyte. If
4766 you have 1 Gbyte you could use: >
4767 :set mkspellmem=900000,3000,800
4768< If you have less than 512 Mbyte |:mkspell| may fail for some
4769 languages, no matter what you set 'mkspellmem' to.
4770
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004772'modeline' 'ml' boolean (Vim default: on (off for root),
4773 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774 local to buffer
4775 *'modelines'* *'mls'*
4776'modelines' 'mls' number (default 5)
4777 global
4778 {not in Vi}
4779 If 'modeline' is on 'modelines' gives the number of lines that is
4780 checked for set commands. If 'modeline' is off or 'modelines' is zero
4781 no lines are checked. See |modeline|.
4782 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4783 set and to the Vim default value when 'compatible' is reset.
4784
4785 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4786'modifiable' 'ma' boolean (default on)
4787 local to buffer
4788 {not in Vi} *E21*
4789 When off the buffer contents cannot be changed. The 'fileformat' and
4790 'fileencoding' options also can't be changed.
4791 Can be reset with the |-M| command line argument.
4792
4793 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4794'modified' 'mod' boolean (default off)
4795 local to buffer
4796 {not in Vi}
4797 When on, the buffer is considered to be modified. This option is set
4798 when:
4799 1. A change was made to the text since it was last written. Using the
4800 |undo| command to go back to the original text will reset the
4801 option. But undoing changes that were made before writing the
4802 buffer will set the option again, since the text is different from
4803 when it was written.
4804 2. 'fileformat' or 'fileencoding' is different from its original
4805 value. The original value is set when the buffer is read or
4806 written. A ":set nomodified" command also resets the original
4807 values to the current values and the 'modified' option will be
4808 reset.
4809 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4810 will be ignored.
4811
4812 *'more'* *'nomore'*
4813'more' boolean (Vim default: on, Vi default: off)
4814 global
4815 {not in Vi}
4816 When on, listings pause when the whole screen is filled. You will get
4817 the |more-prompt|. When this option is off there are no pauses, the
4818 listing continues until finished.
4819 NOTE: This option is set to the Vi default value when 'compatible' is
4820 set and to the Vim default value when 'compatible' is reset.
4821
4822 *'mouse'* *E538*
4823'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4824 global
4825 {not in Vi}
4826 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004827 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4828 sysmouse and Linux console with gpm). For using the mouse in the
4829 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830 The mouse can be enabled for different modes:
4831 n Normal mode
4832 v Visual mode
4833 i Insert mode
4834 c Command-line mode
4835 h all previous modes when editing a help file
4836 a all previous modes
4837 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838 Normally you would enable the mouse in all four modes with: >
4839 :set mouse=a
4840< When the mouse is not enabled, the GUI will still use the mouse for
4841 modeless selection. This doesn't move the text cursor.
4842
4843 See |mouse-using|. Also see |'clipboard'|.
4844
4845 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004846 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847 the mouse buttons can still be used by keeping the shift key pressed.
4848 Also see the 'clipboard' option.
4849
4850 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4851'mousefocus' 'mousef' boolean (default off)
4852 global
4853 {not in Vi}
4854 {only works in the GUI}
4855 The window that the mouse pointer is on is automatically activated.
4856 When changing the window layout or window focus in another way, the
4857 mouse pointer is moved to the window with keyboard focus. Off is the
4858 default because it makes using the pull down menus a little goofy, as
4859 a pointer transit may activate a window unintentionally.
4860
4861 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4862'mousehide' 'mh' boolean (default on)
4863 global
4864 {not in Vi}
4865 {only works in the GUI}
4866 When on, the mouse pointer is hidden when characters are typed.
4867 The mouse pointer is restored when the mouse is moved.
4868
4869 *'mousemodel'* *'mousem'*
4870'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4871 global
4872 {not in Vi}
4873 Sets the model to use for the mouse. The name mostly specifies what
4874 the right mouse button is used for:
4875 extend Right mouse button extends a selection. This works
4876 like in an xterm.
4877 popup Right mouse button pops up a menu. The shifted left
4878 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004879 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004880 popup_setpos Like "popup", but the cursor will be moved to the
4881 position where the mouse was clicked, and thus the
4882 selected operation will act upon the clicked object.
4883 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004884 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 course, that right clicking outside a selection will
4886 end Visual mode.
4887 Overview of what button does what for each model:
4888 mouse extend popup(_setpos) ~
4889 left click place cursor place cursor
4890 left drag start selection start selection
4891 shift-left search word extend selection
4892 right click extend selection popup menu (place cursor)
4893 right drag extend selection -
4894 middle click paste paste
4895
4896 In the "popup" model the right mouse button produces a pop-up menu.
4897 You need to define this first, see |popup-menu|.
4898
4899 Note that you can further refine the meaning of buttons with mappings.
4900 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4901 selection (because that's handled in the GUI code directly).
4902
4903 The 'mousemodel' option is set by the |:behave| command.
4904
4905 *'mouseshape'* *'mouses'* *E547*
4906'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004907 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908 global
4909 {not in Vi}
4910 {only available when compiled with the |+mouseshape|
4911 feature}
4912 This option tells Vim what the mouse pointer should look like in
4913 different modes. The option is a comma separated list of parts, much
4914 like used for 'guicursor'. Each part consist of a mode/location-list
4915 and an argument-list:
4916 mode-list:shape,mode-list:shape,..
4917 The mode-list is a dash separated list of these modes/locations:
4918 In a normal window: ~
4919 n Normal mode
4920 v Visual mode
4921 ve Visual mode with 'selection' "exclusive" (same as 'v',
4922 if not specified)
4923 o Operator-pending mode
4924 i Insert mode
4925 r Replace mode
4926
4927 Others: ~
4928 c appending to the command-line
4929 ci inserting in the command-line
4930 cr replacing in the command-line
4931 m at the 'Hit ENTER' or 'More' prompts
4932 ml idem, but cursor in the last line
4933 e any mode, pointer below last window
4934 s any mode, pointer on a status line
4935 sd any mode, while dragging a status line
4936 vs any mode, pointer on a vertical separator line
4937 vd any mode, while dragging a vertical separator line
4938 a everywhere
4939
4940 The shape is one of the following:
4941 avail name looks like ~
4942 w x arrow Normal mouse pointer
4943 w x blank no pointer at all (use with care!)
4944 w x beam I-beam
4945 w x updown up-down sizing arrows
4946 w x leftright left-right sizing arrows
4947 w x busy The system's usual busy pointer
4948 w x no The system's usual 'no input' pointer
4949 x udsizing indicates up-down resizing
4950 x lrsizing indicates left-right resizing
4951 x crosshair like a big thin +
4952 x hand1 black hand
4953 x hand2 white hand
4954 x pencil what you write with
4955 x question big ?
4956 x rightup-arrow arrow pointing right-up
4957 w x up-arrow arrow pointing up
4958 x <number> any X11 pointer number (see X11/cursorfont.h)
4959
4960 The "avail" column contains a 'w' if the shape is available for Win32,
4961 x for X11.
4962 Any modes not specified or shapes not available use the normal mouse
4963 pointer.
4964
4965 Example: >
4966 :set mouseshape=s:udsizing,m:no
4967< will make the mouse turn to a sizing arrow over the status lines and
4968 indicate no input when the hit-enter prompt is displayed (since
4969 clicking the mouse has no effect in this state.)
4970
4971 *'mousetime'* *'mouset'*
4972'mousetime' 'mouset' number (default 500)
4973 global
4974 {not in Vi}
4975 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4976 time in msec between two mouse clicks for the second click to be
4977 recognized as a multi click.
4978
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004979 *'mzquantum'* *'mzq'*
4980'mzquantum' 'mzq' number (default 100)
4981 global
4982 {not in Vi}
4983 {not available when compiled without the |+mzscheme|
4984 feature}
4985 The number of milliseconds between polls for MzScheme threads.
4986 Negative or zero value means no thread scheduling.
4987
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 *'nrformats'* *'nf'*
4989'nrformats' 'nf' string (default "octal,hex")
4990 local to buffer
4991 {not in Vi}
4992 This defines what bases Vim will consider for numbers when using the
4993 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4994 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004995 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02004997 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00004998 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005000 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 considered to be hexadecimal. Example: Using CTRL-X on
5002 "0x100" results in "0x0ff".
5003 Numbers which simply begin with a digit in the range 1-9 are always
5004 considered decimal. This also happens for numbers that are not
5005 recognized as octal or hex.
5006
5007 *'number'* *'nu'* *'nonumber'* *'nonu'*
5008'number' 'nu' boolean (default off)
5009 local to window
5010 Print the line number in front of each line. When the 'n' option is
5011 excluded from 'cpoptions' a wrapped line will not use the column of
5012 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005013 The 'numberwidth' option can be used to set the room used for the line
5014 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015 When a long, wrapped line doesn't start with the first character, '-'
5016 characters are put before the number.
5017 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005018 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005020 *'numberwidth'* *'nuw'*
5021'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5022 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005023 {not in Vi}
5024 {only available when compiled with the |+linebreak|
5025 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005026 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005027 when the 'number' or 'relativenumber' option is set or printing lines
5028 with a line number. Since one space is always between the number and
5029 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005030 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005031 fit the highest line number in the buffer respectively the number of
5032 rows in the window, depending on whether 'number' or 'relativenumber'
5033 is set. Thus with the Vim default of 4 there is room for a line number
5034 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005035 The minimum value is 1, the maximum value is 10.
5036 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5037
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005038 *'omnifunc'* *'ofu'*
5039'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005040 local to buffer
5041 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005042 {not available when compiled without the |+eval|
5043 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005044 This option specifies a function to be used for Insert mode omni
5045 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005046 See |complete-functions| for an explanation of how the function is
5047 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005048 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005049 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005050
5051
Bram Moolenaar02467872007-05-06 13:22:01 +00005052 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005053'opendevice' 'odev' boolean (default off)
5054 global
5055 {not in Vi}
5056 {only for MS-DOS, MS-Windows and OS/2}
5057 Enable reading and writing from devices. This may get Vim stuck on a
5058 device that can be opened but doesn't actually do the I/O. Therefore
5059 it is off by default.
5060 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5061 result in editing a device.
5062
5063
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005064 *'operatorfunc'* *'opfunc'*
5065'operatorfunc' 'opfunc' string (default: empty)
5066 global
5067 {not in Vi}
5068 This option specifies a function to be called by the |g@| operator.
5069 See |:map-operator| for more info and an example.
5070
5071 This option cannot be set from a |modeline| or in the |sandbox|, for
5072 security reasons.
5073
5074
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 *'osfiletype'* *'oft'* *E366*
5076'osfiletype' 'oft' string (RISC-OS default: "Text",
5077 others default: "")
5078 local to buffer
5079 {not in Vi}
5080 {only available when compiled with the |+osfiletype|
5081 feature}
5082 Some operating systems store extra information about files besides
5083 name, datestamp and permissions. This option contains the extra
5084 information, the nature of which will vary between systems.
5085 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005086 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005087 It can affect the pattern matching of the automatic commands.
5088 |autocmd-osfiletypes|
5089
5090 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005091'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092 global
5093 Specifies the nroff macros that separate paragraphs. These are pairs
5094 of two letters (see |object-motions|).
5095
5096 *'paste'* *'nopaste'*
5097'paste' boolean (default off)
5098 global
5099 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005100 Put Vim in Paste mode. This is useful if you want to cut or copy
5101 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 unexpected effects.
5103 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005104 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105 knows about pasting and will mostly do the right thing without 'paste'
5106 being set. The same is true for a terminal where Vim handles the
5107 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005108 This option is reset when starting the GUI. Thus if you set it in
5109 your .vimrc it will work in a terminal, but not in the GUI. Setting
5110 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5111 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112 When the 'paste' option is switched on (also when it was already on):
5113 - mapping in Insert mode and Command-line mode is disabled
5114 - abbreviations are disabled
5115 - 'textwidth' is set to 0
5116 - 'wrapmargin' is set to 0
5117 - 'autoindent' is reset
5118 - 'smartindent' is reset
5119 - 'softtabstop' is set to 0
5120 - 'revins' is reset
5121 - 'ruler' is reset
5122 - 'showmatch' is reset
5123 - 'formatoptions' is used like it is empty
5124 These options keep their value, but their effect is disabled:
5125 - 'lisp'
5126 - 'indentexpr'
5127 - 'cindent'
5128 NOTE: When you start editing another file while the 'paste' option is
5129 on, settings from the modelines or autocommands may change the
5130 settings again, causing trouble when pasting text. You might want to
5131 set the 'paste' option again.
5132 When the 'paste' option is reset the mentioned options are restored to
5133 the value before the moment 'paste' was switched from off to on.
5134 Resetting 'paste' before ever setting it does not have any effect.
5135 Since mapping doesn't work while 'paste' is active, you need to use
5136 the 'pastetoggle' option to toggle the 'paste' option with some key.
5137
5138 *'pastetoggle'* *'pt'*
5139'pastetoggle' 'pt' string (default "")
5140 global
5141 {not in Vi}
5142 When non-empty, specifies the key sequence that toggles the 'paste'
5143 option. This is like specifying a mapping: >
5144 :map {keys} :set invpaste<CR>
5145< Where {keys} is the value of 'pastetoggle'.
5146 The difference is that it will work even when 'paste' is set.
5147 'pastetoggle' works in Insert mode and Normal mode, but not in
5148 Command-line mode.
5149 Mappings are checked first, thus overrule 'pastetoggle'. However,
5150 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5151 this: >
5152 :map <F10> :set paste<CR>
5153 :map <F11> :set nopaste<CR>
5154 :imap <F10> <C-O>:set paste<CR>
5155 :imap <F11> <nop>
5156 :set pastetoggle=<F11>
5157< This will make <F10> start paste mode and <F11> stop paste mode.
5158 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5159 mode everything is inserted literally, except the 'pastetoggle' key
5160 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005161 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162
5163 *'pex'* *'patchexpr'*
5164'patchexpr' 'pex' string (default "")
5165 global
5166 {not in Vi}
5167 {not available when compiled without the |+diff|
5168 feature}
5169 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005170 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171
5172 *'patchmode'* *'pm'* *E206*
5173'patchmode' 'pm' string (default "")
5174 global
5175 {not in Vi}
5176 When non-empty the oldest version of a file is kept. This can be used
5177 to keep the original version of a file if you are changing files in a
5178 source distribution. Only the first time that a file is written a
5179 copy of the original file will be kept. The name of the copy is the
5180 name of the original file with the string in the 'patchmode' option
5181 appended. This option should start with a dot. Use a string like
5182 ".org". 'backupdir' must not be empty for this to work (Detail: The
5183 backup file is renamed to the patchmode file after the new file has
5184 been successfully written, that's why it must be possible to write a
5185 backup file). If there was no file to be backed up, an empty file is
5186 created.
5187 When the 'backupskip' pattern matches, a patchmode file is not made.
5188 Using 'patchmode' for compressed files appends the extension at the
5189 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5190 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005191 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192
5193 *'path'* *'pa'* *E343* *E345* *E347*
5194'path' 'pa' string (default on Unix: ".,/usr/include,,"
5195 on OS/2: ".,/emx/include,,"
5196 other systems: ".,,")
5197 global or local to buffer |global-local|
5198 {not in Vi}
5199 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005200 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5201 provided that the file being searched for has a relative path (not
5202 starting with "/", "./" or "../"). The directories in the 'path'
5203 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005204 - Use commas to separate directory names: >
5205 :set path=.,/usr/local/include,/usr/include
5206< - Spaces can also be used to separate directory names (for backwards
5207 compatibility with version 3.0). To have a space in a directory
5208 name, precede it with an extra backslash, and escape the space: >
5209 :set path=.,/dir/with\\\ space
5210< - To include a comma in a directory name precede it with an extra
5211 backslash: >
5212 :set path=.,/dir/with\\,comma
5213< - To search relative to the directory of the current file, use: >
5214 :set path=.
5215< - To search in the current directory use an empty string between two
5216 commas: >
5217 :set path=,,
5218< - A directory name may end in a ':' or '/'.
5219 - Environment variables are expanded |:set_env|.
5220 - When using |netrw.vim| URLs can be used. For example, adding
5221 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005222 - Search upwards and downwards in a directory tree using "*", "**" and
5223 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 {not available when compiled without the |+path_extra| feature}
5225 - Careful with '\' characters, type two to get one in the option: >
5226 :set path=.,c:\\include
5227< Or just use '/' instead: >
5228 :set path=.,c:/include
5229< Don't forget "." or files won't even be found in the same directory as
5230 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005231 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 it is something like 256 or 1024 characters.
5233 You can check if all the include files are found, using the value of
5234 'path', see |:checkpath|.
5235 The use of |:set+=| and |:set-=| is preferred when adding or removing
5236 directories from the list. This avoids problems when a future version
5237 uses another default. To remove the current directory use: >
5238 :set path-=
5239< To add the current directory use: >
5240 :set path+=
5241< To use an environment variable, you probably need to replace the
5242 separator. Here is an example to append $INCL, in which directory
5243 names are separated with a semi-colon: >
5244 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5245< Replace the ';' with a ':' or whatever separator is used. Note that
5246 this doesn't work when $INCL contains a comma or white space.
5247
5248 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5249'preserveindent' 'pi' boolean (default off)
5250 local to buffer
5251 {not in Vi}
5252 When changing the indent of the current line, preserve as much of the
5253 indent structure as possible. Normally the indent is replaced by a
5254 series of tabs followed by spaces as required (unless |'expandtab'| is
5255 enabled, in which case only spaces are used). Enabling this option
5256 means the indent will preserve as many existing characters as possible
5257 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005258 'expandtab' does not apply to the preserved white space, a Tab remains
5259 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 NOTE: When using ">>" multiple times the resulting indent is a mix of
5261 tabs and spaces. You might not like this.
5262 NOTE: 'preserveindent' is reset when 'compatible' is set.
5263 Also see 'copyindent'.
5264 Use |:retab| to clean up white space.
5265
5266 *'previewheight'* *'pvh'*
5267'previewheight' 'pvh' number (default 12)
5268 global
5269 {not in Vi}
5270 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005271 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005272 Default height for a preview window. Used for |:ptag| and associated
5273 commands. Used for |CTRL-W_}| when no count is given.
5274
5275 *'previewwindow'* *'nopreviewwindow'*
5276 *'pvw'* *'nopvw'* *E590*
5277'previewwindow' 'pvw' boolean (default off)
5278 local to window
5279 {not in Vi}
5280 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005281 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005282 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 set. It's normally not set directly, but by using one of the commands
5284 |:ptag|, |:pedit|, etc.
5285
5286 *'printdevice'* *'pdev'*
5287'printdevice' 'pdev' string (default empty)
5288 global
5289 {not in Vi}
5290 {only available when compiled with the |+printer|
5291 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005292 The name of the printer to be used for |:hardcopy|.
5293 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005294 This option cannot be set from a |modeline| or in the |sandbox|, for
5295 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005296
Bram Moolenaar8299df92004-07-10 09:47:34 +00005297 *'printencoding'* *'penc'*
5298'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005299 global
5300 {not in Vi}
5301 {only available when compiled with the |+printer|
5302 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005303 Sets the character encoding used when printing.
5304 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305
5306 *'printexpr'* *'pexpr'*
5307'printexpr' 'pexpr' String (default: see below)
5308 global
5309 {not in Vi}
5310 {only available when compiled with the |+printer|
5311 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005312 Expression used to print the PostScript produced with |:hardcopy|.
5313 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314
Bram Moolenaar8299df92004-07-10 09:47:34 +00005315 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316'printfont' 'pfn' string (default "courier")
5317 global
5318 {not in Vi}
5319 {only available when compiled with the |+printer|
5320 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005321 The name of the font that will be used for |:hardcopy|.
5322 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005323
5324 *'printheader'* *'pheader'*
5325'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5326 global
5327 {not in Vi}
5328 {only available when compiled with the |+printer|
5329 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005330 The format of the header produced in |:hardcopy| output.
5331 See |pheader-option|.
5332
5333 *'printmbcharset'* *'pmbcs'*
5334'printmbcharset' 'pmbcs' string (default "")
5335 global
5336 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005337 {only available when compiled with the |+printer|,
5338 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005339 The CJK character set to be used for CJK output from |:hardcopy|.
5340 See |pmbcs-option|.
5341
5342 *'printmbfont'* *'pmbfn'*
5343'printmbfont' 'pmbfn' string (default "")
5344 global
5345 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005346 {only available when compiled with the |+printer|,
5347 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005348 List of font names to be used for CJK output from |:hardcopy|.
5349 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350
5351 *'printoptions'* *'popt'*
5352'printoptions' 'popt' string (default "")
5353 global
5354 {not in Vi}
5355 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005356 List of items that control the format of the output of |:hardcopy|.
5357 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005358
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005359 *'prompt'* *'noprompt'*
5360'prompt' boolean (default on)
5361 global
5362 When on a ":" prompt is used in Ex mode.
5363
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005364 *'pumheight'* *'ph'*
5365'pumheight' 'ph' number (default 0)
5366 global
5367 {not available when compiled without the
5368 |+insert_expand| feature}
5369 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005370 Determines the maximum number of items to show in the popup menu for
5371 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005372 |ins-completion-menu|.
5373
5374
Bram Moolenaar677ee682005-01-27 14:41:15 +00005375 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005376'quoteescape' 'qe' string (default "\")
5377 local to buffer
5378 {not in Vi}
5379 The characters that are used to escape quotes in a string. Used for
5380 objects like a', a" and a` |a'|.
5381 When one of the characters in this option is found inside a string,
5382 the following character will be skipped. The default value makes the
5383 text "foo\"bar\\" considered to be one string.
5384
Bram Moolenaar071d4272004-06-13 20:20:40 +00005385 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5386'readonly' 'ro' boolean (default off)
5387 local to buffer
5388 If on, writes fail unless you use a '!'. Protects you from
5389 accidentally overwriting a file. Default on when Vim is started
5390 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005391 When using ":w!" the 'readonly' option is reset for the current
5392 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005394 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005396 *'redrawtime'* *'rdt'*
5397'redrawtime' 'rdt' number (default 2000)
5398 global
5399 {not in Vi}
5400 {only available when compiled with the |+reltime|
5401 feature}
5402 The time in milliseconds for redrawing the display. This applies to
5403 searching for patterns for 'hlsearch' and |:match| highlighting.
5404 When redrawing takes more than this many milliseconds no further
5405 matches will be highlighted. This is used to avoid that Vim hangs
5406 when using a very complicated pattern.
5407
Bram Moolenaar64486672010-05-16 15:46:46 +02005408 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5409'relativenumber' 'rnu' boolean (default off)
5410 local to window
5411 {not in Vi}
5412 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005413 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005414 precede some vertical motion commands (e.g. j k + -) with, without
5415 having to calculate it yourself. Especially useful in combination with
5416 other commands (e.g. y d c < > gq gw =).
5417 When the 'n' option is excluded from 'cpoptions' a wrapped
5418 line will not use the column of line numbers (this is the default when
5419 'compatible' isn't set).
5420 The 'numberwidth' option can be used to set the room used for the line
5421 number.
5422 When a long, wrapped line doesn't start with the first character, '-'
5423 characters are put before the number.
5424 See |hl-LineNr| for the highlighting used for the number.
5425 When setting this option, 'number' is reset.
5426
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427 *'remap'* *'noremap'*
5428'remap' boolean (default on)
5429 global
5430 Allows for mappings to work recursively. If you do not want this for
5431 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005432 NOTE: To avoid portability problems with Vim scripts, always keep
5433 this option at the default "on". Only switch it off when working with
5434 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435
5436 *'report'*
5437'report' number (default 2)
5438 global
5439 Threshold for reporting number of lines changed. When the number of
5440 changed lines is more than 'report' a message will be given for most
5441 ":" commands. If you want it always, set 'report' to 0.
5442 For the ":substitute" command the number of substitutions is used
5443 instead of the number of lines.
5444
5445 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5446'restorescreen' 'rs' boolean (default on)
5447 global
5448 {not in Vi} {only in Windows 95/NT console version}
5449 When set, the screen contents is restored when exiting Vim. This also
5450 happens when executing external commands.
5451
5452 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5453 options in your .vimrc. To disable restoring:
5454 set t_ti= t_te=
5455 To enable restoring (for an xterm):
5456 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5457 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5458
5459 *'revins'* *'ri'* *'norevins'* *'nori'*
5460'revins' 'ri' boolean (default off)
5461 global
5462 {not in Vi}
5463 {only available when compiled with the |+rightleft|
5464 feature}
5465 Inserting characters in Insert mode will work backwards. See "typing
5466 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5467 command in Insert mode, when 'allowrevins' is set.
5468 NOTE: This option is reset when 'compatible' or 'paste' is set.
5469
5470 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5471'rightleft' 'rl' boolean (default off)
5472 local to window
5473 {not in Vi}
5474 {only available when compiled with the |+rightleft|
5475 feature}
5476 When on, display orientation becomes right-to-left, i.e., characters
5477 that are stored in the file appear from the right to the left.
5478 Using this option, it is possible to edit files for languages that
5479 are written from the right to the left such as Hebrew and Arabic.
5480 This option is per window, so it is possible to edit mixed files
5481 simultaneously, or to view the same file in both ways (this is
5482 useful whenever you have a mixed text file with both right-to-left
5483 and left-to-right strings so that both sets are displayed properly
5484 in different windows). Also see |rileft.txt|.
5485
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005486 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487'rightleftcmd' 'rlc' string (default "search")
5488 local to window
5489 {not in Vi}
5490 {only available when compiled with the |+rightleft|
5491 feature}
5492 Each word in this option enables the command line editing to work in
5493 right-to-left mode for a group of commands:
5494
5495 search "/" and "?" commands
5496
5497 This is useful for languages such as Hebrew, Arabic and Farsi.
5498 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5499
5500 *'ruler'* *'ru'* *'noruler'* *'noru'*
5501'ruler' 'ru' boolean (default off)
5502 global
5503 {not in Vi}
5504 {not available when compiled without the
5505 |+cmdline_info| feature}
5506 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005507 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 text in the file is shown on the far right:
5509 Top first line is visible
5510 Bot last line is visible
5511 All first and last line are visible
5512 45% relative position in the file
5513 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005514 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005516 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005517 this option takes precedence over 'ruler' and 'rulerformat'
5518 If the number of characters displayed is different from the number of
5519 bytes in the text (e.g., for a TAB or a multi-byte character), both
5520 the text column (byte number) and the screen column are shown,
5521 separated with a dash.
5522 For an empty line "0-1" is shown.
5523 For an empty buffer the line number will also be zero: "0,0-1".
5524 This option is reset when the 'paste' option is set.
5525 If you don't want to see the ruler all the time but want to know where
5526 you are, use "g CTRL-G" |g_CTRL-G|.
5527 NOTE: This option is reset when 'compatible' is set.
5528
5529 *'rulerformat'* *'ruf'*
5530'rulerformat' 'ruf' string (default empty)
5531 global
5532 {not in Vi}
5533 {not available when compiled without the |+statusline|
5534 feature}
5535 When this option is not empty, it determines the content of the ruler
5536 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005537 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005538 The default ruler width is 17 characters. To make the ruler 15
5539 characters wide, put "%15(" at the start and "%)" at the end.
5540 Example: >
5541 :set rulerformat=%15(%c%V\ %p%%%)
5542<
5543 *'runtimepath'* *'rtp'* *vimfiles*
5544'runtimepath' 'rtp' string (default:
5545 Unix: "$HOME/.vim,
5546 $VIM/vimfiles,
5547 $VIMRUNTIME,
5548 $VIM/vimfiles/after,
5549 $HOME/.vim/after"
5550 Amiga: "home:vimfiles,
5551 $VIM/vimfiles,
5552 $VIMRUNTIME,
5553 $VIM/vimfiles/after,
5554 home:vimfiles/after"
5555 PC, OS/2: "$HOME/vimfiles,
5556 $VIM/vimfiles,
5557 $VIMRUNTIME,
5558 $VIM/vimfiles/after,
5559 $HOME/vimfiles/after"
5560 Macintosh: "$VIM:vimfiles,
5561 $VIMRUNTIME,
5562 $VIM:vimfiles:after"
5563 RISC-OS: "Choices:vimfiles,
5564 $VIMRUNTIME,
5565 Choices:vimfiles/after"
5566 VMS: "sys$login:vimfiles,
5567 $VIM/vimfiles,
5568 $VIMRUNTIME,
5569 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005570 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 global
5572 {not in Vi}
5573 This is a list of directories which will be searched for runtime
5574 files:
5575 filetype.vim filetypes by file name |new-filetype|
5576 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005577 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578 colors/ color scheme files |:colorscheme|
5579 compiler/ compiler files |:compiler|
5580 doc/ documentation |write-local-help|
5581 ftplugin/ filetype plugins |write-filetype-plugin|
5582 indent/ indent scripts |indent-expression|
5583 keymap/ key mapping files |mbyte-keymap|
5584 lang/ menu translations |:menutrans|
5585 menu.vim GUI menus |menu.vim|
5586 plugin/ plugin scripts |write-plugin|
5587 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005588 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 syntax/ syntax files |mysyntaxfile|
5590 tutor/ files for vimtutor |tutor|
5591
5592 And any other file searched for with the |:runtime| command.
5593
5594 The defaults for most systems are setup to search five locations:
5595 1. In your home directory, for your personal preferences.
5596 2. In a system-wide Vim directory, for preferences from the system
5597 administrator.
5598 3. In $VIMRUNTIME, for files distributed with Vim.
5599 *after-directory*
5600 4. In the "after" directory in the system-wide Vim directory. This is
5601 for the system administrator to overrule or add to the distributed
5602 defaults (rarely needed)
5603 5. In the "after" directory in your home directory. This is for
5604 personal preferences to overrule or add to the distributed defaults
5605 or system-wide settings (rarely needed).
5606
5607 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5608 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005609 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005610 wildcards.
5611 See |:runtime|.
5612 Example: >
5613 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5614< This will use the directory "~/vimruntime" first (containing your
5615 personal Vim runtime files), then "/mygroup/vim" (shared between a
5616 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5617 files).
5618 You probably should always include $VIMRUNTIME somewhere, to use the
5619 distributed runtime files. You can put a directory before $VIMRUNTIME
5620 to find files which replace a distributed runtime files. You can put
5621 a directory after $VIMRUNTIME to find files which add to distributed
5622 runtime files.
5623 This option cannot be set from a |modeline| or in the |sandbox|, for
5624 security reasons.
5625
5626 *'scroll'* *'scr'*
5627'scroll' 'scr' number (default: half the window height)
5628 local to window
5629 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5630 set to half the number of lines in the window when the window size
5631 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005632 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5634 the number of screen lines instead of file lines, makes a difference
5635 when lines wrap}
5636
5637 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5638'scrollbind' 'scb' boolean (default off)
5639 local to window
5640 {not in Vi}
5641 {not available when compiled without the |+scrollbind|
5642 feature}
5643 See also |scroll-binding|. When this option is set, the current
5644 window scrolls as other scrollbind windows (windows that also have
5645 this option set) scroll. This option is useful for viewing the
5646 differences between two versions of a file, see 'diff'.
5647 See |'scrollopt'| for options that determine how this option should be
5648 interpreted.
5649 This option is mostly reset when splitting a window to edit another
5650 file. This means that ":split | edit file" results in two windows
5651 with scroll-binding, but ":split file" does not.
5652
5653 *'scrolljump'* *'sj'*
5654'scrolljump' 'sj' number (default 1)
5655 global
5656 {not in Vi}
5657 Minimal number of lines to scroll when the cursor gets off the
5658 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5659 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005660 When set to a negative number from -1 to -100 this is used as the
5661 percentage of the window height. Thus -50 scrolls half the window
5662 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663 NOTE: This option is set to 1 when 'compatible' is set.
5664
5665 *'scrolloff'* *'so'*
5666'scrolloff' 'so' number (default 0)
5667 global
5668 {not in Vi}
5669 Minimal number of screen lines to keep above and below the cursor.
5670 This will make some context visible around where you are working. If
5671 you set it to a very large value (999) the cursor line will always be
5672 in the middle of the window (except at the start or end of the file or
5673 when long lines wrap).
5674 For scrolling horizontally see 'sidescrolloff'.
5675 NOTE: This option is set to 0 when 'compatible' is set.
5676
5677 *'scrollopt'* *'sbo'*
5678'scrollopt' 'sbo' string (default "ver,jump")
5679 global
5680 {not available when compiled without the |+scrollbind|
5681 feature}
5682 {not in Vi}
5683 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005684 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5685 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005686 The following words are available:
5687 ver Bind vertical scrolling for 'scrollbind' windows
5688 hor Bind horizontal scrolling for 'scrollbind' windows
5689 jump Applies to the offset between two windows for vertical
5690 scrolling. This offset is the difference in the first
5691 displayed line of the bound windows. When moving
5692 around in a window, another 'scrollbind' window may
5693 reach a position before the start or after the end of
5694 the buffer. The offset is not changed though, when
5695 moving back the 'scrollbind' window will try to scroll
5696 to the desired position when possible.
5697 When now making that window the current one, two
5698 things can be done with the relative offset:
5699 1. When "jump" is not included, the relative offset is
5700 adjusted for the scroll position in the new current
5701 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005702 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 2. When "jump" is included, the other windows are
5704 scrolled to keep the same relative offset. When
5705 going back to the other window, it still uses the
5706 same relative offset.
5707 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005708 When 'diff' mode is active there always is vertical scroll binding,
5709 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710
5711 *'sections'* *'sect'*
5712'sections' 'sect' string (default "SHNHH HUnhsh")
5713 global
5714 Specifies the nroff macros that separate sections. These are pairs of
5715 two letters (See |object-motions|). The default makes a section start
5716 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5717
5718 *'secure'* *'nosecure'* *E523*
5719'secure' boolean (default off)
5720 global
5721 {not in Vi}
5722 When on, ":autocmd", shell and write commands are not allowed in
5723 ".vimrc" and ".exrc" in the current directory and map commands are
5724 displayed. Switch it off only if you know that you will not run into
5725 problems, or when the 'exrc' option is off. On Unix this option is
5726 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005727 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005728 'secure' at the end of your ~/.vimrc then.
5729 This option cannot be set from a |modeline| or in the |sandbox|, for
5730 security reasons.
5731
5732 *'selection'* *'sel'*
5733'selection' 'sel' string (default "inclusive")
5734 global
5735 {not in Vi}
5736 This option defines the behavior of the selection. It is only used
5737 in Visual and Select mode.
5738 Possible values:
5739 value past line inclusive ~
5740 old no yes
5741 inclusive yes yes
5742 exclusive yes no
5743 "past line" means that the cursor is allowed to be positioned one
5744 character past the line.
5745 "inclusive" means that the last character of the selection is included
5746 in an operation. For example, when "x" is used to delete the
5747 selection.
5748 Note that when "exclusive" is used and selecting from the end
5749 backwards, you cannot include the last character of a line, when
5750 starting in Normal mode and 'virtualedit' empty.
5751
5752 The 'selection' option is set by the |:behave| command.
5753
5754 *'selectmode'* *'slm'*
5755'selectmode' 'slm' string (default "")
5756 global
5757 {not in Vi}
5758 This is a comma separated list of words, which specifies when to start
5759 Select mode instead of Visual mode, when a selection is started.
5760 Possible values:
5761 mouse when using the mouse
5762 key when using shifted special keys
5763 cmd when using "v", "V" or CTRL-V
5764 See |Select-mode|.
5765 The 'selectmode' option is set by the |:behave| command.
5766
5767 *'sessionoptions'* *'ssop'*
5768'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005769 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770 global
5771 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005772 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 feature}
5774 Changes the effect of the |:mksession| command. It is a comma
5775 separated list of words. Each word enables saving and restoring
5776 something:
5777 word save and restore ~
5778 blank empty windows
5779 buffers hidden and unloaded buffers, not just those in windows
5780 curdir the current directory
5781 folds manually created folds, opened/closed folds and local
5782 fold options
5783 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005784 and contain at least one lowercase letter. Only
5785 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005786 help the help window
5787 localoptions options and mappings local to a window or buffer (not
5788 global values for local options)
5789 options all options and mappings (also global values for local
5790 options)
5791 resize size of the Vim window: 'lines' and 'columns'
5792 sesdir the directory in which the session file is located
5793 will become the current directory (useful with
5794 projects accessed over a network from different
5795 systems)
5796 slash backslashes in file names replaced with forward
5797 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005798 tabpages all tab pages; without this only the current tab page
5799 is restored, so that you can make a session for each
5800 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005801 unix with Unix end-of-line format (single <NL>), even when
5802 on Windows or DOS
5803 winpos position of the whole Vim window
5804 winsize window sizes
5805
5806 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005807 When neither "curdir" nor "sesdir" is included, file names are stored
5808 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809 "slash" and "unix" are useful on Windows when sharing session files
5810 with Unix. The Unix version of Vim cannot source dos format scripts,
5811 but the Windows version of Vim can source unix format scripts.
5812
5813 *'shell'* *'sh'* *E91*
5814'shell' 'sh' string (default $SHELL or "sh",
5815 MS-DOS and Win32: "command.com" or
5816 "cmd.exe", OS/2: "cmd")
5817 global
5818 Name of the shell to use for ! and :! commands. When changing the
5819 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5820 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005821 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822 See |option-backslash| about including spaces and backslashes.
5823 Environment variables are expanded |:set_env|.
5824 If the name of the shell contains a space, you might need to enclose
5825 it in quotes. Example: >
5826 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5827< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005828 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005829 "-f" is not inside the quotes, because it is not part of the command
5830 name. And Vim automagically recognizes the backslashes that are path
5831 separators.
5832 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5833 variable to change the way external commands are executed. See the
5834 libc.inf file of DJGPP.
5835 Under MS-Windows, when the executable ends in ".com" it must be
5836 included. Thus setting the shell to "command.com" or "4dos.com"
5837 works, but "command" and "4dos" do not work for all commands (e.g.,
5838 filtering).
5839 For unknown reasons, when using "4dos.com" the current directory is
5840 changed to "C:\". To avoid this set 'shell' like this: >
5841 :set shell=command.com\ /c\ 4dos
5842< This option cannot be set from a |modeline| or in the |sandbox|, for
5843 security reasons.
5844
5845 *'shellcmdflag'* *'shcf'*
5846'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5847 does not contain "sh" somewhere: "/c")
5848 global
5849 {not in Vi}
5850 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5851 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5852 systems, the default is set according to the value of 'shell', to
5853 reduce the need to set this option by the user. It's not used for
5854 OS/2 (EMX figures this out itself). See |option-backslash| about
5855 including spaces and backslashes. See |dos-shell|.
5856 This option cannot be set from a |modeline| or in the |sandbox|, for
5857 security reasons.
5858
5859 *'shellpipe'* *'sp'*
5860'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5861 global
5862 {not in Vi}
5863 {not available when compiled without the |+quickfix|
5864 feature}
5865 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005866 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005867 including spaces and backslashes.
5868 The name of the temporary file can be represented by "%s" if necessary
5869 (the file name is appended automatically if no %s appears in the value
5870 of this option).
5871 For the Amiga and MS-DOS the default is ">". The output is directly
5872 saved in a file and not echoed to the screen.
5873 For Unix the default it "| tee". The stdout of the compiler is saved
5874 in a file and echoed to the screen. If the 'shell' option is "csh" or
5875 "tcsh" after initializations, the default becomes "|& tee". If the
5876 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005877 "2>&1| tee". This means that stderr is also included. Before using
5878 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879 The initialization of this option is done after reading the ".vimrc"
5880 and the other initializations, so that when the 'shell' option is set
5881 there, the 'shellpipe' option changes automatically, unless it was
5882 explicitly set before.
5883 When 'shellpipe' is set to an empty string, no redirection of the
5884 ":make" output will be done. This is useful if you use a 'makeprg'
5885 that writes to 'makeef' by itself. If you want no piping, but do
5886 want to include the 'makeef', set 'shellpipe' to a single space.
5887 Don't forget to precede the space with a backslash: ":set sp=\ ".
5888 In the future pipes may be used for filtering and this option will
5889 become obsolete (at least for Unix).
5890 This option cannot be set from a |modeline| or in the |sandbox|, for
5891 security reasons.
5892
5893 *'shellquote'* *'shq'*
5894'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5895 contains "sh" somewhere: "\"")
5896 global
5897 {not in Vi}
5898 Quoting character(s), put around the command passed to the shell, for
5899 the "!" and ":!" commands. The redirection is kept outside of the
5900 quoting. See 'shellxquote' to include the redirection. It's
5901 probably not useful to set both options.
5902 This is an empty string by default. Only known to be useful for
5903 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5904 or bash, where it should be "\"". The default is adjusted according
5905 the value of 'shell', to reduce the need to set this option by the
5906 user. See |dos-shell|.
5907 This option cannot be set from a |modeline| or in the |sandbox|, for
5908 security reasons.
5909
5910 *'shellredir'* *'srr'*
5911'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5912 global
5913 {not in Vi}
5914 String to be used to put the output of a filter command in a temporary
5915 file. See also |:!|. See |option-backslash| about including spaces
5916 and backslashes.
5917 The name of the temporary file can be represented by "%s" if necessary
5918 (the file name is appended automatically if no %s appears in the value
5919 of this option).
5920 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5921 or "zsh" during initializations, the default becomes ">&". If the
5922 'shell' option is "sh", "ksh" or "bash" the default becomes
5923 ">%s 2>&1". This means that stderr is also included.
5924 For Win32, the Unix checks are done and additionally "cmd" is checked
5925 for, which makes the default ">%s 2>&1". Also, the same names with
5926 ".exe" appended are checked for.
5927 The initialization of this option is done after reading the ".vimrc"
5928 and the other initializations, so that when the 'shell' option is set
5929 there, the 'shellredir' option changes automatically unless it was
5930 explicitly set before.
5931 In the future pipes may be used for filtering and this option will
5932 become obsolete (at least for Unix).
5933 This option cannot be set from a |modeline| or in the |sandbox|, for
5934 security reasons.
5935
5936 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5937'shellslash' 'ssl' boolean (default off)
5938 global
5939 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5940 When set, a forward slash is used when expanding file names. This is
5941 useful when a Unix-like shell is used instead of command.com or
5942 cmd.exe. Backward slashes can still be typed, but they are changed to
5943 forward slashes by Vim.
5944 Note that setting or resetting this option has no effect for some
5945 existing file names, thus this option needs to be set before opening
5946 any file for best results. This might change in the future.
5947 'shellslash' only works when a backslash can be used as a path
5948 separator. To test if this is so use: >
5949 if exists('+shellslash')
5950<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005951 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5952'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5953 global
5954 {not in Vi}
5955 When on, use temp files for shell commands. When off use a pipe.
5956 When using a pipe is not possible temp files are used anyway.
5957 Currently a pipe is only supported on Unix. You can check it with: >
5958 :if has("filterpipe")
5959< The advantage of using a pipe is that nobody can read the temp file
5960 and the 'shell' command does not need to support redirection.
5961 The advantage of using a temp file is that the file type and encoding
5962 can be detected.
5963 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5964 |FilterWritePost| autocommands event are not triggered when
5965 'shelltemp' is off.
5966
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967 *'shelltype'* *'st'*
5968'shelltype' 'st' number (default 0)
5969 global
5970 {not in Vi} {only for the Amiga}
5971 On the Amiga this option influences the way how the commands work
5972 which use a shell.
5973 0 and 1: always use the shell
5974 2 and 3: use the shell only to filter lines
5975 4 and 5: use shell only for ':sh' command
5976 When not using the shell, the command is executed directly.
5977
5978 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5979 1 and 3: use "shell cmd" to start external commands
5980
5981 *'shellxquote'* *'sxq'*
5982'shellxquote' 'sxq' string (default: "";
5983 for Win32, when 'shell' contains "sh"
5984 somewhere: "\""
5985 for Unix, when using system(): "\"")
5986 global
5987 {not in Vi}
5988 Quoting character(s), put around the command passed to the shell, for
5989 the "!" and ":!" commands. Includes the redirection. See
5990 'shellquote' to exclude the redirection. It's probably not useful
5991 to set both options.
5992 This is an empty string by default. Known to be useful for
5993 third-party shells when using the Win32 version, such as the MKS Korn
5994 Shell or bash, where it should be "\"". The default is adjusted
5995 according the value of 'shell', to reduce the need to set this option
5996 by the user. See |dos-shell|.
5997 This option cannot be set from a |modeline| or in the |sandbox|, for
5998 security reasons.
5999
6000 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6001'shiftround' 'sr' boolean (default off)
6002 global
6003 {not in Vi}
6004 Round indent to multiple of 'shiftwidth'. Applies to > and <
6005 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6006 a multiple of 'shiftwidth' (this is Vi compatible).
6007 NOTE: This option is reset when 'compatible' is set.
6008
6009 *'shiftwidth'* *'sw'*
6010'shiftwidth' 'sw' number (default 8)
6011 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006012 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 |'cindent'|, |>>|, |<<|, etc.
6014
6015 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006016'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6017 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018 global
6019 {not in Vi}
6020 This option helps to avoid all the |hit-enter| prompts caused by file
6021 messages, for example with CTRL-G, and to avoid some other messages.
6022 It is a list of flags:
6023 flag meaning when present ~
6024 f use "(3 of 5)" instead of "(file 3 of 5)"
6025 i use "[noeol]" instead of "[Incomplete last line]"
6026 l use "999L, 888C" instead of "999 lines, 888 characters"
6027 m use "[+]" instead of "[Modified]"
6028 n use "[New]" instead of "[New File]"
6029 r use "[RO]" instead of "[readonly]"
6030 w use "[w]" instead of "written" for file write message
6031 and "[a]" instead of "appended" for ':w >> file' command
6032 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6033 "[unix format]" and "[mac]" instead of "[mac format]".
6034 a all of the above abbreviations
6035
6036 o overwrite message for writing a file with subsequent message
6037 for reading a file (useful for ":wn" or when 'autowrite' on)
6038 O message for reading a file overwrites any previous message.
6039 Also for quickfix message (e.g., ":cn").
6040 s don't give "search hit BOTTOM, continuing at TOP" or "search
6041 hit TOP, continuing at BOTTOM" messages
6042 t truncate file message at the start if it is too long to fit
6043 on the command-line, "<" will appear in the left most column.
6044 Ignored in Ex mode.
6045 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006046 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006047 Ignored in Ex mode.
6048 W don't give "written" or "[w]" when writing a file
6049 A don't give the "ATTENTION" message when an existing swap file
6050 is found.
6051 I don't give the intro message when starting Vim |:intro|.
6052
6053 This gives you the opportunity to avoid that a change between buffers
6054 requires you to hit <Enter>, but still gives as useful a message as
6055 possible for the space available. To get the whole message that you
6056 would have got with 'shm' empty, use ":file!"
6057 Useful values:
6058 shm= No abbreviation of message.
6059 shm=a Abbreviation, but no loss of information.
6060 shm=at Abbreviation, and truncate message when necessary.
6061
6062 NOTE: This option is set to the Vi default value when 'compatible' is
6063 set and to the Vim default value when 'compatible' is reset.
6064
6065 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6066'shortname' 'sn' boolean (default off)
6067 local to buffer
6068 {not in Vi, not in MS-DOS versions}
6069 Filenames are assumed to be 8 characters plus one extension of 3
6070 characters. Multiple dots in file names are not allowed. When this
6071 option is on, dots in file names are replaced with underscores when
6072 adding an extension (".~" or ".swp"). This option is not available
6073 for MS-DOS, because then it would always be on. This option is useful
6074 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6075 or crossdos. When running the Win32 GUI version under Win32s, this
6076 option is always on by default.
6077
6078 *'showbreak'* *'sbr'* *E595*
6079'showbreak' 'sbr' string (default "")
6080 global
6081 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006082 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083 feature}
6084 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006085 values are "> " or "+++ ": >
6086 :set showbreak=>\
6087< Note the backslash to escape the trailing space. It's easier like
6088 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006089 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006090< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091 comma (in a future version the comma might be used to separate the
6092 part that is shown at the end and at the start of a line).
6093 The characters are highlighted according to the '@' flag in
6094 'highlight'.
6095 Note that tabs after the showbreak will be displayed differently.
6096 If you want the 'showbreak' to appear in between line numbers, add the
6097 "n" flag to 'cpoptions'.
6098
6099 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6100'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6101 off)
6102 global
6103 {not in Vi}
6104 {not available when compiled without the
6105 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006106 Show (partial) command in the last line of the screen. Set this
6107 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108 In Visual mode the size of the selected area is shown:
6109 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006110 If the number of bytes is different it is also displayed: "2-6"
6111 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006112 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006113 - When selecting a block, the size in screen characters:
6114 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006115 NOTE: This option is set to the Vi default value when 'compatible' is
6116 set and to the Vim default value when 'compatible' is reset.
6117
6118 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6119'showfulltag' 'sft' boolean (default off)
6120 global
6121 {not in Vi}
6122 When completing a word in insert mode (see |ins-completion|) from the
6123 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006124 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 matched a C function, you can see a template for what arguments are
6126 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006127 Note that this doesn't work well together with having "longest" in
6128 'completeopt', because the completion from the search pattern may not
6129 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006130
6131 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6132'showmatch' 'sm' boolean (default off)
6133 global
6134 When a bracket is inserted, briefly jump to the matching one. The
6135 jump is only done if the match can be seen on the screen. The time to
6136 show the match can be set with 'matchtime'.
6137 A Beep is given if there is no match (no matter if the match can be
6138 seen or not). This option is reset when the 'paste' option is set.
6139 When the 'm' flag is not included in 'cpoptions', typing a character
6140 will immediately move the cursor back to where it belongs.
6141 See the "sm" field in 'guicursor' for setting the cursor shape and
6142 blinking when showing the match.
6143 The 'matchpairs' option can be used to specify the characters to show
6144 matches for. 'rightleft' and 'revins' are used to look for opposite
6145 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006146 Also see the matchparen plugin for highlighting the match when moving
6147 around |pi_paren.txt|.
6148 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149
6150 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6151'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6152 global
6153 If in Insert, Replace or Visual mode put a message on the last line.
6154 Use the 'M' flag in 'highlight' to set the type of highlighting for
6155 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006156 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006157 doesn't mean XIM is really active, especially when 'imactivatekey' is
6158 not set.
6159 NOTE: This option is set to the Vi default value when 'compatible' is
6160 set and to the Vim default value when 'compatible' is reset.
6161
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006162 *'showtabline'* *'stal'*
6163'showtabline' 'stal' number (default 1)
6164 global
6165 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006166 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006167 feature}
6168 The value of this option specifies when the line with tab page labels
6169 will be displayed:
6170 0: never
6171 1: only if there are at least two tab pages
6172 2: always
6173 This is both for the GUI and non-GUI implementation of the tab pages
6174 line.
6175 See |tab-page| for more information about tab pages.
6176
Bram Moolenaar071d4272004-06-13 20:20:40 +00006177 *'sidescroll'* *'ss'*
6178'sidescroll' 'ss' number (default 0)
6179 global
6180 {not in Vi}
6181 The minimal number of columns to scroll horizontally. Used only when
6182 the 'wrap' option is off and the cursor is moved off of the screen.
6183 When it is zero the cursor will be put in the middle of the screen.
6184 When using a slow terminal set it to a large number or 0. When using
6185 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6186 commands.
6187
6188 *'sidescrolloff'* *'siso'*
6189'sidescrolloff' 'siso' number (default 0)
6190 global
6191 {not in Vi}
6192 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006193 right of the cursor if 'nowrap' is set. Setting this option to a
6194 value greater than 0 while having |'sidescroll'| also at a non-zero
6195 value makes some context visible in the line you are scrolling in
6196 horizontally (except at beginning of the line). Setting this option
6197 to a large value (like 999) has the effect of keeping the cursor
6198 horizontally centered in the window, as long as one does not come too
6199 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006200 NOTE: This option is set to 0 when 'compatible' is set.
6201
6202 Example: Try this together with 'sidescroll' and 'listchars' as
6203 in the following example to never allow the cursor to move
6204 onto the "extends" character:
6205
6206 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6207 :set sidescrolloff=1
6208
6209
6210 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6211'smartcase' 'scs' boolean (default off)
6212 global
6213 {not in Vi}
6214 Override the 'ignorecase' option if the search pattern contains upper
6215 case characters. Only used when the search pattern is typed and
6216 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006217 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6219 recalling the search pattern from history and hitting <Enter>.
6220 NOTE: This option is reset when 'compatible' is set.
6221
6222 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6223'smartindent' 'si' boolean (default off)
6224 local to buffer
6225 {not in Vi}
6226 {not available when compiled without the
6227 |+smartindent| feature}
6228 Do smart autoindenting when starting a new line. Works for C-like
6229 programs, but can also be used for other languages. 'cindent' does
6230 something like this, works better in most cases, but is more strict,
6231 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6232 'indentexpr' is a more advanced alternative.
6233 Normally 'autoindent' should also be on when using 'smartindent'.
6234 An indent is automatically inserted:
6235 - After a line ending in '{'.
6236 - After a line starting with a keyword from 'cinwords'.
6237 - Before a line starting with '}' (only with the "O" command).
6238 When typing '}' as the first character in a new line, that line is
6239 given the same indent as the matching '{'.
6240 When typing '#' as the first character in a new line, the indent for
6241 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006242 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6244 When using the ">>" command, lines starting with '#' are not shifted
6245 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006246 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 is set smart indenting is disabled.
6248
6249 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6250'smarttab' 'sta' boolean (default off)
6251 global
6252 {not in Vi}
6253 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006254 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6255 <BS> will delete a 'shiftwidth' worth of space at the start of the
6256 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006257 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006258 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6259 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006260 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006262 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263 NOTE: This option is reset when 'compatible' is set.
6264
6265 *'softtabstop'* *'sts'*
6266'softtabstop' 'sts' number (default 0)
6267 local to buffer
6268 {not in Vi}
6269 Number of spaces that a <Tab> counts for while performing editing
6270 operations, like inserting a <Tab> or using <BS>. It "feels" like
6271 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6272 used. This is useful to keep the 'ts' setting at its standard value
6273 of 8, while being able to edit like it is set to 'sts'. However,
6274 commands like "x" still work on the actual characters.
6275 When 'sts' is zero, this feature is off.
6276 'softtabstop' is set to 0 when the 'paste' option is set.
6277 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6278 spaces is minimized by using <Tab>s.
6279 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6280 set.
6281 NOTE: This option is set to 0 when 'compatible' is set.
6282
Bram Moolenaar217ad922005-03-20 22:37:15 +00006283 *'spell'* *'nospell'*
6284'spell' boolean (default off)
6285 local to window
6286 {not in Vi}
6287 {not available when compiled without the |+syntax|
6288 feature}
6289 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006290 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006291
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006292 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006293'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006294 local to buffer
6295 {not in Vi}
6296 {not available when compiled without the |+syntax|
6297 feature}
6298 Pattern to locate the end of a sentence. The following word will be
6299 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006300 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006301 When this check is not wanted make this option empty.
6302 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006303 Be careful with special characters, see |option-backslash| about
6304 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006305 To set this option automatically depending on the language, see
6306 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006307
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006308 *'spellfile'* *'spf'*
6309'spellfile' 'spf' string (default empty)
6310 local to buffer
6311 {not in Vi}
6312 {not available when compiled without the |+syntax|
6313 feature}
6314 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006315 commands. It must end in ".{encoding}.add". You need to include the
6316 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006317 *E765*
6318 It may also be a comma separated list of names. A count before the
6319 |zg| and |zw| commands can be used to access each. This allows using
6320 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006321 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006322 you: Using the first directory in 'runtimepath' that is writable. If
6323 there is no "spell" directory yet it will be created. For the file
6324 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006325 ignoring the region.
6326 The resulting ".spl" file will be used for spell checking, it does not
6327 have to appear in 'spelllang'.
6328 Normally one file is used for all regions, but you can add the region
6329 name if you want to. However, it will then only be used when
6330 'spellfile' is set to it, for entries in 'spelllang' only files
6331 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006332 This option cannot be set from a |modeline| or in the |sandbox|, for
6333 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006334
Bram Moolenaar217ad922005-03-20 22:37:15 +00006335 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006336'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006337 local to buffer
6338 {not in Vi}
6339 {not available when compiled without the |+syntax|
6340 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006341 A comma separated list of word list names. When the 'spell' option is
6342 on spellchecking will be done for these languages. Example: >
6343 set spelllang=en_us,nl,medical
6344< This means US English, Dutch and medical words are recognized. Words
6345 that are not recognized will be highlighted.
6346 The word list name must not include a comma or dot. Using a dash is
6347 recommended to separate the two letter language name from a
6348 specification. Thus "en-rare" is used for rare English words.
6349 A region name must come last and have the form "_xx", where "xx" is
6350 the two-letter, lower case region name. You can use more than one
6351 region by listing them: "en_us,en_ca" supports both US and Canadian
6352 English, but not words specific for Australia, New Zealand or Great
6353 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006354 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006355 As a special case the name of a .spl file can be given as-is. The
6356 first "_xx" in the name is removed and used as the region name
6357 (_xx is an underscore, two letters and followed by a non-letter).
6358 This is mainly for testing purposes. You must make sure the correct
6359 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006360 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006361 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6362 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006363 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006364
Bram Moolenaar98692072006-02-04 00:57:42 +00006365 If the |spellfile.vim| plugin is active and you use a language name
6366 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6367 will ask you if you want to download the file.
6368
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006369 After this option has been set successfully, Vim will source the files
6370 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006371 up to the first comma, dot or underscore.
6372 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006373
6374
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006375 *'spellsuggest'* *'sps'*
6376'spellsuggest' 'sps' string (default "best")
6377 global
6378 {not in Vi}
6379 {not available when compiled without the |+syntax|
6380 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006381 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006382 the |spellsuggest()| function. This is a comma-separated list of
6383 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006384
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006385 best Internal method that works best for English. Finds
6386 changes like "fast" and uses a bit of sound-a-like
6387 scoring to improve the ordering.
6388
6389 double Internal method that uses two methods and mixes the
6390 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006391 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006392 word. That only works when the language specifies
6393 sound folding. Can be slow and doesn't always give
6394 better results.
6395
6396 fast Internal method that only checks for simple changes:
6397 character inserts/deletes/swaps. Works well for
6398 simple typing mistakes.
6399
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006400 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006401 Not used for |spellsuggest()|. The number of
6402 suggestions is never more than the value of 'lines'
6403 minus two.
6404
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006405 file:{filename} Read file {filename}, which must have two columns,
6406 separated by a slash. The first column contains the
6407 bad word, the second column the suggested good word.
6408 Example:
6409 theribal/terrible ~
6410 Use this for common mistakes that do not appear at the
6411 top of the suggestion list with the internal methods.
6412 Lines without a slash are ignored, use this for
6413 comments.
6414 The file is used for all languages.
6415
6416 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6417 trouble with spaces. |v:val| holds the badly spelled
6418 word. The expression must evaluate to a List of
6419 Lists, each with a suggestion and a score.
6420 Example:
6421 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006422 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006423 internal methods use. A lower score is better.
6424 This may invoke |spellsuggest()| if you temporarily
6425 set 'spellsuggest' to exclude the "expr:" part.
6426 Errors are silently ignored, unless you set the
6427 'verbose' option to a non-zero value.
6428
6429 Only one of "best", "double" or "fast" may be used. The others may
6430 appear several times in any order. Example: >
6431 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6432<
6433 This option cannot be set from a |modeline| or in the |sandbox|, for
6434 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006435
6436
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6438'splitbelow' 'sb' boolean (default off)
6439 global
6440 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006441 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 feature}
6443 When on, splitting a window will put the new window below the current
6444 one. |:split|
6445
6446 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6447'splitright' 'spr' boolean (default off)
6448 global
6449 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006450 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 feature}
6452 When on, splitting a window will put the new window right of the
6453 current one. |:vsplit|
6454
6455 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6456'startofline' 'sol' boolean (default on)
6457 global
6458 {not in Vi}
6459 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006460 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006461 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006462 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 with a linewise operator, with "%" with a count and to buffer changing
6464 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6465 only has a line number, e.g., ":25" or ":+".
6466 In case of buffer changing commands the cursor is placed at the column
6467 where it was the last time the buffer was edited.
6468 NOTE: This option is set when 'compatible' is set.
6469
6470 *'statusline'* *'stl'* *E540* *E541* *E542*
6471'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006472 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 {not in Vi}
6474 {not available when compiled without the |+statusline|
6475 feature}
6476 When nonempty, this option determines the content of the status line.
6477 Also see |status-line|.
6478
6479 The option consists of printf style '%' items interspersed with
6480 normal text. Each status line item is of the form:
6481 %-0{minwid}.{maxwid}{item}
6482 All fields except the {item} is optional. A single percent sign can
6483 be given as "%%". Up to 80 items can be specified.
6484
Bram Moolenaar238a5642006-02-21 22:12:05 +00006485 When the option starts with "%!" then it is used as an expression,
6486 evaluated and the result is used as the option value. Example: >
6487 :set statusline=%!MyStatusLine()
6488< The result can contain %{} items that will be evaluated too.
6489
6490 When there is error while evaluating the option then it will be made
6491 empty to avoid further errors. Otherwise screen updating would loop.
6492
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493 Note that the only effect of 'ruler' when this option is set (and
6494 'laststatus' is 2) is controlling the output of |CTRL-G|.
6495
6496 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006497 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006499 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 minwid Minimum width of the item, padding as set by '-' & '0'.
6501 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006502 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 on the left for text items. Numeric items will be
6504 shifted down to maxwid-2 digits followed by '>'number
6505 where number is the amount of missing digits, much like
6506 an exponential notation.
6507 item A one letter code as described below.
6508
6509 Following is a description of the possible statusline items. The
6510 second character in "item" is the type:
6511 N for number
6512 S for string
6513 F for flags as described below
6514 - not applicable
6515
6516 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006517 f S Path to the file in the buffer, as typed or relative to current
6518 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 F S Full path to the file in the buffer.
6520 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006521 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006523 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006525 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006527 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006529 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6531 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006532 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6534 being used: "<keymap>"
6535 n N Buffer number.
6536 b N Value of byte under cursor.
6537 B N As above, in hexadecimal.
6538 o N Byte number in file of byte under cursor, first byte is 1.
6539 Mnemonic: Offset from start of file (with one added)
6540 {not available when compiled without |+byte_offset| feature}
6541 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006542 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543 l N Line number.
6544 L N Number of lines in buffer.
6545 c N Column number.
6546 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006547 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 p N Percentage through file in lines as in |CTRL-G|.
6549 P S Percentage through file of displayed window. This is like the
6550 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006551 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006552 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006553 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006554 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555 ( - Start of item group. Can be used for setting the width and
6556 alignment of a section. Must be followed by %) somewhere.
6557 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006558 T N For 'tabline': start of tab page N label. Use %T after the last
6559 label. This information is used for mouse clicks.
6560 X N For 'tabline': start of close tab N label. Use %X after the
6561 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6562 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 < - Where to truncate line if too long. Default is at the start.
6564 No width fields allowed.
6565 = - Separation point between left and right aligned items.
6566 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006567 # - Set highlight group. The name must follow and then a # again.
6568 Thus use %#HLname# for highlight group HLname. The same
6569 highlighting is used, also for the statusline of non-current
6570 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006572 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 The difference between User{N} and StatusLine will be applied
6574 to StatusLineNC for the statusline of non-current windows.
6575 The number N must be between 1 and 9. See |hl-User1..9|
6576
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006577 When displaying a flag, Vim removes the leading comma, if any, when
6578 that flag comes right after plaintext. This will make a nice display
6579 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580
Bram Moolenaar582fd852005-03-28 20:58:01 +00006581 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 not set) and a minwid is not set for the group, the whole group will
6583 become empty. This will make a group like the following disappear
6584 completely from the statusline when none of the flags are set. >
6585 :set statusline=...%(\ [%M%R%H]%)...
6586<
6587 Beware that an expression is evaluated each and every time the status
6588 line is displayed. The current buffer and current window will be set
6589 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006590 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006592 real current buffer.
6593
6594 The 'statusline' option may be evaluated in the |sandbox|, see
6595 |sandbox-option|.
6596
6597 It is not allowed to change text or jump to another window while
6598 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599
6600 If the statusline is not updated when you want it (e.g., after setting
6601 a variable that's used in an expression), you can force an update by
6602 setting an option without changing its value. Example: >
6603 :let &ro = &ro
6604
6605< A result of all digits is regarded a number for display purposes.
6606 Otherwise the result is taken as flag text and applied to the rules
6607 described above.
6608
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006609 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6611 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6612
6613 Examples:
6614 Emulate standard status line with 'ruler' set >
6615 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6616< Similar, but add ASCII value of char under the cursor (like "ga") >
6617 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6618< Display byte count and byte value, modified flag in red. >
6619 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6620 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6621< Display a ,GZ flag if a compressed file is loaded >
6622 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6623< In the |:autocmd|'s: >
6624 :let b:gzflag = 1
6625< And: >
6626 :unlet b:gzflag
6627< And define this function: >
6628 :function VarExists(var, val)
6629 : if exists(a:var) | return a:val | else | return '' | endif
6630 :endfunction
6631<
6632 *'suffixes'* *'su'*
6633'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6634 global
6635 {not in Vi}
6636 Files with these suffixes get a lower priority when multiple files
6637 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006638 suffixes. Spaces after the comma are ignored. A dot is also seen as
6639 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006640 separator, precede it with a backslash (see |option-backslash| about
6641 including spaces and backslashes).
6642 See 'wildignore' for completely ignoring files.
6643 The use of |:set+=| and |:set-=| is preferred when adding or removing
6644 suffixes from the list. This avoids problems when a future version
6645 uses another default.
6646
6647 *'suffixesadd'* *'sua'*
6648'suffixesadd' 'sua' string (default "")
6649 local to buffer
6650 {not in Vi}
6651 {not available when compiled without the
6652 |+file_in_path| feature}
6653 Comma separated list of suffixes, which are used when searching for a
6654 file for the "gf", "[I", etc. commands. Example: >
6655 :set suffixesadd=.java
6656<
6657 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6658'swapfile' 'swf' boolean (default on)
6659 local to buffer
6660 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006661 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 swapfile is not wanted for a specific buffer. For example, with
6663 confidential information that even root must not be able to access.
6664 Careful: All text will be in memory:
6665 - Don't use this for big files.
6666 - Recovery will be impossible!
6667 A swapfile will only be present when |'updatecount'| is non-zero and
6668 'swapfile' is set.
6669 When 'swapfile' is reset, the swap file for the current buffer is
6670 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6671 non-zero, a swap file is immediately created.
6672 Also see |swap-file| and |'swapsync'|.
6673
6674 This option is used together with 'bufhidden' and 'buftype' to
6675 specify special kinds of buffers. See |special-buffers|.
6676
6677 *'swapsync'* *'sws'*
6678'swapsync' 'sws' string (default "fsync")
6679 global
6680 {not in Vi}
6681 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006682 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 When this option is empty parts of the swap file may be in memory and
6684 not written to disk. When the system crashes you may lose more work.
6685 On Unix the system does a sync now and then without Vim asking for it,
6686 so the disadvantage of setting this option off is small. On some
6687 systems the swap file will not be written at all. For a unix system
6688 setting it to "sync" will use the sync() call instead of the default
6689 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006690 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006691
6692 *'switchbuf'* *'swb'*
6693'switchbuf' 'swb' string (default "")
6694 global
6695 {not in Vi}
6696 This option controls the behavior when switching between buffers.
6697 Possible values (comma separated list):
6698 useopen If included, jump to the first open window that
6699 contains the specified buffer (if there is one).
6700 Otherwise: Do not examine other windows.
6701 This setting is checked with |quickfix| commands, when
6702 jumping to errors (":cc", ":cn", "cp", etc.). It is
6703 also used in all buffer related split commands, for
6704 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006705 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006706 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006708 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006710 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006711 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006713 *'synmaxcol'* *'smc'*
6714'synmaxcol' 'smc' number (default 3000)
6715 local to buffer
6716 {not in Vi}
6717 {not available when compiled without the |+syntax|
6718 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006719 Maximum column in which to search for syntax items. In long lines the
6720 text after this column is not highlighted and following lines may not
6721 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006722 This helps to avoid very slow redrawing for an XML file that is one
6723 long line.
6724 Set to zero to remove the limit.
6725
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726 *'syntax'* *'syn'*
6727'syntax' 'syn' string (default empty)
6728 local to buffer
6729 {not in Vi}
6730 {not available when compiled without the |+syntax|
6731 feature}
6732 When this option is set, the syntax with this name is loaded, unless
6733 syntax highlighting has been switched off with ":syntax off".
6734 Otherwise this option does not always reflect the current syntax (the
6735 b:current_syntax variable does).
6736 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006737 not automatically recognized. Example, in an IDL file:
6738 /* vim: set syntax=idl : */ ~
6739 When a dot appears in the value then this separates two filetype
6740 names. Example:
6741 /* vim: set syntax=c.doxygen : */ ~
6742 This will use the "c" syntax first, then the "doxygen" syntax.
6743 Note that the second one must be prepared to be loaded as an addition,
6744 otherwise it will be skipped. More than one dot may appear.
6745 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746 :set syntax=OFF
6747< To switch syntax highlighting on according to the current value of the
6748 'filetype' option: >
6749 :set syntax=ON
6750< What actually happens when setting the 'syntax' option is that the
6751 Syntax autocommand event is triggered with the value as argument.
6752 This option is not copied to another buffer, independent of the 's' or
6753 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006754 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006756 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006757'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006758 global
6759 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006760 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006761 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006762 When nonempty, this option determines the content of the tab pages
6763 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006764 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006765
6766 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006767 option and only when there is no GUI tab line. When 'e' is in
6768 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006769 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006770
6771 The value is evaluated like with 'statusline'. You can use
6772 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006773 the text to be displayed. Use "%1T" for the first label, "%2T" for
6774 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006775
6776 Keep in mind that only one of the tab pages is the current one, others
6777 are invisible and you can't jump to their windows.
6778
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006779
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006780 *'tabpagemax'* *'tpm'*
6781'tabpagemax' 'tpm' number (default 10)
6782 global
6783 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006784 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006785 feature}
6786 Maximum number of tab pages to be opened by the |-p| command line
6787 argument or the ":tab all" command. |tabpage|
6788
6789
6790 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791'tabstop' 'ts' number (default 8)
6792 local to buffer
6793 Number of spaces that a <Tab> in the file counts for. Also see
6794 |:retab| command, and 'softtabstop' option.
6795
6796 Note: Setting 'tabstop' to any other value than 8 can make your file
6797 appear wrong in many places (e.g., when printing it).
6798
6799 There are four main ways to use tabs in Vim:
6800 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6801 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006802 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803 behave like a tab appears every 4 (or 3) characters.
6804 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6805 'expandtab'. This way you will always insert spaces. The
6806 formatting will never be messed up when 'tabstop' is changed.
6807 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006808 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 works when using Vim to edit the file.
6810 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6811 'noexpandtab'. This should then work (for initial indents only)
6812 for any tabstop setting that people use. It might be nice to have
6813 tabs after the first non-blank inserted as spaces if you do this
6814 though. Otherwise aligned comments will be wrong when 'tabstop' is
6815 changed.
6816
6817 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6818'tagbsearch' 'tbs' boolean (default on)
6819 global
6820 {not in Vi}
6821 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006822 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 searching makes searching for a tag a LOT faster, but a linear search
6824 will find more tags if the tags file wasn't properly sorted.
6825 Vim normally assumes that your tags files are sorted, or indicate that
6826 they are not sorted. Only when this is not the case does the
6827 'tagbsearch' option need to be switched off.
6828
6829 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006830 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 certain files, or retry all files with a linear search. When
6832 'tagbsearch' is off, only a linear search is done.
6833
6834 Linear searching is done anyway, for one file, when Vim finds a line
6835 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006836 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837< [The whitespace before and after the '0' must be a single <Tab>]
6838
6839 When a binary search was done and no match was found in any of the
6840 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6841 instead of a normal tag name, a retry is done with a linear search.
6842 Tags in unsorted tags files, and matches with different case will only
6843 be found in the retry.
6844
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006845 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 linear search can be avoided for the 'ignorecase' case. Use a value
6847 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6848 case-fold sorted with the -f switch to "sort" in most unices, as in
6849 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006850 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6851 for this as well. Note that case must be folded to uppercase for this
6852 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853
6854 When 'tagbsearch' is off, tags searching is slower when a full match
6855 exists, but faster when no full match exists. Tags in unsorted tags
6856 files may only be found with 'tagbsearch' off.
6857 When the tags file is not sorted, or sorted in a wrong way (not on
6858 ASCII byte value), 'tagbsearch' should be off, or the line given above
6859 must be included in the tags file.
6860 This option doesn't affect commands that find all matching tags (e.g.,
6861 command-line completion and ":help").
6862 {Vi: always uses binary search in some versions}
6863
6864 *'taglength'* *'tl'*
6865'taglength' 'tl' number (default 0)
6866 global
6867 If non-zero, tags are significant up to this number of characters.
6868
6869 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6870'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6871 global
6872 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006873 If on and using a tags file in another directory, file names in that
6874 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875 NOTE: This option is set to the Vi default value when 'compatible' is
6876 set and to the Vim default value when 'compatible' is reset.
6877
6878 *'tags'* *'tag'* *E433*
6879'tags' 'tag' string (default "./tags,tags", when compiled with
6880 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6881 global or local to buffer |global-local|
6882 Filenames for the tag command, separated by spaces or commas. To
6883 include a space or comma in a file name, precede it with a backslash
6884 (see |option-backslash| about including spaces and backslashes).
6885 When a file name starts with "./", the '.' is replaced with the path
6886 of the current file. But only when the 'd' flag is not included in
6887 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6888 |tags-option|.
6889 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02006890 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
6891 find all files named "tags" below "/lib". The filename itself cannot
6892 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
6893 files called "tags?". {not available when compiled without the
6894 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006895 The |tagfiles()| function can be used to get a list of the file names
6896 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6898 files are also supported. They are automatically recognized. The
6899 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6900 differences are ignored (MS-Windows). |emacs-tags|
6901 The use of |:set+=| and |:set-=| is preferred when adding or removing
6902 file names from the list. This avoids problems when a future version
6903 uses another default.
6904 {Vi: default is "tags /usr/lib/tags"}
6905
6906 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6907'tagstack' 'tgst' boolean (default on)
6908 global
6909 {not in all versions of Vi}
6910 When on, the |tagstack| is used normally. When off, a ":tag" or
6911 ":tselect" command with an argument will not push the tag onto the
6912 tagstack. A following ":tag" without an argument, a ":pop" command or
6913 any other command that uses the tagstack will use the unmodified
6914 tagstack, but does change the pointer to the active entry.
6915 Resetting this option is useful when using a ":tag" command in a
6916 mapping which should not change the tagstack.
6917
6918 *'term'* *E529* *E530* *E531*
6919'term' string (default is $TERM, if that fails:
6920 in the GUI: "builtin_gui"
6921 on Amiga: "amiga"
6922 on BeOS: "beos-ansi"
6923 on Mac: "mac-ansi"
6924 on MiNT: "vt52"
6925 on MS-DOS: "pcterm"
6926 on OS/2: "os2ansi"
6927 on Unix: "ansi"
6928 on VMS: "ansi"
6929 on Win 32: "win32")
6930 global
6931 Name of the terminal. Used for choosing the terminal control
6932 characters. Environment variables are expanded |:set_env|.
6933 For example: >
6934 :set term=$TERM
6935< See |termcap|.
6936
6937 *'termbidi'* *'tbidi'*
6938 *'notermbidi'* *'notbidi'*
6939'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6940 global
6941 {not in Vi}
6942 {only available when compiled with the |+arabic|
6943 feature}
6944 The terminal is in charge of Bi-directionality of text (as specified
6945 by Unicode). The terminal is also expected to do the required shaping
6946 that some languages (such as Arabic) require.
6947 Setting this option implies that 'rightleft' will not be set when
6948 'arabic' is set and the value of 'arabicshape' will be ignored.
6949 Note that setting 'termbidi' has the immediate effect that
6950 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6951 This option is reset when the GUI is started.
6952 For further details see |arabic.txt|.
6953
6954 *'termencoding'* *'tenc'*
6955'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6956 Macintosh GUI: "macroman")
6957 global
6958 {only available when compiled with the |+multi_byte|
6959 feature}
6960 {not in Vi}
6961 Encoding used for the terminal. This specifies what character
6962 encoding the keyboard produces and the display will understand. For
6963 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006964 display). Except for the Mac when 'macatsui' is off, then
6965 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 In the Win32 console version the default value is the console codepage
6967 when it differs from the ANSI codepage.
6968 *E617*
6969 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6970 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6971 Any attempts to set a different value will be rejected, and an error
6972 message is shown.
6973 For the Win32 GUI 'termencoding' is not used for typed characters,
6974 because the Win32 system always passes Unicode characters.
6975 When empty, the same encoding is used as for the 'encoding' option.
6976 This is the normal value.
6977 Not all combinations for 'termencoding' and 'encoding' are valid. See
6978 |encoding-table|.
6979 The value for this option must be supported by internal conversions or
6980 iconv(). When this is not possible no conversion will be done and you
6981 will probably experience problems with non-ASCII characters.
6982 Example: You are working with the locale set to euc-jp (Japanese) and
6983 want to edit a UTF-8 file: >
6984 :let &termencoding = &encoding
6985 :set encoding=utf-8
6986< You need to do this when your system has no locale support for UTF-8.
6987
6988 *'terse'* *'noterse'*
6989'terse' boolean (default off)
6990 global
6991 When set: Add 's' flag to 'shortmess' option (this makes the message
6992 for a search that hits the start or end of the file not being
6993 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6994 shortens a lot of messages}
6995
6996 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6997'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6998 global
6999 {not in Vi}
7000 This option is obsolete. Use 'fileformats'.
7001 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7002 set to the default value for the current system. When 'textauto' is
7003 reset, 'fileformats' is made empty.
7004 NOTE: This option is set to the Vi default value when 'compatible' is
7005 set and to the Vim default value when 'compatible' is reset.
7006
7007 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7008'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7009 others: default off)
7010 local to buffer
7011 {not in Vi}
7012 This option is obsolete. Use 'fileformat'.
7013 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7014 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7015 "unix".
7016
7017 *'textwidth'* *'tw'*
7018'textwidth' 'tw' number (default 0)
7019 local to buffer
7020 {not in Vi}
7021 Maximum width of text that is being inserted. A longer line will be
7022 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007023 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7024 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007026 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027 NOTE: This option is set to 0 when 'compatible' is set.
7028
7029 *'thesaurus'* *'tsr'*
7030'thesaurus' 'tsr' string (default "")
7031 global or local to buffer |global-local|
7032 {not in Vi}
7033 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007034 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 the file should contain words with similar meaning, separated by
7036 non-keyword characters (white space is preferred). Maximum line
7037 length is 510 bytes.
7038 To obtain a file to be used here, check out the wordlist FAQ at
7039 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007040 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041 after a comma are ignored, otherwise spaces are included in the file
7042 name. See |option-backslash| about using backslashes.
7043 The use of |:set+=| and |:set-=| is preferred when adding or removing
7044 directories from the list. This avoids problems when a future version
7045 uses another default.
7046 Backticks cannot be used in this option for security reasons.
7047
7048 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7049'tildeop' 'top' boolean (default off)
7050 global
7051 {not in Vi}
7052 When on: The tilde command "~" behaves like an operator.
7053 NOTE: This option is reset when 'compatible' is set.
7054
7055 *'timeout'* *'to'* *'notimeout'* *'noto'*
7056'timeout' 'to' boolean (default on)
7057 global
7058 *'ttimeout'* *'nottimeout'*
7059'ttimeout' boolean (default off)
7060 global
7061 {not in Vi}
7062 These two options together determine the behavior when part of a
7063 mapped key sequence or keyboard code has been received:
7064
7065 'timeout' 'ttimeout' action ~
7066 off off do not time out
7067 on on or off time out on :mappings and key codes
7068 off on time out on key codes
7069
7070 If both options are off, Vim will wait until either the complete
7071 mapping or key sequence has been received, or it is clear that there
7072 is no mapping or key sequence for the received characters. For
7073 example: if you have mapped "vl" and Vim has received 'v', the next
7074 character is needed to see if the 'v' is followed by an 'l'.
7075 When one of the options is on, Vim will wait for about 1 second for
7076 the next character to arrive. After that the already received
7077 characters are interpreted as single characters. The waiting time can
7078 be changed with the 'timeoutlen' option.
7079 On slow terminals or very busy systems timing out may cause
7080 malfunctioning cursor keys. If both options are off, Vim waits
7081 forever after an entered <Esc> if there are key codes that start
7082 with <Esc>. You will have to type <Esc> twice. If you do not have
7083 problems with key codes, but would like to have :mapped key
7084 sequences not timing out in 1 second, set the 'ttimeout' option and
7085 reset the 'timeout' option.
7086
7087 NOTE: 'ttimeout' is reset when 'compatible' is set.
7088
7089 *'timeoutlen'* *'tm'*
7090'timeoutlen' 'tm' number (default 1000)
7091 global
7092 {not in all versions of Vi}
7093 *'ttimeoutlen'* *'ttm'*
7094'ttimeoutlen' 'ttm' number (default -1)
7095 global
7096 {not in Vi}
7097 The time in milliseconds that is waited for a key code or mapped key
7098 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7099 when part of a command has been typed.
7100 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7101 different timeout value for key codes is desired set 'ttimeoutlen' to
7102 a non-negative number.
7103
7104 ttimeoutlen mapping delay key code delay ~
7105 < 0 'timeoutlen' 'timeoutlen'
7106 >= 0 'timeoutlen' 'ttimeoutlen'
7107
7108 The timeout only happens when the 'timeout' and 'ttimeout' options
7109 tell so. A useful setting would be >
7110 :set timeout timeoutlen=3000 ttimeoutlen=100
7111< (time out on mapping after three seconds, time out on key codes after
7112 a tenth of a second).
7113
7114 *'title'* *'notitle'*
7115'title' boolean (default off, on when title can be restored)
7116 global
7117 {not in Vi}
7118 {not available when compiled without the |+title|
7119 feature}
7120 When on, the title of the window will be set to the value of
7121 'titlestring' (if it is not empty), or to:
7122 filename [+=-] (path) - VIM
7123 Where:
7124 filename the name of the file being edited
7125 - indicates the file cannot be modified, 'ma' off
7126 + indicates the file was modified
7127 = indicates the file is read-only
7128 =+ indicates the file is read-only and modified
7129 (path) is the path of the file being edited
7130 - VIM the server name |v:servername| or "VIM"
7131 Only works if the terminal supports setting window titles
7132 (currently Amiga console, Win32 console, all GUI versions and
7133 terminals with a non- empty 't_ts' option - these are Unix xterm and
7134 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7135 *X11*
7136 When Vim was compiled with HAVE_X11 defined, the original title will
7137 be restored if possible. The output of ":version" will include "+X11"
7138 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7139 works for the icon name |'icon'|.
7140 But: When Vim was started with the |-X| argument, restoring the title
7141 will not work (except in the GUI).
7142 If the title cannot be restored, it is set to the value of 'titleold'.
7143 You might want to restore the title outside of Vim then.
7144 When using an xterm from a remote machine you can use this command:
7145 rsh machine_name xterm -display $DISPLAY &
7146 then the WINDOWID environment variable should be inherited and the
7147 title of the window should change back to what it should be after
7148 exiting Vim.
7149
7150 *'titlelen'*
7151'titlelen' number (default 85)
7152 global
7153 {not in Vi}
7154 {not available when compiled without the |+title|
7155 feature}
7156 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007157 title. When the title is longer, only the end of the path name is
7158 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 Using a percentage makes this adapt to the width of the window. But
7160 it won't work perfectly, because the actual number of characters
7161 available also depends on the font used and other things in the title
7162 bar. When 'titlelen' is zero the full path is used. Otherwise,
7163 values from 1 to 30000 percent can be used.
7164 'titlelen' is also used for the 'titlestring' option.
7165
7166 *'titleold'*
7167'titleold' string (default "Thanks for flying Vim")
7168 global
7169 {not in Vi}
7170 {only available when compiled with the |+title|
7171 feature}
7172 This option will be used for the window title when exiting Vim if the
7173 original title cannot be restored. Only happens if 'title' is on or
7174 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007175 This option cannot be set from a |modeline| or in the |sandbox|, for
7176 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 *'titlestring'*
7178'titlestring' string (default "")
7179 global
7180 {not in Vi}
7181 {not available when compiled without the |+title|
7182 feature}
7183 When this option is not empty, it will be used for the title of the
7184 window. This happens only when the 'title' option is on.
7185 Only works if the terminal supports setting window titles (currently
7186 Amiga console, Win32 console, all GUI versions and terminals with a
7187 non-empty 't_ts' option).
7188 When Vim was compiled with HAVE_X11 defined, the original title will
7189 be restored if possible |X11|.
7190 When this option contains printf-style '%' items, they will be
7191 expanded according to the rules used for 'statusline'.
7192 Example: >
7193 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7194 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7195< The value of 'titlelen' is used to align items in the middle or right
7196 of the available space.
7197 Some people prefer to have the file name first: >
7198 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7199< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007200 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201 separating space only when needed.
7202 NOTE: Use of special characters in 'titlestring' may cause the display
7203 to be garbled (e.g., when it contains a CR or NL character).
7204 {not available when compiled without the |+statusline| feature}
7205
7206 *'toolbar'* *'tb'*
7207'toolbar' 'tb' string (default "icons,tooltips")
7208 global
7209 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7210 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007211 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212 possible values are:
7213 icons Toolbar buttons are shown with icons.
7214 text Toolbar buttons shown with text.
7215 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007216 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 tooltips Tooltips are active for toolbar buttons.
7218 Tooltips refer to the popup help text which appears after the mouse
7219 cursor is placed over a toolbar button for a brief moment.
7220
7221 If you want the toolbar to be shown with icons as well as text, do the
7222 following: >
7223 :set tb=icons,text
7224< Motif and Athena cannot display icons and text at the same time. They
7225 will show icons if both are requested.
7226
7227 If none of the strings specified in 'toolbar' are valid or if
7228 'toolbar' is empty, this option is ignored. If you want to disable
7229 the toolbar, you need to set the 'guioptions' option. For example: >
7230 :set guioptions-=T
7231< Also see |gui-toolbar|.
7232
7233 *'toolbariconsize'* *'tbis'*
7234'toolbariconsize' 'tbis' string (default "small")
7235 global
7236 {not in Vi}
7237 {only in the GTK+ 2 GUI}
7238 Controls the size of toolbar icons. The possible values are:
7239 tiny Use tiny toolbar icons.
7240 small Use small toolbar icons (default).
7241 medium Use medium-sized toolbar icons.
7242 large Use large toolbar icons.
7243 The exact dimensions in pixels of the various icon sizes depend on
7244 the current theme. Common dimensions are large=32x32, medium=24x24,
7245 small=20x20 and tiny=16x16.
7246
7247 If 'toolbariconsize' is empty, the global default size as determined
7248 by user preferences or the current theme is used.
7249
7250 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7251'ttybuiltin' 'tbi' boolean (default on)
7252 global
7253 {not in Vi}
7254 When on, the builtin termcaps are searched before the external ones.
7255 When off the builtin termcaps are searched after the external ones.
7256 When this option is changed, you should set the 'term' option next for
7257 the change to take effect, for example: >
7258 :set notbi term=$TERM
7259< See also |termcap|.
7260 Rationale: The default for this option is "on", because the builtin
7261 termcap entries are generally better (many systems contain faulty
7262 xterm entries...).
7263
7264 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7265'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7266 sun-cmd, screen, rxvt, dtterm or
7267 iris-ansi; also on when running Vim in
7268 a DOS console)
7269 global
7270 {not in Vi}
7271 Indicates a fast terminal connection. More characters will be sent to
7272 the screen for redrawing, instead of using insert/delete line
7273 commands. Improves smoothness of redrawing when there are multiple
7274 windows and the terminal does not support a scrolling region.
7275 Also enables the extra writing of characters at the end of each screen
7276 line for lines that wrap. This helps when using copy/paste with the
7277 mouse in an xterm and other terminals.
7278
7279 *'ttymouse'* *'ttym'*
7280'ttymouse' 'ttym' string (default depends on 'term')
7281 global
7282 {not in Vi}
7283 {only in Unix and VMS, doesn't work in the GUI; not
7284 available when compiled without |+mouse|}
7285 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007286 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287 *xterm-mouse*
7288 xterm xterm-like mouse handling. The mouse generates
7289 "<Esc>[Mscr", where "scr" is three bytes:
7290 "s" = button state
7291 "c" = column plus 33
7292 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007293 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007294 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007295 xterm2 Works like "xterm", but with the xterm reporting the
7296 mouse position while the mouse is dragged. This works
7297 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007298 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007299 work. See below for how Vim detects this
7300 automatically.
7301 *netterm-mouse*
7302 netterm NetTerm mouse handling. The mouse generates
7303 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7304 for the row and column.
7305 *dec-mouse*
7306 dec DEC terminal mouse handling. The mouse generates a
7307 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007308 This is also available for an Xterm, if it was
7309 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310 *jsbterm-mouse*
7311 jsbterm JSB term mouse handling.
7312 *pterm-mouse*
7313 pterm QNX pterm mouse handling.
7314
7315 The mouse handling must be enabled at compile time |+mouse_xterm|
7316 |+mouse_dec| |+mouse_netterm|.
7317 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7318 recognized, if enabled at compile time. DEC terminal mouse codes
7319 are recognized if enabled at compile time, and 'ttymouse' is not
7320 "xterm" (because the xterm and dec mouse codes conflict).
7321 This option is automatically set to "xterm", when the 'term' option is
7322 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7323 or "xterm2" already. The main use of this option is to set it to
7324 "xterm", when the terminal name doesn't start with "xterm", but it can
7325 handle xterm mouse codes.
7326 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007327 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007328 feature and if |t_RV| is set to the escape sequence to request the
7329 xterm version number. Otherwise "xterm2" must be set explicitly.
7330 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7331 t_RV to an empty string: >
7332 :set t_RV=
7333<
7334 *'ttyscroll'* *'tsl'*
7335'ttyscroll' 'tsl' number (default 999)
7336 global
7337 Maximum number of lines to scroll the screen. If there are more lines
7338 to scroll the window is redrawn. For terminals where scrolling is
7339 very slow and redrawing is not slow this can be set to a small number,
7340 e.g., 3, to speed up displaying.
7341
7342 *'ttytype'* *'tty'*
7343'ttytype' 'tty' string (default from $TERM)
7344 global
7345 Alias for 'term', see above.
7346
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007347 *'undodir'* *'udir'*
7348'undodir' 'udir' string (default ".")
7349 global
7350 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007351 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007352 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007353 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007354 "." means using the directory of the file. The undo file name for
7355 "file.txt" is ".file.txt.un~".
7356 For other directories the file name is the full path of the edited
7357 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007358 When writing: The first directory that exists is used. "." always
7359 works, no directories after "." will be used for writing.
7360 When reading all entries are tried to find an undo file. The first
7361 undo file that exists is used. When it cannot be read an error is
7362 given, no further entry is used.
7363 See |undo-persistence|.
7364
7365 *'undofile'* *'udf'*
7366'undofile' 'udf' boolean (default off)
7367 local to buffer
7368 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007369 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007370 When on, Vim automatically saves undo history to an undo file when
7371 writing a buffer to a file, and restores undo history from the same
7372 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007373 The directory where the undo file is stored is specified by 'undodir'.
7374 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007375 The undo file is not read when 'undoreload' causes the buffer from
7376 before a reload to be saved for undo.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007377 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007378
Bram Moolenaar071d4272004-06-13 20:20:40 +00007379 *'undolevels'* *'ul'*
7380'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7381 Win32 and OS/2)
7382 global
7383 {not in Vi}
7384 Maximum number of changes that can be undone. Since undo information
7385 is kept in memory, higher numbers will cause more memory to be used
7386 (nevertheless, a single change can use an unlimited amount of memory).
7387 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7388 itself: >
7389 set ul=0
7390< But you can also get Vi compatibility by including the 'u' flag in
7391 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007392 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393 Set to a negative number for no undo at all: >
7394 set ul=-1
7395< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007396 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007398 *'undoreload'* *'ur'*
7399'undoreload' 'ur' number (default 10000)
7400 global
7401 {not in Vi}
7402 Save the whole buffer for undo when reloading it. This applies to the
7403 ":e!" command and reloading for when the buffer changed outside of
7404 Vim. |FileChangedShell|
7405 The save only happens when this options is negative or when the number
7406 of lines is smaller than the value of this option.
7407 Set this option to zero to disable undo for a reload.
7408
7409 When saving undo for a reload, any undo file is not read.
7410
7411 Note that this causes the whole buffer to be stored in memory. Set
7412 this option to a lower value if you run out of memory.
7413
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 *'updatecount'* *'uc'*
7415'updatecount' 'uc' number (default: 200)
7416 global
7417 {not in Vi}
7418 After typing this many characters the swap file will be written to
7419 disk. When zero, no swap file will be created at all (see chapter on
7420 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7421 Vim with the "-n" option, see |startup|. When editing in readonly
7422 mode this option will be initialized to 10000.
7423 The swapfile can be disabled per buffer with |'swapfile'|.
7424 When 'updatecount' is set from zero to non-zero, swap files are
7425 created for all buffers that have 'swapfile' set. When 'updatecount'
7426 is set to zero, existing swap files are not deleted.
7427 Also see |'swapsync'|.
7428 This option has no meaning in buffers where |'buftype'| is "nofile"
7429 or "nowrite".
7430
7431 *'updatetime'* *'ut'*
7432'updatetime' 'ut' number (default 4000)
7433 global
7434 {not in Vi}
7435 If this many milliseconds nothing is typed the swap file will be
7436 written to disk (see |crash-recovery|). Also used for the
7437 |CursorHold| autocommand event.
7438
7439 *'verbose'* *'vbs'*
7440'verbose' 'vbs' number (default 0)
7441 global
7442 {not in Vi, although some versions have a boolean
7443 verbose option}
7444 When bigger than zero, Vim will give messages about what it is doing.
7445 Currently, these messages are given:
7446 >= 1 When the viminfo file is read or written.
7447 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007448 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 >= 8 Files for which a group of autocommands is executed.
7450 >= 9 Every executed autocommand.
7451 >= 12 Every executed function.
7452 >= 13 When an exception is thrown, caught, finished, or discarded.
7453 >= 14 Anything pending in a ":finally" clause.
7454 >= 15 Every executed Ex command (truncated at 200 characters).
7455
7456 This option can also be set with the "-V" argument. See |-V|.
7457 This option is also set by the |:verbose| command.
7458
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007459 When the 'verbosefile' option is set then the verbose messages are not
7460 displayed.
7461
7462 *'verbosefile'* *'vfile'*
7463'verbosefile' 'vfile' string (default empty)
7464 global
7465 {not in Vi}
7466 When not empty all messages are written in a file with this name.
7467 When the file exists messages are appended.
7468 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007469 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007470 Setting 'verbosefile' to a new value is like making it empty first.
7471 The difference with |:redir| is that verbose messages are not
7472 displayed when 'verbosefile' is set.
7473
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474 *'viewdir'* *'vdir'*
7475'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7476 "$VIM/vimfiles/view",
7477 for Unix: "~/.vim/view",
7478 for Macintosh: "$VIM:vimfiles:view"
7479 for VMS: "sys$login:vimfiles/view"
7480 for RiscOS: "Choices:vimfiles/view")
7481 global
7482 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007483 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484 feature}
7485 Name of the directory where to store files for |:mkview|.
7486 This option cannot be set from a |modeline| or in the |sandbox|, for
7487 security reasons.
7488
7489 *'viewoptions'* *'vop'*
7490'viewoptions' 'vop' string (default: "folds,options,cursor")
7491 global
7492 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007493 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494 feature}
7495 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007496 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007497 word save and restore ~
7498 cursor cursor position in file and in window
7499 folds manually created folds, opened/closed folds and local
7500 fold options
7501 options options and mappings local to a window or buffer (not
7502 global values for local options)
7503 slash backslashes in file names replaced with forward
7504 slashes
7505 unix with Unix end-of-line format (single <NL>), even when
7506 on Windows or DOS
7507
7508 "slash" and "unix" are useful on Windows when sharing view files
7509 with Unix. The Unix version of Vim cannot source dos format scripts,
7510 but the Windows version of Vim can source unix format scripts.
7511
7512 *'viminfo'* *'vi'* *E526* *E527* *E528*
7513'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007514 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7515 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7516 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517 global
7518 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007519 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520 feature}
7521 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007522 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523 separated list of parameters, each consisting of a single character
7524 identifying the particular parameter, followed by a number or string
7525 which specifies the value of that parameter. If a particular
7526 character is left out, then the default value is used for that
7527 parameter. The following is a list of the identifying characters and
7528 the effect of their value.
7529 CHAR VALUE ~
7530 ! When included, save and restore global variables that start
7531 with an uppercase letter, and don't contain a lowercase
7532 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007533 and "_K_L_M" are not. Only String and Number types are
7534 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535 " Maximum number of lines saved for each register. Old name of
7536 the '<' item, with the disadvantage that you need to put a
7537 backslash before the ", otherwise it will be recognized as the
7538 start of a comment!
7539 % When included, save and restore the buffer list. If Vim is
7540 started with a file name argument, the buffer list is not
7541 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007542 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007543 without a file name and buffers for help files are not written
7544 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007545 When followed by a number, the number specifies the maximum
7546 number of buffers that are stored. Without a number all
7547 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548 ' Maximum number of previously edited files for which the marks
7549 are remembered. This parameter must always be included when
7550 'viminfo' is non-empty.
7551 Including this item also means that the |jumplist| and the
7552 |changelist| are stored in the viminfo file.
7553 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007554 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007555 patterns are also saved. When not included, the value of
7556 'history' is used.
7557 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007558 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007559 < Maximum number of lines saved for each register. If zero then
7560 registers are not saved. When not included, all lines are
7561 saved. '"' is the old name for this item.
7562 Also see the 's' item below: limit specified in Kbyte.
7563 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007564 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007565 c When included, convert the text in the viminfo file from the
7566 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007567 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 f Whether file marks need to be stored. If zero, file marks ('0
7569 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007570 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007571 cursor position (when exiting or when doing ":wviminfo").
7572 h Disable the effect of 'hlsearch' when loading the viminfo
7573 file. When not included, it depends on whether ":nohlsearch"
7574 has been used since the last search command.
7575 n Name of the viminfo file. The name must immediately follow
7576 the 'n'. Must be the last one! If the "-i" argument was
7577 given when starting Vim, that file name overrides the one
7578 given here with 'viminfo'. Environment variables are expanded
7579 when opening the file, not when setting the option.
7580 r Removable media. The argument is a string (up to the next
7581 ','). This parameter can be given several times. Each
7582 specifies the start of a path for which no marks will be
7583 stored. This is to avoid removable media. For MS-DOS you
7584 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7585 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7586 ignored. Maximum length of each 'r' argument is 50
7587 characters.
7588 s Maximum size of an item in Kbyte. If zero then registers are
7589 not saved. Currently only applies to registers. The default
7590 "s10" will exclude registers with more than 10 Kbyte of text.
7591 Also see the '<' item above: line count limit.
7592
7593 Example: >
7594 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7595<
7596 '50 Marks will be remembered for the last 50 files you
7597 edited.
7598 <1000 Contents of registers (up to 1000 lines each) will be
7599 remembered.
7600 s100 Registers with more than 100 Kbyte text are skipped.
7601 :0 Command-line history will not be saved.
7602 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7603 no / Since '/' is not specified, the default will be used,
7604 that is, save all of the search history, and also the
7605 previous search and substitute patterns.
7606 no % The buffer list will not be saved nor read back.
7607 no h 'hlsearch' highlighting will be restored.
7608
7609 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7610 load the contents of the file, this is not done automatically.
7611
7612 This option cannot be set from a |modeline| or in the |sandbox|, for
7613 security reasons.
7614
7615 *'virtualedit'* *'ve'*
7616'virtualedit' 've' string (default "")
7617 global
7618 {not in Vi}
7619 {not available when compiled without the
7620 |+virtualedit| feature}
7621 A comma separated list of these words:
7622 block Allow virtual editing in Visual block mode.
7623 insert Allow virtual editing in Insert mode.
7624 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007625 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007626
Bram Moolenaar071d4272004-06-13 20:20:40 +00007627 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007628 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007629 of the line. Useful for selecting a rectangle in Visual mode and
7630 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007631 "onemore" is not the same, it will only allow moving the cursor just
7632 after the last character of the line. This makes some commands more
7633 consistent. Previously the cursor was always past the end of the line
7634 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007635 break some plugins or Vim scripts. For example because |l| can move
7636 the cursor after the last character. Use with care!
7637 Using the |$| command will move to the last character in the line, not
7638 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007639 It doesn't make sense to combine "all" with "onemore", but you will
7640 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007641
7642 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7643'visualbell' 'vb' boolean (default off)
7644 global
7645 {not in Vi}
7646 Use visual bell instead of beeping. The terminal code to display the
7647 visual bell is given with 't_vb'. When no beep or flash is wanted,
7648 use ":set vb t_vb=".
7649 Note: When the GUI starts, 't_vb' is reset to its default value. You
7650 might want to set it again in your |gvimrc|.
7651 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7652 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7653 where 40 is the time in msec.
7654 Does not work on the Amiga, you always get a screen flash.
7655 Also see 'errorbells'.
7656
7657 *'warn'* *'nowarn'*
7658'warn' boolean (default on)
7659 global
7660 Give a warning message when a shell command is used while the buffer
7661 has been changed.
7662
7663 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7664'weirdinvert' 'wiv' boolean (default off)
7665 global
7666 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007667 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668 It is provided for backwards compatibility with version 4.x.
7669 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7670 vice versa. Has no effect when the GUI is running.
7671
7672 *'whichwrap'* *'ww'*
7673'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7674 global
7675 {not in Vi}
7676 Allow specified keys that move the cursor left/right to move to the
7677 previous/next line when the cursor is on the first/last character in
7678 the line. Concatenate characters to allow this for these keys:
7679 char key mode ~
7680 b <BS> Normal and Visual
7681 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007682 h "h" Normal and Visual (not recommended)
7683 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684 < <Left> Normal and Visual
7685 > <Right> Normal and Visual
7686 ~ "~" Normal
7687 [ <Left> Insert and Replace
7688 ] <Right> Insert and Replace
7689 For example: >
7690 :set ww=<,>,[,]
7691< allows wrap only when cursor keys are used.
7692 When the movement keys are used in combination with a delete or change
7693 operator, the <EOL> also counts for a character. This makes "3h"
7694 different from "3dh" when the cursor crosses the end of a line. This
7695 is also true for "x" and "X", because they do the same as "dl" and
7696 "dh". If you use this, you may also want to use the mapping
7697 ":map <BS> X" to make backspace delete the character in front of the
7698 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007699 When 'l' is included and it is used after an operator at the end of a
7700 line then it will not move to the next line. This makes "dl", "cl",
7701 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007702 NOTE: This option is set to the Vi default value when 'compatible' is
7703 set and to the Vim default value when 'compatible' is reset.
7704
7705 *'wildchar'* *'wc'*
7706'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7707 global
7708 {not in Vi}
7709 Character you have to type to start wildcard expansion in the
7710 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007711 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 The character is not recognized when used inside a macro. See
7713 'wildcharm' for that.
7714 Although 'wc' is a number option, you can set it to a special key: >
7715 :set wc=<Esc>
7716< NOTE: This option is set to the Vi default value when 'compatible' is
7717 set and to the Vim default value when 'compatible' is reset.
7718
7719 *'wildcharm'* *'wcm'*
7720'wildcharm' 'wcm' number (default: none (0))
7721 global
7722 {not in Vi}
7723 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007724 recognized when used inside a macro. You can find "spare" command-line
7725 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 you'll never actually type 'wildcharm', just use it in mappings that
7727 automatically invoke completion mode, e.g.: >
7728 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007729 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007730< Then after typing :ss you can use CTRL-P & CTRL-N.
7731
7732 *'wildignore'* *'wig'*
7733'wildignore' 'wig' string (default "")
7734 global
7735 {not in Vi}
7736 {not available when compiled without the |+wildignore|
7737 feature}
7738 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007739 patterns is ignored when completing file or directory names, and
7740 influences the result of |expand()|, |glob()| and |globpath()| unless
7741 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7743 Also see 'suffixes'.
7744 Example: >
7745 :set wildignore=*.o,*.obj
7746< The use of |:set+=| and |:set-=| is preferred when adding or removing
7747 a pattern from the list. This avoids problems when a future version
7748 uses another default.
7749
7750 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7751'wildmenu' 'wmnu' boolean (default off)
7752 global
7753 {not in Vi}
7754 {not available if compiled without the |+wildmenu|
7755 feature}
7756 When 'wildmenu' is on, command-line completion operates in an enhanced
7757 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7758 the possible matches are shown just above the command line, with the
7759 first match highlighted (overwriting the status line, if there is
7760 one). Keys that show the previous/next match, such as <Tab> or
7761 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7762 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7763 specified. "longest" and "list" do not start "wildmenu" mode.
7764 If there are more matches than can fit in the line, a ">" is shown on
7765 the right and/or a "<" is shown on the left. The status line scrolls
7766 as needed.
7767 The "wildmenu" mode is abandoned when a key is hit that is not used
7768 for selecting a completion.
7769 While the "wildmenu" is active the following keys have special
7770 meanings:
7771
7772 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7773 <Down> - in filename/menu name completion: move into a
7774 subdirectory or submenu.
7775 <CR> - in menu completion, when the cursor is just after a
7776 dot: move into a submenu.
7777 <Up> - in filename/menu name completion: move up into
7778 parent directory or parent menu.
7779
7780 This makes the menus accessible from the console |console-menus|.
7781
7782 If you prefer the <Left> and <Right> keys to move the cursor instead
7783 of selecting a different match, use this: >
7784 :cnoremap <Left> <Space><BS><Left>
7785 :cnoremap <Right> <Space><BS><Right>
7786<
7787 The "WildMenu" highlighting is used for displaying the current match
7788 |hl-WildMenu|.
7789
7790 *'wildmode'* *'wim'*
7791'wildmode' 'wim' string (Vim default: "full")
7792 global
7793 {not in Vi}
7794 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007795 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007796 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797 first part specifies the behavior for the first use of 'wildchar',
7798 The second part for the second use, etc.
7799 These are the possible values for each part:
7800 "" Complete only the first match.
7801 "full" Complete the next full match. After the last match,
7802 the original string is used and then the first match
7803 again.
7804 "longest" Complete till longest common string. If this doesn't
7805 result in a longer string, use the next part.
7806 "longest:full" Like "longest", but also start 'wildmenu' if it is
7807 enabled.
7808 "list" When more than one match, list all matches.
7809 "list:full" When more than one match, list all matches and
7810 complete first match.
7811 "list:longest" When more than one match, list all matches and
7812 complete till longest common string.
7813 When there is only a single match, it is fully completed in all cases.
7814
7815 Examples: >
7816 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007817< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007818 :set wildmode=longest,full
7819< Complete longest common string, then each full match >
7820 :set wildmode=list:full
7821< List all matches and complete each full match >
7822 :set wildmode=list,full
7823< List all matches without completing, then each full match >
7824 :set wildmode=longest,list
7825< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007826 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007828 *'wildoptions'* *'wop'*
7829'wildoptions' 'wop' string (default "")
7830 global
7831 {not in Vi}
7832 {not available when compiled without the |+wildignore|
7833 feature}
7834 A list of words that change how command line completion is done.
7835 Currently only one word is allowed:
7836 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007837 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007838 is displayed per line. Often used tag kinds are:
7839 d #define
7840 f function
7841 Also see |cmdline-completion|.
7842
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843 *'winaltkeys'* *'wak'*
7844'winaltkeys' 'wak' string (default "menu")
7845 global
7846 {not in Vi}
7847 {only used in Win32, Motif, GTK and Photon GUI}
7848 Some GUI versions allow the access to menu entries by using the ALT
7849 key in combination with a character that appears underlined in the
7850 menu. This conflicts with the use of the ALT key for mappings and
7851 entering special characters. This option tells what to do:
7852 no Don't use ALT keys for menus. ALT key combinations can be
7853 mapped, but there is no automatic handling. This can then be
7854 done with the |:simalt| command.
7855 yes ALT key handling is done by the windowing system. ALT key
7856 combinations cannot be mapped.
7857 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007858 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859 keys can be mapped.
7860 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7861 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007862 This option is not used for <F10>; on Win32 and with GTK <F10> will
7863 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007865 *'window'* *'wi'*
7866'window' 'wi' number (default screen height - 1)
7867 global
7868 Window height. Do not confuse this with the height of the Vim window,
7869 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007870 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7871 value is smaller than 'lines' minus one. The screen will scroll
7872 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007873 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7874 in a much smarter way, taking care of wrapping lines.
7875 When resizing the Vim window, the value is smaller than 1 or more than
7876 or equal to 'lines' it will be set to 'lines' minus 1.
7877 {Vi also uses the option to specify the number of displayed lines}
7878
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 *'winheight'* *'wh'* *E591*
7880'winheight' 'wh' number (default 1)
7881 global
7882 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007883 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 feature}
7885 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007886 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007887 focus goes to a window that is smaller, its size is increased, at the
7888 cost of the height of other windows.
7889 Set 'winheight' to a small number for normal editing.
7890 Set it to 999 to make the current window fill most of the screen.
7891 Other windows will be only 'winminheight' high. This has the drawback
7892 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7893 to create only two windows, set the option after startup is done,
7894 using the |VimEnter| event: >
7895 au VimEnter * set winheight=999
7896< Minimum value is 1.
7897 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007898 height of the current window.
7899 'winheight' applies to the current window. Use 'winminheight' to set
7900 the minimal height for other windows.
7901
7902 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7903'winfixheight' 'wfh' boolean (default off)
7904 local to window
7905 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007906 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907 feature}
7908 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007909 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7910 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007911 The height may be changed anyway when running out of room.
7912
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007913 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7914'winfixwidth' 'wfw' boolean (default off)
7915 local to window
7916 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007917 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007918 feature}
7919 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007920 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007921 The width may be changed anyway when running out of room.
7922
Bram Moolenaar071d4272004-06-13 20:20:40 +00007923 *'winminheight'* *'wmh'*
7924'winminheight' 'wmh' number (default 1)
7925 global
7926 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007927 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007928 feature}
7929 The minimal height of a window, when it's not the current window.
7930 This is a hard minimum, windows will never become smaller.
7931 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7932 status bar) if necessary. They will return to at least one line when
7933 they become active (since the cursor has to have somewhere to go.)
7934 Use 'winheight' to set the minimal height of the current window.
7935 This option is only checked when making a window smaller. Don't use a
7936 large number, it will cause errors when opening more than a few
7937 windows. A value of 0 to 3 is reasonable.
7938
7939 *'winminwidth'* *'wmw'*
7940'winminwidth' 'wmw' number (default 1)
7941 global
7942 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007943 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007944 feature}
7945 The minimal width of a window, when it's not the current window.
7946 This is a hard minimum, windows will never become smaller.
7947 When set to zero, windows may be "squashed" to zero columns (i.e. just
7948 a vertical separator) if necessary. They will return to at least one
7949 line when they become active (since the cursor has to have somewhere
7950 to go.)
7951 Use 'winwidth' to set the minimal width of the current window.
7952 This option is only checked when making a window smaller. Don't use a
7953 large number, it will cause errors when opening more than a few
7954 windows. A value of 0 to 12 is reasonable.
7955
7956 *'winwidth'* *'wiw'* *E592*
7957'winwidth' 'wiw' number (default 20)
7958 global
7959 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007960 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 feature}
7962 Minimal number of columns for the current window. This is not a hard
7963 minimum, Vim will use fewer columns if there is not enough room. If
7964 the current window is smaller, its size is increased, at the cost of
7965 the width of other windows. Set it to 999 to make the current window
7966 always fill the screen. Set it to a small number for normal editing.
7967 The width is not adjusted after one of the commands to change the
7968 width of the current window.
7969 'winwidth' applies to the current window. Use 'winminwidth' to set
7970 the minimal width for other windows.
7971
7972 *'wrap'* *'nowrap'*
7973'wrap' boolean (default on)
7974 local to window
7975 {not in Vi}
7976 This option changes how text is displayed. It doesn't change the text
7977 in the buffer, see 'textwidth' for that.
7978 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007979 displaying continues on the next line. When off lines will not wrap
7980 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981 moved to a part that is not shown, the screen will scroll
7982 horizontally.
7983 The line will be broken in the middle of a word if necessary. See
7984 'linebreak' to get the break at a word boundary.
7985 To make scrolling horizontally a bit more useful, try this: >
7986 :set sidescroll=5
7987 :set listchars+=precedes:<,extends:>
7988< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007989 This option can't be set from a |modeline| when the 'diff' option is
7990 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007991
7992 *'wrapmargin'* *'wm'*
7993'wrapmargin' 'wm' number (default 0)
7994 local to buffer
7995 Number of characters from the right window border where wrapping
7996 starts. When typing text beyond this limit, an <EOL> will be inserted
7997 and inserting continues on the next line.
7998 Options that add a margin, such as 'number' and 'foldcolumn', cause
7999 the text width to be further reduced. This is Vi compatible.
8000 When 'textwidth' is non-zero, this option is not used.
8001 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8002 and less usefully}
8003
8004 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8005'wrapscan' 'ws' boolean (default on) *E384* *E385*
8006 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008007 Searches wrap around the end of the file. Also applies to |]s| and
8008 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008009
8010 *'write'* *'nowrite'*
8011'write' boolean (default on)
8012 global
8013 {not in Vi}
8014 Allows writing files. When not set, writing a file is not allowed.
8015 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008016 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017 argument. Filtering text is still possible, even though this requires
8018 writing a temporary file.
8019
8020 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8021'writeany' 'wa' boolean (default off)
8022 global
8023 Allows writing to any file with no need for "!" override.
8024
8025 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8026'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8027 otherwise)
8028 global
8029 {not in Vi}
8030 Make a backup before overwriting a file. The backup is removed after
8031 the file was successfully written, unless the 'backup' option is
8032 also on. Reset this option if your file system is almost full. See
8033 |backup-table| for another explanation.
8034 When the 'backupskip' pattern matches, a backup is not made anyway.
8035 NOTE: This option is set to the default value when 'compatible' is
8036 set.
8037
8038 *'writedelay'* *'wd'*
8039'writedelay' 'wd' number (default 0)
8040 global
8041 {not in Vi}
8042 The number of microseconds to wait for each character sent to the
8043 screen. When non-zero, characters are sent to the terminal one by
8044 one. For MS-DOS pcterm this does not work. For debugging purposes.
8045
8046 vim:tw=78:ts=8:ft=help:norl: