blob: 8e2b5e07248f6de7dd9007b26500b4fd3be8af46 [file] [log] [blame]
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001*options.txt* For Vim version 7.3b. Last change: 2010 Jul 24
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
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001722 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001723
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001724 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001725 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001726 are moving around text is concealed, but when starting to insert text
1727 or selecting a Visual area the concealed text is displayed, so that
1728 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001729 Keep in mind that the cursor position is not always where it's
1730 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001731
1732
1733'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001734 number (default 0)
1735 local to window
1736 {not in Vi}
1737 {not available when compiled without the |+conceal|
1738 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001739 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1740 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001741
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001742 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001743 0 Text is shown normally
1744 1 Each block of concealed text is replaced with the
1745 character defined in 'listchars' (default is a dash)
1746 and highlighted with the "Conceal" highlight group.
1747 2 Concealed text is completely hidden unless it has a
1748 custom replacement character defined (see
1749 |:syn-cchar|.
Bram Moolenaara7781e02010-07-19 20:13:22 +02001750 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001751
Bram Moolenaara7781e02010-07-19 20:13:22 +02001752 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001753 edit and copy the text. This can be changed with the 'concealcursor'
1754 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001755
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1757'confirm' 'cf' boolean (default off)
1758 global
1759 {not in Vi}
1760 When 'confirm' is on, certain operations that would normally
1761 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1762 instead raise a |dialog| asking if you wish to save the current
1763 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1764 If 'confirm' is off you can still activate confirmation for one
1765 command only (this is most useful in mappings) with the |:confirm|
1766 command.
1767 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1768
1769 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1770'conskey' 'consk' boolean (default off)
1771 global
1772 {not in Vi} {only for MS-DOS}
1773 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001774 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001775 three methods of console input are available:
1776 'conskey' 'bioskey' action ~
1777 on on or off direct console input
1778 off on BIOS
1779 off off STDIN
1780
1781 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1782'copyindent' 'ci' boolean (default off)
1783 local to buffer
1784 {not in Vi}
1785 Copy the structure of the existing lines indent when autoindenting a
1786 new line. Normally the new indent is reconstructed by a series of
1787 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1788 in which case only spaces are used). Enabling this option makes the
1789 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001790 existing line. 'expandtab' has no effect on these characters, a Tab
1791 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001792 line, the remaining space is filled in the normal manner.
1793 NOTE: 'copyindent' is reset when 'compatible' is set.
1794 Also see 'preserveindent'.
1795
1796 *'cpoptions'* *'cpo'*
1797'cpoptions' 'cpo' string (Vim default: "aABceFs",
1798 Vi default: all flags)
1799 global
1800 {not in Vi}
1801 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001802 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 not being vi-compatible is mostly or sometimes preferred.
1804 'cpoptions' stands for "compatible-options".
1805 Commas can be added for readability.
1806 To avoid problems with flags that are added in the future, use the
1807 "+=" and "-=" feature of ":set" |add-option-flags|.
1808 NOTE: This option is set to the Vi default value when 'compatible' is
1809 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001810 NOTE: This option is set to the POSIX default value at startup when
1811 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001812 variable exists |posix|. This means Vim tries to behave like the
1813 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814
1815 contains behavior ~
1816 *cpo-a*
1817 a When included, a ":read" command with a file name
1818 argument will set the alternate file name for the
1819 current window.
1820 *cpo-A*
1821 A When included, a ":write" command with a file name
1822 argument will set the alternate file name for the
1823 current window.
1824 *cpo-b*
1825 b "\|" in a ":map" command is recognized as the end of
1826 the map command. The '\' is included in the mapping,
1827 the text after the '|' is interpreted as the next
1828 command. Use a CTRL-V instead of a backslash to
1829 include the '|' in the mapping. Applies to all
1830 mapping, abbreviation, menu and autocmd commands.
1831 See also |map_bar|.
1832 *cpo-B*
1833 B A backslash has no special meaning in mappings,
1834 abbreviations and the "to" part of the menu commands.
1835 Remove this flag to be able to use a backslash like a
1836 CTRL-V. For example, the command ":map X \<Esc>"
1837 results in X being mapped to:
1838 'B' included: "\^[" (^[ is a real <Esc>)
1839 'B' excluded: "<Esc>" (5 characters)
1840 ('<' excluded in both cases)
1841 *cpo-c*
1842 c Searching continues at the end of any match at the
1843 cursor position, but not further than the start of the
1844 next line. When not present searching continues
1845 one character from the cursor position. With 'c'
1846 "abababababab" only gets three matches when repeating
1847 "/abab", without 'c' there are five matches.
1848 *cpo-C*
1849 C Do not concatenate sourced lines that start with a
1850 backslash. See |line-continuation|.
1851 *cpo-d*
1852 d Using "./" in the 'tags' option doesn't mean to use
1853 the tags file relative to the current file, but the
1854 tags file in the current directory.
1855 *cpo-D*
1856 D Can't use CTRL-K to enter a digraph after Normal mode
1857 commands with a character argument, like |r|, |f| and
1858 |t|.
1859 *cpo-e*
1860 e When executing a register with ":@r", always add a
1861 <CR> to the last line, also when the register is not
1862 linewise. If this flag is not present, the register
1863 is not linewise and the last line does not end in a
1864 <CR>, then the last line is put on the command-line
1865 and can be edited before hitting <CR>.
1866 *cpo-E*
1867 E It is an error when using "y", "d", "c", "g~", "gu" or
1868 "gU" on an Empty region. The operators only work when
1869 at least one character is to be operate on. Example:
1870 This makes "y0" fail in the first column.
1871 *cpo-f*
1872 f When included, a ":read" command with a file name
1873 argument will set the file name for the current buffer,
1874 if the current buffer doesn't have a file name yet.
1875 *cpo-F*
1876 F When included, a ":write" command with a file name
1877 argument will set the file name for the current
1878 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001879 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880 *cpo-g*
1881 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001882 *cpo-H*
1883 H When using "I" on a line with only blanks, insert
1884 before the last blank. Without this flag insert after
1885 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886 *cpo-i*
1887 i When included, interrupting the reading of a file will
1888 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001889 *cpo-I*
1890 I When moving the cursor up or down just after inserting
1891 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 *cpo-j*
1893 j When joining lines, only add two spaces after a '.',
1894 not after '!' or '?'. Also see 'joinspaces'.
1895 *cpo-J*
1896 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001897 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001898 white space.
1899 *cpo-k*
1900 k Disable the recognition of raw key codes in
1901 mappings, abbreviations, and the "to" part of menu
1902 commands. For example, if <Key> sends ^[OA (where ^[
1903 is <Esc>), the command ":map X ^[OA" results in X
1904 being mapped to:
1905 'k' included: "^[OA" (3 characters)
1906 'k' excluded: "<Key>" (one key code)
1907 Also see the '<' flag below.
1908 *cpo-K*
1909 K Don't wait for a key code to complete when it is
1910 halfway a mapping. This breaks mapping <F1><F1> when
1911 only part of the second <F1> has been read. It
1912 enables cancelling the mapping by typing <F1><Esc>.
1913 *cpo-l*
1914 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001915 literally, only "\]", "\^", "\-" and "\\" are special.
1916 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1918 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001919 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 *cpo-L*
1921 L When the 'list' option is set, 'wrapmargin',
1922 'textwidth', 'softtabstop' and Virtual Replace mode
1923 (see |gR|) count a <Tab> as two characters, instead of
1924 the normal behavior of a <Tab>.
1925 *cpo-m*
1926 m When included, a showmatch will always wait half a
1927 second. When not included, a showmatch will wait half
1928 a second or until a character is typed. |'showmatch'|
1929 *cpo-M*
1930 M When excluded, "%" matching will take backslashes into
1931 account. Thus in "( \( )" and "\( ( \)" the outer
1932 parenthesis match. When included "%" ignores
1933 backslashes, which is Vi compatible.
1934 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001935 n When included, the column used for 'number' and
1936 'relativenumber' will also be used for text of wrapped
1937 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938 *cpo-o*
1939 o Line offset to search command is not remembered for
1940 next search.
1941 *cpo-O*
1942 O Don't complain if a file is being overwritten, even
1943 when it didn't exist when editing it. This is a
1944 protection against a file unexpectedly created by
1945 someone else. Vi didn't complain about this.
1946 *cpo-p*
1947 p Vi compatible Lisp indenting. When not present, a
1948 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001949 *cpo-P*
1950 P When included, a ":write" command that appends to a
1951 file will set the file name for the current buffer, if
1952 the current buffer doesn't have a file name yet and
1953 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001954 *cpo-q*
1955 q When joining multiple lines leave the cursor at the
1956 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957 *cpo-r*
1958 r Redo ("." command) uses "/" to repeat a search
1959 command, instead of the actually used search string.
1960 *cpo-R*
1961 R Remove marks from filtered lines. Without this flag
1962 marks are kept like |:keepmarks| was used.
1963 *cpo-s*
1964 s Set buffer options when entering the buffer for the
1965 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001966 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967 set when the buffer is created.
1968 *cpo-S*
1969 S Set buffer options always when entering a buffer
1970 (except 'readonly', 'fileformat', 'filetype' and
1971 'syntax'). This is the (most) Vi compatible setting.
1972 The options are set to the values in the current
1973 buffer. When you change an option and go to another
1974 buffer, the value is copied. Effectively makes the
1975 buffer options global to all buffers.
1976
1977 's' 'S' copy buffer options
1978 no no when buffer created
1979 yes no when buffer first entered (default)
1980 X yes each time when buffer entered (vi comp.)
1981 *cpo-t*
1982 t Search pattern for the tag command is remembered for
1983 "n" command. Otherwise Vim only puts the pattern in
1984 the history for search pattern, but doesn't change the
1985 last used search pattern.
1986 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001987 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 *cpo-v*
1989 v Backspaced characters remain visible on the screen in
1990 Insert mode. Without this flag the characters are
1991 erased from the screen right away. With this flag the
1992 screen newly typed text overwrites backspaced
1993 characters.
1994 *cpo-w*
1995 w When using "cw" on a blank character, only change one
1996 character and not all blanks until the start of the
1997 next word.
1998 *cpo-W*
1999 W Don't overwrite a readonly file. When omitted, ":w!"
2000 overwrites a readonly file, if possible.
2001 *cpo-x*
2002 x <Esc> on the command-line executes the command-line.
2003 The default in Vim is to abandon the command-line,
2004 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002005 *cpo-X*
2006 X When using a count with "R" the replaced text is
2007 deleted only once. Also when repeating "R" with "."
2008 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 *cpo-y*
2010 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002011 *cpo-Z*
2012 Z When using "w!" while the 'readonly' option is set,
2013 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014 *cpo-!*
2015 ! When redoing a filter command, use the last used
2016 external command, whatever it was. Otherwise the last
2017 used -filter- command is used.
2018 *cpo-$*
2019 $ When making a change to one line, don't redisplay the
2020 line, but put a '$' at the end of the changed text.
2021 The changed text will be overwritten when you type the
2022 new text. The line is redisplayed if you type any
2023 command that moves the cursor from the insertion
2024 point.
2025 *cpo-%*
2026 % Vi-compatible matching is done for the "%" command.
2027 Does not recognize "#if", "#endif", etc.
2028 Does not recognize "/*" and "*/".
2029 Parens inside single and double quotes are also
2030 counted, causing a string that contains a paren to
2031 disturb the matching. For example, in a line like
2032 "if (strcmp("foo(", s))" the first paren does not
2033 match the last one. When this flag is not included,
2034 parens inside single and double quotes are treated
2035 specially. When matching a paren outside of quotes,
2036 everything inside quotes is ignored. When matching a
2037 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002038 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002039 This flag is also used for other features, such as
2040 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002041 *cpo--*
2042 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002043 it would go above the first line or below the last
2044 line. Without it the cursor moves to the first or
2045 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002046 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002047 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002048 *cpo-+*
2049 + When included, a ":write file" command will reset the
2050 'modified' flag of the buffer, even though the buffer
2051 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002052 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 * Use ":*" in the same way as ":@". When not included,
2054 ":*" is an alias for ":'<,'>", select the Visual area.
2055 *cpo-<*
2056 < Disable the recognition of special key codes in |<>|
2057 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002058 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 ":map X <Tab>" results in X being mapped to:
2060 '<' included: "<Tab>" (5 characters)
2061 '<' excluded: "^I" (^I is a real <Tab>)
2062 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002063 *cpo->*
2064 > When appending to a register, put a line break before
2065 the appended text.
2066
2067 POSIX flags. These are not included in the Vi default value, except
2068 when $VIM_POSIX was set on startup. |posix|
2069
2070 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002071 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002072 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002073 *cpo-&*
2074 & When ":preserve" was used keep the swap file when
2075 exiting normally while this buffer is still loaded.
2076 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002077 *cpo-\*
2078 \ Backslash in a [] range in a search pattern is taken
2079 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002080 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2081 '\' excluded: "/[ \-]" finds <Space> and '-'
2082 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002083 *cpo-/*
2084 / When "%" is used as the replacement string in a |:s|
2085 command, use the previous replacement string. |:s%|
2086 *cpo-{*
2087 { The |{| and |}| commands also stop at a "{" character
2088 at the start of a line.
2089 *cpo-.*
2090 . The ":chdir" and ":cd" commands fail if the current
2091 buffer is modified, unless ! is used. Vim doesn't
2092 need this, since it remembers the full path of an
2093 opened file.
2094 *cpo-bar*
2095 | The value of the $LINES and $COLUMNS environment
2096 variables overrule the terminal size values obtained
2097 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002098
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002100 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002101'cryptmethod' string (default "zip")
2102 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002103 {not in Vi}
2104 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002105 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002106 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002107 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002108 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002109 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002110 or later, files can NOT be read by Vim 7.2 and older.
2111 This adds a "seed" to the file, every time you write
2112 the file the encrypted bytes will be different.
2113
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002114 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002115 to the detected method of the file being read. Thus if you write it
2116 without changing 'cryptmethod' the same method will be used.
2117 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002118 explicitly write it, you don't get a warning unless there are other
2119 modifications. Also see |:X|.
2120
2121 When setting the global value to an empty string, it will end up with
2122 the value "zip". When setting the local value to an empty string the
2123 buffer will use the global value.
2124
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002125 When a new encryption method is added in a later version of Vim, and
2126 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002127 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002128
2129
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130 *'cscopepathcomp'* *'cspc'*
2131'cscopepathcomp' 'cspc' number (default 0)
2132 global
2133 {not available when compiled without the |+cscope|
2134 feature}
2135 {not in Vi}
2136 Determines how many components of the path to show in a list of tags.
2137 See |cscopepathcomp|.
2138
2139 *'cscopeprg'* *'csprg'*
2140'cscopeprg' 'csprg' string (default "cscope")
2141 global
2142 {not available when compiled without the |+cscope|
2143 feature}
2144 {not in Vi}
2145 Specifies the command to execute cscope. See |cscopeprg|.
2146 This option cannot be set from a |modeline| or in the |sandbox|, for
2147 security reasons.
2148
2149 *'cscopequickfix'* *'csqf'*
2150'cscopequickfix' 'csqf' string (default "")
2151 global
2152 {not available when compiled without the |+cscope|
2153 or |+quickfix| features}
2154 {not in Vi}
2155 Specifies whether to use quickfix window to show cscope results.
2156 See |cscopequickfix|.
2157
2158 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2159'cscopetag' 'cst' boolean (default off)
2160 global
2161 {not available when compiled without the |+cscope|
2162 feature}
2163 {not in Vi}
2164 Use cscope for tag commands. See |cscope-options|.
2165 NOTE: This option is reset when 'compatible' is set.
2166
2167 *'cscopetagorder'* *'csto'*
2168'cscopetagorder' 'csto' number (default 0)
2169 global
2170 {not available when compiled without the |+cscope|
2171 feature}
2172 {not in Vi}
2173 Determines the order in which ":cstag" performs a search. See
2174 |cscopetagorder|.
2175 NOTE: This option is set to 0 when 'compatible' is set.
2176
2177 *'cscopeverbose'* *'csverb'*
2178 *'nocscopeverbose'* *'nocsverb'*
2179'cscopeverbose' 'csverb' boolean (default off)
2180 global
2181 {not available when compiled without the |+cscope|
2182 feature}
2183 {not in Vi}
2184 Give messages when adding a cscope database. See |cscopeverbose|.
2185 NOTE: This option is reset when 'compatible' is set.
2186
Bram Moolenaar860cae12010-06-05 23:22:07 +02002187 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2188'cursorbind' 'crb' boolean (default off)
2189 local to window
2190 {not in Vi}
2191 {not available when compiled without the |+cursorbind|
2192 feature}
2193 When this option is set, as the cursor in the current
2194 window moves other cursorbound windows (windows that also have
2195 this option set) move their cursors to the corresponding line and
2196 column. This option is useful for viewing the
2197 differences between two versions of a file (see 'diff'); in diff mode,
2198 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002199 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002200
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002201
2202 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2203'cursorcolumn' 'cuc' boolean (default off)
2204 local to window
2205 {not in Vi}
2206 {not available when compiled without the |+syntax|
2207 feature}
2208 Highlight the screen column of the cursor with CursorColumn
2209 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2210 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002211 If you only want the highlighting in the current window you can use
2212 these autocommands: >
2213 au WinLeave * set nocursorline nocursorcolumn
2214 au WinEnter * set cursorline cursorcolumn
2215<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002216
2217 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2218'cursorline' 'cul' boolean (default off)
2219 local to window
2220 {not in Vi}
2221 {not available when compiled without the |+syntax|
2222 feature}
2223 Highlight the screen line of the cursor with CursorLine
2224 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2225 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002226 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002227 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002228
2229
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 *'debug'*
2231'debug' string (default "")
2232 global
2233 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002234 These values can be used:
2235 msg Error messages that would otherwise be omitted will be given
2236 anyway.
2237 throw Error messages that would otherwise be omitted will be given
2238 anyway and also throw an exception and set |v:errmsg|.
2239 beep A message will be given when otherwise only a beep would be
2240 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002241 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002242 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2243 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244
2245 *'define'* *'def'*
2246'define' 'def' string (default "^\s*#\s*define")
2247 global or local to buffer |global-local|
2248 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002249 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250 pattern, just like for the "/" command. This option is used for the
2251 commands like "[i" and "[d" |include-search|. The 'isident' option is
2252 used to recognize the defined name after the match:
2253 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2254 See |option-backslash| about inserting backslashes to include a space
2255 or backslash.
2256 The default value is for C programs. For C++ this value would be
2257 useful, to include const type declarations: >
2258 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2259< When using the ":set" command, you need to double the backslashes!
2260
2261 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2262'delcombine' 'deco' boolean (default off)
2263 global
2264 {not in Vi}
2265 {only available when compiled with the |+multi_byte|
2266 feature}
2267 If editing Unicode and this option is set, backspace and Normal mode
2268 "x" delete each combining character on its own. When it is off (the
2269 default) the character along with its combining characters are
2270 deleted.
2271 Note: When 'delcombine' is set "xx" may work different from "2x"!
2272
2273 This is useful for Arabic, Hebrew and many other languages where one
2274 may have combining characters overtop of base characters, and want
2275 to remove only the combining ones.
2276
2277 *'dictionary'* *'dict'*
2278'dictionary' 'dict' string (default "")
2279 global or local to buffer |global-local|
2280 {not in Vi}
2281 List of file names, separated by commas, that are used to lookup words
2282 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2283 contain a list of words. This can be one word per line, or several
2284 words per line, separated by non-keyword characters (white space is
2285 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002286 When this option is empty, or an entry "spell" is present, spell
2287 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002288 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289 after a comma are ignored, otherwise spaces are included in the file
2290 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002291 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002292 Where to find a list of words?
2293 - On FreeBSD, there is the file "/usr/share/dict/words".
2294 - In the Simtel archive, look in the "msdos/linguist" directory.
2295 - In "miscfiles" of the GNU collection.
2296 The use of |:set+=| and |:set-=| is preferred when adding or removing
2297 directories from the list. This avoids problems when a future version
2298 uses another default.
2299 Backticks cannot be used in this option for security reasons.
2300
2301 *'diff'* *'nodiff'*
2302'diff' boolean (default off)
2303 local to window
2304 {not in Vi}
2305 {not available when compiled without the |+diff|
2306 feature}
2307 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002308 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002309
2310 *'dex'* *'diffexpr'*
2311'diffexpr' 'dex' string (default "")
2312 global
2313 {not in Vi}
2314 {not available when compiled without the |+diff|
2315 feature}
2316 Expression which is evaluated to obtain an ed-style diff file from two
2317 versions of a file. See |diff-diffexpr|.
2318 This option cannot be set from a |modeline| or in the |sandbox|, for
2319 security reasons.
2320
2321 *'dip'* *'diffopt'*
2322'diffopt' 'dip' string (default "filler")
2323 global
2324 {not in Vi}
2325 {not available when compiled without the |+diff|
2326 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002327 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 All are optional. Items must be separated by a comma.
2329
2330 filler Show filler lines, to keep the text
2331 synchronized with a window that has inserted
2332 lines at the same position. Mostly useful
2333 when windows are side-by-side and 'scrollbind'
2334 is set.
2335
2336 context:{n} Use a context of {n} lines between a change
2337 and a fold that contains unchanged lines.
2338 When omitted a context of six lines is used.
2339 See |fold-diff|.
2340
2341 icase Ignore changes in case of text. "a" and "A"
2342 are considered the same. Adds the "-i" flag
2343 to the "diff" command if 'diffexpr' is empty.
2344
2345 iwhite Ignore changes in amount of white space. Adds
2346 the "-b" flag to the "diff" command if
2347 'diffexpr' is empty. Check the documentation
2348 of the "diff" command for what this does
2349 exactly. It should ignore adding trailing
2350 white space, but not leading white space.
2351
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002352 horizontal Start diff mode with horizontal splits (unless
2353 explicitly specified otherwise).
2354
2355 vertical Start diff mode with vertical splits (unless
2356 explicitly specified otherwise).
2357
2358 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2359 starting diff mode. Without this 2 is used.
2360
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361 Examples: >
2362
2363 :set diffopt=filler,context:4
2364 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002365 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366<
2367 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2368'digraph' 'dg' boolean (default off)
2369 global
2370 {not in Vi}
2371 {not available when compiled without the |+digraphs|
2372 feature}
2373 Enable the entering of digraphs in Insert mode with {char1} <BS>
2374 {char2}. See |digraphs|.
2375 NOTE: This option is reset when 'compatible' is set.
2376
2377 *'directory'* *'dir'*
2378'directory' 'dir' string (default for Amiga: ".,t:",
2379 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2380 for Unix: ".,~/tmp,/var/tmp,/tmp")
2381 global
2382 List of directory names for the swap file, separated with commas.
2383 - The swap file will be created in the first directory where this is
2384 possible.
2385 - Empty means that no swap file will be used (recovery is
2386 impossible!).
2387 - A directory "." means to put the swap file in the same directory as
2388 the edited file. On Unix, a dot is prepended to the file name, so
2389 it doesn't show in a directory listing. On MS-Windows the "hidden"
2390 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002391 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 put the swap file relative to where the edited file is. The leading
2393 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002394 - For Unix and Win32, if a directory ends in two path separators "//"
2395 or "\\", the swap file name will be built from the complete path to
2396 the file with all path separators substituted to percent '%' signs.
2397 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002398 On Win32, when a separating comma is following, you must use "//",
2399 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400 - Spaces after the comma are ignored, other spaces are considered part
2401 of the directory name. To have a space at the start of a directory
2402 name, precede it with a backslash.
2403 - To include a comma in a directory name precede it with a backslash.
2404 - A directory name may end in an ':' or '/'.
2405 - Environment variables are expanded |:set_env|.
2406 - Careful with '\' characters, type one before a space, type two to
2407 get one in the option (see |option-backslash|), for example: >
2408 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2409< - For backwards compatibility with Vim version 3.0 a '>' at the start
2410 of the option is removed.
2411 Using "." first in the list is recommended. This means that editing
2412 the same file twice will result in a warning. Using "/tmp" on Unix is
2413 discouraged: When the system crashes you lose the swap file.
2414 "/var/tmp" is often not cleared when rebooting, thus is a better
2415 choice than "/tmp". But it can contain a lot of files, your swap
2416 files get lost in the crowd. That is why a "tmp" directory in your
2417 home directory is tried first.
2418 The use of |:set+=| and |:set-=| is preferred when adding or removing
2419 directories from the list. This avoids problems when a future version
2420 uses another default.
2421 This option cannot be set from a |modeline| or in the |sandbox|, for
2422 security reasons.
2423 {Vi: directory to put temp file in, defaults to "/tmp"}
2424
2425 *'display'* *'dy'*
2426'display' 'dy' string (default "")
2427 global
2428 {not in Vi}
2429 Change the way text is displayed. This is comma separated list of
2430 flags:
2431 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002432 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002433 last line that doesn't fit is replaced with "@" lines.
2434 uhex Show unprintable characters hexadecimal as <xx>
2435 instead of using ^C and ~C.
2436
2437 *'eadirection'* *'ead'*
2438'eadirection' 'ead' string (default "both")
2439 global
2440 {not in Vi}
2441 {not available when compiled without the +vertsplit
2442 feature}
2443 Tells when the 'equalalways' option applies:
2444 ver vertically, width of windows is not affected
2445 hor horizontally, height of windows is not affected
2446 both width and height of windows is affected
2447
2448 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2449'edcompatible' 'ed' boolean (default off)
2450 global
2451 Makes the 'g' and 'c' flags of the ":substitute" command to be
2452 toggled each time the flag is given. See |complex-change|. See
2453 also 'gdefault' option.
2454 Switching this option on is discouraged!
2455
2456 *'encoding'* *'enc'* *E543*
2457'encoding' 'enc' string (default: "latin1" or value from $LANG)
2458 global
2459 {only available when compiled with the |+multi_byte|
2460 feature}
2461 {not in Vi}
2462 Sets the character encoding used inside Vim. It applies to text in
2463 the buffers, registers, Strings in expressions, text stored in the
2464 viminfo file, etc. It sets the kind of characters which Vim can work
2465 with. See |encoding-names| for the possible values.
2466
2467 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002468 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002469 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002470 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471
Bram Moolenaar865242e2010-07-14 21:12:05 +02002472 This option cannot be set from a |modeline|. It would most likely
2473 corrupt the text.
2474
Bram Moolenaar071d4272004-06-13 20:20:40 +00002475 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2476 "utf-8". Although care has been taken to allow different values of
2477 'encoding', "utf-8" is the natural choice for the environment and
2478 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002479 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002480 versions, and to avoid changing the encoding of newly created files
2481 without your knowledge (in case 'fileencodings' is empty).
2482
2483 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002484 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485 iconv() or as specified with 'charconvert'.
2486
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002487 If you need to know whether 'encoding' is a multi-byte encoding, you
2488 can use: >
2489 if has("multi_byte_encoding")
2490<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491 Normally 'encoding' will be equal to your current locale. This will
2492 be the default if Vim recognizes your environment settings. If
2493 'encoding' is not set to the current locale, 'termencoding' must be
2494 set to convert typed and displayed text. See |encoding-table|.
2495
2496 When you set this option, it fires the |EncodingChanged| autocommand
2497 event so that you can set up fonts if necessary.
2498
2499 When the option is set, the value is converted to lowercase. Thus
2500 you can set it with uppercase values too. Underscores are translated
2501 to '-' signs.
2502 When the encoding is recognized, it is changed to the standard name.
2503 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2504 "iso-8859-2" and "utf8" becomes "utf-8".
2505
2506 Note: "latin1" is also used when the encoding could not be detected.
2507 This only works when editing files in the same encoding! When the
2508 actual character set is not latin1, make sure 'fileencoding' and
2509 'fileencodings' are empty. When conversion is needed, switch to using
2510 utf-8.
2511
2512 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2513 You don't notice this while editing, but it does matter for the
2514 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2515 setting 'encoding' to one of these values instead of utf-8 only has
2516 effect for encoding used for files when 'fileencoding' is empty.
2517
Bram Moolenaar661b1822005-07-28 22:36:45 +00002518 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2519 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520
2521 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2522'endofline' 'eol' boolean (default on)
2523 local to buffer
2524 {not in Vi}
2525 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002526 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527 option is automatically set when starting to edit a new file, unless
2528 the file does not have an <EOL> for the last line in the file, in
2529 which case it is reset. Normally you don't have to set or reset this
2530 option. When 'binary' is off the value is not used when writing the
2531 file. When 'binary' is on it is used to remember the presence of a
2532 <EOL> for the last line in the file, so that when you write the file
2533 the situation from the original file can be kept. But you can change
2534 it if you want to.
2535
2536 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2537'equalalways' 'ea' boolean (default on)
2538 global
2539 {not in Vi}
2540 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002541 splitting or closing a window. This also happens the moment the
2542 option is switched on. When off, splitting a window will reduce the
2543 size of the current window and leave the other windows the same. When
2544 closing a window the extra lines are given to the window next to it
2545 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002546 When mixing vertically and horizontally split windows, a minimal size
2547 is computed and some windows may be larger if there is room. The
2548 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002549 Changing the height and width of a window can be avoided by setting
2550 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002551 If a window size is specified when creating a new window sizes are
2552 currently not equalized (it's complicated, but may be implemented in
2553 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002554
2555 *'equalprg'* *'ep'*
2556'equalprg' 'ep' string (default "")
2557 global or local to buffer |global-local|
2558 {not in Vi}
2559 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002560 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002561 or 'indentexpr'. When Vim was compiled without internal formatting,
2562 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002563 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 about including spaces and backslashes.
2565 This option cannot be set from a |modeline| or in the |sandbox|, for
2566 security reasons.
2567
2568 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2569'errorbells' 'eb' boolean (default off)
2570 global
2571 Ring the bell (beep or screen flash) for error messages. This only
2572 makes a difference for error messages, the bell will be used always
2573 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002574 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 screen flash or do nothing.
2576
2577 *'errorfile'* *'ef'*
2578'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2579 others: "errors.err")
2580 global
2581 {not in Vi}
2582 {not available when compiled without the |+quickfix|
2583 feature}
2584 Name of the errorfile for the QuickFix mode (see |:cf|).
2585 When the "-q" command-line argument is used, 'errorfile' is set to the
2586 following argument. See |-q|.
2587 NOT used for the ":make" command. See 'makeef' for that.
2588 Environment variables are expanded |:set_env|.
2589 See |option-backslash| about including spaces and backslashes.
2590 This option cannot be set from a |modeline| or in the |sandbox|, for
2591 security reasons.
2592
2593 *'errorformat'* *'efm'*
2594'errorformat' 'efm' string (default is very long)
2595 global or local to buffer |global-local|
2596 {not in Vi}
2597 {not available when compiled without the |+quickfix|
2598 feature}
2599 Scanf-like description of the format for the lines in the error file
2600 (see |errorformat|).
2601
2602 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2603'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2604 global
2605 {not in Vi}
2606 Function keys that start with an <Esc> are recognized in Insert
2607 mode. When this option is off, the cursor and function keys cannot be
2608 used in Insert mode if they start with an <Esc>. The advantage of
2609 this is that the single <Esc> is recognized immediately, instead of
2610 after one second. Instead of resetting this option, you might want to
2611 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2612 when 'esckeys' is off, you can still map anything, but the cursor keys
2613 won't work by default.
2614 NOTE: This option is set to the Vi default value when 'compatible' is
2615 set and to the Vim default value when 'compatible' is reset.
2616
2617 *'eventignore'* *'ei'*
2618'eventignore' 'ei' string (default "")
2619 global
2620 {not in Vi}
2621 {not available when compiled without the |+autocmd|
2622 feature}
2623 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002624 When set to "all" or when "all" is one of the items, all autocommand
2625 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626 Otherwise this is a comma separated list of event names. Example: >
2627 :set ei=WinEnter,WinLeave
2628<
2629 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2630'expandtab' 'et' boolean (default off)
2631 local to buffer
2632 {not in Vi}
2633 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002634 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2636 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2637 NOTE: This option is reset when 'compatible' is set.
2638
2639 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2640'exrc' 'ex' boolean (default off)
2641 global
2642 {not in Vi}
2643 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2644 directory. If you switch this option on you should also consider
2645 setting the 'secure' option (see |initialization|). Using a local
2646 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2647 also see |.vimrc| and |gui-init|.
2648 This option cannot be set from a |modeline| or in the |sandbox|, for
2649 security reasons.
2650
2651 *'fileencoding'* *'fenc'* *E213*
2652'fileencoding' 'fenc' string (default: "")
2653 local to buffer
2654 {only available when compiled with the |+multi_byte|
2655 feature}
2656 {not in Vi}
2657 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002658
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002660 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 When 'fileencoding' is empty, the same value as 'encoding' will be
2662 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002663 Conversion will also be done when 'encoding' and 'fileencoding' are
2664 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2665 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002666 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002667 'encoding' is "utf-8" or another Unicode encoding, conversion
2668 is most likely done in a way that the reverse conversion
2669 results in the same text. When 'encoding' is not "utf-8" some
2670 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002671
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672 See 'encoding' for the possible values. Additionally, values may be
2673 specified that can be handled by the converter, see
2674 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002675
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 When reading a file 'fileencoding' will be set from 'fileencodings'.
2677 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002678 'fileencoding', use the |++enc| argument. One exception: when
2679 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002680 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002681
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2683 When the option is set, the value is converted to lowercase. Thus
2684 you can set it with uppercase values too. '_' characters are
2685 replaced with '-'. If a name is recognized from the list for
2686 'encoding', it is replaced by the standard name. For example
2687 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002688
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689 When this option is set, after starting to edit a file, the 'modified'
2690 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002691
2692 Keep in mind that changing 'fenc' from a modeline happens
2693 AFTER the text has been read, thus it applies to when the file will be
2694 written. If you do set 'fenc' in a modeline, you might want to set
2695 'nomodified' to avoid not being able to ":q".
2696
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 This option can not be changed when 'modifiable' is off.
2698
2699 *'fe'*
2700 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002701 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 old short name was 'fe', which is no longer used.
2703
2704 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002705'fileencodings' 'fencs' string (default: "ucs-bom",
2706 "ucs-bom,utf-8,default,latin1" when
2707 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 global
2709 {only available when compiled with the |+multi_byte|
2710 feature}
2711 {not in Vi}
2712 This is a list of character encodings considered when starting to edit
2713 an existing file. When a file is read, Vim tries to use the first
2714 mentioned character encoding. If an error is detected, the next one
2715 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002716 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717 an empty string, which means the value of 'encoding' is used.
2718 WARNING: Conversion can cause loss of information! When
2719 'encoding' is "utf-8" (or one of the other Unicode variants)
2720 conversion is most likely done in a way that the reverse
2721 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002722 "utf-8" some non-ASCII characters may be lost! You can use
2723 the |++bad| argument to specify what is done with characters
2724 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 For an empty file or a file with only ASCII characters most encodings
2726 will work and the first entry of 'fileencodings' will be used (except
2727 "ucs-bom", which requires the BOM to be present). If you prefer
2728 another encoding use an BufReadPost autocommand event to test if your
2729 preferred encoding is to be used. Example: >
2730 au BufReadPost * if search('\S', 'w') == 0 |
2731 \ set fenc=iso-2022-jp | endif
2732< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2733 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002734 When the |++enc| argument is used then the value of 'fileencodings' is
2735 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002736 Note that 'fileencodings' is not used for a new file, the global value
2737 of 'fileencoding' is used instead. You can set it with: >
2738 :setglobal fenc=iso-8859-2
2739< This means that a non-existing file may get a different encoding than
2740 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741 The special value "ucs-bom" can be used to check for a Unicode BOM
2742 (Byte Order Mark) at the start of the file. It must not be preceded
2743 by "utf-8" or another Unicode encoding for this to work properly.
2744 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2745 because Vim cannot detect an error, thus the encoding is always
2746 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002747 The special value "default" can be used for the encoding from the
2748 environment. This is the default value for 'encoding'. It is useful
2749 when 'encoding' is set to "utf-8" and your environment uses a
2750 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002751 When 'encoding' is "utf-8" and a file contains an illegal byte
2752 sequence it won't be recognized as UTF-8. You can use the |8g8|
2753 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 WRONG VALUES: WHAT'S WRONG:
2755 latin1,utf-8 "latin1" will always be used
2756 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2757 file
2758 cp1250,latin1 "cp1250" will always be used
2759 If 'fileencodings' is empty, 'fileencoding' is not modified.
2760 See 'fileencoding' for the possible values.
2761 Setting this option does not have an effect until the next time a file
2762 is read.
2763
2764 *'fileformat'* *'ff'*
2765'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2766 Unix default: "unix",
2767 Macintosh default: "mac")
2768 local to buffer
2769 {not in Vi}
2770 This gives the <EOL> of the current buffer, which is used for
2771 reading/writing the buffer from/to a file:
2772 dos <CR> <NL>
2773 unix <NL>
2774 mac <CR>
2775 When "dos" is used, CTRL-Z at the end of a file is ignored.
2776 See |file-formats| and |file-read|.
2777 For the character encoding of the file see 'fileencoding'.
2778 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2779 works like it was set to "unix'.
2780 This option is set automatically when starting to edit a file and
2781 'fileformats' is not empty and 'binary' is off.
2782 When this option is set, after starting to edit a file, the 'modified'
2783 option is set, because the file would be different when written.
2784 This option can not be changed when 'modifiable' is off.
2785 For backwards compatibility: When this option is set to "dos",
2786 'textmode' is set, otherwise 'textmode' is reset.
2787
2788 *'fileformats'* *'ffs'*
2789'fileformats' 'ffs' string (default:
2790 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2791 Vim Unix: "unix,dos",
2792 Vim Mac: "mac,unix,dos",
2793 Vi Cygwin: "unix,dos",
2794 Vi others: "")
2795 global
2796 {not in Vi}
2797 This gives the end-of-line (<EOL>) formats that will be tried when
2798 starting to edit a new buffer and when reading a file into an existing
2799 buffer:
2800 - When empty, the format defined with 'fileformat' will be used
2801 always. It is not set automatically.
2802 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002803 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 'fileformats' name will be used when a file is read into an existing
2805 buffer, no matter what 'fileformat' for that buffer is set to.
2806 - When more than one name is present, separated by commas, automatic
2807 <EOL> detection will be done when reading a file. When starting to
2808 edit a file, a check is done for the <EOL>:
2809 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2810 'fileformat' is set to "dos".
2811 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002812 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002813 preceding <CR>, "unix" is preferred over "dos".
2814 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2815 This means that "mac" is only chosen when "unix" is not present,
2816 or when no <NL> is found in the file, and when "dos" is not
2817 present, or no <CR><NL> is present in the file.
2818 Also if "unix" was first chosen, but the first <CR> is before
2819 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2820 the file, then 'fileformat' is set to "mac".
2821 4. If 'fileformat' is still not set, the first name from
2822 'fileformats' is used.
2823 When reading a file into an existing buffer, the same is done, but
2824 this happens like 'fileformat' has been set appropriately for that
2825 file only, the option is not changed.
2826 When 'binary' is set, the value of 'fileformats' is not used.
2827
2828 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2829 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2830 done:
2831 - When 'fileformats' is empty, there is no automatic detection. Dos
2832 format will be used.
2833 - When 'fileformats' is set to one or more names, automatic detection
2834 is done. This is based on the first <NL> in the file: If there is a
2835 <CR> in front of it, Dos format is used, otherwise Unix format is
2836 used.
2837 Also see |file-formats|.
2838 For backwards compatibility: When this option is set to an empty
2839 string or one format (no comma is included), 'textauto' is reset,
2840 otherwise 'textauto' is set.
2841 NOTE: This option is set to the Vi default value when 'compatible' is
2842 set and to the Vim default value when 'compatible' is reset.
2843
2844 *'filetype'* *'ft'*
2845'filetype' 'ft' string (default: "")
2846 local to buffer
2847 {not in Vi}
2848 {not available when compiled without the |+autocmd|
2849 feature}
2850 When this option is set, the FileType autocommand event is triggered.
2851 All autocommands that match with the value of this option will be
2852 executed. Thus the value of 'filetype' is used in place of the file
2853 name.
2854 Otherwise this option does not always reflect the current file type.
2855 This option is normally set when the file type is detected. To enable
2856 this use the ":filetype on" command. |:filetype|
2857 Setting this option to a different value is most useful in a modeline,
2858 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002859 Example, for in an IDL file:
2860 /* vim: set filetype=idl : */ ~
2861 |FileType| |filetypes|
2862 When a dot appears in the value then this separates two filetype
2863 names. Example:
2864 /* vim: set filetype=c.doxygen : */ ~
2865 This will use the "c" filetype first, then the "doxygen" filetype.
2866 This works both for filetype plugins and for syntax files. More than
2867 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 Do not confuse this option with 'osfiletype', which is for the file
2869 type that is actually stored with the file.
2870 This option is not copied to another buffer, independent of the 's' or
2871 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002872 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873
2874 *'fillchars'* *'fcs'*
2875'fillchars' 'fcs' string (default "vert:|,fold:-")
2876 global
2877 {not in Vi}
2878 {not available when compiled without the |+windows|
2879 and |+folding| features}
2880 Characters to fill the statuslines and vertical separators.
2881 It is a comma separated list of items:
2882
2883 item default Used for ~
2884 stl:c ' ' or '^' statusline of the current window
2885 stlnc:c ' ' or '-' statusline of the non-current windows
2886 vert:c '|' vertical separators |:vsplit|
2887 fold:c '-' filling 'foldtext'
2888 diff:c '-' deleted lines of the 'diff' option
2889
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002890 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 "stlnc" the space will be used when there is highlighting, '^' or '-'
2892 otherwise.
2893
2894 Example: >
2895 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2896< This is similar to the default, except that these characters will also
2897 be used when there is highlighting.
2898
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002899 for "stl" and "stlnc" only single-byte values are supported.
2900
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 The highlighting used for these items:
2902 item highlight group ~
2903 stl:c StatusLine |hl-StatusLine|
2904 stlnc:c StatusLineNC |hl-StatusLineNC|
2905 vert:c VertSplit |hl-VertSplit|
2906 fold:c Folded |hl-Folded|
2907 diff:c DiffDelete |hl-DiffDelete|
2908
2909 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2910'fkmap' 'fk' boolean (default off) *E198*
2911 global
2912 {not in Vi}
2913 {only available when compiled with the |+rightleft|
2914 feature}
2915 When on, the keyboard is mapped for the Farsi character set.
2916 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002917 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918
2919 *'foldclose'* *'fcl'*
2920'foldclose' 'fcl' string (default "")
2921 global
2922 {not in Vi}
2923 {not available when compiled without the |+folding|
2924 feature}
2925 When set to "all", a fold is closed when the cursor isn't in it and
2926 its level is higher than 'foldlevel'. Useful if you want folds to
2927 automatically close when moving out of them.
2928
2929 *'foldcolumn'* *'fdc'*
2930'foldcolumn' 'fdc' number (default 0)
2931 local to window
2932 {not in Vi}
2933 {not available when compiled without the |+folding|
2934 feature}
2935 When non-zero, a column with the specified width is shown at the side
2936 of the window which indicates open and closed folds. The maximum
2937 value is 12.
2938 See |folding|.
2939
2940 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2941'foldenable' 'fen' boolean (default on)
2942 local to window
2943 {not in Vi}
2944 {not available when compiled without the |+folding|
2945 feature}
2946 When off, all folds are open. This option can be used to quickly
2947 switch between showing all text unfolded and viewing the text with
2948 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002949 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 'foldenable' is off.
2951 This option is set by commands that create a new fold or close a fold.
2952 See |folding|.
2953
2954 *'foldexpr'* *'fde'*
2955'foldexpr' 'fde' string (default: "0")
2956 local to window
2957 {not in Vi}
2958 {not available when compiled without the |+folding|
2959 or |+eval| feature}
2960 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002961 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002962
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002963 The expression may be evaluated in the |sandbox|, see
2964 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002965 This option can't be set from a |modeline| when the 'diff' option is
2966 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002967
2968 It is not allowed to change text or jump to another window while
2969 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970
2971 *'foldignore'* *'fdi'*
2972'foldignore' 'fdi' string (default: "#")
2973 local to window
2974 {not in Vi}
2975 {not available when compiled without the |+folding|
2976 feature}
2977 Used only when 'foldmethod' is "indent". Lines starting with
2978 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002979 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980 The default "#" works well for C programs. See |fold-indent|.
2981
2982 *'foldlevel'* *'fdl'*
2983'foldlevel' 'fdl' number (default: 0)
2984 local to window
2985 {not in Vi}
2986 {not available when compiled without the |+folding|
2987 feature}
2988 Sets the fold level: Folds with a higher level will be closed.
2989 Setting this option to zero will close all folds. Higher numbers will
2990 close fewer folds.
2991 This option is set by commands like |zm|, |zM| and |zR|.
2992 See |fold-foldlevel|.
2993
2994 *'foldlevelstart'* *'fdls'*
2995'foldlevelstart' 'fdls' number (default: -1)
2996 global
2997 {not in Vi}
2998 {not available when compiled without the |+folding|
2999 feature}
3000 Sets 'foldlevel' when starting to edit another buffer in a window.
3001 Useful to always start editing with all folds closed (value zero),
3002 some folds closed (one) or no folds closed (99).
3003 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003004 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 ignores this option and closes all folds.
3006 It is also done before BufReadPre autocommands, to allow an autocmd to
3007 overrule the 'foldlevel' value for specific files.
3008 When the value is negative, it is not used.
3009
3010 *'foldmarker'* *'fmr'* *E536*
3011'foldmarker' 'fmr' string (default: "{{{,}}}")
3012 local to window
3013 {not in Vi}
3014 {not available when compiled without the |+folding|
3015 feature}
3016 The start and end marker used when 'foldmethod' is "marker". There
3017 must be one comma, which separates the start and end marker. The
3018 marker is a literal string (a regular expression would be too slow).
3019 See |fold-marker|.
3020
3021 *'foldmethod'* *'fdm'*
3022'foldmethod' 'fdm' string (default: "manual")
3023 local to window
3024 {not in Vi}
3025 {not available when compiled without the |+folding|
3026 feature}
3027 The kind of folding used for the current window. Possible values:
3028 |fold-manual| manual Folds are created manually.
3029 |fold-indent| indent Lines with equal indent form a fold.
3030 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3031 |fold-marker| marker Markers are used to specify folds.
3032 |fold-syntax| syntax Syntax highlighting items specify folds.
3033 |fold-diff| diff Fold text that is not changed.
3034
3035 *'foldminlines'* *'fml'*
3036'foldminlines' 'fml' number (default: 1)
3037 local to window
3038 {not in Vi}
3039 {not available when compiled without the |+folding|
3040 feature}
3041 Sets the minimum number of screen lines for a fold to be displayed
3042 closed. Also for manually closed folds.
3043 Note that this only has an effect of what is displayed. After using
3044 "zc" to close a fold, which is displayed open because it's smaller
3045 than 'foldminlines', a following "zc" may close a containing fold.
3046
3047 *'foldnestmax'* *'fdn'*
3048'foldnestmax' 'fdn' number (default: 20)
3049 local to window
3050 {not in Vi}
3051 {not available when compiled without the |+folding|
3052 feature}
3053 Sets the maximum nesting of folds for the "indent" and "syntax"
3054 methods. This avoids that too many folds will be created. Using more
3055 than 20 doesn't work, because the internal limit is 20.
3056
3057 *'foldopen'* *'fdo'*
3058'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3059 search,tag,undo")
3060 global
3061 {not in Vi}
3062 {not available when compiled without the |+folding|
3063 feature}
3064 Specifies for which type of commands folds will be opened, if the
3065 command moves the cursor into a closed fold. It is a comma separated
3066 list of items.
3067 item commands ~
3068 all any
3069 block "(", "{", "[[", "[{", etc.
3070 hor horizontal movements: "l", "w", "fx", etc.
3071 insert any command in Insert mode
3072 jump far jumps: "G", "gg", etc.
3073 mark jumping to a mark: "'m", CTRL-O, etc.
3074 percent "%"
3075 quickfix ":cn", ":crew", ":make", etc.
3076 search search for a pattern: "/", "n", "*", "gd", etc.
3077 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003078 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 tag jumping to a tag: ":ta", CTRL-T, etc.
3080 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003081 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 the |zv| command to the mapping to get the same effect.
3083 When a movement command is used for an operator (e.g., "dl" or "y%")
3084 this option is not used. This means the operator will include the
3085 whole closed fold.
3086 Note that vertical movements are not here, because it would make it
3087 very difficult to move onto a closed fold.
3088 In insert mode the folds containing the cursor will always be open
3089 when text is inserted.
3090 To close folds you can re-apply 'foldlevel' with the |zx| command or
3091 set the 'foldclose' option to "all".
3092
3093 *'foldtext'* *'fdt'*
3094'foldtext' 'fdt' string (default: "foldtext()")
3095 local to window
3096 {not in Vi}
3097 {not available when compiled without the |+folding|
3098 feature}
3099 An expression which is used to specify the text displayed for a closed
3100 fold. See |fold-foldtext|.
3101
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003102 The expression may be evaluated in the |sandbox|, see
3103 |sandbox-option|.
3104
3105 It is not allowed to change text or jump to another window while
3106 evaluating 'foldtext' |textlock|.
3107
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 *'formatoptions'* *'fo'*
3109'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3110 local to buffer
3111 {not in Vi}
3112 This is a sequence of letters which describes how automatic
3113 formatting is to be done. See |fo-table|. When the 'paste' option is
3114 on, no formatting is done (like 'formatoptions' is empty). Commas can
3115 be inserted for readability.
3116 To avoid problems with flags that are added in the future, use the
3117 "+=" and "-=" feature of ":set" |add-option-flags|.
3118 NOTE: This option is set to the Vi default value when 'compatible' is
3119 set and to the Vim default value when 'compatible' is reset.
3120
Bram Moolenaar86b68352004-12-27 21:59:20 +00003121 *'formatlistpat'* *'flp'*
3122'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3123 local to buffer
3124 {not in Vi}
3125 A pattern that is used to recognize a list header. This is used for
3126 the "n" flag in 'formatoptions'.
3127 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003128 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003129 while still checking more characters. There must be a character
3130 following the pattern, when it matches the whole line it is handled
3131 like there is no match.
3132 The default recognizes a number, followed by an optional punctuation
3133 character and white space.
3134
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 *'formatprg'* *'fp'*
3136'formatprg' 'fp' string (default "")
3137 global
3138 {not in Vi}
3139 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003140 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003142 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003143 If the 'formatexpr' option is not empty it will be used instead.
3144 Otherwise, if 'formatprg' option is an empty string, the internal
3145 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003146 Environment variables are expanded |:set_env|. See |option-backslash|
3147 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003148 The expression may be evaluated in the |sandbox|, see
3149 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003151 *'formatexpr'* *'fex'*
3152'formatexpr' 'fex' string (default "")
3153 local to buffer
3154 {not in Vi}
3155 {not available when compiled without the |+eval|
3156 feature}
3157 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003158 operator or automatic formatting (see 'formatoptions'). When this
3159 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003160
3161 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003162 The |v:count| variable holds the number of lines to be formatted.
3163 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003164 inserted if the expression is being evaluated due to
3165 automatic formatting. This can be empty. Don't insert
3166 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003167
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003168 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003169 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003170< This will invoke the mylang#Format() function in the
3171 autoload/mylang.vim file in 'runtimepath'. |autoload|
3172
3173 The expression is also evaluated when 'textwidth' is set and adding
3174 text beyond that limit. This happens under the same conditions as
3175 when internal formatting is used. Make sure the cursor is kept in the
3176 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003177 return "i" or "R" in this situation.
3178
3179 When the expression evaluates to non-zero Vim will fall back to using
3180 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003181
3182 The expression may be evaluated in the |sandbox|, see
3183 |sandbox-option|.
3184
3185 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003186'fsync' 'fs' boolean (default on)
3187 global
3188 {not in Vi}
3189 When on, the library function fsync() will be called after writing a
3190 file. This will flush a file to disk, ensuring that it is safely
3191 written even on filesystems which do metadata-only journaling. This
3192 will force the harddrive to spin up on Linux systems running in laptop
3193 mode, so it may be undesirable in some situations. Be warned that
3194 turning this off increases the chances of data loss after a crash. On
3195 systems without an fsync() implementation, this variable is always
3196 off.
3197 Also see 'swapsync' for controlling fsync() on swap files.
3198
Bram Moolenaar071d4272004-06-13 20:20:40 +00003199 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3200'gdefault' 'gd' boolean (default off)
3201 global
3202 {not in Vi}
3203 When on, the ":substitute" flag 'g' is default on. This means that
3204 all matches in a line are substituted instead of one. When a 'g' flag
3205 is given to a ":substitute" command, this will toggle the substitution
3206 of all or one match. See |complex-change|.
3207
3208 command 'gdefault' on 'gdefault' off ~
3209 :s/// subst. all subst. one
3210 :s///g subst. one subst. all
3211 :s///gg subst. all subst. one
3212
3213 NOTE: This option is reset when 'compatible' is set.
3214
3215 *'grepformat'* *'gfm'*
3216'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3217 global
3218 {not in Vi}
3219 Format to recognize for the ":grep" command output.
3220 This is a scanf-like string that uses the same format as the
3221 'errorformat' option: see |errorformat|.
3222
3223 *'grepprg'* *'gp'*
3224'grepprg' 'gp' string (default "grep -n ",
3225 Unix: "grep -n $* /dev/null",
3226 Win32: "findstr /n" or "grep -n",
3227 VMS: "SEARCH/NUMBERS ")
3228 global or local to buffer |global-local|
3229 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003230 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231 and '#' characters, which are expanded like when used in a command-
3232 line. The placeholder "$*" is allowed to specify where the arguments
3233 will be included. Environment variables are expanded |:set_env|. See
3234 |option-backslash| about including spaces and backslashes.
3235 When your "grep" accepts the "-H" argument, use this to make ":grep"
3236 also work well with a single file: >
3237 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003238< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003239 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3240 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003241 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 apply equally to 'grepprg'.
3243 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3244 otherwise it's "grep -n".
3245 This option cannot be set from a |modeline| or in the |sandbox|, for
3246 security reasons.
3247
3248 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3249'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3250 ve:ver35-Cursor,
3251 o:hor50-Cursor,
3252 i-ci:ver25-Cursor/lCursor,
3253 r-cr:hor20-Cursor/lCursor,
3254 sm:block-Cursor
3255 -blinkwait175-blinkoff150-blinkon175",
3256 for MS-DOS and Win32 console:
3257 "n-v-c:block,o:hor50,i-ci:hor15,
3258 r-cr:hor30,sm:block")
3259 global
3260 {not in Vi}
3261 {only available when compiled with GUI enabled, and
3262 for MS-DOS and Win32 console}
3263 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003264 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 the height of the cursor can be changed. This can be done by
3266 specifying a block cursor, or a percentage for a vertical or
3267 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003268 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003270 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 mode-list and an argument-list:
3272 mode-list:argument-list,mode-list:argument-list,..
3273 The mode-list is a dash separated list of these modes:
3274 n Normal mode
3275 v Visual mode
3276 ve Visual mode with 'selection' "exclusive" (same as 'v',
3277 if not specified)
3278 o Operator-pending mode
3279 i Insert mode
3280 r Replace mode
3281 c Command-line Normal (append) mode
3282 ci Command-line Insert mode
3283 cr Command-line Replace mode
3284 sm showmatch in Insert mode
3285 a all modes
3286 The argument-list is a dash separated list of these arguments:
3287 hor{N} horizontal bar, {N} percent of the character height
3288 ver{N} vertical bar, {N} percent of the character width
3289 block block cursor, fills the whole character
3290 [only one of the above three should be present]
3291 blinkwait{N} *cursor-blinking*
3292 blinkon{N}
3293 blinkoff{N}
3294 blink times for cursor: blinkwait is the delay before
3295 the cursor starts blinking, blinkon is the time that
3296 the cursor is shown and blinkoff is the time that the
3297 cursor is not shown. The times are in msec. When one
3298 of the numbers is zero, there is no blinking. The
3299 default is: "blinkwait700-blinkon400-blinkoff250".
3300 These numbers are used for a missing entry. This
3301 means that blinking is enabled by default. To switch
3302 blinking off you can use "blinkon0". The cursor only
3303 blinks when Vim is waiting for input, not while
3304 executing a command.
3305 To make the cursor blink in an xterm, see
3306 |xterm-blink|.
3307 {group-name}
3308 a highlight group name, that sets the color and font
3309 for the cursor
3310 {group-name}/{group-name}
3311 Two highlight group names, the first is used when
3312 no language mappings are used, the other when they
3313 are. |language-mapping|
3314
3315 Examples of parts:
3316 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3317 block cursor with colors from the "nCursor"
3318 highlight group
3319 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3320 In Insert and Command-line Insert mode, use a
3321 30% vertical bar cursor with colors from the
3322 "iCursor" highlight group. Blink a bit
3323 faster.
3324
3325 The 'a' mode is different. It will set the given argument-list for
3326 all modes. It does not reset anything to defaults. This can be used
3327 to do a common setting for all modes. For example, to switch off
3328 blinking: "a:blinkon0"
3329
3330 Examples of cursor highlighting: >
3331 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3332 :highlight Cursor gui=NONE guifg=bg guibg=fg
3333<
3334 *'guifont'* *'gfn'*
3335 *E235* *E596* *E610* *E611*
3336'guifont' 'gfn' string (default "")
3337 global
3338 {not in Vi}
3339 {only available when compiled with GUI enabled}
3340 This is a list of fonts which will be used for the GUI version of Vim.
3341 In its simplest form the value is just one font name. When
3342 the font cannot be found you will get an error message. To try other
3343 font names a list can be specified, font names separated with commas.
3344 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003345
Bram Moolenaar05159a02005-02-26 23:04:13 +00003346 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3347 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003348
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 Spaces after a comma are ignored. To include a comma in a font name
3350 precede it with a backslash. Setting an option requires an extra
3351 backslash before a space and a backslash. See also
3352 |option-backslash|. For example: >
3353 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003354< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003356
3357 If none of the fonts can be loaded, Vim will keep the current setting.
3358 If an empty font list is given, Vim will try using other resource
3359 settings (for X, it will use the Vim.font resource), and finally it
3360 will try some builtin default which should always be there ("7x13" in
3361 the case of X). The font names given should be "normal" fonts. Vim
3362 will try to find the related bold and italic fonts.
3363
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003364 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003365 :set guifont=*
3366< will bring up a font requester, where you can pick the font you want.
3367
3368 The font name depends on the GUI used. See |setting-guifont| for a
3369 way to set 'guifont' for various systems.
3370
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371 For the GTK+ 2 GUI the font name looks like this: >
3372 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003373< That's all. XLFDs are not used. For Chinese this is reported to work
3374 well: >
3375 if has("gui_gtk2")
3376 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3377 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3378 endif
3379<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003380 For Mac OSX you can use something like this: >
3381 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003382< Also see 'macatsui', it can help fix display problems.
3383 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003385 width). An exception is GTK 2: all fonts are accepted, but
3386 mono-spaced fonts look best.
3387
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 To preview a font on X11, you might be able to use the "xfontsel"
3389 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003390
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 For the Win32 GUI *E244* *E245*
3392 - takes these options in the font name:
3393 hXX - height is XX (points, can be floating-point)
3394 wXX - width is XX (points, can be floating-point)
3395 b - bold
3396 i - italic
3397 u - underline
3398 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003399 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3401 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3402 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003403 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404
3405 Use a ':' to separate the options.
3406 - A '_' can be used in the place of a space, so you don't need to use
3407 backslashes to escape the spaces.
3408 - Examples: >
3409 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3410 :set guifont=Andale_Mono:h7.5:w4.5
3411< See also |font-sizes|.
3412
3413 *'guifontset'* *'gfs'*
3414 *E250* *E252* *E234* *E597* *E598*
3415'guifontset' 'gfs' string (default "")
3416 global
3417 {not in Vi}
3418 {only available when compiled with GUI enabled and
3419 with the |+xfontset| feature}
3420 {not available in the GTK+ 2 GUI}
3421 When not empty, specifies two (or more) fonts to be used. The first
3422 one for normal English, the second one for your special language. See
3423 |xfontset|.
3424 Setting this option also means that all font names will be handled as
3425 a fontset name. Also the ones used for the "font" argument of the
3426 |:highlight| command.
3427 The fonts must match with the current locale. If fonts for the
3428 character sets that the current locale uses are not included, setting
3429 'guifontset' will fail.
3430 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3431 the comma-separated names are alternative names, one of which will be
3432 used. In 'guifontset' the whole string is one fontset name,
3433 including the commas. It is not possible to specify alternative
3434 fontset names.
3435 This example works on many X11 systems: >
3436 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3437<
3438 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3439'guifontwide' 'gfw' string (default "")
3440 global
3441 {not in Vi}
3442 {only available when compiled with GUI enabled}
3443 When not empty, specifies a comma-separated list of fonts to be used
3444 for double-width characters. The first font that can be loaded is
3445 used.
3446 Note: The size of these fonts must be exactly twice as wide as the one
3447 specified with 'guifont' and the same height.
3448
3449 All GUI versions but GTK+ 2:
3450
3451 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3452 'guifontset' is empty or invalid.
3453 When 'guifont' is set and a valid font is found in it and
3454 'guifontwide' is empty Vim will attempt to find a matching
3455 double-width font and set 'guifontwide' to it.
3456
3457 GTK+ 2 GUI only: *guifontwide_gtk2*
3458
3459 If set and valid, 'guifontwide' is always used for double width
3460 characters, even if 'encoding' is not set to "utf-8".
3461 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003462 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 font for characters not available in 'guifont'. Thus you do not need
3464 to set 'guifontwide' at all unless you want to override the choice
3465 made by Pango/Xft.
3466
3467 *'guiheadroom'* *'ghr'*
3468'guiheadroom' 'ghr' number (default 50)
3469 global
3470 {not in Vi} {only for GTK and X11 GUI}
3471 The number of pixels subtracted from the screen height when fitting
3472 the GUI window on the screen. Set this before the GUI is started,
3473 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003474 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475 lines will be left for window decorations and other items on the
3476 screen. Set it to a negative value to allow windows taller than the
3477 screen.
3478
3479 *'guioptions'* *'go'*
3480'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003481 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 global
3483 {not in Vi}
3484 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003485 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 sequence of letters which describes what components and options of the
3487 GUI should be used.
3488 To avoid problems with flags that are added in the future, use the
3489 "+=" and "-=" feature of ":set" |add-option-flags|.
3490
3491 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003492 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 'a' Autoselect: If present, then whenever VISUAL mode is started,
3494 or the Visual area extended, Vim tries to become the owner of
3495 the windowing system's global selection. This means that the
3496 Visually highlighted text is available for pasting into other
3497 applications as well as into Vim itself. When the Visual mode
3498 ends, possibly due to an operation on the text, or when an
3499 application wants to paste the selection, the highlighted text
3500 is automatically yanked into the "* selection register.
3501 Thus the selection is still available for pasting into other
3502 applications after the VISUAL mode has ended.
3503 If not present, then Vim won't become the owner of the
3504 windowing system's global selection unless explicitly told to
3505 by a yank or delete operation for the "* register.
3506 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003507 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003508 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 applies to the modeless selection.
3510
3511 'guioptions' autoselect Visual autoselect modeless ~
3512 "" - -
3513 "a" yes yes
3514 "A" - yes
3515 "aA" yes yes
3516
Bram Moolenaar02467872007-05-06 13:22:01 +00003517 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 'c' Use console dialogs instead of popup dialogs for simple
3519 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003520 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003521 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003522 'guitablabel' can be used to change the text in the labels.
3523 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003524 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003525 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003526 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 'f' Foreground: Don't use fork() to detach the GUI from the shell
3528 where it was started. Use this for programs that wait for the
3529 editor to finish (e.g., an e-mail program). Alternatively you
3530 can use "gvim -f" or ":gui -f" to start the GUI in the
3531 foreground. |gui-fork|
3532 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003533 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003534 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3536 corner of the window. It's black&white on non-GTK, because of
3537 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003538 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003540 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003541 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003543 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 file is sourced the system menu has already been loaded; the
3545 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003546 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 'g' Grey menu items: Make menu items that are not active grey. If
3548 'g' is not included inactive menu items are not shown at all.
3549 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003550 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 't' Include tearoff menu items. Currently only works for Win32,
3552 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003553 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003554 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003555 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003556 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003558 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 'R' Right-hand scrollbar is present when there is a vertically
3560 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003561 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003563 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 'L' Left-hand scrollbar is present when there is a vertically
3565 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003566 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3568 the longest visible line, or on the cursor line if the 'h'
3569 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003570 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 'h' Limit horizontal scrollbar size to the length of the cursor
3572 line. Reduces computations. |gui-horiz-scroll|
3573
3574 And yes, you may even have scrollbars on the left AND the right if
3575 you really want to :-). See |gui-scrollbars| for more information.
3576
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003577 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 'v' Use a vertical button layout for dialogs. When not included,
3579 a horizontal layout is preferred, but when it doesn't fit a
3580 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003581 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 'p' Use Pointer callbacks for X11 GUI. This is required for some
3583 window managers. If the cursor is not blinking or hollow at
3584 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003585 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003587 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003588 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589
Bram Moolenaar02467872007-05-06 13:22:01 +00003590
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591 *'guipty'* *'noguipty'*
3592'guipty' boolean (default on)
3593 global
3594 {not in Vi}
3595 {only available when compiled with GUI enabled}
3596 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3597 I/O to/from shell commands. See |gui-pty|.
3598
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003599 *'guitablabel'* *'gtl'*
3600'guitablabel' 'gtl' string (default empty)
3601 global
3602 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003603 {only available when compiled with GUI enabled and
3604 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003605 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003606 pages line. When empty and when the result is empty Vim will use a
3607 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003608
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003609 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003610 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003611
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003612 Only used when the GUI tab pages line is displayed. 'e' must be
3613 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3614 used.
3615
Bram Moolenaar57657d82006-04-21 22:12:41 +00003616 *'guitabtooltip'* *'gtt'*
3617'guitabtooltip' 'gtt' string (default empty)
3618 global
3619 {not in Vi}
3620 {only available when compiled with GUI enabled and
3621 with the +windows feature}
3622 When nonempty describes the text to use in a tooltip for the GUI tab
3623 pages line. When empty Vim will use a default tooltip.
3624 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003625 You can include a line break. Simplest method is to use |:let|: >
3626 :let &guitabtooltip = "line one\nline two"
3627<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003628
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629 *'helpfile'* *'hf'*
3630'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3631 (others) "$VIMRUNTIME/doc/help.txt")
3632 global
3633 {not in Vi}
3634 Name of the main help file. All distributed help files should be
3635 placed together in one directory. Additionally, all "doc" directories
3636 in 'runtimepath' will be used.
3637 Environment variables are expanded |:set_env|. For example:
3638 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003639 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 spaces and backslashes.
3641 This option cannot be set from a |modeline| or in the |sandbox|, for
3642 security reasons.
3643
3644 *'helpheight'* *'hh'*
3645'helpheight' 'hh' number (default 20)
3646 global
3647 {not in Vi}
3648 {not available when compiled without the +windows
3649 feature}
3650 Minimal initial height of the help window when it is opened with the
3651 ":help" command. The initial height of the help window is half of the
3652 current window, or (when the 'ea' option is on) the same as other
3653 windows. When the height is less than 'helpheight', the height is
3654 set to 'helpheight'. Set to zero to disable.
3655
3656 *'helplang'* *'hlg'*
3657'helplang' 'hlg' string (default: messages language or empty)
3658 global
3659 {only available when compiled with the |+multi_lang|
3660 feature}
3661 {not in Vi}
3662 Comma separated list of languages. Vim will use the first language
3663 for which the desired help can be found. The English help will always
3664 be used as a last resort. You can add "en" to prefer English over
3665 another language, but that will only find tags that exist in that
3666 language and not in the English help.
3667 Example: >
3668 :set helplang=de,it
3669< This will first search German, then Italian and finally English help
3670 files.
3671 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3672 try to find the tag in the current language before using this option.
3673 See |help-translated|.
3674
3675 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3676'hidden' 'hid' boolean (default off)
3677 global
3678 {not in Vi}
3679 When off a buffer is unloaded when it is |abandon|ed. When on a
3680 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3681 displayed in another window, it does not become hidden, of course.
3682 The commands that move through the buffer list sometimes make a buffer
3683 hidden although the 'hidden' option is off: When the buffer is
3684 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003685 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003686 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 This option is set for one command with ":hide {command}" |:hide|.
3688 WARNING: It's easy to forget that you have changes in hidden buffers.
3689 Think twice when using ":q!" or ":qa!".
3690
3691 *'highlight'* *'hl'*
3692'highlight' 'hl' string (default (as a single string):
3693 "8:SpecialKey,@:NonText,d:Directory,
3694 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3695 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003696 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3698 f:Folded,F:FoldColumn,A:DiffAdd,
3699 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003700 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003701 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003702 +:Pmenu,=:PmenuSel,
3703 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 global
3705 {not in Vi}
3706 This option can be used to set highlighting mode for various
3707 occasions. It is a comma separated list of character pairs. The
3708 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003709 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3711 |hl-NonText| @ '~' and '@' at the end of the window and
3712 characters from 'showbreak'
3713 |hl-Directory| d directories in CTRL-D listing and other special
3714 things in listings
3715 |hl-ErrorMsg| e error messages
3716 h (obsolete, ignored)
3717 |hl-IncSearch| i 'incsearch' highlighting
3718 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3719 |hl-MoreMsg| m |more-prompt|
3720 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003721 |hl-LineNr| n line number for ":number" and ":#" commands, and
3722 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 |hl-Question| r |hit-enter| prompt and yes/no questions
3724 |hl-StatusLine| s status line of current window |status-line|
3725 |hl-StatusLineNC| S status lines of not-current windows
3726 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3727 |hl-VertSplit| c column used to separate vertically split windows
3728 |hl-Visual| v Visual mode
3729 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3730 Selection" Only X11 Gui's |gui-x11| and
3731 |xterm-clipboard|.
3732 |hl-WarningMsg| w warning messages
3733 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3734 |hl-Folded| f line used for closed folds
3735 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003736 |hl-DiffAdd| A added line in diff mode
3737 |hl-DiffChange| C changed line in diff mode
3738 |hl-DiffDelete| D deleted line in diff mode
3739 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003741 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003742 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003743 |hl-SpellRare| R rare word |spell|
3744 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003745 |hl-Conceal| - the placeholders used for concealed characters
3746 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003747 |hl-Pmenu| + popup menu normal line
3748 |hl-PmenuSel| = popup menu normal line
3749 |hl-PmenuSbar| x popup menu scrollbar
3750 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751
3752 The display modes are:
3753 r reverse (termcap entry "mr" and "me")
3754 i italic (termcap entry "ZH" and "ZR")
3755 b bold (termcap entry "md" and "me")
3756 s standout (termcap entry "so" and "se")
3757 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003758 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 n no highlighting
3760 - no highlighting
3761 : use a highlight group
3762 The default is used for occasions that are not included.
3763 If you want to change what the display modes do, see |dos-colors|
3764 for an example.
3765 When using the ':' display mode, this must be followed by the name of
3766 a highlight group. A highlight group can be used to define any type
3767 of highlighting, including using color. See |:highlight| on how to
3768 define one. The default uses a different group for each occasion.
3769 See |highlight-default| for the default highlight groups.
3770
3771 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3772'hlsearch' 'hls' boolean (default off)
3773 global
3774 {not in Vi}
3775 {not available when compiled without the
3776 |+extra_search| feature}
3777 When there is a previous search pattern, highlight all its matches.
3778 The type of highlighting used can be set with the 'l' occasion in the
3779 'highlight' option. This uses the "Search" highlight group by
3780 default. Note that only the matching text is highlighted, any offsets
3781 are not applied.
3782 See also: 'incsearch' and |:match|.
3783 When you get bored looking at the highlighted matches, you can turn it
3784 off with |:nohlsearch|. As soon as you use a search command, the
3785 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003786 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 When the search pattern can match an end-of-line, Vim will try to
3788 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003789 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003791 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 NOTE: This option is reset when 'compatible' is set.
3793
3794 *'history'* *'hi'*
3795'history' 'hi' number (Vim default: 20, Vi default: 0)
3796 global
3797 {not in Vi}
3798 A history of ":" commands, and a history of previous search patterns
3799 are remembered. This option decides how many entries may be stored in
3800 each of these histories (see |cmdline-editing|).
3801 NOTE: This option is set to the Vi default value when 'compatible' is
3802 set and to the Vim default value when 'compatible' is reset.
3803
3804 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3805'hkmap' 'hk' boolean (default off)
3806 global
3807 {not in Vi}
3808 {only available when compiled with the |+rightleft|
3809 feature}
3810 When on, the keyboard is mapped for the Hebrew character set.
3811 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3812 toggle this option. See |rileft.txt|.
3813 NOTE: This option is reset when 'compatible' is set.
3814
3815 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3816'hkmapp' 'hkp' boolean (default off)
3817 global
3818 {not in Vi}
3819 {only available when compiled with the |+rightleft|
3820 feature}
3821 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3822 This is useful if you have a non-Hebrew keyboard.
3823 See |rileft.txt|.
3824 NOTE: This option is reset when 'compatible' is set.
3825
3826 *'icon'* *'noicon'*
3827'icon' boolean (default off, on when title can be restored)
3828 global
3829 {not in Vi}
3830 {not available when compiled without the |+title|
3831 feature}
3832 When on, the icon text of the window will be set to the value of
3833 'iconstring' (if it is not empty), or to the name of the file
3834 currently being edited. Only the last part of the name is used.
3835 Overridden by the 'iconstring' option.
3836 Only works if the terminal supports setting window icons (currently
3837 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3838 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3839 builtin termcap).
3840 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003841 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842 X11.
3843
3844 *'iconstring'*
3845'iconstring' string (default "")
3846 global
3847 {not in Vi}
3848 {not available when compiled without the |+title|
3849 feature}
3850 When this option is not empty, it will be used for the icon text of
3851 the window. This happens only when the 'icon' option is on.
3852 Only works if the terminal supports setting window icon text
3853 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3854 Does not work for MS Windows.
3855 When Vim was compiled with HAVE_X11 defined, the original icon will be
3856 restored if possible |X11|.
3857 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003858 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 'titlestring' for example settings.
3860 {not available when compiled without the |+statusline| feature}
3861
3862 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3863'ignorecase' 'ic' boolean (default off)
3864 global
3865 Ignore case in search patterns. Also used when searching in the tags
3866 file.
3867 Also see 'smartcase'.
3868 Can be overruled by using "\c" or "\C" in the pattern, see
3869 |/ignorecase|.
3870
3871 *'imactivatekey'* *'imak'*
3872'imactivatekey' 'imak' string (default "")
3873 global
3874 {not in Vi}
3875 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003876 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 Specifies the key that your Input Method in X-Windows uses for
3878 activation. When this is specified correctly, vim can fully control
3879 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3880 You can't use this option to change the activation key, the option
3881 tells Vim what the key is.
3882 Format:
3883 [MODIFIER_FLAG-]KEY_STRING
3884
3885 These characters can be used for MODIFIER_FLAG (case is ignored):
3886 S Shift key
3887 L Lock key
3888 C Control key
3889 1 Mod1 key
3890 2 Mod2 key
3891 3 Mod3 key
3892 4 Mod4 key
3893 5 Mod5 key
3894 Combinations are allowed, for example "S-C-space" or "SC-space" are
3895 both shift+ctrl+space.
3896 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3897
3898 Example: >
3899 :set imactivatekey=S-space
3900< "S-space" means shift+space. This is the activation key for kinput2 +
3901 canna (Japanese), and ami (Korean).
3902
3903 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3904'imcmdline' 'imc' boolean (default off)
3905 global
3906 {not in Vi}
3907 {only available when compiled with the |+xim|
3908 |+multi_byte_ime| or |global-ime| feature}
3909 When set the Input Method is always on when starting to edit a command
3910 line, unless entering a search pattern (see 'imsearch' for that).
3911 Setting this option is useful when your input method allows entering
3912 English characters directly, e.g., when it's used to type accented
3913 characters with dead keys.
3914
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003915 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3917 global
3918 {not in Vi}
3919 {only available when compiled with the |+xim|
3920 |+multi_byte_ime| or |global-ime| feature}
3921 When set the Input Method is never used. This is useful to disable
3922 the IM when it doesn't work properly.
3923 Currently this option is on by default for SGI/IRIX machines. This
3924 may change in later releases.
3925
3926 *'iminsert'* *'imi'*
3927'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3928 local to buffer
3929 {not in Vi}
3930 Specifies whether :lmap or an Input Method (IM) is to be used in
3931 Insert mode. Valid values:
3932 0 :lmap is off and IM is off
3933 1 :lmap is ON and IM is off
3934 2 :lmap is off and IM is ON
3935 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3936 or |global-ime|.
3937 To always reset the option to zero when leaving Insert mode with <Esc>
3938 this can be used: >
3939 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3940< This makes :lmap and IM turn off automatically when leaving Insert
3941 mode.
3942 Note that this option changes when using CTRL-^ in Insert mode
3943 |i_CTRL-^|.
3944 The value is set to 1 when setting 'keymap' to a valid keymap name.
3945 It is also used for the argument of commands like "r" and "f".
3946 The value 0 may not work correctly with Athena and Motif with some XIM
3947 methods. Use 'imdisable' to disable XIM then.
3948
3949 *'imsearch'* *'ims'*
3950'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3951 local to buffer
3952 {not in Vi}
3953 Specifies whether :lmap or an Input Method (IM) is to be used when
3954 entering a search pattern. Valid values:
3955 -1 the value of 'iminsert' is used, makes it look like
3956 'iminsert' is also used when typing a search pattern
3957 0 :lmap is off and IM is off
3958 1 :lmap is ON and IM is off
3959 2 :lmap is off and IM is ON
3960 Note that this option changes when using CTRL-^ in Command-line mode
3961 |c_CTRL-^|.
3962 The value is set to 1 when it is not -1 and setting the 'keymap'
3963 option to a valid keymap name.
3964 The value 0 may not work correctly with Athena and Motif with some XIM
3965 methods. Use 'imdisable' to disable XIM then.
3966
3967 *'include'* *'inc'*
3968'include' 'inc' string (default "^\s*#\s*include")
3969 global or local to buffer |global-local|
3970 {not in Vi}
3971 {not available when compiled without the
3972 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003973 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974 pattern, just like for the "/" command (See |pattern|). The default
3975 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003976 "]I", "[d", etc.
3977 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003978 comes after the matched pattern. But if "\zs" appears in the pattern
3979 then the text matched from "\zs" to the end, or until "\ze" if it
3980 appears, is used as the file name. Use this to include characters
3981 that are not in 'isfname', such as a space. You can then use
3982 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003983 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984
3985 *'includeexpr'* *'inex'*
3986'includeexpr' 'inex' string (default "")
3987 local to buffer
3988 {not in Vi}
3989 {not available when compiled without the
3990 |+find_in_path| or |+eval| feature}
3991 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003992 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993 :set includeexpr=substitute(v:fname,'\\.','/','g')
3994< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003995
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003997 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 Also used for |<cfile>|.
3999
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004000 The expression may be evaluated in the |sandbox|, see
4001 |sandbox-option|.
4002
4003 It is not allowed to change text or jump to another window while
4004 evaluating 'includeexpr' |textlock|.
4005
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4007'incsearch' 'is' boolean (default off)
4008 global
4009 {not in Vi}
4010 {not available when compiled without the
4011 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004012 While typing a search command, show where the pattern, as it was typed
4013 so far, matches. The matched string is highlighted. If the pattern
4014 is invalid or not found, nothing is shown. The screen will be updated
4015 often, this is only useful on fast terminals.
4016 Note that the match will be shown, but the cursor will return to its
4017 original position when no match is found and when pressing <Esc>. You
4018 still need to finish the search command with <Enter> to move the
4019 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004020 When compiled with the |+reltime| feature Vim only searches for about
4021 half a second. With a complicated pattern and/or a lot of text the
4022 match may not be found. This is to avoid that Vim hangs while you
4023 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004024 The highlighting can be set with the 'i' flag in 'highlight'.
4025 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004026 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004027 to the command line. If 'ignorecase' and 'smartcase' are set and the
4028 command line has no uppercase characters, the added character is
4029 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004030 CTRL-R CTRL-W can be used to add the word at the end of the current
4031 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 NOTE: This option is reset when 'compatible' is set.
4033
4034 *'indentexpr'* *'inde'*
4035'indentexpr' 'inde' string (default "")
4036 local to buffer
4037 {not in Vi}
4038 {not available when compiled without the |+cindent|
4039 or |+eval| features}
4040 Expression which is evaluated to obtain the proper indent for a line.
4041 It is used when a new line is created, for the |=| operator and
4042 in Insert mode as specified with the 'indentkeys' option.
4043 When this option is not empty, it overrules the 'cindent' and
4044 'smartindent' indenting.
4045 When 'paste' is set this option is not used for indenting.
4046 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004047 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 when the expression is evaluated (but it may be moved around).
4049 The expression must return the number of spaces worth of indent. It
4050 can return "-1" to keep the current indent (this means 'autoindent' is
4051 used for the indent).
4052 Functions useful for computing the indent are |indent()|, |cindent()|
4053 and |lispindent()|.
4054 The evaluation of the expression must not have side effects! It must
4055 not change the text, jump to another window, etc. Afterwards the
4056 cursor position is always restored, thus the cursor may be moved.
4057 Normally this option would be set to call a function: >
4058 :set indentexpr=GetMyIndent()
4059< Error messages will be suppressed, unless the 'debug' option contains
4060 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004061 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 NOTE: This option is made empty when 'compatible' is set.
4063
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004064 The expression may be evaluated in the |sandbox|, see
4065 |sandbox-option|.
4066
4067 It is not allowed to change text or jump to another window while
4068 evaluating 'indentexpr' |textlock|.
4069
4070
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 *'indentkeys'* *'indk'*
4072'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4073 local to buffer
4074 {not in Vi}
4075 {not available when compiled without the |+cindent|
4076 feature}
4077 A list of keys that, when typed in Insert mode, cause reindenting of
4078 the current line. Only happens if 'indentexpr' isn't empty.
4079 The format is identical to 'cinkeys', see |indentkeys-format|.
4080 See |C-indenting| and |indent-expression|.
4081
4082 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4083'infercase' 'inf' boolean (default off)
4084 local to buffer
4085 {not in Vi}
4086 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004087 'ignorecase' is also on, the case of the match is adjusted depending
4088 on the typed text. If the typed text contains a lowercase letter
4089 where the match has an upper case letter, the completed part is made
4090 lowercase. If the typed text has no lowercase letters and the match
4091 has a lowercase letter where the typed text has an uppercase letter,
4092 and there is a letter before it, the completed part is made uppercase.
4093 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094
4095 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4096'insertmode' 'im' boolean (default off)
4097 global
4098 {not in Vi}
4099 Makes Vim work in a way that Insert mode is the default mode. Useful
4100 if you want to use Vim as a modeless editor. Used for |evim|.
4101 These Insert mode commands will be useful:
4102 - Use the cursor keys to move around.
4103 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4104 this is a mapping, it is executed as if 'insertmode' was off.
4105 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004107 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4108 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109
4110 These items change when 'insertmode' is set:
4111 - when starting to edit of a file, Vim goes to Insert mode.
4112 - <Esc> in Insert mode is a no-op and beeps.
4113 - <Esc> in Normal mode makes Vim go to Insert mode.
4114 - CTRL-L in Insert mode is a command, it is not inserted.
4115 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4116 However, when <Esc> is used inside a mapping, it behaves like
4117 'insertmode' was not set. This was done to be able to use the same
4118 mappings with 'insertmode' set or not set.
4119 When executing commands with |:normal| 'insertmode' is not used.
4120
4121 NOTE: This option is reset when 'compatible' is set.
4122
4123 *'isfname'* *'isf'*
4124'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4125 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4126 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4127 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4128 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4129 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4130 global
4131 {not in Vi}
4132 The characters specified by this option are included in file names and
4133 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004134 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 Multi-byte characters 256 and above are always included, only the
4136 characters up to 255 are specified with this option.
4137 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004138 Think twice before adding white space to this option. Although a
4139 space may appear inside a file name, the effect will be that Vim
4140 doesn't know where a file name starts or ends when doing completion.
4141 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142
4143 Note that on systems using a backslash as path separator, Vim tries to
4144 do its best to make it work as you would expect. That is a bit
4145 tricky, since Vi originally used the backslash to escape special
4146 characters. Vim will not remove a backslash in front of a normal file
4147 name character on these systems, but it will on Unix and alikes. The
4148 '&' and '^' are not included by default, because these are special for
4149 cmd.exe.
4150
4151 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004152 Each part can be a single character number or a range. A range is two
4153 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 decimal number between 0 and 255 or the ASCII character itself (does
4155 not work for digits). Example:
4156 "_,-,128-140,#-43" (include '_' and '-' and the range
4157 128 to 140 and '#' to 43)
4158 If a part starts with '^', the following character number or range
4159 will be excluded from the option. The option is interpreted from left
4160 to right. Put the excluded character after the range where it is
4161 included. To include '^' itself use it as the last character of the
4162 option or the end of a range. Example:
4163 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4164 If the character is '@', all characters where isalpha() returns TRUE
4165 are included. Normally these are the characters a to z and A to Z,
4166 plus accented characters. To include '@' itself use "@-@". Examples:
4167 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004168 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 "a-z,A-Z,@-@" All letters plus the '@' character.
4170 A comma can be included by using it where a character number is
4171 expected. Example:
4172 "48-57,,,_" Digits, comma and underscore.
4173 A comma can be excluded by prepending a '^'. Example:
4174 " -~,^,,9" All characters from space to '~', excluding
4175 comma, plus <Tab>.
4176 See |option-backslash| about including spaces and backslashes.
4177
4178 *'isident'* *'isi'*
4179'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4180 "@,48-57,_,128-167,224-235"
4181 otherwise: "@,48-57,_,192-255")
4182 global
4183 {not in Vi}
4184 The characters given by this option are included in identifiers.
4185 Identifiers are used in recognizing environment variables and after a
4186 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004187 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188 option.
4189 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004190 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4192
4193 *'iskeyword'* *'isk'*
4194'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4195 "@,48-57,_,128-167,224-235"
4196 otherwise: "@,48-57,_,192-255"
4197 Vi default: "@,48-57,_")
4198 local to buffer
4199 {not in Vi}
4200 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004201 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 'isfname' for a description of the format of this option. For C
4203 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4204 For a help file it is set to all non-blank printable characters except
4205 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4206 command).
4207 When the 'lisp' option is on the '-' character is always included.
4208 NOTE: This option is set to the Vi default value when 'compatible' is
4209 set and to the Vim default value when 'compatible' is reset.
4210
4211 *'isprint'* *'isp'*
4212'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4213 "@,~-255"; otherwise: "@,161-255")
4214 global
4215 {not in Vi}
4216 The characters given by this option are displayed directly on the
4217 screen. It is also used for "\p" in a |pattern|. The characters from
4218 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4219 even when they are not included in 'isprint' or excluded. See
4220 'isfname' for a description of the format of this option.
4221
4222 Non-printable characters are displayed with two characters:
4223 0 - 31 "^@" - "^_"
4224 32 - 126 always single characters
4225 127 "^?"
4226 128 - 159 "~@" - "~_"
4227 160 - 254 "| " - "|~"
4228 255 "~?"
4229 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4230 displayed as <xx>, with the hexadecimal value of the byte.
4231 When 'display' contains "uhex" all unprintable characters are
4232 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004233 The SpecialKey highlighting will be used for unprintable characters.
4234 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235
4236 Multi-byte characters 256 and above are always included, only the
4237 characters up to 255 are specified with this option. When a character
4238 is printable but it is not available in the current font, a
4239 replacement character will be shown.
4240 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4241 There is no option to specify these characters.
4242
4243 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4244'joinspaces' 'js' boolean (default on)
4245 global
4246 {not in Vi}
4247 Insert two spaces after a '.', '?' and '!' with a join command.
4248 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4249 Otherwise only one space is inserted.
4250 NOTE: This option is set when 'compatible' is set.
4251
4252 *'key'*
4253'key' string (default "")
4254 local to buffer
4255 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004256 {only available when compiled with the |+cryptv|
4257 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004259 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260 Careful: Do not set the key value by hand, someone might see the typed
4261 key. Use the |:X| command. But you can make 'key' empty: >
4262 :set key=
4263< It is not possible to get the value of this option with ":set key" or
4264 "echo &key". This is to avoid showing it to someone who shouldn't
4265 know. It also means you cannot see it yourself once you have set it,
4266 be careful not to make a typing error!
4267
4268 *'keymap'* *'kmp'* *E544*
4269'keymap' 'kmp' string (default "")
4270 local to buffer
4271 {not in Vi}
4272 {only available when compiled with the |+keymap|
4273 feature}
4274 Name of a keyboard mapping. See |mbyte-keymap|.
4275 Setting this option to a valid keymap name has the side effect of
4276 setting 'iminsert' to one, so that the keymap becomes effective.
4277 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004278 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279
4280 *'keymodel'* *'km'*
4281'keymodel' 'km' string (default "")
4282 global
4283 {not in Vi}
4284 List of comma separated words, which enable special things that keys
4285 can do. These values can be used:
4286 startsel Using a shifted special key starts selection (either
4287 Select mode or Visual mode, depending on "key" being
4288 present in 'selectmode').
4289 stopsel Using a not-shifted special key stops selection.
4290 Special keys in this context are the cursor keys, <End>, <Home>,
4291 <PageUp> and <PageDown>.
4292 The 'keymodel' option is set by the |:behave| command.
4293
4294 *'keywordprg'* *'kp'*
4295'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4296 OS/2: "view /", VMS: "help")
4297 global or local to buffer |global-local|
4298 {not in Vi}
4299 Program to use for the |K| command. Environment variables are
4300 expanded |:set_env|. ":help" may be used to access the Vim internal
4301 help. (Note that previously setting the global option to the empty
4302 value did this, which is now deprecated.)
4303 When "man" is used, Vim will automatically translate a count for the
4304 "K" command to a section number. Also for "man -s", in which case the
4305 "-s" is removed when there is no count.
4306 See |option-backslash| about including spaces and backslashes.
4307 Example: >
4308 :set keywordprg=man\ -s
4309< This option cannot be set from a |modeline| or in the |sandbox|, for
4310 security reasons.
4311
4312 *'langmap'* *'lmap'* *E357* *E358*
4313'langmap' 'lmap' string (default "")
4314 global
4315 {not in Vi}
4316 {only available when compiled with the |+langmap|
4317 feature}
4318 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004319 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 inserted directly. When in command mode the 'langmap' option takes
4321 care of translating these special characters to the original meaning
4322 of the key. This means you don't have to change the keyboard mode to
4323 be able to execute Normal mode commands.
4324 This is the opposite of the 'keymap' option, where characters are
4325 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004327 Example (for Greek, in UTF-8): *greek* >
4328 :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 +00004329< Example (exchanges meaning of z and y for commands): >
4330 :set langmap=zy,yz,ZY,YZ
4331<
4332 The 'langmap' option is a list of parts, separated with commas. Each
4333 part can be in one of two forms:
4334 1. A list of pairs. Each pair is a "from" character immediately
4335 followed by the "to" character. Examples: "aA", "aAbBcC".
4336 2. A list of "from" characters, a semi-colon and a list of "to"
4337 characters. Example: "abc;ABC"
4338 Example: "aA,fgh;FGH,cCdDeE"
4339 Special characters need to be preceded with a backslash. These are
4340 ";", ',' and backslash itself.
4341
4342 This will allow you to activate vim actions without having to switch
4343 back and forth between the languages. Your language characters will
4344 be understood as normal vim English characters (according to the
4345 langmap mappings) in the following cases:
4346 o Normal/Visual mode (commands, buffer/register names, user mappings)
4347 o Insert/Replace Mode: Register names after CTRL-R
4348 o Insert/Replace Mode: Mappings
4349 Characters entered in Command-line mode will NOT be affected by
4350 this option. Note that this option can be changed at any time
4351 allowing to switch between mappings for different languages/encodings.
4352 Use a mapping to avoid having to type it each time!
4353
4354 *'langmenu'* *'lm'*
4355'langmenu' 'lm' string (default "")
4356 global
4357 {not in Vi}
4358 {only available when compiled with the |+menu| and
4359 |+multi_lang| features}
4360 Language to use for menu translation. Tells which file is loaded
4361 from the "lang" directory in 'runtimepath': >
4362 "lang/menu_" . &langmenu . ".vim"
4363< (without the spaces). For example, to always use the Dutch menus, no
4364 matter what $LANG is set to: >
4365 :set langmenu=nl_NL.ISO_8859-1
4366< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004367 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368 If your $LANG is set to a non-English language but you do want to use
4369 the English menus: >
4370 :set langmenu=none
4371< This option must be set before loading menus, switching on filetype
4372 detection or syntax highlighting. Once the menus are defined setting
4373 this option has no effect. But you could do this: >
4374 :source $VIMRUNTIME/delmenu.vim
4375 :set langmenu=de_DE.ISO_8859-1
4376 :source $VIMRUNTIME/menu.vim
4377< Warning: This deletes all menus that you defined yourself!
4378
4379 *'laststatus'* *'ls'*
4380'laststatus' 'ls' number (default 1)
4381 global
4382 {not in Vi}
4383 The value of this option influences when the last window will have a
4384 status line:
4385 0: never
4386 1: only if there are at least two windows
4387 2: always
4388 The screen looks nicer with a status line if you have several
4389 windows, but it takes another screen line. |status-line|
4390
4391 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4392'lazyredraw' 'lz' boolean (default off)
4393 global
4394 {not in Vi}
4395 When this option is set, the screen will not be redrawn while
4396 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004397 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 update use |:redraw|.
4399
4400 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4401'linebreak' 'lbr' boolean (default off)
4402 local to window
4403 {not in Vi}
4404 {not available when compiled without the |+linebreak|
4405 feature}
4406 If on Vim will wrap long lines at a character in 'breakat' rather
4407 than at the last character that fits on the screen. Unlike
4408 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4409 it only affects the way the file is displayed, not its contents. The
4410 value of 'showbreak' is used to put in front of wrapped lines.
4411 This option is not used when the 'wrap' option is off or 'list' is on.
4412 Note that <Tab> characters after an <EOL> are mostly not displayed
4413 with the right amount of white space.
4414
4415 *'lines'* *E593*
4416'lines' number (default 24 or terminal height)
4417 global
4418 Number of lines of the Vim window.
4419 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004420 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 When Vim is running in the GUI or in a resizable window, setting this
4422 option will cause the window size to be changed. When you only want
4423 to use the size for the GUI, put the command in your |gvimrc| file.
4424 Vim limits the number of lines to what fits on the screen. You can
4425 use this command to get the tallest window possible: >
4426 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004427< Minimum value is 2, maximum value is 1000.
4428 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004429 When you set this option and Vim is unable to change the physical
4430 number of lines of the display, the display may be messed up.
4431
4432 *'linespace'* *'lsp'*
4433'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4434 global
4435 {not in Vi}
4436 {only in the GUI}
4437 Number of pixel lines inserted between characters. Useful if the font
4438 uses the full character cell height, making lines touch each other.
4439 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004440 With some fonts there can be too much room between lines (to have
4441 space for ascents and descents). Then it makes sense to set
4442 'linespace' to a negative value. This may cause display problems
4443 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444
4445 *'lisp'* *'nolisp'*
4446'lisp' boolean (default off)
4447 local to buffer
4448 {not available when compiled without the |+lispindent|
4449 feature}
4450 Lisp mode: When <Enter> is typed in insert mode set the indent for
4451 the next line to Lisp standards (well, sort of). Also happens with
4452 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4453 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4454 better. Also see 'lispwords'.
4455 The '-' character is included in keyword characters. Redefines the
4456 "=" operator to use this same indentation algorithm rather than
4457 calling an external program if 'equalprg' is empty.
4458 This option is not used when 'paste' is set.
4459 {Vi: Does it a little bit differently}
4460
4461 *'lispwords'* *'lw'*
4462'lispwords' 'lw' string (default is very long)
4463 global
4464 {not in Vi}
4465 {not available when compiled without the |+lispindent|
4466 feature}
4467 Comma separated list of words that influence the Lisp indenting.
4468 |'lisp'|
4469
4470 *'list'* *'nolist'*
4471'list' boolean (default off)
4472 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004473 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4474 line. Useful to see the difference between tabs and spaces and for
4475 trailing blanks. Further changed by the 'listchars' option.
4476
4477 The cursor is displayed at the start of the space a Tab character
4478 occupies, not at the end as usual in Normal mode. To get this cursor
4479 position while displaying Tabs with spaces, use: >
4480 :set list lcs=tab\ \
4481<
4482 Note that list mode will also affect formatting (set with 'textwidth'
4483 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 changing the way tabs are displayed.
4485
4486 *'listchars'* *'lcs'*
4487'listchars' 'lcs' string (default "eol:$")
4488 global
4489 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004490 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004491 settings.
4492 eol:c Character to show at the end of each line. When
4493 omitted, there is no extra character at the end of the
4494 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004495 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004497 fill the space that the tab normally occupies.
4498 "tab:>-" will show a tab that takes four spaces as
4499 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004500 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 trailing spaces are blank.
4502 extends:c Character to show in the last column, when 'wrap' is
4503 off and the line continues beyond the right of the
4504 screen.
4505 precedes:c Character to show in the first column, when 'wrap'
4506 is off and there is text preceding the character
4507 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004508 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004509 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004510 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004511 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004512
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004513 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004515 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516
4517 Examples: >
4518 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004519 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 :set lcs=extends:>,precedes:<
4521< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004522 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004523 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524
4525 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4526'loadplugins' 'lpl' boolean (default on)
4527 global
4528 {not in Vi}
4529 When on the plugin scripts are loaded when starting up |load-plugins|.
4530 This option can be reset in your |vimrc| file to disable the loading
4531 of plugins.
4532 Note that using the "-u NONE" and "--noplugin" command line arguments
4533 reset this option. |-u| |--noplugin|
4534
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004535 *'macatsui'* *'nomacatsui'*
4536'macatsui' boolean (default on)
4537 global
4538 {only available in Mac GUI version}
4539 This is a workaround for when drawing doesn't work properly. When set
4540 and compiled with multi-byte support ATSUI text drawing is used. When
4541 not set ATSUI text drawing is not used. Switch this option off when
4542 you experience drawing problems. In a future version the problems may
4543 be solved and this option becomes obsolete. Therefore use this method
4544 to unset it: >
4545 if exists('&macatsui')
4546 set nomacatsui
4547 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004548< Another option to check if you have drawing problems is
4549 'termencoding'.
4550
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 *'magic'* *'nomagic'*
4552'magic' boolean (default on)
4553 global
4554 Changes the special characters that can be used in search patterns.
4555 See |pattern|.
4556 NOTE: To avoid portability problems with using patterns, always keep
4557 this option at the default "on". Only switch it off when working with
4558 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004559 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560
4561 *'makeef'* *'mef'*
4562'makeef' 'mef' string (default: "")
4563 global
4564 {not in Vi}
4565 {not available when compiled without the |+quickfix|
4566 feature}
4567 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4568 and the |:grep| command.
4569 When it is empty, an internally generated temp file will be used.
4570 When "##" is included, it is replaced by a number to make the name
4571 unique. This makes sure that the ":make" command doesn't overwrite an
4572 existing file.
4573 NOT used for the ":cf" command. See 'errorfile' for that.
4574 Environment variables are expanded |:set_env|.
4575 See |option-backslash| about including spaces and backslashes.
4576 This option cannot be set from a |modeline| or in the |sandbox|, for
4577 security reasons.
4578
4579 *'makeprg'* *'mp'*
4580'makeprg' 'mp' string (default "make", VMS: "MMS")
4581 global or local to buffer |global-local|
4582 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004583 Program to use for the ":make" command. See |:make_makeprg|.
4584 This option may contain '%' and '#' characters, which are expanded to
4585 the current and alternate file name. |:_%| |:_#|
4586 Environment variables are expanded |:set_env|. See |option-backslash|
4587 about including spaces and backslashes.
4588 Note that a '|' must be escaped twice: once for ":set" and once for
4589 the interpretation of a command. When you use a filter called
4590 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 :set makeprg=gmake\ \\\|\ myfilter
4592< The placeholder "$*" can be given (even multiple times) to specify
4593 where the arguments will be included, for example: >
4594 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4595< This option cannot be set from a |modeline| or in the |sandbox|, for
4596 security reasons.
4597
Bram Moolenaar1a384422010-07-14 19:53:30 +02004598 *'colorcolumn'* *'cc'*
4599'colorcolumn' 'cc' string (default "")
4600 local to window
4601 {not in Vi}
4602 {not available when compiled without the |+syntax|
4603 feature}
4604 'colorcolumn' is a comma separated list of screen columns that are
4605 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
4606 text. Will make screen redrawing slower.
4607 The screen column can be an absolute number, or a number preceded with
4608 '+' or '-', which is added to or subtracted from 'textwidth'. >
4609
4610 :set cc=+1 " highlight column after 'textwidth'
4611 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
4612 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
4613<
4614 When 'textwidth' is zero then the items with '-' and '+' are not used.
4615 A maximum of 256 columns are highlighted.
4616
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 *'matchpairs'* *'mps'*
4618'matchpairs' 'mps' string (default "(:),{:},[:]")
4619 local to buffer
4620 {not in Vi}
4621 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004622 other. Currently only single byte character pairs are allowed, and
4623 they must be different. The characters must be separated by a colon.
4624 The pairs must be separated by a comma. Example for including '<' and
4625 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 :set mps+=<:>
4627
4628< A more exotic example, to jump between the '=' and ';' in an
4629 assignment, useful for languages like C and Java: >
4630 :au FileType c,cpp,java set mps+==:;
4631
4632< For a more advanced way of using "%", see the matchit.vim plugin in
4633 the $VIMRUNTIME/macros directory. |add-local-help|
4634
4635 *'matchtime'* *'mat'*
4636'matchtime' 'mat' number (default 5)
4637 global
4638 {not in Vi}{in Nvi}
4639 Tenths of a second to show the matching paren, when 'showmatch' is
4640 set. Note that this is not in milliseconds, like other options that
4641 set a time. This is to be compatible with Nvi.
4642
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004643 *'maxcombine'* *'mco'*
4644'maxcombine' 'mco' number (default 2)
4645 global
4646 {not in Vi}
4647 {only available when compiled with the |+multi_byte|
4648 feature}
4649 The maximum number of combining characters supported for displaying.
4650 Only used when 'encoding' is "utf-8".
4651 The default is OK for most languages. Hebrew may require 4.
4652 Maximum value is 6.
4653 Even when this option is set to 2 you can still edit text with more
4654 combining characters, you just can't see them. Use |g8| or |ga|.
4655 See |mbyte-combining|.
4656
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 *'maxfuncdepth'* *'mfd'*
4658'maxfuncdepth' 'mfd' number (default 100)
4659 global
4660 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004661 {not available when compiled without the +eval
4662 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 Maximum depth of function calls for user functions. This normally
4664 catches endless recursion. When using a recursive function with
4665 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4666 more memory, there is the danger of failing when memory is exhausted.
4667 See also |:function|.
4668
4669 *'maxmapdepth'* *'mmd'* *E223*
4670'maxmapdepth' 'mmd' number (default 1000)
4671 global
4672 {not in Vi}
4673 Maximum number of times a mapping is done without resulting in a
4674 character to be used. This normally catches endless mappings, like
4675 ":map x y" with ":map y x". It still does not catch ":map g wg",
4676 because the 'w' is used before the next mapping is done. See also
4677 |key-mapping|.
4678
4679 *'maxmem'* *'mm'*
4680'maxmem' 'mm' number (default between 256 to 5120 (system
4681 dependent) or half the amount of memory
4682 available)
4683 global
4684 {not in Vi}
4685 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4686 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004687 other memory to be freed. The maximum usable value is about 2000000.
4688 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004690 *'maxmempattern'* *'mmp'*
4691'maxmempattern' 'mmp' number (default 1000)
4692 global
4693 {not in Vi}
4694 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004695 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004696 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004697 When Vim runs into the limit it gives an error message and mostly
4698 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004699 Running into the limit often means that the pattern is very
4700 inefficient or too complex. This may already happen with the pattern
4701 "\(.\)*" on a very long line. ".*" works much better.
4702 Vim may run out of memory before hitting the 'maxmempattern' limit.
4703
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 *'maxmemtot'* *'mmt'*
4705'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4706 dependent) or half the amount of memory
4707 available)
4708 global
4709 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004710 Maximum amount of memory in Kbyte to use for all buffers together.
4711 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4712 without a limit. On 64 bit machines higher values might work. But
4713 hey, do you really need more than 2 Gbyte for text editing?
4714 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715
4716 *'menuitems'* *'mis'*
4717'menuitems' 'mis' number (default 25)
4718 global
4719 {not in Vi}
4720 {not available when compiled without the |+menu|
4721 feature}
4722 Maximum number of items to use in a menu. Used for menus that are
4723 generated from a list of items, e.g., the Buffers menu. Changing this
4724 option has no direct effect, the menu must be refreshed first.
4725
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004726 *'mkspellmem'* *'msm'*
4727'mkspellmem' 'msm' string (default "460000,2000,500")
4728 global
4729 {not in Vi}
4730 {not available when compiled without the |+syntax|
4731 feature}
4732 Parameters for |:mkspell|. This tunes when to start compressing the
4733 word tree. Compression can be slow when there are many words, but
4734 it's needed to avoid running out of memory. The amount of memory used
4735 per word depends very much on how similar the words are, that's why
4736 this tuning is complicated.
4737
4738 There are three numbers, separated by commas:
4739 {start},{inc},{added}
4740
4741 For most languages the uncompressed word tree fits in memory. {start}
4742 gives the amount of memory in Kbyte that can be used before any
4743 compression is done. It should be a bit smaller than the amount of
4744 memory that is available to Vim.
4745
4746 When going over the {start} limit the {inc} number specifies the
4747 amount of memory in Kbyte that can be allocated before another
4748 compression is done. A low number means compression is done after
4749 less words are added, which is slow. A high number means more memory
4750 will be allocated.
4751
4752 After doing compression, {added} times 1024 words can be added before
4753 the {inc} limit is ignored and compression is done when any extra
4754 amount of memory is needed. A low number means there is a smaller
4755 chance of hitting the {inc} limit, less memory is used but it's
4756 slower.
4757
4758 The languages for which these numbers are important are Italian and
4759 Hungarian. The default works for when you have about 512 Mbyte. If
4760 you have 1 Gbyte you could use: >
4761 :set mkspellmem=900000,3000,800
4762< If you have less than 512 Mbyte |:mkspell| may fail for some
4763 languages, no matter what you set 'mkspellmem' to.
4764
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004766'modeline' 'ml' boolean (Vim default: on (off for root),
4767 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768 local to buffer
4769 *'modelines'* *'mls'*
4770'modelines' 'mls' number (default 5)
4771 global
4772 {not in Vi}
4773 If 'modeline' is on 'modelines' gives the number of lines that is
4774 checked for set commands. If 'modeline' is off or 'modelines' is zero
4775 no lines are checked. See |modeline|.
4776 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4777 set and to the Vim default value when 'compatible' is reset.
4778
4779 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4780'modifiable' 'ma' boolean (default on)
4781 local to buffer
4782 {not in Vi} *E21*
4783 When off the buffer contents cannot be changed. The 'fileformat' and
4784 'fileencoding' options also can't be changed.
4785 Can be reset with the |-M| command line argument.
4786
4787 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4788'modified' 'mod' boolean (default off)
4789 local to buffer
4790 {not in Vi}
4791 When on, the buffer is considered to be modified. This option is set
4792 when:
4793 1. A change was made to the text since it was last written. Using the
4794 |undo| command to go back to the original text will reset the
4795 option. But undoing changes that were made before writing the
4796 buffer will set the option again, since the text is different from
4797 when it was written.
4798 2. 'fileformat' or 'fileencoding' is different from its original
4799 value. The original value is set when the buffer is read or
4800 written. A ":set nomodified" command also resets the original
4801 values to the current values and the 'modified' option will be
4802 reset.
4803 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4804 will be ignored.
4805
4806 *'more'* *'nomore'*
4807'more' boolean (Vim default: on, Vi default: off)
4808 global
4809 {not in Vi}
4810 When on, listings pause when the whole screen is filled. You will get
4811 the |more-prompt|. When this option is off there are no pauses, the
4812 listing continues until finished.
4813 NOTE: This option is set to the Vi default value when 'compatible' is
4814 set and to the Vim default value when 'compatible' is reset.
4815
4816 *'mouse'* *E538*
4817'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4818 global
4819 {not in Vi}
4820 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004821 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4822 sysmouse and Linux console with gpm). For using the mouse in the
4823 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824 The mouse can be enabled for different modes:
4825 n Normal mode
4826 v Visual mode
4827 i Insert mode
4828 c Command-line mode
4829 h all previous modes when editing a help file
4830 a all previous modes
4831 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 Normally you would enable the mouse in all four modes with: >
4833 :set mouse=a
4834< When the mouse is not enabled, the GUI will still use the mouse for
4835 modeless selection. This doesn't move the text cursor.
4836
4837 See |mouse-using|. Also see |'clipboard'|.
4838
4839 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004840 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 the mouse buttons can still be used by keeping the shift key pressed.
4842 Also see the 'clipboard' option.
4843
4844 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4845'mousefocus' 'mousef' boolean (default off)
4846 global
4847 {not in Vi}
4848 {only works in the GUI}
4849 The window that the mouse pointer is on is automatically activated.
4850 When changing the window layout or window focus in another way, the
4851 mouse pointer is moved to the window with keyboard focus. Off is the
4852 default because it makes using the pull down menus a little goofy, as
4853 a pointer transit may activate a window unintentionally.
4854
4855 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4856'mousehide' 'mh' boolean (default on)
4857 global
4858 {not in Vi}
4859 {only works in the GUI}
4860 When on, the mouse pointer is hidden when characters are typed.
4861 The mouse pointer is restored when the mouse is moved.
4862
4863 *'mousemodel'* *'mousem'*
4864'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4865 global
4866 {not in Vi}
4867 Sets the model to use for the mouse. The name mostly specifies what
4868 the right mouse button is used for:
4869 extend Right mouse button extends a selection. This works
4870 like in an xterm.
4871 popup Right mouse button pops up a menu. The shifted left
4872 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004873 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 popup_setpos Like "popup", but the cursor will be moved to the
4875 position where the mouse was clicked, and thus the
4876 selected operation will act upon the clicked object.
4877 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004878 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879 course, that right clicking outside a selection will
4880 end Visual mode.
4881 Overview of what button does what for each model:
4882 mouse extend popup(_setpos) ~
4883 left click place cursor place cursor
4884 left drag start selection start selection
4885 shift-left search word extend selection
4886 right click extend selection popup menu (place cursor)
4887 right drag extend selection -
4888 middle click paste paste
4889
4890 In the "popup" model the right mouse button produces a pop-up menu.
4891 You need to define this first, see |popup-menu|.
4892
4893 Note that you can further refine the meaning of buttons with mappings.
4894 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4895 selection (because that's handled in the GUI code directly).
4896
4897 The 'mousemodel' option is set by the |:behave| command.
4898
4899 *'mouseshape'* *'mouses'* *E547*
4900'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004901 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004902 global
4903 {not in Vi}
4904 {only available when compiled with the |+mouseshape|
4905 feature}
4906 This option tells Vim what the mouse pointer should look like in
4907 different modes. The option is a comma separated list of parts, much
4908 like used for 'guicursor'. Each part consist of a mode/location-list
4909 and an argument-list:
4910 mode-list:shape,mode-list:shape,..
4911 The mode-list is a dash separated list of these modes/locations:
4912 In a normal window: ~
4913 n Normal mode
4914 v Visual mode
4915 ve Visual mode with 'selection' "exclusive" (same as 'v',
4916 if not specified)
4917 o Operator-pending mode
4918 i Insert mode
4919 r Replace mode
4920
4921 Others: ~
4922 c appending to the command-line
4923 ci inserting in the command-line
4924 cr replacing in the command-line
4925 m at the 'Hit ENTER' or 'More' prompts
4926 ml idem, but cursor in the last line
4927 e any mode, pointer below last window
4928 s any mode, pointer on a status line
4929 sd any mode, while dragging a status line
4930 vs any mode, pointer on a vertical separator line
4931 vd any mode, while dragging a vertical separator line
4932 a everywhere
4933
4934 The shape is one of the following:
4935 avail name looks like ~
4936 w x arrow Normal mouse pointer
4937 w x blank no pointer at all (use with care!)
4938 w x beam I-beam
4939 w x updown up-down sizing arrows
4940 w x leftright left-right sizing arrows
4941 w x busy The system's usual busy pointer
4942 w x no The system's usual 'no input' pointer
4943 x udsizing indicates up-down resizing
4944 x lrsizing indicates left-right resizing
4945 x crosshair like a big thin +
4946 x hand1 black hand
4947 x hand2 white hand
4948 x pencil what you write with
4949 x question big ?
4950 x rightup-arrow arrow pointing right-up
4951 w x up-arrow arrow pointing up
4952 x <number> any X11 pointer number (see X11/cursorfont.h)
4953
4954 The "avail" column contains a 'w' if the shape is available for Win32,
4955 x for X11.
4956 Any modes not specified or shapes not available use the normal mouse
4957 pointer.
4958
4959 Example: >
4960 :set mouseshape=s:udsizing,m:no
4961< will make the mouse turn to a sizing arrow over the status lines and
4962 indicate no input when the hit-enter prompt is displayed (since
4963 clicking the mouse has no effect in this state.)
4964
4965 *'mousetime'* *'mouset'*
4966'mousetime' 'mouset' number (default 500)
4967 global
4968 {not in Vi}
4969 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4970 time in msec between two mouse clicks for the second click to be
4971 recognized as a multi click.
4972
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004973 *'mzquantum'* *'mzq'*
4974'mzquantum' 'mzq' number (default 100)
4975 global
4976 {not in Vi}
4977 {not available when compiled without the |+mzscheme|
4978 feature}
4979 The number of milliseconds between polls for MzScheme threads.
4980 Negative or zero value means no thread scheduling.
4981
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 *'nrformats'* *'nf'*
4983'nrformats' 'nf' string (default "octal,hex")
4984 local to buffer
4985 {not in Vi}
4986 This defines what bases Vim will consider for numbers when using the
4987 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4988 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004989 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02004991 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00004992 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004994 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995 considered to be hexadecimal. Example: Using CTRL-X on
4996 "0x100" results in "0x0ff".
4997 Numbers which simply begin with a digit in the range 1-9 are always
4998 considered decimal. This also happens for numbers that are not
4999 recognized as octal or hex.
5000
5001 *'number'* *'nu'* *'nonumber'* *'nonu'*
5002'number' 'nu' boolean (default off)
5003 local to window
5004 Print the line number in front of each line. When the 'n' option is
5005 excluded from 'cpoptions' a wrapped line will not use the column of
5006 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005007 The 'numberwidth' option can be used to set the room used for the line
5008 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009 When a long, wrapped line doesn't start with the first character, '-'
5010 characters are put before the number.
5011 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005012 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005014 *'numberwidth'* *'nuw'*
5015'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5016 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005017 {not in Vi}
5018 {only available when compiled with the |+linebreak|
5019 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005020 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005021 when the 'number' or 'relativenumber' option is set or printing lines
5022 with a line number. Since one space is always between the number and
5023 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005024 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005025 fit the highest line number in the buffer respectively the number of
5026 rows in the window, depending on whether 'number' or 'relativenumber'
5027 is set. Thus with the Vim default of 4 there is room for a line number
5028 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005029 The minimum value is 1, the maximum value is 10.
5030 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5031
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005032 *'omnifunc'* *'ofu'*
5033'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005034 local to buffer
5035 {not in Vi}
5036 {not available when compiled without the +eval
5037 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005038 This option specifies a function to be used for Insert mode omni
5039 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005040 See |complete-functions| for an explanation of how the function is
5041 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005042 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005043 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005044
5045
Bram Moolenaar02467872007-05-06 13:22:01 +00005046 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005047'opendevice' 'odev' boolean (default off)
5048 global
5049 {not in Vi}
5050 {only for MS-DOS, MS-Windows and OS/2}
5051 Enable reading and writing from devices. This may get Vim stuck on a
5052 device that can be opened but doesn't actually do the I/O. Therefore
5053 it is off by default.
5054 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5055 result in editing a device.
5056
5057
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005058 *'operatorfunc'* *'opfunc'*
5059'operatorfunc' 'opfunc' string (default: empty)
5060 global
5061 {not in Vi}
5062 This option specifies a function to be called by the |g@| operator.
5063 See |:map-operator| for more info and an example.
5064
5065 This option cannot be set from a |modeline| or in the |sandbox|, for
5066 security reasons.
5067
5068
Bram Moolenaar071d4272004-06-13 20:20:40 +00005069 *'osfiletype'* *'oft'* *E366*
5070'osfiletype' 'oft' string (RISC-OS default: "Text",
5071 others default: "")
5072 local to buffer
5073 {not in Vi}
5074 {only available when compiled with the |+osfiletype|
5075 feature}
5076 Some operating systems store extra information about files besides
5077 name, datestamp and permissions. This option contains the extra
5078 information, the nature of which will vary between systems.
5079 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005080 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005081 It can affect the pattern matching of the automatic commands.
5082 |autocmd-osfiletypes|
5083
5084 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005085'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 global
5087 Specifies the nroff macros that separate paragraphs. These are pairs
5088 of two letters (see |object-motions|).
5089
5090 *'paste'* *'nopaste'*
5091'paste' boolean (default off)
5092 global
5093 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005094 Put Vim in Paste mode. This is useful if you want to cut or copy
5095 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 unexpected effects.
5097 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005098 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099 knows about pasting and will mostly do the right thing without 'paste'
5100 being set. The same is true for a terminal where Vim handles the
5101 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005102 This option is reset when starting the GUI. Thus if you set it in
5103 your .vimrc it will work in a terminal, but not in the GUI. Setting
5104 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5105 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 When the 'paste' option is switched on (also when it was already on):
5107 - mapping in Insert mode and Command-line mode is disabled
5108 - abbreviations are disabled
5109 - 'textwidth' is set to 0
5110 - 'wrapmargin' is set to 0
5111 - 'autoindent' is reset
5112 - 'smartindent' is reset
5113 - 'softtabstop' is set to 0
5114 - 'revins' is reset
5115 - 'ruler' is reset
5116 - 'showmatch' is reset
5117 - 'formatoptions' is used like it is empty
5118 These options keep their value, but their effect is disabled:
5119 - 'lisp'
5120 - 'indentexpr'
5121 - 'cindent'
5122 NOTE: When you start editing another file while the 'paste' option is
5123 on, settings from the modelines or autocommands may change the
5124 settings again, causing trouble when pasting text. You might want to
5125 set the 'paste' option again.
5126 When the 'paste' option is reset the mentioned options are restored to
5127 the value before the moment 'paste' was switched from off to on.
5128 Resetting 'paste' before ever setting it does not have any effect.
5129 Since mapping doesn't work while 'paste' is active, you need to use
5130 the 'pastetoggle' option to toggle the 'paste' option with some key.
5131
5132 *'pastetoggle'* *'pt'*
5133'pastetoggle' 'pt' string (default "")
5134 global
5135 {not in Vi}
5136 When non-empty, specifies the key sequence that toggles the 'paste'
5137 option. This is like specifying a mapping: >
5138 :map {keys} :set invpaste<CR>
5139< Where {keys} is the value of 'pastetoggle'.
5140 The difference is that it will work even when 'paste' is set.
5141 'pastetoggle' works in Insert mode and Normal mode, but not in
5142 Command-line mode.
5143 Mappings are checked first, thus overrule 'pastetoggle'. However,
5144 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5145 this: >
5146 :map <F10> :set paste<CR>
5147 :map <F11> :set nopaste<CR>
5148 :imap <F10> <C-O>:set paste<CR>
5149 :imap <F11> <nop>
5150 :set pastetoggle=<F11>
5151< This will make <F10> start paste mode and <F11> stop paste mode.
5152 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5153 mode everything is inserted literally, except the 'pastetoggle' key
5154 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005155 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156
5157 *'pex'* *'patchexpr'*
5158'patchexpr' 'pex' string (default "")
5159 global
5160 {not in Vi}
5161 {not available when compiled without the |+diff|
5162 feature}
5163 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005164 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165
5166 *'patchmode'* *'pm'* *E206*
5167'patchmode' 'pm' string (default "")
5168 global
5169 {not in Vi}
5170 When non-empty the oldest version of a file is kept. This can be used
5171 to keep the original version of a file if you are changing files in a
5172 source distribution. Only the first time that a file is written a
5173 copy of the original file will be kept. The name of the copy is the
5174 name of the original file with the string in the 'patchmode' option
5175 appended. This option should start with a dot. Use a string like
5176 ".org". 'backupdir' must not be empty for this to work (Detail: The
5177 backup file is renamed to the patchmode file after the new file has
5178 been successfully written, that's why it must be possible to write a
5179 backup file). If there was no file to be backed up, an empty file is
5180 created.
5181 When the 'backupskip' pattern matches, a patchmode file is not made.
5182 Using 'patchmode' for compressed files appends the extension at the
5183 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5184 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005185 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186
5187 *'path'* *'pa'* *E343* *E345* *E347*
5188'path' 'pa' string (default on Unix: ".,/usr/include,,"
5189 on OS/2: ".,/emx/include,,"
5190 other systems: ".,,")
5191 global or local to buffer |global-local|
5192 {not in Vi}
5193 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005194 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5195 provided that the file being searched for has a relative path (not
5196 starting with "/", "./" or "../"). The directories in the 'path'
5197 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 - Use commas to separate directory names: >
5199 :set path=.,/usr/local/include,/usr/include
5200< - Spaces can also be used to separate directory names (for backwards
5201 compatibility with version 3.0). To have a space in a directory
5202 name, precede it with an extra backslash, and escape the space: >
5203 :set path=.,/dir/with\\\ space
5204< - To include a comma in a directory name precede it with an extra
5205 backslash: >
5206 :set path=.,/dir/with\\,comma
5207< - To search relative to the directory of the current file, use: >
5208 :set path=.
5209< - To search in the current directory use an empty string between two
5210 commas: >
5211 :set path=,,
5212< - A directory name may end in a ':' or '/'.
5213 - Environment variables are expanded |:set_env|.
5214 - When using |netrw.vim| URLs can be used. For example, adding
5215 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005216 - Search upwards and downwards in a directory tree using "*", "**" and
5217 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 {not available when compiled without the |+path_extra| feature}
5219 - Careful with '\' characters, type two to get one in the option: >
5220 :set path=.,c:\\include
5221< Or just use '/' instead: >
5222 :set path=.,c:/include
5223< Don't forget "." or files won't even be found in the same directory as
5224 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005225 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 it is something like 256 or 1024 characters.
5227 You can check if all the include files are found, using the value of
5228 'path', see |:checkpath|.
5229 The use of |:set+=| and |:set-=| is preferred when adding or removing
5230 directories from the list. This avoids problems when a future version
5231 uses another default. To remove the current directory use: >
5232 :set path-=
5233< To add the current directory use: >
5234 :set path+=
5235< To use an environment variable, you probably need to replace the
5236 separator. Here is an example to append $INCL, in which directory
5237 names are separated with a semi-colon: >
5238 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5239< Replace the ';' with a ':' or whatever separator is used. Note that
5240 this doesn't work when $INCL contains a comma or white space.
5241
5242 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5243'preserveindent' 'pi' boolean (default off)
5244 local to buffer
5245 {not in Vi}
5246 When changing the indent of the current line, preserve as much of the
5247 indent structure as possible. Normally the indent is replaced by a
5248 series of tabs followed by spaces as required (unless |'expandtab'| is
5249 enabled, in which case only spaces are used). Enabling this option
5250 means the indent will preserve as many existing characters as possible
5251 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005252 'expandtab' does not apply to the preserved white space, a Tab remains
5253 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 NOTE: When using ">>" multiple times the resulting indent is a mix of
5255 tabs and spaces. You might not like this.
5256 NOTE: 'preserveindent' is reset when 'compatible' is set.
5257 Also see 'copyindent'.
5258 Use |:retab| to clean up white space.
5259
5260 *'previewheight'* *'pvh'*
5261'previewheight' 'pvh' number (default 12)
5262 global
5263 {not in Vi}
5264 {not available when compiled without the |+windows| or
5265 |+quickfix| feature}
5266 Default height for a preview window. Used for |:ptag| and associated
5267 commands. Used for |CTRL-W_}| when no count is given.
5268
5269 *'previewwindow'* *'nopreviewwindow'*
5270 *'pvw'* *'nopvw'* *E590*
5271'previewwindow' 'pvw' boolean (default off)
5272 local to window
5273 {not in Vi}
5274 {not available when compiled without the |+windows| or
5275 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005276 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 set. It's normally not set directly, but by using one of the commands
5278 |:ptag|, |:pedit|, etc.
5279
5280 *'printdevice'* *'pdev'*
5281'printdevice' 'pdev' string (default empty)
5282 global
5283 {not in Vi}
5284 {only available when compiled with the |+printer|
5285 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005286 The name of the printer to be used for |:hardcopy|.
5287 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005288 This option cannot be set from a |modeline| or in the |sandbox|, for
5289 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005290
Bram Moolenaar8299df92004-07-10 09:47:34 +00005291 *'printencoding'* *'penc'*
5292'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 global
5294 {not in Vi}
5295 {only available when compiled with the |+printer|
5296 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005297 Sets the character encoding used when printing.
5298 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005299
5300 *'printexpr'* *'pexpr'*
5301'printexpr' 'pexpr' String (default: see below)
5302 global
5303 {not in Vi}
5304 {only available when compiled with the |+printer|
5305 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005306 Expression used to print the PostScript produced with |:hardcopy|.
5307 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308
Bram Moolenaar8299df92004-07-10 09:47:34 +00005309 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310'printfont' 'pfn' string (default "courier")
5311 global
5312 {not in Vi}
5313 {only available when compiled with the |+printer|
5314 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005315 The name of the font that will be used for |:hardcopy|.
5316 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317
5318 *'printheader'* *'pheader'*
5319'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5320 global
5321 {not in Vi}
5322 {only available when compiled with the |+printer|
5323 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005324 The format of the header produced in |:hardcopy| output.
5325 See |pheader-option|.
5326
5327 *'printmbcharset'* *'pmbcs'*
5328'printmbcharset' 'pmbcs' string (default "")
5329 global
5330 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005331 {only available when compiled with the |+printer|,
5332 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005333 The CJK character set to be used for CJK output from |:hardcopy|.
5334 See |pmbcs-option|.
5335
5336 *'printmbfont'* *'pmbfn'*
5337'printmbfont' 'pmbfn' string (default "")
5338 global
5339 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005340 {only available when compiled with the |+printer|,
5341 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005342 List of font names to be used for CJK output from |:hardcopy|.
5343 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005344
5345 *'printoptions'* *'popt'*
5346'printoptions' 'popt' string (default "")
5347 global
5348 {not in Vi}
5349 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005350 List of items that control the format of the output of |:hardcopy|.
5351 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005352
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005353 *'prompt'* *'noprompt'*
5354'prompt' boolean (default on)
5355 global
5356 When on a ":" prompt is used in Ex mode.
5357
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005358 *'pumheight'* *'ph'*
5359'pumheight' 'ph' number (default 0)
5360 global
5361 {not available when compiled without the
5362 |+insert_expand| feature}
5363 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005364 Determines the maximum number of items to show in the popup menu for
5365 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005366 |ins-completion-menu|.
5367
5368
Bram Moolenaar677ee682005-01-27 14:41:15 +00005369 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005370'quoteescape' 'qe' string (default "\")
5371 local to buffer
5372 {not in Vi}
5373 The characters that are used to escape quotes in a string. Used for
5374 objects like a', a" and a` |a'|.
5375 When one of the characters in this option is found inside a string,
5376 the following character will be skipped. The default value makes the
5377 text "foo\"bar\\" considered to be one string.
5378
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5380'readonly' 'ro' boolean (default off)
5381 local to buffer
5382 If on, writes fail unless you use a '!'. Protects you from
5383 accidentally overwriting a file. Default on when Vim is started
5384 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005385 When using ":w!" the 'readonly' option is reset for the current
5386 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005387 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005388 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005390 *'redrawtime'* *'rdt'*
5391'redrawtime' 'rdt' number (default 2000)
5392 global
5393 {not in Vi}
5394 {only available when compiled with the |+reltime|
5395 feature}
5396 The time in milliseconds for redrawing the display. This applies to
5397 searching for patterns for 'hlsearch' and |:match| highlighting.
5398 When redrawing takes more than this many milliseconds no further
5399 matches will be highlighted. This is used to avoid that Vim hangs
5400 when using a very complicated pattern.
5401
Bram Moolenaar64486672010-05-16 15:46:46 +02005402 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5403'relativenumber' 'rnu' boolean (default off)
5404 local to window
5405 {not in Vi}
5406 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005407 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005408 precede some vertical motion commands (e.g. j k + -) with, without
5409 having to calculate it yourself. Especially useful in combination with
5410 other commands (e.g. y d c < > gq gw =).
5411 When the 'n' option is excluded from 'cpoptions' a wrapped
5412 line will not use the column of line numbers (this is the default when
5413 'compatible' isn't set).
5414 The 'numberwidth' option can be used to set the room used for the line
5415 number.
5416 When a long, wrapped line doesn't start with the first character, '-'
5417 characters are put before the number.
5418 See |hl-LineNr| for the highlighting used for the number.
5419 When setting this option, 'number' is reset.
5420
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421 *'remap'* *'noremap'*
5422'remap' boolean (default on)
5423 global
5424 Allows for mappings to work recursively. If you do not want this for
5425 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005426 NOTE: To avoid portability problems with Vim scripts, always keep
5427 this option at the default "on". Only switch it off when working with
5428 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429
5430 *'report'*
5431'report' number (default 2)
5432 global
5433 Threshold for reporting number of lines changed. When the number of
5434 changed lines is more than 'report' a message will be given for most
5435 ":" commands. If you want it always, set 'report' to 0.
5436 For the ":substitute" command the number of substitutions is used
5437 instead of the number of lines.
5438
5439 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5440'restorescreen' 'rs' boolean (default on)
5441 global
5442 {not in Vi} {only in Windows 95/NT console version}
5443 When set, the screen contents is restored when exiting Vim. This also
5444 happens when executing external commands.
5445
5446 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5447 options in your .vimrc. To disable restoring:
5448 set t_ti= t_te=
5449 To enable restoring (for an xterm):
5450 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5451 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5452
5453 *'revins'* *'ri'* *'norevins'* *'nori'*
5454'revins' 'ri' boolean (default off)
5455 global
5456 {not in Vi}
5457 {only available when compiled with the |+rightleft|
5458 feature}
5459 Inserting characters in Insert mode will work backwards. See "typing
5460 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5461 command in Insert mode, when 'allowrevins' is set.
5462 NOTE: This option is reset when 'compatible' or 'paste' is set.
5463
5464 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5465'rightleft' 'rl' boolean (default off)
5466 local to window
5467 {not in Vi}
5468 {only available when compiled with the |+rightleft|
5469 feature}
5470 When on, display orientation becomes right-to-left, i.e., characters
5471 that are stored in the file appear from the right to the left.
5472 Using this option, it is possible to edit files for languages that
5473 are written from the right to the left such as Hebrew and Arabic.
5474 This option is per window, so it is possible to edit mixed files
5475 simultaneously, or to view the same file in both ways (this is
5476 useful whenever you have a mixed text file with both right-to-left
5477 and left-to-right strings so that both sets are displayed properly
5478 in different windows). Also see |rileft.txt|.
5479
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005480 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481'rightleftcmd' 'rlc' string (default "search")
5482 local to window
5483 {not in Vi}
5484 {only available when compiled with the |+rightleft|
5485 feature}
5486 Each word in this option enables the command line editing to work in
5487 right-to-left mode for a group of commands:
5488
5489 search "/" and "?" commands
5490
5491 This is useful for languages such as Hebrew, Arabic and Farsi.
5492 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5493
5494 *'ruler'* *'ru'* *'noruler'* *'noru'*
5495'ruler' 'ru' boolean (default off)
5496 global
5497 {not in Vi}
5498 {not available when compiled without the
5499 |+cmdline_info| feature}
5500 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005501 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005502 text in the file is shown on the far right:
5503 Top first line is visible
5504 Bot last line is visible
5505 All first and last line are visible
5506 45% relative position in the file
5507 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005508 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005510 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511 this option takes precedence over 'ruler' and 'rulerformat'
5512 If the number of characters displayed is different from the number of
5513 bytes in the text (e.g., for a TAB or a multi-byte character), both
5514 the text column (byte number) and the screen column are shown,
5515 separated with a dash.
5516 For an empty line "0-1" is shown.
5517 For an empty buffer the line number will also be zero: "0,0-1".
5518 This option is reset when the 'paste' option is set.
5519 If you don't want to see the ruler all the time but want to know where
5520 you are, use "g CTRL-G" |g_CTRL-G|.
5521 NOTE: This option is reset when 'compatible' is set.
5522
5523 *'rulerformat'* *'ruf'*
5524'rulerformat' 'ruf' string (default empty)
5525 global
5526 {not in Vi}
5527 {not available when compiled without the |+statusline|
5528 feature}
5529 When this option is not empty, it determines the content of the ruler
5530 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005531 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 The default ruler width is 17 characters. To make the ruler 15
5533 characters wide, put "%15(" at the start and "%)" at the end.
5534 Example: >
5535 :set rulerformat=%15(%c%V\ %p%%%)
5536<
5537 *'runtimepath'* *'rtp'* *vimfiles*
5538'runtimepath' 'rtp' string (default:
5539 Unix: "$HOME/.vim,
5540 $VIM/vimfiles,
5541 $VIMRUNTIME,
5542 $VIM/vimfiles/after,
5543 $HOME/.vim/after"
5544 Amiga: "home:vimfiles,
5545 $VIM/vimfiles,
5546 $VIMRUNTIME,
5547 $VIM/vimfiles/after,
5548 home:vimfiles/after"
5549 PC, OS/2: "$HOME/vimfiles,
5550 $VIM/vimfiles,
5551 $VIMRUNTIME,
5552 $VIM/vimfiles/after,
5553 $HOME/vimfiles/after"
5554 Macintosh: "$VIM:vimfiles,
5555 $VIMRUNTIME,
5556 $VIM:vimfiles:after"
5557 RISC-OS: "Choices:vimfiles,
5558 $VIMRUNTIME,
5559 Choices:vimfiles/after"
5560 VMS: "sys$login:vimfiles,
5561 $VIM/vimfiles,
5562 $VIMRUNTIME,
5563 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005564 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 global
5566 {not in Vi}
5567 This is a list of directories which will be searched for runtime
5568 files:
5569 filetype.vim filetypes by file name |new-filetype|
5570 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005571 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572 colors/ color scheme files |:colorscheme|
5573 compiler/ compiler files |:compiler|
5574 doc/ documentation |write-local-help|
5575 ftplugin/ filetype plugins |write-filetype-plugin|
5576 indent/ indent scripts |indent-expression|
5577 keymap/ key mapping files |mbyte-keymap|
5578 lang/ menu translations |:menutrans|
5579 menu.vim GUI menus |menu.vim|
5580 plugin/ plugin scripts |write-plugin|
5581 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005582 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583 syntax/ syntax files |mysyntaxfile|
5584 tutor/ files for vimtutor |tutor|
5585
5586 And any other file searched for with the |:runtime| command.
5587
5588 The defaults for most systems are setup to search five locations:
5589 1. In your home directory, for your personal preferences.
5590 2. In a system-wide Vim directory, for preferences from the system
5591 administrator.
5592 3. In $VIMRUNTIME, for files distributed with Vim.
5593 *after-directory*
5594 4. In the "after" directory in the system-wide Vim directory. This is
5595 for the system administrator to overrule or add to the distributed
5596 defaults (rarely needed)
5597 5. In the "after" directory in your home directory. This is for
5598 personal preferences to overrule or add to the distributed defaults
5599 or system-wide settings (rarely needed).
5600
5601 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5602 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005603 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604 wildcards.
5605 See |:runtime|.
5606 Example: >
5607 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5608< This will use the directory "~/vimruntime" first (containing your
5609 personal Vim runtime files), then "/mygroup/vim" (shared between a
5610 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5611 files).
5612 You probably should always include $VIMRUNTIME somewhere, to use the
5613 distributed runtime files. You can put a directory before $VIMRUNTIME
5614 to find files which replace a distributed runtime files. You can put
5615 a directory after $VIMRUNTIME to find files which add to distributed
5616 runtime files.
5617 This option cannot be set from a |modeline| or in the |sandbox|, for
5618 security reasons.
5619
5620 *'scroll'* *'scr'*
5621'scroll' 'scr' number (default: half the window height)
5622 local to window
5623 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5624 set to half the number of lines in the window when the window size
5625 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005626 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5628 the number of screen lines instead of file lines, makes a difference
5629 when lines wrap}
5630
5631 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5632'scrollbind' 'scb' boolean (default off)
5633 local to window
5634 {not in Vi}
5635 {not available when compiled without the |+scrollbind|
5636 feature}
5637 See also |scroll-binding|. When this option is set, the current
5638 window scrolls as other scrollbind windows (windows that also have
5639 this option set) scroll. This option is useful for viewing the
5640 differences between two versions of a file, see 'diff'.
5641 See |'scrollopt'| for options that determine how this option should be
5642 interpreted.
5643 This option is mostly reset when splitting a window to edit another
5644 file. This means that ":split | edit file" results in two windows
5645 with scroll-binding, but ":split file" does not.
5646
5647 *'scrolljump'* *'sj'*
5648'scrolljump' 'sj' number (default 1)
5649 global
5650 {not in Vi}
5651 Minimal number of lines to scroll when the cursor gets off the
5652 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5653 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005654 When set to a negative number from -1 to -100 this is used as the
5655 percentage of the window height. Thus -50 scrolls half the window
5656 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657 NOTE: This option is set to 1 when 'compatible' is set.
5658
5659 *'scrolloff'* *'so'*
5660'scrolloff' 'so' number (default 0)
5661 global
5662 {not in Vi}
5663 Minimal number of screen lines to keep above and below the cursor.
5664 This will make some context visible around where you are working. If
5665 you set it to a very large value (999) the cursor line will always be
5666 in the middle of the window (except at the start or end of the file or
5667 when long lines wrap).
5668 For scrolling horizontally see 'sidescrolloff'.
5669 NOTE: This option is set to 0 when 'compatible' is set.
5670
5671 *'scrollopt'* *'sbo'*
5672'scrollopt' 'sbo' string (default "ver,jump")
5673 global
5674 {not available when compiled without the |+scrollbind|
5675 feature}
5676 {not in Vi}
5677 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005678 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5679 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680 The following words are available:
5681 ver Bind vertical scrolling for 'scrollbind' windows
5682 hor Bind horizontal scrolling for 'scrollbind' windows
5683 jump Applies to the offset between two windows for vertical
5684 scrolling. This offset is the difference in the first
5685 displayed line of the bound windows. When moving
5686 around in a window, another 'scrollbind' window may
5687 reach a position before the start or after the end of
5688 the buffer. The offset is not changed though, when
5689 moving back the 'scrollbind' window will try to scroll
5690 to the desired position when possible.
5691 When now making that window the current one, two
5692 things can be done with the relative offset:
5693 1. When "jump" is not included, the relative offset is
5694 adjusted for the scroll position in the new current
5695 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005696 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 2. When "jump" is included, the other windows are
5698 scrolled to keep the same relative offset. When
5699 going back to the other window, it still uses the
5700 same relative offset.
5701 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005702 When 'diff' mode is active there always is vertical scroll binding,
5703 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704
5705 *'sections'* *'sect'*
5706'sections' 'sect' string (default "SHNHH HUnhsh")
5707 global
5708 Specifies the nroff macros that separate sections. These are pairs of
5709 two letters (See |object-motions|). The default makes a section start
5710 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5711
5712 *'secure'* *'nosecure'* *E523*
5713'secure' boolean (default off)
5714 global
5715 {not in Vi}
5716 When on, ":autocmd", shell and write commands are not allowed in
5717 ".vimrc" and ".exrc" in the current directory and map commands are
5718 displayed. Switch it off only if you know that you will not run into
5719 problems, or when the 'exrc' option is off. On Unix this option is
5720 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005721 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 'secure' at the end of your ~/.vimrc then.
5723 This option cannot be set from a |modeline| or in the |sandbox|, for
5724 security reasons.
5725
5726 *'selection'* *'sel'*
5727'selection' 'sel' string (default "inclusive")
5728 global
5729 {not in Vi}
5730 This option defines the behavior of the selection. It is only used
5731 in Visual and Select mode.
5732 Possible values:
5733 value past line inclusive ~
5734 old no yes
5735 inclusive yes yes
5736 exclusive yes no
5737 "past line" means that the cursor is allowed to be positioned one
5738 character past the line.
5739 "inclusive" means that the last character of the selection is included
5740 in an operation. For example, when "x" is used to delete the
5741 selection.
5742 Note that when "exclusive" is used and selecting from the end
5743 backwards, you cannot include the last character of a line, when
5744 starting in Normal mode and 'virtualedit' empty.
5745
5746 The 'selection' option is set by the |:behave| command.
5747
5748 *'selectmode'* *'slm'*
5749'selectmode' 'slm' string (default "")
5750 global
5751 {not in Vi}
5752 This is a comma separated list of words, which specifies when to start
5753 Select mode instead of Visual mode, when a selection is started.
5754 Possible values:
5755 mouse when using the mouse
5756 key when using shifted special keys
5757 cmd when using "v", "V" or CTRL-V
5758 See |Select-mode|.
5759 The 'selectmode' option is set by the |:behave| command.
5760
5761 *'sessionoptions'* *'ssop'*
5762'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005763 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 global
5765 {not in Vi}
5766 {not available when compiled without the +mksession
5767 feature}
5768 Changes the effect of the |:mksession| command. It is a comma
5769 separated list of words. Each word enables saving and restoring
5770 something:
5771 word save and restore ~
5772 blank empty windows
5773 buffers hidden and unloaded buffers, not just those in windows
5774 curdir the current directory
5775 folds manually created folds, opened/closed folds and local
5776 fold options
5777 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005778 and contain at least one lowercase letter. Only
5779 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780 help the help window
5781 localoptions options and mappings local to a window or buffer (not
5782 global values for local options)
5783 options all options and mappings (also global values for local
5784 options)
5785 resize size of the Vim window: 'lines' and 'columns'
5786 sesdir the directory in which the session file is located
5787 will become the current directory (useful with
5788 projects accessed over a network from different
5789 systems)
5790 slash backslashes in file names replaced with forward
5791 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005792 tabpages all tab pages; without this only the current tab page
5793 is restored, so that you can make a session for each
5794 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 unix with Unix end-of-line format (single <NL>), even when
5796 on Windows or DOS
5797 winpos position of the whole Vim window
5798 winsize window sizes
5799
5800 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005801 When neither "curdir" nor "sesdir" is included, file names are stored
5802 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803 "slash" and "unix" are useful on Windows when sharing session files
5804 with Unix. The Unix version of Vim cannot source dos format scripts,
5805 but the Windows version of Vim can source unix format scripts.
5806
5807 *'shell'* *'sh'* *E91*
5808'shell' 'sh' string (default $SHELL or "sh",
5809 MS-DOS and Win32: "command.com" or
5810 "cmd.exe", OS/2: "cmd")
5811 global
5812 Name of the shell to use for ! and :! commands. When changing the
5813 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5814 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005815 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005816 See |option-backslash| about including spaces and backslashes.
5817 Environment variables are expanded |:set_env|.
5818 If the name of the shell contains a space, you might need to enclose
5819 it in quotes. Example: >
5820 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5821< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005822 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005823 "-f" is not inside the quotes, because it is not part of the command
5824 name. And Vim automagically recognizes the backslashes that are path
5825 separators.
5826 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5827 variable to change the way external commands are executed. See the
5828 libc.inf file of DJGPP.
5829 Under MS-Windows, when the executable ends in ".com" it must be
5830 included. Thus setting the shell to "command.com" or "4dos.com"
5831 works, but "command" and "4dos" do not work for all commands (e.g.,
5832 filtering).
5833 For unknown reasons, when using "4dos.com" the current directory is
5834 changed to "C:\". To avoid this set 'shell' like this: >
5835 :set shell=command.com\ /c\ 4dos
5836< This option cannot be set from a |modeline| or in the |sandbox|, for
5837 security reasons.
5838
5839 *'shellcmdflag'* *'shcf'*
5840'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5841 does not contain "sh" somewhere: "/c")
5842 global
5843 {not in Vi}
5844 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5845 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5846 systems, the default is set according to the value of 'shell', to
5847 reduce the need to set this option by the user. It's not used for
5848 OS/2 (EMX figures this out itself). See |option-backslash| about
5849 including spaces and backslashes. See |dos-shell|.
5850 This option cannot be set from a |modeline| or in the |sandbox|, for
5851 security reasons.
5852
5853 *'shellpipe'* *'sp'*
5854'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5855 global
5856 {not in Vi}
5857 {not available when compiled without the |+quickfix|
5858 feature}
5859 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005860 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861 including spaces and backslashes.
5862 The name of the temporary file can be represented by "%s" if necessary
5863 (the file name is appended automatically if no %s appears in the value
5864 of this option).
5865 For the Amiga and MS-DOS the default is ">". The output is directly
5866 saved in a file and not echoed to the screen.
5867 For Unix the default it "| tee". The stdout of the compiler is saved
5868 in a file and echoed to the screen. If the 'shell' option is "csh" or
5869 "tcsh" after initializations, the default becomes "|& tee". If the
5870 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005871 "2>&1| tee". This means that stderr is also included. Before using
5872 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873 The initialization of this option is done after reading the ".vimrc"
5874 and the other initializations, so that when the 'shell' option is set
5875 there, the 'shellpipe' option changes automatically, unless it was
5876 explicitly set before.
5877 When 'shellpipe' is set to an empty string, no redirection of the
5878 ":make" output will be done. This is useful if you use a 'makeprg'
5879 that writes to 'makeef' by itself. If you want no piping, but do
5880 want to include the 'makeef', set 'shellpipe' to a single space.
5881 Don't forget to precede the space with a backslash: ":set sp=\ ".
5882 In the future pipes may be used for filtering and this option will
5883 become obsolete (at least for Unix).
5884 This option cannot be set from a |modeline| or in the |sandbox|, for
5885 security reasons.
5886
5887 *'shellquote'* *'shq'*
5888'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5889 contains "sh" somewhere: "\"")
5890 global
5891 {not in Vi}
5892 Quoting character(s), put around the command passed to the shell, for
5893 the "!" and ":!" commands. The redirection is kept outside of the
5894 quoting. See 'shellxquote' to include the redirection. It's
5895 probably not useful to set both options.
5896 This is an empty string by default. Only known to be useful for
5897 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5898 or bash, where it should be "\"". The default is adjusted according
5899 the value of 'shell', to reduce the need to set this option by the
5900 user. See |dos-shell|.
5901 This option cannot be set from a |modeline| or in the |sandbox|, for
5902 security reasons.
5903
5904 *'shellredir'* *'srr'*
5905'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5906 global
5907 {not in Vi}
5908 String to be used to put the output of a filter command in a temporary
5909 file. See also |:!|. See |option-backslash| about including spaces
5910 and backslashes.
5911 The name of the temporary file can be represented by "%s" if necessary
5912 (the file name is appended automatically if no %s appears in the value
5913 of this option).
5914 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5915 or "zsh" during initializations, the default becomes ">&". If the
5916 'shell' option is "sh", "ksh" or "bash" the default becomes
5917 ">%s 2>&1". This means that stderr is also included.
5918 For Win32, the Unix checks are done and additionally "cmd" is checked
5919 for, which makes the default ">%s 2>&1". Also, the same names with
5920 ".exe" appended are checked for.
5921 The initialization of this option is done after reading the ".vimrc"
5922 and the other initializations, so that when the 'shell' option is set
5923 there, the 'shellredir' option changes automatically unless it was
5924 explicitly set before.
5925 In the future pipes may be used for filtering and this option will
5926 become obsolete (at least for Unix).
5927 This option cannot be set from a |modeline| or in the |sandbox|, for
5928 security reasons.
5929
5930 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5931'shellslash' 'ssl' boolean (default off)
5932 global
5933 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5934 When set, a forward slash is used when expanding file names. This is
5935 useful when a Unix-like shell is used instead of command.com or
5936 cmd.exe. Backward slashes can still be typed, but they are changed to
5937 forward slashes by Vim.
5938 Note that setting or resetting this option has no effect for some
5939 existing file names, thus this option needs to be set before opening
5940 any file for best results. This might change in the future.
5941 'shellslash' only works when a backslash can be used as a path
5942 separator. To test if this is so use: >
5943 if exists('+shellslash')
5944<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005945 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5946'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5947 global
5948 {not in Vi}
5949 When on, use temp files for shell commands. When off use a pipe.
5950 When using a pipe is not possible temp files are used anyway.
5951 Currently a pipe is only supported on Unix. You can check it with: >
5952 :if has("filterpipe")
5953< The advantage of using a pipe is that nobody can read the temp file
5954 and the 'shell' command does not need to support redirection.
5955 The advantage of using a temp file is that the file type and encoding
5956 can be detected.
5957 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5958 |FilterWritePost| autocommands event are not triggered when
5959 'shelltemp' is off.
5960
Bram Moolenaar071d4272004-06-13 20:20:40 +00005961 *'shelltype'* *'st'*
5962'shelltype' 'st' number (default 0)
5963 global
5964 {not in Vi} {only for the Amiga}
5965 On the Amiga this option influences the way how the commands work
5966 which use a shell.
5967 0 and 1: always use the shell
5968 2 and 3: use the shell only to filter lines
5969 4 and 5: use shell only for ':sh' command
5970 When not using the shell, the command is executed directly.
5971
5972 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5973 1 and 3: use "shell cmd" to start external commands
5974
5975 *'shellxquote'* *'sxq'*
5976'shellxquote' 'sxq' string (default: "";
5977 for Win32, when 'shell' contains "sh"
5978 somewhere: "\""
5979 for Unix, when using system(): "\"")
5980 global
5981 {not in Vi}
5982 Quoting character(s), put around the command passed to the shell, for
5983 the "!" and ":!" commands. Includes the redirection. See
5984 'shellquote' to exclude the redirection. It's probably not useful
5985 to set both options.
5986 This is an empty string by default. Known to be useful for
5987 third-party shells when using the Win32 version, such as the MKS Korn
5988 Shell or bash, where it should be "\"". The default is adjusted
5989 according the value of 'shell', to reduce the need to set this option
5990 by the user. See |dos-shell|.
5991 This option cannot be set from a |modeline| or in the |sandbox|, for
5992 security reasons.
5993
5994 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5995'shiftround' 'sr' boolean (default off)
5996 global
5997 {not in Vi}
5998 Round indent to multiple of 'shiftwidth'. Applies to > and <
5999 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6000 a multiple of 'shiftwidth' (this is Vi compatible).
6001 NOTE: This option is reset when 'compatible' is set.
6002
6003 *'shiftwidth'* *'sw'*
6004'shiftwidth' 'sw' number (default 8)
6005 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006006 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007 |'cindent'|, |>>|, |<<|, etc.
6008
6009 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006010'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6011 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 global
6013 {not in Vi}
6014 This option helps to avoid all the |hit-enter| prompts caused by file
6015 messages, for example with CTRL-G, and to avoid some other messages.
6016 It is a list of flags:
6017 flag meaning when present ~
6018 f use "(3 of 5)" instead of "(file 3 of 5)"
6019 i use "[noeol]" instead of "[Incomplete last line]"
6020 l use "999L, 888C" instead of "999 lines, 888 characters"
6021 m use "[+]" instead of "[Modified]"
6022 n use "[New]" instead of "[New File]"
6023 r use "[RO]" instead of "[readonly]"
6024 w use "[w]" instead of "written" for file write message
6025 and "[a]" instead of "appended" for ':w >> file' command
6026 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6027 "[unix format]" and "[mac]" instead of "[mac format]".
6028 a all of the above abbreviations
6029
6030 o overwrite message for writing a file with subsequent message
6031 for reading a file (useful for ":wn" or when 'autowrite' on)
6032 O message for reading a file overwrites any previous message.
6033 Also for quickfix message (e.g., ":cn").
6034 s don't give "search hit BOTTOM, continuing at TOP" or "search
6035 hit TOP, continuing at BOTTOM" messages
6036 t truncate file message at the start if it is too long to fit
6037 on the command-line, "<" will appear in the left most column.
6038 Ignored in Ex mode.
6039 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006040 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041 Ignored in Ex mode.
6042 W don't give "written" or "[w]" when writing a file
6043 A don't give the "ATTENTION" message when an existing swap file
6044 is found.
6045 I don't give the intro message when starting Vim |:intro|.
6046
6047 This gives you the opportunity to avoid that a change between buffers
6048 requires you to hit <Enter>, but still gives as useful a message as
6049 possible for the space available. To get the whole message that you
6050 would have got with 'shm' empty, use ":file!"
6051 Useful values:
6052 shm= No abbreviation of message.
6053 shm=a Abbreviation, but no loss of information.
6054 shm=at Abbreviation, and truncate message when necessary.
6055
6056 NOTE: This option is set to the Vi default value when 'compatible' is
6057 set and to the Vim default value when 'compatible' is reset.
6058
6059 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6060'shortname' 'sn' boolean (default off)
6061 local to buffer
6062 {not in Vi, not in MS-DOS versions}
6063 Filenames are assumed to be 8 characters plus one extension of 3
6064 characters. Multiple dots in file names are not allowed. When this
6065 option is on, dots in file names are replaced with underscores when
6066 adding an extension (".~" or ".swp"). This option is not available
6067 for MS-DOS, because then it would always be on. This option is useful
6068 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6069 or crossdos. When running the Win32 GUI version under Win32s, this
6070 option is always on by default.
6071
6072 *'showbreak'* *'sbr'* *E595*
6073'showbreak' 'sbr' string (default "")
6074 global
6075 {not in Vi}
6076 {not available when compiled without the |+linebreak|
6077 feature}
6078 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006079 values are "> " or "+++ ": >
6080 :set showbreak=>\
6081< Note the backslash to escape the trailing space. It's easier like
6082 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006083 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006084< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 comma (in a future version the comma might be used to separate the
6086 part that is shown at the end and at the start of a line).
6087 The characters are highlighted according to the '@' flag in
6088 'highlight'.
6089 Note that tabs after the showbreak will be displayed differently.
6090 If you want the 'showbreak' to appear in between line numbers, add the
6091 "n" flag to 'cpoptions'.
6092
6093 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6094'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6095 off)
6096 global
6097 {not in Vi}
6098 {not available when compiled without the
6099 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006100 Show (partial) command in the last line of the screen. Set this
6101 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102 In Visual mode the size of the selected area is shown:
6103 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006104 If the number of bytes is different it is also displayed: "2-6"
6105 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006107 - When selecting a block, the size in screen characters:
6108 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006109 NOTE: This option is set to the Vi default value when 'compatible' is
6110 set and to the Vim default value when 'compatible' is reset.
6111
6112 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6113'showfulltag' 'sft' boolean (default off)
6114 global
6115 {not in Vi}
6116 When completing a word in insert mode (see |ins-completion|) from the
6117 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006118 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119 matched a C function, you can see a template for what arguments are
6120 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006121 Note that this doesn't work well together with having "longest" in
6122 'completeopt', because the completion from the search pattern may not
6123 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006124
6125 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6126'showmatch' 'sm' boolean (default off)
6127 global
6128 When a bracket is inserted, briefly jump to the matching one. The
6129 jump is only done if the match can be seen on the screen. The time to
6130 show the match can be set with 'matchtime'.
6131 A Beep is given if there is no match (no matter if the match can be
6132 seen or not). This option is reset when the 'paste' option is set.
6133 When the 'm' flag is not included in 'cpoptions', typing a character
6134 will immediately move the cursor back to where it belongs.
6135 See the "sm" field in 'guicursor' for setting the cursor shape and
6136 blinking when showing the match.
6137 The 'matchpairs' option can be used to specify the characters to show
6138 matches for. 'rightleft' and 'revins' are used to look for opposite
6139 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006140 Also see the matchparen plugin for highlighting the match when moving
6141 around |pi_paren.txt|.
6142 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143
6144 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6145'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6146 global
6147 If in Insert, Replace or Visual mode put a message on the last line.
6148 Use the 'M' flag in 'highlight' to set the type of highlighting for
6149 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006150 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151 doesn't mean XIM is really active, especially when 'imactivatekey' is
6152 not set.
6153 NOTE: This option is set to the Vi default value when 'compatible' is
6154 set and to the Vim default value when 'compatible' is reset.
6155
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006156 *'showtabline'* *'stal'*
6157'showtabline' 'stal' number (default 1)
6158 global
6159 {not in Vi}
6160 {not available when compiled without the +windows
6161 feature}
6162 The value of this option specifies when the line with tab page labels
6163 will be displayed:
6164 0: never
6165 1: only if there are at least two tab pages
6166 2: always
6167 This is both for the GUI and non-GUI implementation of the tab pages
6168 line.
6169 See |tab-page| for more information about tab pages.
6170
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 *'sidescroll'* *'ss'*
6172'sidescroll' 'ss' number (default 0)
6173 global
6174 {not in Vi}
6175 The minimal number of columns to scroll horizontally. Used only when
6176 the 'wrap' option is off and the cursor is moved off of the screen.
6177 When it is zero the cursor will be put in the middle of the screen.
6178 When using a slow terminal set it to a large number or 0. When using
6179 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6180 commands.
6181
6182 *'sidescrolloff'* *'siso'*
6183'sidescrolloff' 'siso' number (default 0)
6184 global
6185 {not in Vi}
6186 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006187 right of the cursor if 'nowrap' is set. Setting this option to a
6188 value greater than 0 while having |'sidescroll'| also at a non-zero
6189 value makes some context visible in the line you are scrolling in
6190 horizontally (except at beginning of the line). Setting this option
6191 to a large value (like 999) has the effect of keeping the cursor
6192 horizontally centered in the window, as long as one does not come too
6193 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194 NOTE: This option is set to 0 when 'compatible' is set.
6195
6196 Example: Try this together with 'sidescroll' and 'listchars' as
6197 in the following example to never allow the cursor to move
6198 onto the "extends" character:
6199
6200 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6201 :set sidescrolloff=1
6202
6203
6204 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6205'smartcase' 'scs' boolean (default off)
6206 global
6207 {not in Vi}
6208 Override the 'ignorecase' option if the search pattern contains upper
6209 case characters. Only used when the search pattern is typed and
6210 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006211 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6213 recalling the search pattern from history and hitting <Enter>.
6214 NOTE: This option is reset when 'compatible' is set.
6215
6216 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6217'smartindent' 'si' boolean (default off)
6218 local to buffer
6219 {not in Vi}
6220 {not available when compiled without the
6221 |+smartindent| feature}
6222 Do smart autoindenting when starting a new line. Works for C-like
6223 programs, but can also be used for other languages. 'cindent' does
6224 something like this, works better in most cases, but is more strict,
6225 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6226 'indentexpr' is a more advanced alternative.
6227 Normally 'autoindent' should also be on when using 'smartindent'.
6228 An indent is automatically inserted:
6229 - After a line ending in '{'.
6230 - After a line starting with a keyword from 'cinwords'.
6231 - Before a line starting with '}' (only with the "O" command).
6232 When typing '}' as the first character in a new line, that line is
6233 given the same indent as the matching '{'.
6234 When typing '#' as the first character in a new line, the indent for
6235 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006236 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6238 When using the ">>" command, lines starting with '#' are not shifted
6239 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006240 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 is set smart indenting is disabled.
6242
6243 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6244'smarttab' 'sta' boolean (default off)
6245 global
6246 {not in Vi}
6247 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006248 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6249 <BS> will delete a 'shiftwidth' worth of space at the start of the
6250 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006251 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006252 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6253 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006254 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006256 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 NOTE: This option is reset when 'compatible' is set.
6258
6259 *'softtabstop'* *'sts'*
6260'softtabstop' 'sts' number (default 0)
6261 local to buffer
6262 {not in Vi}
6263 Number of spaces that a <Tab> counts for while performing editing
6264 operations, like inserting a <Tab> or using <BS>. It "feels" like
6265 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6266 used. This is useful to keep the 'ts' setting at its standard value
6267 of 8, while being able to edit like it is set to 'sts'. However,
6268 commands like "x" still work on the actual characters.
6269 When 'sts' is zero, this feature is off.
6270 'softtabstop' is set to 0 when the 'paste' option is set.
6271 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6272 spaces is minimized by using <Tab>s.
6273 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6274 set.
6275 NOTE: This option is set to 0 when 'compatible' is set.
6276
Bram Moolenaar217ad922005-03-20 22:37:15 +00006277 *'spell'* *'nospell'*
6278'spell' boolean (default off)
6279 local to window
6280 {not in Vi}
6281 {not available when compiled without the |+syntax|
6282 feature}
6283 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006284 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006285
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006286 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006287'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006288 local to buffer
6289 {not in Vi}
6290 {not available when compiled without the |+syntax|
6291 feature}
6292 Pattern to locate the end of a sentence. The following word will be
6293 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006294 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006295 When this check is not wanted make this option empty.
6296 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006297 Be careful with special characters, see |option-backslash| about
6298 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006299 To set this option automatically depending on the language, see
6300 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006301
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006302 *'spellfile'* *'spf'*
6303'spellfile' 'spf' string (default empty)
6304 local to buffer
6305 {not in Vi}
6306 {not available when compiled without the |+syntax|
6307 feature}
6308 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006309 commands. It must end in ".{encoding}.add". You need to include the
6310 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006311 *E765*
6312 It may also be a comma separated list of names. A count before the
6313 |zg| and |zw| commands can be used to access each. This allows using
6314 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006315 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006316 you: Using the first directory in 'runtimepath' that is writable. If
6317 there is no "spell" directory yet it will be created. For the file
6318 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006319 ignoring the region.
6320 The resulting ".spl" file will be used for spell checking, it does not
6321 have to appear in 'spelllang'.
6322 Normally one file is used for all regions, but you can add the region
6323 name if you want to. However, it will then only be used when
6324 'spellfile' is set to it, for entries in 'spelllang' only files
6325 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006326 This option cannot be set from a |modeline| or in the |sandbox|, for
6327 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006328
Bram Moolenaar217ad922005-03-20 22:37:15 +00006329 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006330'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006331 local to buffer
6332 {not in Vi}
6333 {not available when compiled without the |+syntax|
6334 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006335 A comma separated list of word list names. When the 'spell' option is
6336 on spellchecking will be done for these languages. Example: >
6337 set spelllang=en_us,nl,medical
6338< This means US English, Dutch and medical words are recognized. Words
6339 that are not recognized will be highlighted.
6340 The word list name must not include a comma or dot. Using a dash is
6341 recommended to separate the two letter language name from a
6342 specification. Thus "en-rare" is used for rare English words.
6343 A region name must come last and have the form "_xx", where "xx" is
6344 the two-letter, lower case region name. You can use more than one
6345 region by listing them: "en_us,en_ca" supports both US and Canadian
6346 English, but not words specific for Australia, New Zealand or Great
6347 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006348 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006349 As a special case the name of a .spl file can be given as-is. The
6350 first "_xx" in the name is removed and used as the region name
6351 (_xx is an underscore, two letters and followed by a non-letter).
6352 This is mainly for testing purposes. You must make sure the correct
6353 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006354 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006355 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6356 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006357 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006358
Bram Moolenaar98692072006-02-04 00:57:42 +00006359 If the |spellfile.vim| plugin is active and you use a language name
6360 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6361 will ask you if you want to download the file.
6362
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006363 After this option has been set successfully, Vim will source the files
6364 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006365 up to the first comma, dot or underscore.
6366 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006367
6368
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006369 *'spellsuggest'* *'sps'*
6370'spellsuggest' 'sps' string (default "best")
6371 global
6372 {not in Vi}
6373 {not available when compiled without the |+syntax|
6374 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006375 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006376 the |spellsuggest()| function. This is a comma-separated list of
6377 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006378
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006379 best Internal method that works best for English. Finds
6380 changes like "fast" and uses a bit of sound-a-like
6381 scoring to improve the ordering.
6382
6383 double Internal method that uses two methods and mixes the
6384 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006385 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006386 word. That only works when the language specifies
6387 sound folding. Can be slow and doesn't always give
6388 better results.
6389
6390 fast Internal method that only checks for simple changes:
6391 character inserts/deletes/swaps. Works well for
6392 simple typing mistakes.
6393
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006394 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006395 Not used for |spellsuggest()|. The number of
6396 suggestions is never more than the value of 'lines'
6397 minus two.
6398
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006399 file:{filename} Read file {filename}, which must have two columns,
6400 separated by a slash. The first column contains the
6401 bad word, the second column the suggested good word.
6402 Example:
6403 theribal/terrible ~
6404 Use this for common mistakes that do not appear at the
6405 top of the suggestion list with the internal methods.
6406 Lines without a slash are ignored, use this for
6407 comments.
6408 The file is used for all languages.
6409
6410 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6411 trouble with spaces. |v:val| holds the badly spelled
6412 word. The expression must evaluate to a List of
6413 Lists, each with a suggestion and a score.
6414 Example:
6415 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006416 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006417 internal methods use. A lower score is better.
6418 This may invoke |spellsuggest()| if you temporarily
6419 set 'spellsuggest' to exclude the "expr:" part.
6420 Errors are silently ignored, unless you set the
6421 'verbose' option to a non-zero value.
6422
6423 Only one of "best", "double" or "fast" may be used. The others may
6424 appear several times in any order. Example: >
6425 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6426<
6427 This option cannot be set from a |modeline| or in the |sandbox|, for
6428 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006429
6430
Bram Moolenaar071d4272004-06-13 20:20:40 +00006431 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6432'splitbelow' 'sb' boolean (default off)
6433 global
6434 {not in Vi}
6435 {not available when compiled without the +windows
6436 feature}
6437 When on, splitting a window will put the new window below the current
6438 one. |:split|
6439
6440 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6441'splitright' 'spr' boolean (default off)
6442 global
6443 {not in Vi}
6444 {not available when compiled without the +vertsplit
6445 feature}
6446 When on, splitting a window will put the new window right of the
6447 current one. |:vsplit|
6448
6449 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6450'startofline' 'sol' boolean (default on)
6451 global
6452 {not in Vi}
6453 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006454 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006455 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006456 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457 with a linewise operator, with "%" with a count and to buffer changing
6458 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6459 only has a line number, e.g., ":25" or ":+".
6460 In case of buffer changing commands the cursor is placed at the column
6461 where it was the last time the buffer was edited.
6462 NOTE: This option is set when 'compatible' is set.
6463
6464 *'statusline'* *'stl'* *E540* *E541* *E542*
6465'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006466 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 {not in Vi}
6468 {not available when compiled without the |+statusline|
6469 feature}
6470 When nonempty, this option determines the content of the status line.
6471 Also see |status-line|.
6472
6473 The option consists of printf style '%' items interspersed with
6474 normal text. Each status line item is of the form:
6475 %-0{minwid}.{maxwid}{item}
6476 All fields except the {item} is optional. A single percent sign can
6477 be given as "%%". Up to 80 items can be specified.
6478
Bram Moolenaar238a5642006-02-21 22:12:05 +00006479 When the option starts with "%!" then it is used as an expression,
6480 evaluated and the result is used as the option value. Example: >
6481 :set statusline=%!MyStatusLine()
6482< The result can contain %{} items that will be evaluated too.
6483
6484 When there is error while evaluating the option then it will be made
6485 empty to avoid further errors. Otherwise screen updating would loop.
6486
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 Note that the only effect of 'ruler' when this option is set (and
6488 'laststatus' is 2) is controlling the output of |CTRL-G|.
6489
6490 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006491 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006493 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494 minwid Minimum width of the item, padding as set by '-' & '0'.
6495 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006496 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006497 on the left for text items. Numeric items will be
6498 shifted down to maxwid-2 digits followed by '>'number
6499 where number is the amount of missing digits, much like
6500 an exponential notation.
6501 item A one letter code as described below.
6502
6503 Following is a description of the possible statusline items. The
6504 second character in "item" is the type:
6505 N for number
6506 S for string
6507 F for flags as described below
6508 - not applicable
6509
6510 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006511 f S Path to the file in the buffer, as typed or relative to current
6512 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513 F S Full path to the file in the buffer.
6514 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006515 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006517 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006519 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006521 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006523 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6525 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006526 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6528 being used: "<keymap>"
6529 n N Buffer number.
6530 b N Value of byte under cursor.
6531 B N As above, in hexadecimal.
6532 o N Byte number in file of byte under cursor, first byte is 1.
6533 Mnemonic: Offset from start of file (with one added)
6534 {not available when compiled without |+byte_offset| feature}
6535 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006536 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 l N Line number.
6538 L N Number of lines in buffer.
6539 c N Column number.
6540 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006541 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006542 p N Percentage through file in lines as in |CTRL-G|.
6543 P S Percentage through file of displayed window. This is like the
6544 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006545 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006547 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006548 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 ( - Start of item group. Can be used for setting the width and
6550 alignment of a section. Must be followed by %) somewhere.
6551 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006552 T N For 'tabline': start of tab page N label. Use %T after the last
6553 label. This information is used for mouse clicks.
6554 X N For 'tabline': start of close tab N label. Use %X after the
6555 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6556 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557 < - Where to truncate line if too long. Default is at the start.
6558 No width fields allowed.
6559 = - Separation point between left and right aligned items.
6560 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006561 # - Set highlight group. The name must follow and then a # again.
6562 Thus use %#HLname# for highlight group HLname. The same
6563 highlighting is used, also for the statusline of non-current
6564 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006566 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567 The difference between User{N} and StatusLine will be applied
6568 to StatusLineNC for the statusline of non-current windows.
6569 The number N must be between 1 and 9. See |hl-User1..9|
6570
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006571 When displaying a flag, Vim removes the leading comma, if any, when
6572 that flag comes right after plaintext. This will make a nice display
6573 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006574
Bram Moolenaar582fd852005-03-28 20:58:01 +00006575 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 not set) and a minwid is not set for the group, the whole group will
6577 become empty. This will make a group like the following disappear
6578 completely from the statusline when none of the flags are set. >
6579 :set statusline=...%(\ [%M%R%H]%)...
6580<
6581 Beware that an expression is evaluated each and every time the status
6582 line is displayed. The current buffer and current window will be set
6583 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006584 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006585 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006586 real current buffer.
6587
6588 The 'statusline' option may be evaluated in the |sandbox|, see
6589 |sandbox-option|.
6590
6591 It is not allowed to change text or jump to another window while
6592 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006593
6594 If the statusline is not updated when you want it (e.g., after setting
6595 a variable that's used in an expression), you can force an update by
6596 setting an option without changing its value. Example: >
6597 :let &ro = &ro
6598
6599< A result of all digits is regarded a number for display purposes.
6600 Otherwise the result is taken as flag text and applied to the rules
6601 described above.
6602
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006603 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6605 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6606
6607 Examples:
6608 Emulate standard status line with 'ruler' set >
6609 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6610< Similar, but add ASCII value of char under the cursor (like "ga") >
6611 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6612< Display byte count and byte value, modified flag in red. >
6613 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6614 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6615< Display a ,GZ flag if a compressed file is loaded >
6616 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6617< In the |:autocmd|'s: >
6618 :let b:gzflag = 1
6619< And: >
6620 :unlet b:gzflag
6621< And define this function: >
6622 :function VarExists(var, val)
6623 : if exists(a:var) | return a:val | else | return '' | endif
6624 :endfunction
6625<
6626 *'suffixes'* *'su'*
6627'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6628 global
6629 {not in Vi}
6630 Files with these suffixes get a lower priority when multiple files
6631 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006632 suffixes. Spaces after the comma are ignored. A dot is also seen as
6633 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 separator, precede it with a backslash (see |option-backslash| about
6635 including spaces and backslashes).
6636 See 'wildignore' for completely ignoring files.
6637 The use of |:set+=| and |:set-=| is preferred when adding or removing
6638 suffixes from the list. This avoids problems when a future version
6639 uses another default.
6640
6641 *'suffixesadd'* *'sua'*
6642'suffixesadd' 'sua' string (default "")
6643 local to buffer
6644 {not in Vi}
6645 {not available when compiled without the
6646 |+file_in_path| feature}
6647 Comma separated list of suffixes, which are used when searching for a
6648 file for the "gf", "[I", etc. commands. Example: >
6649 :set suffixesadd=.java
6650<
6651 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6652'swapfile' 'swf' boolean (default on)
6653 local to buffer
6654 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006655 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 swapfile is not wanted for a specific buffer. For example, with
6657 confidential information that even root must not be able to access.
6658 Careful: All text will be in memory:
6659 - Don't use this for big files.
6660 - Recovery will be impossible!
6661 A swapfile will only be present when |'updatecount'| is non-zero and
6662 'swapfile' is set.
6663 When 'swapfile' is reset, the swap file for the current buffer is
6664 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6665 non-zero, a swap file is immediately created.
6666 Also see |swap-file| and |'swapsync'|.
6667
6668 This option is used together with 'bufhidden' and 'buftype' to
6669 specify special kinds of buffers. See |special-buffers|.
6670
6671 *'swapsync'* *'sws'*
6672'swapsync' 'sws' string (default "fsync")
6673 global
6674 {not in Vi}
6675 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006676 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 When this option is empty parts of the swap file may be in memory and
6678 not written to disk. When the system crashes you may lose more work.
6679 On Unix the system does a sync now and then without Vim asking for it,
6680 so the disadvantage of setting this option off is small. On some
6681 systems the swap file will not be written at all. For a unix system
6682 setting it to "sync" will use the sync() call instead of the default
6683 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006684 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685
6686 *'switchbuf'* *'swb'*
6687'switchbuf' 'swb' string (default "")
6688 global
6689 {not in Vi}
6690 This option controls the behavior when switching between buffers.
6691 Possible values (comma separated list):
6692 useopen If included, jump to the first open window that
6693 contains the specified buffer (if there is one).
6694 Otherwise: Do not examine other windows.
6695 This setting is checked with |quickfix| commands, when
6696 jumping to errors (":cc", ":cn", "cp", etc.). It is
6697 also used in all buffer related split commands, for
6698 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006699 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006700 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006702 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006704 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006705 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006707 *'synmaxcol'* *'smc'*
6708'synmaxcol' 'smc' number (default 3000)
6709 local to buffer
6710 {not in Vi}
6711 {not available when compiled without the |+syntax|
6712 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006713 Maximum column in which to search for syntax items. In long lines the
6714 text after this column is not highlighted and following lines may not
6715 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006716 This helps to avoid very slow redrawing for an XML file that is one
6717 long line.
6718 Set to zero to remove the limit.
6719
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 *'syntax'* *'syn'*
6721'syntax' 'syn' string (default empty)
6722 local to buffer
6723 {not in Vi}
6724 {not available when compiled without the |+syntax|
6725 feature}
6726 When this option is set, the syntax with this name is loaded, unless
6727 syntax highlighting has been switched off with ":syntax off".
6728 Otherwise this option does not always reflect the current syntax (the
6729 b:current_syntax variable does).
6730 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006731 not automatically recognized. Example, in an IDL file:
6732 /* vim: set syntax=idl : */ ~
6733 When a dot appears in the value then this separates two filetype
6734 names. Example:
6735 /* vim: set syntax=c.doxygen : */ ~
6736 This will use the "c" syntax first, then the "doxygen" syntax.
6737 Note that the second one must be prepared to be loaded as an addition,
6738 otherwise it will be skipped. More than one dot may appear.
6739 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 :set syntax=OFF
6741< To switch syntax highlighting on according to the current value of the
6742 'filetype' option: >
6743 :set syntax=ON
6744< What actually happens when setting the 'syntax' option is that the
6745 Syntax autocommand event is triggered with the value as argument.
6746 This option is not copied to another buffer, independent of the 's' or
6747 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006748 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006750 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006751'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006752 global
6753 {not in Vi}
6754 {not available when compiled without the +windows
6755 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006756 When nonempty, this option determines the content of the tab pages
6757 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006758 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006759
6760 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006761 option and only when there is no GUI tab line. When 'e' is in
6762 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6763 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006764
6765 The value is evaluated like with 'statusline'. You can use
6766 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006767 the text to be displayed. Use "%1T" for the first label, "%2T" for
6768 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006769
6770 Keep in mind that only one of the tab pages is the current one, others
6771 are invisible and you can't jump to their windows.
6772
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006773
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006774 *'tabpagemax'* *'tpm'*
6775'tabpagemax' 'tpm' number (default 10)
6776 global
6777 {not in Vi}
6778 {not available when compiled without the +windows
6779 feature}
6780 Maximum number of tab pages to be opened by the |-p| command line
6781 argument or the ":tab all" command. |tabpage|
6782
6783
6784 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785'tabstop' 'ts' number (default 8)
6786 local to buffer
6787 Number of spaces that a <Tab> in the file counts for. Also see
6788 |:retab| command, and 'softtabstop' option.
6789
6790 Note: Setting 'tabstop' to any other value than 8 can make your file
6791 appear wrong in many places (e.g., when printing it).
6792
6793 There are four main ways to use tabs in Vim:
6794 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6795 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006796 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 behave like a tab appears every 4 (or 3) characters.
6798 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6799 'expandtab'. This way you will always insert spaces. The
6800 formatting will never be messed up when 'tabstop' is changed.
6801 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006802 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803 works when using Vim to edit the file.
6804 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6805 'noexpandtab'. This should then work (for initial indents only)
6806 for any tabstop setting that people use. It might be nice to have
6807 tabs after the first non-blank inserted as spaces if you do this
6808 though. Otherwise aligned comments will be wrong when 'tabstop' is
6809 changed.
6810
6811 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6812'tagbsearch' 'tbs' boolean (default on)
6813 global
6814 {not in Vi}
6815 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006816 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 searching makes searching for a tag a LOT faster, but a linear search
6818 will find more tags if the tags file wasn't properly sorted.
6819 Vim normally assumes that your tags files are sorted, or indicate that
6820 they are not sorted. Only when this is not the case does the
6821 'tagbsearch' option need to be switched off.
6822
6823 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006824 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 certain files, or retry all files with a linear search. When
6826 'tagbsearch' is off, only a linear search is done.
6827
6828 Linear searching is done anyway, for one file, when Vim finds a line
6829 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006830 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831< [The whitespace before and after the '0' must be a single <Tab>]
6832
6833 When a binary search was done and no match was found in any of the
6834 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6835 instead of a normal tag name, a retry is done with a linear search.
6836 Tags in unsorted tags files, and matches with different case will only
6837 be found in the retry.
6838
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006839 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 linear search can be avoided for the 'ignorecase' case. Use a value
6841 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6842 case-fold sorted with the -f switch to "sort" in most unices, as in
6843 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006844 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6845 for this as well. Note that case must be folded to uppercase for this
6846 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847
6848 When 'tagbsearch' is off, tags searching is slower when a full match
6849 exists, but faster when no full match exists. Tags in unsorted tags
6850 files may only be found with 'tagbsearch' off.
6851 When the tags file is not sorted, or sorted in a wrong way (not on
6852 ASCII byte value), 'tagbsearch' should be off, or the line given above
6853 must be included in the tags file.
6854 This option doesn't affect commands that find all matching tags (e.g.,
6855 command-line completion and ":help").
6856 {Vi: always uses binary search in some versions}
6857
6858 *'taglength'* *'tl'*
6859'taglength' 'tl' number (default 0)
6860 global
6861 If non-zero, tags are significant up to this number of characters.
6862
6863 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6864'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6865 global
6866 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006867 If on and using a tags file in another directory, file names in that
6868 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 NOTE: This option is set to the Vi default value when 'compatible' is
6870 set and to the Vim default value when 'compatible' is reset.
6871
6872 *'tags'* *'tag'* *E433*
6873'tags' 'tag' string (default "./tags,tags", when compiled with
6874 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6875 global or local to buffer |global-local|
6876 Filenames for the tag command, separated by spaces or commas. To
6877 include a space or comma in a file name, precede it with a backslash
6878 (see |option-backslash| about including spaces and backslashes).
6879 When a file name starts with "./", the '.' is replaced with the path
6880 of the current file. But only when the 'd' flag is not included in
6881 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6882 |tags-option|.
6883 "*", "**" and other wildcards can be used to search for tags files in
6884 a directory tree. See |file-searching|. {not available when compiled
6885 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006886 The |tagfiles()| function can be used to get a list of the file names
6887 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6889 files are also supported. They are automatically recognized. The
6890 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6891 differences are ignored (MS-Windows). |emacs-tags|
6892 The use of |:set+=| and |:set-=| is preferred when adding or removing
6893 file names from the list. This avoids problems when a future version
6894 uses another default.
6895 {Vi: default is "tags /usr/lib/tags"}
6896
6897 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6898'tagstack' 'tgst' boolean (default on)
6899 global
6900 {not in all versions of Vi}
6901 When on, the |tagstack| is used normally. When off, a ":tag" or
6902 ":tselect" command with an argument will not push the tag onto the
6903 tagstack. A following ":tag" without an argument, a ":pop" command or
6904 any other command that uses the tagstack will use the unmodified
6905 tagstack, but does change the pointer to the active entry.
6906 Resetting this option is useful when using a ":tag" command in a
6907 mapping which should not change the tagstack.
6908
6909 *'term'* *E529* *E530* *E531*
6910'term' string (default is $TERM, if that fails:
6911 in the GUI: "builtin_gui"
6912 on Amiga: "amiga"
6913 on BeOS: "beos-ansi"
6914 on Mac: "mac-ansi"
6915 on MiNT: "vt52"
6916 on MS-DOS: "pcterm"
6917 on OS/2: "os2ansi"
6918 on Unix: "ansi"
6919 on VMS: "ansi"
6920 on Win 32: "win32")
6921 global
6922 Name of the terminal. Used for choosing the terminal control
6923 characters. Environment variables are expanded |:set_env|.
6924 For example: >
6925 :set term=$TERM
6926< See |termcap|.
6927
6928 *'termbidi'* *'tbidi'*
6929 *'notermbidi'* *'notbidi'*
6930'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6931 global
6932 {not in Vi}
6933 {only available when compiled with the |+arabic|
6934 feature}
6935 The terminal is in charge of Bi-directionality of text (as specified
6936 by Unicode). The terminal is also expected to do the required shaping
6937 that some languages (such as Arabic) require.
6938 Setting this option implies that 'rightleft' will not be set when
6939 'arabic' is set and the value of 'arabicshape' will be ignored.
6940 Note that setting 'termbidi' has the immediate effect that
6941 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6942 This option is reset when the GUI is started.
6943 For further details see |arabic.txt|.
6944
6945 *'termencoding'* *'tenc'*
6946'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6947 Macintosh GUI: "macroman")
6948 global
6949 {only available when compiled with the |+multi_byte|
6950 feature}
6951 {not in Vi}
6952 Encoding used for the terminal. This specifies what character
6953 encoding the keyboard produces and the display will understand. For
6954 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006955 display). Except for the Mac when 'macatsui' is off, then
6956 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 In the Win32 console version the default value is the console codepage
6958 when it differs from the ANSI codepage.
6959 *E617*
6960 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6961 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6962 Any attempts to set a different value will be rejected, and an error
6963 message is shown.
6964 For the Win32 GUI 'termencoding' is not used for typed characters,
6965 because the Win32 system always passes Unicode characters.
6966 When empty, the same encoding is used as for the 'encoding' option.
6967 This is the normal value.
6968 Not all combinations for 'termencoding' and 'encoding' are valid. See
6969 |encoding-table|.
6970 The value for this option must be supported by internal conversions or
6971 iconv(). When this is not possible no conversion will be done and you
6972 will probably experience problems with non-ASCII characters.
6973 Example: You are working with the locale set to euc-jp (Japanese) and
6974 want to edit a UTF-8 file: >
6975 :let &termencoding = &encoding
6976 :set encoding=utf-8
6977< You need to do this when your system has no locale support for UTF-8.
6978
6979 *'terse'* *'noterse'*
6980'terse' boolean (default off)
6981 global
6982 When set: Add 's' flag to 'shortmess' option (this makes the message
6983 for a search that hits the start or end of the file not being
6984 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6985 shortens a lot of messages}
6986
6987 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6988'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6989 global
6990 {not in Vi}
6991 This option is obsolete. Use 'fileformats'.
6992 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6993 set to the default value for the current system. When 'textauto' is
6994 reset, 'fileformats' is made empty.
6995 NOTE: This option is set to the Vi default value when 'compatible' is
6996 set and to the Vim default value when 'compatible' is reset.
6997
6998 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6999'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7000 others: default off)
7001 local to buffer
7002 {not in Vi}
7003 This option is obsolete. Use 'fileformat'.
7004 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7005 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7006 "unix".
7007
7008 *'textwidth'* *'tw'*
7009'textwidth' 'tw' number (default 0)
7010 local to buffer
7011 {not in Vi}
7012 Maximum width of text that is being inserted. A longer line will be
7013 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007014 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7015 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007017 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007018 NOTE: This option is set to 0 when 'compatible' is set.
7019
7020 *'thesaurus'* *'tsr'*
7021'thesaurus' 'tsr' string (default "")
7022 global or local to buffer |global-local|
7023 {not in Vi}
7024 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007025 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007026 the file should contain words with similar meaning, separated by
7027 non-keyword characters (white space is preferred). Maximum line
7028 length is 510 bytes.
7029 To obtain a file to be used here, check out the wordlist FAQ at
7030 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007031 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 after a comma are ignored, otherwise spaces are included in the file
7033 name. See |option-backslash| about using backslashes.
7034 The use of |:set+=| and |:set-=| is preferred when adding or removing
7035 directories from the list. This avoids problems when a future version
7036 uses another default.
7037 Backticks cannot be used in this option for security reasons.
7038
7039 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7040'tildeop' 'top' boolean (default off)
7041 global
7042 {not in Vi}
7043 When on: The tilde command "~" behaves like an operator.
7044 NOTE: This option is reset when 'compatible' is set.
7045
7046 *'timeout'* *'to'* *'notimeout'* *'noto'*
7047'timeout' 'to' boolean (default on)
7048 global
7049 *'ttimeout'* *'nottimeout'*
7050'ttimeout' boolean (default off)
7051 global
7052 {not in Vi}
7053 These two options together determine the behavior when part of a
7054 mapped key sequence or keyboard code has been received:
7055
7056 'timeout' 'ttimeout' action ~
7057 off off do not time out
7058 on on or off time out on :mappings and key codes
7059 off on time out on key codes
7060
7061 If both options are off, Vim will wait until either the complete
7062 mapping or key sequence has been received, or it is clear that there
7063 is no mapping or key sequence for the received characters. For
7064 example: if you have mapped "vl" and Vim has received 'v', the next
7065 character is needed to see if the 'v' is followed by an 'l'.
7066 When one of the options is on, Vim will wait for about 1 second for
7067 the next character to arrive. After that the already received
7068 characters are interpreted as single characters. The waiting time can
7069 be changed with the 'timeoutlen' option.
7070 On slow terminals or very busy systems timing out may cause
7071 malfunctioning cursor keys. If both options are off, Vim waits
7072 forever after an entered <Esc> if there are key codes that start
7073 with <Esc>. You will have to type <Esc> twice. If you do not have
7074 problems with key codes, but would like to have :mapped key
7075 sequences not timing out in 1 second, set the 'ttimeout' option and
7076 reset the 'timeout' option.
7077
7078 NOTE: 'ttimeout' is reset when 'compatible' is set.
7079
7080 *'timeoutlen'* *'tm'*
7081'timeoutlen' 'tm' number (default 1000)
7082 global
7083 {not in all versions of Vi}
7084 *'ttimeoutlen'* *'ttm'*
7085'ttimeoutlen' 'ttm' number (default -1)
7086 global
7087 {not in Vi}
7088 The time in milliseconds that is waited for a key code or mapped key
7089 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7090 when part of a command has been typed.
7091 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7092 different timeout value for key codes is desired set 'ttimeoutlen' to
7093 a non-negative number.
7094
7095 ttimeoutlen mapping delay key code delay ~
7096 < 0 'timeoutlen' 'timeoutlen'
7097 >= 0 'timeoutlen' 'ttimeoutlen'
7098
7099 The timeout only happens when the 'timeout' and 'ttimeout' options
7100 tell so. A useful setting would be >
7101 :set timeout timeoutlen=3000 ttimeoutlen=100
7102< (time out on mapping after three seconds, time out on key codes after
7103 a tenth of a second).
7104
7105 *'title'* *'notitle'*
7106'title' boolean (default off, on when title can be restored)
7107 global
7108 {not in Vi}
7109 {not available when compiled without the |+title|
7110 feature}
7111 When on, the title of the window will be set to the value of
7112 'titlestring' (if it is not empty), or to:
7113 filename [+=-] (path) - VIM
7114 Where:
7115 filename the name of the file being edited
7116 - indicates the file cannot be modified, 'ma' off
7117 + indicates the file was modified
7118 = indicates the file is read-only
7119 =+ indicates the file is read-only and modified
7120 (path) is the path of the file being edited
7121 - VIM the server name |v:servername| or "VIM"
7122 Only works if the terminal supports setting window titles
7123 (currently Amiga console, Win32 console, all GUI versions and
7124 terminals with a non- empty 't_ts' option - these are Unix xterm and
7125 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7126 *X11*
7127 When Vim was compiled with HAVE_X11 defined, the original title will
7128 be restored if possible. The output of ":version" will include "+X11"
7129 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7130 works for the icon name |'icon'|.
7131 But: When Vim was started with the |-X| argument, restoring the title
7132 will not work (except in the GUI).
7133 If the title cannot be restored, it is set to the value of 'titleold'.
7134 You might want to restore the title outside of Vim then.
7135 When using an xterm from a remote machine you can use this command:
7136 rsh machine_name xterm -display $DISPLAY &
7137 then the WINDOWID environment variable should be inherited and the
7138 title of the window should change back to what it should be after
7139 exiting Vim.
7140
7141 *'titlelen'*
7142'titlelen' number (default 85)
7143 global
7144 {not in Vi}
7145 {not available when compiled without the |+title|
7146 feature}
7147 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007148 title. When the title is longer, only the end of the path name is
7149 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007150 Using a percentage makes this adapt to the width of the window. But
7151 it won't work perfectly, because the actual number of characters
7152 available also depends on the font used and other things in the title
7153 bar. When 'titlelen' is zero the full path is used. Otherwise,
7154 values from 1 to 30000 percent can be used.
7155 'titlelen' is also used for the 'titlestring' option.
7156
7157 *'titleold'*
7158'titleold' string (default "Thanks for flying Vim")
7159 global
7160 {not in Vi}
7161 {only available when compiled with the |+title|
7162 feature}
7163 This option will be used for the window title when exiting Vim if the
7164 original title cannot be restored. Only happens if 'title' is on or
7165 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007166 This option cannot be set from a |modeline| or in the |sandbox|, for
7167 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168 *'titlestring'*
7169'titlestring' string (default "")
7170 global
7171 {not in Vi}
7172 {not available when compiled without the |+title|
7173 feature}
7174 When this option is not empty, it will be used for the title of the
7175 window. This happens only when the 'title' option is on.
7176 Only works if the terminal supports setting window titles (currently
7177 Amiga console, Win32 console, all GUI versions and terminals with a
7178 non-empty 't_ts' option).
7179 When Vim was compiled with HAVE_X11 defined, the original title will
7180 be restored if possible |X11|.
7181 When this option contains printf-style '%' items, they will be
7182 expanded according to the rules used for 'statusline'.
7183 Example: >
7184 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7185 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7186< The value of 'titlelen' is used to align items in the middle or right
7187 of the available space.
7188 Some people prefer to have the file name first: >
7189 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7190< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007191 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007192 separating space only when needed.
7193 NOTE: Use of special characters in 'titlestring' may cause the display
7194 to be garbled (e.g., when it contains a CR or NL character).
7195 {not available when compiled without the |+statusline| feature}
7196
7197 *'toolbar'* *'tb'*
7198'toolbar' 'tb' string (default "icons,tooltips")
7199 global
7200 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7201 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007202 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 possible values are:
7204 icons Toolbar buttons are shown with icons.
7205 text Toolbar buttons shown with text.
7206 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007207 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 tooltips Tooltips are active for toolbar buttons.
7209 Tooltips refer to the popup help text which appears after the mouse
7210 cursor is placed over a toolbar button for a brief moment.
7211
7212 If you want the toolbar to be shown with icons as well as text, do the
7213 following: >
7214 :set tb=icons,text
7215< Motif and Athena cannot display icons and text at the same time. They
7216 will show icons if both are requested.
7217
7218 If none of the strings specified in 'toolbar' are valid or if
7219 'toolbar' is empty, this option is ignored. If you want to disable
7220 the toolbar, you need to set the 'guioptions' option. For example: >
7221 :set guioptions-=T
7222< Also see |gui-toolbar|.
7223
7224 *'toolbariconsize'* *'tbis'*
7225'toolbariconsize' 'tbis' string (default "small")
7226 global
7227 {not in Vi}
7228 {only in the GTK+ 2 GUI}
7229 Controls the size of toolbar icons. The possible values are:
7230 tiny Use tiny toolbar icons.
7231 small Use small toolbar icons (default).
7232 medium Use medium-sized toolbar icons.
7233 large Use large toolbar icons.
7234 The exact dimensions in pixels of the various icon sizes depend on
7235 the current theme. Common dimensions are large=32x32, medium=24x24,
7236 small=20x20 and tiny=16x16.
7237
7238 If 'toolbariconsize' is empty, the global default size as determined
7239 by user preferences or the current theme is used.
7240
7241 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7242'ttybuiltin' 'tbi' boolean (default on)
7243 global
7244 {not in Vi}
7245 When on, the builtin termcaps are searched before the external ones.
7246 When off the builtin termcaps are searched after the external ones.
7247 When this option is changed, you should set the 'term' option next for
7248 the change to take effect, for example: >
7249 :set notbi term=$TERM
7250< See also |termcap|.
7251 Rationale: The default for this option is "on", because the builtin
7252 termcap entries are generally better (many systems contain faulty
7253 xterm entries...).
7254
7255 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7256'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7257 sun-cmd, screen, rxvt, dtterm or
7258 iris-ansi; also on when running Vim in
7259 a DOS console)
7260 global
7261 {not in Vi}
7262 Indicates a fast terminal connection. More characters will be sent to
7263 the screen for redrawing, instead of using insert/delete line
7264 commands. Improves smoothness of redrawing when there are multiple
7265 windows and the terminal does not support a scrolling region.
7266 Also enables the extra writing of characters at the end of each screen
7267 line for lines that wrap. This helps when using copy/paste with the
7268 mouse in an xterm and other terminals.
7269
7270 *'ttymouse'* *'ttym'*
7271'ttymouse' 'ttym' string (default depends on 'term')
7272 global
7273 {not in Vi}
7274 {only in Unix and VMS, doesn't work in the GUI; not
7275 available when compiled without |+mouse|}
7276 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007277 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 *xterm-mouse*
7279 xterm xterm-like mouse handling. The mouse generates
7280 "<Esc>[Mscr", where "scr" is three bytes:
7281 "s" = button state
7282 "c" = column plus 33
7283 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007284 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007285 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286 xterm2 Works like "xterm", but with the xterm reporting the
7287 mouse position while the mouse is dragged. This works
7288 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007289 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 work. See below for how Vim detects this
7291 automatically.
7292 *netterm-mouse*
7293 netterm NetTerm mouse handling. The mouse generates
7294 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7295 for the row and column.
7296 *dec-mouse*
7297 dec DEC terminal mouse handling. The mouse generates a
7298 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007299 This is also available for an Xterm, if it was
7300 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007301 *jsbterm-mouse*
7302 jsbterm JSB term mouse handling.
7303 *pterm-mouse*
7304 pterm QNX pterm mouse handling.
7305
7306 The mouse handling must be enabled at compile time |+mouse_xterm|
7307 |+mouse_dec| |+mouse_netterm|.
7308 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7309 recognized, if enabled at compile time. DEC terminal mouse codes
7310 are recognized if enabled at compile time, and 'ttymouse' is not
7311 "xterm" (because the xterm and dec mouse codes conflict).
7312 This option is automatically set to "xterm", when the 'term' option is
7313 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7314 or "xterm2" already. The main use of this option is to set it to
7315 "xterm", when the terminal name doesn't start with "xterm", but it can
7316 handle xterm mouse codes.
7317 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007318 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319 feature and if |t_RV| is set to the escape sequence to request the
7320 xterm version number. Otherwise "xterm2" must be set explicitly.
7321 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7322 t_RV to an empty string: >
7323 :set t_RV=
7324<
7325 *'ttyscroll'* *'tsl'*
7326'ttyscroll' 'tsl' number (default 999)
7327 global
7328 Maximum number of lines to scroll the screen. If there are more lines
7329 to scroll the window is redrawn. For terminals where scrolling is
7330 very slow and redrawing is not slow this can be set to a small number,
7331 e.g., 3, to speed up displaying.
7332
7333 *'ttytype'* *'tty'*
7334'ttytype' 'tty' string (default from $TERM)
7335 global
7336 Alias for 'term', see above.
7337
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007338 *'undodir'* *'udir'*
7339'undodir' 'udir' string (default ".")
7340 global
7341 {not in Vi}
7342 {only when compiled with the +persistent_undo feature}
7343 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007344 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007345 "." means using the directory of the file. The undo file name for
7346 "file.txt" is ".file.txt.un~".
7347 For other directories the file name is the full path of the edited
7348 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007349 When writing: The first directory that exists is used. "." always
7350 works, no directories after "." will be used for writing.
7351 When reading all entries are tried to find an undo file. The first
7352 undo file that exists is used. When it cannot be read an error is
7353 given, no further entry is used.
7354 See |undo-persistence|.
7355
7356 *'undofile'* *'udf'*
7357'undofile' 'udf' boolean (default off)
7358 local to buffer
7359 {not in Vi}
7360 {only when compiled with the +persistent_undo feature}
7361 When on, Vim automatically saves undo history to an undo file when
7362 writing a buffer to a file, and restores undo history from the same
7363 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007364 The directory where the undo file is stored is specified by 'undodir'.
7365 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007366 The undo file is not read when 'undoreload' causes the buffer from
7367 before a reload to be saved for undo.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007368 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007369
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370 *'undolevels'* *'ul'*
7371'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7372 Win32 and OS/2)
7373 global
7374 {not in Vi}
7375 Maximum number of changes that can be undone. Since undo information
7376 is kept in memory, higher numbers will cause more memory to be used
7377 (nevertheless, a single change can use an unlimited amount of memory).
7378 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7379 itself: >
7380 set ul=0
7381< But you can also get Vi compatibility by including the 'u' flag in
7382 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007383 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 Set to a negative number for no undo at all: >
7385 set ul=-1
7386< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007387 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007389 *'undoreload'* *'ur'*
7390'undoreload' 'ur' number (default 10000)
7391 global
7392 {not in Vi}
7393 Save the whole buffer for undo when reloading it. This applies to the
7394 ":e!" command and reloading for when the buffer changed outside of
7395 Vim. |FileChangedShell|
7396 The save only happens when this options is negative or when the number
7397 of lines is smaller than the value of this option.
7398 Set this option to zero to disable undo for a reload.
7399
7400 When saving undo for a reload, any undo file is not read.
7401
7402 Note that this causes the whole buffer to be stored in memory. Set
7403 this option to a lower value if you run out of memory.
7404
Bram Moolenaar071d4272004-06-13 20:20:40 +00007405 *'updatecount'* *'uc'*
7406'updatecount' 'uc' number (default: 200)
7407 global
7408 {not in Vi}
7409 After typing this many characters the swap file will be written to
7410 disk. When zero, no swap file will be created at all (see chapter on
7411 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7412 Vim with the "-n" option, see |startup|. When editing in readonly
7413 mode this option will be initialized to 10000.
7414 The swapfile can be disabled per buffer with |'swapfile'|.
7415 When 'updatecount' is set from zero to non-zero, swap files are
7416 created for all buffers that have 'swapfile' set. When 'updatecount'
7417 is set to zero, existing swap files are not deleted.
7418 Also see |'swapsync'|.
7419 This option has no meaning in buffers where |'buftype'| is "nofile"
7420 or "nowrite".
7421
7422 *'updatetime'* *'ut'*
7423'updatetime' 'ut' number (default 4000)
7424 global
7425 {not in Vi}
7426 If this many milliseconds nothing is typed the swap file will be
7427 written to disk (see |crash-recovery|). Also used for the
7428 |CursorHold| autocommand event.
7429
7430 *'verbose'* *'vbs'*
7431'verbose' 'vbs' number (default 0)
7432 global
7433 {not in Vi, although some versions have a boolean
7434 verbose option}
7435 When bigger than zero, Vim will give messages about what it is doing.
7436 Currently, these messages are given:
7437 >= 1 When the viminfo file is read or written.
7438 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007439 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440 >= 8 Files for which a group of autocommands is executed.
7441 >= 9 Every executed autocommand.
7442 >= 12 Every executed function.
7443 >= 13 When an exception is thrown, caught, finished, or discarded.
7444 >= 14 Anything pending in a ":finally" clause.
7445 >= 15 Every executed Ex command (truncated at 200 characters).
7446
7447 This option can also be set with the "-V" argument. See |-V|.
7448 This option is also set by the |:verbose| command.
7449
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007450 When the 'verbosefile' option is set then the verbose messages are not
7451 displayed.
7452
7453 *'verbosefile'* *'vfile'*
7454'verbosefile' 'vfile' string (default empty)
7455 global
7456 {not in Vi}
7457 When not empty all messages are written in a file with this name.
7458 When the file exists messages are appended.
7459 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007460 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007461 Setting 'verbosefile' to a new value is like making it empty first.
7462 The difference with |:redir| is that verbose messages are not
7463 displayed when 'verbosefile' is set.
7464
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 *'viewdir'* *'vdir'*
7466'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7467 "$VIM/vimfiles/view",
7468 for Unix: "~/.vim/view",
7469 for Macintosh: "$VIM:vimfiles:view"
7470 for VMS: "sys$login:vimfiles/view"
7471 for RiscOS: "Choices:vimfiles/view")
7472 global
7473 {not in Vi}
7474 {not available when compiled without the +mksession
7475 feature}
7476 Name of the directory where to store files for |:mkview|.
7477 This option cannot be set from a |modeline| or in the |sandbox|, for
7478 security reasons.
7479
7480 *'viewoptions'* *'vop'*
7481'viewoptions' 'vop' string (default: "folds,options,cursor")
7482 global
7483 {not in Vi}
7484 {not available when compiled without the +mksession
7485 feature}
7486 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007487 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 word save and restore ~
7489 cursor cursor position in file and in window
7490 folds manually created folds, opened/closed folds and local
7491 fold options
7492 options options and mappings local to a window or buffer (not
7493 global values for local options)
7494 slash backslashes in file names replaced with forward
7495 slashes
7496 unix with Unix end-of-line format (single <NL>), even when
7497 on Windows or DOS
7498
7499 "slash" and "unix" are useful on Windows when sharing view files
7500 with Unix. The Unix version of Vim cannot source dos format scripts,
7501 but the Windows version of Vim can source unix format scripts.
7502
7503 *'viminfo'* *'vi'* *E526* *E527* *E528*
7504'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007505 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7506 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7507 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 global
7509 {not in Vi}
7510 {not available when compiled without the |+viminfo|
7511 feature}
7512 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007513 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514 separated list of parameters, each consisting of a single character
7515 identifying the particular parameter, followed by a number or string
7516 which specifies the value of that parameter. If a particular
7517 character is left out, then the default value is used for that
7518 parameter. The following is a list of the identifying characters and
7519 the effect of their value.
7520 CHAR VALUE ~
7521 ! When included, save and restore global variables that start
7522 with an uppercase letter, and don't contain a lowercase
7523 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007524 and "_K_L_M" are not. Only String and Number types are
7525 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526 " Maximum number of lines saved for each register. Old name of
7527 the '<' item, with the disadvantage that you need to put a
7528 backslash before the ", otherwise it will be recognized as the
7529 start of a comment!
7530 % When included, save and restore the buffer list. If Vim is
7531 started with a file name argument, the buffer list is not
7532 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007533 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007534 without a file name and buffers for help files are not written
7535 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007536 When followed by a number, the number specifies the maximum
7537 number of buffers that are stored. Without a number all
7538 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539 ' Maximum number of previously edited files for which the marks
7540 are remembered. This parameter must always be included when
7541 'viminfo' is non-empty.
7542 Including this item also means that the |jumplist| and the
7543 |changelist| are stored in the viminfo file.
7544 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007545 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 patterns are also saved. When not included, the value of
7547 'history' is used.
7548 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007549 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007550 < Maximum number of lines saved for each register. If zero then
7551 registers are not saved. When not included, all lines are
7552 saved. '"' is the old name for this item.
7553 Also see the 's' item below: limit specified in Kbyte.
7554 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007555 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556 c When included, convert the text in the viminfo file from the
7557 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007558 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007559 f Whether file marks need to be stored. If zero, file marks ('0
7560 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007561 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 cursor position (when exiting or when doing ":wviminfo").
7563 h Disable the effect of 'hlsearch' when loading the viminfo
7564 file. When not included, it depends on whether ":nohlsearch"
7565 has been used since the last search command.
7566 n Name of the viminfo file. The name must immediately follow
7567 the 'n'. Must be the last one! If the "-i" argument was
7568 given when starting Vim, that file name overrides the one
7569 given here with 'viminfo'. Environment variables are expanded
7570 when opening the file, not when setting the option.
7571 r Removable media. The argument is a string (up to the next
7572 ','). This parameter can be given several times. Each
7573 specifies the start of a path for which no marks will be
7574 stored. This is to avoid removable media. For MS-DOS you
7575 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7576 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7577 ignored. Maximum length of each 'r' argument is 50
7578 characters.
7579 s Maximum size of an item in Kbyte. If zero then registers are
7580 not saved. Currently only applies to registers. The default
7581 "s10" will exclude registers with more than 10 Kbyte of text.
7582 Also see the '<' item above: line count limit.
7583
7584 Example: >
7585 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7586<
7587 '50 Marks will be remembered for the last 50 files you
7588 edited.
7589 <1000 Contents of registers (up to 1000 lines each) will be
7590 remembered.
7591 s100 Registers with more than 100 Kbyte text are skipped.
7592 :0 Command-line history will not be saved.
7593 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7594 no / Since '/' is not specified, the default will be used,
7595 that is, save all of the search history, and also the
7596 previous search and substitute patterns.
7597 no % The buffer list will not be saved nor read back.
7598 no h 'hlsearch' highlighting will be restored.
7599
7600 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7601 load the contents of the file, this is not done automatically.
7602
7603 This option cannot be set from a |modeline| or in the |sandbox|, for
7604 security reasons.
7605
7606 *'virtualedit'* *'ve'*
7607'virtualedit' 've' string (default "")
7608 global
7609 {not in Vi}
7610 {not available when compiled without the
7611 |+virtualedit| feature}
7612 A comma separated list of these words:
7613 block Allow virtual editing in Visual block mode.
7614 insert Allow virtual editing in Insert mode.
7615 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007616 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007617
Bram Moolenaar071d4272004-06-13 20:20:40 +00007618 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007619 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 of the line. Useful for selecting a rectangle in Visual mode and
7621 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007622 "onemore" is not the same, it will only allow moving the cursor just
7623 after the last character of the line. This makes some commands more
7624 consistent. Previously the cursor was always past the end of the line
7625 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007626 break some plugins or Vim scripts. For example because |l| can move
7627 the cursor after the last character. Use with care!
7628 Using the |$| command will move to the last character in the line, not
7629 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007630 It doesn't make sense to combine "all" with "onemore", but you will
7631 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632
7633 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7634'visualbell' 'vb' boolean (default off)
7635 global
7636 {not in Vi}
7637 Use visual bell instead of beeping. The terminal code to display the
7638 visual bell is given with 't_vb'. When no beep or flash is wanted,
7639 use ":set vb t_vb=".
7640 Note: When the GUI starts, 't_vb' is reset to its default value. You
7641 might want to set it again in your |gvimrc|.
7642 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7643 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7644 where 40 is the time in msec.
7645 Does not work on the Amiga, you always get a screen flash.
7646 Also see 'errorbells'.
7647
7648 *'warn'* *'nowarn'*
7649'warn' boolean (default on)
7650 global
7651 Give a warning message when a shell command is used while the buffer
7652 has been changed.
7653
7654 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7655'weirdinvert' 'wiv' boolean (default off)
7656 global
7657 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007658 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007659 It is provided for backwards compatibility with version 4.x.
7660 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7661 vice versa. Has no effect when the GUI is running.
7662
7663 *'whichwrap'* *'ww'*
7664'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7665 global
7666 {not in Vi}
7667 Allow specified keys that move the cursor left/right to move to the
7668 previous/next line when the cursor is on the first/last character in
7669 the line. Concatenate characters to allow this for these keys:
7670 char key mode ~
7671 b <BS> Normal and Visual
7672 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007673 h "h" Normal and Visual (not recommended)
7674 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007675 < <Left> Normal and Visual
7676 > <Right> Normal and Visual
7677 ~ "~" Normal
7678 [ <Left> Insert and Replace
7679 ] <Right> Insert and Replace
7680 For example: >
7681 :set ww=<,>,[,]
7682< allows wrap only when cursor keys are used.
7683 When the movement keys are used in combination with a delete or change
7684 operator, the <EOL> also counts for a character. This makes "3h"
7685 different from "3dh" when the cursor crosses the end of a line. This
7686 is also true for "x" and "X", because they do the same as "dl" and
7687 "dh". If you use this, you may also want to use the mapping
7688 ":map <BS> X" to make backspace delete the character in front of the
7689 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007690 When 'l' is included and it is used after an operator at the end of a
7691 line then it will not move to the next line. This makes "dl", "cl",
7692 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693 NOTE: This option is set to the Vi default value when 'compatible' is
7694 set and to the Vim default value when 'compatible' is reset.
7695
7696 *'wildchar'* *'wc'*
7697'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7698 global
7699 {not in Vi}
7700 Character you have to type to start wildcard expansion in the
7701 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007702 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007703 The character is not recognized when used inside a macro. See
7704 'wildcharm' for that.
7705 Although 'wc' is a number option, you can set it to a special key: >
7706 :set wc=<Esc>
7707< NOTE: This option is set to the Vi default value when 'compatible' is
7708 set and to the Vim default value when 'compatible' is reset.
7709
7710 *'wildcharm'* *'wcm'*
7711'wildcharm' 'wcm' number (default: none (0))
7712 global
7713 {not in Vi}
7714 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007715 recognized when used inside a macro. You can find "spare" command-line
7716 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007717 you'll never actually type 'wildcharm', just use it in mappings that
7718 automatically invoke completion mode, e.g.: >
7719 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007720 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007721< Then after typing :ss you can use CTRL-P & CTRL-N.
7722
7723 *'wildignore'* *'wig'*
7724'wildignore' 'wig' string (default "")
7725 global
7726 {not in Vi}
7727 {not available when compiled without the |+wildignore|
7728 feature}
7729 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007730 patterns is ignored when completing file or directory names, and
7731 influences the result of |expand()|, |glob()| and |globpath()| unless
7732 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7734 Also see 'suffixes'.
7735 Example: >
7736 :set wildignore=*.o,*.obj
7737< The use of |:set+=| and |:set-=| is preferred when adding or removing
7738 a pattern from the list. This avoids problems when a future version
7739 uses another default.
7740
7741 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7742'wildmenu' 'wmnu' boolean (default off)
7743 global
7744 {not in Vi}
7745 {not available if compiled without the |+wildmenu|
7746 feature}
7747 When 'wildmenu' is on, command-line completion operates in an enhanced
7748 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7749 the possible matches are shown just above the command line, with the
7750 first match highlighted (overwriting the status line, if there is
7751 one). Keys that show the previous/next match, such as <Tab> or
7752 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7753 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7754 specified. "longest" and "list" do not start "wildmenu" mode.
7755 If there are more matches than can fit in the line, a ">" is shown on
7756 the right and/or a "<" is shown on the left. The status line scrolls
7757 as needed.
7758 The "wildmenu" mode is abandoned when a key is hit that is not used
7759 for selecting a completion.
7760 While the "wildmenu" is active the following keys have special
7761 meanings:
7762
7763 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7764 <Down> - in filename/menu name completion: move into a
7765 subdirectory or submenu.
7766 <CR> - in menu completion, when the cursor is just after a
7767 dot: move into a submenu.
7768 <Up> - in filename/menu name completion: move up into
7769 parent directory or parent menu.
7770
7771 This makes the menus accessible from the console |console-menus|.
7772
7773 If you prefer the <Left> and <Right> keys to move the cursor instead
7774 of selecting a different match, use this: >
7775 :cnoremap <Left> <Space><BS><Left>
7776 :cnoremap <Right> <Space><BS><Right>
7777<
7778 The "WildMenu" highlighting is used for displaying the current match
7779 |hl-WildMenu|.
7780
7781 *'wildmode'* *'wim'*
7782'wildmode' 'wim' string (Vim default: "full")
7783 global
7784 {not in Vi}
7785 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007786 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007787 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788 first part specifies the behavior for the first use of 'wildchar',
7789 The second part for the second use, etc.
7790 These are the possible values for each part:
7791 "" Complete only the first match.
7792 "full" Complete the next full match. After the last match,
7793 the original string is used and then the first match
7794 again.
7795 "longest" Complete till longest common string. If this doesn't
7796 result in a longer string, use the next part.
7797 "longest:full" Like "longest", but also start 'wildmenu' if it is
7798 enabled.
7799 "list" When more than one match, list all matches.
7800 "list:full" When more than one match, list all matches and
7801 complete first match.
7802 "list:longest" When more than one match, list all matches and
7803 complete till longest common string.
7804 When there is only a single match, it is fully completed in all cases.
7805
7806 Examples: >
7807 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007808< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 :set wildmode=longest,full
7810< Complete longest common string, then each full match >
7811 :set wildmode=list:full
7812< List all matches and complete each full match >
7813 :set wildmode=list,full
7814< List all matches without completing, then each full match >
7815 :set wildmode=longest,list
7816< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007817 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007818
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007819 *'wildoptions'* *'wop'*
7820'wildoptions' 'wop' string (default "")
7821 global
7822 {not in Vi}
7823 {not available when compiled without the |+wildignore|
7824 feature}
7825 A list of words that change how command line completion is done.
7826 Currently only one word is allowed:
7827 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007828 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007829 is displayed per line. Often used tag kinds are:
7830 d #define
7831 f function
7832 Also see |cmdline-completion|.
7833
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834 *'winaltkeys'* *'wak'*
7835'winaltkeys' 'wak' string (default "menu")
7836 global
7837 {not in Vi}
7838 {only used in Win32, Motif, GTK and Photon GUI}
7839 Some GUI versions allow the access to menu entries by using the ALT
7840 key in combination with a character that appears underlined in the
7841 menu. This conflicts with the use of the ALT key for mappings and
7842 entering special characters. This option tells what to do:
7843 no Don't use ALT keys for menus. ALT key combinations can be
7844 mapped, but there is no automatic handling. This can then be
7845 done with the |:simalt| command.
7846 yes ALT key handling is done by the windowing system. ALT key
7847 combinations cannot be mapped.
7848 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007849 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850 keys can be mapped.
7851 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7852 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007853 This option is not used for <F10>; on Win32 and with GTK <F10> will
7854 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007856 *'window'* *'wi'*
7857'window' 'wi' number (default screen height - 1)
7858 global
7859 Window height. Do not confuse this with the height of the Vim window,
7860 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007861 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7862 value is smaller than 'lines' minus one. The screen will scroll
7863 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007864 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7865 in a much smarter way, taking care of wrapping lines.
7866 When resizing the Vim window, the value is smaller than 1 or more than
7867 or equal to 'lines' it will be set to 'lines' minus 1.
7868 {Vi also uses the option to specify the number of displayed lines}
7869
Bram Moolenaar071d4272004-06-13 20:20:40 +00007870 *'winheight'* *'wh'* *E591*
7871'winheight' 'wh' number (default 1)
7872 global
7873 {not in Vi}
7874 {not available when compiled without the +windows
7875 feature}
7876 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007877 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007878 focus goes to a window that is smaller, its size is increased, at the
7879 cost of the height of other windows.
7880 Set 'winheight' to a small number for normal editing.
7881 Set it to 999 to make the current window fill most of the screen.
7882 Other windows will be only 'winminheight' high. This has the drawback
7883 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7884 to create only two windows, set the option after startup is done,
7885 using the |VimEnter| event: >
7886 au VimEnter * set winheight=999
7887< Minimum value is 1.
7888 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 height of the current window.
7890 'winheight' applies to the current window. Use 'winminheight' to set
7891 the minimal height for other windows.
7892
7893 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7894'winfixheight' 'wfh' boolean (default off)
7895 local to window
7896 {not in Vi}
7897 {not available when compiled without the +windows
7898 feature}
7899 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007900 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7901 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 The height may be changed anyway when running out of room.
7903
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007904 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7905'winfixwidth' 'wfw' boolean (default off)
7906 local to window
7907 {not in Vi}
7908 {not available when compiled without the +windows
7909 feature}
7910 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007911 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007912 The width may be changed anyway when running out of room.
7913
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 *'winminheight'* *'wmh'*
7915'winminheight' 'wmh' number (default 1)
7916 global
7917 {not in Vi}
7918 {not available when compiled without the +windows
7919 feature}
7920 The minimal height of a window, when it's not the current window.
7921 This is a hard minimum, windows will never become smaller.
7922 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7923 status bar) if necessary. They will return to at least one line when
7924 they become active (since the cursor has to have somewhere to go.)
7925 Use 'winheight' to set the minimal height of the current window.
7926 This option is only checked when making a window smaller. Don't use a
7927 large number, it will cause errors when opening more than a few
7928 windows. A value of 0 to 3 is reasonable.
7929
7930 *'winminwidth'* *'wmw'*
7931'winminwidth' 'wmw' number (default 1)
7932 global
7933 {not in Vi}
7934 {not available when compiled without the +vertsplit
7935 feature}
7936 The minimal width of a window, when it's not the current window.
7937 This is a hard minimum, windows will never become smaller.
7938 When set to zero, windows may be "squashed" to zero columns (i.e. just
7939 a vertical separator) if necessary. They will return to at least one
7940 line when they become active (since the cursor has to have somewhere
7941 to go.)
7942 Use 'winwidth' to set the minimal width of the current window.
7943 This option is only checked when making a window smaller. Don't use a
7944 large number, it will cause errors when opening more than a few
7945 windows. A value of 0 to 12 is reasonable.
7946
7947 *'winwidth'* *'wiw'* *E592*
7948'winwidth' 'wiw' number (default 20)
7949 global
7950 {not in Vi}
7951 {not available when compiled without the +vertsplit
7952 feature}
7953 Minimal number of columns for the current window. This is not a hard
7954 minimum, Vim will use fewer columns if there is not enough room. If
7955 the current window is smaller, its size is increased, at the cost of
7956 the width of other windows. Set it to 999 to make the current window
7957 always fill the screen. Set it to a small number for normal editing.
7958 The width is not adjusted after one of the commands to change the
7959 width of the current window.
7960 'winwidth' applies to the current window. Use 'winminwidth' to set
7961 the minimal width for other windows.
7962
7963 *'wrap'* *'nowrap'*
7964'wrap' boolean (default on)
7965 local to window
7966 {not in Vi}
7967 This option changes how text is displayed. It doesn't change the text
7968 in the buffer, see 'textwidth' for that.
7969 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007970 displaying continues on the next line. When off lines will not wrap
7971 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007972 moved to a part that is not shown, the screen will scroll
7973 horizontally.
7974 The line will be broken in the middle of a word if necessary. See
7975 'linebreak' to get the break at a word boundary.
7976 To make scrolling horizontally a bit more useful, try this: >
7977 :set sidescroll=5
7978 :set listchars+=precedes:<,extends:>
7979< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007980 This option can't be set from a |modeline| when the 'diff' option is
7981 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982
7983 *'wrapmargin'* *'wm'*
7984'wrapmargin' 'wm' number (default 0)
7985 local to buffer
7986 Number of characters from the right window border where wrapping
7987 starts. When typing text beyond this limit, an <EOL> will be inserted
7988 and inserting continues on the next line.
7989 Options that add a margin, such as 'number' and 'foldcolumn', cause
7990 the text width to be further reduced. This is Vi compatible.
7991 When 'textwidth' is non-zero, this option is not used.
7992 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7993 and less usefully}
7994
7995 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7996'wrapscan' 'ws' boolean (default on) *E384* *E385*
7997 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007998 Searches wrap around the end of the file. Also applies to |]s| and
7999 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008000
8001 *'write'* *'nowrite'*
8002'write' boolean (default on)
8003 global
8004 {not in Vi}
8005 Allows writing files. When not set, writing a file is not allowed.
8006 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008007 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008 argument. Filtering text is still possible, even though this requires
8009 writing a temporary file.
8010
8011 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8012'writeany' 'wa' boolean (default off)
8013 global
8014 Allows writing to any file with no need for "!" override.
8015
8016 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8017'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8018 otherwise)
8019 global
8020 {not in Vi}
8021 Make a backup before overwriting a file. The backup is removed after
8022 the file was successfully written, unless the 'backup' option is
8023 also on. Reset this option if your file system is almost full. See
8024 |backup-table| for another explanation.
8025 When the 'backupskip' pattern matches, a backup is not made anyway.
8026 NOTE: This option is set to the default value when 'compatible' is
8027 set.
8028
8029 *'writedelay'* *'wd'*
8030'writedelay' 'wd' number (default 0)
8031 global
8032 {not in Vi}
8033 The number of microseconds to wait for each character sent to the
8034 screen. When non-zero, characters are sent to the terminal one by
8035 one. For MS-DOS pcterm this does not work. For debugging purposes.
8036
8037 vim:tw=78:ts=8:ft=help:norl: