blob: 9344e884e1ca5ffbcb76e54e148ca93e4bb51ce8 [file] [log] [blame]
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001*options.txt* For Vim version 7.3b. Last change: 2010 Jul 23
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
53:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000054 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 'columns' are not changed. {not in Vi}
56
57 *:set-args* *E487* *E521*
58:se[t] {option}={value} or
59:se[t] {option}:{value}
60 Set string or number option to {value}.
61 For numeric options the value can be given in decimal,
62 hex (preceded with 0x) or octal (preceded with '0')
63 (hex and octal are only available for machines which
64 have the strtol() function).
65 The old value can be inserted by typing 'wildchar' (by
66 default this is a <Tab> or CTRL-E if 'compatible' is
67 set). See |cmdline-completion|.
68 White space between {option} and '=' is allowed and
69 will be ignored. White space between '=' and {value}
70 is not allowed.
71 See |option-backslash| for using white space and
72 backslashes in {value}.
73
74:se[t] {option}+={value} *:set+=*
75 Add the {value} to a number option, or append the
76 {value} to a string option. When the option is a
77 comma separated list, a comma is added, unless the
78 value was empty.
79 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000080 are removed. When adding a flag that was already
81 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000082 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 {not in Vi}
84
85:se[t] {option}^={value} *:set^=*
86 Multiply the {value} to a number option, or prepend
87 the {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 Also see |:set-args| above.
91 {not in Vi}
92
93:se[t] {option}-={value} *:set-=*
94 Subtract the {value} from a number option, or remove
95 the {value} from a string option, if it is there.
96 If the {value} is not found in a string option, there
97 is no error or warning. When the option is a comma
98 separated list, a comma is deleted, unless the option
99 becomes empty.
100 When the option is a list of flags, {value} must be
101 exactly as they appear in the option. Remove flags
102 one by one to avoid problems.
103 Also see |:set-args| above.
104 {not in Vi}
105
106The {option} arguments to ":set" may be repeated. For example: >
107 :set ai nosi sw=3 ts=3
108If you make an error in one of the arguments, an error message will be given
109and the following arguments will be ignored.
110
111 *:set-verbose*
112When 'verbose' is non-zero, displaying an option value will also tell where it
113was last set. Example: >
114 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000115< shiftwidth=4 ~
116 Last set from modeline ~
117 cindent ~
118 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
119This is only done when specific option values are requested, not for ":verbose
120set all" or ":verbose set" without an argument.
121When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122When the option was set while executing a function, user command or
123autocommand, the script in which it was defined is reported.
124Note that an option may also have been set as a side effect of setting
125'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000126A few special texts:
127 Last set from modeline ~
128 Option was set in a |modeline|.
129 Last set from --cmd argument ~
130 Option was set with command line argument |--cmd| or +.
131 Last set from -c argument ~
132 Option was set with command line argument |-c|, +, |-S| or
133 |-q|.
134 Last set from environment variable ~
135 Option was set from an environment variable, $VIMINIT,
136 $GVIMINIT or $EXINIT.
137 Last set from error handler ~
138 Option was cleared when evaluating it resulted in an error.
139
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140{not available when compiled without the +eval feature}
141
142 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000143For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144override the value from the termcap. You can then use it in a mapping. If
145the "xx" part contains special characters, use the <t_xx> form: >
146 :set <t_#4>=^[Ot
147This can also be used to translate a special code for a normal key. For
148example, if Alt-b produces <Esc>b, use this: >
149 :set <M-b>=^[b
150(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
151The advantage over a mapping is that it works in all situations.
152
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000153The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
154security reasons.
155
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000157at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158"set all" probably does not fit on the screen, causing Vim to give the
159|more-prompt|.
160
161 *option-backslash*
162To include white space in a string option value it has to be preceded with a
163backslash. To include a backslash you have to use two. Effectively this
164means that the number of backslashes in an option value is halved (rounded
165down).
166A few examples: >
167 :set tags=tags\ /usr/tags results in "tags /usr/tags"
168 :set tags=tags\\,file results in "tags\,file"
169 :set tags=tags\\\ file results in "tags\ file"
170
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000171The "|" character separates a ":set" command from a following command. To
172include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173'titlestring' option to "hi|there": >
174 :set titlestring=hi\|there
175This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
176 :set titlestring=hi|set iconstring=there
177
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000178Similarly, the double quote character starts a comment. To include the '"' in
179the option value, use '\"' instead. This example sets the 'titlestring'
180option to 'hi "there"': >
181 :set titlestring=hi\ \"there\"
182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000183For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184precise: For options that expect a file name (those where environment
185variables are expanded) a backslash before a normal file name character is not
186removed. But a backslash before a special character (space, backslash, comma,
187etc.) is used like explained above.
188There is one special situation, when the value starts with "\\": >
189 :set dir=\\machine\path results in "\\machine\path"
190 :set dir=\\\\machine\\path results in "\\machine\path"
191 :set dir=\\path\\file results in "\\path\file" (wrong!)
192For the first one the start is kept, but for the second one the backslashes
193are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000194halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195result which is probably not what you want. Avoid it.
196
197 *add-option-flags* *remove-option-flags*
198 *E539* *E550* *E551* *E552*
199Some options are a list of flags. When you want to add a flag to such an
200option, without changing the existing ones, you can do it like this: >
201 :set guioptions+=a
202Remove a flag from an option like this: >
203 :set guioptions-=a
204This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000205Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
207doesn't appear.
208
209 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000210Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211environment variable exists the '$' and the following environment variable
212name is replaced with its value. If it does not exist the '$' and the name
213are not modified. Any non-id character (not a letter, digit or '_') may
214follow the environment variable name. That character and what follows is
215appended to the value of the environment variable. Examples: >
216 :set term=$TERM.new
217 :set path=/usr/$INCLUDE,$HOME/include,.
218When adding or removing a string from an option with ":set opt-=val" or ":set
219opt+=val" the expansion is done before the adding or removing.
220
221
222Handling of local options *local-options*
223
224Some of the options only apply to a window or buffer. Each window or buffer
225has its own copy of this option, thus can each have their own value. This
226allows you to set 'list' in one window but not in another. And set
227'shiftwidth' to 3 in one buffer and 4 in another.
228
229The following explains what happens to these local options in specific
230situations. You don't really need to know all of this, since Vim mostly uses
231the option values you would expect. Unfortunately, doing what the user
232expects is a bit complicated...
233
234When splitting a window, the local options are copied to the new window. Thus
235right after the split the contents of the two windows look the same.
236
237When editing a new buffer, its local option values must be initialized. Since
238the local options of the current buffer might be specifically for that buffer,
239these are not used. Instead, for each buffer-local option there also is a
240global value, which is used for new buffers. With ":set" both the local and
241global value is changed. With "setlocal" only the local value is changed,
242thus this value is not used when editing a new buffer.
243
244When editing a buffer that has been edited before, the last used window
245options are used again. If this buffer has been edited in this window, the
246values from back then are used. Otherwise the values from the window where
247the buffer was edited last are used.
248
249It's possible to set a local window option specifically for a type of buffer.
250When you edit another buffer in the same window, you don't want to keep
251using these local window options. Therefore Vim keeps a global value of the
252local window options, which is used when editing another buffer. Each window
253has its own copy of these values. Thus these are local to the window, but
254global to all buffers in the window. With this you can do: >
255 :e one
256 :set list
257 :e two
258Now the 'list' option will also be set in "two", since with the ":set list"
259command you have also set the global value. >
260 :set nolist
261 :e one
262 :setlocal list
263 :e two
264Now the 'list' option is not set, because ":set nolist" resets the global
265value, ":setlocal list" only changes the local value and ":e two" gets the
266global value. Note that if you do this next: >
267 :e one
268You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000269"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270
271 *:setl* *:setlocal*
272:setl[ocal] ... Like ":set" but set only the value local to the
273 current buffer or window. Not all options have a
274 local value. If the option does not have a local
275 value the global value is set.
276 With the "all" argument: display all local option's
277 local values.
278 Without argument: Display all local option's local
279 values which are different from the default.
280 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000281 local value. For a global/local boolean option, when
282 the global value is being used, "--" is displayed
283 before the option name.
284 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285 shown (but that might change in the future).
286 {not in Vi}
287
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000288:setl[ocal] {option}< Set the local value of {option} to its global value by
289 copying the value.
290 {not in Vi}
291
292:se[t] {option}< Set the local value of {option} to its global value by
293 making it empty. Only makes sense for |global-local|
294 options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 {not in Vi}
296
297 *:setg* *:setglobal*
298:setg[lobal] ... Like ":set" but set only the global value for a local
299 option without changing the local value.
300 When displaying an option, the global value is shown.
301 With the "all" argument: display all local option's
302 global values.
303 Without argument: display all local option's global
304 values which are different from the default.
305 {not in Vi}
306
307For buffer-local and window-local options:
308 Command global value local value ~
309 :set option=value set set
310 :setlocal option=value - set
311:setglobal option=value set -
312 :set option? - display
313 :setlocal option? - display
314:setglobal option? display -
315
316
317Global options with a local value *global-local*
318
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000319Options are global when you mostly use one value for all buffers and windows.
320For some global options it's useful to sometimes have a different local value.
321You can set the local value with ":setlocal". That buffer or window will then
322use the local value, while other buffers and windows continue using the global
323value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324
325For example, you have two windows, both on C source code. They use the global
326'makeprg' option. If you do this in one of the two windows: >
327 :set makeprg=gmake
328then the other window will switch to the same value. There is no need to set
329the 'makeprg' option in the other C source window too.
330However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000331another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000332files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333 :setlocal makeprg=perlmake
334You can switch back to using the global value by making the local value empty: >
335 :setlocal makeprg=
336This only works for a string option. For a boolean option you need to use the
337"<" flag, like this: >
338 :setlocal autoread<
339Note that for non-boolean options using "<" copies the global value to the
340local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000341when the global value changes later). You can also use: >
342 :set path<
343This will make the local value of 'path' empty, so that the global value is
344used. Thus it does the same as: >
345 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346Note: In the future more global options can be made global-local. Using
347":setlocal" on a global option might work differently then.
348
349
350Setting the filetype
351
352:setf[iletype] {filetype} *:setf* *:setfiletype*
353 Set the 'filetype' option to {filetype}, but only if
354 not done yet in a sequence of (nested) autocommands.
355 This is short for: >
356 :if !did_filetype()
357 : setlocal filetype={filetype}
358 :endif
359< This command is used in a filetype.vim file to avoid
360 setting the 'filetype' option twice, causing different
361 settings and syntax files to be loaded.
362 {not in Vi}
363
364:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
365:opt[ions] Open a window for viewing and setting all options.
366 Options are grouped by function.
367 Offers short help for each option. Hit <CR> on the
368 short help to open a help window with more help for
369 the option.
370 Modify the value of the option and hit <CR> on the
371 "set" line to set the new value. For window and
372 buffer specific options, the last accessed window is
373 used to set the option value in, unless this is a help
374 window, in which case the window below help window is
375 used (skipping the option-window).
376 {not available when compiled without the |+eval| or
377 |+autocmd| features}
378
379 *$HOME*
380Using "~" is like using "$HOME", but it is only recognized at the start of an
381option and after a space or comma.
382
383On Unix systems "~user" can be used too. It is replaced by the home directory
384of user "user". Example: >
385 :set path=~mool/include,/usr/include,.
386
387On Unix systems the form "${HOME}" can be used too. The name between {} can
388contain non-id characters then. Note that if you want to use this for the
389"gf" command, you need to add the '{' and '}' characters to 'isfname'.
390
391NOTE: expanding environment variables and "~/" is only done with the ":set"
392command, not when assigning a value to an option with ":let".
393
394
395Note the maximum length of an expanded option is limited. How much depends on
396the system, mostly it is something like 256 or 1024 characters.
397
398 *:fix* *:fixdel*
399:fix[del] Set the value of 't_kD':
400 't_kb' is 't_kD' becomes ~
401 CTRL-? CTRL-H
402 not CTRL-? CTRL-?
403
404 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
405
406 If your delete key terminal code is wrong, but the
407 code for backspace is alright, you can put this in
408 your .vimrc: >
409 :fixdel
410< This works no matter what the actual code for
411 backspace is.
412
413 If the backspace key terminal code is wrong you can
414 use this: >
415 :if &term == "termname"
416 : set t_kb=^V<BS>
417 : fixdel
418 :endif
419< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000420 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421 with your terminal name.
422
423 If your <Delete> key sends a strange key sequence (not
424 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
425 :if &term == "termname"
426 : set t_kD=^V<Delete>
427 :endif
428< Where "^V" is CTRL-V and "<Delete>" is the delete key
429 (don't type eight characters!). Replace "termname"
430 with your terminal name.
431
432 *Linux-backspace*
433 Note about Linux: By default the backspace key
434 produces CTRL-?, which is wrong. You can fix it by
435 putting this line in your rc.local: >
436 echo "keycode 14 = BackSpace" | loadkeys
437<
438 *NetBSD-backspace*
439 Note about NetBSD: If your backspace doesn't produce
440 the right code, try this: >
441 xmodmap -e "keycode 22 = BackSpace"
442< If this works, add this in your .Xmodmap file: >
443 keysym 22 = BackSpace
444< You need to restart for this to take effect.
445
446==============================================================================
4472. Automatically setting options *auto-setting*
448
449Besides changing options with the ":set" command, there are three alternatives
450to set options automatically for one or more files:
451
4521. When starting Vim initializations are read from various places. See
453 |initialization|. Most of them are performed for all editing sessions,
454 and some of them depend on the directory where Vim is started.
455 You can create an initialization file with |:mkvimrc|, |:mkview| and
456 |:mksession|.
4572. If you start editing a new file, the automatic commands are executed.
458 This can be used to set options for files matching a particular pattern and
459 many other things. See |autocommand|.
4603. If you start editing a new file, and the 'modeline' option is on, a
461 number of lines at the beginning and end of the file are checked for
462 modelines. This is explained here.
463
464 *modeline* *vim:* *vi:* *ex:* *E520*
465There are two forms of modelines. The first form:
466 [text]{white}{vi:|vim:|ex:}[white]{options}
467
468[text] any text or empty
469{white} at least one blank character (<Space> or <Tab>)
470{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
471[white] optional white space
472{options} a list of option settings, separated with white space or ':',
473 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000474 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000476Example:
477 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478
479The second form (this is compatible with some versions of Vi):
480
481 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
482
483[text] any text or empty
484{white} at least one blank character (<Space> or <Tab>)
485{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
486[white] optional white space
487se[t] the string "set " or "se " (note the space)
488{options} a list of options, separated with white space, which is the
489 argument for a ":set" command
490: a colon
491[text] any text or empty
492
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000493Example:
494 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495
496The white space before {vi:|vim:|ex:} is required. This minimizes the chance
497that a normal word like "lex:" is caught. There is one exception: "vi:" and
498"vim:" can also be at the start of the line (for compatibility with version
4993.0). Using "ex:" at the start of the line will be ignored (this could be
500short for "example:").
501
502 *modeline-local*
503The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000504buffer and window that contain the file. Although it's possible to set global
505options from a modeline, this is unusual. If you have two windows open and
506the files in it set the same global option to a different value, the result
507depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000509When editing a file that was already loaded, only the window-local options
510from the modeline are used. Thus if you manually changed a buffer-local
511option after opening the file, it won't be changed if you edit the same buffer
512in another window. But window-local options will be set.
513
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514 *modeline-version*
515If the modeline is only to be used for some versions of Vim, the version
516number can be specified where "vim:" is used:
517 vim{vers}: version {vers} or later
518 vim<{vers}: version before {vers}
519 vim={vers}: version {vers}
520 vim>{vers}: version after {vers}
521{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000522For example, to use a modeline only for Vim 6.0 and later:
523 /* vim600: set foldmethod=marker: */ ~
524To use a modeline for Vim before version 5.7:
525 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526There can be no blanks between "vim" and the ":".
527
528
529The number of lines that are checked can be set with the 'modelines' option.
530If 'modeline' is off or 'modelines' is 0 no lines are checked.
531
532Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000533like:
534 /* vi:ts=4: */ ~
535will give an error message for the trailing "*/". This line is OK:
536 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538If an error is detected the rest of the line is skipped.
539
540If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000541backslash in front of the ':' will be removed. Example:
542 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543This sets the 'dir' option to "c:\tmp". Only a single backslash before the
544':' is removed. Thus to include "\:" you have to specify "\\:".
545
546No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000547might create a Trojan horse text file with modelines). And not all options
548can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000549|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000550causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
551are wrapped unexpectedly. So disable modelines before editing untrusted text.
552The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553
554Hint: If you would like to do something else than setting an option, you could
555define an autocommand that checks the file for a specific string. For
556example: >
557 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
558And define a function SetVar() that does something with the line containing
559"VAR".
560
561==============================================================================
5623. Options summary *option-summary*
563
564In the list below all the options are mentioned with their full name and with
565an abbreviation if there is one. Both forms may be used.
566
567In this document when a boolean option is "set" that means that ":set option"
568is entered. When an option is "reset", ":set nooption" is used.
569
570For some options there are two default values: The "Vim default", which is
571used when 'compatible' is not set, and the "Vi default", which is used when
572'compatible' is set.
573
574Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000575are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576different value in each window. For example the 'list' option can be set in
577one window and reset in another for the same text, giving both types of view
578at the same time. There are a few options that are specific to a certain
579file. These can have a different value for each file or buffer. For example
580the 'textwidth' option can be 78 for a normal text file and 0 for a C
581program.
582
583 global one option for all buffers and windows
584 local to window each window has its own copy of this option
585 local to buffer each buffer has its own copy of this option
586
587When creating a new window the option values from the currently active window
588are used as a default value for the window-specific options. For the
589buffer-specific options this depends on the 's' and 'S' flags in the
590'cpoptions' option. If 's' is included (which is the default) the values for
591buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000592first entered. If 'S' is present the options are copied each time the buffer
593is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594present, the options are copied from the currently active buffer when the
595buffer is created.
596
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000597Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000599Not all options are supported in all versions. This depends on the supported
600features and sometimes on the system. A remark about this is in curly braces
601below. When an option is not supported it may still be set without getting an
602error, this is called a hidden option. You can't get the value of a hidden
603option though, it is not stored.
604
605To test if option "foo" can be used with ":set" use something like this: >
606 if exists('&foo')
607This also returns true for a hidden option. To test if option "foo" is really
608supported use something like this: >
609 if exists('+foo')
610<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 *E355*
612A jump table for the options with a short description can be found at |Q_op|.
613
614 *'aleph'* *'al'* *aleph* *Aleph*
615'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
616 global
617 {not in Vi}
618 {only available when compiled with the |+rightleft|
619 feature}
620 The ASCII code for the first letter of the Hebrew alphabet. The
621 routine that maps the keyboard in Hebrew mode, both in Insert mode
622 (when hkmap is set) and on the command-line (when hitting CTRL-_)
623 outputs the Hebrew characters in the range [aleph..aleph+26].
624 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
625 See |rileft.txt|.
626
627 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
628'allowrevins' 'ari' boolean (default off)
629 global
630 {not in Vi}
631 {only available when compiled with the |+rightleft|
632 feature}
633 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
634 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
635 into reverse Insert mode, and don't know how to get out. See
636 'revins'.
637 NOTE: This option is reset when 'compatible' is set.
638
639 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
640'altkeymap' 'akm' boolean (default off)
641 global
642 {not in Vi}
643 {only available when compiled with the |+farsi|
644 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000645 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 the keyboard map between Farsi and English, when 'allowrevins' set.
647
Bram Moolenaar582fd852005-03-28 20:58:01 +0000648 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 is useful to start the Vim in native mode i.e. English (left-to-right
650 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000651 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
653 *'ambiwidth'* *'ambw'*
654'ambiwidth' 'ambw' string (default: "single")
655 global
656 {not in Vi}
657 {only available when compiled with the |+multi_byte|
658 feature}
659 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
660 Tells Vim what to do with characters with East Asian Width Class
661 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
662 letters, Cyrillic letters).
663
664 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000665 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 expected by most users.
667 "double": Use twice the width of ASCII characters.
668
669 There are a number of CJK fonts for which the width of glyphs for
670 those characters are solely based on how many octets they take in
671 legacy/traditional CJK encodings. In those encodings, Euro,
672 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000673 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000675 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 Vim is running inside a terminal (emulators) that uses a CJK font
677 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
678 this option should be set to "double" to match the width perceived
679 by Vim with the width of glyphs in the font. Perhaps it also has
680 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
681 when the system locale is set to one of CJK locales. See Unicode
682 Standard Annex #11 (http://www.unicode.org/reports/tr11).
683
684 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
685'antialias' 'anti' boolean (default: off)
686 global
687 {not in Vi}
688 {only available when compiled with GUI enabled
689 on Mac OS X}
690 This option only has an effect in the GUI version of Vim on Mac OS X
691 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
692 which can be easier to read at certain sizes on certain displays.
693 Setting this option can sometimes cause problems if 'guifont' is set
694 to its default (empty string).
695
696 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
697'autochdir' 'acd' boolean (default off)
698 global
699 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200700 {only available when compiled with it, use
701 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000702 When on, Vim will change the current working directory whenever you
703 open a file, switch buffers, delete a buffer or open/close a window.
704 It will change to the directory containing the file which was opened
705 or selected.
706 This option is provided for backward compatibility with the Vim
707 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000708 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709
710 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
711'arabic' 'arab' boolean (default off)
712 local to window
713 {not in Vi}
714 {only available when compiled with the |+arabic|
715 feature}
716 This option can be set to start editing Arabic text.
717 Setting this option will:
718 - Set the 'rightleft' option, unless 'termbidi' is set.
719 - Set the 'arabicshape' option, unless 'termbidi' is set.
720 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
721 between typing English and Arabic key mapping.
722 - Set the 'delcombine' option
723 Note that 'encoding' must be "utf-8" for working with Arabic text.
724
725 Resetting this option will:
726 - Reset the 'rightleft' option.
727 - Disable the use of 'keymap' (without changing its value).
728 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
729 option.
730 Also see |arabic.txt|.
731
732 *'arabicshape'* *'arshape'*
733 *'noarabicshape'* *'noarshape'*
734'arabicshape' 'arshape' boolean (default on)
735 global
736 {not in Vi}
737 {only available when compiled with the |+arabic|
738 feature}
739 When on and 'termbidi' is off, the required visual character
740 corrections that need to take place for displaying the Arabic language
741 take affect. Shaping, in essence, gets enabled; the term is a broad
742 one which encompasses:
743 a) the changing/morphing of characters based on their location
744 within a word (initial, medial, final and stand-alone).
745 b) the enabling of the ability to compose characters
746 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100747 When disabled the display shows each character's true stand-alone
748 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 Arabic is a complex language which requires other settings, for
750 further details see |arabic.txt|.
751
752 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
753'autoindent' 'ai' boolean (default off)
754 local to buffer
755 Copy indent from current line when starting a new line (typing <CR>
756 in Insert mode or when using the "o" or "O" command). If you do not
757 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000758 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
759 to another line has the same effect, unless the 'I' flag is included
760 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000761 When autoindent is on, formatting (with the "gq" command or when you
762 reach 'textwidth' in Insert mode) uses the indentation of the first
763 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 When 'smartindent' or 'cindent' is on the indent is changed in
765 a different way.
766 The 'autoindent' option is reset when the 'paste' option is set.
767 {small difference from Vi: After the indent is deleted when typing
768 <Esc> or <CR>, the cursor position when moving up or down is after the
769 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
770
771 *'autoread'* *'ar'* *'noautoread'* *'noar'*
772'autoread' 'ar' boolean (default off)
773 global or local to buffer |global-local|
774 {not in Vi}
775 When a file has been detected to have been changed outside of Vim and
776 it has not been changed inside of Vim, automatically read it again.
777 When the file has been deleted this is not done. |timestamp|
778 If this option has a local value, use this command to switch back to
779 using the global value: >
780 :set autoread<
781<
782 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
783'autowrite' 'aw' boolean (default off)
784 global
785 Write the contents of the file, if it has been modified, on each
786 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000787 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
789 Note that for some commands the 'autowrite' option is not used, see
790 'autowriteall' for that.
791
792 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
793'autowriteall' 'awa' boolean (default off)
794 global
795 {not in Vi}
796 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
797 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
798 Setting this option also implies that Vim behaves like 'autowrite' has
799 been set.
800
801 *'background'* *'bg'*
802'background' 'bg' string (default "dark" or "light")
803 global
804 {not in Vi}
805 When set to "dark", Vim will try to use colors that look good on a
806 dark background. When set to "light", Vim will try to use colors that
807 look good on a light background. Any other value is illegal.
808 Vim tries to set the default value according to the terminal used.
809 This will not always be correct.
810 Setting this option does not change the background color, it tells Vim
811 what the background color looks like. For changing the background
812 color, see |:hi-normal|.
813
814 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000815 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000816 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100817 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 setting 'background' will cause the color scheme to be reloaded. If
819 the color scheme adjusts to the value of 'background' this will work.
820 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100821 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822
823 When setting 'background' to the default value with: >
824 :set background&
825< Vim will guess the value. In the GUI this should work correctly,
826 in other cases Vim might not be able to guess the right value.
827
828 When starting the GUI, the default value for 'background' will be
829 "light". When the value is not set in the .gvimrc, and Vim detects
830 that the background is actually quite dark, 'background' is set to
831 "dark". But this happens only AFTER the .gvimrc file has been read
832 (because the window needs to be opened to find the actual background
833 color). To get around this, force the GUI window to be opened by
834 putting a ":gui" command in the .gvimrc file, before where the value
835 of 'background' is used (e.g., before ":syntax on").
836 Normally this option would be set in the .vimrc file. Possibly
837 depending on the terminal name. Example: >
838 :if &term == "pcterm"
839 : set background=dark
840 :endif
841< When this option is set, the default settings for the highlight groups
842 will change. To use other settings, place ":highlight" commands AFTER
843 the setting of the 'background' option.
844 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
845 to select the colors for syntax highlighting. After changing this
846 option, you must load syntax.vim again to see the result. This can be
847 done with ":syntax on".
848
849 *'backspace'* *'bs'*
850'backspace' 'bs' string (default "")
851 global
852 {not in Vi}
853 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
854 mode. This is a list of items, separated by commas. Each item allows
855 a way to backspace over something:
856 value effect ~
857 indent allow backspacing over autoindent
858 eol allow backspacing over line breaks (join lines)
859 start allow backspacing over the start of insert; CTRL-W and CTRL-U
860 stop once at the start of insert.
861
862 When the value is empty, Vi compatible backspacing is used.
863
864 For backwards compatibility with version 5.4 and earlier:
865 value effect ~
866 0 same as ":set backspace=" (Vi compatible)
867 1 same as ":set backspace=indent,eol"
868 2 same as ":set backspace=indent,eol,start"
869
870 See |:fixdel| if your <BS> or <Del> key does not do what you want.
871 NOTE: This option is set to "" when 'compatible' is set.
872
873 *'backup'* *'bk'* *'nobackup'* *'nobk'*
874'backup' 'bk' boolean (default off)
875 global
876 {not in Vi}
877 Make a backup before overwriting a file. Leave it around after the
878 file has been successfully written. If you do not want to keep the
879 backup file, but you do want a backup while the file is being
880 written, reset this option and set the 'writebackup' option (this is
881 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000882 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 |backup-table| for more explanations.
884 When the 'backupskip' pattern matches, a backup is not made anyway.
885 When 'patchmode' is set, the backup may be renamed to become the
886 oldest version of a file.
887 NOTE: This option is reset when 'compatible' is set.
888
889 *'backupcopy'* *'bkc'*
890'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
891 global
892 {not in Vi}
893 When writing a file and a backup is made, this option tells how it's
894 done. This is a comma separated list of words.
895
896 The main values are:
897 "yes" make a copy of the file and overwrite the original one
898 "no" rename the file and write a new one
899 "auto" one of the previous, what works best
900
901 Extra values that can be combined with the ones above are:
902 "breaksymlink" always break symlinks when writing
903 "breakhardlink" always break hardlinks when writing
904
905 Making a copy and overwriting the original file:
906 - Takes extra time to copy the file.
907 + When the file has special attributes, is a (hard/symbolic) link or
908 has a resource fork, all this is preserved.
909 - When the file is a link the backup will have the name of the link,
910 not of the real file.
911
912 Renaming the file and writing a new one:
913 + It's fast.
914 - Sometimes not all attributes of the file can be copied to the new
915 file.
916 - When the file is a link the new file will not be a link.
917
918 The "auto" value is the middle way: When Vim sees that renaming file
919 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000920 the file is not a link) that is used. When problems are expected, a
921 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922
923 The "breaksymlink" and "breakhardlink" values can be used in
924 combination with any of "yes", "no" and "auto". When included, they
925 force Vim to always break either symbolic or hard links by doing
926 exactly what the "no" option does, renaming the original file to
927 become the backup and writing a new file in its place. This can be
928 useful for example in source trees where all the files are symbolic or
929 hard links and any changes should stay in the local source tree, not
930 be propagated back to the original source.
931 *crontab*
932 One situation where "no" and "auto" will cause problems: A program
933 that opens a file, invokes Vim to edit that file, and then tests if
934 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000935 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 example.
937
938 When a copy is made, the original file is truncated and then filled
939 with the new text. This means that protection bits, owner and
940 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000941 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 group of the backup is set to the group of the original file. If this
943 fails, the protection bits for the group are made the same as for
944 others.
945
946 When the file is renamed this is the other way around: The backup has
947 the same attributes of the original file, and the newly written file
948 is owned by the current user. When the file was a (hard/symbolic)
949 link, the new file will not! That's why the "auto" value doesn't
950 rename when the file is a link. The owner and group of the newly
951 written file will be set to the same ones as the original file, but
952 the system may refuse to do this. In that case the "auto" value will
953 again not rename the file.
954
955 *'backupdir'* *'bdir'*
956'backupdir' 'bdir' string (default for Amiga: ".,t:",
957 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
958 for Unix: ".,~/tmp,~/")
959 global
960 {not in Vi}
961 List of directories for the backup file, separated with commas.
962 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100963 where this is possible. The directory must exist, Vim will not
964 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 - Empty means that no backup file will be created ('patchmode' is
966 impossible!). Writing may fail because of this.
967 - A directory "." means to put the backup file in the same directory
968 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000969 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 put the backup file relative to where the edited file is. The
971 leading "." is replaced with the path name of the edited file.
972 ("." inside a directory name has no special meaning).
973 - Spaces after the comma are ignored, other spaces are considered part
974 of the directory name. To have a space at the start of a directory
975 name, precede it with a backslash.
976 - To include a comma in a directory name precede it with a backslash.
977 - A directory name may end in an '/'.
978 - Environment variables are expanded |:set_env|.
979 - Careful with '\' characters, type one before a space, type two to
980 get one in the option (see |option-backslash|), for example: >
981 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
982< - For backwards compatibility with Vim version 3.0 a '>' at the start
983 of the option is removed.
984 See also 'backup' and 'writebackup' options.
985 If you want to hide your backup files on Unix, consider this value: >
986 :set backupdir=./.backup,~/.backup,.,/tmp
987< You must create a ".backup" directory in each directory and in your
988 home directory for this to work properly.
989 The use of |:set+=| and |:set-=| is preferred when adding or removing
990 directories from the list. This avoids problems when a future version
991 uses another default.
992 This option cannot be set from a |modeline| or in the |sandbox|, for
993 security reasons.
994
995 *'backupext'* *'bex'* *E589*
996'backupext' 'bex' string (default "~", for VMS: "_")
997 global
998 {not in Vi}
999 String which is appended to a file name to make the name of the
1000 backup file. The default is quite unusual, because this avoids
1001 accidentally overwriting existing files with a backup file. You might
1002 prefer using ".bak", but make sure that you don't have files with
1003 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001004 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001006 If you like to keep a lot of backups, you could use a BufWritePre
1007 autocommand to change 'backupext' just before writing the file to
1008 include a timestamp. >
1009 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1010< Use 'backupdir' to put the backup in a different directory.
1011
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 *'backupskip'* *'bsk'*
1013'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1014 global
1015 {not in Vi}
1016 {not available when compiled without the |+wildignore|
1017 feature}
1018 A list of file patterns. When one of the patterns matches with the
1019 name of the file which is written, no backup file is created. Both
1020 the specified file name and the full path name of the file are used.
1021 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1022 Watch out for special characters, see |option-backslash|.
1023 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001024 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001025
1026 Note that environment variables are not expanded. If you want to use
1027 $HOME you must expand it explicitly, e.g.: >
1028 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1029
1030< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001031 backup would be made by renaming the original file crontab won't see
1032 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033
1034 *'balloondelay'* *'bdlay'*
1035'balloondelay' 'bdlay' number (default: 600)
1036 global
1037 {not in Vi}
1038 {only available when compiled with the |+balloon_eval|
1039 feature}
1040 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1041
1042 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1043'ballooneval' 'beval' boolean (default off)
1044 global
1045 {not in Vi}
1046 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001047 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 Switch on the |balloon-eval| functionality.
1049
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001050 *'balloonexpr'* *'bexpr'*
1051'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001052 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001053 {not in Vi}
1054 {only available when compiled with the |+balloon_eval|
1055 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001056 Expression for text to show in evaluation balloon. It is only used
1057 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001058
1059 v:beval_bufnr number of the buffer in which balloon is going to show
1060 v:beval_winnr number of the window
1061 v:beval_lnum line number
1062 v:beval_col column number (byte index)
1063 v:beval_text word under or after the mouse pointer
1064
1065 The evaluation of the expression must not have side effects!
1066 Example: >
1067 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001068 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001069 \', column ' . v:beval_col .
1070 \ ' of file ' . bufname(v:beval_bufnr) .
1071 \ ' on word "' . v:beval_text . '"'
1072 endfunction
1073 set bexpr=MyBalloonExpr()
1074 set ballooneval
1075<
1076 NOTE: The balloon is displayed only if the cursor is on a text
1077 character. If the result of evaluating 'balloonexpr' is not empty,
1078 Vim does not try to send a message to an external debugger (Netbeans
1079 or Sun Workshop).
1080
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001081 The expression may be evaluated in the |sandbox|, see
1082 |sandbox-option|.
1083
1084 It is not allowed to change text or jump to another window while
1085 evaluating 'balloonexpr' |textlock|.
1086
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001087 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001088 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001089< When they are supported "\n" characters will start a new line. If the
1090 expression evaluates to a |List| this is equal to using each List item
1091 as a string and putting "\n" in between them.
1092
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1094'binary' 'bin' boolean (default off)
1095 local to buffer
1096 {not in Vi}
1097 This option should be set before editing a binary file. You can also
1098 use the |-b| Vim argument. When this option is switched on a few
1099 options will be changed (also when it already was on):
1100 'textwidth' will be set to 0
1101 'wrapmargin' will be set to 0
1102 'modeline' will be off
1103 'expandtab' will be off
1104 Also, 'fileformat' and 'fileformats' options will not be used, the
1105 file is read and written like 'fileformat' was "unix" (a single <NL>
1106 separates lines).
1107 The 'fileencoding' and 'fileencodings' options will not be used, the
1108 file is read without conversion.
1109 NOTE: When you start editing a(nother) file while the 'bin' option is
1110 on, settings from autocommands may change the settings again (e.g.,
1111 'textwidth'), causing trouble when editing. You might want to set
1112 'bin' again when the file has been loaded.
1113 The previous values of these options are remembered and restored when
1114 'bin' is switched from on to off. Each buffer has its own set of
1115 saved option values.
1116 To edit a file with 'binary' set you can use the |++bin| argument.
1117 This avoids you have to do ":set bin", which would have effect for all
1118 files you edit.
1119 When writing a file the <EOL> for the last line is only written if
1120 there was one in the original file (normally Vim appends an <EOL> to
1121 the last line if there is none; this would make the file longer). See
1122 the 'endofline' option.
1123
1124 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1125'bioskey' 'biosk' boolean (default on)
1126 global
1127 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001128 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129 better to detect CTRL-C, but only works for the console. When using a
1130 terminal over a serial port reset this option.
1131 Also see |'conskey'|.
1132
1133 *'bomb'* *'nobomb'*
1134'bomb' boolean (default off)
1135 local to buffer
1136 {not in Vi}
1137 {only available when compiled with the |+multi_byte|
1138 feature}
1139 When writing a file and the following conditions are met, a BOM (Byte
1140 Order Mark) is prepended to the file:
1141 - this option is on
1142 - the 'binary' option is off
1143 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1144 endian variants.
1145 Some applications use the BOM to recognize the encoding of the file.
1146 Often used for UCS-2 files on MS-Windows. For other applications it
1147 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001148 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1150 check for the presence of the BOM is done and 'bomb' set accordingly.
1151 Unless 'binary' is set, it is removed from the first line, so that you
1152 don't see it when editing. When you don't change the options, the BOM
1153 will be restored when writing the file.
1154
1155 *'breakat'* *'brk'*
1156'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1157 global
1158 {not in Vi}
1159 {not available when compiled without the |+linebreak|
1160 feature}
1161 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001162 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1163 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164
1165 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001166'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001168 {not in Vi} {only for Motif, Athena, GTK, Mac and
1169 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001171 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001172 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 buffer Use the directory of the related buffer.
1174 current Use the current directory.
1175 {path} Use the specified directory
1176
1177 *'bufhidden'* *'bh'*
1178'bufhidden' 'bh' string (default: "")
1179 local to buffer
1180 {not in Vi}
1181 {not available when compiled without the |+quickfix|
1182 feature}
1183 This option specifies what happens when a buffer is no longer
1184 displayed in a window:
1185 <empty> follow the global 'hidden' option
1186 hide hide the buffer (don't unload it), also when 'hidden'
1187 is not set
1188 unload unload the buffer, also when 'hidden' is set or using
1189 |:hide|
1190 delete delete the buffer from the buffer list, also when
1191 'hidden' is set or using |:hide|, like using
1192 |:bdelete|
1193 wipe wipe out the buffer from the buffer list, also when
1194 'hidden' is set or using |:hide|, like using
1195 |:bwipeout|
1196
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001197 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1198 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 This option is used together with 'buftype' and 'swapfile' to specify
1200 special kinds of buffers. See |special-buffers|.
1201
1202 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1203'buflisted' 'bl' boolean (default: on)
1204 local to buffer
1205 {not in Vi}
1206 When this option is set, the buffer shows up in the buffer list. If
1207 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1208 This option is reset by Vim for buffers that are only used to remember
1209 a file name or marks. Vim sets it when starting to edit a buffer.
1210 But not when moving to a buffer with ":buffer".
1211
1212 *'buftype'* *'bt'* *E382*
1213'buftype' 'bt' string (default: "")
1214 local to buffer
1215 {not in Vi}
1216 {not available when compiled without the |+quickfix|
1217 feature}
1218 The value of this option specifies the type of a buffer:
1219 <empty> normal buffer
1220 nofile buffer which is not related to a file and will not be
1221 written
1222 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001223 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001224 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001225 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001227 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228 help help buffer (you are not supposed to set this
1229 manually)
1230
1231 This option is used together with 'bufhidden' and 'swapfile' to
1232 specify special kinds of buffers. See |special-buffers|.
1233
1234 Be careful with changing this option, it can have many side effects!
1235
Bram Moolenaar280f1262006-01-30 00:14:18 +00001236 A "quickfix" buffer is only used for the error list and the location
1237 list. This value is set by the |:cwindow| and |:lwindow| commands and
1238 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239
1240 "nofile" and "nowrite" buffers are similar:
1241 both: The buffer is not to be written to disk, ":w" doesn't
1242 work (":w filename" does work though).
1243 both: The buffer is never considered to be |'modified'|.
1244 There is no warning when the changes will be lost, for
1245 example when you quit Vim.
1246 both: A swap file is only created when using too much memory
1247 (when 'swapfile' has been reset there is never a swap
1248 file).
1249 nofile only: The buffer name is fixed, it is not handled like a
1250 file name. It is not modified in response to a |:cd|
1251 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001252 *E676*
1253 "acwrite" implies that the buffer name is not related to a file, like
1254 "nofile", but it will be written. Thus, in contrast to "nofile" and
1255 "nowrite", ":w" does work and a modified buffer can't be abandoned
1256 without saving. For writing there must be matching |BufWriteCmd|,
1257 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258
1259 *'casemap'* *'cmp'*
1260'casemap' 'cmp' string (default: "internal,keepascii")
1261 global
1262 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001263 {only available when compiled with the |+multi_byte|
1264 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 Specifies details about changing the case of letters. It may contain
1266 these words, separated by a comma:
1267 internal Use internal case mapping functions, the current
1268 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001269 matters when 'encoding' is a Unicode encoding,
1270 "latin1" or "iso-8859-15". When "internal" is
1271 omitted, the towupper() and towlower() system library
1272 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1274 case mapping, the current locale is not effective.
1275 This probably only matters for Turkish.
1276
1277 *'cdpath'* *'cd'* *E344* *E346*
1278'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1279 global
1280 {not in Vi}
1281 {not available when compiled without the
1282 |+file_in_path| feature}
1283 This is a list of directories which will be searched when using the
1284 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001285 for has a relative path, not an absolute part starting with "/", "./"
1286 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 The 'cdpath' option's value has the same form and semantics as
1288 |'path'|. Also see |file-searching|.
1289 The default value is taken from $CDPATH, with a "," prepended to look
1290 in the current directory first.
1291 If the default value taken from $CDPATH is not what you want, include
1292 a modified version of the following command in your vimrc file to
1293 override it: >
1294 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1295< This option cannot be set from a |modeline| or in the |sandbox|, for
1296 security reasons.
1297 (parts of 'cdpath' can be passed to the shell to expand file names).
1298
1299 *'cedit'*
1300'cedit' string (Vi default: "", Vim default: CTRL-F)
1301 global
1302 {not in Vi}
1303 {not available when compiled without the |+vertsplit|
1304 feature}
1305 The key used in Command-line Mode to open the command-line window.
1306 The default is CTRL-F when 'compatible' is off.
1307 Only non-printable keys are allowed.
1308 The key can be specified as a single character, but it is difficult to
1309 type. The preferred way is to use the <> notation. Examples: >
1310 :set cedit=<C-Y>
1311 :set cedit=<Esc>
1312< |Nvi| also has this option, but it only uses the first character.
1313 See |cmdwin|.
1314
1315 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1316'charconvert' 'ccv' string (default "")
1317 global
1318 {only available when compiled with the |+multi_byte|
1319 feature and the |+eval| feature}
1320 {not in Vi}
1321 An expression that is used for character encoding conversion. It is
1322 evaluated when a file that is to be read or has been written has a
1323 different encoding from what is desired.
1324 'charconvert' is not used when the internal iconv() function is
1325 supported and is able to do the conversion. Using iconv() is
1326 preferred, because it is much faster.
1327 'charconvert' is not used when reading stdin |--|, because there is no
1328 file to convert from. You will have to save the text in a file first.
1329 The expression must return zero or an empty string for success,
1330 non-zero for failure.
1331 The possible encoding names encountered are in 'encoding'.
1332 Additionally, names given in 'fileencodings' and 'fileencoding' are
1333 used.
1334 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1335 is done internally by Vim, 'charconvert' is not used for this.
1336 'charconvert' is also used to convert the viminfo file, if the 'c'
1337 flag is present in 'viminfo'. Also used for Unicode conversion.
1338 Example: >
1339 set charconvert=CharConvert()
1340 fun CharConvert()
1341 system("recode "
1342 \ . v:charconvert_from . ".." . v:charconvert_to
1343 \ . " <" . v:fname_in . " >" v:fname_out)
1344 return v:shell_error
1345 endfun
1346< The related Vim variables are:
1347 v:charconvert_from name of the current encoding
1348 v:charconvert_to name of the desired encoding
1349 v:fname_in name of the input file
1350 v:fname_out name of the output file
1351 Note that v:fname_in and v:fname_out will never be the same.
1352 Note that v:charconvert_from and v:charconvert_to may be different
1353 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1354 Encryption is not done by Vim when using 'charconvert'. If you want
1355 to encrypt the file after conversion, 'charconvert' should take care
1356 of this.
1357 This option cannot be set from a |modeline| or in the |sandbox|, for
1358 security reasons.
1359
1360 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1361'cindent' 'cin' boolean (default off)
1362 local to buffer
1363 {not in Vi}
1364 {not available when compiled without the |+cindent|
1365 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001366 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 that trigger reindenting in insert mode and 'cinoptions' to set your
1368 preferred indent style.
1369 If 'indentexpr' is not empty, it overrules 'cindent'.
1370 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1371 the "=" operator indents using this algorithm rather than calling an
1372 external program.
1373 See |C-indenting|.
1374 When you don't like the way 'cindent' works, try the 'smartindent'
1375 option or 'indentexpr'.
1376 This option is not used when 'paste' is set.
1377 NOTE: This option is reset when 'compatible' is set.
1378
1379 *'cinkeys'* *'cink'*
1380'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1381 local to buffer
1382 {not in Vi}
1383 {not available when compiled without the |+cindent|
1384 feature}
1385 A list of keys that, when typed in Insert mode, cause reindenting of
1386 the current line. Only used if 'cindent' is on and 'indentexpr' is
1387 empty.
1388 For the format of this option see |cinkeys-format|.
1389 See |C-indenting|.
1390
1391 *'cinoptions'* *'cino'*
1392'cinoptions' 'cino' string (default "")
1393 local to buffer
1394 {not in Vi}
1395 {not available when compiled without the |+cindent|
1396 feature}
1397 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1398 program. See |cinoptions-values| for the values of this option, and
1399 |C-indenting| for info on C indenting in general.
1400
1401
1402 *'cinwords'* *'cinw'*
1403'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1404 local to buffer
1405 {not in Vi}
1406 {not available when compiled without both the
1407 |+cindent| and the |+smartindent| features}
1408 These keywords start an extra indent in the next line when
1409 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1410 an appropriate place (inside {}).
1411 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1412 matter, include the keyword both the uppercase and lowercase:
1413 "if,If,IF".
1414
1415 *'clipboard'* *'cb'*
1416'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1417 for X-windows, "" otherwise)
1418 global
1419 {not in Vi}
1420 {only in GUI versions or when the |+xterm_clipboard|
1421 feature is included}
1422 This option is a list of comma separated names.
1423 These names are recognized:
1424
1425 unnamed When included, Vim will use the clipboard register '*'
1426 for all yank, delete, change and put operations which
1427 would normally go to the unnamed register. When a
1428 register is explicitly specified, it will always be
1429 used regardless of whether "unnamed" is in 'clipboard'
1430 or not. The clipboard register can always be
1431 explicitly accessed using the "* notation. Also see
1432 |gui-clipboard|.
1433
1434 autoselect Works like the 'a' flag in 'guioptions': If present,
1435 then whenever Visual mode is started, or the Visual
1436 area extended, Vim tries to become the owner of the
1437 windowing system's global selection or put the
1438 selected text on the clipboard used by the selection
1439 register "*. See |guioptions_a| and |quotestar| for
1440 details. When the GUI is active, the 'a' flag in
1441 'guioptions' is used, when the GUI is not active, this
1442 "autoselect" flag is used.
1443 Also applies to the modeless selection.
1444
1445 autoselectml Like "autoselect", but for the modeless selection
1446 only. Compare to the 'A' flag in 'guioptions'.
1447
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001448 html When the clipboard contains HTML, use this when
1449 pasting. When putting text on the clipboard, mark it
1450 as HTML. This works to copy rendered HTML from
1451 Firefox, paste it as raw HTML in Vim, select the HTML
1452 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001453 You probably want to add this only temporarily,
1454 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001455 Only supported for GTK version 2 and later.
1456 Only available with the |+multi_byte| feature.
1457
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458 exclude:{pattern}
1459 Defines a pattern that is matched against the name of
1460 the terminal 'term'. If there is a match, no
1461 connection will be made to the X server. This is
1462 useful in this situation:
1463 - Running Vim in a console.
1464 - $DISPLAY is set to start applications on another
1465 display.
1466 - You do not want to connect to the X server in the
1467 console, but do want this in a terminal emulator.
1468 To never connect to the X server use: >
1469 exclude:.*
1470< This has the same effect as using the |-X| argument.
1471 Note that when there is no connection to the X server
1472 the window title won't be restored and the clipboard
1473 cannot be accessed.
1474 The value of 'magic' is ignored, {pattern} is
1475 interpreted as if 'magic' was on.
1476 The rest of the option value will be used for
1477 {pattern}, this must be the last entry.
1478
1479 *'cmdheight'* *'ch'*
1480'cmdheight' 'ch' number (default 1)
1481 global
1482 {not in Vi}
1483 Number of screen lines to use for the command-line. Helps avoiding
1484 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001485 The value of this option is stored with the tab page, so that each tab
1486 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487
1488 *'cmdwinheight'* *'cwh'*
1489'cmdwinheight' 'cwh' number (default 7)
1490 global
1491 {not in Vi}
1492 {not available when compiled without the |+vertsplit|
1493 feature}
1494 Number of screen lines to use for the command-line window. |cmdwin|
1495
1496 *'columns'* *'co'* *E594*
1497'columns' 'co' number (default 80 or terminal width)
1498 global
1499 {not in Vi}
1500 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001501 initialization and does not have to be set by hand. Also see
1502 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503 When Vim is running in the GUI or in a resizable window, setting this
1504 option will cause the window size to be changed. When you only want
1505 to use the size for the GUI, put the command in your |gvimrc| file.
1506 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001507 number of columns of the display, the display may be messed up. For
1508 the GUI it is always possible and Vim limits the number of columns to
1509 what fits on the screen. You can use this command to get the widest
1510 window possible: >
1511 :set columns=9999
1512< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513
1514 *'comments'* *'com'* *E524* *E525*
1515'comments' 'com' string (default
1516 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1517 local to buffer
1518 {not in Vi}
1519 {not available when compiled without the |+comments|
1520 feature}
1521 A comma separated list of strings that can start a comment line. See
1522 |format-comments|. See |option-backslash| about using backslashes to
1523 insert a space.
1524
1525 *'commentstring'* *'cms'* *E537*
1526'commentstring' 'cms' string (default "/*%s*/")
1527 local to buffer
1528 {not in Vi}
1529 {not available when compiled without the |+folding|
1530 feature}
1531 A template for a comment. The "%s" in the value is replaced with the
1532 comment text. Currently only used to add markers for folding, see
1533 |fold-marker|.
1534
1535 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001536'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1537 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 global
1539 {not in Vi}
1540 This option has the effect of making Vim either more Vi-compatible, or
1541 make Vim behave in a more useful way.
1542 This is a special kind of option, because when it's set or reset,
1543 other options are also changed as a side effect. CAREFUL: Setting or
1544 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001545 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 set this option in your vimrc file, you should probably put it at the
1547 very start.
1548 By default this option is on and the Vi defaults are used for the
1549 options. This default was chosen for those people who want to use Vim
1550 just like Vi, and don't even (want to) know about the 'compatible'
1551 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001552 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001553 this option is switched off, and all options that have not been
1554 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001555 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001556 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001557 happen for the system-wide vimrc or gvimrc file, nor for a file given
1558 with the |-u| argument). Also see |compatible-default| and
1559 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 You can also set this option with the "-C" argument, and reset it with
1561 "-N". See |-C| and |-N|.
1562 Switching this option off makes the Vim defaults be used for options
1563 that have a different Vi and Vim default value. See the options
1564 marked with a '+' below. Other options are not modified.
1565 At the moment this option is set, several other options will be set
1566 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001567 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 editing.
1569 See also 'cpoptions'.
1570
1571 option + set value effect ~
1572
1573 'allowrevins' off no CTRL-_ command
1574 'backupcopy' Unix: "yes" backup file is a copy
1575 others: "auto" copy or rename backup file
1576 'backspace' "" normal backspace
1577 'backup' off no backup file
1578 'cindent' off no C code indentation
1579 'cedit' + "" no key to open the |cmdwin|
1580 'cpoptions' + (all flags) Vi-compatible flags
1581 'cscopetag' off don't use cscope for ":tag"
1582 'cscopetagorder' 0 see |cscopetagorder|
1583 'cscopeverbose' off see |cscopeverbose|
1584 'digraph' off no digraphs
1585 'esckeys' + off no <Esc>-keys in Insert mode
1586 'expandtab' off tabs not expanded to spaces
1587 'fileformats' + "" no automatic file format detection,
1588 "dos,unix" except for DOS, Windows and OS/2
1589 'formatoptions' + "vt" Vi compatible formatting
1590 'gdefault' off no default 'g' flag for ":s"
1591 'history' + 0 no commandline history
1592 'hkmap' off no Hebrew keyboard mapping
1593 'hkmapp' off no phonetic Hebrew keyboard mapping
1594 'hlsearch' off no highlighting of search matches
1595 'incsearch' off no incremental searching
1596 'indentexpr' "" no indenting by expression
1597 'insertmode' off do not start in Insert mode
1598 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1599 characters and '_'
1600 'joinspaces' on insert 2 spaces after period
1601 'modeline' + off no modelines
1602 'more' + off no pauses in listings
1603 'revins' off no reverse insert
1604 'ruler' off no ruler
1605 'scrolljump' 1 no jump scroll
1606 'scrolloff' 0 no scroll offset
1607 'shiftround' off indent not rounded to shiftwidth
1608 'shortmess' + "" no shortening of messages
1609 'showcmd' + off command characters not shown
1610 'showmode' + off current mode not shown
1611 'smartcase' off no automatic ignore case switch
1612 'smartindent' off no smart indentation
1613 'smarttab' off no smart tab size
1614 'softtabstop' 0 tabs are always 'tabstop' positions
1615 'startofline' on goto startofline with some commands
1616 'tagrelative' + off tag file names are not relative
1617 'textauto' + off no automatic textmode detection
1618 'textwidth' 0 no automatic line wrap
1619 'tildeop' off tilde is not an operator
1620 'ttimeout' off no terminal timeout
1621 'whichwrap' + "" left-right movements don't wrap
1622 'wildchar' + CTRL-E only when the current value is <Tab>
1623 use CTRL-E for cmdline completion
1624 'writebackup' on or off depends on +writebackup feature
1625
1626 *'complete'* *'cpt'* *E535*
1627'complete' 'cpt' string (default: ".,w,b,u,t,i")
1628 local to buffer
1629 {not in Vi}
1630 This option specifies how keyword completion |ins-completion| works
1631 when CTRL-P or CTRL-N are used. It is also used for whole-line
1632 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1633 and the places to scan. It is a comma separated list of flags:
1634 . scan the current buffer ('wrapscan' is ignored)
1635 w scan buffers from other windows
1636 b scan other loaded buffers that are in the buffer list
1637 u scan the unloaded buffers that are in the buffer list
1638 U scan the buffers that are not in the buffer list
1639 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001640 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 k{dict} scan the file {dict}. Several "k" flags can be given,
1642 patterns are valid too. For example: >
1643 :set cpt=k/usr/dict/*,k~/spanish
1644< s scan the files given with the 'thesaurus' option
1645 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1646 are valid too.
1647 i scan current and included files
1648 d scan current and included files for defined name or macro
1649 |i_CTRL-X_CTRL-D|
1650 ] tag completion
1651 t same as "]"
1652
1653 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1654 not executed, this may lead to unexpected completions from some files
1655 (gzipped files for example). Unloaded buffers are not scanned for
1656 whole-line completion.
1657
1658 The default is ".,w,b,u,t,i", which means to scan:
1659 1. the current buffer
1660 2. buffers in other windows
1661 3. other loaded buffers
1662 4. unloaded buffers
1663 5. tags
1664 6. included files
1665
1666 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001667 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1668 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001670 *'completefunc'* *'cfu'*
1671'completefunc' 'cfu' string (default: empty)
1672 local to buffer
1673 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001674 {not available when compiled without the +eval
1675 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001676 This option specifies a function to be used for Insert mode completion
1677 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001678 See |complete-functions| for an explanation of how the function is
1679 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001680
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001681
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001682 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001683'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001684 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001685 {not available when compiled without the
1686 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001687 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001688 A comma separated list of options for Insert mode completion
1689 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001690
1691 menu Use a popup menu to show the possible completions. The
1692 menu is only shown when there is more than one match and
1693 sufficient colors are available. |ins-completion-menu|
1694
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001695 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001696 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001697 match, e.g., what file it comes from.
1698
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001699 longest Only insert the longest common text of the matches. If
1700 the menu is displayed you can use CTRL-L to add more
1701 characters. Whether case is ignored depends on the kind
1702 of completion. For buffer text the 'ignorecase' option is
1703 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001704
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001705 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001706 completion in the preview window. Only works in
1707 combination with "menu" or "menuone".
1708
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001709
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001710 *'concealcursor'* *'cocu'*
1711'concealcursor' 'cocu' string (default: "")
1712 local to window
1713 {not in Vi}
1714 {not available when compiled without the |+conceal|
1715 feature}
1716 Sets the modes in which text in the cursor line can also be concealed.
1717 When the current mode is listed then concealing happens just like in
1718 other lines.
1719 n Normal mode
1720 v Visual mode
1721 i Insert mode
1722
1723 A useful value is "n". This is used in help files. So long as you
1724 are moving around text is concealed, but when starting to insert text
1725 or selecting a Visual area the concealed text is displayed, so that
1726 you can see what you are doing.
1727
1728
1729'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001730 number (default 0)
1731 local to window
1732 {not in Vi}
1733 {not available when compiled without the |+conceal|
1734 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001735 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1736 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001737
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001738 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001739 0 Text is shown normally
1740 1 Each block of concealed text is replaced with the
1741 character defined in 'listchars' (default is a dash)
1742 and highlighted with the "Conceal" highlight group.
1743 2 Concealed text is completely hidden unless it has a
1744 custom replacement character defined (see
1745 |:syn-cchar|.
Bram Moolenaara7781e02010-07-19 20:13:22 +02001746 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001747
Bram Moolenaara7781e02010-07-19 20:13:22 +02001748 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001749 edit and copy the text. This can be changed with the 'concealcursor'
1750 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001751
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1753'confirm' 'cf' boolean (default off)
1754 global
1755 {not in Vi}
1756 When 'confirm' is on, certain operations that would normally
1757 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1758 instead raise a |dialog| asking if you wish to save the current
1759 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1760 If 'confirm' is off you can still activate confirmation for one
1761 command only (this is most useful in mappings) with the |:confirm|
1762 command.
1763 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1764
1765 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1766'conskey' 'consk' boolean (default off)
1767 global
1768 {not in Vi} {only for MS-DOS}
1769 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001770 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771 three methods of console input are available:
1772 'conskey' 'bioskey' action ~
1773 on on or off direct console input
1774 off on BIOS
1775 off off STDIN
1776
1777 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1778'copyindent' 'ci' boolean (default off)
1779 local to buffer
1780 {not in Vi}
1781 Copy the structure of the existing lines indent when autoindenting a
1782 new line. Normally the new indent is reconstructed by a series of
1783 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1784 in which case only spaces are used). Enabling this option makes the
1785 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001786 existing line. 'expandtab' has no effect on these characters, a Tab
1787 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 line, the remaining space is filled in the normal manner.
1789 NOTE: 'copyindent' is reset when 'compatible' is set.
1790 Also see 'preserveindent'.
1791
1792 *'cpoptions'* *'cpo'*
1793'cpoptions' 'cpo' string (Vim default: "aABceFs",
1794 Vi default: all flags)
1795 global
1796 {not in Vi}
1797 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001798 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 not being vi-compatible is mostly or sometimes preferred.
1800 'cpoptions' stands for "compatible-options".
1801 Commas can be added for readability.
1802 To avoid problems with flags that are added in the future, use the
1803 "+=" and "-=" feature of ":set" |add-option-flags|.
1804 NOTE: This option is set to the Vi default value when 'compatible' is
1805 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001806 NOTE: This option is set to the POSIX default value at startup when
1807 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001808 variable exists |posix|. This means Vim tries to behave like the
1809 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810
1811 contains behavior ~
1812 *cpo-a*
1813 a When included, a ":read" command with a file name
1814 argument will set the alternate file name for the
1815 current window.
1816 *cpo-A*
1817 A When included, a ":write" command with a file name
1818 argument will set the alternate file name for the
1819 current window.
1820 *cpo-b*
1821 b "\|" in a ":map" command is recognized as the end of
1822 the map command. The '\' is included in the mapping,
1823 the text after the '|' is interpreted as the next
1824 command. Use a CTRL-V instead of a backslash to
1825 include the '|' in the mapping. Applies to all
1826 mapping, abbreviation, menu and autocmd commands.
1827 See also |map_bar|.
1828 *cpo-B*
1829 B A backslash has no special meaning in mappings,
1830 abbreviations and the "to" part of the menu commands.
1831 Remove this flag to be able to use a backslash like a
1832 CTRL-V. For example, the command ":map X \<Esc>"
1833 results in X being mapped to:
1834 'B' included: "\^[" (^[ is a real <Esc>)
1835 'B' excluded: "<Esc>" (5 characters)
1836 ('<' excluded in both cases)
1837 *cpo-c*
1838 c Searching continues at the end of any match at the
1839 cursor position, but not further than the start of the
1840 next line. When not present searching continues
1841 one character from the cursor position. With 'c'
1842 "abababababab" only gets three matches when repeating
1843 "/abab", without 'c' there are five matches.
1844 *cpo-C*
1845 C Do not concatenate sourced lines that start with a
1846 backslash. See |line-continuation|.
1847 *cpo-d*
1848 d Using "./" in the 'tags' option doesn't mean to use
1849 the tags file relative to the current file, but the
1850 tags file in the current directory.
1851 *cpo-D*
1852 D Can't use CTRL-K to enter a digraph after Normal mode
1853 commands with a character argument, like |r|, |f| and
1854 |t|.
1855 *cpo-e*
1856 e When executing a register with ":@r", always add a
1857 <CR> to the last line, also when the register is not
1858 linewise. If this flag is not present, the register
1859 is not linewise and the last line does not end in a
1860 <CR>, then the last line is put on the command-line
1861 and can be edited before hitting <CR>.
1862 *cpo-E*
1863 E It is an error when using "y", "d", "c", "g~", "gu" or
1864 "gU" on an Empty region. The operators only work when
1865 at least one character is to be operate on. Example:
1866 This makes "y0" fail in the first column.
1867 *cpo-f*
1868 f When included, a ":read" command with a file name
1869 argument will set the file name for the current buffer,
1870 if the current buffer doesn't have a file name yet.
1871 *cpo-F*
1872 F When included, a ":write" command with a file name
1873 argument will set the file name for the current
1874 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001875 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001876 *cpo-g*
1877 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001878 *cpo-H*
1879 H When using "I" on a line with only blanks, insert
1880 before the last blank. Without this flag insert after
1881 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001882 *cpo-i*
1883 i When included, interrupting the reading of a file will
1884 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001885 *cpo-I*
1886 I When moving the cursor up or down just after inserting
1887 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888 *cpo-j*
1889 j When joining lines, only add two spaces after a '.',
1890 not after '!' or '?'. Also see 'joinspaces'.
1891 *cpo-J*
1892 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001893 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 white space.
1895 *cpo-k*
1896 k Disable the recognition of raw key codes in
1897 mappings, abbreviations, and the "to" part of menu
1898 commands. For example, if <Key> sends ^[OA (where ^[
1899 is <Esc>), the command ":map X ^[OA" results in X
1900 being mapped to:
1901 'k' included: "^[OA" (3 characters)
1902 'k' excluded: "<Key>" (one key code)
1903 Also see the '<' flag below.
1904 *cpo-K*
1905 K Don't wait for a key code to complete when it is
1906 halfway a mapping. This breaks mapping <F1><F1> when
1907 only part of the second <F1> has been read. It
1908 enables cancelling the mapping by typing <F1><Esc>.
1909 *cpo-l*
1910 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001911 literally, only "\]", "\^", "\-" and "\\" are special.
1912 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1914 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001915 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 *cpo-L*
1917 L When the 'list' option is set, 'wrapmargin',
1918 'textwidth', 'softtabstop' and Virtual Replace mode
1919 (see |gR|) count a <Tab> as two characters, instead of
1920 the normal behavior of a <Tab>.
1921 *cpo-m*
1922 m When included, a showmatch will always wait half a
1923 second. When not included, a showmatch will wait half
1924 a second or until a character is typed. |'showmatch'|
1925 *cpo-M*
1926 M When excluded, "%" matching will take backslashes into
1927 account. Thus in "( \( )" and "\( ( \)" the outer
1928 parenthesis match. When included "%" ignores
1929 backslashes, which is Vi compatible.
1930 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001931 n When included, the column used for 'number' and
1932 'relativenumber' will also be used for text of wrapped
1933 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934 *cpo-o*
1935 o Line offset to search command is not remembered for
1936 next search.
1937 *cpo-O*
1938 O Don't complain if a file is being overwritten, even
1939 when it didn't exist when editing it. This is a
1940 protection against a file unexpectedly created by
1941 someone else. Vi didn't complain about this.
1942 *cpo-p*
1943 p Vi compatible Lisp indenting. When not present, a
1944 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001945 *cpo-P*
1946 P When included, a ":write" command that appends to a
1947 file will set the file name for the current buffer, if
1948 the current buffer doesn't have a file name yet and
1949 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001950 *cpo-q*
1951 q When joining multiple lines leave the cursor at the
1952 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953 *cpo-r*
1954 r Redo ("." command) uses "/" to repeat a search
1955 command, instead of the actually used search string.
1956 *cpo-R*
1957 R Remove marks from filtered lines. Without this flag
1958 marks are kept like |:keepmarks| was used.
1959 *cpo-s*
1960 s Set buffer options when entering the buffer for the
1961 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001962 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001963 set when the buffer is created.
1964 *cpo-S*
1965 S Set buffer options always when entering a buffer
1966 (except 'readonly', 'fileformat', 'filetype' and
1967 'syntax'). This is the (most) Vi compatible setting.
1968 The options are set to the values in the current
1969 buffer. When you change an option and go to another
1970 buffer, the value is copied. Effectively makes the
1971 buffer options global to all buffers.
1972
1973 's' 'S' copy buffer options
1974 no no when buffer created
1975 yes no when buffer first entered (default)
1976 X yes each time when buffer entered (vi comp.)
1977 *cpo-t*
1978 t Search pattern for the tag command is remembered for
1979 "n" command. Otherwise Vim only puts the pattern in
1980 the history for search pattern, but doesn't change the
1981 last used search pattern.
1982 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001983 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984 *cpo-v*
1985 v Backspaced characters remain visible on the screen in
1986 Insert mode. Without this flag the characters are
1987 erased from the screen right away. With this flag the
1988 screen newly typed text overwrites backspaced
1989 characters.
1990 *cpo-w*
1991 w When using "cw" on a blank character, only change one
1992 character and not all blanks until the start of the
1993 next word.
1994 *cpo-W*
1995 W Don't overwrite a readonly file. When omitted, ":w!"
1996 overwrites a readonly file, if possible.
1997 *cpo-x*
1998 x <Esc> on the command-line executes the command-line.
1999 The default in Vim is to abandon the command-line,
2000 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002001 *cpo-X*
2002 X When using a count with "R" the replaced text is
2003 deleted only once. Also when repeating "R" with "."
2004 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005 *cpo-y*
2006 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002007 *cpo-Z*
2008 Z When using "w!" while the 'readonly' option is set,
2009 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002010 *cpo-!*
2011 ! When redoing a filter command, use the last used
2012 external command, whatever it was. Otherwise the last
2013 used -filter- command is used.
2014 *cpo-$*
2015 $ When making a change to one line, don't redisplay the
2016 line, but put a '$' at the end of the changed text.
2017 The changed text will be overwritten when you type the
2018 new text. The line is redisplayed if you type any
2019 command that moves the cursor from the insertion
2020 point.
2021 *cpo-%*
2022 % Vi-compatible matching is done for the "%" command.
2023 Does not recognize "#if", "#endif", etc.
2024 Does not recognize "/*" and "*/".
2025 Parens inside single and double quotes are also
2026 counted, causing a string that contains a paren to
2027 disturb the matching. For example, in a line like
2028 "if (strcmp("foo(", s))" the first paren does not
2029 match the last one. When this flag is not included,
2030 parens inside single and double quotes are treated
2031 specially. When matching a paren outside of quotes,
2032 everything inside quotes is ignored. When matching a
2033 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002034 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002035 This flag is also used for other features, such as
2036 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002037 *cpo--*
2038 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002039 it would go above the first line or below the last
2040 line. Without it the cursor moves to the first or
2041 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002042 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002043 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002044 *cpo-+*
2045 + When included, a ":write file" command will reset the
2046 'modified' flag of the buffer, even though the buffer
2047 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002048 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 * Use ":*" in the same way as ":@". When not included,
2050 ":*" is an alias for ":'<,'>", select the Visual area.
2051 *cpo-<*
2052 < Disable the recognition of special key codes in |<>|
2053 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002054 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 ":map X <Tab>" results in X being mapped to:
2056 '<' included: "<Tab>" (5 characters)
2057 '<' excluded: "^I" (^I is a real <Tab>)
2058 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002059 *cpo->*
2060 > When appending to a register, put a line break before
2061 the appended text.
2062
2063 POSIX flags. These are not included in the Vi default value, except
2064 when $VIM_POSIX was set on startup. |posix|
2065
2066 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002067 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002068 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002069 *cpo-&*
2070 & When ":preserve" was used keep the swap file when
2071 exiting normally while this buffer is still loaded.
2072 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002073 *cpo-\*
2074 \ Backslash in a [] range in a search pattern is taken
2075 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002076 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2077 '\' excluded: "/[ \-]" finds <Space> and '-'
2078 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002079 *cpo-/*
2080 / When "%" is used as the replacement string in a |:s|
2081 command, use the previous replacement string. |:s%|
2082 *cpo-{*
2083 { The |{| and |}| commands also stop at a "{" character
2084 at the start of a line.
2085 *cpo-.*
2086 . The ":chdir" and ":cd" commands fail if the current
2087 buffer is modified, unless ! is used. Vim doesn't
2088 need this, since it remembers the full path of an
2089 opened file.
2090 *cpo-bar*
2091 | The value of the $LINES and $COLUMNS environment
2092 variables overrule the terminal size values obtained
2093 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002094
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002096 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002097'cryptmethod' string (default "zip")
2098 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002099 {not in Vi}
2100 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002101 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002102 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002103 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002104 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002105 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002106 or later, files can NOT be read by Vim 7.2 and older.
2107 This adds a "seed" to the file, every time you write
2108 the file the encrypted bytes will be different.
2109
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002110 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002111 to the detected method of the file being read. Thus if you write it
2112 without changing 'cryptmethod' the same method will be used.
2113 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002114 explicitly write it, you don't get a warning unless there are other
2115 modifications. Also see |:X|.
2116
2117 When setting the global value to an empty string, it will end up with
2118 the value "zip". When setting the local value to an empty string the
2119 buffer will use the global value.
2120
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002121 When a new encryption method is added in a later version of Vim, and
2122 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002123 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002124
2125
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 *'cscopepathcomp'* *'cspc'*
2127'cscopepathcomp' 'cspc' number (default 0)
2128 global
2129 {not available when compiled without the |+cscope|
2130 feature}
2131 {not in Vi}
2132 Determines how many components of the path to show in a list of tags.
2133 See |cscopepathcomp|.
2134
2135 *'cscopeprg'* *'csprg'*
2136'cscopeprg' 'csprg' string (default "cscope")
2137 global
2138 {not available when compiled without the |+cscope|
2139 feature}
2140 {not in Vi}
2141 Specifies the command to execute cscope. See |cscopeprg|.
2142 This option cannot be set from a |modeline| or in the |sandbox|, for
2143 security reasons.
2144
2145 *'cscopequickfix'* *'csqf'*
2146'cscopequickfix' 'csqf' string (default "")
2147 global
2148 {not available when compiled without the |+cscope|
2149 or |+quickfix| features}
2150 {not in Vi}
2151 Specifies whether to use quickfix window to show cscope results.
2152 See |cscopequickfix|.
2153
2154 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2155'cscopetag' 'cst' boolean (default off)
2156 global
2157 {not available when compiled without the |+cscope|
2158 feature}
2159 {not in Vi}
2160 Use cscope for tag commands. See |cscope-options|.
2161 NOTE: This option is reset when 'compatible' is set.
2162
2163 *'cscopetagorder'* *'csto'*
2164'cscopetagorder' 'csto' number (default 0)
2165 global
2166 {not available when compiled without the |+cscope|
2167 feature}
2168 {not in Vi}
2169 Determines the order in which ":cstag" performs a search. See
2170 |cscopetagorder|.
2171 NOTE: This option is set to 0 when 'compatible' is set.
2172
2173 *'cscopeverbose'* *'csverb'*
2174 *'nocscopeverbose'* *'nocsverb'*
2175'cscopeverbose' 'csverb' boolean (default off)
2176 global
2177 {not available when compiled without the |+cscope|
2178 feature}
2179 {not in Vi}
2180 Give messages when adding a cscope database. See |cscopeverbose|.
2181 NOTE: This option is reset when 'compatible' is set.
2182
Bram Moolenaar860cae12010-06-05 23:22:07 +02002183 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2184'cursorbind' 'crb' boolean (default off)
2185 local to window
2186 {not in Vi}
2187 {not available when compiled without the |+cursorbind|
2188 feature}
2189 When this option is set, as the cursor in the current
2190 window moves other cursorbound windows (windows that also have
2191 this option set) move their cursors to the corresponding line and
2192 column. This option is useful for viewing the
2193 differences between two versions of a file (see 'diff'); in diff mode,
2194 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002195 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002196
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002197
2198 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2199'cursorcolumn' 'cuc' boolean (default off)
2200 local to window
2201 {not in Vi}
2202 {not available when compiled without the |+syntax|
2203 feature}
2204 Highlight the screen column of the cursor with CursorColumn
2205 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2206 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002207 If you only want the highlighting in the current window you can use
2208 these autocommands: >
2209 au WinLeave * set nocursorline nocursorcolumn
2210 au WinEnter * set cursorline cursorcolumn
2211<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002212
2213 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2214'cursorline' 'cul' boolean (default off)
2215 local to window
2216 {not in Vi}
2217 {not available when compiled without the |+syntax|
2218 feature}
2219 Highlight the screen line of the cursor with CursorLine
2220 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2221 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002222 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002223 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002224
2225
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 *'debug'*
2227'debug' string (default "")
2228 global
2229 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002230 These values can be used:
2231 msg Error messages that would otherwise be omitted will be given
2232 anyway.
2233 throw Error messages that would otherwise be omitted will be given
2234 anyway and also throw an exception and set |v:errmsg|.
2235 beep A message will be given when otherwise only a beep would be
2236 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002237 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002238 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2239 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240
2241 *'define'* *'def'*
2242'define' 'def' string (default "^\s*#\s*define")
2243 global or local to buffer |global-local|
2244 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002245 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 pattern, just like for the "/" command. This option is used for the
2247 commands like "[i" and "[d" |include-search|. The 'isident' option is
2248 used to recognize the defined name after the match:
2249 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2250 See |option-backslash| about inserting backslashes to include a space
2251 or backslash.
2252 The default value is for C programs. For C++ this value would be
2253 useful, to include const type declarations: >
2254 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2255< When using the ":set" command, you need to double the backslashes!
2256
2257 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2258'delcombine' 'deco' boolean (default off)
2259 global
2260 {not in Vi}
2261 {only available when compiled with the |+multi_byte|
2262 feature}
2263 If editing Unicode and this option is set, backspace and Normal mode
2264 "x" delete each combining character on its own. When it is off (the
2265 default) the character along with its combining characters are
2266 deleted.
2267 Note: When 'delcombine' is set "xx" may work different from "2x"!
2268
2269 This is useful for Arabic, Hebrew and many other languages where one
2270 may have combining characters overtop of base characters, and want
2271 to remove only the combining ones.
2272
2273 *'dictionary'* *'dict'*
2274'dictionary' 'dict' string (default "")
2275 global or local to buffer |global-local|
2276 {not in Vi}
2277 List of file names, separated by commas, that are used to lookup words
2278 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2279 contain a list of words. This can be one word per line, or several
2280 words per line, separated by non-keyword characters (white space is
2281 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002282 When this option is empty, or an entry "spell" is present, spell
2283 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002284 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 after a comma are ignored, otherwise spaces are included in the file
2286 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002287 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288 Where to find a list of words?
2289 - On FreeBSD, there is the file "/usr/share/dict/words".
2290 - In the Simtel archive, look in the "msdos/linguist" directory.
2291 - In "miscfiles" of the GNU collection.
2292 The use of |:set+=| and |:set-=| is preferred when adding or removing
2293 directories from the list. This avoids problems when a future version
2294 uses another default.
2295 Backticks cannot be used in this option for security reasons.
2296
2297 *'diff'* *'nodiff'*
2298'diff' boolean (default off)
2299 local to window
2300 {not in Vi}
2301 {not available when compiled without the |+diff|
2302 feature}
2303 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002304 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002305
2306 *'dex'* *'diffexpr'*
2307'diffexpr' 'dex' string (default "")
2308 global
2309 {not in Vi}
2310 {not available when compiled without the |+diff|
2311 feature}
2312 Expression which is evaluated to obtain an ed-style diff file from two
2313 versions of a file. See |diff-diffexpr|.
2314 This option cannot be set from a |modeline| or in the |sandbox|, for
2315 security reasons.
2316
2317 *'dip'* *'diffopt'*
2318'diffopt' 'dip' string (default "filler")
2319 global
2320 {not in Vi}
2321 {not available when compiled without the |+diff|
2322 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002323 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002324 All are optional. Items must be separated by a comma.
2325
2326 filler Show filler lines, to keep the text
2327 synchronized with a window that has inserted
2328 lines at the same position. Mostly useful
2329 when windows are side-by-side and 'scrollbind'
2330 is set.
2331
2332 context:{n} Use a context of {n} lines between a change
2333 and a fold that contains unchanged lines.
2334 When omitted a context of six lines is used.
2335 See |fold-diff|.
2336
2337 icase Ignore changes in case of text. "a" and "A"
2338 are considered the same. Adds the "-i" flag
2339 to the "diff" command if 'diffexpr' is empty.
2340
2341 iwhite Ignore changes in amount of white space. Adds
2342 the "-b" flag to the "diff" command if
2343 'diffexpr' is empty. Check the documentation
2344 of the "diff" command for what this does
2345 exactly. It should ignore adding trailing
2346 white space, but not leading white space.
2347
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002348 horizontal Start diff mode with horizontal splits (unless
2349 explicitly specified otherwise).
2350
2351 vertical Start diff mode with vertical splits (unless
2352 explicitly specified otherwise).
2353
2354 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2355 starting diff mode. Without this 2 is used.
2356
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357 Examples: >
2358
2359 :set diffopt=filler,context:4
2360 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002361 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002362<
2363 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2364'digraph' 'dg' boolean (default off)
2365 global
2366 {not in Vi}
2367 {not available when compiled without the |+digraphs|
2368 feature}
2369 Enable the entering of digraphs in Insert mode with {char1} <BS>
2370 {char2}. See |digraphs|.
2371 NOTE: This option is reset when 'compatible' is set.
2372
2373 *'directory'* *'dir'*
2374'directory' 'dir' string (default for Amiga: ".,t:",
2375 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2376 for Unix: ".,~/tmp,/var/tmp,/tmp")
2377 global
2378 List of directory names for the swap file, separated with commas.
2379 - The swap file will be created in the first directory where this is
2380 possible.
2381 - Empty means that no swap file will be used (recovery is
2382 impossible!).
2383 - A directory "." means to put the swap file in the same directory as
2384 the edited file. On Unix, a dot is prepended to the file name, so
2385 it doesn't show in a directory listing. On MS-Windows the "hidden"
2386 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002387 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 put the swap file relative to where the edited file is. The leading
2389 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002390 - For Unix and Win32, if a directory ends in two path separators "//"
2391 or "\\", the swap file name will be built from the complete path to
2392 the file with all path separators substituted to percent '%' signs.
2393 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002394 On Win32, when a separating comma is following, you must use "//",
2395 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396 - Spaces after the comma are ignored, other spaces are considered part
2397 of the directory name. To have a space at the start of a directory
2398 name, precede it with a backslash.
2399 - To include a comma in a directory name precede it with a backslash.
2400 - A directory name may end in an ':' or '/'.
2401 - Environment variables are expanded |:set_env|.
2402 - Careful with '\' characters, type one before a space, type two to
2403 get one in the option (see |option-backslash|), for example: >
2404 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2405< - For backwards compatibility with Vim version 3.0 a '>' at the start
2406 of the option is removed.
2407 Using "." first in the list is recommended. This means that editing
2408 the same file twice will result in a warning. Using "/tmp" on Unix is
2409 discouraged: When the system crashes you lose the swap file.
2410 "/var/tmp" is often not cleared when rebooting, thus is a better
2411 choice than "/tmp". But it can contain a lot of files, your swap
2412 files get lost in the crowd. That is why a "tmp" directory in your
2413 home directory is tried first.
2414 The use of |:set+=| and |:set-=| is preferred when adding or removing
2415 directories from the list. This avoids problems when a future version
2416 uses another default.
2417 This option cannot be set from a |modeline| or in the |sandbox|, for
2418 security reasons.
2419 {Vi: directory to put temp file in, defaults to "/tmp"}
2420
2421 *'display'* *'dy'*
2422'display' 'dy' string (default "")
2423 global
2424 {not in Vi}
2425 Change the way text is displayed. This is comma separated list of
2426 flags:
2427 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002428 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 last line that doesn't fit is replaced with "@" lines.
2430 uhex Show unprintable characters hexadecimal as <xx>
2431 instead of using ^C and ~C.
2432
2433 *'eadirection'* *'ead'*
2434'eadirection' 'ead' string (default "both")
2435 global
2436 {not in Vi}
2437 {not available when compiled without the +vertsplit
2438 feature}
2439 Tells when the 'equalalways' option applies:
2440 ver vertically, width of windows is not affected
2441 hor horizontally, height of windows is not affected
2442 both width and height of windows is affected
2443
2444 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2445'edcompatible' 'ed' boolean (default off)
2446 global
2447 Makes the 'g' and 'c' flags of the ":substitute" command to be
2448 toggled each time the flag is given. See |complex-change|. See
2449 also 'gdefault' option.
2450 Switching this option on is discouraged!
2451
2452 *'encoding'* *'enc'* *E543*
2453'encoding' 'enc' string (default: "latin1" or value from $LANG)
2454 global
2455 {only available when compiled with the |+multi_byte|
2456 feature}
2457 {not in Vi}
2458 Sets the character encoding used inside Vim. It applies to text in
2459 the buffers, registers, Strings in expressions, text stored in the
2460 viminfo file, etc. It sets the kind of characters which Vim can work
2461 with. See |encoding-names| for the possible values.
2462
2463 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002464 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002465 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002466 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467
Bram Moolenaar865242e2010-07-14 21:12:05 +02002468 This option cannot be set from a |modeline|. It would most likely
2469 corrupt the text.
2470
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2472 "utf-8". Although care has been taken to allow different values of
2473 'encoding', "utf-8" is the natural choice for the environment and
2474 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002475 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002476 versions, and to avoid changing the encoding of newly created files
2477 without your knowledge (in case 'fileencodings' is empty).
2478
2479 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002480 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481 iconv() or as specified with 'charconvert'.
2482
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002483 If you need to know whether 'encoding' is a multi-byte encoding, you
2484 can use: >
2485 if has("multi_byte_encoding")
2486<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 Normally 'encoding' will be equal to your current locale. This will
2488 be the default if Vim recognizes your environment settings. If
2489 'encoding' is not set to the current locale, 'termencoding' must be
2490 set to convert typed and displayed text. See |encoding-table|.
2491
2492 When you set this option, it fires the |EncodingChanged| autocommand
2493 event so that you can set up fonts if necessary.
2494
2495 When the option is set, the value is converted to lowercase. Thus
2496 you can set it with uppercase values too. Underscores are translated
2497 to '-' signs.
2498 When the encoding is recognized, it is changed to the standard name.
2499 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2500 "iso-8859-2" and "utf8" becomes "utf-8".
2501
2502 Note: "latin1" is also used when the encoding could not be detected.
2503 This only works when editing files in the same encoding! When the
2504 actual character set is not latin1, make sure 'fileencoding' and
2505 'fileencodings' are empty. When conversion is needed, switch to using
2506 utf-8.
2507
2508 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2509 You don't notice this while editing, but it does matter for the
2510 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2511 setting 'encoding' to one of these values instead of utf-8 only has
2512 effect for encoding used for files when 'fileencoding' is empty.
2513
Bram Moolenaar661b1822005-07-28 22:36:45 +00002514 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2515 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516
2517 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2518'endofline' 'eol' boolean (default on)
2519 local to buffer
2520 {not in Vi}
2521 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002522 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523 option is automatically set when starting to edit a new file, unless
2524 the file does not have an <EOL> for the last line in the file, in
2525 which case it is reset. Normally you don't have to set or reset this
2526 option. When 'binary' is off the value is not used when writing the
2527 file. When 'binary' is on it is used to remember the presence of a
2528 <EOL> for the last line in the file, so that when you write the file
2529 the situation from the original file can be kept. But you can change
2530 it if you want to.
2531
2532 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2533'equalalways' 'ea' boolean (default on)
2534 global
2535 {not in Vi}
2536 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002537 splitting or closing a window. This also happens the moment the
2538 option is switched on. When off, splitting a window will reduce the
2539 size of the current window and leave the other windows the same. When
2540 closing a window the extra lines are given to the window next to it
2541 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 When mixing vertically and horizontally split windows, a minimal size
2543 is computed and some windows may be larger if there is room. The
2544 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002545 Changing the height and width of a window can be avoided by setting
2546 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002547 If a window size is specified when creating a new window sizes are
2548 currently not equalized (it's complicated, but may be implemented in
2549 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550
2551 *'equalprg'* *'ep'*
2552'equalprg' 'ep' string (default "")
2553 global or local to buffer |global-local|
2554 {not in Vi}
2555 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002556 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002557 or 'indentexpr'. When Vim was compiled without internal formatting,
2558 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002559 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560 about including spaces and backslashes.
2561 This option cannot be set from a |modeline| or in the |sandbox|, for
2562 security reasons.
2563
2564 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2565'errorbells' 'eb' boolean (default off)
2566 global
2567 Ring the bell (beep or screen flash) for error messages. This only
2568 makes a difference for error messages, the bell will be used always
2569 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002570 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 screen flash or do nothing.
2572
2573 *'errorfile'* *'ef'*
2574'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2575 others: "errors.err")
2576 global
2577 {not in Vi}
2578 {not available when compiled without the |+quickfix|
2579 feature}
2580 Name of the errorfile for the QuickFix mode (see |:cf|).
2581 When the "-q" command-line argument is used, 'errorfile' is set to the
2582 following argument. See |-q|.
2583 NOT used for the ":make" command. See 'makeef' for that.
2584 Environment variables are expanded |:set_env|.
2585 See |option-backslash| about including spaces and backslashes.
2586 This option cannot be set from a |modeline| or in the |sandbox|, for
2587 security reasons.
2588
2589 *'errorformat'* *'efm'*
2590'errorformat' 'efm' string (default is very long)
2591 global or local to buffer |global-local|
2592 {not in Vi}
2593 {not available when compiled without the |+quickfix|
2594 feature}
2595 Scanf-like description of the format for the lines in the error file
2596 (see |errorformat|).
2597
2598 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2599'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2600 global
2601 {not in Vi}
2602 Function keys that start with an <Esc> are recognized in Insert
2603 mode. When this option is off, the cursor and function keys cannot be
2604 used in Insert mode if they start with an <Esc>. The advantage of
2605 this is that the single <Esc> is recognized immediately, instead of
2606 after one second. Instead of resetting this option, you might want to
2607 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2608 when 'esckeys' is off, you can still map anything, but the cursor keys
2609 won't work by default.
2610 NOTE: This option is set to the Vi default value when 'compatible' is
2611 set and to the Vim default value when 'compatible' is reset.
2612
2613 *'eventignore'* *'ei'*
2614'eventignore' 'ei' string (default "")
2615 global
2616 {not in Vi}
2617 {not available when compiled without the |+autocmd|
2618 feature}
2619 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002620 When set to "all" or when "all" is one of the items, all autocommand
2621 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 Otherwise this is a comma separated list of event names. Example: >
2623 :set ei=WinEnter,WinLeave
2624<
2625 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2626'expandtab' 'et' boolean (default off)
2627 local to buffer
2628 {not in Vi}
2629 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002630 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2632 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2633 NOTE: This option is reset when 'compatible' is set.
2634
2635 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2636'exrc' 'ex' boolean (default off)
2637 global
2638 {not in Vi}
2639 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2640 directory. If you switch this option on you should also consider
2641 setting the 'secure' option (see |initialization|). Using a local
2642 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2643 also see |.vimrc| and |gui-init|.
2644 This option cannot be set from a |modeline| or in the |sandbox|, for
2645 security reasons.
2646
2647 *'fileencoding'* *'fenc'* *E213*
2648'fileencoding' 'fenc' string (default: "")
2649 local to buffer
2650 {only available when compiled with the |+multi_byte|
2651 feature}
2652 {not in Vi}
2653 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002654
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002656 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657 When 'fileencoding' is empty, the same value as 'encoding' will be
2658 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002659 Conversion will also be done when 'encoding' and 'fileencoding' are
2660 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2661 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002663 'encoding' is "utf-8" or another Unicode encoding, conversion
2664 is most likely done in a way that the reverse conversion
2665 results in the same text. When 'encoding' is not "utf-8" some
2666 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002667
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668 See 'encoding' for the possible values. Additionally, values may be
2669 specified that can be handled by the converter, see
2670 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002671
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672 When reading a file 'fileencoding' will be set from 'fileencodings'.
2673 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002674 'fileencoding', use the |++enc| argument. One exception: when
2675 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002676 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002677
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2679 When the option is set, the value is converted to lowercase. Thus
2680 you can set it with uppercase values too. '_' characters are
2681 replaced with '-'. If a name is recognized from the list for
2682 'encoding', it is replaced by the standard name. For example
2683 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002684
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 When this option is set, after starting to edit a file, the 'modified'
2686 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002687
2688 Keep in mind that changing 'fenc' from a modeline happens
2689 AFTER the text has been read, thus it applies to when the file will be
2690 written. If you do set 'fenc' in a modeline, you might want to set
2691 'nomodified' to avoid not being able to ":q".
2692
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693 This option can not be changed when 'modifiable' is off.
2694
2695 *'fe'*
2696 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002697 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698 old short name was 'fe', which is no longer used.
2699
2700 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002701'fileencodings' 'fencs' string (default: "ucs-bom",
2702 "ucs-bom,utf-8,default,latin1" when
2703 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 global
2705 {only available when compiled with the |+multi_byte|
2706 feature}
2707 {not in Vi}
2708 This is a list of character encodings considered when starting to edit
2709 an existing file. When a file is read, Vim tries to use the first
2710 mentioned character encoding. If an error is detected, the next one
2711 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002712 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713 an empty string, which means the value of 'encoding' is used.
2714 WARNING: Conversion can cause loss of information! When
2715 'encoding' is "utf-8" (or one of the other Unicode variants)
2716 conversion is most likely done in a way that the reverse
2717 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002718 "utf-8" some non-ASCII characters may be lost! You can use
2719 the |++bad| argument to specify what is done with characters
2720 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721 For an empty file or a file with only ASCII characters most encodings
2722 will work and the first entry of 'fileencodings' will be used (except
2723 "ucs-bom", which requires the BOM to be present). If you prefer
2724 another encoding use an BufReadPost autocommand event to test if your
2725 preferred encoding is to be used. Example: >
2726 au BufReadPost * if search('\S', 'w') == 0 |
2727 \ set fenc=iso-2022-jp | endif
2728< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2729 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002730 When the |++enc| argument is used then the value of 'fileencodings' is
2731 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002732 Note that 'fileencodings' is not used for a new file, the global value
2733 of 'fileencoding' is used instead. You can set it with: >
2734 :setglobal fenc=iso-8859-2
2735< This means that a non-existing file may get a different encoding than
2736 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737 The special value "ucs-bom" can be used to check for a Unicode BOM
2738 (Byte Order Mark) at the start of the file. It must not be preceded
2739 by "utf-8" or another Unicode encoding for this to work properly.
2740 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2741 because Vim cannot detect an error, thus the encoding is always
2742 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002743 The special value "default" can be used for the encoding from the
2744 environment. This is the default value for 'encoding'. It is useful
2745 when 'encoding' is set to "utf-8" and your environment uses a
2746 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002747 When 'encoding' is "utf-8" and a file contains an illegal byte
2748 sequence it won't be recognized as UTF-8. You can use the |8g8|
2749 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 WRONG VALUES: WHAT'S WRONG:
2751 latin1,utf-8 "latin1" will always be used
2752 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2753 file
2754 cp1250,latin1 "cp1250" will always be used
2755 If 'fileencodings' is empty, 'fileencoding' is not modified.
2756 See 'fileencoding' for the possible values.
2757 Setting this option does not have an effect until the next time a file
2758 is read.
2759
2760 *'fileformat'* *'ff'*
2761'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2762 Unix default: "unix",
2763 Macintosh default: "mac")
2764 local to buffer
2765 {not in Vi}
2766 This gives the <EOL> of the current buffer, which is used for
2767 reading/writing the buffer from/to a file:
2768 dos <CR> <NL>
2769 unix <NL>
2770 mac <CR>
2771 When "dos" is used, CTRL-Z at the end of a file is ignored.
2772 See |file-formats| and |file-read|.
2773 For the character encoding of the file see 'fileencoding'.
2774 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2775 works like it was set to "unix'.
2776 This option is set automatically when starting to edit a file and
2777 'fileformats' is not empty and 'binary' is off.
2778 When this option is set, after starting to edit a file, the 'modified'
2779 option is set, because the file would be different when written.
2780 This option can not be changed when 'modifiable' is off.
2781 For backwards compatibility: When this option is set to "dos",
2782 'textmode' is set, otherwise 'textmode' is reset.
2783
2784 *'fileformats'* *'ffs'*
2785'fileformats' 'ffs' string (default:
2786 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2787 Vim Unix: "unix,dos",
2788 Vim Mac: "mac,unix,dos",
2789 Vi Cygwin: "unix,dos",
2790 Vi others: "")
2791 global
2792 {not in Vi}
2793 This gives the end-of-line (<EOL>) formats that will be tried when
2794 starting to edit a new buffer and when reading a file into an existing
2795 buffer:
2796 - When empty, the format defined with 'fileformat' will be used
2797 always. It is not set automatically.
2798 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002799 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 'fileformats' name will be used when a file is read into an existing
2801 buffer, no matter what 'fileformat' for that buffer is set to.
2802 - When more than one name is present, separated by commas, automatic
2803 <EOL> detection will be done when reading a file. When starting to
2804 edit a file, a check is done for the <EOL>:
2805 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2806 'fileformat' is set to "dos".
2807 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002808 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 preceding <CR>, "unix" is preferred over "dos".
2810 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2811 This means that "mac" is only chosen when "unix" is not present,
2812 or when no <NL> is found in the file, and when "dos" is not
2813 present, or no <CR><NL> is present in the file.
2814 Also if "unix" was first chosen, but the first <CR> is before
2815 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2816 the file, then 'fileformat' is set to "mac".
2817 4. If 'fileformat' is still not set, the first name from
2818 'fileformats' is used.
2819 When reading a file into an existing buffer, the same is done, but
2820 this happens like 'fileformat' has been set appropriately for that
2821 file only, the option is not changed.
2822 When 'binary' is set, the value of 'fileformats' is not used.
2823
2824 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2825 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2826 done:
2827 - When 'fileformats' is empty, there is no automatic detection. Dos
2828 format will be used.
2829 - When 'fileformats' is set to one or more names, automatic detection
2830 is done. This is based on the first <NL> in the file: If there is a
2831 <CR> in front of it, Dos format is used, otherwise Unix format is
2832 used.
2833 Also see |file-formats|.
2834 For backwards compatibility: When this option is set to an empty
2835 string or one format (no comma is included), 'textauto' is reset,
2836 otherwise 'textauto' is set.
2837 NOTE: This option is set to the Vi default value when 'compatible' is
2838 set and to the Vim default value when 'compatible' is reset.
2839
2840 *'filetype'* *'ft'*
2841'filetype' 'ft' string (default: "")
2842 local to buffer
2843 {not in Vi}
2844 {not available when compiled without the |+autocmd|
2845 feature}
2846 When this option is set, the FileType autocommand event is triggered.
2847 All autocommands that match with the value of this option will be
2848 executed. Thus the value of 'filetype' is used in place of the file
2849 name.
2850 Otherwise this option does not always reflect the current file type.
2851 This option is normally set when the file type is detected. To enable
2852 this use the ":filetype on" command. |:filetype|
2853 Setting this option to a different value is most useful in a modeline,
2854 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002855 Example, for in an IDL file:
2856 /* vim: set filetype=idl : */ ~
2857 |FileType| |filetypes|
2858 When a dot appears in the value then this separates two filetype
2859 names. Example:
2860 /* vim: set filetype=c.doxygen : */ ~
2861 This will use the "c" filetype first, then the "doxygen" filetype.
2862 This works both for filetype plugins and for syntax files. More than
2863 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864 Do not confuse this option with 'osfiletype', which is for the file
2865 type that is actually stored with the file.
2866 This option is not copied to another buffer, independent of the 's' or
2867 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002868 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869
2870 *'fillchars'* *'fcs'*
2871'fillchars' 'fcs' string (default "vert:|,fold:-")
2872 global
2873 {not in Vi}
2874 {not available when compiled without the |+windows|
2875 and |+folding| features}
2876 Characters to fill the statuslines and vertical separators.
2877 It is a comma separated list of items:
2878
2879 item default Used for ~
2880 stl:c ' ' or '^' statusline of the current window
2881 stlnc:c ' ' or '-' statusline of the non-current windows
2882 vert:c '|' vertical separators |:vsplit|
2883 fold:c '-' filling 'foldtext'
2884 diff:c '-' deleted lines of the 'diff' option
2885
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002886 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 "stlnc" the space will be used when there is highlighting, '^' or '-'
2888 otherwise.
2889
2890 Example: >
2891 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2892< This is similar to the default, except that these characters will also
2893 be used when there is highlighting.
2894
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002895 for "stl" and "stlnc" only single-byte values are supported.
2896
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897 The highlighting used for these items:
2898 item highlight group ~
2899 stl:c StatusLine |hl-StatusLine|
2900 stlnc:c StatusLineNC |hl-StatusLineNC|
2901 vert:c VertSplit |hl-VertSplit|
2902 fold:c Folded |hl-Folded|
2903 diff:c DiffDelete |hl-DiffDelete|
2904
2905 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2906'fkmap' 'fk' boolean (default off) *E198*
2907 global
2908 {not in Vi}
2909 {only available when compiled with the |+rightleft|
2910 feature}
2911 When on, the keyboard is mapped for the Farsi character set.
2912 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002913 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914
2915 *'foldclose'* *'fcl'*
2916'foldclose' 'fcl' string (default "")
2917 global
2918 {not in Vi}
2919 {not available when compiled without the |+folding|
2920 feature}
2921 When set to "all", a fold is closed when the cursor isn't in it and
2922 its level is higher than 'foldlevel'. Useful if you want folds to
2923 automatically close when moving out of them.
2924
2925 *'foldcolumn'* *'fdc'*
2926'foldcolumn' 'fdc' number (default 0)
2927 local to window
2928 {not in Vi}
2929 {not available when compiled without the |+folding|
2930 feature}
2931 When non-zero, a column with the specified width is shown at the side
2932 of the window which indicates open and closed folds. The maximum
2933 value is 12.
2934 See |folding|.
2935
2936 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2937'foldenable' 'fen' boolean (default on)
2938 local to window
2939 {not in Vi}
2940 {not available when compiled without the |+folding|
2941 feature}
2942 When off, all folds are open. This option can be used to quickly
2943 switch between showing all text unfolded and viewing the text with
2944 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002945 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 'foldenable' is off.
2947 This option is set by commands that create a new fold or close a fold.
2948 See |folding|.
2949
2950 *'foldexpr'* *'fde'*
2951'foldexpr' 'fde' string (default: "0")
2952 local to window
2953 {not in Vi}
2954 {not available when compiled without the |+folding|
2955 or |+eval| feature}
2956 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002957 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002958
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002959 The expression may be evaluated in the |sandbox|, see
2960 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002961 This option can't be set from a |modeline| when the 'diff' option is
2962 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002963
2964 It is not allowed to change text or jump to another window while
2965 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966
2967 *'foldignore'* *'fdi'*
2968'foldignore' 'fdi' string (default: "#")
2969 local to window
2970 {not in Vi}
2971 {not available when compiled without the |+folding|
2972 feature}
2973 Used only when 'foldmethod' is "indent". Lines starting with
2974 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002975 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 The default "#" works well for C programs. See |fold-indent|.
2977
2978 *'foldlevel'* *'fdl'*
2979'foldlevel' 'fdl' number (default: 0)
2980 local to window
2981 {not in Vi}
2982 {not available when compiled without the |+folding|
2983 feature}
2984 Sets the fold level: Folds with a higher level will be closed.
2985 Setting this option to zero will close all folds. Higher numbers will
2986 close fewer folds.
2987 This option is set by commands like |zm|, |zM| and |zR|.
2988 See |fold-foldlevel|.
2989
2990 *'foldlevelstart'* *'fdls'*
2991'foldlevelstart' 'fdls' number (default: -1)
2992 global
2993 {not in Vi}
2994 {not available when compiled without the |+folding|
2995 feature}
2996 Sets 'foldlevel' when starting to edit another buffer in a window.
2997 Useful to always start editing with all folds closed (value zero),
2998 some folds closed (one) or no folds closed (99).
2999 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003000 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 ignores this option and closes all folds.
3002 It is also done before BufReadPre autocommands, to allow an autocmd to
3003 overrule the 'foldlevel' value for specific files.
3004 When the value is negative, it is not used.
3005
3006 *'foldmarker'* *'fmr'* *E536*
3007'foldmarker' 'fmr' string (default: "{{{,}}}")
3008 local to window
3009 {not in Vi}
3010 {not available when compiled without the |+folding|
3011 feature}
3012 The start and end marker used when 'foldmethod' is "marker". There
3013 must be one comma, which separates the start and end marker. The
3014 marker is a literal string (a regular expression would be too slow).
3015 See |fold-marker|.
3016
3017 *'foldmethod'* *'fdm'*
3018'foldmethod' 'fdm' string (default: "manual")
3019 local to window
3020 {not in Vi}
3021 {not available when compiled without the |+folding|
3022 feature}
3023 The kind of folding used for the current window. Possible values:
3024 |fold-manual| manual Folds are created manually.
3025 |fold-indent| indent Lines with equal indent form a fold.
3026 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3027 |fold-marker| marker Markers are used to specify folds.
3028 |fold-syntax| syntax Syntax highlighting items specify folds.
3029 |fold-diff| diff Fold text that is not changed.
3030
3031 *'foldminlines'* *'fml'*
3032'foldminlines' 'fml' number (default: 1)
3033 local to window
3034 {not in Vi}
3035 {not available when compiled without the |+folding|
3036 feature}
3037 Sets the minimum number of screen lines for a fold to be displayed
3038 closed. Also for manually closed folds.
3039 Note that this only has an effect of what is displayed. After using
3040 "zc" to close a fold, which is displayed open because it's smaller
3041 than 'foldminlines', a following "zc" may close a containing fold.
3042
3043 *'foldnestmax'* *'fdn'*
3044'foldnestmax' 'fdn' number (default: 20)
3045 local to window
3046 {not in Vi}
3047 {not available when compiled without the |+folding|
3048 feature}
3049 Sets the maximum nesting of folds for the "indent" and "syntax"
3050 methods. This avoids that too many folds will be created. Using more
3051 than 20 doesn't work, because the internal limit is 20.
3052
3053 *'foldopen'* *'fdo'*
3054'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3055 search,tag,undo")
3056 global
3057 {not in Vi}
3058 {not available when compiled without the |+folding|
3059 feature}
3060 Specifies for which type of commands folds will be opened, if the
3061 command moves the cursor into a closed fold. It is a comma separated
3062 list of items.
3063 item commands ~
3064 all any
3065 block "(", "{", "[[", "[{", etc.
3066 hor horizontal movements: "l", "w", "fx", etc.
3067 insert any command in Insert mode
3068 jump far jumps: "G", "gg", etc.
3069 mark jumping to a mark: "'m", CTRL-O, etc.
3070 percent "%"
3071 quickfix ":cn", ":crew", ":make", etc.
3072 search search for a pattern: "/", "n", "*", "gd", etc.
3073 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003074 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 tag jumping to a tag: ":ta", CTRL-T, etc.
3076 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003077 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 the |zv| command to the mapping to get the same effect.
3079 When a movement command is used for an operator (e.g., "dl" or "y%")
3080 this option is not used. This means the operator will include the
3081 whole closed fold.
3082 Note that vertical movements are not here, because it would make it
3083 very difficult to move onto a closed fold.
3084 In insert mode the folds containing the cursor will always be open
3085 when text is inserted.
3086 To close folds you can re-apply 'foldlevel' with the |zx| command or
3087 set the 'foldclose' option to "all".
3088
3089 *'foldtext'* *'fdt'*
3090'foldtext' 'fdt' string (default: "foldtext()")
3091 local to window
3092 {not in Vi}
3093 {not available when compiled without the |+folding|
3094 feature}
3095 An expression which is used to specify the text displayed for a closed
3096 fold. See |fold-foldtext|.
3097
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003098 The expression may be evaluated in the |sandbox|, see
3099 |sandbox-option|.
3100
3101 It is not allowed to change text or jump to another window while
3102 evaluating 'foldtext' |textlock|.
3103
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104 *'formatoptions'* *'fo'*
3105'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3106 local to buffer
3107 {not in Vi}
3108 This is a sequence of letters which describes how automatic
3109 formatting is to be done. See |fo-table|. When the 'paste' option is
3110 on, no formatting is done (like 'formatoptions' is empty). Commas can
3111 be inserted for readability.
3112 To avoid problems with flags that are added in the future, use the
3113 "+=" and "-=" feature of ":set" |add-option-flags|.
3114 NOTE: This option is set to the Vi default value when 'compatible' is
3115 set and to the Vim default value when 'compatible' is reset.
3116
Bram Moolenaar86b68352004-12-27 21:59:20 +00003117 *'formatlistpat'* *'flp'*
3118'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3119 local to buffer
3120 {not in Vi}
3121 A pattern that is used to recognize a list header. This is used for
3122 the "n" flag in 'formatoptions'.
3123 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003124 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003125 while still checking more characters. There must be a character
3126 following the pattern, when it matches the whole line it is handled
3127 like there is no match.
3128 The default recognizes a number, followed by an optional punctuation
3129 character and white space.
3130
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 *'formatprg'* *'fp'*
3132'formatprg' 'fp' string (default "")
3133 global
3134 {not in Vi}
3135 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003136 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003138 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003139 If the 'formatexpr' option is not empty it will be used instead.
3140 Otherwise, if 'formatprg' option is an empty string, the internal
3141 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003142 Environment variables are expanded |:set_env|. See |option-backslash|
3143 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003144 The expression may be evaluated in the |sandbox|, see
3145 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003147 *'formatexpr'* *'fex'*
3148'formatexpr' 'fex' string (default "")
3149 local to buffer
3150 {not in Vi}
3151 {not available when compiled without the |+eval|
3152 feature}
3153 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003154 operator or automatic formatting (see 'formatoptions'). When this
3155 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003156
3157 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003158 The |v:count| variable holds the number of lines to be formatted.
3159 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003160 inserted if the expression is being evaluated due to
3161 automatic formatting. This can be empty. Don't insert
3162 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003163
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003164 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003165 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003166< This will invoke the mylang#Format() function in the
3167 autoload/mylang.vim file in 'runtimepath'. |autoload|
3168
3169 The expression is also evaluated when 'textwidth' is set and adding
3170 text beyond that limit. This happens under the same conditions as
3171 when internal formatting is used. Make sure the cursor is kept in the
3172 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003173 return "i" or "R" in this situation.
3174
3175 When the expression evaluates to non-zero Vim will fall back to using
3176 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003177
3178 The expression may be evaluated in the |sandbox|, see
3179 |sandbox-option|.
3180
3181 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003182'fsync' 'fs' boolean (default on)
3183 global
3184 {not in Vi}
3185 When on, the library function fsync() will be called after writing a
3186 file. This will flush a file to disk, ensuring that it is safely
3187 written even on filesystems which do metadata-only journaling. This
3188 will force the harddrive to spin up on Linux systems running in laptop
3189 mode, so it may be undesirable in some situations. Be warned that
3190 turning this off increases the chances of data loss after a crash. On
3191 systems without an fsync() implementation, this variable is always
3192 off.
3193 Also see 'swapsync' for controlling fsync() on swap files.
3194
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3196'gdefault' 'gd' boolean (default off)
3197 global
3198 {not in Vi}
3199 When on, the ":substitute" flag 'g' is default on. This means that
3200 all matches in a line are substituted instead of one. When a 'g' flag
3201 is given to a ":substitute" command, this will toggle the substitution
3202 of all or one match. See |complex-change|.
3203
3204 command 'gdefault' on 'gdefault' off ~
3205 :s/// subst. all subst. one
3206 :s///g subst. one subst. all
3207 :s///gg subst. all subst. one
3208
3209 NOTE: This option is reset when 'compatible' is set.
3210
3211 *'grepformat'* *'gfm'*
3212'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3213 global
3214 {not in Vi}
3215 Format to recognize for the ":grep" command output.
3216 This is a scanf-like string that uses the same format as the
3217 'errorformat' option: see |errorformat|.
3218
3219 *'grepprg'* *'gp'*
3220'grepprg' 'gp' string (default "grep -n ",
3221 Unix: "grep -n $* /dev/null",
3222 Win32: "findstr /n" or "grep -n",
3223 VMS: "SEARCH/NUMBERS ")
3224 global or local to buffer |global-local|
3225 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003226 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 and '#' characters, which are expanded like when used in a command-
3228 line. The placeholder "$*" is allowed to specify where the arguments
3229 will be included. Environment variables are expanded |:set_env|. See
3230 |option-backslash| about including spaces and backslashes.
3231 When your "grep" accepts the "-H" argument, use this to make ":grep"
3232 also work well with a single file: >
3233 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003234< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003235 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3236 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003237 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 apply equally to 'grepprg'.
3239 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3240 otherwise it's "grep -n".
3241 This option cannot be set from a |modeline| or in the |sandbox|, for
3242 security reasons.
3243
3244 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3245'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3246 ve:ver35-Cursor,
3247 o:hor50-Cursor,
3248 i-ci:ver25-Cursor/lCursor,
3249 r-cr:hor20-Cursor/lCursor,
3250 sm:block-Cursor
3251 -blinkwait175-blinkoff150-blinkon175",
3252 for MS-DOS and Win32 console:
3253 "n-v-c:block,o:hor50,i-ci:hor15,
3254 r-cr:hor30,sm:block")
3255 global
3256 {not in Vi}
3257 {only available when compiled with GUI enabled, and
3258 for MS-DOS and Win32 console}
3259 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003260 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261 the height of the cursor can be changed. This can be done by
3262 specifying a block cursor, or a percentage for a vertical or
3263 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003264 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003266 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 mode-list and an argument-list:
3268 mode-list:argument-list,mode-list:argument-list,..
3269 The mode-list is a dash separated list of these modes:
3270 n Normal mode
3271 v Visual mode
3272 ve Visual mode with 'selection' "exclusive" (same as 'v',
3273 if not specified)
3274 o Operator-pending mode
3275 i Insert mode
3276 r Replace mode
3277 c Command-line Normal (append) mode
3278 ci Command-line Insert mode
3279 cr Command-line Replace mode
3280 sm showmatch in Insert mode
3281 a all modes
3282 The argument-list is a dash separated list of these arguments:
3283 hor{N} horizontal bar, {N} percent of the character height
3284 ver{N} vertical bar, {N} percent of the character width
3285 block block cursor, fills the whole character
3286 [only one of the above three should be present]
3287 blinkwait{N} *cursor-blinking*
3288 blinkon{N}
3289 blinkoff{N}
3290 blink times for cursor: blinkwait is the delay before
3291 the cursor starts blinking, blinkon is the time that
3292 the cursor is shown and blinkoff is the time that the
3293 cursor is not shown. The times are in msec. When one
3294 of the numbers is zero, there is no blinking. The
3295 default is: "blinkwait700-blinkon400-blinkoff250".
3296 These numbers are used for a missing entry. This
3297 means that blinking is enabled by default. To switch
3298 blinking off you can use "blinkon0". The cursor only
3299 blinks when Vim is waiting for input, not while
3300 executing a command.
3301 To make the cursor blink in an xterm, see
3302 |xterm-blink|.
3303 {group-name}
3304 a highlight group name, that sets the color and font
3305 for the cursor
3306 {group-name}/{group-name}
3307 Two highlight group names, the first is used when
3308 no language mappings are used, the other when they
3309 are. |language-mapping|
3310
3311 Examples of parts:
3312 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3313 block cursor with colors from the "nCursor"
3314 highlight group
3315 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3316 In Insert and Command-line Insert mode, use a
3317 30% vertical bar cursor with colors from the
3318 "iCursor" highlight group. Blink a bit
3319 faster.
3320
3321 The 'a' mode is different. It will set the given argument-list for
3322 all modes. It does not reset anything to defaults. This can be used
3323 to do a common setting for all modes. For example, to switch off
3324 blinking: "a:blinkon0"
3325
3326 Examples of cursor highlighting: >
3327 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3328 :highlight Cursor gui=NONE guifg=bg guibg=fg
3329<
3330 *'guifont'* *'gfn'*
3331 *E235* *E596* *E610* *E611*
3332'guifont' 'gfn' string (default "")
3333 global
3334 {not in Vi}
3335 {only available when compiled with GUI enabled}
3336 This is a list of fonts which will be used for the GUI version of Vim.
3337 In its simplest form the value is just one font name. When
3338 the font cannot be found you will get an error message. To try other
3339 font names a list can be specified, font names separated with commas.
3340 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003341
Bram Moolenaar05159a02005-02-26 23:04:13 +00003342 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3343 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003344
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 Spaces after a comma are ignored. To include a comma in a font name
3346 precede it with a backslash. Setting an option requires an extra
3347 backslash before a space and a backslash. See also
3348 |option-backslash|. For example: >
3349 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003350< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003352
3353 If none of the fonts can be loaded, Vim will keep the current setting.
3354 If an empty font list is given, Vim will try using other resource
3355 settings (for X, it will use the Vim.font resource), and finally it
3356 will try some builtin default which should always be there ("7x13" in
3357 the case of X). The font names given should be "normal" fonts. Vim
3358 will try to find the related bold and italic fonts.
3359
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003360 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003361 :set guifont=*
3362< will bring up a font requester, where you can pick the font you want.
3363
3364 The font name depends on the GUI used. See |setting-guifont| for a
3365 way to set 'guifont' for various systems.
3366
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 For the GTK+ 2 GUI the font name looks like this: >
3368 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003369< That's all. XLFDs are not used. For Chinese this is reported to work
3370 well: >
3371 if has("gui_gtk2")
3372 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3373 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3374 endif
3375<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003376 For Mac OSX you can use something like this: >
3377 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003378< Also see 'macatsui', it can help fix display problems.
3379 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003381 width). An exception is GTK 2: all fonts are accepted, but
3382 mono-spaced fonts look best.
3383
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 To preview a font on X11, you might be able to use the "xfontsel"
3385 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003386
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387 For the Win32 GUI *E244* *E245*
3388 - takes these options in the font name:
3389 hXX - height is XX (points, can be floating-point)
3390 wXX - width is XX (points, can be floating-point)
3391 b - bold
3392 i - italic
3393 u - underline
3394 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003395 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3397 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3398 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003399 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400
3401 Use a ':' to separate the options.
3402 - A '_' can be used in the place of a space, so you don't need to use
3403 backslashes to escape the spaces.
3404 - Examples: >
3405 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3406 :set guifont=Andale_Mono:h7.5:w4.5
3407< See also |font-sizes|.
3408
3409 *'guifontset'* *'gfs'*
3410 *E250* *E252* *E234* *E597* *E598*
3411'guifontset' 'gfs' string (default "")
3412 global
3413 {not in Vi}
3414 {only available when compiled with GUI enabled and
3415 with the |+xfontset| feature}
3416 {not available in the GTK+ 2 GUI}
3417 When not empty, specifies two (or more) fonts to be used. The first
3418 one for normal English, the second one for your special language. See
3419 |xfontset|.
3420 Setting this option also means that all font names will be handled as
3421 a fontset name. Also the ones used for the "font" argument of the
3422 |:highlight| command.
3423 The fonts must match with the current locale. If fonts for the
3424 character sets that the current locale uses are not included, setting
3425 'guifontset' will fail.
3426 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3427 the comma-separated names are alternative names, one of which will be
3428 used. In 'guifontset' the whole string is one fontset name,
3429 including the commas. It is not possible to specify alternative
3430 fontset names.
3431 This example works on many X11 systems: >
3432 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3433<
3434 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3435'guifontwide' 'gfw' string (default "")
3436 global
3437 {not in Vi}
3438 {only available when compiled with GUI enabled}
3439 When not empty, specifies a comma-separated list of fonts to be used
3440 for double-width characters. The first font that can be loaded is
3441 used.
3442 Note: The size of these fonts must be exactly twice as wide as the one
3443 specified with 'guifont' and the same height.
3444
3445 All GUI versions but GTK+ 2:
3446
3447 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3448 'guifontset' is empty or invalid.
3449 When 'guifont' is set and a valid font is found in it and
3450 'guifontwide' is empty Vim will attempt to find a matching
3451 double-width font and set 'guifontwide' to it.
3452
3453 GTK+ 2 GUI only: *guifontwide_gtk2*
3454
3455 If set and valid, 'guifontwide' is always used for double width
3456 characters, even if 'encoding' is not set to "utf-8".
3457 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003458 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 font for characters not available in 'guifont'. Thus you do not need
3460 to set 'guifontwide' at all unless you want to override the choice
3461 made by Pango/Xft.
3462
3463 *'guiheadroom'* *'ghr'*
3464'guiheadroom' 'ghr' number (default 50)
3465 global
3466 {not in Vi} {only for GTK and X11 GUI}
3467 The number of pixels subtracted from the screen height when fitting
3468 the GUI window on the screen. Set this before the GUI is started,
3469 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003470 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471 lines will be left for window decorations and other items on the
3472 screen. Set it to a negative value to allow windows taller than the
3473 screen.
3474
3475 *'guioptions'* *'go'*
3476'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003477 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 global
3479 {not in Vi}
3480 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003481 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 sequence of letters which describes what components and options of the
3483 GUI should be used.
3484 To avoid problems with flags that are added in the future, use the
3485 "+=" and "-=" feature of ":set" |add-option-flags|.
3486
3487 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003488 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 'a' Autoselect: If present, then whenever VISUAL mode is started,
3490 or the Visual area extended, Vim tries to become the owner of
3491 the windowing system's global selection. This means that the
3492 Visually highlighted text is available for pasting into other
3493 applications as well as into Vim itself. When the Visual mode
3494 ends, possibly due to an operation on the text, or when an
3495 application wants to paste the selection, the highlighted text
3496 is automatically yanked into the "* selection register.
3497 Thus the selection is still available for pasting into other
3498 applications after the VISUAL mode has ended.
3499 If not present, then Vim won't become the owner of the
3500 windowing system's global selection unless explicitly told to
3501 by a yank or delete operation for the "* register.
3502 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003503 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003504 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505 applies to the modeless selection.
3506
3507 'guioptions' autoselect Visual autoselect modeless ~
3508 "" - -
3509 "a" yes yes
3510 "A" - yes
3511 "aA" yes yes
3512
Bram Moolenaar02467872007-05-06 13:22:01 +00003513 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 'c' Use console dialogs instead of popup dialogs for simple
3515 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003516 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003517 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003518 'guitablabel' can be used to change the text in the labels.
3519 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003520 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003521 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003522 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523 'f' Foreground: Don't use fork() to detach the GUI from the shell
3524 where it was started. Use this for programs that wait for the
3525 editor to finish (e.g., an e-mail program). Alternatively you
3526 can use "gvim -f" or ":gui -f" to start the GUI in the
3527 foreground. |gui-fork|
3528 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003529 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003530 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3532 corner of the window. It's black&white on non-GTK, because of
3533 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003534 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003536 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003537 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003539 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 file is sourced the system menu has already been loaded; the
3541 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003542 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 'g' Grey menu items: Make menu items that are not active grey. If
3544 'g' is not included inactive menu items are not shown at all.
3545 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003546 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 't' Include tearoff menu items. Currently only works for Win32,
3548 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003549 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003550 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003551 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003552 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003554 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 'R' Right-hand scrollbar is present when there is a vertically
3556 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003557 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003559 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 'L' Left-hand scrollbar is present when there is a vertically
3561 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003562 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3564 the longest visible line, or on the cursor line if the 'h'
3565 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003566 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 'h' Limit horizontal scrollbar size to the length of the cursor
3568 line. Reduces computations. |gui-horiz-scroll|
3569
3570 And yes, you may even have scrollbars on the left AND the right if
3571 you really want to :-). See |gui-scrollbars| for more information.
3572
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003573 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 'v' Use a vertical button layout for dialogs. When not included,
3575 a horizontal layout is preferred, but when it doesn't fit a
3576 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003577 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 'p' Use Pointer callbacks for X11 GUI. This is required for some
3579 window managers. If the cursor is not blinking or hollow at
3580 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003581 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003583 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003584 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585
Bram Moolenaar02467872007-05-06 13:22:01 +00003586
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 *'guipty'* *'noguipty'*
3588'guipty' boolean (default on)
3589 global
3590 {not in Vi}
3591 {only available when compiled with GUI enabled}
3592 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3593 I/O to/from shell commands. See |gui-pty|.
3594
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003595 *'guitablabel'* *'gtl'*
3596'guitablabel' 'gtl' string (default empty)
3597 global
3598 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003599 {only available when compiled with GUI enabled and
3600 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003601 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003602 pages line. When empty and when the result is empty Vim will use a
3603 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003604
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003605 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003606 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003607
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003608 Only used when the GUI tab pages line is displayed. 'e' must be
3609 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3610 used.
3611
Bram Moolenaar57657d82006-04-21 22:12:41 +00003612 *'guitabtooltip'* *'gtt'*
3613'guitabtooltip' 'gtt' string (default empty)
3614 global
3615 {not in Vi}
3616 {only available when compiled with GUI enabled and
3617 with the +windows feature}
3618 When nonempty describes the text to use in a tooltip for the GUI tab
3619 pages line. When empty Vim will use a default tooltip.
3620 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003621 You can include a line break. Simplest method is to use |:let|: >
3622 :let &guitabtooltip = "line one\nline two"
3623<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003624
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 *'helpfile'* *'hf'*
3626'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3627 (others) "$VIMRUNTIME/doc/help.txt")
3628 global
3629 {not in Vi}
3630 Name of the main help file. All distributed help files should be
3631 placed together in one directory. Additionally, all "doc" directories
3632 in 'runtimepath' will be used.
3633 Environment variables are expanded |:set_env|. For example:
3634 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003635 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636 spaces and backslashes.
3637 This option cannot be set from a |modeline| or in the |sandbox|, for
3638 security reasons.
3639
3640 *'helpheight'* *'hh'*
3641'helpheight' 'hh' number (default 20)
3642 global
3643 {not in Vi}
3644 {not available when compiled without the +windows
3645 feature}
3646 Minimal initial height of the help window when it is opened with the
3647 ":help" command. The initial height of the help window is half of the
3648 current window, or (when the 'ea' option is on) the same as other
3649 windows. When the height is less than 'helpheight', the height is
3650 set to 'helpheight'. Set to zero to disable.
3651
3652 *'helplang'* *'hlg'*
3653'helplang' 'hlg' string (default: messages language or empty)
3654 global
3655 {only available when compiled with the |+multi_lang|
3656 feature}
3657 {not in Vi}
3658 Comma separated list of languages. Vim will use the first language
3659 for which the desired help can be found. The English help will always
3660 be used as a last resort. You can add "en" to prefer English over
3661 another language, but that will only find tags that exist in that
3662 language and not in the English help.
3663 Example: >
3664 :set helplang=de,it
3665< This will first search German, then Italian and finally English help
3666 files.
3667 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3668 try to find the tag in the current language before using this option.
3669 See |help-translated|.
3670
3671 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3672'hidden' 'hid' boolean (default off)
3673 global
3674 {not in Vi}
3675 When off a buffer is unloaded when it is |abandon|ed. When on a
3676 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3677 displayed in another window, it does not become hidden, of course.
3678 The commands that move through the buffer list sometimes make a buffer
3679 hidden although the 'hidden' option is off: When the buffer is
3680 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003681 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003682 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 This option is set for one command with ":hide {command}" |:hide|.
3684 WARNING: It's easy to forget that you have changes in hidden buffers.
3685 Think twice when using ":q!" or ":qa!".
3686
3687 *'highlight'* *'hl'*
3688'highlight' 'hl' string (default (as a single string):
3689 "8:SpecialKey,@:NonText,d:Directory,
3690 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3691 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003692 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3694 f:Folded,F:FoldColumn,A:DiffAdd,
3695 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003696 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003697 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003698 +:Pmenu,=:PmenuSel,
3699 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 global
3701 {not in Vi}
3702 This option can be used to set highlighting mode for various
3703 occasions. It is a comma separated list of character pairs. The
3704 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003705 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3707 |hl-NonText| @ '~' and '@' at the end of the window and
3708 characters from 'showbreak'
3709 |hl-Directory| d directories in CTRL-D listing and other special
3710 things in listings
3711 |hl-ErrorMsg| e error messages
3712 h (obsolete, ignored)
3713 |hl-IncSearch| i 'incsearch' highlighting
3714 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3715 |hl-MoreMsg| m |more-prompt|
3716 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003717 |hl-LineNr| n line number for ":number" and ":#" commands, and
3718 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 |hl-Question| r |hit-enter| prompt and yes/no questions
3720 |hl-StatusLine| s status line of current window |status-line|
3721 |hl-StatusLineNC| S status lines of not-current windows
3722 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3723 |hl-VertSplit| c column used to separate vertically split windows
3724 |hl-Visual| v Visual mode
3725 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3726 Selection" Only X11 Gui's |gui-x11| and
3727 |xterm-clipboard|.
3728 |hl-WarningMsg| w warning messages
3729 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3730 |hl-Folded| f line used for closed folds
3731 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003732 |hl-DiffAdd| A added line in diff mode
3733 |hl-DiffChange| C changed line in diff mode
3734 |hl-DiffDelete| D deleted line in diff mode
3735 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003737 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003738 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003739 |hl-SpellRare| R rare word |spell|
3740 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003741 |hl-Conceal| - the placeholders used for concealed characters
3742 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003743 |hl-Pmenu| + popup menu normal line
3744 |hl-PmenuSel| = popup menu normal line
3745 |hl-PmenuSbar| x popup menu scrollbar
3746 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747
3748 The display modes are:
3749 r reverse (termcap entry "mr" and "me")
3750 i italic (termcap entry "ZH" and "ZR")
3751 b bold (termcap entry "md" and "me")
3752 s standout (termcap entry "so" and "se")
3753 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003754 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 n no highlighting
3756 - no highlighting
3757 : use a highlight group
3758 The default is used for occasions that are not included.
3759 If you want to change what the display modes do, see |dos-colors|
3760 for an example.
3761 When using the ':' display mode, this must be followed by the name of
3762 a highlight group. A highlight group can be used to define any type
3763 of highlighting, including using color. See |:highlight| on how to
3764 define one. The default uses a different group for each occasion.
3765 See |highlight-default| for the default highlight groups.
3766
3767 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3768'hlsearch' 'hls' boolean (default off)
3769 global
3770 {not in Vi}
3771 {not available when compiled without the
3772 |+extra_search| feature}
3773 When there is a previous search pattern, highlight all its matches.
3774 The type of highlighting used can be set with the 'l' occasion in the
3775 'highlight' option. This uses the "Search" highlight group by
3776 default. Note that only the matching text is highlighted, any offsets
3777 are not applied.
3778 See also: 'incsearch' and |:match|.
3779 When you get bored looking at the highlighted matches, you can turn it
3780 off with |:nohlsearch|. As soon as you use a search command, the
3781 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003782 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 When the search pattern can match an end-of-line, Vim will try to
3784 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003785 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003787 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 NOTE: This option is reset when 'compatible' is set.
3789
3790 *'history'* *'hi'*
3791'history' 'hi' number (Vim default: 20, Vi default: 0)
3792 global
3793 {not in Vi}
3794 A history of ":" commands, and a history of previous search patterns
3795 are remembered. This option decides how many entries may be stored in
3796 each of these histories (see |cmdline-editing|).
3797 NOTE: This option is set to the Vi default value when 'compatible' is
3798 set and to the Vim default value when 'compatible' is reset.
3799
3800 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3801'hkmap' 'hk' boolean (default off)
3802 global
3803 {not in Vi}
3804 {only available when compiled with the |+rightleft|
3805 feature}
3806 When on, the keyboard is mapped for the Hebrew character set.
3807 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3808 toggle this option. See |rileft.txt|.
3809 NOTE: This option is reset when 'compatible' is set.
3810
3811 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3812'hkmapp' 'hkp' boolean (default off)
3813 global
3814 {not in Vi}
3815 {only available when compiled with the |+rightleft|
3816 feature}
3817 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3818 This is useful if you have a non-Hebrew keyboard.
3819 See |rileft.txt|.
3820 NOTE: This option is reset when 'compatible' is set.
3821
3822 *'icon'* *'noicon'*
3823'icon' boolean (default off, on when title can be restored)
3824 global
3825 {not in Vi}
3826 {not available when compiled without the |+title|
3827 feature}
3828 When on, the icon text of the window will be set to the value of
3829 'iconstring' (if it is not empty), or to the name of the file
3830 currently being edited. Only the last part of the name is used.
3831 Overridden by the 'iconstring' option.
3832 Only works if the terminal supports setting window icons (currently
3833 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3834 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3835 builtin termcap).
3836 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003837 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 X11.
3839
3840 *'iconstring'*
3841'iconstring' string (default "")
3842 global
3843 {not in Vi}
3844 {not available when compiled without the |+title|
3845 feature}
3846 When this option is not empty, it will be used for the icon text of
3847 the window. This happens only when the 'icon' option is on.
3848 Only works if the terminal supports setting window icon text
3849 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3850 Does not work for MS Windows.
3851 When Vim was compiled with HAVE_X11 defined, the original icon will be
3852 restored if possible |X11|.
3853 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003854 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 'titlestring' for example settings.
3856 {not available when compiled without the |+statusline| feature}
3857
3858 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3859'ignorecase' 'ic' boolean (default off)
3860 global
3861 Ignore case in search patterns. Also used when searching in the tags
3862 file.
3863 Also see 'smartcase'.
3864 Can be overruled by using "\c" or "\C" in the pattern, see
3865 |/ignorecase|.
3866
3867 *'imactivatekey'* *'imak'*
3868'imactivatekey' 'imak' string (default "")
3869 global
3870 {not in Vi}
3871 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003872 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 Specifies the key that your Input Method in X-Windows uses for
3874 activation. When this is specified correctly, vim can fully control
3875 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3876 You can't use this option to change the activation key, the option
3877 tells Vim what the key is.
3878 Format:
3879 [MODIFIER_FLAG-]KEY_STRING
3880
3881 These characters can be used for MODIFIER_FLAG (case is ignored):
3882 S Shift key
3883 L Lock key
3884 C Control key
3885 1 Mod1 key
3886 2 Mod2 key
3887 3 Mod3 key
3888 4 Mod4 key
3889 5 Mod5 key
3890 Combinations are allowed, for example "S-C-space" or "SC-space" are
3891 both shift+ctrl+space.
3892 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3893
3894 Example: >
3895 :set imactivatekey=S-space
3896< "S-space" means shift+space. This is the activation key for kinput2 +
3897 canna (Japanese), and ami (Korean).
3898
3899 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3900'imcmdline' 'imc' boolean (default off)
3901 global
3902 {not in Vi}
3903 {only available when compiled with the |+xim|
3904 |+multi_byte_ime| or |global-ime| feature}
3905 When set the Input Method is always on when starting to edit a command
3906 line, unless entering a search pattern (see 'imsearch' for that).
3907 Setting this option is useful when your input method allows entering
3908 English characters directly, e.g., when it's used to type accented
3909 characters with dead keys.
3910
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003911 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3913 global
3914 {not in Vi}
3915 {only available when compiled with the |+xim|
3916 |+multi_byte_ime| or |global-ime| feature}
3917 When set the Input Method is never used. This is useful to disable
3918 the IM when it doesn't work properly.
3919 Currently this option is on by default for SGI/IRIX machines. This
3920 may change in later releases.
3921
3922 *'iminsert'* *'imi'*
3923'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3924 local to buffer
3925 {not in Vi}
3926 Specifies whether :lmap or an Input Method (IM) is to be used in
3927 Insert mode. Valid values:
3928 0 :lmap is off and IM is off
3929 1 :lmap is ON and IM is off
3930 2 :lmap is off and IM is ON
3931 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3932 or |global-ime|.
3933 To always reset the option to zero when leaving Insert mode with <Esc>
3934 this can be used: >
3935 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3936< This makes :lmap and IM turn off automatically when leaving Insert
3937 mode.
3938 Note that this option changes when using CTRL-^ in Insert mode
3939 |i_CTRL-^|.
3940 The value is set to 1 when setting 'keymap' to a valid keymap name.
3941 It is also used for the argument of commands like "r" and "f".
3942 The value 0 may not work correctly with Athena and Motif with some XIM
3943 methods. Use 'imdisable' to disable XIM then.
3944
3945 *'imsearch'* *'ims'*
3946'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3947 local to buffer
3948 {not in Vi}
3949 Specifies whether :lmap or an Input Method (IM) is to be used when
3950 entering a search pattern. Valid values:
3951 -1 the value of 'iminsert' is used, makes it look like
3952 'iminsert' is also used when typing a search pattern
3953 0 :lmap is off and IM is off
3954 1 :lmap is ON and IM is off
3955 2 :lmap is off and IM is ON
3956 Note that this option changes when using CTRL-^ in Command-line mode
3957 |c_CTRL-^|.
3958 The value is set to 1 when it is not -1 and setting the 'keymap'
3959 option to a valid keymap name.
3960 The value 0 may not work correctly with Athena and Motif with some XIM
3961 methods. Use 'imdisable' to disable XIM then.
3962
3963 *'include'* *'inc'*
3964'include' 'inc' string (default "^\s*#\s*include")
3965 global or local to buffer |global-local|
3966 {not in Vi}
3967 {not available when compiled without the
3968 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003969 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 pattern, just like for the "/" command (See |pattern|). The default
3971 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003972 "]I", "[d", etc.
3973 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003974 comes after the matched pattern. But if "\zs" appears in the pattern
3975 then the text matched from "\zs" to the end, or until "\ze" if it
3976 appears, is used as the file name. Use this to include characters
3977 that are not in 'isfname', such as a space. You can then use
3978 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003979 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980
3981 *'includeexpr'* *'inex'*
3982'includeexpr' 'inex' string (default "")
3983 local to buffer
3984 {not in Vi}
3985 {not available when compiled without the
3986 |+find_in_path| or |+eval| feature}
3987 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003988 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 :set includeexpr=substitute(v:fname,'\\.','/','g')
3990< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003991
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003993 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994 Also used for |<cfile>|.
3995
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003996 The expression may be evaluated in the |sandbox|, see
3997 |sandbox-option|.
3998
3999 It is not allowed to change text or jump to another window while
4000 evaluating 'includeexpr' |textlock|.
4001
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4003'incsearch' 'is' boolean (default off)
4004 global
4005 {not in Vi}
4006 {not available when compiled without the
4007 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004008 While typing a search command, show where the pattern, as it was typed
4009 so far, matches. The matched string is highlighted. If the pattern
4010 is invalid or not found, nothing is shown. The screen will be updated
4011 often, this is only useful on fast terminals.
4012 Note that the match will be shown, but the cursor will return to its
4013 original position when no match is found and when pressing <Esc>. You
4014 still need to finish the search command with <Enter> to move the
4015 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004016 When compiled with the |+reltime| feature Vim only searches for about
4017 half a second. With a complicated pattern and/or a lot of text the
4018 match may not be found. This is to avoid that Vim hangs while you
4019 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004020 The highlighting can be set with the 'i' flag in 'highlight'.
4021 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004022 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004023 to the command line. If 'ignorecase' and 'smartcase' are set and the
4024 command line has no uppercase characters, the added character is
4025 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004026 CTRL-R CTRL-W can be used to add the word at the end of the current
4027 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 NOTE: This option is reset when 'compatible' is set.
4029
4030 *'indentexpr'* *'inde'*
4031'indentexpr' 'inde' string (default "")
4032 local to buffer
4033 {not in Vi}
4034 {not available when compiled without the |+cindent|
4035 or |+eval| features}
4036 Expression which is evaluated to obtain the proper indent for a line.
4037 It is used when a new line is created, for the |=| operator and
4038 in Insert mode as specified with the 'indentkeys' option.
4039 When this option is not empty, it overrules the 'cindent' and
4040 'smartindent' indenting.
4041 When 'paste' is set this option is not used for indenting.
4042 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004043 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 when the expression is evaluated (but it may be moved around).
4045 The expression must return the number of spaces worth of indent. It
4046 can return "-1" to keep the current indent (this means 'autoindent' is
4047 used for the indent).
4048 Functions useful for computing the indent are |indent()|, |cindent()|
4049 and |lispindent()|.
4050 The evaluation of the expression must not have side effects! It must
4051 not change the text, jump to another window, etc. Afterwards the
4052 cursor position is always restored, thus the cursor may be moved.
4053 Normally this option would be set to call a function: >
4054 :set indentexpr=GetMyIndent()
4055< Error messages will be suppressed, unless the 'debug' option contains
4056 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004057 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 NOTE: This option is made empty when 'compatible' is set.
4059
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004060 The expression may be evaluated in the |sandbox|, see
4061 |sandbox-option|.
4062
4063 It is not allowed to change text or jump to another window while
4064 evaluating 'indentexpr' |textlock|.
4065
4066
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 *'indentkeys'* *'indk'*
4068'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4069 local to buffer
4070 {not in Vi}
4071 {not available when compiled without the |+cindent|
4072 feature}
4073 A list of keys that, when typed in Insert mode, cause reindenting of
4074 the current line. Only happens if 'indentexpr' isn't empty.
4075 The format is identical to 'cinkeys', see |indentkeys-format|.
4076 See |C-indenting| and |indent-expression|.
4077
4078 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4079'infercase' 'inf' boolean (default off)
4080 local to buffer
4081 {not in Vi}
4082 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004083 'ignorecase' is also on, the case of the match is adjusted depending
4084 on the typed text. If the typed text contains a lowercase letter
4085 where the match has an upper case letter, the completed part is made
4086 lowercase. If the typed text has no lowercase letters and the match
4087 has a lowercase letter where the typed text has an uppercase letter,
4088 and there is a letter before it, the completed part is made uppercase.
4089 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090
4091 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4092'insertmode' 'im' boolean (default off)
4093 global
4094 {not in Vi}
4095 Makes Vim work in a way that Insert mode is the default mode. Useful
4096 if you want to use Vim as a modeless editor. Used for |evim|.
4097 These Insert mode commands will be useful:
4098 - Use the cursor keys to move around.
4099 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4100 this is a mapping, it is executed as if 'insertmode' was off.
4101 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004103 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4104 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105
4106 These items change when 'insertmode' is set:
4107 - when starting to edit of a file, Vim goes to Insert mode.
4108 - <Esc> in Insert mode is a no-op and beeps.
4109 - <Esc> in Normal mode makes Vim go to Insert mode.
4110 - CTRL-L in Insert mode is a command, it is not inserted.
4111 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4112 However, when <Esc> is used inside a mapping, it behaves like
4113 'insertmode' was not set. This was done to be able to use the same
4114 mappings with 'insertmode' set or not set.
4115 When executing commands with |:normal| 'insertmode' is not used.
4116
4117 NOTE: This option is reset when 'compatible' is set.
4118
4119 *'isfname'* *'isf'*
4120'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4121 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4122 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4123 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4124 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4125 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4126 global
4127 {not in Vi}
4128 The characters specified by this option are included in file names and
4129 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004130 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 Multi-byte characters 256 and above are always included, only the
4132 characters up to 255 are specified with this option.
4133 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004134 Think twice before adding white space to this option. Although a
4135 space may appear inside a file name, the effect will be that Vim
4136 doesn't know where a file name starts or ends when doing completion.
4137 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138
4139 Note that on systems using a backslash as path separator, Vim tries to
4140 do its best to make it work as you would expect. That is a bit
4141 tricky, since Vi originally used the backslash to escape special
4142 characters. Vim will not remove a backslash in front of a normal file
4143 name character on these systems, but it will on Unix and alikes. The
4144 '&' and '^' are not included by default, because these are special for
4145 cmd.exe.
4146
4147 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004148 Each part can be a single character number or a range. A range is two
4149 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150 decimal number between 0 and 255 or the ASCII character itself (does
4151 not work for digits). Example:
4152 "_,-,128-140,#-43" (include '_' and '-' and the range
4153 128 to 140 and '#' to 43)
4154 If a part starts with '^', the following character number or range
4155 will be excluded from the option. The option is interpreted from left
4156 to right. Put the excluded character after the range where it is
4157 included. To include '^' itself use it as the last character of the
4158 option or the end of a range. Example:
4159 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4160 If the character is '@', all characters where isalpha() returns TRUE
4161 are included. Normally these are the characters a to z and A to Z,
4162 plus accented characters. To include '@' itself use "@-@". Examples:
4163 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004164 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004165 "a-z,A-Z,@-@" All letters plus the '@' character.
4166 A comma can be included by using it where a character number is
4167 expected. Example:
4168 "48-57,,,_" Digits, comma and underscore.
4169 A comma can be excluded by prepending a '^'. Example:
4170 " -~,^,,9" All characters from space to '~', excluding
4171 comma, plus <Tab>.
4172 See |option-backslash| about including spaces and backslashes.
4173
4174 *'isident'* *'isi'*
4175'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4176 "@,48-57,_,128-167,224-235"
4177 otherwise: "@,48-57,_,192-255")
4178 global
4179 {not in Vi}
4180 The characters given by this option are included in identifiers.
4181 Identifiers are used in recognizing environment variables and after a
4182 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004183 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 option.
4185 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004186 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4188
4189 *'iskeyword'* *'isk'*
4190'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4191 "@,48-57,_,128-167,224-235"
4192 otherwise: "@,48-57,_,192-255"
4193 Vi default: "@,48-57,_")
4194 local to buffer
4195 {not in Vi}
4196 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004197 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 'isfname' for a description of the format of this option. For C
4199 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4200 For a help file it is set to all non-blank printable characters except
4201 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4202 command).
4203 When the 'lisp' option is on the '-' character is always included.
4204 NOTE: This option is set to the Vi default value when 'compatible' is
4205 set and to the Vim default value when 'compatible' is reset.
4206
4207 *'isprint'* *'isp'*
4208'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4209 "@,~-255"; otherwise: "@,161-255")
4210 global
4211 {not in Vi}
4212 The characters given by this option are displayed directly on the
4213 screen. It is also used for "\p" in a |pattern|. The characters from
4214 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4215 even when they are not included in 'isprint' or excluded. See
4216 'isfname' for a description of the format of this option.
4217
4218 Non-printable characters are displayed with two characters:
4219 0 - 31 "^@" - "^_"
4220 32 - 126 always single characters
4221 127 "^?"
4222 128 - 159 "~@" - "~_"
4223 160 - 254 "| " - "|~"
4224 255 "~?"
4225 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4226 displayed as <xx>, with the hexadecimal value of the byte.
4227 When 'display' contains "uhex" all unprintable characters are
4228 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004229 The SpecialKey highlighting will be used for unprintable characters.
4230 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231
4232 Multi-byte characters 256 and above are always included, only the
4233 characters up to 255 are specified with this option. When a character
4234 is printable but it is not available in the current font, a
4235 replacement character will be shown.
4236 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4237 There is no option to specify these characters.
4238
4239 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4240'joinspaces' 'js' boolean (default on)
4241 global
4242 {not in Vi}
4243 Insert two spaces after a '.', '?' and '!' with a join command.
4244 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4245 Otherwise only one space is inserted.
4246 NOTE: This option is set when 'compatible' is set.
4247
4248 *'key'*
4249'key' string (default "")
4250 local to buffer
4251 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004252 {only available when compiled with the |+cryptv|
4253 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004255 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 Careful: Do not set the key value by hand, someone might see the typed
4257 key. Use the |:X| command. But you can make 'key' empty: >
4258 :set key=
4259< It is not possible to get the value of this option with ":set key" or
4260 "echo &key". This is to avoid showing it to someone who shouldn't
4261 know. It also means you cannot see it yourself once you have set it,
4262 be careful not to make a typing error!
4263
4264 *'keymap'* *'kmp'* *E544*
4265'keymap' 'kmp' string (default "")
4266 local to buffer
4267 {not in Vi}
4268 {only available when compiled with the |+keymap|
4269 feature}
4270 Name of a keyboard mapping. See |mbyte-keymap|.
4271 Setting this option to a valid keymap name has the side effect of
4272 setting 'iminsert' to one, so that the keymap becomes effective.
4273 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004274 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275
4276 *'keymodel'* *'km'*
4277'keymodel' 'km' string (default "")
4278 global
4279 {not in Vi}
4280 List of comma separated words, which enable special things that keys
4281 can do. These values can be used:
4282 startsel Using a shifted special key starts selection (either
4283 Select mode or Visual mode, depending on "key" being
4284 present in 'selectmode').
4285 stopsel Using a not-shifted special key stops selection.
4286 Special keys in this context are the cursor keys, <End>, <Home>,
4287 <PageUp> and <PageDown>.
4288 The 'keymodel' option is set by the |:behave| command.
4289
4290 *'keywordprg'* *'kp'*
4291'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4292 OS/2: "view /", VMS: "help")
4293 global or local to buffer |global-local|
4294 {not in Vi}
4295 Program to use for the |K| command. Environment variables are
4296 expanded |:set_env|. ":help" may be used to access the Vim internal
4297 help. (Note that previously setting the global option to the empty
4298 value did this, which is now deprecated.)
4299 When "man" is used, Vim will automatically translate a count for the
4300 "K" command to a section number. Also for "man -s", in which case the
4301 "-s" is removed when there is no count.
4302 See |option-backslash| about including spaces and backslashes.
4303 Example: >
4304 :set keywordprg=man\ -s
4305< This option cannot be set from a |modeline| or in the |sandbox|, for
4306 security reasons.
4307
4308 *'langmap'* *'lmap'* *E357* *E358*
4309'langmap' 'lmap' string (default "")
4310 global
4311 {not in Vi}
4312 {only available when compiled with the |+langmap|
4313 feature}
4314 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004315 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 inserted directly. When in command mode the 'langmap' option takes
4317 care of translating these special characters to the original meaning
4318 of the key. This means you don't have to change the keyboard mode to
4319 be able to execute Normal mode commands.
4320 This is the opposite of the 'keymap' option, where characters are
4321 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004323 Example (for Greek, in UTF-8): *greek* >
4324 :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 +00004325< Example (exchanges meaning of z and y for commands): >
4326 :set langmap=zy,yz,ZY,YZ
4327<
4328 The 'langmap' option is a list of parts, separated with commas. Each
4329 part can be in one of two forms:
4330 1. A list of pairs. Each pair is a "from" character immediately
4331 followed by the "to" character. Examples: "aA", "aAbBcC".
4332 2. A list of "from" characters, a semi-colon and a list of "to"
4333 characters. Example: "abc;ABC"
4334 Example: "aA,fgh;FGH,cCdDeE"
4335 Special characters need to be preceded with a backslash. These are
4336 ";", ',' and backslash itself.
4337
4338 This will allow you to activate vim actions without having to switch
4339 back and forth between the languages. Your language characters will
4340 be understood as normal vim English characters (according to the
4341 langmap mappings) in the following cases:
4342 o Normal/Visual mode (commands, buffer/register names, user mappings)
4343 o Insert/Replace Mode: Register names after CTRL-R
4344 o Insert/Replace Mode: Mappings
4345 Characters entered in Command-line mode will NOT be affected by
4346 this option. Note that this option can be changed at any time
4347 allowing to switch between mappings for different languages/encodings.
4348 Use a mapping to avoid having to type it each time!
4349
4350 *'langmenu'* *'lm'*
4351'langmenu' 'lm' string (default "")
4352 global
4353 {not in Vi}
4354 {only available when compiled with the |+menu| and
4355 |+multi_lang| features}
4356 Language to use for menu translation. Tells which file is loaded
4357 from the "lang" directory in 'runtimepath': >
4358 "lang/menu_" . &langmenu . ".vim"
4359< (without the spaces). For example, to always use the Dutch menus, no
4360 matter what $LANG is set to: >
4361 :set langmenu=nl_NL.ISO_8859-1
4362< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004363 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364 If your $LANG is set to a non-English language but you do want to use
4365 the English menus: >
4366 :set langmenu=none
4367< This option must be set before loading menus, switching on filetype
4368 detection or syntax highlighting. Once the menus are defined setting
4369 this option has no effect. But you could do this: >
4370 :source $VIMRUNTIME/delmenu.vim
4371 :set langmenu=de_DE.ISO_8859-1
4372 :source $VIMRUNTIME/menu.vim
4373< Warning: This deletes all menus that you defined yourself!
4374
4375 *'laststatus'* *'ls'*
4376'laststatus' 'ls' number (default 1)
4377 global
4378 {not in Vi}
4379 The value of this option influences when the last window will have a
4380 status line:
4381 0: never
4382 1: only if there are at least two windows
4383 2: always
4384 The screen looks nicer with a status line if you have several
4385 windows, but it takes another screen line. |status-line|
4386
4387 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4388'lazyredraw' 'lz' boolean (default off)
4389 global
4390 {not in Vi}
4391 When this option is set, the screen will not be redrawn while
4392 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004393 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 update use |:redraw|.
4395
4396 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4397'linebreak' 'lbr' boolean (default off)
4398 local to window
4399 {not in Vi}
4400 {not available when compiled without the |+linebreak|
4401 feature}
4402 If on Vim will wrap long lines at a character in 'breakat' rather
4403 than at the last character that fits on the screen. Unlike
4404 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4405 it only affects the way the file is displayed, not its contents. The
4406 value of 'showbreak' is used to put in front of wrapped lines.
4407 This option is not used when the 'wrap' option is off or 'list' is on.
4408 Note that <Tab> characters after an <EOL> are mostly not displayed
4409 with the right amount of white space.
4410
4411 *'lines'* *E593*
4412'lines' number (default 24 or terminal height)
4413 global
4414 Number of lines of the Vim window.
4415 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004416 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 When Vim is running in the GUI or in a resizable window, setting this
4418 option will cause the window size to be changed. When you only want
4419 to use the size for the GUI, put the command in your |gvimrc| file.
4420 Vim limits the number of lines to what fits on the screen. You can
4421 use this command to get the tallest window possible: >
4422 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004423< Minimum value is 2, maximum value is 1000.
4424 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 When you set this option and Vim is unable to change the physical
4426 number of lines of the display, the display may be messed up.
4427
4428 *'linespace'* *'lsp'*
4429'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4430 global
4431 {not in Vi}
4432 {only in the GUI}
4433 Number of pixel lines inserted between characters. Useful if the font
4434 uses the full character cell height, making lines touch each other.
4435 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004436 With some fonts there can be too much room between lines (to have
4437 space for ascents and descents). Then it makes sense to set
4438 'linespace' to a negative value. This may cause display problems
4439 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440
4441 *'lisp'* *'nolisp'*
4442'lisp' boolean (default off)
4443 local to buffer
4444 {not available when compiled without the |+lispindent|
4445 feature}
4446 Lisp mode: When <Enter> is typed in insert mode set the indent for
4447 the next line to Lisp standards (well, sort of). Also happens with
4448 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4449 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4450 better. Also see 'lispwords'.
4451 The '-' character is included in keyword characters. Redefines the
4452 "=" operator to use this same indentation algorithm rather than
4453 calling an external program if 'equalprg' is empty.
4454 This option is not used when 'paste' is set.
4455 {Vi: Does it a little bit differently}
4456
4457 *'lispwords'* *'lw'*
4458'lispwords' 'lw' string (default is very long)
4459 global
4460 {not in Vi}
4461 {not available when compiled without the |+lispindent|
4462 feature}
4463 Comma separated list of words that influence the Lisp indenting.
4464 |'lisp'|
4465
4466 *'list'* *'nolist'*
4467'list' boolean (default off)
4468 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004469 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4470 line. Useful to see the difference between tabs and spaces and for
4471 trailing blanks. Further changed by the 'listchars' option.
4472
4473 The cursor is displayed at the start of the space a Tab character
4474 occupies, not at the end as usual in Normal mode. To get this cursor
4475 position while displaying Tabs with spaces, use: >
4476 :set list lcs=tab\ \
4477<
4478 Note that list mode will also affect formatting (set with 'textwidth'
4479 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 changing the way tabs are displayed.
4481
4482 *'listchars'* *'lcs'*
4483'listchars' 'lcs' string (default "eol:$")
4484 global
4485 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004486 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 settings.
4488 eol:c Character to show at the end of each line. When
4489 omitted, there is no extra character at the end of the
4490 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004491 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004493 fill the space that the tab normally occupies.
4494 "tab:>-" will show a tab that takes four spaces as
4495 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004496 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 trailing spaces are blank.
4498 extends:c Character to show in the last column, when 'wrap' is
4499 off and the line continues beyond the right of the
4500 screen.
4501 precedes:c Character to show in the first column, when 'wrap'
4502 is off and there is text preceding the character
4503 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004504 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004505 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004506 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004507 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004509 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004511 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004512
4513 Examples: >
4514 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004515 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 :set lcs=extends:>,precedes:<
4517< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004518 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004519 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520
4521 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4522'loadplugins' 'lpl' boolean (default on)
4523 global
4524 {not in Vi}
4525 When on the plugin scripts are loaded when starting up |load-plugins|.
4526 This option can be reset in your |vimrc| file to disable the loading
4527 of plugins.
4528 Note that using the "-u NONE" and "--noplugin" command line arguments
4529 reset this option. |-u| |--noplugin|
4530
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004531 *'macatsui'* *'nomacatsui'*
4532'macatsui' boolean (default on)
4533 global
4534 {only available in Mac GUI version}
4535 This is a workaround for when drawing doesn't work properly. When set
4536 and compiled with multi-byte support ATSUI text drawing is used. When
4537 not set ATSUI text drawing is not used. Switch this option off when
4538 you experience drawing problems. In a future version the problems may
4539 be solved and this option becomes obsolete. Therefore use this method
4540 to unset it: >
4541 if exists('&macatsui')
4542 set nomacatsui
4543 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004544< Another option to check if you have drawing problems is
4545 'termencoding'.
4546
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 *'magic'* *'nomagic'*
4548'magic' boolean (default on)
4549 global
4550 Changes the special characters that can be used in search patterns.
4551 See |pattern|.
4552 NOTE: To avoid portability problems with using patterns, always keep
4553 this option at the default "on". Only switch it off when working with
4554 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004555 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556
4557 *'makeef'* *'mef'*
4558'makeef' 'mef' string (default: "")
4559 global
4560 {not in Vi}
4561 {not available when compiled without the |+quickfix|
4562 feature}
4563 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4564 and the |:grep| command.
4565 When it is empty, an internally generated temp file will be used.
4566 When "##" is included, it is replaced by a number to make the name
4567 unique. This makes sure that the ":make" command doesn't overwrite an
4568 existing file.
4569 NOT used for the ":cf" command. See 'errorfile' for that.
4570 Environment variables are expanded |:set_env|.
4571 See |option-backslash| about including spaces and backslashes.
4572 This option cannot be set from a |modeline| or in the |sandbox|, for
4573 security reasons.
4574
4575 *'makeprg'* *'mp'*
4576'makeprg' 'mp' string (default "make", VMS: "MMS")
4577 global or local to buffer |global-local|
4578 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004579 Program to use for the ":make" command. See |:make_makeprg|.
4580 This option may contain '%' and '#' characters, which are expanded to
4581 the current and alternate file name. |:_%| |:_#|
4582 Environment variables are expanded |:set_env|. See |option-backslash|
4583 about including spaces and backslashes.
4584 Note that a '|' must be escaped twice: once for ":set" and once for
4585 the interpretation of a command. When you use a filter called
4586 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 :set makeprg=gmake\ \\\|\ myfilter
4588< The placeholder "$*" can be given (even multiple times) to specify
4589 where the arguments will be included, for example: >
4590 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4591< This option cannot be set from a |modeline| or in the |sandbox|, for
4592 security reasons.
4593
Bram Moolenaar1a384422010-07-14 19:53:30 +02004594 *'colorcolumn'* *'cc'*
4595'colorcolumn' 'cc' string (default "")
4596 local to window
4597 {not in Vi}
4598 {not available when compiled without the |+syntax|
4599 feature}
4600 'colorcolumn' is a comma separated list of screen columns that are
4601 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
4602 text. Will make screen redrawing slower.
4603 The screen column can be an absolute number, or a number preceded with
4604 '+' or '-', which is added to or subtracted from 'textwidth'. >
4605
4606 :set cc=+1 " highlight column after 'textwidth'
4607 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
4608 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
4609<
4610 When 'textwidth' is zero then the items with '-' and '+' are not used.
4611 A maximum of 256 columns are highlighted.
4612
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 *'matchpairs'* *'mps'*
4614'matchpairs' 'mps' string (default "(:),{:},[:]")
4615 local to buffer
4616 {not in Vi}
4617 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004618 other. Currently only single byte character pairs are allowed, and
4619 they must be different. The characters must be separated by a colon.
4620 The pairs must be separated by a comma. Example for including '<' and
4621 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 :set mps+=<:>
4623
4624< A more exotic example, to jump between the '=' and ';' in an
4625 assignment, useful for languages like C and Java: >
4626 :au FileType c,cpp,java set mps+==:;
4627
4628< For a more advanced way of using "%", see the matchit.vim plugin in
4629 the $VIMRUNTIME/macros directory. |add-local-help|
4630
4631 *'matchtime'* *'mat'*
4632'matchtime' 'mat' number (default 5)
4633 global
4634 {not in Vi}{in Nvi}
4635 Tenths of a second to show the matching paren, when 'showmatch' is
4636 set. Note that this is not in milliseconds, like other options that
4637 set a time. This is to be compatible with Nvi.
4638
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004639 *'maxcombine'* *'mco'*
4640'maxcombine' 'mco' number (default 2)
4641 global
4642 {not in Vi}
4643 {only available when compiled with the |+multi_byte|
4644 feature}
4645 The maximum number of combining characters supported for displaying.
4646 Only used when 'encoding' is "utf-8".
4647 The default is OK for most languages. Hebrew may require 4.
4648 Maximum value is 6.
4649 Even when this option is set to 2 you can still edit text with more
4650 combining characters, you just can't see them. Use |g8| or |ga|.
4651 See |mbyte-combining|.
4652
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 *'maxfuncdepth'* *'mfd'*
4654'maxfuncdepth' 'mfd' number (default 100)
4655 global
4656 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004657 {not available when compiled without the +eval
4658 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659 Maximum depth of function calls for user functions. This normally
4660 catches endless recursion. When using a recursive function with
4661 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4662 more memory, there is the danger of failing when memory is exhausted.
4663 See also |:function|.
4664
4665 *'maxmapdepth'* *'mmd'* *E223*
4666'maxmapdepth' 'mmd' number (default 1000)
4667 global
4668 {not in Vi}
4669 Maximum number of times a mapping is done without resulting in a
4670 character to be used. This normally catches endless mappings, like
4671 ":map x y" with ":map y x". It still does not catch ":map g wg",
4672 because the 'w' is used before the next mapping is done. See also
4673 |key-mapping|.
4674
4675 *'maxmem'* *'mm'*
4676'maxmem' 'mm' number (default between 256 to 5120 (system
4677 dependent) or half the amount of memory
4678 available)
4679 global
4680 {not in Vi}
4681 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4682 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004683 other memory to be freed. The maximum usable value is about 2000000.
4684 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004686 *'maxmempattern'* *'mmp'*
4687'maxmempattern' 'mmp' number (default 1000)
4688 global
4689 {not in Vi}
4690 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004691 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004692 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004693 When Vim runs into the limit it gives an error message and mostly
4694 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004695 Running into the limit often means that the pattern is very
4696 inefficient or too complex. This may already happen with the pattern
4697 "\(.\)*" on a very long line. ".*" works much better.
4698 Vim may run out of memory before hitting the 'maxmempattern' limit.
4699
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700 *'maxmemtot'* *'mmt'*
4701'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4702 dependent) or half the amount of memory
4703 available)
4704 global
4705 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004706 Maximum amount of memory in Kbyte to use for all buffers together.
4707 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4708 without a limit. On 64 bit machines higher values might work. But
4709 hey, do you really need more than 2 Gbyte for text editing?
4710 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711
4712 *'menuitems'* *'mis'*
4713'menuitems' 'mis' number (default 25)
4714 global
4715 {not in Vi}
4716 {not available when compiled without the |+menu|
4717 feature}
4718 Maximum number of items to use in a menu. Used for menus that are
4719 generated from a list of items, e.g., the Buffers menu. Changing this
4720 option has no direct effect, the menu must be refreshed first.
4721
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004722 *'mkspellmem'* *'msm'*
4723'mkspellmem' 'msm' string (default "460000,2000,500")
4724 global
4725 {not in Vi}
4726 {not available when compiled without the |+syntax|
4727 feature}
4728 Parameters for |:mkspell|. This tunes when to start compressing the
4729 word tree. Compression can be slow when there are many words, but
4730 it's needed to avoid running out of memory. The amount of memory used
4731 per word depends very much on how similar the words are, that's why
4732 this tuning is complicated.
4733
4734 There are three numbers, separated by commas:
4735 {start},{inc},{added}
4736
4737 For most languages the uncompressed word tree fits in memory. {start}
4738 gives the amount of memory in Kbyte that can be used before any
4739 compression is done. It should be a bit smaller than the amount of
4740 memory that is available to Vim.
4741
4742 When going over the {start} limit the {inc} number specifies the
4743 amount of memory in Kbyte that can be allocated before another
4744 compression is done. A low number means compression is done after
4745 less words are added, which is slow. A high number means more memory
4746 will be allocated.
4747
4748 After doing compression, {added} times 1024 words can be added before
4749 the {inc} limit is ignored and compression is done when any extra
4750 amount of memory is needed. A low number means there is a smaller
4751 chance of hitting the {inc} limit, less memory is used but it's
4752 slower.
4753
4754 The languages for which these numbers are important are Italian and
4755 Hungarian. The default works for when you have about 512 Mbyte. If
4756 you have 1 Gbyte you could use: >
4757 :set mkspellmem=900000,3000,800
4758< If you have less than 512 Mbyte |:mkspell| may fail for some
4759 languages, no matter what you set 'mkspellmem' to.
4760
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004762'modeline' 'ml' boolean (Vim default: on (off for root),
4763 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 local to buffer
4765 *'modelines'* *'mls'*
4766'modelines' 'mls' number (default 5)
4767 global
4768 {not in Vi}
4769 If 'modeline' is on 'modelines' gives the number of lines that is
4770 checked for set commands. If 'modeline' is off or 'modelines' is zero
4771 no lines are checked. See |modeline|.
4772 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4773 set and to the Vim default value when 'compatible' is reset.
4774
4775 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4776'modifiable' 'ma' boolean (default on)
4777 local to buffer
4778 {not in Vi} *E21*
4779 When off the buffer contents cannot be changed. The 'fileformat' and
4780 'fileencoding' options also can't be changed.
4781 Can be reset with the |-M| command line argument.
4782
4783 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4784'modified' 'mod' boolean (default off)
4785 local to buffer
4786 {not in Vi}
4787 When on, the buffer is considered to be modified. This option is set
4788 when:
4789 1. A change was made to the text since it was last written. Using the
4790 |undo| command to go back to the original text will reset the
4791 option. But undoing changes that were made before writing the
4792 buffer will set the option again, since the text is different from
4793 when it was written.
4794 2. 'fileformat' or 'fileencoding' is different from its original
4795 value. The original value is set when the buffer is read or
4796 written. A ":set nomodified" command also resets the original
4797 values to the current values and the 'modified' option will be
4798 reset.
4799 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4800 will be ignored.
4801
4802 *'more'* *'nomore'*
4803'more' boolean (Vim default: on, Vi default: off)
4804 global
4805 {not in Vi}
4806 When on, listings pause when the whole screen is filled. You will get
4807 the |more-prompt|. When this option is off there are no pauses, the
4808 listing continues until finished.
4809 NOTE: This option is set to the Vi default value when 'compatible' is
4810 set and to the Vim default value when 'compatible' is reset.
4811
4812 *'mouse'* *E538*
4813'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4814 global
4815 {not in Vi}
4816 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004817 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4818 sysmouse and Linux console with gpm). For using the mouse in the
4819 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 The mouse can be enabled for different modes:
4821 n Normal mode
4822 v Visual mode
4823 i Insert mode
4824 c Command-line mode
4825 h all previous modes when editing a help file
4826 a all previous modes
4827 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828 Normally you would enable the mouse in all four modes with: >
4829 :set mouse=a
4830< When the mouse is not enabled, the GUI will still use the mouse for
4831 modeless selection. This doesn't move the text cursor.
4832
4833 See |mouse-using|. Also see |'clipboard'|.
4834
4835 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004836 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 the mouse buttons can still be used by keeping the shift key pressed.
4838 Also see the 'clipboard' option.
4839
4840 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4841'mousefocus' 'mousef' boolean (default off)
4842 global
4843 {not in Vi}
4844 {only works in the GUI}
4845 The window that the mouse pointer is on is automatically activated.
4846 When changing the window layout or window focus in another way, the
4847 mouse pointer is moved to the window with keyboard focus. Off is the
4848 default because it makes using the pull down menus a little goofy, as
4849 a pointer transit may activate a window unintentionally.
4850
4851 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4852'mousehide' 'mh' boolean (default on)
4853 global
4854 {not in Vi}
4855 {only works in the GUI}
4856 When on, the mouse pointer is hidden when characters are typed.
4857 The mouse pointer is restored when the mouse is moved.
4858
4859 *'mousemodel'* *'mousem'*
4860'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4861 global
4862 {not in Vi}
4863 Sets the model to use for the mouse. The name mostly specifies what
4864 the right mouse button is used for:
4865 extend Right mouse button extends a selection. This works
4866 like in an xterm.
4867 popup Right mouse button pops up a menu. The shifted left
4868 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004869 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 popup_setpos Like "popup", but the cursor will be moved to the
4871 position where the mouse was clicked, and thus the
4872 selected operation will act upon the clicked object.
4873 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004874 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 course, that right clicking outside a selection will
4876 end Visual mode.
4877 Overview of what button does what for each model:
4878 mouse extend popup(_setpos) ~
4879 left click place cursor place cursor
4880 left drag start selection start selection
4881 shift-left search word extend selection
4882 right click extend selection popup menu (place cursor)
4883 right drag extend selection -
4884 middle click paste paste
4885
4886 In the "popup" model the right mouse button produces a pop-up menu.
4887 You need to define this first, see |popup-menu|.
4888
4889 Note that you can further refine the meaning of buttons with mappings.
4890 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4891 selection (because that's handled in the GUI code directly).
4892
4893 The 'mousemodel' option is set by the |:behave| command.
4894
4895 *'mouseshape'* *'mouses'* *E547*
4896'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004897 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898 global
4899 {not in Vi}
4900 {only available when compiled with the |+mouseshape|
4901 feature}
4902 This option tells Vim what the mouse pointer should look like in
4903 different modes. The option is a comma separated list of parts, much
4904 like used for 'guicursor'. Each part consist of a mode/location-list
4905 and an argument-list:
4906 mode-list:shape,mode-list:shape,..
4907 The mode-list is a dash separated list of these modes/locations:
4908 In a normal window: ~
4909 n Normal mode
4910 v Visual mode
4911 ve Visual mode with 'selection' "exclusive" (same as 'v',
4912 if not specified)
4913 o Operator-pending mode
4914 i Insert mode
4915 r Replace mode
4916
4917 Others: ~
4918 c appending to the command-line
4919 ci inserting in the command-line
4920 cr replacing in the command-line
4921 m at the 'Hit ENTER' or 'More' prompts
4922 ml idem, but cursor in the last line
4923 e any mode, pointer below last window
4924 s any mode, pointer on a status line
4925 sd any mode, while dragging a status line
4926 vs any mode, pointer on a vertical separator line
4927 vd any mode, while dragging a vertical separator line
4928 a everywhere
4929
4930 The shape is one of the following:
4931 avail name looks like ~
4932 w x arrow Normal mouse pointer
4933 w x blank no pointer at all (use with care!)
4934 w x beam I-beam
4935 w x updown up-down sizing arrows
4936 w x leftright left-right sizing arrows
4937 w x busy The system's usual busy pointer
4938 w x no The system's usual 'no input' pointer
4939 x udsizing indicates up-down resizing
4940 x lrsizing indicates left-right resizing
4941 x crosshair like a big thin +
4942 x hand1 black hand
4943 x hand2 white hand
4944 x pencil what you write with
4945 x question big ?
4946 x rightup-arrow arrow pointing right-up
4947 w x up-arrow arrow pointing up
4948 x <number> any X11 pointer number (see X11/cursorfont.h)
4949
4950 The "avail" column contains a 'w' if the shape is available for Win32,
4951 x for X11.
4952 Any modes not specified or shapes not available use the normal mouse
4953 pointer.
4954
4955 Example: >
4956 :set mouseshape=s:udsizing,m:no
4957< will make the mouse turn to a sizing arrow over the status lines and
4958 indicate no input when the hit-enter prompt is displayed (since
4959 clicking the mouse has no effect in this state.)
4960
4961 *'mousetime'* *'mouset'*
4962'mousetime' 'mouset' number (default 500)
4963 global
4964 {not in Vi}
4965 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4966 time in msec between two mouse clicks for the second click to be
4967 recognized as a multi click.
4968
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004969 *'mzquantum'* *'mzq'*
4970'mzquantum' 'mzq' number (default 100)
4971 global
4972 {not in Vi}
4973 {not available when compiled without the |+mzscheme|
4974 feature}
4975 The number of milliseconds between polls for MzScheme threads.
4976 Negative or zero value means no thread scheduling.
4977
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 *'nrformats'* *'nf'*
4979'nrformats' 'nf' string (default "octal,hex")
4980 local to buffer
4981 {not in Vi}
4982 This defines what bases Vim will consider for numbers when using the
4983 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4984 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004985 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02004987 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00004988 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004990 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 considered to be hexadecimal. Example: Using CTRL-X on
4992 "0x100" results in "0x0ff".
4993 Numbers which simply begin with a digit in the range 1-9 are always
4994 considered decimal. This also happens for numbers that are not
4995 recognized as octal or hex.
4996
4997 *'number'* *'nu'* *'nonumber'* *'nonu'*
4998'number' 'nu' boolean (default off)
4999 local to window
5000 Print the line number in front of each line. When the 'n' option is
5001 excluded from 'cpoptions' a wrapped line will not use the column of
5002 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005003 The 'numberwidth' option can be used to set the room used for the line
5004 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005 When a long, wrapped line doesn't start with the first character, '-'
5006 characters are put before the number.
5007 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005008 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005010 *'numberwidth'* *'nuw'*
5011'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5012 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005013 {not in Vi}
5014 {only available when compiled with the |+linebreak|
5015 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005016 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005017 when the 'number' or 'relativenumber' option is set or printing lines
5018 with a line number. Since one space is always between the number and
5019 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005020 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005021 fit the highest line number in the buffer respectively the number of
5022 rows in the window, depending on whether 'number' or 'relativenumber'
5023 is set. Thus with the Vim default of 4 there is room for a line number
5024 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005025 The minimum value is 1, the maximum value is 10.
5026 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5027
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005028 *'omnifunc'* *'ofu'*
5029'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005030 local to buffer
5031 {not in Vi}
5032 {not available when compiled without the +eval
5033 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005034 This option specifies a function to be used for Insert mode omni
5035 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005036 See |complete-functions| for an explanation of how the function is
5037 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005038 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005039 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005040
5041
Bram Moolenaar02467872007-05-06 13:22:01 +00005042 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005043'opendevice' 'odev' boolean (default off)
5044 global
5045 {not in Vi}
5046 {only for MS-DOS, MS-Windows and OS/2}
5047 Enable reading and writing from devices. This may get Vim stuck on a
5048 device that can be opened but doesn't actually do the I/O. Therefore
5049 it is off by default.
5050 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5051 result in editing a device.
5052
5053
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005054 *'operatorfunc'* *'opfunc'*
5055'operatorfunc' 'opfunc' string (default: empty)
5056 global
5057 {not in Vi}
5058 This option specifies a function to be called by the |g@| operator.
5059 See |:map-operator| for more info and an example.
5060
5061 This option cannot be set from a |modeline| or in the |sandbox|, for
5062 security reasons.
5063
5064
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 *'osfiletype'* *'oft'* *E366*
5066'osfiletype' 'oft' string (RISC-OS default: "Text",
5067 others default: "")
5068 local to buffer
5069 {not in Vi}
5070 {only available when compiled with the |+osfiletype|
5071 feature}
5072 Some operating systems store extra information about files besides
5073 name, datestamp and permissions. This option contains the extra
5074 information, the nature of which will vary between systems.
5075 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005076 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077 It can affect the pattern matching of the automatic commands.
5078 |autocmd-osfiletypes|
5079
5080 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005081'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 global
5083 Specifies the nroff macros that separate paragraphs. These are pairs
5084 of two letters (see |object-motions|).
5085
5086 *'paste'* *'nopaste'*
5087'paste' boolean (default off)
5088 global
5089 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005090 Put Vim in Paste mode. This is useful if you want to cut or copy
5091 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092 unexpected effects.
5093 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005094 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095 knows about pasting and will mostly do the right thing without 'paste'
5096 being set. The same is true for a terminal where Vim handles the
5097 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005098 This option is reset when starting the GUI. Thus if you set it in
5099 your .vimrc it will work in a terminal, but not in the GUI. Setting
5100 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5101 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 When the 'paste' option is switched on (also when it was already on):
5103 - mapping in Insert mode and Command-line mode is disabled
5104 - abbreviations are disabled
5105 - 'textwidth' is set to 0
5106 - 'wrapmargin' is set to 0
5107 - 'autoindent' is reset
5108 - 'smartindent' is reset
5109 - 'softtabstop' is set to 0
5110 - 'revins' is reset
5111 - 'ruler' is reset
5112 - 'showmatch' is reset
5113 - 'formatoptions' is used like it is empty
5114 These options keep their value, but their effect is disabled:
5115 - 'lisp'
5116 - 'indentexpr'
5117 - 'cindent'
5118 NOTE: When you start editing another file while the 'paste' option is
5119 on, settings from the modelines or autocommands may change the
5120 settings again, causing trouble when pasting text. You might want to
5121 set the 'paste' option again.
5122 When the 'paste' option is reset the mentioned options are restored to
5123 the value before the moment 'paste' was switched from off to on.
5124 Resetting 'paste' before ever setting it does not have any effect.
5125 Since mapping doesn't work while 'paste' is active, you need to use
5126 the 'pastetoggle' option to toggle the 'paste' option with some key.
5127
5128 *'pastetoggle'* *'pt'*
5129'pastetoggle' 'pt' string (default "")
5130 global
5131 {not in Vi}
5132 When non-empty, specifies the key sequence that toggles the 'paste'
5133 option. This is like specifying a mapping: >
5134 :map {keys} :set invpaste<CR>
5135< Where {keys} is the value of 'pastetoggle'.
5136 The difference is that it will work even when 'paste' is set.
5137 'pastetoggle' works in Insert mode and Normal mode, but not in
5138 Command-line mode.
5139 Mappings are checked first, thus overrule 'pastetoggle'. However,
5140 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5141 this: >
5142 :map <F10> :set paste<CR>
5143 :map <F11> :set nopaste<CR>
5144 :imap <F10> <C-O>:set paste<CR>
5145 :imap <F11> <nop>
5146 :set pastetoggle=<F11>
5147< This will make <F10> start paste mode and <F11> stop paste mode.
5148 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5149 mode everything is inserted literally, except the 'pastetoggle' key
5150 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005151 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005152
5153 *'pex'* *'patchexpr'*
5154'patchexpr' 'pex' string (default "")
5155 global
5156 {not in Vi}
5157 {not available when compiled without the |+diff|
5158 feature}
5159 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005160 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161
5162 *'patchmode'* *'pm'* *E206*
5163'patchmode' 'pm' string (default "")
5164 global
5165 {not in Vi}
5166 When non-empty the oldest version of a file is kept. This can be used
5167 to keep the original version of a file if you are changing files in a
5168 source distribution. Only the first time that a file is written a
5169 copy of the original file will be kept. The name of the copy is the
5170 name of the original file with the string in the 'patchmode' option
5171 appended. This option should start with a dot. Use a string like
5172 ".org". 'backupdir' must not be empty for this to work (Detail: The
5173 backup file is renamed to the patchmode file after the new file has
5174 been successfully written, that's why it must be possible to write a
5175 backup file). If there was no file to be backed up, an empty file is
5176 created.
5177 When the 'backupskip' pattern matches, a patchmode file is not made.
5178 Using 'patchmode' for compressed files appends the extension at the
5179 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5180 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005181 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182
5183 *'path'* *'pa'* *E343* *E345* *E347*
5184'path' 'pa' string (default on Unix: ".,/usr/include,,"
5185 on OS/2: ".,/emx/include,,"
5186 other systems: ".,,")
5187 global or local to buffer |global-local|
5188 {not in Vi}
5189 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005190 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5191 provided that the file being searched for has a relative path (not
5192 starting with "/", "./" or "../"). The directories in the 'path'
5193 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194 - Use commas to separate directory names: >
5195 :set path=.,/usr/local/include,/usr/include
5196< - Spaces can also be used to separate directory names (for backwards
5197 compatibility with version 3.0). To have a space in a directory
5198 name, precede it with an extra backslash, and escape the space: >
5199 :set path=.,/dir/with\\\ space
5200< - To include a comma in a directory name precede it with an extra
5201 backslash: >
5202 :set path=.,/dir/with\\,comma
5203< - To search relative to the directory of the current file, use: >
5204 :set path=.
5205< - To search in the current directory use an empty string between two
5206 commas: >
5207 :set path=,,
5208< - A directory name may end in a ':' or '/'.
5209 - Environment variables are expanded |:set_env|.
5210 - When using |netrw.vim| URLs can be used. For example, adding
5211 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005212 - Search upwards and downwards in a directory tree using "*", "**" and
5213 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 {not available when compiled without the |+path_extra| feature}
5215 - Careful with '\' characters, type two to get one in the option: >
5216 :set path=.,c:\\include
5217< Or just use '/' instead: >
5218 :set path=.,c:/include
5219< Don't forget "." or files won't even be found in the same directory as
5220 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005221 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222 it is something like 256 or 1024 characters.
5223 You can check if all the include files are found, using the value of
5224 'path', see |:checkpath|.
5225 The use of |:set+=| and |:set-=| is preferred when adding or removing
5226 directories from the list. This avoids problems when a future version
5227 uses another default. To remove the current directory use: >
5228 :set path-=
5229< To add the current directory use: >
5230 :set path+=
5231< To use an environment variable, you probably need to replace the
5232 separator. Here is an example to append $INCL, in which directory
5233 names are separated with a semi-colon: >
5234 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5235< Replace the ';' with a ':' or whatever separator is used. Note that
5236 this doesn't work when $INCL contains a comma or white space.
5237
5238 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5239'preserveindent' 'pi' boolean (default off)
5240 local to buffer
5241 {not in Vi}
5242 When changing the indent of the current line, preserve as much of the
5243 indent structure as possible. Normally the indent is replaced by a
5244 series of tabs followed by spaces as required (unless |'expandtab'| is
5245 enabled, in which case only spaces are used). Enabling this option
5246 means the indent will preserve as many existing characters as possible
5247 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005248 'expandtab' does not apply to the preserved white space, a Tab remains
5249 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005250 NOTE: When using ">>" multiple times the resulting indent is a mix of
5251 tabs and spaces. You might not like this.
5252 NOTE: 'preserveindent' is reset when 'compatible' is set.
5253 Also see 'copyindent'.
5254 Use |:retab| to clean up white space.
5255
5256 *'previewheight'* *'pvh'*
5257'previewheight' 'pvh' number (default 12)
5258 global
5259 {not in Vi}
5260 {not available when compiled without the |+windows| or
5261 |+quickfix| feature}
5262 Default height for a preview window. Used for |:ptag| and associated
5263 commands. Used for |CTRL-W_}| when no count is given.
5264
5265 *'previewwindow'* *'nopreviewwindow'*
5266 *'pvw'* *'nopvw'* *E590*
5267'previewwindow' 'pvw' boolean (default off)
5268 local to window
5269 {not in Vi}
5270 {not available when compiled without the |+windows| or
5271 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005272 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005273 set. It's normally not set directly, but by using one of the commands
5274 |:ptag|, |:pedit|, etc.
5275
5276 *'printdevice'* *'pdev'*
5277'printdevice' 'pdev' string (default empty)
5278 global
5279 {not in Vi}
5280 {only available when compiled with the |+printer|
5281 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005282 The name of the printer to be used for |:hardcopy|.
5283 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005284 This option cannot be set from a |modeline| or in the |sandbox|, for
5285 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005286
Bram Moolenaar8299df92004-07-10 09:47:34 +00005287 *'printencoding'* *'penc'*
5288'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289 global
5290 {not in Vi}
5291 {only available when compiled with the |+printer|
5292 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005293 Sets the character encoding used when printing.
5294 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005295
5296 *'printexpr'* *'pexpr'*
5297'printexpr' 'pexpr' String (default: see below)
5298 global
5299 {not in Vi}
5300 {only available when compiled with the |+printer|
5301 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005302 Expression used to print the PostScript produced with |:hardcopy|.
5303 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005304
Bram Moolenaar8299df92004-07-10 09:47:34 +00005305 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005306'printfont' 'pfn' string (default "courier")
5307 global
5308 {not in Vi}
5309 {only available when compiled with the |+printer|
5310 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005311 The name of the font that will be used for |:hardcopy|.
5312 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313
5314 *'printheader'* *'pheader'*
5315'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5316 global
5317 {not in Vi}
5318 {only available when compiled with the |+printer|
5319 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005320 The format of the header produced in |:hardcopy| output.
5321 See |pheader-option|.
5322
5323 *'printmbcharset'* *'pmbcs'*
5324'printmbcharset' 'pmbcs' string (default "")
5325 global
5326 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005327 {only available when compiled with the |+printer|,
5328 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005329 The CJK character set to be used for CJK output from |:hardcopy|.
5330 See |pmbcs-option|.
5331
5332 *'printmbfont'* *'pmbfn'*
5333'printmbfont' 'pmbfn' string (default "")
5334 global
5335 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005336 {only available when compiled with the |+printer|,
5337 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005338 List of font names to be used for CJK output from |:hardcopy|.
5339 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340
5341 *'printoptions'* *'popt'*
5342'printoptions' 'popt' string (default "")
5343 global
5344 {not in Vi}
5345 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005346 List of items that control the format of the output of |:hardcopy|.
5347 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005348
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005349 *'prompt'* *'noprompt'*
5350'prompt' boolean (default on)
5351 global
5352 When on a ":" prompt is used in Ex mode.
5353
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005354 *'pumheight'* *'ph'*
5355'pumheight' 'ph' number (default 0)
5356 global
5357 {not available when compiled without the
5358 |+insert_expand| feature}
5359 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005360 Determines the maximum number of items to show in the popup menu for
5361 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005362 |ins-completion-menu|.
5363
5364
Bram Moolenaar677ee682005-01-27 14:41:15 +00005365 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005366'quoteescape' 'qe' string (default "\")
5367 local to buffer
5368 {not in Vi}
5369 The characters that are used to escape quotes in a string. Used for
5370 objects like a', a" and a` |a'|.
5371 When one of the characters in this option is found inside a string,
5372 the following character will be skipped. The default value makes the
5373 text "foo\"bar\\" considered to be one string.
5374
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5376'readonly' 'ro' boolean (default off)
5377 local to buffer
5378 If on, writes fail unless you use a '!'. Protects you from
5379 accidentally overwriting a file. Default on when Vim is started
5380 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005381 When using ":w!" the 'readonly' option is reset for the current
5382 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005384 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005385
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005386 *'redrawtime'* *'rdt'*
5387'redrawtime' 'rdt' number (default 2000)
5388 global
5389 {not in Vi}
5390 {only available when compiled with the |+reltime|
5391 feature}
5392 The time in milliseconds for redrawing the display. This applies to
5393 searching for patterns for 'hlsearch' and |:match| highlighting.
5394 When redrawing takes more than this many milliseconds no further
5395 matches will be highlighted. This is used to avoid that Vim hangs
5396 when using a very complicated pattern.
5397
Bram Moolenaar64486672010-05-16 15:46:46 +02005398 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5399'relativenumber' 'rnu' boolean (default off)
5400 local to window
5401 {not in Vi}
5402 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005403 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005404 precede some vertical motion commands (e.g. j k + -) with, without
5405 having to calculate it yourself. Especially useful in combination with
5406 other commands (e.g. y d c < > gq gw =).
5407 When the 'n' option is excluded from 'cpoptions' a wrapped
5408 line will not use the column of line numbers (this is the default when
5409 'compatible' isn't set).
5410 The 'numberwidth' option can be used to set the room used for the line
5411 number.
5412 When a long, wrapped line doesn't start with the first character, '-'
5413 characters are put before the number.
5414 See |hl-LineNr| for the highlighting used for the number.
5415 When setting this option, 'number' is reset.
5416
Bram Moolenaar071d4272004-06-13 20:20:40 +00005417 *'remap'* *'noremap'*
5418'remap' boolean (default on)
5419 global
5420 Allows for mappings to work recursively. If you do not want this for
5421 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005422 NOTE: To avoid portability problems with Vim scripts, always keep
5423 this option at the default "on". Only switch it off when working with
5424 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425
5426 *'report'*
5427'report' number (default 2)
5428 global
5429 Threshold for reporting number of lines changed. When the number of
5430 changed lines is more than 'report' a message will be given for most
5431 ":" commands. If you want it always, set 'report' to 0.
5432 For the ":substitute" command the number of substitutions is used
5433 instead of the number of lines.
5434
5435 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5436'restorescreen' 'rs' boolean (default on)
5437 global
5438 {not in Vi} {only in Windows 95/NT console version}
5439 When set, the screen contents is restored when exiting Vim. This also
5440 happens when executing external commands.
5441
5442 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5443 options in your .vimrc. To disable restoring:
5444 set t_ti= t_te=
5445 To enable restoring (for an xterm):
5446 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5447 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5448
5449 *'revins'* *'ri'* *'norevins'* *'nori'*
5450'revins' 'ri' boolean (default off)
5451 global
5452 {not in Vi}
5453 {only available when compiled with the |+rightleft|
5454 feature}
5455 Inserting characters in Insert mode will work backwards. See "typing
5456 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5457 command in Insert mode, when 'allowrevins' is set.
5458 NOTE: This option is reset when 'compatible' or 'paste' is set.
5459
5460 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5461'rightleft' 'rl' boolean (default off)
5462 local to window
5463 {not in Vi}
5464 {only available when compiled with the |+rightleft|
5465 feature}
5466 When on, display orientation becomes right-to-left, i.e., characters
5467 that are stored in the file appear from the right to the left.
5468 Using this option, it is possible to edit files for languages that
5469 are written from the right to the left such as Hebrew and Arabic.
5470 This option is per window, so it is possible to edit mixed files
5471 simultaneously, or to view the same file in both ways (this is
5472 useful whenever you have a mixed text file with both right-to-left
5473 and left-to-right strings so that both sets are displayed properly
5474 in different windows). Also see |rileft.txt|.
5475
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005476 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477'rightleftcmd' 'rlc' string (default "search")
5478 local to window
5479 {not in Vi}
5480 {only available when compiled with the |+rightleft|
5481 feature}
5482 Each word in this option enables the command line editing to work in
5483 right-to-left mode for a group of commands:
5484
5485 search "/" and "?" commands
5486
5487 This is useful for languages such as Hebrew, Arabic and Farsi.
5488 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5489
5490 *'ruler'* *'ru'* *'noruler'* *'noru'*
5491'ruler' 'ru' boolean (default off)
5492 global
5493 {not in Vi}
5494 {not available when compiled without the
5495 |+cmdline_info| feature}
5496 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005497 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005498 text in the file is shown on the far right:
5499 Top first line is visible
5500 Bot last line is visible
5501 All first and last line are visible
5502 45% relative position in the file
5503 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005504 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005506 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507 this option takes precedence over 'ruler' and 'rulerformat'
5508 If the number of characters displayed is different from the number of
5509 bytes in the text (e.g., for a TAB or a multi-byte character), both
5510 the text column (byte number) and the screen column are shown,
5511 separated with a dash.
5512 For an empty line "0-1" is shown.
5513 For an empty buffer the line number will also be zero: "0,0-1".
5514 This option is reset when the 'paste' option is set.
5515 If you don't want to see the ruler all the time but want to know where
5516 you are, use "g CTRL-G" |g_CTRL-G|.
5517 NOTE: This option is reset when 'compatible' is set.
5518
5519 *'rulerformat'* *'ruf'*
5520'rulerformat' 'ruf' string (default empty)
5521 global
5522 {not in Vi}
5523 {not available when compiled without the |+statusline|
5524 feature}
5525 When this option is not empty, it determines the content of the ruler
5526 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005527 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528 The default ruler width is 17 characters. To make the ruler 15
5529 characters wide, put "%15(" at the start and "%)" at the end.
5530 Example: >
5531 :set rulerformat=%15(%c%V\ %p%%%)
5532<
5533 *'runtimepath'* *'rtp'* *vimfiles*
5534'runtimepath' 'rtp' string (default:
5535 Unix: "$HOME/.vim,
5536 $VIM/vimfiles,
5537 $VIMRUNTIME,
5538 $VIM/vimfiles/after,
5539 $HOME/.vim/after"
5540 Amiga: "home:vimfiles,
5541 $VIM/vimfiles,
5542 $VIMRUNTIME,
5543 $VIM/vimfiles/after,
5544 home:vimfiles/after"
5545 PC, OS/2: "$HOME/vimfiles,
5546 $VIM/vimfiles,
5547 $VIMRUNTIME,
5548 $VIM/vimfiles/after,
5549 $HOME/vimfiles/after"
5550 Macintosh: "$VIM:vimfiles,
5551 $VIMRUNTIME,
5552 $VIM:vimfiles:after"
5553 RISC-OS: "Choices:vimfiles,
5554 $VIMRUNTIME,
5555 Choices:vimfiles/after"
5556 VMS: "sys$login:vimfiles,
5557 $VIM/vimfiles,
5558 $VIMRUNTIME,
5559 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005560 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561 global
5562 {not in Vi}
5563 This is a list of directories which will be searched for runtime
5564 files:
5565 filetype.vim filetypes by file name |new-filetype|
5566 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005567 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 colors/ color scheme files |:colorscheme|
5569 compiler/ compiler files |:compiler|
5570 doc/ documentation |write-local-help|
5571 ftplugin/ filetype plugins |write-filetype-plugin|
5572 indent/ indent scripts |indent-expression|
5573 keymap/ key mapping files |mbyte-keymap|
5574 lang/ menu translations |:menutrans|
5575 menu.vim GUI menus |menu.vim|
5576 plugin/ plugin scripts |write-plugin|
5577 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005578 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005579 syntax/ syntax files |mysyntaxfile|
5580 tutor/ files for vimtutor |tutor|
5581
5582 And any other file searched for with the |:runtime| command.
5583
5584 The defaults for most systems are setup to search five locations:
5585 1. In your home directory, for your personal preferences.
5586 2. In a system-wide Vim directory, for preferences from the system
5587 administrator.
5588 3. In $VIMRUNTIME, for files distributed with Vim.
5589 *after-directory*
5590 4. In the "after" directory in the system-wide Vim directory. This is
5591 for the system administrator to overrule or add to the distributed
5592 defaults (rarely needed)
5593 5. In the "after" directory in your home directory. This is for
5594 personal preferences to overrule or add to the distributed defaults
5595 or system-wide settings (rarely needed).
5596
5597 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5598 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005599 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600 wildcards.
5601 See |:runtime|.
5602 Example: >
5603 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5604< This will use the directory "~/vimruntime" first (containing your
5605 personal Vim runtime files), then "/mygroup/vim" (shared between a
5606 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5607 files).
5608 You probably should always include $VIMRUNTIME somewhere, to use the
5609 distributed runtime files. You can put a directory before $VIMRUNTIME
5610 to find files which replace a distributed runtime files. You can put
5611 a directory after $VIMRUNTIME to find files which add to distributed
5612 runtime files.
5613 This option cannot be set from a |modeline| or in the |sandbox|, for
5614 security reasons.
5615
5616 *'scroll'* *'scr'*
5617'scroll' 'scr' number (default: half the window height)
5618 local to window
5619 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5620 set to half the number of lines in the window when the window size
5621 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005622 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5624 the number of screen lines instead of file lines, makes a difference
5625 when lines wrap}
5626
5627 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5628'scrollbind' 'scb' boolean (default off)
5629 local to window
5630 {not in Vi}
5631 {not available when compiled without the |+scrollbind|
5632 feature}
5633 See also |scroll-binding|. When this option is set, the current
5634 window scrolls as other scrollbind windows (windows that also have
5635 this option set) scroll. This option is useful for viewing the
5636 differences between two versions of a file, see 'diff'.
5637 See |'scrollopt'| for options that determine how this option should be
5638 interpreted.
5639 This option is mostly reset when splitting a window to edit another
5640 file. This means that ":split | edit file" results in two windows
5641 with scroll-binding, but ":split file" does not.
5642
5643 *'scrolljump'* *'sj'*
5644'scrolljump' 'sj' number (default 1)
5645 global
5646 {not in Vi}
5647 Minimal number of lines to scroll when the cursor gets off the
5648 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5649 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005650 When set to a negative number from -1 to -100 this is used as the
5651 percentage of the window height. Thus -50 scrolls half the window
5652 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653 NOTE: This option is set to 1 when 'compatible' is set.
5654
5655 *'scrolloff'* *'so'*
5656'scrolloff' 'so' number (default 0)
5657 global
5658 {not in Vi}
5659 Minimal number of screen lines to keep above and below the cursor.
5660 This will make some context visible around where you are working. If
5661 you set it to a very large value (999) the cursor line will always be
5662 in the middle of the window (except at the start or end of the file or
5663 when long lines wrap).
5664 For scrolling horizontally see 'sidescrolloff'.
5665 NOTE: This option is set to 0 when 'compatible' is set.
5666
5667 *'scrollopt'* *'sbo'*
5668'scrollopt' 'sbo' string (default "ver,jump")
5669 global
5670 {not available when compiled without the |+scrollbind|
5671 feature}
5672 {not in Vi}
5673 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005674 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5675 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 The following words are available:
5677 ver Bind vertical scrolling for 'scrollbind' windows
5678 hor Bind horizontal scrolling for 'scrollbind' windows
5679 jump Applies to the offset between two windows for vertical
5680 scrolling. This offset is the difference in the first
5681 displayed line of the bound windows. When moving
5682 around in a window, another 'scrollbind' window may
5683 reach a position before the start or after the end of
5684 the buffer. The offset is not changed though, when
5685 moving back the 'scrollbind' window will try to scroll
5686 to the desired position when possible.
5687 When now making that window the current one, two
5688 things can be done with the relative offset:
5689 1. When "jump" is not included, the relative offset is
5690 adjusted for the scroll position in the new current
5691 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005692 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 2. When "jump" is included, the other windows are
5694 scrolled to keep the same relative offset. When
5695 going back to the other window, it still uses the
5696 same relative offset.
5697 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005698 When 'diff' mode is active there always is vertical scroll binding,
5699 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700
5701 *'sections'* *'sect'*
5702'sections' 'sect' string (default "SHNHH HUnhsh")
5703 global
5704 Specifies the nroff macros that separate sections. These are pairs of
5705 two letters (See |object-motions|). The default makes a section start
5706 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5707
5708 *'secure'* *'nosecure'* *E523*
5709'secure' boolean (default off)
5710 global
5711 {not in Vi}
5712 When on, ":autocmd", shell and write commands are not allowed in
5713 ".vimrc" and ".exrc" in the current directory and map commands are
5714 displayed. Switch it off only if you know that you will not run into
5715 problems, or when the 'exrc' option is off. On Unix this option is
5716 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005717 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005718 'secure' at the end of your ~/.vimrc then.
5719 This option cannot be set from a |modeline| or in the |sandbox|, for
5720 security reasons.
5721
5722 *'selection'* *'sel'*
5723'selection' 'sel' string (default "inclusive")
5724 global
5725 {not in Vi}
5726 This option defines the behavior of the selection. It is only used
5727 in Visual and Select mode.
5728 Possible values:
5729 value past line inclusive ~
5730 old no yes
5731 inclusive yes yes
5732 exclusive yes no
5733 "past line" means that the cursor is allowed to be positioned one
5734 character past the line.
5735 "inclusive" means that the last character of the selection is included
5736 in an operation. For example, when "x" is used to delete the
5737 selection.
5738 Note that when "exclusive" is used and selecting from the end
5739 backwards, you cannot include the last character of a line, when
5740 starting in Normal mode and 'virtualedit' empty.
5741
5742 The 'selection' option is set by the |:behave| command.
5743
5744 *'selectmode'* *'slm'*
5745'selectmode' 'slm' string (default "")
5746 global
5747 {not in Vi}
5748 This is a comma separated list of words, which specifies when to start
5749 Select mode instead of Visual mode, when a selection is started.
5750 Possible values:
5751 mouse when using the mouse
5752 key when using shifted special keys
5753 cmd when using "v", "V" or CTRL-V
5754 See |Select-mode|.
5755 The 'selectmode' option is set by the |:behave| command.
5756
5757 *'sessionoptions'* *'ssop'*
5758'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005759 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005760 global
5761 {not in Vi}
5762 {not available when compiled without the +mksession
5763 feature}
5764 Changes the effect of the |:mksession| command. It is a comma
5765 separated list of words. Each word enables saving and restoring
5766 something:
5767 word save and restore ~
5768 blank empty windows
5769 buffers hidden and unloaded buffers, not just those in windows
5770 curdir the current directory
5771 folds manually created folds, opened/closed folds and local
5772 fold options
5773 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005774 and contain at least one lowercase letter. Only
5775 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005776 help the help window
5777 localoptions options and mappings local to a window or buffer (not
5778 global values for local options)
5779 options all options and mappings (also global values for local
5780 options)
5781 resize size of the Vim window: 'lines' and 'columns'
5782 sesdir the directory in which the session file is located
5783 will become the current directory (useful with
5784 projects accessed over a network from different
5785 systems)
5786 slash backslashes in file names replaced with forward
5787 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005788 tabpages all tab pages; without this only the current tab page
5789 is restored, so that you can make a session for each
5790 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005791 unix with Unix end-of-line format (single <NL>), even when
5792 on Windows or DOS
5793 winpos position of the whole Vim window
5794 winsize window sizes
5795
5796 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005797 When neither "curdir" nor "sesdir" is included, file names are stored
5798 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005799 "slash" and "unix" are useful on Windows when sharing session files
5800 with Unix. The Unix version of Vim cannot source dos format scripts,
5801 but the Windows version of Vim can source unix format scripts.
5802
5803 *'shell'* *'sh'* *E91*
5804'shell' 'sh' string (default $SHELL or "sh",
5805 MS-DOS and Win32: "command.com" or
5806 "cmd.exe", OS/2: "cmd")
5807 global
5808 Name of the shell to use for ! and :! commands. When changing the
5809 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5810 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005811 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005812 See |option-backslash| about including spaces and backslashes.
5813 Environment variables are expanded |:set_env|.
5814 If the name of the shell contains a space, you might need to enclose
5815 it in quotes. Example: >
5816 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5817< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005818 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819 "-f" is not inside the quotes, because it is not part of the command
5820 name. And Vim automagically recognizes the backslashes that are path
5821 separators.
5822 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5823 variable to change the way external commands are executed. See the
5824 libc.inf file of DJGPP.
5825 Under MS-Windows, when the executable ends in ".com" it must be
5826 included. Thus setting the shell to "command.com" or "4dos.com"
5827 works, but "command" and "4dos" do not work for all commands (e.g.,
5828 filtering).
5829 For unknown reasons, when using "4dos.com" the current directory is
5830 changed to "C:\". To avoid this set 'shell' like this: >
5831 :set shell=command.com\ /c\ 4dos
5832< This option cannot be set from a |modeline| or in the |sandbox|, for
5833 security reasons.
5834
5835 *'shellcmdflag'* *'shcf'*
5836'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5837 does not contain "sh" somewhere: "/c")
5838 global
5839 {not in Vi}
5840 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5841 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5842 systems, the default is set according to the value of 'shell', to
5843 reduce the need to set this option by the user. It's not used for
5844 OS/2 (EMX figures this out itself). See |option-backslash| about
5845 including spaces and backslashes. See |dos-shell|.
5846 This option cannot be set from a |modeline| or in the |sandbox|, for
5847 security reasons.
5848
5849 *'shellpipe'* *'sp'*
5850'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5851 global
5852 {not in Vi}
5853 {not available when compiled without the |+quickfix|
5854 feature}
5855 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005856 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005857 including spaces and backslashes.
5858 The name of the temporary file can be represented by "%s" if necessary
5859 (the file name is appended automatically if no %s appears in the value
5860 of this option).
5861 For the Amiga and MS-DOS the default is ">". The output is directly
5862 saved in a file and not echoed to the screen.
5863 For Unix the default it "| tee". The stdout of the compiler is saved
5864 in a file and echoed to the screen. If the 'shell' option is "csh" or
5865 "tcsh" after initializations, the default becomes "|& tee". If the
5866 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005867 "2>&1| tee". This means that stderr is also included. Before using
5868 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869 The initialization of this option is done after reading the ".vimrc"
5870 and the other initializations, so that when the 'shell' option is set
5871 there, the 'shellpipe' option changes automatically, unless it was
5872 explicitly set before.
5873 When 'shellpipe' is set to an empty string, no redirection of the
5874 ":make" output will be done. This is useful if you use a 'makeprg'
5875 that writes to 'makeef' by itself. If you want no piping, but do
5876 want to include the 'makeef', set 'shellpipe' to a single space.
5877 Don't forget to precede the space with a backslash: ":set sp=\ ".
5878 In the future pipes may be used for filtering and this option will
5879 become obsolete (at least for Unix).
5880 This option cannot be set from a |modeline| or in the |sandbox|, for
5881 security reasons.
5882
5883 *'shellquote'* *'shq'*
5884'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5885 contains "sh" somewhere: "\"")
5886 global
5887 {not in Vi}
5888 Quoting character(s), put around the command passed to the shell, for
5889 the "!" and ":!" commands. The redirection is kept outside of the
5890 quoting. See 'shellxquote' to include the redirection. It's
5891 probably not useful to set both options.
5892 This is an empty string by default. Only known to be useful for
5893 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5894 or bash, where it should be "\"". The default is adjusted according
5895 the value of 'shell', to reduce the need to set this option by the
5896 user. See |dos-shell|.
5897 This option cannot be set from a |modeline| or in the |sandbox|, for
5898 security reasons.
5899
5900 *'shellredir'* *'srr'*
5901'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5902 global
5903 {not in Vi}
5904 String to be used to put the output of a filter command in a temporary
5905 file. See also |:!|. See |option-backslash| about including spaces
5906 and backslashes.
5907 The name of the temporary file can be represented by "%s" if necessary
5908 (the file name is appended automatically if no %s appears in the value
5909 of this option).
5910 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5911 or "zsh" during initializations, the default becomes ">&". If the
5912 'shell' option is "sh", "ksh" or "bash" the default becomes
5913 ">%s 2>&1". This means that stderr is also included.
5914 For Win32, the Unix checks are done and additionally "cmd" is checked
5915 for, which makes the default ">%s 2>&1". Also, the same names with
5916 ".exe" appended are checked for.
5917 The initialization of this option is done after reading the ".vimrc"
5918 and the other initializations, so that when the 'shell' option is set
5919 there, the 'shellredir' option changes automatically unless it was
5920 explicitly set before.
5921 In the future pipes may be used for filtering and this option will
5922 become obsolete (at least for Unix).
5923 This option cannot be set from a |modeline| or in the |sandbox|, for
5924 security reasons.
5925
5926 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5927'shellslash' 'ssl' boolean (default off)
5928 global
5929 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5930 When set, a forward slash is used when expanding file names. This is
5931 useful when a Unix-like shell is used instead of command.com or
5932 cmd.exe. Backward slashes can still be typed, but they are changed to
5933 forward slashes by Vim.
5934 Note that setting or resetting this option has no effect for some
5935 existing file names, thus this option needs to be set before opening
5936 any file for best results. This might change in the future.
5937 'shellslash' only works when a backslash can be used as a path
5938 separator. To test if this is so use: >
5939 if exists('+shellslash')
5940<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005941 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5942'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5943 global
5944 {not in Vi}
5945 When on, use temp files for shell commands. When off use a pipe.
5946 When using a pipe is not possible temp files are used anyway.
5947 Currently a pipe is only supported on Unix. You can check it with: >
5948 :if has("filterpipe")
5949< The advantage of using a pipe is that nobody can read the temp file
5950 and the 'shell' command does not need to support redirection.
5951 The advantage of using a temp file is that the file type and encoding
5952 can be detected.
5953 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5954 |FilterWritePost| autocommands event are not triggered when
5955 'shelltemp' is off.
5956
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 *'shelltype'* *'st'*
5958'shelltype' 'st' number (default 0)
5959 global
5960 {not in Vi} {only for the Amiga}
5961 On the Amiga this option influences the way how the commands work
5962 which use a shell.
5963 0 and 1: always use the shell
5964 2 and 3: use the shell only to filter lines
5965 4 and 5: use shell only for ':sh' command
5966 When not using the shell, the command is executed directly.
5967
5968 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5969 1 and 3: use "shell cmd" to start external commands
5970
5971 *'shellxquote'* *'sxq'*
5972'shellxquote' 'sxq' string (default: "";
5973 for Win32, when 'shell' contains "sh"
5974 somewhere: "\""
5975 for Unix, when using system(): "\"")
5976 global
5977 {not in Vi}
5978 Quoting character(s), put around the command passed to the shell, for
5979 the "!" and ":!" commands. Includes the redirection. See
5980 'shellquote' to exclude the redirection. It's probably not useful
5981 to set both options.
5982 This is an empty string by default. Known to be useful for
5983 third-party shells when using the Win32 version, such as the MKS Korn
5984 Shell or bash, where it should be "\"". The default is adjusted
5985 according the value of 'shell', to reduce the need to set this option
5986 by the user. See |dos-shell|.
5987 This option cannot be set from a |modeline| or in the |sandbox|, for
5988 security reasons.
5989
5990 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5991'shiftround' 'sr' boolean (default off)
5992 global
5993 {not in Vi}
5994 Round indent to multiple of 'shiftwidth'. Applies to > and <
5995 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5996 a multiple of 'shiftwidth' (this is Vi compatible).
5997 NOTE: This option is reset when 'compatible' is set.
5998
5999 *'shiftwidth'* *'sw'*
6000'shiftwidth' 'sw' number (default 8)
6001 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006002 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006003 |'cindent'|, |>>|, |<<|, etc.
6004
6005 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006006'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6007 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 global
6009 {not in Vi}
6010 This option helps to avoid all the |hit-enter| prompts caused by file
6011 messages, for example with CTRL-G, and to avoid some other messages.
6012 It is a list of flags:
6013 flag meaning when present ~
6014 f use "(3 of 5)" instead of "(file 3 of 5)"
6015 i use "[noeol]" instead of "[Incomplete last line]"
6016 l use "999L, 888C" instead of "999 lines, 888 characters"
6017 m use "[+]" instead of "[Modified]"
6018 n use "[New]" instead of "[New File]"
6019 r use "[RO]" instead of "[readonly]"
6020 w use "[w]" instead of "written" for file write message
6021 and "[a]" instead of "appended" for ':w >> file' command
6022 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6023 "[unix format]" and "[mac]" instead of "[mac format]".
6024 a all of the above abbreviations
6025
6026 o overwrite message for writing a file with subsequent message
6027 for reading a file (useful for ":wn" or when 'autowrite' on)
6028 O message for reading a file overwrites any previous message.
6029 Also for quickfix message (e.g., ":cn").
6030 s don't give "search hit BOTTOM, continuing at TOP" or "search
6031 hit TOP, continuing at BOTTOM" messages
6032 t truncate file message at the start if it is too long to fit
6033 on the command-line, "<" will appear in the left most column.
6034 Ignored in Ex mode.
6035 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006036 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037 Ignored in Ex mode.
6038 W don't give "written" or "[w]" when writing a file
6039 A don't give the "ATTENTION" message when an existing swap file
6040 is found.
6041 I don't give the intro message when starting Vim |:intro|.
6042
6043 This gives you the opportunity to avoid that a change between buffers
6044 requires you to hit <Enter>, but still gives as useful a message as
6045 possible for the space available. To get the whole message that you
6046 would have got with 'shm' empty, use ":file!"
6047 Useful values:
6048 shm= No abbreviation of message.
6049 shm=a Abbreviation, but no loss of information.
6050 shm=at Abbreviation, and truncate message when necessary.
6051
6052 NOTE: This option is set to the Vi default value when 'compatible' is
6053 set and to the Vim default value when 'compatible' is reset.
6054
6055 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6056'shortname' 'sn' boolean (default off)
6057 local to buffer
6058 {not in Vi, not in MS-DOS versions}
6059 Filenames are assumed to be 8 characters plus one extension of 3
6060 characters. Multiple dots in file names are not allowed. When this
6061 option is on, dots in file names are replaced with underscores when
6062 adding an extension (".~" or ".swp"). This option is not available
6063 for MS-DOS, because then it would always be on. This option is useful
6064 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6065 or crossdos. When running the Win32 GUI version under Win32s, this
6066 option is always on by default.
6067
6068 *'showbreak'* *'sbr'* *E595*
6069'showbreak' 'sbr' string (default "")
6070 global
6071 {not in Vi}
6072 {not available when compiled without the |+linebreak|
6073 feature}
6074 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006075 values are "> " or "+++ ": >
6076 :set showbreak=>\
6077< Note the backslash to escape the trailing space. It's easier like
6078 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006079 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006080< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 comma (in a future version the comma might be used to separate the
6082 part that is shown at the end and at the start of a line).
6083 The characters are highlighted according to the '@' flag in
6084 'highlight'.
6085 Note that tabs after the showbreak will be displayed differently.
6086 If you want the 'showbreak' to appear in between line numbers, add the
6087 "n" flag to 'cpoptions'.
6088
6089 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6090'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6091 off)
6092 global
6093 {not in Vi}
6094 {not available when compiled without the
6095 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006096 Show (partial) command in the last line of the screen. Set this
6097 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 In Visual mode the size of the selected area is shown:
6099 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006100 If the number of bytes is different it is also displayed: "2-6"
6101 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006103 - When selecting a block, the size in screen characters:
6104 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105 NOTE: This option is set to the Vi default value when 'compatible' is
6106 set and to the Vim default value when 'compatible' is reset.
6107
6108 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6109'showfulltag' 'sft' boolean (default off)
6110 global
6111 {not in Vi}
6112 When completing a word in insert mode (see |ins-completion|) from the
6113 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006114 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006115 matched a C function, you can see a template for what arguments are
6116 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006117 Note that this doesn't work well together with having "longest" in
6118 'completeopt', because the completion from the search pattern may not
6119 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006120
6121 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6122'showmatch' 'sm' boolean (default off)
6123 global
6124 When a bracket is inserted, briefly jump to the matching one. The
6125 jump is only done if the match can be seen on the screen. The time to
6126 show the match can be set with 'matchtime'.
6127 A Beep is given if there is no match (no matter if the match can be
6128 seen or not). This option is reset when the 'paste' option is set.
6129 When the 'm' flag is not included in 'cpoptions', typing a character
6130 will immediately move the cursor back to where it belongs.
6131 See the "sm" field in 'guicursor' for setting the cursor shape and
6132 blinking when showing the match.
6133 The 'matchpairs' option can be used to specify the characters to show
6134 matches for. 'rightleft' and 'revins' are used to look for opposite
6135 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006136 Also see the matchparen plugin for highlighting the match when moving
6137 around |pi_paren.txt|.
6138 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139
6140 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6141'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6142 global
6143 If in Insert, Replace or Visual mode put a message on the last line.
6144 Use the 'M' flag in 'highlight' to set the type of highlighting for
6145 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006146 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 doesn't mean XIM is really active, especially when 'imactivatekey' is
6148 not set.
6149 NOTE: This option is set to the Vi default value when 'compatible' is
6150 set and to the Vim default value when 'compatible' is reset.
6151
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006152 *'showtabline'* *'stal'*
6153'showtabline' 'stal' number (default 1)
6154 global
6155 {not in Vi}
6156 {not available when compiled without the +windows
6157 feature}
6158 The value of this option specifies when the line with tab page labels
6159 will be displayed:
6160 0: never
6161 1: only if there are at least two tab pages
6162 2: always
6163 This is both for the GUI and non-GUI implementation of the tab pages
6164 line.
6165 See |tab-page| for more information about tab pages.
6166
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 *'sidescroll'* *'ss'*
6168'sidescroll' 'ss' number (default 0)
6169 global
6170 {not in Vi}
6171 The minimal number of columns to scroll horizontally. Used only when
6172 the 'wrap' option is off and the cursor is moved off of the screen.
6173 When it is zero the cursor will be put in the middle of the screen.
6174 When using a slow terminal set it to a large number or 0. When using
6175 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6176 commands.
6177
6178 *'sidescrolloff'* *'siso'*
6179'sidescrolloff' 'siso' number (default 0)
6180 global
6181 {not in Vi}
6182 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006183 right of the cursor if 'nowrap' is set. Setting this option to a
6184 value greater than 0 while having |'sidescroll'| also at a non-zero
6185 value makes some context visible in the line you are scrolling in
6186 horizontally (except at beginning of the line). Setting this option
6187 to a large value (like 999) has the effect of keeping the cursor
6188 horizontally centered in the window, as long as one does not come too
6189 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 NOTE: This option is set to 0 when 'compatible' is set.
6191
6192 Example: Try this together with 'sidescroll' and 'listchars' as
6193 in the following example to never allow the cursor to move
6194 onto the "extends" character:
6195
6196 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6197 :set sidescrolloff=1
6198
6199
6200 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6201'smartcase' 'scs' boolean (default off)
6202 global
6203 {not in Vi}
6204 Override the 'ignorecase' option if the search pattern contains upper
6205 case characters. Only used when the search pattern is typed and
6206 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006207 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6209 recalling the search pattern from history and hitting <Enter>.
6210 NOTE: This option is reset when 'compatible' is set.
6211
6212 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6213'smartindent' 'si' boolean (default off)
6214 local to buffer
6215 {not in Vi}
6216 {not available when compiled without the
6217 |+smartindent| feature}
6218 Do smart autoindenting when starting a new line. Works for C-like
6219 programs, but can also be used for other languages. 'cindent' does
6220 something like this, works better in most cases, but is more strict,
6221 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6222 'indentexpr' is a more advanced alternative.
6223 Normally 'autoindent' should also be on when using 'smartindent'.
6224 An indent is automatically inserted:
6225 - After a line ending in '{'.
6226 - After a line starting with a keyword from 'cinwords'.
6227 - Before a line starting with '}' (only with the "O" command).
6228 When typing '}' as the first character in a new line, that line is
6229 given the same indent as the matching '{'.
6230 When typing '#' as the first character in a new line, the indent for
6231 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006232 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6234 When using the ">>" command, lines starting with '#' are not shifted
6235 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006236 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237 is set smart indenting is disabled.
6238
6239 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6240'smarttab' 'sta' boolean (default off)
6241 global
6242 {not in Vi}
6243 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006244 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6245 <BS> will delete a 'shiftwidth' worth of space at the start of the
6246 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006247 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006248 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6249 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006250 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006252 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 NOTE: This option is reset when 'compatible' is set.
6254
6255 *'softtabstop'* *'sts'*
6256'softtabstop' 'sts' number (default 0)
6257 local to buffer
6258 {not in Vi}
6259 Number of spaces that a <Tab> counts for while performing editing
6260 operations, like inserting a <Tab> or using <BS>. It "feels" like
6261 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6262 used. This is useful to keep the 'ts' setting at its standard value
6263 of 8, while being able to edit like it is set to 'sts'. However,
6264 commands like "x" still work on the actual characters.
6265 When 'sts' is zero, this feature is off.
6266 'softtabstop' is set to 0 when the 'paste' option is set.
6267 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6268 spaces is minimized by using <Tab>s.
6269 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6270 set.
6271 NOTE: This option is set to 0 when 'compatible' is set.
6272
Bram Moolenaar217ad922005-03-20 22:37:15 +00006273 *'spell'* *'nospell'*
6274'spell' boolean (default off)
6275 local to window
6276 {not in Vi}
6277 {not available when compiled without the |+syntax|
6278 feature}
6279 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006280 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006281
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006282 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006283'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006284 local to buffer
6285 {not in Vi}
6286 {not available when compiled without the |+syntax|
6287 feature}
6288 Pattern to locate the end of a sentence. The following word will be
6289 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006290 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006291 When this check is not wanted make this option empty.
6292 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006293 Be careful with special characters, see |option-backslash| about
6294 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006295 To set this option automatically depending on the language, see
6296 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006297
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006298 *'spellfile'* *'spf'*
6299'spellfile' 'spf' string (default empty)
6300 local to buffer
6301 {not in Vi}
6302 {not available when compiled without the |+syntax|
6303 feature}
6304 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006305 commands. It must end in ".{encoding}.add". You need to include the
6306 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006307 *E765*
6308 It may also be a comma separated list of names. A count before the
6309 |zg| and |zw| commands can be used to access each. This allows using
6310 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006311 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006312 you: Using the first directory in 'runtimepath' that is writable. If
6313 there is no "spell" directory yet it will be created. For the file
6314 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006315 ignoring the region.
6316 The resulting ".spl" file will be used for spell checking, it does not
6317 have to appear in 'spelllang'.
6318 Normally one file is used for all regions, but you can add the region
6319 name if you want to. However, it will then only be used when
6320 'spellfile' is set to it, for entries in 'spelllang' only files
6321 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006322 This option cannot be set from a |modeline| or in the |sandbox|, for
6323 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006324
Bram Moolenaar217ad922005-03-20 22:37:15 +00006325 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006326'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006327 local to buffer
6328 {not in Vi}
6329 {not available when compiled without the |+syntax|
6330 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006331 A comma separated list of word list names. When the 'spell' option is
6332 on spellchecking will be done for these languages. Example: >
6333 set spelllang=en_us,nl,medical
6334< This means US English, Dutch and medical words are recognized. Words
6335 that are not recognized will be highlighted.
6336 The word list name must not include a comma or dot. Using a dash is
6337 recommended to separate the two letter language name from a
6338 specification. Thus "en-rare" is used for rare English words.
6339 A region name must come last and have the form "_xx", where "xx" is
6340 the two-letter, lower case region name. You can use more than one
6341 region by listing them: "en_us,en_ca" supports both US and Canadian
6342 English, but not words specific for Australia, New Zealand or Great
6343 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006344 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006345 As a special case the name of a .spl file can be given as-is. The
6346 first "_xx" in the name is removed and used as the region name
6347 (_xx is an underscore, two letters and followed by a non-letter).
6348 This is mainly for testing purposes. You must make sure the correct
6349 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006350 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006351 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6352 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006353 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006354
Bram Moolenaar98692072006-02-04 00:57:42 +00006355 If the |spellfile.vim| plugin is active and you use a language name
6356 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6357 will ask you if you want to download the file.
6358
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006359 After this option has been set successfully, Vim will source the files
6360 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006361 up to the first comma, dot or underscore.
6362 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006363
6364
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006365 *'spellsuggest'* *'sps'*
6366'spellsuggest' 'sps' string (default "best")
6367 global
6368 {not in Vi}
6369 {not available when compiled without the |+syntax|
6370 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006371 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006372 the |spellsuggest()| function. This is a comma-separated list of
6373 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006374
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006375 best Internal method that works best for English. Finds
6376 changes like "fast" and uses a bit of sound-a-like
6377 scoring to improve the ordering.
6378
6379 double Internal method that uses two methods and mixes the
6380 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006381 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006382 word. That only works when the language specifies
6383 sound folding. Can be slow and doesn't always give
6384 better results.
6385
6386 fast Internal method that only checks for simple changes:
6387 character inserts/deletes/swaps. Works well for
6388 simple typing mistakes.
6389
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006390 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006391 Not used for |spellsuggest()|. The number of
6392 suggestions is never more than the value of 'lines'
6393 minus two.
6394
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006395 file:{filename} Read file {filename}, which must have two columns,
6396 separated by a slash. The first column contains the
6397 bad word, the second column the suggested good word.
6398 Example:
6399 theribal/terrible ~
6400 Use this for common mistakes that do not appear at the
6401 top of the suggestion list with the internal methods.
6402 Lines without a slash are ignored, use this for
6403 comments.
6404 The file is used for all languages.
6405
6406 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6407 trouble with spaces. |v:val| holds the badly spelled
6408 word. The expression must evaluate to a List of
6409 Lists, each with a suggestion and a score.
6410 Example:
6411 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006412 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006413 internal methods use. A lower score is better.
6414 This may invoke |spellsuggest()| if you temporarily
6415 set 'spellsuggest' to exclude the "expr:" part.
6416 Errors are silently ignored, unless you set the
6417 'verbose' option to a non-zero value.
6418
6419 Only one of "best", "double" or "fast" may be used. The others may
6420 appear several times in any order. Example: >
6421 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6422<
6423 This option cannot be set from a |modeline| or in the |sandbox|, for
6424 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006425
6426
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6428'splitbelow' 'sb' boolean (default off)
6429 global
6430 {not in Vi}
6431 {not available when compiled without the +windows
6432 feature}
6433 When on, splitting a window will put the new window below the current
6434 one. |:split|
6435
6436 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6437'splitright' 'spr' boolean (default off)
6438 global
6439 {not in Vi}
6440 {not available when compiled without the +vertsplit
6441 feature}
6442 When on, splitting a window will put the new window right of the
6443 current one. |:vsplit|
6444
6445 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6446'startofline' 'sol' boolean (default on)
6447 global
6448 {not in Vi}
6449 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006450 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006451 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006452 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006453 with a linewise operator, with "%" with a count and to buffer changing
6454 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6455 only has a line number, e.g., ":25" or ":+".
6456 In case of buffer changing commands the cursor is placed at the column
6457 where it was the last time the buffer was edited.
6458 NOTE: This option is set when 'compatible' is set.
6459
6460 *'statusline'* *'stl'* *E540* *E541* *E542*
6461'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006462 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 {not in Vi}
6464 {not available when compiled without the |+statusline|
6465 feature}
6466 When nonempty, this option determines the content of the status line.
6467 Also see |status-line|.
6468
6469 The option consists of printf style '%' items interspersed with
6470 normal text. Each status line item is of the form:
6471 %-0{minwid}.{maxwid}{item}
6472 All fields except the {item} is optional. A single percent sign can
6473 be given as "%%". Up to 80 items can be specified.
6474
Bram Moolenaar238a5642006-02-21 22:12:05 +00006475 When the option starts with "%!" then it is used as an expression,
6476 evaluated and the result is used as the option value. Example: >
6477 :set statusline=%!MyStatusLine()
6478< The result can contain %{} items that will be evaluated too.
6479
6480 When there is error while evaluating the option then it will be made
6481 empty to avoid further errors. Otherwise screen updating would loop.
6482
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483 Note that the only effect of 'ruler' when this option is set (and
6484 'laststatus' is 2) is controlling the output of |CTRL-G|.
6485
6486 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006487 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006489 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 minwid Minimum width of the item, padding as set by '-' & '0'.
6491 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006492 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493 on the left for text items. Numeric items will be
6494 shifted down to maxwid-2 digits followed by '>'number
6495 where number is the amount of missing digits, much like
6496 an exponential notation.
6497 item A one letter code as described below.
6498
6499 Following is a description of the possible statusline items. The
6500 second character in "item" is the type:
6501 N for number
6502 S for string
6503 F for flags as described below
6504 - not applicable
6505
6506 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006507 f S Path to the file in the buffer, as typed or relative to current
6508 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006509 F S Full path to the file in the buffer.
6510 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006511 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006513 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006515 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006517 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006519 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6521 {not available when compiled without |+autocmd| feature}
6522 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6523 being used: "<keymap>"
6524 n N Buffer number.
6525 b N Value of byte under cursor.
6526 B N As above, in hexadecimal.
6527 o N Byte number in file of byte under cursor, first byte is 1.
6528 Mnemonic: Offset from start of file (with one added)
6529 {not available when compiled without |+byte_offset| feature}
6530 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006531 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 l N Line number.
6533 L N Number of lines in buffer.
6534 c N Column number.
6535 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006536 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 p N Percentage through file in lines as in |CTRL-G|.
6538 P S Percentage through file of displayed window. This is like the
6539 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006540 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006542 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006543 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 ( - Start of item group. Can be used for setting the width and
6545 alignment of a section. Must be followed by %) somewhere.
6546 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006547 T N For 'tabline': start of tab page N label. Use %T after the last
6548 label. This information is used for mouse clicks.
6549 X N For 'tabline': start of close tab N label. Use %X after the
6550 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6551 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006552 < - Where to truncate line if too long. Default is at the start.
6553 No width fields allowed.
6554 = - Separation point between left and right aligned items.
6555 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006556 # - Set highlight group. The name must follow and then a # again.
6557 Thus use %#HLname# for highlight group HLname. The same
6558 highlighting is used, also for the statusline of non-current
6559 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006560 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006561 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562 The difference between User{N} and StatusLine will be applied
6563 to StatusLineNC for the statusline of non-current windows.
6564 The number N must be between 1 and 9. See |hl-User1..9|
6565
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006566 When displaying a flag, Vim removes the leading comma, if any, when
6567 that flag comes right after plaintext. This will make a nice display
6568 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569
Bram Moolenaar582fd852005-03-28 20:58:01 +00006570 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 not set) and a minwid is not set for the group, the whole group will
6572 become empty. This will make a group like the following disappear
6573 completely from the statusline when none of the flags are set. >
6574 :set statusline=...%(\ [%M%R%H]%)...
6575<
6576 Beware that an expression is evaluated each and every time the status
6577 line is displayed. The current buffer and current window will be set
6578 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006579 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006581 real current buffer.
6582
6583 The 'statusline' option may be evaluated in the |sandbox|, see
6584 |sandbox-option|.
6585
6586 It is not allowed to change text or jump to another window while
6587 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588
6589 If the statusline is not updated when you want it (e.g., after setting
6590 a variable that's used in an expression), you can force an update by
6591 setting an option without changing its value. Example: >
6592 :let &ro = &ro
6593
6594< A result of all digits is regarded a number for display purposes.
6595 Otherwise the result is taken as flag text and applied to the rules
6596 described above.
6597
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006598 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6600 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6601
6602 Examples:
6603 Emulate standard status line with 'ruler' set >
6604 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6605< Similar, but add ASCII value of char under the cursor (like "ga") >
6606 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6607< Display byte count and byte value, modified flag in red. >
6608 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6609 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6610< Display a ,GZ flag if a compressed file is loaded >
6611 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6612< In the |:autocmd|'s: >
6613 :let b:gzflag = 1
6614< And: >
6615 :unlet b:gzflag
6616< And define this function: >
6617 :function VarExists(var, val)
6618 : if exists(a:var) | return a:val | else | return '' | endif
6619 :endfunction
6620<
6621 *'suffixes'* *'su'*
6622'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6623 global
6624 {not in Vi}
6625 Files with these suffixes get a lower priority when multiple files
6626 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006627 suffixes. Spaces after the comma are ignored. A dot is also seen as
6628 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 separator, precede it with a backslash (see |option-backslash| about
6630 including spaces and backslashes).
6631 See 'wildignore' for completely ignoring files.
6632 The use of |:set+=| and |:set-=| is preferred when adding or removing
6633 suffixes from the list. This avoids problems when a future version
6634 uses another default.
6635
6636 *'suffixesadd'* *'sua'*
6637'suffixesadd' 'sua' string (default "")
6638 local to buffer
6639 {not in Vi}
6640 {not available when compiled without the
6641 |+file_in_path| feature}
6642 Comma separated list of suffixes, which are used when searching for a
6643 file for the "gf", "[I", etc. commands. Example: >
6644 :set suffixesadd=.java
6645<
6646 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6647'swapfile' 'swf' boolean (default on)
6648 local to buffer
6649 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006650 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 swapfile is not wanted for a specific buffer. For example, with
6652 confidential information that even root must not be able to access.
6653 Careful: All text will be in memory:
6654 - Don't use this for big files.
6655 - Recovery will be impossible!
6656 A swapfile will only be present when |'updatecount'| is non-zero and
6657 'swapfile' is set.
6658 When 'swapfile' is reset, the swap file for the current buffer is
6659 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6660 non-zero, a swap file is immediately created.
6661 Also see |swap-file| and |'swapsync'|.
6662
6663 This option is used together with 'bufhidden' and 'buftype' to
6664 specify special kinds of buffers. See |special-buffers|.
6665
6666 *'swapsync'* *'sws'*
6667'swapsync' 'sws' string (default "fsync")
6668 global
6669 {not in Vi}
6670 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006671 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 When this option is empty parts of the swap file may be in memory and
6673 not written to disk. When the system crashes you may lose more work.
6674 On Unix the system does a sync now and then without Vim asking for it,
6675 so the disadvantage of setting this option off is small. On some
6676 systems the swap file will not be written at all. For a unix system
6677 setting it to "sync" will use the sync() call instead of the default
6678 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006679 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680
6681 *'switchbuf'* *'swb'*
6682'switchbuf' 'swb' string (default "")
6683 global
6684 {not in Vi}
6685 This option controls the behavior when switching between buffers.
6686 Possible values (comma separated list):
6687 useopen If included, jump to the first open window that
6688 contains the specified buffer (if there is one).
6689 Otherwise: Do not examine other windows.
6690 This setting is checked with |quickfix| commands, when
6691 jumping to errors (":cc", ":cn", "cp", etc.). It is
6692 also used in all buffer related split commands, for
6693 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006694 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006695 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006697 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006698 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006699 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006700 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006702 *'synmaxcol'* *'smc'*
6703'synmaxcol' 'smc' number (default 3000)
6704 local to buffer
6705 {not in Vi}
6706 {not available when compiled without the |+syntax|
6707 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006708 Maximum column in which to search for syntax items. In long lines the
6709 text after this column is not highlighted and following lines may not
6710 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006711 This helps to avoid very slow redrawing for an XML file that is one
6712 long line.
6713 Set to zero to remove the limit.
6714
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 *'syntax'* *'syn'*
6716'syntax' 'syn' string (default empty)
6717 local to buffer
6718 {not in Vi}
6719 {not available when compiled without the |+syntax|
6720 feature}
6721 When this option is set, the syntax with this name is loaded, unless
6722 syntax highlighting has been switched off with ":syntax off".
6723 Otherwise this option does not always reflect the current syntax (the
6724 b:current_syntax variable does).
6725 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006726 not automatically recognized. Example, in an IDL file:
6727 /* vim: set syntax=idl : */ ~
6728 When a dot appears in the value then this separates two filetype
6729 names. Example:
6730 /* vim: set syntax=c.doxygen : */ ~
6731 This will use the "c" syntax first, then the "doxygen" syntax.
6732 Note that the second one must be prepared to be loaded as an addition,
6733 otherwise it will be skipped. More than one dot may appear.
6734 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 :set syntax=OFF
6736< To switch syntax highlighting on according to the current value of the
6737 'filetype' option: >
6738 :set syntax=ON
6739< What actually happens when setting the 'syntax' option is that the
6740 Syntax autocommand event is triggered with the value as argument.
6741 This option is not copied to another buffer, independent of the 's' or
6742 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006743 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006744
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006745 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006746'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006747 global
6748 {not in Vi}
6749 {not available when compiled without the +windows
6750 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006751 When nonempty, this option determines the content of the tab pages
6752 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006753 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006754
6755 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006756 option and only when there is no GUI tab line. When 'e' is in
6757 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6758 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006759
6760 The value is evaluated like with 'statusline'. You can use
6761 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006762 the text to be displayed. Use "%1T" for the first label, "%2T" for
6763 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006764
6765 Keep in mind that only one of the tab pages is the current one, others
6766 are invisible and you can't jump to their windows.
6767
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006768
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006769 *'tabpagemax'* *'tpm'*
6770'tabpagemax' 'tpm' number (default 10)
6771 global
6772 {not in Vi}
6773 {not available when compiled without the +windows
6774 feature}
6775 Maximum number of tab pages to be opened by the |-p| command line
6776 argument or the ":tab all" command. |tabpage|
6777
6778
6779 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006780'tabstop' 'ts' number (default 8)
6781 local to buffer
6782 Number of spaces that a <Tab> in the file counts for. Also see
6783 |:retab| command, and 'softtabstop' option.
6784
6785 Note: Setting 'tabstop' to any other value than 8 can make your file
6786 appear wrong in many places (e.g., when printing it).
6787
6788 There are four main ways to use tabs in Vim:
6789 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6790 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006791 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792 behave like a tab appears every 4 (or 3) characters.
6793 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6794 'expandtab'. This way you will always insert spaces. The
6795 formatting will never be messed up when 'tabstop' is changed.
6796 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006797 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798 works when using Vim to edit the file.
6799 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6800 'noexpandtab'. This should then work (for initial indents only)
6801 for any tabstop setting that people use. It might be nice to have
6802 tabs after the first non-blank inserted as spaces if you do this
6803 though. Otherwise aligned comments will be wrong when 'tabstop' is
6804 changed.
6805
6806 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6807'tagbsearch' 'tbs' boolean (default on)
6808 global
6809 {not in Vi}
6810 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006811 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812 searching makes searching for a tag a LOT faster, but a linear search
6813 will find more tags if the tags file wasn't properly sorted.
6814 Vim normally assumes that your tags files are sorted, or indicate that
6815 they are not sorted. Only when this is not the case does the
6816 'tagbsearch' option need to be switched off.
6817
6818 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006819 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820 certain files, or retry all files with a linear search. When
6821 'tagbsearch' is off, only a linear search is done.
6822
6823 Linear searching is done anyway, for one file, when Vim finds a line
6824 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006825 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826< [The whitespace before and after the '0' must be a single <Tab>]
6827
6828 When a binary search was done and no match was found in any of the
6829 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6830 instead of a normal tag name, a retry is done with a linear search.
6831 Tags in unsorted tags files, and matches with different case will only
6832 be found in the retry.
6833
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006834 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835 linear search can be avoided for the 'ignorecase' case. Use a value
6836 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6837 case-fold sorted with the -f switch to "sort" in most unices, as in
6838 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006839 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6840 for this as well. Note that case must be folded to uppercase for this
6841 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842
6843 When 'tagbsearch' is off, tags searching is slower when a full match
6844 exists, but faster when no full match exists. Tags in unsorted tags
6845 files may only be found with 'tagbsearch' off.
6846 When the tags file is not sorted, or sorted in a wrong way (not on
6847 ASCII byte value), 'tagbsearch' should be off, or the line given above
6848 must be included in the tags file.
6849 This option doesn't affect commands that find all matching tags (e.g.,
6850 command-line completion and ":help").
6851 {Vi: always uses binary search in some versions}
6852
6853 *'taglength'* *'tl'*
6854'taglength' 'tl' number (default 0)
6855 global
6856 If non-zero, tags are significant up to this number of characters.
6857
6858 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6859'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6860 global
6861 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006862 If on and using a tags file in another directory, file names in that
6863 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864 NOTE: This option is set to the Vi default value when 'compatible' is
6865 set and to the Vim default value when 'compatible' is reset.
6866
6867 *'tags'* *'tag'* *E433*
6868'tags' 'tag' string (default "./tags,tags", when compiled with
6869 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6870 global or local to buffer |global-local|
6871 Filenames for the tag command, separated by spaces or commas. To
6872 include a space or comma in a file name, precede it with a backslash
6873 (see |option-backslash| about including spaces and backslashes).
6874 When a file name starts with "./", the '.' is replaced with the path
6875 of the current file. But only when the 'd' flag is not included in
6876 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6877 |tags-option|.
6878 "*", "**" and other wildcards can be used to search for tags files in
6879 a directory tree. See |file-searching|. {not available when compiled
6880 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006881 The |tagfiles()| function can be used to get a list of the file names
6882 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6884 files are also supported. They are automatically recognized. The
6885 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6886 differences are ignored (MS-Windows). |emacs-tags|
6887 The use of |:set+=| and |:set-=| is preferred when adding or removing
6888 file names from the list. This avoids problems when a future version
6889 uses another default.
6890 {Vi: default is "tags /usr/lib/tags"}
6891
6892 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6893'tagstack' 'tgst' boolean (default on)
6894 global
6895 {not in all versions of Vi}
6896 When on, the |tagstack| is used normally. When off, a ":tag" or
6897 ":tselect" command with an argument will not push the tag onto the
6898 tagstack. A following ":tag" without an argument, a ":pop" command or
6899 any other command that uses the tagstack will use the unmodified
6900 tagstack, but does change the pointer to the active entry.
6901 Resetting this option is useful when using a ":tag" command in a
6902 mapping which should not change the tagstack.
6903
6904 *'term'* *E529* *E530* *E531*
6905'term' string (default is $TERM, if that fails:
6906 in the GUI: "builtin_gui"
6907 on Amiga: "amiga"
6908 on BeOS: "beos-ansi"
6909 on Mac: "mac-ansi"
6910 on MiNT: "vt52"
6911 on MS-DOS: "pcterm"
6912 on OS/2: "os2ansi"
6913 on Unix: "ansi"
6914 on VMS: "ansi"
6915 on Win 32: "win32")
6916 global
6917 Name of the terminal. Used for choosing the terminal control
6918 characters. Environment variables are expanded |:set_env|.
6919 For example: >
6920 :set term=$TERM
6921< See |termcap|.
6922
6923 *'termbidi'* *'tbidi'*
6924 *'notermbidi'* *'notbidi'*
6925'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6926 global
6927 {not in Vi}
6928 {only available when compiled with the |+arabic|
6929 feature}
6930 The terminal is in charge of Bi-directionality of text (as specified
6931 by Unicode). The terminal is also expected to do the required shaping
6932 that some languages (such as Arabic) require.
6933 Setting this option implies that 'rightleft' will not be set when
6934 'arabic' is set and the value of 'arabicshape' will be ignored.
6935 Note that setting 'termbidi' has the immediate effect that
6936 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6937 This option is reset when the GUI is started.
6938 For further details see |arabic.txt|.
6939
6940 *'termencoding'* *'tenc'*
6941'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6942 Macintosh GUI: "macroman")
6943 global
6944 {only available when compiled with the |+multi_byte|
6945 feature}
6946 {not in Vi}
6947 Encoding used for the terminal. This specifies what character
6948 encoding the keyboard produces and the display will understand. For
6949 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006950 display). Except for the Mac when 'macatsui' is off, then
6951 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 In the Win32 console version the default value is the console codepage
6953 when it differs from the ANSI codepage.
6954 *E617*
6955 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6956 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6957 Any attempts to set a different value will be rejected, and an error
6958 message is shown.
6959 For the Win32 GUI 'termencoding' is not used for typed characters,
6960 because the Win32 system always passes Unicode characters.
6961 When empty, the same encoding is used as for the 'encoding' option.
6962 This is the normal value.
6963 Not all combinations for 'termencoding' and 'encoding' are valid. See
6964 |encoding-table|.
6965 The value for this option must be supported by internal conversions or
6966 iconv(). When this is not possible no conversion will be done and you
6967 will probably experience problems with non-ASCII characters.
6968 Example: You are working with the locale set to euc-jp (Japanese) and
6969 want to edit a UTF-8 file: >
6970 :let &termencoding = &encoding
6971 :set encoding=utf-8
6972< You need to do this when your system has no locale support for UTF-8.
6973
6974 *'terse'* *'noterse'*
6975'terse' boolean (default off)
6976 global
6977 When set: Add 's' flag to 'shortmess' option (this makes the message
6978 for a search that hits the start or end of the file not being
6979 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6980 shortens a lot of messages}
6981
6982 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6983'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6984 global
6985 {not in Vi}
6986 This option is obsolete. Use 'fileformats'.
6987 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6988 set to the default value for the current system. When 'textauto' is
6989 reset, 'fileformats' is made empty.
6990 NOTE: This option is set to the Vi default value when 'compatible' is
6991 set and to the Vim default value when 'compatible' is reset.
6992
6993 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6994'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6995 others: default off)
6996 local to buffer
6997 {not in Vi}
6998 This option is obsolete. Use 'fileformat'.
6999 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7000 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7001 "unix".
7002
7003 *'textwidth'* *'tw'*
7004'textwidth' 'tw' number (default 0)
7005 local to buffer
7006 {not in Vi}
7007 Maximum width of text that is being inserted. A longer line will be
7008 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007009 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7010 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007012 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 NOTE: This option is set to 0 when 'compatible' is set.
7014
7015 *'thesaurus'* *'tsr'*
7016'thesaurus' 'tsr' string (default "")
7017 global or local to buffer |global-local|
7018 {not in Vi}
7019 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007020 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 the file should contain words with similar meaning, separated by
7022 non-keyword characters (white space is preferred). Maximum line
7023 length is 510 bytes.
7024 To obtain a file to be used here, check out the wordlist FAQ at
7025 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007026 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027 after a comma are ignored, otherwise spaces are included in the file
7028 name. See |option-backslash| about using backslashes.
7029 The use of |:set+=| and |:set-=| is preferred when adding or removing
7030 directories from the list. This avoids problems when a future version
7031 uses another default.
7032 Backticks cannot be used in this option for security reasons.
7033
7034 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7035'tildeop' 'top' boolean (default off)
7036 global
7037 {not in Vi}
7038 When on: The tilde command "~" behaves like an operator.
7039 NOTE: This option is reset when 'compatible' is set.
7040
7041 *'timeout'* *'to'* *'notimeout'* *'noto'*
7042'timeout' 'to' boolean (default on)
7043 global
7044 *'ttimeout'* *'nottimeout'*
7045'ttimeout' boolean (default off)
7046 global
7047 {not in Vi}
7048 These two options together determine the behavior when part of a
7049 mapped key sequence or keyboard code has been received:
7050
7051 'timeout' 'ttimeout' action ~
7052 off off do not time out
7053 on on or off time out on :mappings and key codes
7054 off on time out on key codes
7055
7056 If both options are off, Vim will wait until either the complete
7057 mapping or key sequence has been received, or it is clear that there
7058 is no mapping or key sequence for the received characters. For
7059 example: if you have mapped "vl" and Vim has received 'v', the next
7060 character is needed to see if the 'v' is followed by an 'l'.
7061 When one of the options is on, Vim will wait for about 1 second for
7062 the next character to arrive. After that the already received
7063 characters are interpreted as single characters. The waiting time can
7064 be changed with the 'timeoutlen' option.
7065 On slow terminals or very busy systems timing out may cause
7066 malfunctioning cursor keys. If both options are off, Vim waits
7067 forever after an entered <Esc> if there are key codes that start
7068 with <Esc>. You will have to type <Esc> twice. If you do not have
7069 problems with key codes, but would like to have :mapped key
7070 sequences not timing out in 1 second, set the 'ttimeout' option and
7071 reset the 'timeout' option.
7072
7073 NOTE: 'ttimeout' is reset when 'compatible' is set.
7074
7075 *'timeoutlen'* *'tm'*
7076'timeoutlen' 'tm' number (default 1000)
7077 global
7078 {not in all versions of Vi}
7079 *'ttimeoutlen'* *'ttm'*
7080'ttimeoutlen' 'ttm' number (default -1)
7081 global
7082 {not in Vi}
7083 The time in milliseconds that is waited for a key code or mapped key
7084 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7085 when part of a command has been typed.
7086 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7087 different timeout value for key codes is desired set 'ttimeoutlen' to
7088 a non-negative number.
7089
7090 ttimeoutlen mapping delay key code delay ~
7091 < 0 'timeoutlen' 'timeoutlen'
7092 >= 0 'timeoutlen' 'ttimeoutlen'
7093
7094 The timeout only happens when the 'timeout' and 'ttimeout' options
7095 tell so. A useful setting would be >
7096 :set timeout timeoutlen=3000 ttimeoutlen=100
7097< (time out on mapping after three seconds, time out on key codes after
7098 a tenth of a second).
7099
7100 *'title'* *'notitle'*
7101'title' boolean (default off, on when title can be restored)
7102 global
7103 {not in Vi}
7104 {not available when compiled without the |+title|
7105 feature}
7106 When on, the title of the window will be set to the value of
7107 'titlestring' (if it is not empty), or to:
7108 filename [+=-] (path) - VIM
7109 Where:
7110 filename the name of the file being edited
7111 - indicates the file cannot be modified, 'ma' off
7112 + indicates the file was modified
7113 = indicates the file is read-only
7114 =+ indicates the file is read-only and modified
7115 (path) is the path of the file being edited
7116 - VIM the server name |v:servername| or "VIM"
7117 Only works if the terminal supports setting window titles
7118 (currently Amiga console, Win32 console, all GUI versions and
7119 terminals with a non- empty 't_ts' option - these are Unix xterm and
7120 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7121 *X11*
7122 When Vim was compiled with HAVE_X11 defined, the original title will
7123 be restored if possible. The output of ":version" will include "+X11"
7124 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7125 works for the icon name |'icon'|.
7126 But: When Vim was started with the |-X| argument, restoring the title
7127 will not work (except in the GUI).
7128 If the title cannot be restored, it is set to the value of 'titleold'.
7129 You might want to restore the title outside of Vim then.
7130 When using an xterm from a remote machine you can use this command:
7131 rsh machine_name xterm -display $DISPLAY &
7132 then the WINDOWID environment variable should be inherited and the
7133 title of the window should change back to what it should be after
7134 exiting Vim.
7135
7136 *'titlelen'*
7137'titlelen' number (default 85)
7138 global
7139 {not in Vi}
7140 {not available when compiled without the |+title|
7141 feature}
7142 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007143 title. When the title is longer, only the end of the path name is
7144 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145 Using a percentage makes this adapt to the width of the window. But
7146 it won't work perfectly, because the actual number of characters
7147 available also depends on the font used and other things in the title
7148 bar. When 'titlelen' is zero the full path is used. Otherwise,
7149 values from 1 to 30000 percent can be used.
7150 'titlelen' is also used for the 'titlestring' option.
7151
7152 *'titleold'*
7153'titleold' string (default "Thanks for flying Vim")
7154 global
7155 {not in Vi}
7156 {only available when compiled with the |+title|
7157 feature}
7158 This option will be used for the window title when exiting Vim if the
7159 original title cannot be restored. Only happens if 'title' is on or
7160 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007161 This option cannot be set from a |modeline| or in the |sandbox|, for
7162 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 *'titlestring'*
7164'titlestring' string (default "")
7165 global
7166 {not in Vi}
7167 {not available when compiled without the |+title|
7168 feature}
7169 When this option is not empty, it will be used for the title of the
7170 window. This happens only when the 'title' option is on.
7171 Only works if the terminal supports setting window titles (currently
7172 Amiga console, Win32 console, all GUI versions and terminals with a
7173 non-empty 't_ts' option).
7174 When Vim was compiled with HAVE_X11 defined, the original title will
7175 be restored if possible |X11|.
7176 When this option contains printf-style '%' items, they will be
7177 expanded according to the rules used for 'statusline'.
7178 Example: >
7179 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7180 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7181< The value of 'titlelen' is used to align items in the middle or right
7182 of the available space.
7183 Some people prefer to have the file name first: >
7184 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7185< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007186 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 separating space only when needed.
7188 NOTE: Use of special characters in 'titlestring' may cause the display
7189 to be garbled (e.g., when it contains a CR or NL character).
7190 {not available when compiled without the |+statusline| feature}
7191
7192 *'toolbar'* *'tb'*
7193'toolbar' 'tb' string (default "icons,tooltips")
7194 global
7195 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7196 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007197 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 possible values are:
7199 icons Toolbar buttons are shown with icons.
7200 text Toolbar buttons shown with text.
7201 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007202 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 tooltips Tooltips are active for toolbar buttons.
7204 Tooltips refer to the popup help text which appears after the mouse
7205 cursor is placed over a toolbar button for a brief moment.
7206
7207 If you want the toolbar to be shown with icons as well as text, do the
7208 following: >
7209 :set tb=icons,text
7210< Motif and Athena cannot display icons and text at the same time. They
7211 will show icons if both are requested.
7212
7213 If none of the strings specified in 'toolbar' are valid or if
7214 'toolbar' is empty, this option is ignored. If you want to disable
7215 the toolbar, you need to set the 'guioptions' option. For example: >
7216 :set guioptions-=T
7217< Also see |gui-toolbar|.
7218
7219 *'toolbariconsize'* *'tbis'*
7220'toolbariconsize' 'tbis' string (default "small")
7221 global
7222 {not in Vi}
7223 {only in the GTK+ 2 GUI}
7224 Controls the size of toolbar icons. The possible values are:
7225 tiny Use tiny toolbar icons.
7226 small Use small toolbar icons (default).
7227 medium Use medium-sized toolbar icons.
7228 large Use large toolbar icons.
7229 The exact dimensions in pixels of the various icon sizes depend on
7230 the current theme. Common dimensions are large=32x32, medium=24x24,
7231 small=20x20 and tiny=16x16.
7232
7233 If 'toolbariconsize' is empty, the global default size as determined
7234 by user preferences or the current theme is used.
7235
7236 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7237'ttybuiltin' 'tbi' boolean (default on)
7238 global
7239 {not in Vi}
7240 When on, the builtin termcaps are searched before the external ones.
7241 When off the builtin termcaps are searched after the external ones.
7242 When this option is changed, you should set the 'term' option next for
7243 the change to take effect, for example: >
7244 :set notbi term=$TERM
7245< See also |termcap|.
7246 Rationale: The default for this option is "on", because the builtin
7247 termcap entries are generally better (many systems contain faulty
7248 xterm entries...).
7249
7250 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7251'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7252 sun-cmd, screen, rxvt, dtterm or
7253 iris-ansi; also on when running Vim in
7254 a DOS console)
7255 global
7256 {not in Vi}
7257 Indicates a fast terminal connection. More characters will be sent to
7258 the screen for redrawing, instead of using insert/delete line
7259 commands. Improves smoothness of redrawing when there are multiple
7260 windows and the terminal does not support a scrolling region.
7261 Also enables the extra writing of characters at the end of each screen
7262 line for lines that wrap. This helps when using copy/paste with the
7263 mouse in an xterm and other terminals.
7264
7265 *'ttymouse'* *'ttym'*
7266'ttymouse' 'ttym' string (default depends on 'term')
7267 global
7268 {not in Vi}
7269 {only in Unix and VMS, doesn't work in the GUI; not
7270 available when compiled without |+mouse|}
7271 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007272 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007273 *xterm-mouse*
7274 xterm xterm-like mouse handling. The mouse generates
7275 "<Esc>[Mscr", where "scr" is three bytes:
7276 "s" = button state
7277 "c" = column plus 33
7278 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007279 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007280 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 xterm2 Works like "xterm", but with the xterm reporting the
7282 mouse position while the mouse is dragged. This works
7283 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007284 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285 work. See below for how Vim detects this
7286 automatically.
7287 *netterm-mouse*
7288 netterm NetTerm mouse handling. The mouse generates
7289 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7290 for the row and column.
7291 *dec-mouse*
7292 dec DEC terminal mouse handling. The mouse generates a
7293 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007294 This is also available for an Xterm, if it was
7295 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 *jsbterm-mouse*
7297 jsbterm JSB term mouse handling.
7298 *pterm-mouse*
7299 pterm QNX pterm mouse handling.
7300
7301 The mouse handling must be enabled at compile time |+mouse_xterm|
7302 |+mouse_dec| |+mouse_netterm|.
7303 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7304 recognized, if enabled at compile time. DEC terminal mouse codes
7305 are recognized if enabled at compile time, and 'ttymouse' is not
7306 "xterm" (because the xterm and dec mouse codes conflict).
7307 This option is automatically set to "xterm", when the 'term' option is
7308 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7309 or "xterm2" already. The main use of this option is to set it to
7310 "xterm", when the terminal name doesn't start with "xterm", but it can
7311 handle xterm mouse codes.
7312 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007313 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007314 feature and if |t_RV| is set to the escape sequence to request the
7315 xterm version number. Otherwise "xterm2" must be set explicitly.
7316 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7317 t_RV to an empty string: >
7318 :set t_RV=
7319<
7320 *'ttyscroll'* *'tsl'*
7321'ttyscroll' 'tsl' number (default 999)
7322 global
7323 Maximum number of lines to scroll the screen. If there are more lines
7324 to scroll the window is redrawn. For terminals where scrolling is
7325 very slow and redrawing is not slow this can be set to a small number,
7326 e.g., 3, to speed up displaying.
7327
7328 *'ttytype'* *'tty'*
7329'ttytype' 'tty' string (default from $TERM)
7330 global
7331 Alias for 'term', see above.
7332
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007333 *'undodir'* *'udir'*
7334'undodir' 'udir' string (default ".")
7335 global
7336 {not in Vi}
7337 {only when compiled with the +persistent_undo feature}
7338 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007339 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007340 "." means using the directory of the file. The undo file name for
7341 "file.txt" is ".file.txt.un~".
7342 For other directories the file name is the full path of the edited
7343 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007344 When writing: The first directory that exists is used. "." always
7345 works, no directories after "." will be used for writing.
7346 When reading all entries are tried to find an undo file. The first
7347 undo file that exists is used. When it cannot be read an error is
7348 given, no further entry is used.
7349 See |undo-persistence|.
7350
7351 *'undofile'* *'udf'*
7352'undofile' 'udf' boolean (default off)
7353 local to buffer
7354 {not in Vi}
7355 {only when compiled with the +persistent_undo feature}
7356 When on, Vim automatically saves undo history to an undo file when
7357 writing a buffer to a file, and restores undo history from the same
7358 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007359 The directory where the undo file is stored is specified by 'undodir'.
7360 For more information about this feature see |undo-persistence|.
7361 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007362
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363 *'undolevels'* *'ul'*
7364'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7365 Win32 and OS/2)
7366 global
7367 {not in Vi}
7368 Maximum number of changes that can be undone. Since undo information
7369 is kept in memory, higher numbers will cause more memory to be used
7370 (nevertheless, a single change can use an unlimited amount of memory).
7371 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7372 itself: >
7373 set ul=0
7374< But you can also get Vi compatibility by including the 'u' flag in
7375 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007376 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007377 Set to a negative number for no undo at all: >
7378 set ul=-1
7379< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007380 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381
7382 *'updatecount'* *'uc'*
7383'updatecount' 'uc' number (default: 200)
7384 global
7385 {not in Vi}
7386 After typing this many characters the swap file will be written to
7387 disk. When zero, no swap file will be created at all (see chapter on
7388 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7389 Vim with the "-n" option, see |startup|. When editing in readonly
7390 mode this option will be initialized to 10000.
7391 The swapfile can be disabled per buffer with |'swapfile'|.
7392 When 'updatecount' is set from zero to non-zero, swap files are
7393 created for all buffers that have 'swapfile' set. When 'updatecount'
7394 is set to zero, existing swap files are not deleted.
7395 Also see |'swapsync'|.
7396 This option has no meaning in buffers where |'buftype'| is "nofile"
7397 or "nowrite".
7398
7399 *'updatetime'* *'ut'*
7400'updatetime' 'ut' number (default 4000)
7401 global
7402 {not in Vi}
7403 If this many milliseconds nothing is typed the swap file will be
7404 written to disk (see |crash-recovery|). Also used for the
7405 |CursorHold| autocommand event.
7406
7407 *'verbose'* *'vbs'*
7408'verbose' 'vbs' number (default 0)
7409 global
7410 {not in Vi, although some versions have a boolean
7411 verbose option}
7412 When bigger than zero, Vim will give messages about what it is doing.
7413 Currently, these messages are given:
7414 >= 1 When the viminfo file is read or written.
7415 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007416 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417 >= 8 Files for which a group of autocommands is executed.
7418 >= 9 Every executed autocommand.
7419 >= 12 Every executed function.
7420 >= 13 When an exception is thrown, caught, finished, or discarded.
7421 >= 14 Anything pending in a ":finally" clause.
7422 >= 15 Every executed Ex command (truncated at 200 characters).
7423
7424 This option can also be set with the "-V" argument. See |-V|.
7425 This option is also set by the |:verbose| command.
7426
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007427 When the 'verbosefile' option is set then the verbose messages are not
7428 displayed.
7429
7430 *'verbosefile'* *'vfile'*
7431'verbosefile' 'vfile' string (default empty)
7432 global
7433 {not in Vi}
7434 When not empty all messages are written in a file with this name.
7435 When the file exists messages are appended.
7436 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007437 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007438 Setting 'verbosefile' to a new value is like making it empty first.
7439 The difference with |:redir| is that verbose messages are not
7440 displayed when 'verbosefile' is set.
7441
Bram Moolenaar071d4272004-06-13 20:20:40 +00007442 *'viewdir'* *'vdir'*
7443'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7444 "$VIM/vimfiles/view",
7445 for Unix: "~/.vim/view",
7446 for Macintosh: "$VIM:vimfiles:view"
7447 for VMS: "sys$login:vimfiles/view"
7448 for RiscOS: "Choices:vimfiles/view")
7449 global
7450 {not in Vi}
7451 {not available when compiled without the +mksession
7452 feature}
7453 Name of the directory where to store files for |:mkview|.
7454 This option cannot be set from a |modeline| or in the |sandbox|, for
7455 security reasons.
7456
7457 *'viewoptions'* *'vop'*
7458'viewoptions' 'vop' string (default: "folds,options,cursor")
7459 global
7460 {not in Vi}
7461 {not available when compiled without the +mksession
7462 feature}
7463 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007464 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 word save and restore ~
7466 cursor cursor position in file and in window
7467 folds manually created folds, opened/closed folds and local
7468 fold options
7469 options options and mappings local to a window or buffer (not
7470 global values for local options)
7471 slash backslashes in file names replaced with forward
7472 slashes
7473 unix with Unix end-of-line format (single <NL>), even when
7474 on Windows or DOS
7475
7476 "slash" and "unix" are useful on Windows when sharing view files
7477 with Unix. The Unix version of Vim cannot source dos format scripts,
7478 but the Windows version of Vim can source unix format scripts.
7479
7480 *'viminfo'* *'vi'* *E526* *E527* *E528*
7481'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007482 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7483 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7484 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 global
7486 {not in Vi}
7487 {not available when compiled without the |+viminfo|
7488 feature}
7489 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007490 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007491 separated list of parameters, each consisting of a single character
7492 identifying the particular parameter, followed by a number or string
7493 which specifies the value of that parameter. If a particular
7494 character is left out, then the default value is used for that
7495 parameter. The following is a list of the identifying characters and
7496 the effect of their value.
7497 CHAR VALUE ~
7498 ! When included, save and restore global variables that start
7499 with an uppercase letter, and don't contain a lowercase
7500 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007501 and "_K_L_M" are not. Only String and Number types are
7502 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503 " Maximum number of lines saved for each register. Old name of
7504 the '<' item, with the disadvantage that you need to put a
7505 backslash before the ", otherwise it will be recognized as the
7506 start of a comment!
7507 % When included, save and restore the buffer list. If Vim is
7508 started with a file name argument, the buffer list is not
7509 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007510 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511 without a file name and buffers for help files are not written
7512 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007513 When followed by a number, the number specifies the maximum
7514 number of buffers that are stored. Without a number all
7515 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007516 ' Maximum number of previously edited files for which the marks
7517 are remembered. This parameter must always be included when
7518 'viminfo' is non-empty.
7519 Including this item also means that the |jumplist| and the
7520 |changelist| are stored in the viminfo file.
7521 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007522 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523 patterns are also saved. When not included, the value of
7524 'history' is used.
7525 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007526 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527 < Maximum number of lines saved for each register. If zero then
7528 registers are not saved. When not included, all lines are
7529 saved. '"' is the old name for this item.
7530 Also see the 's' item below: limit specified in Kbyte.
7531 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007532 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007533 c When included, convert the text in the viminfo file from the
7534 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007535 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536 f Whether file marks need to be stored. If zero, file marks ('0
7537 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007538 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539 cursor position (when exiting or when doing ":wviminfo").
7540 h Disable the effect of 'hlsearch' when loading the viminfo
7541 file. When not included, it depends on whether ":nohlsearch"
7542 has been used since the last search command.
7543 n Name of the viminfo file. The name must immediately follow
7544 the 'n'. Must be the last one! If the "-i" argument was
7545 given when starting Vim, that file name overrides the one
7546 given here with 'viminfo'. Environment variables are expanded
7547 when opening the file, not when setting the option.
7548 r Removable media. The argument is a string (up to the next
7549 ','). This parameter can be given several times. Each
7550 specifies the start of a path for which no marks will be
7551 stored. This is to avoid removable media. For MS-DOS you
7552 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7553 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7554 ignored. Maximum length of each 'r' argument is 50
7555 characters.
7556 s Maximum size of an item in Kbyte. If zero then registers are
7557 not saved. Currently only applies to registers. The default
7558 "s10" will exclude registers with more than 10 Kbyte of text.
7559 Also see the '<' item above: line count limit.
7560
7561 Example: >
7562 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7563<
7564 '50 Marks will be remembered for the last 50 files you
7565 edited.
7566 <1000 Contents of registers (up to 1000 lines each) will be
7567 remembered.
7568 s100 Registers with more than 100 Kbyte text are skipped.
7569 :0 Command-line history will not be saved.
7570 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7571 no / Since '/' is not specified, the default will be used,
7572 that is, save all of the search history, and also the
7573 previous search and substitute patterns.
7574 no % The buffer list will not be saved nor read back.
7575 no h 'hlsearch' highlighting will be restored.
7576
7577 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7578 load the contents of the file, this is not done automatically.
7579
7580 This option cannot be set from a |modeline| or in the |sandbox|, for
7581 security reasons.
7582
7583 *'virtualedit'* *'ve'*
7584'virtualedit' 've' string (default "")
7585 global
7586 {not in Vi}
7587 {not available when compiled without the
7588 |+virtualedit| feature}
7589 A comma separated list of these words:
7590 block Allow virtual editing in Visual block mode.
7591 insert Allow virtual editing in Insert mode.
7592 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007593 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007594
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007596 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597 of the line. Useful for selecting a rectangle in Visual mode and
7598 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007599 "onemore" is not the same, it will only allow moving the cursor just
7600 after the last character of the line. This makes some commands more
7601 consistent. Previously the cursor was always past the end of the line
7602 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007603 break some plugins or Vim scripts. For example because |l| can move
7604 the cursor after the last character. Use with care!
7605 Using the |$| command will move to the last character in the line, not
7606 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007607 It doesn't make sense to combine "all" with "onemore", but you will
7608 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609
7610 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7611'visualbell' 'vb' boolean (default off)
7612 global
7613 {not in Vi}
7614 Use visual bell instead of beeping. The terminal code to display the
7615 visual bell is given with 't_vb'. When no beep or flash is wanted,
7616 use ":set vb t_vb=".
7617 Note: When the GUI starts, 't_vb' is reset to its default value. You
7618 might want to set it again in your |gvimrc|.
7619 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7620 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7621 where 40 is the time in msec.
7622 Does not work on the Amiga, you always get a screen flash.
7623 Also see 'errorbells'.
7624
7625 *'warn'* *'nowarn'*
7626'warn' boolean (default on)
7627 global
7628 Give a warning message when a shell command is used while the buffer
7629 has been changed.
7630
7631 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7632'weirdinvert' 'wiv' boolean (default off)
7633 global
7634 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007635 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636 It is provided for backwards compatibility with version 4.x.
7637 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7638 vice versa. Has no effect when the GUI is running.
7639
7640 *'whichwrap'* *'ww'*
7641'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7642 global
7643 {not in Vi}
7644 Allow specified keys that move the cursor left/right to move to the
7645 previous/next line when the cursor is on the first/last character in
7646 the line. Concatenate characters to allow this for these keys:
7647 char key mode ~
7648 b <BS> Normal and Visual
7649 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007650 h "h" Normal and Visual (not recommended)
7651 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652 < <Left> Normal and Visual
7653 > <Right> Normal and Visual
7654 ~ "~" Normal
7655 [ <Left> Insert and Replace
7656 ] <Right> Insert and Replace
7657 For example: >
7658 :set ww=<,>,[,]
7659< allows wrap only when cursor keys are used.
7660 When the movement keys are used in combination with a delete or change
7661 operator, the <EOL> also counts for a character. This makes "3h"
7662 different from "3dh" when the cursor crosses the end of a line. This
7663 is also true for "x" and "X", because they do the same as "dl" and
7664 "dh". If you use this, you may also want to use the mapping
7665 ":map <BS> X" to make backspace delete the character in front of the
7666 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007667 When 'l' is included and it is used after an operator at the end of a
7668 line then it will not move to the next line. This makes "dl", "cl",
7669 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007670 NOTE: This option is set to the Vi default value when 'compatible' is
7671 set and to the Vim default value when 'compatible' is reset.
7672
7673 *'wildchar'* *'wc'*
7674'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7675 global
7676 {not in Vi}
7677 Character you have to type to start wildcard expansion in the
7678 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007679 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007680 The character is not recognized when used inside a macro. See
7681 'wildcharm' for that.
7682 Although 'wc' is a number option, you can set it to a special key: >
7683 :set wc=<Esc>
7684< NOTE: This option is set to the Vi default value when 'compatible' is
7685 set and to the Vim default value when 'compatible' is reset.
7686
7687 *'wildcharm'* *'wcm'*
7688'wildcharm' 'wcm' number (default: none (0))
7689 global
7690 {not in Vi}
7691 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007692 recognized when used inside a macro. You can find "spare" command-line
7693 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007694 you'll never actually type 'wildcharm', just use it in mappings that
7695 automatically invoke completion mode, e.g.: >
7696 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007697 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698< Then after typing :ss you can use CTRL-P & CTRL-N.
7699
7700 *'wildignore'* *'wig'*
7701'wildignore' 'wig' string (default "")
7702 global
7703 {not in Vi}
7704 {not available when compiled without the |+wildignore|
7705 feature}
7706 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007707 patterns is ignored when completing file or directory names, and
7708 influences the result of |expand()|, |glob()| and |globpath()| unless
7709 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7711 Also see 'suffixes'.
7712 Example: >
7713 :set wildignore=*.o,*.obj
7714< The use of |:set+=| and |:set-=| is preferred when adding or removing
7715 a pattern from the list. This avoids problems when a future version
7716 uses another default.
7717
7718 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7719'wildmenu' 'wmnu' boolean (default off)
7720 global
7721 {not in Vi}
7722 {not available if compiled without the |+wildmenu|
7723 feature}
7724 When 'wildmenu' is on, command-line completion operates in an enhanced
7725 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7726 the possible matches are shown just above the command line, with the
7727 first match highlighted (overwriting the status line, if there is
7728 one). Keys that show the previous/next match, such as <Tab> or
7729 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7730 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7731 specified. "longest" and "list" do not start "wildmenu" mode.
7732 If there are more matches than can fit in the line, a ">" is shown on
7733 the right and/or a "<" is shown on the left. The status line scrolls
7734 as needed.
7735 The "wildmenu" mode is abandoned when a key is hit that is not used
7736 for selecting a completion.
7737 While the "wildmenu" is active the following keys have special
7738 meanings:
7739
7740 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7741 <Down> - in filename/menu name completion: move into a
7742 subdirectory or submenu.
7743 <CR> - in menu completion, when the cursor is just after a
7744 dot: move into a submenu.
7745 <Up> - in filename/menu name completion: move up into
7746 parent directory or parent menu.
7747
7748 This makes the menus accessible from the console |console-menus|.
7749
7750 If you prefer the <Left> and <Right> keys to move the cursor instead
7751 of selecting a different match, use this: >
7752 :cnoremap <Left> <Space><BS><Left>
7753 :cnoremap <Right> <Space><BS><Right>
7754<
7755 The "WildMenu" highlighting is used for displaying the current match
7756 |hl-WildMenu|.
7757
7758 *'wildmode'* *'wim'*
7759'wildmode' 'wim' string (Vim default: "full")
7760 global
7761 {not in Vi}
7762 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007763 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007764 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765 first part specifies the behavior for the first use of 'wildchar',
7766 The second part for the second use, etc.
7767 These are the possible values for each part:
7768 "" Complete only the first match.
7769 "full" Complete the next full match. After the last match,
7770 the original string is used and then the first match
7771 again.
7772 "longest" Complete till longest common string. If this doesn't
7773 result in a longer string, use the next part.
7774 "longest:full" Like "longest", but also start 'wildmenu' if it is
7775 enabled.
7776 "list" When more than one match, list all matches.
7777 "list:full" When more than one match, list all matches and
7778 complete first match.
7779 "list:longest" When more than one match, list all matches and
7780 complete till longest common string.
7781 When there is only a single match, it is fully completed in all cases.
7782
7783 Examples: >
7784 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007785< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786 :set wildmode=longest,full
7787< Complete longest common string, then each full match >
7788 :set wildmode=list:full
7789< List all matches and complete each full match >
7790 :set wildmode=list,full
7791< List all matches without completing, then each full match >
7792 :set wildmode=longest,list
7793< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007794 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007795
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007796 *'wildoptions'* *'wop'*
7797'wildoptions' 'wop' string (default "")
7798 global
7799 {not in Vi}
7800 {not available when compiled without the |+wildignore|
7801 feature}
7802 A list of words that change how command line completion is done.
7803 Currently only one word is allowed:
7804 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007805 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007806 is displayed per line. Often used tag kinds are:
7807 d #define
7808 f function
7809 Also see |cmdline-completion|.
7810
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811 *'winaltkeys'* *'wak'*
7812'winaltkeys' 'wak' string (default "menu")
7813 global
7814 {not in Vi}
7815 {only used in Win32, Motif, GTK and Photon GUI}
7816 Some GUI versions allow the access to menu entries by using the ALT
7817 key in combination with a character that appears underlined in the
7818 menu. This conflicts with the use of the ALT key for mappings and
7819 entering special characters. This option tells what to do:
7820 no Don't use ALT keys for menus. ALT key combinations can be
7821 mapped, but there is no automatic handling. This can then be
7822 done with the |:simalt| command.
7823 yes ALT key handling is done by the windowing system. ALT key
7824 combinations cannot be mapped.
7825 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007826 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 keys can be mapped.
7828 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7829 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007830 This option is not used for <F10>; on Win32 and with GTK <F10> will
7831 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007832
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007833 *'window'* *'wi'*
7834'window' 'wi' number (default screen height - 1)
7835 global
7836 Window height. Do not confuse this with the height of the Vim window,
7837 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007838 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7839 value is smaller than 'lines' minus one. The screen will scroll
7840 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007841 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7842 in a much smarter way, taking care of wrapping lines.
7843 When resizing the Vim window, the value is smaller than 1 or more than
7844 or equal to 'lines' it will be set to 'lines' minus 1.
7845 {Vi also uses the option to specify the number of displayed lines}
7846
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847 *'winheight'* *'wh'* *E591*
7848'winheight' 'wh' number (default 1)
7849 global
7850 {not in Vi}
7851 {not available when compiled without the +windows
7852 feature}
7853 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007854 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007855 focus goes to a window that is smaller, its size is increased, at the
7856 cost of the height of other windows.
7857 Set 'winheight' to a small number for normal editing.
7858 Set it to 999 to make the current window fill most of the screen.
7859 Other windows will be only 'winminheight' high. This has the drawback
7860 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7861 to create only two windows, set the option after startup is done,
7862 using the |VimEnter| event: >
7863 au VimEnter * set winheight=999
7864< Minimum value is 1.
7865 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007866 height of the current window.
7867 'winheight' applies to the current window. Use 'winminheight' to set
7868 the minimal height for other windows.
7869
7870 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7871'winfixheight' 'wfh' boolean (default off)
7872 local to window
7873 {not in Vi}
7874 {not available when compiled without the +windows
7875 feature}
7876 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007877 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7878 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 The height may be changed anyway when running out of room.
7880
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007881 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7882'winfixwidth' 'wfw' boolean (default off)
7883 local to window
7884 {not in Vi}
7885 {not available when compiled without the +windows
7886 feature}
7887 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007888 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007889 The width may be changed anyway when running out of room.
7890
Bram Moolenaar071d4272004-06-13 20:20:40 +00007891 *'winminheight'* *'wmh'*
7892'winminheight' 'wmh' number (default 1)
7893 global
7894 {not in Vi}
7895 {not available when compiled without the +windows
7896 feature}
7897 The minimal height of a window, when it's not the current window.
7898 This is a hard minimum, windows will never become smaller.
7899 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7900 status bar) if necessary. They will return to at least one line when
7901 they become active (since the cursor has to have somewhere to go.)
7902 Use 'winheight' to set the minimal height of the current window.
7903 This option is only checked when making a window smaller. Don't use a
7904 large number, it will cause errors when opening more than a few
7905 windows. A value of 0 to 3 is reasonable.
7906
7907 *'winminwidth'* *'wmw'*
7908'winminwidth' 'wmw' number (default 1)
7909 global
7910 {not in Vi}
7911 {not available when compiled without the +vertsplit
7912 feature}
7913 The minimal width of a window, when it's not the current window.
7914 This is a hard minimum, windows will never become smaller.
7915 When set to zero, windows may be "squashed" to zero columns (i.e. just
7916 a vertical separator) if necessary. They will return to at least one
7917 line when they become active (since the cursor has to have somewhere
7918 to go.)
7919 Use 'winwidth' to set the minimal width of the current window.
7920 This option is only checked when making a window smaller. Don't use a
7921 large number, it will cause errors when opening more than a few
7922 windows. A value of 0 to 12 is reasonable.
7923
7924 *'winwidth'* *'wiw'* *E592*
7925'winwidth' 'wiw' number (default 20)
7926 global
7927 {not in Vi}
7928 {not available when compiled without the +vertsplit
7929 feature}
7930 Minimal number of columns for the current window. This is not a hard
7931 minimum, Vim will use fewer columns if there is not enough room. If
7932 the current window is smaller, its size is increased, at the cost of
7933 the width of other windows. Set it to 999 to make the current window
7934 always fill the screen. Set it to a small number for normal editing.
7935 The width is not adjusted after one of the commands to change the
7936 width of the current window.
7937 'winwidth' applies to the current window. Use 'winminwidth' to set
7938 the minimal width for other windows.
7939
7940 *'wrap'* *'nowrap'*
7941'wrap' boolean (default on)
7942 local to window
7943 {not in Vi}
7944 This option changes how text is displayed. It doesn't change the text
7945 in the buffer, see 'textwidth' for that.
7946 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007947 displaying continues on the next line. When off lines will not wrap
7948 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007949 moved to a part that is not shown, the screen will scroll
7950 horizontally.
7951 The line will be broken in the middle of a word if necessary. See
7952 'linebreak' to get the break at a word boundary.
7953 To make scrolling horizontally a bit more useful, try this: >
7954 :set sidescroll=5
7955 :set listchars+=precedes:<,extends:>
7956< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007957 This option can't be set from a |modeline| when the 'diff' option is
7958 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959
7960 *'wrapmargin'* *'wm'*
7961'wrapmargin' 'wm' number (default 0)
7962 local to buffer
7963 Number of characters from the right window border where wrapping
7964 starts. When typing text beyond this limit, an <EOL> will be inserted
7965 and inserting continues on the next line.
7966 Options that add a margin, such as 'number' and 'foldcolumn', cause
7967 the text width to be further reduced. This is Vi compatible.
7968 When 'textwidth' is non-zero, this option is not used.
7969 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7970 and less usefully}
7971
7972 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7973'wrapscan' 'ws' boolean (default on) *E384* *E385*
7974 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007975 Searches wrap around the end of the file. Also applies to |]s| and
7976 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007977
7978 *'write'* *'nowrite'*
7979'write' boolean (default on)
7980 global
7981 {not in Vi}
7982 Allows writing files. When not set, writing a file is not allowed.
7983 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007984 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007985 argument. Filtering text is still possible, even though this requires
7986 writing a temporary file.
7987
7988 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7989'writeany' 'wa' boolean (default off)
7990 global
7991 Allows writing to any file with no need for "!" override.
7992
7993 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7994'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7995 otherwise)
7996 global
7997 {not in Vi}
7998 Make a backup before overwriting a file. The backup is removed after
7999 the file was successfully written, unless the 'backup' option is
8000 also on. Reset this option if your file system is almost full. See
8001 |backup-table| for another explanation.
8002 When the 'backupskip' pattern matches, a backup is not made anyway.
8003 NOTE: This option is set to the default value when 'compatible' is
8004 set.
8005
8006 *'writedelay'* *'wd'*
8007'writedelay' 'wd' number (default 0)
8008 global
8009 {not in Vi}
8010 The number of microseconds to wait for each character sent to the
8011 screen. When non-zero, characters are sent to the terminal one by
8012 one. For MS-DOS pcterm this does not work. For debugging purposes.
8013
8014 vim:tw=78:ts=8:ft=help:norl: