blob: 09e9ab352c9a45d9e547728474e6cc8b6fee5bbd [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 Moolenaarca8c9862010-07-24 15:00:38 +02001724 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001725 are moving around text is concealed, but when starting to insert text
1726 or selecting a Visual area the concealed text is displayed, so that
1727 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001728 Keep in mind that the cursor position is not always where it's
1729 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001730
1731
1732'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001733 number (default 0)
1734 local to window
1735 {not in Vi}
1736 {not available when compiled without the |+conceal|
1737 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001738 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1739 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001740
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001741 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001742 0 Text is shown normally
1743 1 Each block of concealed text is replaced with the
1744 character defined in 'listchars' (default is a dash)
1745 and highlighted with the "Conceal" highlight group.
1746 2 Concealed text is completely hidden unless it has a
1747 custom replacement character defined (see
1748 |:syn-cchar|.
Bram Moolenaara7781e02010-07-19 20:13:22 +02001749 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001750
Bram Moolenaara7781e02010-07-19 20:13:22 +02001751 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001752 edit and copy the text. This can be changed with the 'concealcursor'
1753 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001754
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1756'confirm' 'cf' boolean (default off)
1757 global
1758 {not in Vi}
1759 When 'confirm' is on, certain operations that would normally
1760 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1761 instead raise a |dialog| asking if you wish to save the current
1762 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1763 If 'confirm' is off you can still activate confirmation for one
1764 command only (this is most useful in mappings) with the |:confirm|
1765 command.
1766 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1767
1768 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1769'conskey' 'consk' boolean (default off)
1770 global
1771 {not in Vi} {only for MS-DOS}
1772 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001773 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 three methods of console input are available:
1775 'conskey' 'bioskey' action ~
1776 on on or off direct console input
1777 off on BIOS
1778 off off STDIN
1779
1780 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1781'copyindent' 'ci' boolean (default off)
1782 local to buffer
1783 {not in Vi}
1784 Copy the structure of the existing lines indent when autoindenting a
1785 new line. Normally the new indent is reconstructed by a series of
1786 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1787 in which case only spaces are used). Enabling this option makes the
1788 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001789 existing line. 'expandtab' has no effect on these characters, a Tab
1790 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 line, the remaining space is filled in the normal manner.
1792 NOTE: 'copyindent' is reset when 'compatible' is set.
1793 Also see 'preserveindent'.
1794
1795 *'cpoptions'* *'cpo'*
1796'cpoptions' 'cpo' string (Vim default: "aABceFs",
1797 Vi default: all flags)
1798 global
1799 {not in Vi}
1800 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001801 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 not being vi-compatible is mostly or sometimes preferred.
1803 'cpoptions' stands for "compatible-options".
1804 Commas can be added for readability.
1805 To avoid problems with flags that are added in the future, use the
1806 "+=" and "-=" feature of ":set" |add-option-flags|.
1807 NOTE: This option is set to the Vi default value when 'compatible' is
1808 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001809 NOTE: This option is set to the POSIX default value at startup when
1810 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001811 variable exists |posix|. This means Vim tries to behave like the
1812 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813
1814 contains behavior ~
1815 *cpo-a*
1816 a When included, a ":read" command with a file name
1817 argument will set the alternate file name for the
1818 current window.
1819 *cpo-A*
1820 A When included, a ":write" command with a file name
1821 argument will set the alternate file name for the
1822 current window.
1823 *cpo-b*
1824 b "\|" in a ":map" command is recognized as the end of
1825 the map command. The '\' is included in the mapping,
1826 the text after the '|' is interpreted as the next
1827 command. Use a CTRL-V instead of a backslash to
1828 include the '|' in the mapping. Applies to all
1829 mapping, abbreviation, menu and autocmd commands.
1830 See also |map_bar|.
1831 *cpo-B*
1832 B A backslash has no special meaning in mappings,
1833 abbreviations and the "to" part of the menu commands.
1834 Remove this flag to be able to use a backslash like a
1835 CTRL-V. For example, the command ":map X \<Esc>"
1836 results in X being mapped to:
1837 'B' included: "\^[" (^[ is a real <Esc>)
1838 'B' excluded: "<Esc>" (5 characters)
1839 ('<' excluded in both cases)
1840 *cpo-c*
1841 c Searching continues at the end of any match at the
1842 cursor position, but not further than the start of the
1843 next line. When not present searching continues
1844 one character from the cursor position. With 'c'
1845 "abababababab" only gets three matches when repeating
1846 "/abab", without 'c' there are five matches.
1847 *cpo-C*
1848 C Do not concatenate sourced lines that start with a
1849 backslash. See |line-continuation|.
1850 *cpo-d*
1851 d Using "./" in the 'tags' option doesn't mean to use
1852 the tags file relative to the current file, but the
1853 tags file in the current directory.
1854 *cpo-D*
1855 D Can't use CTRL-K to enter a digraph after Normal mode
1856 commands with a character argument, like |r|, |f| and
1857 |t|.
1858 *cpo-e*
1859 e When executing a register with ":@r", always add a
1860 <CR> to the last line, also when the register is not
1861 linewise. If this flag is not present, the register
1862 is not linewise and the last line does not end in a
1863 <CR>, then the last line is put on the command-line
1864 and can be edited before hitting <CR>.
1865 *cpo-E*
1866 E It is an error when using "y", "d", "c", "g~", "gu" or
1867 "gU" on an Empty region. The operators only work when
1868 at least one character is to be operate on. Example:
1869 This makes "y0" fail in the first column.
1870 *cpo-f*
1871 f When included, a ":read" command with a file name
1872 argument will set the file name for the current buffer,
1873 if the current buffer doesn't have a file name yet.
1874 *cpo-F*
1875 F When included, a ":write" command with a file name
1876 argument will set the file name for the current
1877 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001878 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879 *cpo-g*
1880 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001881 *cpo-H*
1882 H When using "I" on a line with only blanks, insert
1883 before the last blank. Without this flag insert after
1884 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885 *cpo-i*
1886 i When included, interrupting the reading of a file will
1887 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001888 *cpo-I*
1889 I When moving the cursor up or down just after inserting
1890 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 *cpo-j*
1892 j When joining lines, only add two spaces after a '.',
1893 not after '!' or '?'. Also see 'joinspaces'.
1894 *cpo-J*
1895 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001896 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897 white space.
1898 *cpo-k*
1899 k Disable the recognition of raw key codes in
1900 mappings, abbreviations, and the "to" part of menu
1901 commands. For example, if <Key> sends ^[OA (where ^[
1902 is <Esc>), the command ":map X ^[OA" results in X
1903 being mapped to:
1904 'k' included: "^[OA" (3 characters)
1905 'k' excluded: "<Key>" (one key code)
1906 Also see the '<' flag below.
1907 *cpo-K*
1908 K Don't wait for a key code to complete when it is
1909 halfway a mapping. This breaks mapping <F1><F1> when
1910 only part of the second <F1> has been read. It
1911 enables cancelling the mapping by typing <F1><Esc>.
1912 *cpo-l*
1913 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001914 literally, only "\]", "\^", "\-" and "\\" are special.
1915 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1917 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001918 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 *cpo-L*
1920 L When the 'list' option is set, 'wrapmargin',
1921 'textwidth', 'softtabstop' and Virtual Replace mode
1922 (see |gR|) count a <Tab> as two characters, instead of
1923 the normal behavior of a <Tab>.
1924 *cpo-m*
1925 m When included, a showmatch will always wait half a
1926 second. When not included, a showmatch will wait half
1927 a second or until a character is typed. |'showmatch'|
1928 *cpo-M*
1929 M When excluded, "%" matching will take backslashes into
1930 account. Thus in "( \( )" and "\( ( \)" the outer
1931 parenthesis match. When included "%" ignores
1932 backslashes, which is Vi compatible.
1933 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001934 n When included, the column used for 'number' and
1935 'relativenumber' will also be used for text of wrapped
1936 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937 *cpo-o*
1938 o Line offset to search command is not remembered for
1939 next search.
1940 *cpo-O*
1941 O Don't complain if a file is being overwritten, even
1942 when it didn't exist when editing it. This is a
1943 protection against a file unexpectedly created by
1944 someone else. Vi didn't complain about this.
1945 *cpo-p*
1946 p Vi compatible Lisp indenting. When not present, a
1947 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001948 *cpo-P*
1949 P When included, a ":write" command that appends to a
1950 file will set the file name for the current buffer, if
1951 the current buffer doesn't have a file name yet and
1952 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001953 *cpo-q*
1954 q When joining multiple lines leave the cursor at the
1955 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956 *cpo-r*
1957 r Redo ("." command) uses "/" to repeat a search
1958 command, instead of the actually used search string.
1959 *cpo-R*
1960 R Remove marks from filtered lines. Without this flag
1961 marks are kept like |:keepmarks| was used.
1962 *cpo-s*
1963 s Set buffer options when entering the buffer for the
1964 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001965 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001966 set when the buffer is created.
1967 *cpo-S*
1968 S Set buffer options always when entering a buffer
1969 (except 'readonly', 'fileformat', 'filetype' and
1970 'syntax'). This is the (most) Vi compatible setting.
1971 The options are set to the values in the current
1972 buffer. When you change an option and go to another
1973 buffer, the value is copied. Effectively makes the
1974 buffer options global to all buffers.
1975
1976 's' 'S' copy buffer options
1977 no no when buffer created
1978 yes no when buffer first entered (default)
1979 X yes each time when buffer entered (vi comp.)
1980 *cpo-t*
1981 t Search pattern for the tag command is remembered for
1982 "n" command. Otherwise Vim only puts the pattern in
1983 the history for search pattern, but doesn't change the
1984 last used search pattern.
1985 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001986 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001987 *cpo-v*
1988 v Backspaced characters remain visible on the screen in
1989 Insert mode. Without this flag the characters are
1990 erased from the screen right away. With this flag the
1991 screen newly typed text overwrites backspaced
1992 characters.
1993 *cpo-w*
1994 w When using "cw" on a blank character, only change one
1995 character and not all blanks until the start of the
1996 next word.
1997 *cpo-W*
1998 W Don't overwrite a readonly file. When omitted, ":w!"
1999 overwrites a readonly file, if possible.
2000 *cpo-x*
2001 x <Esc> on the command-line executes the command-line.
2002 The default in Vim is to abandon the command-line,
2003 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002004 *cpo-X*
2005 X When using a count with "R" the replaced text is
2006 deleted only once. Also when repeating "R" with "."
2007 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008 *cpo-y*
2009 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002010 *cpo-Z*
2011 Z When using "w!" while the 'readonly' option is set,
2012 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 *cpo-!*
2014 ! When redoing a filter command, use the last used
2015 external command, whatever it was. Otherwise the last
2016 used -filter- command is used.
2017 *cpo-$*
2018 $ When making a change to one line, don't redisplay the
2019 line, but put a '$' at the end of the changed text.
2020 The changed text will be overwritten when you type the
2021 new text. The line is redisplayed if you type any
2022 command that moves the cursor from the insertion
2023 point.
2024 *cpo-%*
2025 % Vi-compatible matching is done for the "%" command.
2026 Does not recognize "#if", "#endif", etc.
2027 Does not recognize "/*" and "*/".
2028 Parens inside single and double quotes are also
2029 counted, causing a string that contains a paren to
2030 disturb the matching. For example, in a line like
2031 "if (strcmp("foo(", s))" the first paren does not
2032 match the last one. When this flag is not included,
2033 parens inside single and double quotes are treated
2034 specially. When matching a paren outside of quotes,
2035 everything inside quotes is ignored. When matching a
2036 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002037 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002038 This flag is also used for other features, such as
2039 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002040 *cpo--*
2041 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002042 it would go above the first line or below the last
2043 line. Without it the cursor moves to the first or
2044 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002045 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002046 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002047 *cpo-+*
2048 + When included, a ":write file" command will reset the
2049 'modified' flag of the buffer, even though the buffer
2050 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002051 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052 * Use ":*" in the same way as ":@". When not included,
2053 ":*" is an alias for ":'<,'>", select the Visual area.
2054 *cpo-<*
2055 < Disable the recognition of special key codes in |<>|
2056 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002057 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 ":map X <Tab>" results in X being mapped to:
2059 '<' included: "<Tab>" (5 characters)
2060 '<' excluded: "^I" (^I is a real <Tab>)
2061 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002062 *cpo->*
2063 > When appending to a register, put a line break before
2064 the appended text.
2065
2066 POSIX flags. These are not included in the Vi default value, except
2067 when $VIM_POSIX was set on startup. |posix|
2068
2069 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002070 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002071 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002072 *cpo-&*
2073 & When ":preserve" was used keep the swap file when
2074 exiting normally while this buffer is still loaded.
2075 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002076 *cpo-\*
2077 \ Backslash in a [] range in a search pattern is taken
2078 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002079 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2080 '\' excluded: "/[ \-]" finds <Space> and '-'
2081 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002082 *cpo-/*
2083 / When "%" is used as the replacement string in a |:s|
2084 command, use the previous replacement string. |:s%|
2085 *cpo-{*
2086 { The |{| and |}| commands also stop at a "{" character
2087 at the start of a line.
2088 *cpo-.*
2089 . The ":chdir" and ":cd" commands fail if the current
2090 buffer is modified, unless ! is used. Vim doesn't
2091 need this, since it remembers the full path of an
2092 opened file.
2093 *cpo-bar*
2094 | The value of the $LINES and $COLUMNS environment
2095 variables overrule the terminal size values obtained
2096 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002097
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002099 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002100'cryptmethod' string (default "zip")
2101 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002102 {not in Vi}
2103 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002104 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002105 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002106 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002107 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002108 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002109 or later, files can NOT be read by Vim 7.2 and older.
2110 This adds a "seed" to the file, every time you write
2111 the file the encrypted bytes will be different.
2112
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002113 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002114 to the detected method of the file being read. Thus if you write it
2115 without changing 'cryptmethod' the same method will be used.
2116 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002117 explicitly write it, you don't get a warning unless there are other
2118 modifications. Also see |:X|.
2119
2120 When setting the global value to an empty string, it will end up with
2121 the value "zip". When setting the local value to an empty string the
2122 buffer will use the global value.
2123
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002124 When a new encryption method is added in a later version of Vim, and
2125 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002126 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002127
2128
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129 *'cscopepathcomp'* *'cspc'*
2130'cscopepathcomp' 'cspc' number (default 0)
2131 global
2132 {not available when compiled without the |+cscope|
2133 feature}
2134 {not in Vi}
2135 Determines how many components of the path to show in a list of tags.
2136 See |cscopepathcomp|.
2137
2138 *'cscopeprg'* *'csprg'*
2139'cscopeprg' 'csprg' string (default "cscope")
2140 global
2141 {not available when compiled without the |+cscope|
2142 feature}
2143 {not in Vi}
2144 Specifies the command to execute cscope. See |cscopeprg|.
2145 This option cannot be set from a |modeline| or in the |sandbox|, for
2146 security reasons.
2147
2148 *'cscopequickfix'* *'csqf'*
2149'cscopequickfix' 'csqf' string (default "")
2150 global
2151 {not available when compiled without the |+cscope|
2152 or |+quickfix| features}
2153 {not in Vi}
2154 Specifies whether to use quickfix window to show cscope results.
2155 See |cscopequickfix|.
2156
2157 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2158'cscopetag' 'cst' boolean (default off)
2159 global
2160 {not available when compiled without the |+cscope|
2161 feature}
2162 {not in Vi}
2163 Use cscope for tag commands. See |cscope-options|.
2164 NOTE: This option is reset when 'compatible' is set.
2165
2166 *'cscopetagorder'* *'csto'*
2167'cscopetagorder' 'csto' number (default 0)
2168 global
2169 {not available when compiled without the |+cscope|
2170 feature}
2171 {not in Vi}
2172 Determines the order in which ":cstag" performs a search. See
2173 |cscopetagorder|.
2174 NOTE: This option is set to 0 when 'compatible' is set.
2175
2176 *'cscopeverbose'* *'csverb'*
2177 *'nocscopeverbose'* *'nocsverb'*
2178'cscopeverbose' 'csverb' boolean (default off)
2179 global
2180 {not available when compiled without the |+cscope|
2181 feature}
2182 {not in Vi}
2183 Give messages when adding a cscope database. See |cscopeverbose|.
2184 NOTE: This option is reset when 'compatible' is set.
2185
Bram Moolenaar860cae12010-06-05 23:22:07 +02002186 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2187'cursorbind' 'crb' boolean (default off)
2188 local to window
2189 {not in Vi}
2190 {not available when compiled without the |+cursorbind|
2191 feature}
2192 When this option is set, as the cursor in the current
2193 window moves other cursorbound windows (windows that also have
2194 this option set) move their cursors to the corresponding line and
2195 column. This option is useful for viewing the
2196 differences between two versions of a file (see 'diff'); in diff mode,
2197 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002198 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002199
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002200
2201 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2202'cursorcolumn' 'cuc' boolean (default off)
2203 local to window
2204 {not in Vi}
2205 {not available when compiled without the |+syntax|
2206 feature}
2207 Highlight the screen column of the cursor with CursorColumn
2208 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2209 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002210 If you only want the highlighting in the current window you can use
2211 these autocommands: >
2212 au WinLeave * set nocursorline nocursorcolumn
2213 au WinEnter * set cursorline cursorcolumn
2214<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002215
2216 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2217'cursorline' 'cul' boolean (default off)
2218 local to window
2219 {not in Vi}
2220 {not available when compiled without the |+syntax|
2221 feature}
2222 Highlight the screen line of the cursor with CursorLine
2223 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2224 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002225 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002226 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002227
2228
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229 *'debug'*
2230'debug' string (default "")
2231 global
2232 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002233 These values can be used:
2234 msg Error messages that would otherwise be omitted will be given
2235 anyway.
2236 throw Error messages that would otherwise be omitted will be given
2237 anyway and also throw an exception and set |v:errmsg|.
2238 beep A message will be given when otherwise only a beep would be
2239 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002240 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002241 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2242 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243
2244 *'define'* *'def'*
2245'define' 'def' string (default "^\s*#\s*define")
2246 global or local to buffer |global-local|
2247 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002248 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249 pattern, just like for the "/" command. This option is used for the
2250 commands like "[i" and "[d" |include-search|. The 'isident' option is
2251 used to recognize the defined name after the match:
2252 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2253 See |option-backslash| about inserting backslashes to include a space
2254 or backslash.
2255 The default value is for C programs. For C++ this value would be
2256 useful, to include const type declarations: >
2257 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2258< When using the ":set" command, you need to double the backslashes!
2259
2260 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2261'delcombine' 'deco' boolean (default off)
2262 global
2263 {not in Vi}
2264 {only available when compiled with the |+multi_byte|
2265 feature}
2266 If editing Unicode and this option is set, backspace and Normal mode
2267 "x" delete each combining character on its own. When it is off (the
2268 default) the character along with its combining characters are
2269 deleted.
2270 Note: When 'delcombine' is set "xx" may work different from "2x"!
2271
2272 This is useful for Arabic, Hebrew and many other languages where one
2273 may have combining characters overtop of base characters, and want
2274 to remove only the combining ones.
2275
2276 *'dictionary'* *'dict'*
2277'dictionary' 'dict' string (default "")
2278 global or local to buffer |global-local|
2279 {not in Vi}
2280 List of file names, separated by commas, that are used to lookup words
2281 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2282 contain a list of words. This can be one word per line, or several
2283 words per line, separated by non-keyword characters (white space is
2284 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002285 When this option is empty, or an entry "spell" is present, spell
2286 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002287 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288 after a comma are ignored, otherwise spaces are included in the file
2289 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002290 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291 Where to find a list of words?
2292 - On FreeBSD, there is the file "/usr/share/dict/words".
2293 - In the Simtel archive, look in the "msdos/linguist" directory.
2294 - In "miscfiles" of the GNU collection.
2295 The use of |:set+=| and |:set-=| is preferred when adding or removing
2296 directories from the list. This avoids problems when a future version
2297 uses another default.
2298 Backticks cannot be used in this option for security reasons.
2299
2300 *'diff'* *'nodiff'*
2301'diff' boolean (default off)
2302 local to window
2303 {not in Vi}
2304 {not available when compiled without the |+diff|
2305 feature}
2306 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002307 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002308
2309 *'dex'* *'diffexpr'*
2310'diffexpr' 'dex' string (default "")
2311 global
2312 {not in Vi}
2313 {not available when compiled without the |+diff|
2314 feature}
2315 Expression which is evaluated to obtain an ed-style diff file from two
2316 versions of a file. See |diff-diffexpr|.
2317 This option cannot be set from a |modeline| or in the |sandbox|, for
2318 security reasons.
2319
2320 *'dip'* *'diffopt'*
2321'diffopt' 'dip' string (default "filler")
2322 global
2323 {not in Vi}
2324 {not available when compiled without the |+diff|
2325 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002326 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327 All are optional. Items must be separated by a comma.
2328
2329 filler Show filler lines, to keep the text
2330 synchronized with a window that has inserted
2331 lines at the same position. Mostly useful
2332 when windows are side-by-side and 'scrollbind'
2333 is set.
2334
2335 context:{n} Use a context of {n} lines between a change
2336 and a fold that contains unchanged lines.
2337 When omitted a context of six lines is used.
2338 See |fold-diff|.
2339
2340 icase Ignore changes in case of text. "a" and "A"
2341 are considered the same. Adds the "-i" flag
2342 to the "diff" command if 'diffexpr' is empty.
2343
2344 iwhite Ignore changes in amount of white space. Adds
2345 the "-b" flag to the "diff" command if
2346 'diffexpr' is empty. Check the documentation
2347 of the "diff" command for what this does
2348 exactly. It should ignore adding trailing
2349 white space, but not leading white space.
2350
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002351 horizontal Start diff mode with horizontal splits (unless
2352 explicitly specified otherwise).
2353
2354 vertical Start diff mode with vertical splits (unless
2355 explicitly specified otherwise).
2356
2357 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2358 starting diff mode. Without this 2 is used.
2359
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 Examples: >
2361
2362 :set diffopt=filler,context:4
2363 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002364 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365<
2366 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2367'digraph' 'dg' boolean (default off)
2368 global
2369 {not in Vi}
2370 {not available when compiled without the |+digraphs|
2371 feature}
2372 Enable the entering of digraphs in Insert mode with {char1} <BS>
2373 {char2}. See |digraphs|.
2374 NOTE: This option is reset when 'compatible' is set.
2375
2376 *'directory'* *'dir'*
2377'directory' 'dir' string (default for Amiga: ".,t:",
2378 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2379 for Unix: ".,~/tmp,/var/tmp,/tmp")
2380 global
2381 List of directory names for the swap file, separated with commas.
2382 - The swap file will be created in the first directory where this is
2383 possible.
2384 - Empty means that no swap file will be used (recovery is
2385 impossible!).
2386 - A directory "." means to put the swap file in the same directory as
2387 the edited file. On Unix, a dot is prepended to the file name, so
2388 it doesn't show in a directory listing. On MS-Windows the "hidden"
2389 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002390 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391 put the swap file relative to where the edited file is. The leading
2392 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002393 - For Unix and Win32, if a directory ends in two path separators "//"
2394 or "\\", the swap file name will be built from the complete path to
2395 the file with all path separators substituted to percent '%' signs.
2396 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002397 On Win32, when a separating comma is following, you must use "//",
2398 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002399 - Spaces after the comma are ignored, other spaces are considered part
2400 of the directory name. To have a space at the start of a directory
2401 name, precede it with a backslash.
2402 - To include a comma in a directory name precede it with a backslash.
2403 - A directory name may end in an ':' or '/'.
2404 - Environment variables are expanded |:set_env|.
2405 - Careful with '\' characters, type one before a space, type two to
2406 get one in the option (see |option-backslash|), for example: >
2407 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2408< - For backwards compatibility with Vim version 3.0 a '>' at the start
2409 of the option is removed.
2410 Using "." first in the list is recommended. This means that editing
2411 the same file twice will result in a warning. Using "/tmp" on Unix is
2412 discouraged: When the system crashes you lose the swap file.
2413 "/var/tmp" is often not cleared when rebooting, thus is a better
2414 choice than "/tmp". But it can contain a lot of files, your swap
2415 files get lost in the crowd. That is why a "tmp" directory in your
2416 home directory is tried first.
2417 The use of |:set+=| and |:set-=| is preferred when adding or removing
2418 directories from the list. This avoids problems when a future version
2419 uses another default.
2420 This option cannot be set from a |modeline| or in the |sandbox|, for
2421 security reasons.
2422 {Vi: directory to put temp file in, defaults to "/tmp"}
2423
2424 *'display'* *'dy'*
2425'display' 'dy' string (default "")
2426 global
2427 {not in Vi}
2428 Change the way text is displayed. This is comma separated list of
2429 flags:
2430 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002431 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002432 last line that doesn't fit is replaced with "@" lines.
2433 uhex Show unprintable characters hexadecimal as <xx>
2434 instead of using ^C and ~C.
2435
2436 *'eadirection'* *'ead'*
2437'eadirection' 'ead' string (default "both")
2438 global
2439 {not in Vi}
2440 {not available when compiled without the +vertsplit
2441 feature}
2442 Tells when the 'equalalways' option applies:
2443 ver vertically, width of windows is not affected
2444 hor horizontally, height of windows is not affected
2445 both width and height of windows is affected
2446
2447 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2448'edcompatible' 'ed' boolean (default off)
2449 global
2450 Makes the 'g' and 'c' flags of the ":substitute" command to be
2451 toggled each time the flag is given. See |complex-change|. See
2452 also 'gdefault' option.
2453 Switching this option on is discouraged!
2454
2455 *'encoding'* *'enc'* *E543*
2456'encoding' 'enc' string (default: "latin1" or value from $LANG)
2457 global
2458 {only available when compiled with the |+multi_byte|
2459 feature}
2460 {not in Vi}
2461 Sets the character encoding used inside Vim. It applies to text in
2462 the buffers, registers, Strings in expressions, text stored in the
2463 viminfo file, etc. It sets the kind of characters which Vim can work
2464 with. See |encoding-names| for the possible values.
2465
2466 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002467 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002469 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002470
Bram Moolenaar865242e2010-07-14 21:12:05 +02002471 This option cannot be set from a |modeline|. It would most likely
2472 corrupt the text.
2473
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2475 "utf-8". Although care has been taken to allow different values of
2476 'encoding', "utf-8" is the natural choice for the environment and
2477 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002478 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 versions, and to avoid changing the encoding of newly created files
2480 without your knowledge (in case 'fileencodings' is empty).
2481
2482 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002483 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484 iconv() or as specified with 'charconvert'.
2485
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002486 If you need to know whether 'encoding' is a multi-byte encoding, you
2487 can use: >
2488 if has("multi_byte_encoding")
2489<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002490 Normally 'encoding' will be equal to your current locale. This will
2491 be the default if Vim recognizes your environment settings. If
2492 'encoding' is not set to the current locale, 'termencoding' must be
2493 set to convert typed and displayed text. See |encoding-table|.
2494
2495 When you set this option, it fires the |EncodingChanged| autocommand
2496 event so that you can set up fonts if necessary.
2497
2498 When the option is set, the value is converted to lowercase. Thus
2499 you can set it with uppercase values too. Underscores are translated
2500 to '-' signs.
2501 When the encoding is recognized, it is changed to the standard name.
2502 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2503 "iso-8859-2" and "utf8" becomes "utf-8".
2504
2505 Note: "latin1" is also used when the encoding could not be detected.
2506 This only works when editing files in the same encoding! When the
2507 actual character set is not latin1, make sure 'fileencoding' and
2508 'fileencodings' are empty. When conversion is needed, switch to using
2509 utf-8.
2510
2511 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2512 You don't notice this while editing, but it does matter for the
2513 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2514 setting 'encoding' to one of these values instead of utf-8 only has
2515 effect for encoding used for files when 'fileencoding' is empty.
2516
Bram Moolenaar661b1822005-07-28 22:36:45 +00002517 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2518 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002519
2520 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2521'endofline' 'eol' boolean (default on)
2522 local to buffer
2523 {not in Vi}
2524 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002525 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526 option is automatically set when starting to edit a new file, unless
2527 the file does not have an <EOL> for the last line in the file, in
2528 which case it is reset. Normally you don't have to set or reset this
2529 option. When 'binary' is off the value is not used when writing the
2530 file. When 'binary' is on it is used to remember the presence of a
2531 <EOL> for the last line in the file, so that when you write the file
2532 the situation from the original file can be kept. But you can change
2533 it if you want to.
2534
2535 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2536'equalalways' 'ea' boolean (default on)
2537 global
2538 {not in Vi}
2539 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002540 splitting or closing a window. This also happens the moment the
2541 option is switched on. When off, splitting a window will reduce the
2542 size of the current window and leave the other windows the same. When
2543 closing a window the extra lines are given to the window next to it
2544 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545 When mixing vertically and horizontally split windows, a minimal size
2546 is computed and some windows may be larger if there is room. The
2547 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002548 Changing the height and width of a window can be avoided by setting
2549 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002550 If a window size is specified when creating a new window sizes are
2551 currently not equalized (it's complicated, but may be implemented in
2552 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553
2554 *'equalprg'* *'ep'*
2555'equalprg' 'ep' string (default "")
2556 global or local to buffer |global-local|
2557 {not in Vi}
2558 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002559 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002560 or 'indentexpr'. When Vim was compiled without internal formatting,
2561 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002562 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 about including spaces and backslashes.
2564 This option cannot be set from a |modeline| or in the |sandbox|, for
2565 security reasons.
2566
2567 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2568'errorbells' 'eb' boolean (default off)
2569 global
2570 Ring the bell (beep or screen flash) for error messages. This only
2571 makes a difference for error messages, the bell will be used always
2572 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002573 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574 screen flash or do nothing.
2575
2576 *'errorfile'* *'ef'*
2577'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2578 others: "errors.err")
2579 global
2580 {not in Vi}
2581 {not available when compiled without the |+quickfix|
2582 feature}
2583 Name of the errorfile for the QuickFix mode (see |:cf|).
2584 When the "-q" command-line argument is used, 'errorfile' is set to the
2585 following argument. See |-q|.
2586 NOT used for the ":make" command. See 'makeef' for that.
2587 Environment variables are expanded |:set_env|.
2588 See |option-backslash| about including spaces and backslashes.
2589 This option cannot be set from a |modeline| or in the |sandbox|, for
2590 security reasons.
2591
2592 *'errorformat'* *'efm'*
2593'errorformat' 'efm' string (default is very long)
2594 global or local to buffer |global-local|
2595 {not in Vi}
2596 {not available when compiled without the |+quickfix|
2597 feature}
2598 Scanf-like description of the format for the lines in the error file
2599 (see |errorformat|).
2600
2601 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2602'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2603 global
2604 {not in Vi}
2605 Function keys that start with an <Esc> are recognized in Insert
2606 mode. When this option is off, the cursor and function keys cannot be
2607 used in Insert mode if they start with an <Esc>. The advantage of
2608 this is that the single <Esc> is recognized immediately, instead of
2609 after one second. Instead of resetting this option, you might want to
2610 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2611 when 'esckeys' is off, you can still map anything, but the cursor keys
2612 won't work by default.
2613 NOTE: This option is set to the Vi default value when 'compatible' is
2614 set and to the Vim default value when 'compatible' is reset.
2615
2616 *'eventignore'* *'ei'*
2617'eventignore' 'ei' string (default "")
2618 global
2619 {not in Vi}
2620 {not available when compiled without the |+autocmd|
2621 feature}
2622 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002623 When set to "all" or when "all" is one of the items, all autocommand
2624 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 Otherwise this is a comma separated list of event names. Example: >
2626 :set ei=WinEnter,WinLeave
2627<
2628 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2629'expandtab' 'et' boolean (default off)
2630 local to buffer
2631 {not in Vi}
2632 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002633 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2635 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2636 NOTE: This option is reset when 'compatible' is set.
2637
2638 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2639'exrc' 'ex' boolean (default off)
2640 global
2641 {not in Vi}
2642 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2643 directory. If you switch this option on you should also consider
2644 setting the 'secure' option (see |initialization|). Using a local
2645 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2646 also see |.vimrc| and |gui-init|.
2647 This option cannot be set from a |modeline| or in the |sandbox|, for
2648 security reasons.
2649
2650 *'fileencoding'* *'fenc'* *E213*
2651'fileencoding' 'fenc' string (default: "")
2652 local to buffer
2653 {only available when compiled with the |+multi_byte|
2654 feature}
2655 {not in Vi}
2656 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002657
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002659 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660 When 'fileencoding' is empty, the same value as 'encoding' will be
2661 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002662 Conversion will also be done when 'encoding' and 'fileencoding' are
2663 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2664 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002666 'encoding' is "utf-8" or another Unicode encoding, conversion
2667 is most likely done in a way that the reverse conversion
2668 results in the same text. When 'encoding' is not "utf-8" some
2669 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002670
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671 See 'encoding' for the possible values. Additionally, values may be
2672 specified that can be handled by the converter, see
2673 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002674
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 When reading a file 'fileencoding' will be set from 'fileencodings'.
2676 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002677 'fileencoding', use the |++enc| argument. One exception: when
2678 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002679 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002680
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2682 When the option is set, the value is converted to lowercase. Thus
2683 you can set it with uppercase values too. '_' characters are
2684 replaced with '-'. If a name is recognized from the list for
2685 'encoding', it is replaced by the standard name. For example
2686 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002687
Bram Moolenaar071d4272004-06-13 20:20:40 +00002688 When this option is set, after starting to edit a file, the 'modified'
2689 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002690
2691 Keep in mind that changing 'fenc' from a modeline happens
2692 AFTER the text has been read, thus it applies to when the file will be
2693 written. If you do set 'fenc' in a modeline, you might want to set
2694 'nomodified' to avoid not being able to ":q".
2695
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696 This option can not be changed when 'modifiable' is off.
2697
2698 *'fe'*
2699 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002700 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 old short name was 'fe', which is no longer used.
2702
2703 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002704'fileencodings' 'fencs' string (default: "ucs-bom",
2705 "ucs-bom,utf-8,default,latin1" when
2706 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707 global
2708 {only available when compiled with the |+multi_byte|
2709 feature}
2710 {not in Vi}
2711 This is a list of character encodings considered when starting to edit
2712 an existing file. When a file is read, Vim tries to use the first
2713 mentioned character encoding. If an error is detected, the next one
2714 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002715 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716 an empty string, which means the value of 'encoding' is used.
2717 WARNING: Conversion can cause loss of information! When
2718 'encoding' is "utf-8" (or one of the other Unicode variants)
2719 conversion is most likely done in a way that the reverse
2720 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002721 "utf-8" some non-ASCII characters may be lost! You can use
2722 the |++bad| argument to specify what is done with characters
2723 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 For an empty file or a file with only ASCII characters most encodings
2725 will work and the first entry of 'fileencodings' will be used (except
2726 "ucs-bom", which requires the BOM to be present). If you prefer
2727 another encoding use an BufReadPost autocommand event to test if your
2728 preferred encoding is to be used. Example: >
2729 au BufReadPost * if search('\S', 'w') == 0 |
2730 \ set fenc=iso-2022-jp | endif
2731< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2732 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002733 When the |++enc| argument is used then the value of 'fileencodings' is
2734 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002735 Note that 'fileencodings' is not used for a new file, the global value
2736 of 'fileencoding' is used instead. You can set it with: >
2737 :setglobal fenc=iso-8859-2
2738< This means that a non-existing file may get a different encoding than
2739 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740 The special value "ucs-bom" can be used to check for a Unicode BOM
2741 (Byte Order Mark) at the start of the file. It must not be preceded
2742 by "utf-8" or another Unicode encoding for this to work properly.
2743 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2744 because Vim cannot detect an error, thus the encoding is always
2745 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002746 The special value "default" can be used for the encoding from the
2747 environment. This is the default value for 'encoding'. It is useful
2748 when 'encoding' is set to "utf-8" and your environment uses a
2749 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002750 When 'encoding' is "utf-8" and a file contains an illegal byte
2751 sequence it won't be recognized as UTF-8. You can use the |8g8|
2752 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 WRONG VALUES: WHAT'S WRONG:
2754 latin1,utf-8 "latin1" will always be used
2755 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2756 file
2757 cp1250,latin1 "cp1250" will always be used
2758 If 'fileencodings' is empty, 'fileencoding' is not modified.
2759 See 'fileencoding' for the possible values.
2760 Setting this option does not have an effect until the next time a file
2761 is read.
2762
2763 *'fileformat'* *'ff'*
2764'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2765 Unix default: "unix",
2766 Macintosh default: "mac")
2767 local to buffer
2768 {not in Vi}
2769 This gives the <EOL> of the current buffer, which is used for
2770 reading/writing the buffer from/to a file:
2771 dos <CR> <NL>
2772 unix <NL>
2773 mac <CR>
2774 When "dos" is used, CTRL-Z at the end of a file is ignored.
2775 See |file-formats| and |file-read|.
2776 For the character encoding of the file see 'fileencoding'.
2777 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2778 works like it was set to "unix'.
2779 This option is set automatically when starting to edit a file and
2780 'fileformats' is not empty and 'binary' is off.
2781 When this option is set, after starting to edit a file, the 'modified'
2782 option is set, because the file would be different when written.
2783 This option can not be changed when 'modifiable' is off.
2784 For backwards compatibility: When this option is set to "dos",
2785 'textmode' is set, otherwise 'textmode' is reset.
2786
2787 *'fileformats'* *'ffs'*
2788'fileformats' 'ffs' string (default:
2789 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2790 Vim Unix: "unix,dos",
2791 Vim Mac: "mac,unix,dos",
2792 Vi Cygwin: "unix,dos",
2793 Vi others: "")
2794 global
2795 {not in Vi}
2796 This gives the end-of-line (<EOL>) formats that will be tried when
2797 starting to edit a new buffer and when reading a file into an existing
2798 buffer:
2799 - When empty, the format defined with 'fileformat' will be used
2800 always. It is not set automatically.
2801 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002802 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002803 'fileformats' name will be used when a file is read into an existing
2804 buffer, no matter what 'fileformat' for that buffer is set to.
2805 - When more than one name is present, separated by commas, automatic
2806 <EOL> detection will be done when reading a file. When starting to
2807 edit a file, a check is done for the <EOL>:
2808 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2809 'fileformat' is set to "dos".
2810 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002811 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 preceding <CR>, "unix" is preferred over "dos".
2813 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2814 This means that "mac" is only chosen when "unix" is not present,
2815 or when no <NL> is found in the file, and when "dos" is not
2816 present, or no <CR><NL> is present in the file.
2817 Also if "unix" was first chosen, but the first <CR> is before
2818 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2819 the file, then 'fileformat' is set to "mac".
2820 4. If 'fileformat' is still not set, the first name from
2821 'fileformats' is used.
2822 When reading a file into an existing buffer, the same is done, but
2823 this happens like 'fileformat' has been set appropriately for that
2824 file only, the option is not changed.
2825 When 'binary' is set, the value of 'fileformats' is not used.
2826
2827 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2828 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2829 done:
2830 - When 'fileformats' is empty, there is no automatic detection. Dos
2831 format will be used.
2832 - When 'fileformats' is set to one or more names, automatic detection
2833 is done. This is based on the first <NL> in the file: If there is a
2834 <CR> in front of it, Dos format is used, otherwise Unix format is
2835 used.
2836 Also see |file-formats|.
2837 For backwards compatibility: When this option is set to an empty
2838 string or one format (no comma is included), 'textauto' is reset,
2839 otherwise 'textauto' is set.
2840 NOTE: This option is set to the Vi default value when 'compatible' is
2841 set and to the Vim default value when 'compatible' is reset.
2842
2843 *'filetype'* *'ft'*
2844'filetype' 'ft' string (default: "")
2845 local to buffer
2846 {not in Vi}
2847 {not available when compiled without the |+autocmd|
2848 feature}
2849 When this option is set, the FileType autocommand event is triggered.
2850 All autocommands that match with the value of this option will be
2851 executed. Thus the value of 'filetype' is used in place of the file
2852 name.
2853 Otherwise this option does not always reflect the current file type.
2854 This option is normally set when the file type is detected. To enable
2855 this use the ":filetype on" command. |:filetype|
2856 Setting this option to a different value is most useful in a modeline,
2857 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002858 Example, for in an IDL file:
2859 /* vim: set filetype=idl : */ ~
2860 |FileType| |filetypes|
2861 When a dot appears in the value then this separates two filetype
2862 names. Example:
2863 /* vim: set filetype=c.doxygen : */ ~
2864 This will use the "c" filetype first, then the "doxygen" filetype.
2865 This works both for filetype plugins and for syntax files. More than
2866 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 Do not confuse this option with 'osfiletype', which is for the file
2868 type that is actually stored with the file.
2869 This option is not copied to another buffer, independent of the 's' or
2870 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002871 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872
2873 *'fillchars'* *'fcs'*
2874'fillchars' 'fcs' string (default "vert:|,fold:-")
2875 global
2876 {not in Vi}
2877 {not available when compiled without the |+windows|
2878 and |+folding| features}
2879 Characters to fill the statuslines and vertical separators.
2880 It is a comma separated list of items:
2881
2882 item default Used for ~
2883 stl:c ' ' or '^' statusline of the current window
2884 stlnc:c ' ' or '-' statusline of the non-current windows
2885 vert:c '|' vertical separators |:vsplit|
2886 fold:c '-' filling 'foldtext'
2887 diff:c '-' deleted lines of the 'diff' option
2888
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002889 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 "stlnc" the space will be used when there is highlighting, '^' or '-'
2891 otherwise.
2892
2893 Example: >
2894 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2895< This is similar to the default, except that these characters will also
2896 be used when there is highlighting.
2897
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002898 for "stl" and "stlnc" only single-byte values are supported.
2899
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 The highlighting used for these items:
2901 item highlight group ~
2902 stl:c StatusLine |hl-StatusLine|
2903 stlnc:c StatusLineNC |hl-StatusLineNC|
2904 vert:c VertSplit |hl-VertSplit|
2905 fold:c Folded |hl-Folded|
2906 diff:c DiffDelete |hl-DiffDelete|
2907
2908 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2909'fkmap' 'fk' boolean (default off) *E198*
2910 global
2911 {not in Vi}
2912 {only available when compiled with the |+rightleft|
2913 feature}
2914 When on, the keyboard is mapped for the Farsi character set.
2915 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002916 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917
2918 *'foldclose'* *'fcl'*
2919'foldclose' 'fcl' string (default "")
2920 global
2921 {not in Vi}
2922 {not available when compiled without the |+folding|
2923 feature}
2924 When set to "all", a fold is closed when the cursor isn't in it and
2925 its level is higher than 'foldlevel'. Useful if you want folds to
2926 automatically close when moving out of them.
2927
2928 *'foldcolumn'* *'fdc'*
2929'foldcolumn' 'fdc' number (default 0)
2930 local to window
2931 {not in Vi}
2932 {not available when compiled without the |+folding|
2933 feature}
2934 When non-zero, a column with the specified width is shown at the side
2935 of the window which indicates open and closed folds. The maximum
2936 value is 12.
2937 See |folding|.
2938
2939 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2940'foldenable' 'fen' boolean (default on)
2941 local to window
2942 {not in Vi}
2943 {not available when compiled without the |+folding|
2944 feature}
2945 When off, all folds are open. This option can be used to quickly
2946 switch between showing all text unfolded and viewing the text with
2947 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002948 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949 'foldenable' is off.
2950 This option is set by commands that create a new fold or close a fold.
2951 See |folding|.
2952
2953 *'foldexpr'* *'fde'*
2954'foldexpr' 'fde' string (default: "0")
2955 local to window
2956 {not in Vi}
2957 {not available when compiled without the |+folding|
2958 or |+eval| feature}
2959 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002960 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002961
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002962 The expression may be evaluated in the |sandbox|, see
2963 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002964 This option can't be set from a |modeline| when the 'diff' option is
2965 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002966
2967 It is not allowed to change text or jump to another window while
2968 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969
2970 *'foldignore'* *'fdi'*
2971'foldignore' 'fdi' string (default: "#")
2972 local to window
2973 {not in Vi}
2974 {not available when compiled without the |+folding|
2975 feature}
2976 Used only when 'foldmethod' is "indent". Lines starting with
2977 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002978 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 The default "#" works well for C programs. See |fold-indent|.
2980
2981 *'foldlevel'* *'fdl'*
2982'foldlevel' 'fdl' number (default: 0)
2983 local to window
2984 {not in Vi}
2985 {not available when compiled without the |+folding|
2986 feature}
2987 Sets the fold level: Folds with a higher level will be closed.
2988 Setting this option to zero will close all folds. Higher numbers will
2989 close fewer folds.
2990 This option is set by commands like |zm|, |zM| and |zR|.
2991 See |fold-foldlevel|.
2992
2993 *'foldlevelstart'* *'fdls'*
2994'foldlevelstart' 'fdls' number (default: -1)
2995 global
2996 {not in Vi}
2997 {not available when compiled without the |+folding|
2998 feature}
2999 Sets 'foldlevel' when starting to edit another buffer in a window.
3000 Useful to always start editing with all folds closed (value zero),
3001 some folds closed (one) or no folds closed (99).
3002 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003003 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 ignores this option and closes all folds.
3005 It is also done before BufReadPre autocommands, to allow an autocmd to
3006 overrule the 'foldlevel' value for specific files.
3007 When the value is negative, it is not used.
3008
3009 *'foldmarker'* *'fmr'* *E536*
3010'foldmarker' 'fmr' string (default: "{{{,}}}")
3011 local to window
3012 {not in Vi}
3013 {not available when compiled without the |+folding|
3014 feature}
3015 The start and end marker used when 'foldmethod' is "marker". There
3016 must be one comma, which separates the start and end marker. The
3017 marker is a literal string (a regular expression would be too slow).
3018 See |fold-marker|.
3019
3020 *'foldmethod'* *'fdm'*
3021'foldmethod' 'fdm' string (default: "manual")
3022 local to window
3023 {not in Vi}
3024 {not available when compiled without the |+folding|
3025 feature}
3026 The kind of folding used for the current window. Possible values:
3027 |fold-manual| manual Folds are created manually.
3028 |fold-indent| indent Lines with equal indent form a fold.
3029 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3030 |fold-marker| marker Markers are used to specify folds.
3031 |fold-syntax| syntax Syntax highlighting items specify folds.
3032 |fold-diff| diff Fold text that is not changed.
3033
3034 *'foldminlines'* *'fml'*
3035'foldminlines' 'fml' number (default: 1)
3036 local to window
3037 {not in Vi}
3038 {not available when compiled without the |+folding|
3039 feature}
3040 Sets the minimum number of screen lines for a fold to be displayed
3041 closed. Also for manually closed folds.
3042 Note that this only has an effect of what is displayed. After using
3043 "zc" to close a fold, which is displayed open because it's smaller
3044 than 'foldminlines', a following "zc" may close a containing fold.
3045
3046 *'foldnestmax'* *'fdn'*
3047'foldnestmax' 'fdn' number (default: 20)
3048 local to window
3049 {not in Vi}
3050 {not available when compiled without the |+folding|
3051 feature}
3052 Sets the maximum nesting of folds for the "indent" and "syntax"
3053 methods. This avoids that too many folds will be created. Using more
3054 than 20 doesn't work, because the internal limit is 20.
3055
3056 *'foldopen'* *'fdo'*
3057'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3058 search,tag,undo")
3059 global
3060 {not in Vi}
3061 {not available when compiled without the |+folding|
3062 feature}
3063 Specifies for which type of commands folds will be opened, if the
3064 command moves the cursor into a closed fold. It is a comma separated
3065 list of items.
3066 item commands ~
3067 all any
3068 block "(", "{", "[[", "[{", etc.
3069 hor horizontal movements: "l", "w", "fx", etc.
3070 insert any command in Insert mode
3071 jump far jumps: "G", "gg", etc.
3072 mark jumping to a mark: "'m", CTRL-O, etc.
3073 percent "%"
3074 quickfix ":cn", ":crew", ":make", etc.
3075 search search for a pattern: "/", "n", "*", "gd", etc.
3076 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003077 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 tag jumping to a tag: ":ta", CTRL-T, etc.
3079 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003080 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 the |zv| command to the mapping to get the same effect.
3082 When a movement command is used for an operator (e.g., "dl" or "y%")
3083 this option is not used. This means the operator will include the
3084 whole closed fold.
3085 Note that vertical movements are not here, because it would make it
3086 very difficult to move onto a closed fold.
3087 In insert mode the folds containing the cursor will always be open
3088 when text is inserted.
3089 To close folds you can re-apply 'foldlevel' with the |zx| command or
3090 set the 'foldclose' option to "all".
3091
3092 *'foldtext'* *'fdt'*
3093'foldtext' 'fdt' string (default: "foldtext()")
3094 local to window
3095 {not in Vi}
3096 {not available when compiled without the |+folding|
3097 feature}
3098 An expression which is used to specify the text displayed for a closed
3099 fold. See |fold-foldtext|.
3100
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003101 The expression may be evaluated in the |sandbox|, see
3102 |sandbox-option|.
3103
3104 It is not allowed to change text or jump to another window while
3105 evaluating 'foldtext' |textlock|.
3106
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 *'formatoptions'* *'fo'*
3108'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3109 local to buffer
3110 {not in Vi}
3111 This is a sequence of letters which describes how automatic
3112 formatting is to be done. See |fo-table|. When the 'paste' option is
3113 on, no formatting is done (like 'formatoptions' is empty). Commas can
3114 be inserted for readability.
3115 To avoid problems with flags that are added in the future, use the
3116 "+=" and "-=" feature of ":set" |add-option-flags|.
3117 NOTE: This option is set to the Vi default value when 'compatible' is
3118 set and to the Vim default value when 'compatible' is reset.
3119
Bram Moolenaar86b68352004-12-27 21:59:20 +00003120 *'formatlistpat'* *'flp'*
3121'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3122 local to buffer
3123 {not in Vi}
3124 A pattern that is used to recognize a list header. This is used for
3125 the "n" flag in 'formatoptions'.
3126 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003127 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003128 while still checking more characters. There must be a character
3129 following the pattern, when it matches the whole line it is handled
3130 like there is no match.
3131 The default recognizes a number, followed by an optional punctuation
3132 character and white space.
3133
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 *'formatprg'* *'fp'*
3135'formatprg' 'fp' string (default "")
3136 global
3137 {not in Vi}
3138 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003139 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003141 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003142 If the 'formatexpr' option is not empty it will be used instead.
3143 Otherwise, if 'formatprg' option is an empty string, the internal
3144 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003145 Environment variables are expanded |:set_env|. See |option-backslash|
3146 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003147 The expression may be evaluated in the |sandbox|, see
3148 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003150 *'formatexpr'* *'fex'*
3151'formatexpr' 'fex' string (default "")
3152 local to buffer
3153 {not in Vi}
3154 {not available when compiled without the |+eval|
3155 feature}
3156 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003157 operator or automatic formatting (see 'formatoptions'). When this
3158 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003159
3160 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003161 The |v:count| variable holds the number of lines to be formatted.
3162 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003163 inserted if the expression is being evaluated due to
3164 automatic formatting. This can be empty. Don't insert
3165 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003166
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003167 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003168 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003169< This will invoke the mylang#Format() function in the
3170 autoload/mylang.vim file in 'runtimepath'. |autoload|
3171
3172 The expression is also evaluated when 'textwidth' is set and adding
3173 text beyond that limit. This happens under the same conditions as
3174 when internal formatting is used. Make sure the cursor is kept in the
3175 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003176 return "i" or "R" in this situation.
3177
3178 When the expression evaluates to non-zero Vim will fall back to using
3179 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003180
3181 The expression may be evaluated in the |sandbox|, see
3182 |sandbox-option|.
3183
3184 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003185'fsync' 'fs' boolean (default on)
3186 global
3187 {not in Vi}
3188 When on, the library function fsync() will be called after writing a
3189 file. This will flush a file to disk, ensuring that it is safely
3190 written even on filesystems which do metadata-only journaling. This
3191 will force the harddrive to spin up on Linux systems running in laptop
3192 mode, so it may be undesirable in some situations. Be warned that
3193 turning this off increases the chances of data loss after a crash. On
3194 systems without an fsync() implementation, this variable is always
3195 off.
3196 Also see 'swapsync' for controlling fsync() on swap files.
3197
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3199'gdefault' 'gd' boolean (default off)
3200 global
3201 {not in Vi}
3202 When on, the ":substitute" flag 'g' is default on. This means that
3203 all matches in a line are substituted instead of one. When a 'g' flag
3204 is given to a ":substitute" command, this will toggle the substitution
3205 of all or one match. See |complex-change|.
3206
3207 command 'gdefault' on 'gdefault' off ~
3208 :s/// subst. all subst. one
3209 :s///g subst. one subst. all
3210 :s///gg subst. all subst. one
3211
3212 NOTE: This option is reset when 'compatible' is set.
3213
3214 *'grepformat'* *'gfm'*
3215'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3216 global
3217 {not in Vi}
3218 Format to recognize for the ":grep" command output.
3219 This is a scanf-like string that uses the same format as the
3220 'errorformat' option: see |errorformat|.
3221
3222 *'grepprg'* *'gp'*
3223'grepprg' 'gp' string (default "grep -n ",
3224 Unix: "grep -n $* /dev/null",
3225 Win32: "findstr /n" or "grep -n",
3226 VMS: "SEARCH/NUMBERS ")
3227 global or local to buffer |global-local|
3228 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003229 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 and '#' characters, which are expanded like when used in a command-
3231 line. The placeholder "$*" is allowed to specify where the arguments
3232 will be included. Environment variables are expanded |:set_env|. See
3233 |option-backslash| about including spaces and backslashes.
3234 When your "grep" accepts the "-H" argument, use this to make ":grep"
3235 also work well with a single file: >
3236 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003237< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003238 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3239 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003240 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 apply equally to 'grepprg'.
3242 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3243 otherwise it's "grep -n".
3244 This option cannot be set from a |modeline| or in the |sandbox|, for
3245 security reasons.
3246
3247 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3248'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3249 ve:ver35-Cursor,
3250 o:hor50-Cursor,
3251 i-ci:ver25-Cursor/lCursor,
3252 r-cr:hor20-Cursor/lCursor,
3253 sm:block-Cursor
3254 -blinkwait175-blinkoff150-blinkon175",
3255 for MS-DOS and Win32 console:
3256 "n-v-c:block,o:hor50,i-ci:hor15,
3257 r-cr:hor30,sm:block")
3258 global
3259 {not in Vi}
3260 {only available when compiled with GUI enabled, and
3261 for MS-DOS and Win32 console}
3262 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003263 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 the height of the cursor can be changed. This can be done by
3265 specifying a block cursor, or a percentage for a vertical or
3266 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003267 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003269 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 mode-list and an argument-list:
3271 mode-list:argument-list,mode-list:argument-list,..
3272 The mode-list is a dash separated list of these modes:
3273 n Normal mode
3274 v Visual mode
3275 ve Visual mode with 'selection' "exclusive" (same as 'v',
3276 if not specified)
3277 o Operator-pending mode
3278 i Insert mode
3279 r Replace mode
3280 c Command-line Normal (append) mode
3281 ci Command-line Insert mode
3282 cr Command-line Replace mode
3283 sm showmatch in Insert mode
3284 a all modes
3285 The argument-list is a dash separated list of these arguments:
3286 hor{N} horizontal bar, {N} percent of the character height
3287 ver{N} vertical bar, {N} percent of the character width
3288 block block cursor, fills the whole character
3289 [only one of the above three should be present]
3290 blinkwait{N} *cursor-blinking*
3291 blinkon{N}
3292 blinkoff{N}
3293 blink times for cursor: blinkwait is the delay before
3294 the cursor starts blinking, blinkon is the time that
3295 the cursor is shown and blinkoff is the time that the
3296 cursor is not shown. The times are in msec. When one
3297 of the numbers is zero, there is no blinking. The
3298 default is: "blinkwait700-blinkon400-blinkoff250".
3299 These numbers are used for a missing entry. This
3300 means that blinking is enabled by default. To switch
3301 blinking off you can use "blinkon0". The cursor only
3302 blinks when Vim is waiting for input, not while
3303 executing a command.
3304 To make the cursor blink in an xterm, see
3305 |xterm-blink|.
3306 {group-name}
3307 a highlight group name, that sets the color and font
3308 for the cursor
3309 {group-name}/{group-name}
3310 Two highlight group names, the first is used when
3311 no language mappings are used, the other when they
3312 are. |language-mapping|
3313
3314 Examples of parts:
3315 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3316 block cursor with colors from the "nCursor"
3317 highlight group
3318 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3319 In Insert and Command-line Insert mode, use a
3320 30% vertical bar cursor with colors from the
3321 "iCursor" highlight group. Blink a bit
3322 faster.
3323
3324 The 'a' mode is different. It will set the given argument-list for
3325 all modes. It does not reset anything to defaults. This can be used
3326 to do a common setting for all modes. For example, to switch off
3327 blinking: "a:blinkon0"
3328
3329 Examples of cursor highlighting: >
3330 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3331 :highlight Cursor gui=NONE guifg=bg guibg=fg
3332<
3333 *'guifont'* *'gfn'*
3334 *E235* *E596* *E610* *E611*
3335'guifont' 'gfn' string (default "")
3336 global
3337 {not in Vi}
3338 {only available when compiled with GUI enabled}
3339 This is a list of fonts which will be used for the GUI version of Vim.
3340 In its simplest form the value is just one font name. When
3341 the font cannot be found you will get an error message. To try other
3342 font names a list can be specified, font names separated with commas.
3343 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003344
Bram Moolenaar05159a02005-02-26 23:04:13 +00003345 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3346 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003347
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 Spaces after a comma are ignored. To include a comma in a font name
3349 precede it with a backslash. Setting an option requires an extra
3350 backslash before a space and a backslash. See also
3351 |option-backslash|. For example: >
3352 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003353< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003355
3356 If none of the fonts can be loaded, Vim will keep the current setting.
3357 If an empty font list is given, Vim will try using other resource
3358 settings (for X, it will use the Vim.font resource), and finally it
3359 will try some builtin default which should always be there ("7x13" in
3360 the case of X). The font names given should be "normal" fonts. Vim
3361 will try to find the related bold and italic fonts.
3362
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003363 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003364 :set guifont=*
3365< will bring up a font requester, where you can pick the font you want.
3366
3367 The font name depends on the GUI used. See |setting-guifont| for a
3368 way to set 'guifont' for various systems.
3369
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 For the GTK+ 2 GUI the font name looks like this: >
3371 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003372< That's all. XLFDs are not used. For Chinese this is reported to work
3373 well: >
3374 if has("gui_gtk2")
3375 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3376 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3377 endif
3378<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003379 For Mac OSX you can use something like this: >
3380 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003381< Also see 'macatsui', it can help fix display problems.
3382 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003384 width). An exception is GTK 2: all fonts are accepted, but
3385 mono-spaced fonts look best.
3386
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387 To preview a font on X11, you might be able to use the "xfontsel"
3388 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003389
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 For the Win32 GUI *E244* *E245*
3391 - takes these options in the font name:
3392 hXX - height is XX (points, can be floating-point)
3393 wXX - width is XX (points, can be floating-point)
3394 b - bold
3395 i - italic
3396 u - underline
3397 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003398 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3400 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3401 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003402 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403
3404 Use a ':' to separate the options.
3405 - A '_' can be used in the place of a space, so you don't need to use
3406 backslashes to escape the spaces.
3407 - Examples: >
3408 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3409 :set guifont=Andale_Mono:h7.5:w4.5
3410< See also |font-sizes|.
3411
3412 *'guifontset'* *'gfs'*
3413 *E250* *E252* *E234* *E597* *E598*
3414'guifontset' 'gfs' string (default "")
3415 global
3416 {not in Vi}
3417 {only available when compiled with GUI enabled and
3418 with the |+xfontset| feature}
3419 {not available in the GTK+ 2 GUI}
3420 When not empty, specifies two (or more) fonts to be used. The first
3421 one for normal English, the second one for your special language. See
3422 |xfontset|.
3423 Setting this option also means that all font names will be handled as
3424 a fontset name. Also the ones used for the "font" argument of the
3425 |:highlight| command.
3426 The fonts must match with the current locale. If fonts for the
3427 character sets that the current locale uses are not included, setting
3428 'guifontset' will fail.
3429 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3430 the comma-separated names are alternative names, one of which will be
3431 used. In 'guifontset' the whole string is one fontset name,
3432 including the commas. It is not possible to specify alternative
3433 fontset names.
3434 This example works on many X11 systems: >
3435 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3436<
3437 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3438'guifontwide' 'gfw' string (default "")
3439 global
3440 {not in Vi}
3441 {only available when compiled with GUI enabled}
3442 When not empty, specifies a comma-separated list of fonts to be used
3443 for double-width characters. The first font that can be loaded is
3444 used.
3445 Note: The size of these fonts must be exactly twice as wide as the one
3446 specified with 'guifont' and the same height.
3447
3448 All GUI versions but GTK+ 2:
3449
3450 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3451 'guifontset' is empty or invalid.
3452 When 'guifont' is set and a valid font is found in it and
3453 'guifontwide' is empty Vim will attempt to find a matching
3454 double-width font and set 'guifontwide' to it.
3455
3456 GTK+ 2 GUI only: *guifontwide_gtk2*
3457
3458 If set and valid, 'guifontwide' is always used for double width
3459 characters, even if 'encoding' is not set to "utf-8".
3460 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003461 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462 font for characters not available in 'guifont'. Thus you do not need
3463 to set 'guifontwide' at all unless you want to override the choice
3464 made by Pango/Xft.
3465
3466 *'guiheadroom'* *'ghr'*
3467'guiheadroom' 'ghr' number (default 50)
3468 global
3469 {not in Vi} {only for GTK and X11 GUI}
3470 The number of pixels subtracted from the screen height when fitting
3471 the GUI window on the screen. Set this before the GUI is started,
3472 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003473 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474 lines will be left for window decorations and other items on the
3475 screen. Set it to a negative value to allow windows taller than the
3476 screen.
3477
3478 *'guioptions'* *'go'*
3479'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003480 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 global
3482 {not in Vi}
3483 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003484 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 sequence of letters which describes what components and options of the
3486 GUI should be used.
3487 To avoid problems with flags that are added in the future, use the
3488 "+=" and "-=" feature of ":set" |add-option-flags|.
3489
3490 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003491 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 'a' Autoselect: If present, then whenever VISUAL mode is started,
3493 or the Visual area extended, Vim tries to become the owner of
3494 the windowing system's global selection. This means that the
3495 Visually highlighted text is available for pasting into other
3496 applications as well as into Vim itself. When the Visual mode
3497 ends, possibly due to an operation on the text, or when an
3498 application wants to paste the selection, the highlighted text
3499 is automatically yanked into the "* selection register.
3500 Thus the selection is still available for pasting into other
3501 applications after the VISUAL mode has ended.
3502 If not present, then Vim won't become the owner of the
3503 windowing system's global selection unless explicitly told to
3504 by a yank or delete operation for the "* register.
3505 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003506 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003507 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508 applies to the modeless selection.
3509
3510 'guioptions' autoselect Visual autoselect modeless ~
3511 "" - -
3512 "a" yes yes
3513 "A" - yes
3514 "aA" yes yes
3515
Bram Moolenaar02467872007-05-06 13:22:01 +00003516 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517 'c' Use console dialogs instead of popup dialogs for simple
3518 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003519 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003520 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003521 'guitablabel' can be used to change the text in the labels.
3522 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003523 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003524 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003525 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 'f' Foreground: Don't use fork() to detach the GUI from the shell
3527 where it was started. Use this for programs that wait for the
3528 editor to finish (e.g., an e-mail program). Alternatively you
3529 can use "gvim -f" or ":gui -f" to start the GUI in the
3530 foreground. |gui-fork|
3531 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003532 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003533 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3535 corner of the window. It's black&white on non-GTK, because of
3536 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003537 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003539 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003540 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003542 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 file is sourced the system menu has already been loaded; the
3544 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003545 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 'g' Grey menu items: Make menu items that are not active grey. If
3547 'g' is not included inactive menu items are not shown at all.
3548 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003549 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 't' Include tearoff menu items. Currently only works for Win32,
3551 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003552 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003553 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003554 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003555 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003557 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 'R' Right-hand scrollbar is present when there is a vertically
3559 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003560 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003562 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563 'L' Left-hand scrollbar is present when there is a vertically
3564 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003565 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3567 the longest visible line, or on the cursor line if the 'h'
3568 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003569 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 'h' Limit horizontal scrollbar size to the length of the cursor
3571 line. Reduces computations. |gui-horiz-scroll|
3572
3573 And yes, you may even have scrollbars on the left AND the right if
3574 you really want to :-). See |gui-scrollbars| for more information.
3575
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003576 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 'v' Use a vertical button layout for dialogs. When not included,
3578 a horizontal layout is preferred, but when it doesn't fit a
3579 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003580 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 'p' Use Pointer callbacks for X11 GUI. This is required for some
3582 window managers. If the cursor is not blinking or hollow at
3583 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003584 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003586 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003587 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003588
Bram Moolenaar02467872007-05-06 13:22:01 +00003589
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590 *'guipty'* *'noguipty'*
3591'guipty' boolean (default on)
3592 global
3593 {not in Vi}
3594 {only available when compiled with GUI enabled}
3595 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3596 I/O to/from shell commands. See |gui-pty|.
3597
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003598 *'guitablabel'* *'gtl'*
3599'guitablabel' 'gtl' string (default empty)
3600 global
3601 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003602 {only available when compiled with GUI enabled and
3603 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003604 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003605 pages line. When empty and when the result is empty Vim will use a
3606 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003607
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003608 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003609 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003610
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003611 Only used when the GUI tab pages line is displayed. 'e' must be
3612 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3613 used.
3614
Bram Moolenaar57657d82006-04-21 22:12:41 +00003615 *'guitabtooltip'* *'gtt'*
3616'guitabtooltip' 'gtt' string (default empty)
3617 global
3618 {not in Vi}
3619 {only available when compiled with GUI enabled and
3620 with the +windows feature}
3621 When nonempty describes the text to use in a tooltip for the GUI tab
3622 pages line. When empty Vim will use a default tooltip.
3623 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003624 You can include a line break. Simplest method is to use |:let|: >
3625 :let &guitabtooltip = "line one\nline two"
3626<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003627
Bram Moolenaar071d4272004-06-13 20:20:40 +00003628 *'helpfile'* *'hf'*
3629'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3630 (others) "$VIMRUNTIME/doc/help.txt")
3631 global
3632 {not in Vi}
3633 Name of the main help file. All distributed help files should be
3634 placed together in one directory. Additionally, all "doc" directories
3635 in 'runtimepath' will be used.
3636 Environment variables are expanded |:set_env|. For example:
3637 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003638 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 spaces and backslashes.
3640 This option cannot be set from a |modeline| or in the |sandbox|, for
3641 security reasons.
3642
3643 *'helpheight'* *'hh'*
3644'helpheight' 'hh' number (default 20)
3645 global
3646 {not in Vi}
3647 {not available when compiled without the +windows
3648 feature}
3649 Minimal initial height of the help window when it is opened with the
3650 ":help" command. The initial height of the help window is half of the
3651 current window, or (when the 'ea' option is on) the same as other
3652 windows. When the height is less than 'helpheight', the height is
3653 set to 'helpheight'. Set to zero to disable.
3654
3655 *'helplang'* *'hlg'*
3656'helplang' 'hlg' string (default: messages language or empty)
3657 global
3658 {only available when compiled with the |+multi_lang|
3659 feature}
3660 {not in Vi}
3661 Comma separated list of languages. Vim will use the first language
3662 for which the desired help can be found. The English help will always
3663 be used as a last resort. You can add "en" to prefer English over
3664 another language, but that will only find tags that exist in that
3665 language and not in the English help.
3666 Example: >
3667 :set helplang=de,it
3668< This will first search German, then Italian and finally English help
3669 files.
3670 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3671 try to find the tag in the current language before using this option.
3672 See |help-translated|.
3673
3674 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3675'hidden' 'hid' boolean (default off)
3676 global
3677 {not in Vi}
3678 When off a buffer is unloaded when it is |abandon|ed. When on a
3679 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3680 displayed in another window, it does not become hidden, of course.
3681 The commands that move through the buffer list sometimes make a buffer
3682 hidden although the 'hidden' option is off: When the buffer is
3683 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003684 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003685 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 This option is set for one command with ":hide {command}" |:hide|.
3687 WARNING: It's easy to forget that you have changes in hidden buffers.
3688 Think twice when using ":q!" or ":qa!".
3689
3690 *'highlight'* *'hl'*
3691'highlight' 'hl' string (default (as a single string):
3692 "8:SpecialKey,@:NonText,d:Directory,
3693 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3694 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003695 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3697 f:Folded,F:FoldColumn,A:DiffAdd,
3698 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003699 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003700 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003701 +:Pmenu,=:PmenuSel,
3702 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 global
3704 {not in Vi}
3705 This option can be used to set highlighting mode for various
3706 occasions. It is a comma separated list of character pairs. The
3707 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003708 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3710 |hl-NonText| @ '~' and '@' at the end of the window and
3711 characters from 'showbreak'
3712 |hl-Directory| d directories in CTRL-D listing and other special
3713 things in listings
3714 |hl-ErrorMsg| e error messages
3715 h (obsolete, ignored)
3716 |hl-IncSearch| i 'incsearch' highlighting
3717 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3718 |hl-MoreMsg| m |more-prompt|
3719 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003720 |hl-LineNr| n line number for ":number" and ":#" commands, and
3721 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 |hl-Question| r |hit-enter| prompt and yes/no questions
3723 |hl-StatusLine| s status line of current window |status-line|
3724 |hl-StatusLineNC| S status lines of not-current windows
3725 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3726 |hl-VertSplit| c column used to separate vertically split windows
3727 |hl-Visual| v Visual mode
3728 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3729 Selection" Only X11 Gui's |gui-x11| and
3730 |xterm-clipboard|.
3731 |hl-WarningMsg| w warning messages
3732 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3733 |hl-Folded| f line used for closed folds
3734 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003735 |hl-DiffAdd| A added line in diff mode
3736 |hl-DiffChange| C changed line in diff mode
3737 |hl-DiffDelete| D deleted line in diff mode
3738 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003740 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003741 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003742 |hl-SpellRare| R rare word |spell|
3743 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003744 |hl-Conceal| - the placeholders used for concealed characters
3745 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003746 |hl-Pmenu| + popup menu normal line
3747 |hl-PmenuSel| = popup menu normal line
3748 |hl-PmenuSbar| x popup menu scrollbar
3749 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750
3751 The display modes are:
3752 r reverse (termcap entry "mr" and "me")
3753 i italic (termcap entry "ZH" and "ZR")
3754 b bold (termcap entry "md" and "me")
3755 s standout (termcap entry "so" and "se")
3756 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003757 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 n no highlighting
3759 - no highlighting
3760 : use a highlight group
3761 The default is used for occasions that are not included.
3762 If you want to change what the display modes do, see |dos-colors|
3763 for an example.
3764 When using the ':' display mode, this must be followed by the name of
3765 a highlight group. A highlight group can be used to define any type
3766 of highlighting, including using color. See |:highlight| on how to
3767 define one. The default uses a different group for each occasion.
3768 See |highlight-default| for the default highlight groups.
3769
3770 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3771'hlsearch' 'hls' boolean (default off)
3772 global
3773 {not in Vi}
3774 {not available when compiled without the
3775 |+extra_search| feature}
3776 When there is a previous search pattern, highlight all its matches.
3777 The type of highlighting used can be set with the 'l' occasion in the
3778 'highlight' option. This uses the "Search" highlight group by
3779 default. Note that only the matching text is highlighted, any offsets
3780 are not applied.
3781 See also: 'incsearch' and |:match|.
3782 When you get bored looking at the highlighted matches, you can turn it
3783 off with |:nohlsearch|. As soon as you use a search command, the
3784 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003785 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 When the search pattern can match an end-of-line, Vim will try to
3787 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003788 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003790 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791 NOTE: This option is reset when 'compatible' is set.
3792
3793 *'history'* *'hi'*
3794'history' 'hi' number (Vim default: 20, Vi default: 0)
3795 global
3796 {not in Vi}
3797 A history of ":" commands, and a history of previous search patterns
3798 are remembered. This option decides how many entries may be stored in
3799 each of these histories (see |cmdline-editing|).
3800 NOTE: This option is set to the Vi default value when 'compatible' is
3801 set and to the Vim default value when 'compatible' is reset.
3802
3803 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3804'hkmap' 'hk' boolean (default off)
3805 global
3806 {not in Vi}
3807 {only available when compiled with the |+rightleft|
3808 feature}
3809 When on, the keyboard is mapped for the Hebrew character set.
3810 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3811 toggle this option. See |rileft.txt|.
3812 NOTE: This option is reset when 'compatible' is set.
3813
3814 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3815'hkmapp' 'hkp' boolean (default off)
3816 global
3817 {not in Vi}
3818 {only available when compiled with the |+rightleft|
3819 feature}
3820 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3821 This is useful if you have a non-Hebrew keyboard.
3822 See |rileft.txt|.
3823 NOTE: This option is reset when 'compatible' is set.
3824
3825 *'icon'* *'noicon'*
3826'icon' boolean (default off, on when title can be restored)
3827 global
3828 {not in Vi}
3829 {not available when compiled without the |+title|
3830 feature}
3831 When on, the icon text of the window will be set to the value of
3832 'iconstring' (if it is not empty), or to the name of the file
3833 currently being edited. Only the last part of the name is used.
3834 Overridden by the 'iconstring' option.
3835 Only works if the terminal supports setting window icons (currently
3836 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3837 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3838 builtin termcap).
3839 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003840 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 X11.
3842
3843 *'iconstring'*
3844'iconstring' string (default "")
3845 global
3846 {not in Vi}
3847 {not available when compiled without the |+title|
3848 feature}
3849 When this option is not empty, it will be used for the icon text of
3850 the window. This happens only when the 'icon' option is on.
3851 Only works if the terminal supports setting window icon text
3852 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3853 Does not work for MS Windows.
3854 When Vim was compiled with HAVE_X11 defined, the original icon will be
3855 restored if possible |X11|.
3856 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003857 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 'titlestring' for example settings.
3859 {not available when compiled without the |+statusline| feature}
3860
3861 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3862'ignorecase' 'ic' boolean (default off)
3863 global
3864 Ignore case in search patterns. Also used when searching in the tags
3865 file.
3866 Also see 'smartcase'.
3867 Can be overruled by using "\c" or "\C" in the pattern, see
3868 |/ignorecase|.
3869
3870 *'imactivatekey'* *'imak'*
3871'imactivatekey' 'imak' string (default "")
3872 global
3873 {not in Vi}
3874 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003875 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 Specifies the key that your Input Method in X-Windows uses for
3877 activation. When this is specified correctly, vim can fully control
3878 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3879 You can't use this option to change the activation key, the option
3880 tells Vim what the key is.
3881 Format:
3882 [MODIFIER_FLAG-]KEY_STRING
3883
3884 These characters can be used for MODIFIER_FLAG (case is ignored):
3885 S Shift key
3886 L Lock key
3887 C Control key
3888 1 Mod1 key
3889 2 Mod2 key
3890 3 Mod3 key
3891 4 Mod4 key
3892 5 Mod5 key
3893 Combinations are allowed, for example "S-C-space" or "SC-space" are
3894 both shift+ctrl+space.
3895 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3896
3897 Example: >
3898 :set imactivatekey=S-space
3899< "S-space" means shift+space. This is the activation key for kinput2 +
3900 canna (Japanese), and ami (Korean).
3901
3902 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3903'imcmdline' 'imc' boolean (default off)
3904 global
3905 {not in Vi}
3906 {only available when compiled with the |+xim|
3907 |+multi_byte_ime| or |global-ime| feature}
3908 When set the Input Method is always on when starting to edit a command
3909 line, unless entering a search pattern (see 'imsearch' for that).
3910 Setting this option is useful when your input method allows entering
3911 English characters directly, e.g., when it's used to type accented
3912 characters with dead keys.
3913
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003914 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3916 global
3917 {not in Vi}
3918 {only available when compiled with the |+xim|
3919 |+multi_byte_ime| or |global-ime| feature}
3920 When set the Input Method is never used. This is useful to disable
3921 the IM when it doesn't work properly.
3922 Currently this option is on by default for SGI/IRIX machines. This
3923 may change in later releases.
3924
3925 *'iminsert'* *'imi'*
3926'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3927 local to buffer
3928 {not in Vi}
3929 Specifies whether :lmap or an Input Method (IM) is to be used in
3930 Insert mode. Valid values:
3931 0 :lmap is off and IM is off
3932 1 :lmap is ON and IM is off
3933 2 :lmap is off and IM is ON
3934 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3935 or |global-ime|.
3936 To always reset the option to zero when leaving Insert mode with <Esc>
3937 this can be used: >
3938 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3939< This makes :lmap and IM turn off automatically when leaving Insert
3940 mode.
3941 Note that this option changes when using CTRL-^ in Insert mode
3942 |i_CTRL-^|.
3943 The value is set to 1 when setting 'keymap' to a valid keymap name.
3944 It is also used for the argument of commands like "r" and "f".
3945 The value 0 may not work correctly with Athena and Motif with some XIM
3946 methods. Use 'imdisable' to disable XIM then.
3947
3948 *'imsearch'* *'ims'*
3949'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3950 local to buffer
3951 {not in Vi}
3952 Specifies whether :lmap or an Input Method (IM) is to be used when
3953 entering a search pattern. Valid values:
3954 -1 the value of 'iminsert' is used, makes it look like
3955 'iminsert' is also used when typing a search pattern
3956 0 :lmap is off and IM is off
3957 1 :lmap is ON and IM is off
3958 2 :lmap is off and IM is ON
3959 Note that this option changes when using CTRL-^ in Command-line mode
3960 |c_CTRL-^|.
3961 The value is set to 1 when it is not -1 and setting the 'keymap'
3962 option to a valid keymap name.
3963 The value 0 may not work correctly with Athena and Motif with some XIM
3964 methods. Use 'imdisable' to disable XIM then.
3965
3966 *'include'* *'inc'*
3967'include' 'inc' string (default "^\s*#\s*include")
3968 global or local to buffer |global-local|
3969 {not in Vi}
3970 {not available when compiled without the
3971 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003972 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 pattern, just like for the "/" command (See |pattern|). The default
3974 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003975 "]I", "[d", etc.
3976 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003977 comes after the matched pattern. But if "\zs" appears in the pattern
3978 then the text matched from "\zs" to the end, or until "\ze" if it
3979 appears, is used as the file name. Use this to include characters
3980 that are not in 'isfname', such as a space. You can then use
3981 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003982 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983
3984 *'includeexpr'* *'inex'*
3985'includeexpr' 'inex' string (default "")
3986 local to buffer
3987 {not in Vi}
3988 {not available when compiled without the
3989 |+find_in_path| or |+eval| feature}
3990 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003991 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 :set includeexpr=substitute(v:fname,'\\.','/','g')
3993< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003994
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003996 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 Also used for |<cfile>|.
3998
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003999 The expression may be evaluated in the |sandbox|, see
4000 |sandbox-option|.
4001
4002 It is not allowed to change text or jump to another window while
4003 evaluating 'includeexpr' |textlock|.
4004
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4006'incsearch' 'is' boolean (default off)
4007 global
4008 {not in Vi}
4009 {not available when compiled without the
4010 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004011 While typing a search command, show where the pattern, as it was typed
4012 so far, matches. The matched string is highlighted. If the pattern
4013 is invalid or not found, nothing is shown. The screen will be updated
4014 often, this is only useful on fast terminals.
4015 Note that the match will be shown, but the cursor will return to its
4016 original position when no match is found and when pressing <Esc>. You
4017 still need to finish the search command with <Enter> to move the
4018 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004019 When compiled with the |+reltime| feature Vim only searches for about
4020 half a second. With a complicated pattern and/or a lot of text the
4021 match may not be found. This is to avoid that Vim hangs while you
4022 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004023 The highlighting can be set with the 'i' flag in 'highlight'.
4024 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004025 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004026 to the command line. If 'ignorecase' and 'smartcase' are set and the
4027 command line has no uppercase characters, the added character is
4028 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004029 CTRL-R CTRL-W can be used to add the word at the end of the current
4030 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 NOTE: This option is reset when 'compatible' is set.
4032
4033 *'indentexpr'* *'inde'*
4034'indentexpr' 'inde' string (default "")
4035 local to buffer
4036 {not in Vi}
4037 {not available when compiled without the |+cindent|
4038 or |+eval| features}
4039 Expression which is evaluated to obtain the proper indent for a line.
4040 It is used when a new line is created, for the |=| operator and
4041 in Insert mode as specified with the 'indentkeys' option.
4042 When this option is not empty, it overrules the 'cindent' and
4043 'smartindent' indenting.
4044 When 'paste' is set this option is not used for indenting.
4045 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004046 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 when the expression is evaluated (but it may be moved around).
4048 The expression must return the number of spaces worth of indent. It
4049 can return "-1" to keep the current indent (this means 'autoindent' is
4050 used for the indent).
4051 Functions useful for computing the indent are |indent()|, |cindent()|
4052 and |lispindent()|.
4053 The evaluation of the expression must not have side effects! It must
4054 not change the text, jump to another window, etc. Afterwards the
4055 cursor position is always restored, thus the cursor may be moved.
4056 Normally this option would be set to call a function: >
4057 :set indentexpr=GetMyIndent()
4058< Error messages will be suppressed, unless the 'debug' option contains
4059 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004060 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061 NOTE: This option is made empty when 'compatible' is set.
4062
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004063 The expression may be evaluated in the |sandbox|, see
4064 |sandbox-option|.
4065
4066 It is not allowed to change text or jump to another window while
4067 evaluating 'indentexpr' |textlock|.
4068
4069
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070 *'indentkeys'* *'indk'*
4071'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4072 local to buffer
4073 {not in Vi}
4074 {not available when compiled without the |+cindent|
4075 feature}
4076 A list of keys that, when typed in Insert mode, cause reindenting of
4077 the current line. Only happens if 'indentexpr' isn't empty.
4078 The format is identical to 'cinkeys', see |indentkeys-format|.
4079 See |C-indenting| and |indent-expression|.
4080
4081 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4082'infercase' 'inf' boolean (default off)
4083 local to buffer
4084 {not in Vi}
4085 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004086 'ignorecase' is also on, the case of the match is adjusted depending
4087 on the typed text. If the typed text contains a lowercase letter
4088 where the match has an upper case letter, the completed part is made
4089 lowercase. If the typed text has no lowercase letters and the match
4090 has a lowercase letter where the typed text has an uppercase letter,
4091 and there is a letter before it, the completed part is made uppercase.
4092 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093
4094 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4095'insertmode' 'im' boolean (default off)
4096 global
4097 {not in Vi}
4098 Makes Vim work in a way that Insert mode is the default mode. Useful
4099 if you want to use Vim as a modeless editor. Used for |evim|.
4100 These Insert mode commands will be useful:
4101 - Use the cursor keys to move around.
4102 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4103 this is a mapping, it is executed as if 'insertmode' was off.
4104 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004106 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4107 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004108
4109 These items change when 'insertmode' is set:
4110 - when starting to edit of a file, Vim goes to Insert mode.
4111 - <Esc> in Insert mode is a no-op and beeps.
4112 - <Esc> in Normal mode makes Vim go to Insert mode.
4113 - CTRL-L in Insert mode is a command, it is not inserted.
4114 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4115 However, when <Esc> is used inside a mapping, it behaves like
4116 'insertmode' was not set. This was done to be able to use the same
4117 mappings with 'insertmode' set or not set.
4118 When executing commands with |:normal| 'insertmode' is not used.
4119
4120 NOTE: This option is reset when 'compatible' is set.
4121
4122 *'isfname'* *'isf'*
4123'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4124 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4125 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4126 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4127 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4128 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4129 global
4130 {not in Vi}
4131 The characters specified by this option are included in file names and
4132 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004133 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134 Multi-byte characters 256 and above are always included, only the
4135 characters up to 255 are specified with this option.
4136 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004137 Think twice before adding white space to this option. Although a
4138 space may appear inside a file name, the effect will be that Vim
4139 doesn't know where a file name starts or ends when doing completion.
4140 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141
4142 Note that on systems using a backslash as path separator, Vim tries to
4143 do its best to make it work as you would expect. That is a bit
4144 tricky, since Vi originally used the backslash to escape special
4145 characters. Vim will not remove a backslash in front of a normal file
4146 name character on these systems, but it will on Unix and alikes. The
4147 '&' and '^' are not included by default, because these are special for
4148 cmd.exe.
4149
4150 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004151 Each part can be a single character number or a range. A range is two
4152 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 decimal number between 0 and 255 or the ASCII character itself (does
4154 not work for digits). Example:
4155 "_,-,128-140,#-43" (include '_' and '-' and the range
4156 128 to 140 and '#' to 43)
4157 If a part starts with '^', the following character number or range
4158 will be excluded from the option. The option is interpreted from left
4159 to right. Put the excluded character after the range where it is
4160 included. To include '^' itself use it as the last character of the
4161 option or the end of a range. Example:
4162 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4163 If the character is '@', all characters where isalpha() returns TRUE
4164 are included. Normally these are the characters a to z and A to Z,
4165 plus accented characters. To include '@' itself use "@-@". Examples:
4166 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004167 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168 "a-z,A-Z,@-@" All letters plus the '@' character.
4169 A comma can be included by using it where a character number is
4170 expected. Example:
4171 "48-57,,,_" Digits, comma and underscore.
4172 A comma can be excluded by prepending a '^'. Example:
4173 " -~,^,,9" All characters from space to '~', excluding
4174 comma, plus <Tab>.
4175 See |option-backslash| about including spaces and backslashes.
4176
4177 *'isident'* *'isi'*
4178'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4179 "@,48-57,_,128-167,224-235"
4180 otherwise: "@,48-57,_,192-255")
4181 global
4182 {not in Vi}
4183 The characters given by this option are included in identifiers.
4184 Identifiers are used in recognizing environment variables and after a
4185 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004186 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187 option.
4188 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004189 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4191
4192 *'iskeyword'* *'isk'*
4193'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4194 "@,48-57,_,128-167,224-235"
4195 otherwise: "@,48-57,_,192-255"
4196 Vi default: "@,48-57,_")
4197 local to buffer
4198 {not in Vi}
4199 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004200 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 'isfname' for a description of the format of this option. For C
4202 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4203 For a help file it is set to all non-blank printable characters except
4204 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4205 command).
4206 When the 'lisp' option is on the '-' character is always included.
4207 NOTE: This option is set to the Vi default value when 'compatible' is
4208 set and to the Vim default value when 'compatible' is reset.
4209
4210 *'isprint'* *'isp'*
4211'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4212 "@,~-255"; otherwise: "@,161-255")
4213 global
4214 {not in Vi}
4215 The characters given by this option are displayed directly on the
4216 screen. It is also used for "\p" in a |pattern|. The characters from
4217 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4218 even when they are not included in 'isprint' or excluded. See
4219 'isfname' for a description of the format of this option.
4220
4221 Non-printable characters are displayed with two characters:
4222 0 - 31 "^@" - "^_"
4223 32 - 126 always single characters
4224 127 "^?"
4225 128 - 159 "~@" - "~_"
4226 160 - 254 "| " - "|~"
4227 255 "~?"
4228 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4229 displayed as <xx>, with the hexadecimal value of the byte.
4230 When 'display' contains "uhex" all unprintable characters are
4231 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004232 The SpecialKey highlighting will be used for unprintable characters.
4233 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234
4235 Multi-byte characters 256 and above are always included, only the
4236 characters up to 255 are specified with this option. When a character
4237 is printable but it is not available in the current font, a
4238 replacement character will be shown.
4239 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4240 There is no option to specify these characters.
4241
4242 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4243'joinspaces' 'js' boolean (default on)
4244 global
4245 {not in Vi}
4246 Insert two spaces after a '.', '?' and '!' with a join command.
4247 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4248 Otherwise only one space is inserted.
4249 NOTE: This option is set when 'compatible' is set.
4250
4251 *'key'*
4252'key' string (default "")
4253 local to buffer
4254 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004255 {only available when compiled with the |+cryptv|
4256 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004257 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004258 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 Careful: Do not set the key value by hand, someone might see the typed
4260 key. Use the |:X| command. But you can make 'key' empty: >
4261 :set key=
4262< It is not possible to get the value of this option with ":set key" or
4263 "echo &key". This is to avoid showing it to someone who shouldn't
4264 know. It also means you cannot see it yourself once you have set it,
4265 be careful not to make a typing error!
4266
4267 *'keymap'* *'kmp'* *E544*
4268'keymap' 'kmp' string (default "")
4269 local to buffer
4270 {not in Vi}
4271 {only available when compiled with the |+keymap|
4272 feature}
4273 Name of a keyboard mapping. See |mbyte-keymap|.
4274 Setting this option to a valid keymap name has the side effect of
4275 setting 'iminsert' to one, so that the keymap becomes effective.
4276 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004277 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278
4279 *'keymodel'* *'km'*
4280'keymodel' 'km' string (default "")
4281 global
4282 {not in Vi}
4283 List of comma separated words, which enable special things that keys
4284 can do. These values can be used:
4285 startsel Using a shifted special key starts selection (either
4286 Select mode or Visual mode, depending on "key" being
4287 present in 'selectmode').
4288 stopsel Using a not-shifted special key stops selection.
4289 Special keys in this context are the cursor keys, <End>, <Home>,
4290 <PageUp> and <PageDown>.
4291 The 'keymodel' option is set by the |:behave| command.
4292
4293 *'keywordprg'* *'kp'*
4294'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4295 OS/2: "view /", VMS: "help")
4296 global or local to buffer |global-local|
4297 {not in Vi}
4298 Program to use for the |K| command. Environment variables are
4299 expanded |:set_env|. ":help" may be used to access the Vim internal
4300 help. (Note that previously setting the global option to the empty
4301 value did this, which is now deprecated.)
4302 When "man" is used, Vim will automatically translate a count for the
4303 "K" command to a section number. Also for "man -s", in which case the
4304 "-s" is removed when there is no count.
4305 See |option-backslash| about including spaces and backslashes.
4306 Example: >
4307 :set keywordprg=man\ -s
4308< This option cannot be set from a |modeline| or in the |sandbox|, for
4309 security reasons.
4310
4311 *'langmap'* *'lmap'* *E357* *E358*
4312'langmap' 'lmap' string (default "")
4313 global
4314 {not in Vi}
4315 {only available when compiled with the |+langmap|
4316 feature}
4317 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004318 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 inserted directly. When in command mode the 'langmap' option takes
4320 care of translating these special characters to the original meaning
4321 of the key. This means you don't have to change the keyboard mode to
4322 be able to execute Normal mode commands.
4323 This is the opposite of the 'keymap' option, where characters are
4324 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004326 Example (for Greek, in UTF-8): *greek* >
4327 :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 +00004328< Example (exchanges meaning of z and y for commands): >
4329 :set langmap=zy,yz,ZY,YZ
4330<
4331 The 'langmap' option is a list of parts, separated with commas. Each
4332 part can be in one of two forms:
4333 1. A list of pairs. Each pair is a "from" character immediately
4334 followed by the "to" character. Examples: "aA", "aAbBcC".
4335 2. A list of "from" characters, a semi-colon and a list of "to"
4336 characters. Example: "abc;ABC"
4337 Example: "aA,fgh;FGH,cCdDeE"
4338 Special characters need to be preceded with a backslash. These are
4339 ";", ',' and backslash itself.
4340
4341 This will allow you to activate vim actions without having to switch
4342 back and forth between the languages. Your language characters will
4343 be understood as normal vim English characters (according to the
4344 langmap mappings) in the following cases:
4345 o Normal/Visual mode (commands, buffer/register names, user mappings)
4346 o Insert/Replace Mode: Register names after CTRL-R
4347 o Insert/Replace Mode: Mappings
4348 Characters entered in Command-line mode will NOT be affected by
4349 this option. Note that this option can be changed at any time
4350 allowing to switch between mappings for different languages/encodings.
4351 Use a mapping to avoid having to type it each time!
4352
4353 *'langmenu'* *'lm'*
4354'langmenu' 'lm' string (default "")
4355 global
4356 {not in Vi}
4357 {only available when compiled with the |+menu| and
4358 |+multi_lang| features}
4359 Language to use for menu translation. Tells which file is loaded
4360 from the "lang" directory in 'runtimepath': >
4361 "lang/menu_" . &langmenu . ".vim"
4362< (without the spaces). For example, to always use the Dutch menus, no
4363 matter what $LANG is set to: >
4364 :set langmenu=nl_NL.ISO_8859-1
4365< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004366 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 If your $LANG is set to a non-English language but you do want to use
4368 the English menus: >
4369 :set langmenu=none
4370< This option must be set before loading menus, switching on filetype
4371 detection or syntax highlighting. Once the menus are defined setting
4372 this option has no effect. But you could do this: >
4373 :source $VIMRUNTIME/delmenu.vim
4374 :set langmenu=de_DE.ISO_8859-1
4375 :source $VIMRUNTIME/menu.vim
4376< Warning: This deletes all menus that you defined yourself!
4377
4378 *'laststatus'* *'ls'*
4379'laststatus' 'ls' number (default 1)
4380 global
4381 {not in Vi}
4382 The value of this option influences when the last window will have a
4383 status line:
4384 0: never
4385 1: only if there are at least two windows
4386 2: always
4387 The screen looks nicer with a status line if you have several
4388 windows, but it takes another screen line. |status-line|
4389
4390 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4391'lazyredraw' 'lz' boolean (default off)
4392 global
4393 {not in Vi}
4394 When this option is set, the screen will not be redrawn while
4395 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004396 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 update use |:redraw|.
4398
4399 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4400'linebreak' 'lbr' boolean (default off)
4401 local to window
4402 {not in Vi}
4403 {not available when compiled without the |+linebreak|
4404 feature}
4405 If on Vim will wrap long lines at a character in 'breakat' rather
4406 than at the last character that fits on the screen. Unlike
4407 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4408 it only affects the way the file is displayed, not its contents. The
4409 value of 'showbreak' is used to put in front of wrapped lines.
4410 This option is not used when the 'wrap' option is off or 'list' is on.
4411 Note that <Tab> characters after an <EOL> are mostly not displayed
4412 with the right amount of white space.
4413
4414 *'lines'* *E593*
4415'lines' number (default 24 or terminal height)
4416 global
4417 Number of lines of the Vim window.
4418 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004419 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 When Vim is running in the GUI or in a resizable window, setting this
4421 option will cause the window size to be changed. When you only want
4422 to use the size for the GUI, put the command in your |gvimrc| file.
4423 Vim limits the number of lines to what fits on the screen. You can
4424 use this command to get the tallest window possible: >
4425 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004426< Minimum value is 2, maximum value is 1000.
4427 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 When you set this option and Vim is unable to change the physical
4429 number of lines of the display, the display may be messed up.
4430
4431 *'linespace'* *'lsp'*
4432'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4433 global
4434 {not in Vi}
4435 {only in the GUI}
4436 Number of pixel lines inserted between characters. Useful if the font
4437 uses the full character cell height, making lines touch each other.
4438 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004439 With some fonts there can be too much room between lines (to have
4440 space for ascents and descents). Then it makes sense to set
4441 'linespace' to a negative value. This may cause display problems
4442 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443
4444 *'lisp'* *'nolisp'*
4445'lisp' boolean (default off)
4446 local to buffer
4447 {not available when compiled without the |+lispindent|
4448 feature}
4449 Lisp mode: When <Enter> is typed in insert mode set the indent for
4450 the next line to Lisp standards (well, sort of). Also happens with
4451 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4452 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4453 better. Also see 'lispwords'.
4454 The '-' character is included in keyword characters. Redefines the
4455 "=" operator to use this same indentation algorithm rather than
4456 calling an external program if 'equalprg' is empty.
4457 This option is not used when 'paste' is set.
4458 {Vi: Does it a little bit differently}
4459
4460 *'lispwords'* *'lw'*
4461'lispwords' 'lw' string (default is very long)
4462 global
4463 {not in Vi}
4464 {not available when compiled without the |+lispindent|
4465 feature}
4466 Comma separated list of words that influence the Lisp indenting.
4467 |'lisp'|
4468
4469 *'list'* *'nolist'*
4470'list' boolean (default off)
4471 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004472 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4473 line. Useful to see the difference between tabs and spaces and for
4474 trailing blanks. Further changed by the 'listchars' option.
4475
4476 The cursor is displayed at the start of the space a Tab character
4477 occupies, not at the end as usual in Normal mode. To get this cursor
4478 position while displaying Tabs with spaces, use: >
4479 :set list lcs=tab\ \
4480<
4481 Note that list mode will also affect formatting (set with 'textwidth'
4482 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483 changing the way tabs are displayed.
4484
4485 *'listchars'* *'lcs'*
4486'listchars' 'lcs' string (default "eol:$")
4487 global
4488 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004489 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 settings.
4491 eol:c Character to show at the end of each line. When
4492 omitted, there is no extra character at the end of the
4493 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004494 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004496 fill the space that the tab normally occupies.
4497 "tab:>-" will show a tab that takes four spaces as
4498 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004499 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500 trailing spaces are blank.
4501 extends:c Character to show in the last column, when 'wrap' is
4502 off and the line continues beyond the right of the
4503 screen.
4504 precedes:c Character to show in the first column, when 'wrap'
4505 is off and there is text preceding the character
4506 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004507 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004508 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004509 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004510 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004512 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004514 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515
4516 Examples: >
4517 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004518 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519 :set lcs=extends:>,precedes:<
4520< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004521 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004522 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523
4524 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4525'loadplugins' 'lpl' boolean (default on)
4526 global
4527 {not in Vi}
4528 When on the plugin scripts are loaded when starting up |load-plugins|.
4529 This option can be reset in your |vimrc| file to disable the loading
4530 of plugins.
4531 Note that using the "-u NONE" and "--noplugin" command line arguments
4532 reset this option. |-u| |--noplugin|
4533
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004534 *'macatsui'* *'nomacatsui'*
4535'macatsui' boolean (default on)
4536 global
4537 {only available in Mac GUI version}
4538 This is a workaround for when drawing doesn't work properly. When set
4539 and compiled with multi-byte support ATSUI text drawing is used. When
4540 not set ATSUI text drawing is not used. Switch this option off when
4541 you experience drawing problems. In a future version the problems may
4542 be solved and this option becomes obsolete. Therefore use this method
4543 to unset it: >
4544 if exists('&macatsui')
4545 set nomacatsui
4546 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004547< Another option to check if you have drawing problems is
4548 'termencoding'.
4549
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 *'magic'* *'nomagic'*
4551'magic' boolean (default on)
4552 global
4553 Changes the special characters that can be used in search patterns.
4554 See |pattern|.
4555 NOTE: To avoid portability problems with using patterns, always keep
4556 this option at the default "on". Only switch it off when working with
4557 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004558 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559
4560 *'makeef'* *'mef'*
4561'makeef' 'mef' string (default: "")
4562 global
4563 {not in Vi}
4564 {not available when compiled without the |+quickfix|
4565 feature}
4566 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4567 and the |:grep| command.
4568 When it is empty, an internally generated temp file will be used.
4569 When "##" is included, it is replaced by a number to make the name
4570 unique. This makes sure that the ":make" command doesn't overwrite an
4571 existing file.
4572 NOT used for the ":cf" command. See 'errorfile' for that.
4573 Environment variables are expanded |:set_env|.
4574 See |option-backslash| about including spaces and backslashes.
4575 This option cannot be set from a |modeline| or in the |sandbox|, for
4576 security reasons.
4577
4578 *'makeprg'* *'mp'*
4579'makeprg' 'mp' string (default "make", VMS: "MMS")
4580 global or local to buffer |global-local|
4581 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004582 Program to use for the ":make" command. See |:make_makeprg|.
4583 This option may contain '%' and '#' characters, which are expanded to
4584 the current and alternate file name. |:_%| |:_#|
4585 Environment variables are expanded |:set_env|. See |option-backslash|
4586 about including spaces and backslashes.
4587 Note that a '|' must be escaped twice: once for ":set" and once for
4588 the interpretation of a command. When you use a filter called
4589 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590 :set makeprg=gmake\ \\\|\ myfilter
4591< The placeholder "$*" can be given (even multiple times) to specify
4592 where the arguments will be included, for example: >
4593 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4594< This option cannot be set from a |modeline| or in the |sandbox|, for
4595 security reasons.
4596
Bram Moolenaar1a384422010-07-14 19:53:30 +02004597 *'colorcolumn'* *'cc'*
4598'colorcolumn' 'cc' string (default "")
4599 local to window
4600 {not in Vi}
4601 {not available when compiled without the |+syntax|
4602 feature}
4603 'colorcolumn' is a comma separated list of screen columns that are
4604 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
4605 text. Will make screen redrawing slower.
4606 The screen column can be an absolute number, or a number preceded with
4607 '+' or '-', which is added to or subtracted from 'textwidth'. >
4608
4609 :set cc=+1 " highlight column after 'textwidth'
4610 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
4611 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
4612<
4613 When 'textwidth' is zero then the items with '-' and '+' are not used.
4614 A maximum of 256 columns are highlighted.
4615
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 *'matchpairs'* *'mps'*
4617'matchpairs' 'mps' string (default "(:),{:},[:]")
4618 local to buffer
4619 {not in Vi}
4620 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004621 other. Currently only single byte character pairs are allowed, and
4622 they must be different. The characters must be separated by a colon.
4623 The pairs must be separated by a comma. Example for including '<' and
4624 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 :set mps+=<:>
4626
4627< A more exotic example, to jump between the '=' and ';' in an
4628 assignment, useful for languages like C and Java: >
4629 :au FileType c,cpp,java set mps+==:;
4630
4631< For a more advanced way of using "%", see the matchit.vim plugin in
4632 the $VIMRUNTIME/macros directory. |add-local-help|
4633
4634 *'matchtime'* *'mat'*
4635'matchtime' 'mat' number (default 5)
4636 global
4637 {not in Vi}{in Nvi}
4638 Tenths of a second to show the matching paren, when 'showmatch' is
4639 set. Note that this is not in milliseconds, like other options that
4640 set a time. This is to be compatible with Nvi.
4641
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004642 *'maxcombine'* *'mco'*
4643'maxcombine' 'mco' number (default 2)
4644 global
4645 {not in Vi}
4646 {only available when compiled with the |+multi_byte|
4647 feature}
4648 The maximum number of combining characters supported for displaying.
4649 Only used when 'encoding' is "utf-8".
4650 The default is OK for most languages. Hebrew may require 4.
4651 Maximum value is 6.
4652 Even when this option is set to 2 you can still edit text with more
4653 combining characters, you just can't see them. Use |g8| or |ga|.
4654 See |mbyte-combining|.
4655
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 *'maxfuncdepth'* *'mfd'*
4657'maxfuncdepth' 'mfd' number (default 100)
4658 global
4659 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004660 {not available when compiled without the +eval
4661 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 Maximum depth of function calls for user functions. This normally
4663 catches endless recursion. When using a recursive function with
4664 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4665 more memory, there is the danger of failing when memory is exhausted.
4666 See also |:function|.
4667
4668 *'maxmapdepth'* *'mmd'* *E223*
4669'maxmapdepth' 'mmd' number (default 1000)
4670 global
4671 {not in Vi}
4672 Maximum number of times a mapping is done without resulting in a
4673 character to be used. This normally catches endless mappings, like
4674 ":map x y" with ":map y x". It still does not catch ":map g wg",
4675 because the 'w' is used before the next mapping is done. See also
4676 |key-mapping|.
4677
4678 *'maxmem'* *'mm'*
4679'maxmem' 'mm' number (default between 256 to 5120 (system
4680 dependent) or half the amount of memory
4681 available)
4682 global
4683 {not in Vi}
4684 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4685 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004686 other memory to be freed. The maximum usable value is about 2000000.
4687 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004689 *'maxmempattern'* *'mmp'*
4690'maxmempattern' 'mmp' number (default 1000)
4691 global
4692 {not in Vi}
4693 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004694 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004695 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004696 When Vim runs into the limit it gives an error message and mostly
4697 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004698 Running into the limit often means that the pattern is very
4699 inefficient or too complex. This may already happen with the pattern
4700 "\(.\)*" on a very long line. ".*" works much better.
4701 Vim may run out of memory before hitting the 'maxmempattern' limit.
4702
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 *'maxmemtot'* *'mmt'*
4704'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4705 dependent) or half the amount of memory
4706 available)
4707 global
4708 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004709 Maximum amount of memory in Kbyte to use for all buffers together.
4710 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4711 without a limit. On 64 bit machines higher values might work. But
4712 hey, do you really need more than 2 Gbyte for text editing?
4713 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714
4715 *'menuitems'* *'mis'*
4716'menuitems' 'mis' number (default 25)
4717 global
4718 {not in Vi}
4719 {not available when compiled without the |+menu|
4720 feature}
4721 Maximum number of items to use in a menu. Used for menus that are
4722 generated from a list of items, e.g., the Buffers menu. Changing this
4723 option has no direct effect, the menu must be refreshed first.
4724
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004725 *'mkspellmem'* *'msm'*
4726'mkspellmem' 'msm' string (default "460000,2000,500")
4727 global
4728 {not in Vi}
4729 {not available when compiled without the |+syntax|
4730 feature}
4731 Parameters for |:mkspell|. This tunes when to start compressing the
4732 word tree. Compression can be slow when there are many words, but
4733 it's needed to avoid running out of memory. The amount of memory used
4734 per word depends very much on how similar the words are, that's why
4735 this tuning is complicated.
4736
4737 There are three numbers, separated by commas:
4738 {start},{inc},{added}
4739
4740 For most languages the uncompressed word tree fits in memory. {start}
4741 gives the amount of memory in Kbyte that can be used before any
4742 compression is done. It should be a bit smaller than the amount of
4743 memory that is available to Vim.
4744
4745 When going over the {start} limit the {inc} number specifies the
4746 amount of memory in Kbyte that can be allocated before another
4747 compression is done. A low number means compression is done after
4748 less words are added, which is slow. A high number means more memory
4749 will be allocated.
4750
4751 After doing compression, {added} times 1024 words can be added before
4752 the {inc} limit is ignored and compression is done when any extra
4753 amount of memory is needed. A low number means there is a smaller
4754 chance of hitting the {inc} limit, less memory is used but it's
4755 slower.
4756
4757 The languages for which these numbers are important are Italian and
4758 Hungarian. The default works for when you have about 512 Mbyte. If
4759 you have 1 Gbyte you could use: >
4760 :set mkspellmem=900000,3000,800
4761< If you have less than 512 Mbyte |:mkspell| may fail for some
4762 languages, no matter what you set 'mkspellmem' to.
4763
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004765'modeline' 'ml' boolean (Vim default: on (off for root),
4766 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 local to buffer
4768 *'modelines'* *'mls'*
4769'modelines' 'mls' number (default 5)
4770 global
4771 {not in Vi}
4772 If 'modeline' is on 'modelines' gives the number of lines that is
4773 checked for set commands. If 'modeline' is off or 'modelines' is zero
4774 no lines are checked. See |modeline|.
4775 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4776 set and to the Vim default value when 'compatible' is reset.
4777
4778 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4779'modifiable' 'ma' boolean (default on)
4780 local to buffer
4781 {not in Vi} *E21*
4782 When off the buffer contents cannot be changed. The 'fileformat' and
4783 'fileencoding' options also can't be changed.
4784 Can be reset with the |-M| command line argument.
4785
4786 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4787'modified' 'mod' boolean (default off)
4788 local to buffer
4789 {not in Vi}
4790 When on, the buffer is considered to be modified. This option is set
4791 when:
4792 1. A change was made to the text since it was last written. Using the
4793 |undo| command to go back to the original text will reset the
4794 option. But undoing changes that were made before writing the
4795 buffer will set the option again, since the text is different from
4796 when it was written.
4797 2. 'fileformat' or 'fileencoding' is different from its original
4798 value. The original value is set when the buffer is read or
4799 written. A ":set nomodified" command also resets the original
4800 values to the current values and the 'modified' option will be
4801 reset.
4802 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4803 will be ignored.
4804
4805 *'more'* *'nomore'*
4806'more' boolean (Vim default: on, Vi default: off)
4807 global
4808 {not in Vi}
4809 When on, listings pause when the whole screen is filled. You will get
4810 the |more-prompt|. When this option is off there are no pauses, the
4811 listing continues until finished.
4812 NOTE: This option is set to the Vi default value when 'compatible' is
4813 set and to the Vim default value when 'compatible' is reset.
4814
4815 *'mouse'* *E538*
4816'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4817 global
4818 {not in Vi}
4819 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004820 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4821 sysmouse and Linux console with gpm). For using the mouse in the
4822 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823 The mouse can be enabled for different modes:
4824 n Normal mode
4825 v Visual mode
4826 i Insert mode
4827 c Command-line mode
4828 h all previous modes when editing a help file
4829 a all previous modes
4830 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831 Normally you would enable the mouse in all four modes with: >
4832 :set mouse=a
4833< When the mouse is not enabled, the GUI will still use the mouse for
4834 modeless selection. This doesn't move the text cursor.
4835
4836 See |mouse-using|. Also see |'clipboard'|.
4837
4838 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004839 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 the mouse buttons can still be used by keeping the shift key pressed.
4841 Also see the 'clipboard' option.
4842
4843 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4844'mousefocus' 'mousef' boolean (default off)
4845 global
4846 {not in Vi}
4847 {only works in the GUI}
4848 The window that the mouse pointer is on is automatically activated.
4849 When changing the window layout or window focus in another way, the
4850 mouse pointer is moved to the window with keyboard focus. Off is the
4851 default because it makes using the pull down menus a little goofy, as
4852 a pointer transit may activate a window unintentionally.
4853
4854 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4855'mousehide' 'mh' boolean (default on)
4856 global
4857 {not in Vi}
4858 {only works in the GUI}
4859 When on, the mouse pointer is hidden when characters are typed.
4860 The mouse pointer is restored when the mouse is moved.
4861
4862 *'mousemodel'* *'mousem'*
4863'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4864 global
4865 {not in Vi}
4866 Sets the model to use for the mouse. The name mostly specifies what
4867 the right mouse button is used for:
4868 extend Right mouse button extends a selection. This works
4869 like in an xterm.
4870 popup Right mouse button pops up a menu. The shifted left
4871 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004872 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873 popup_setpos Like "popup", but the cursor will be moved to the
4874 position where the mouse was clicked, and thus the
4875 selected operation will act upon the clicked object.
4876 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004877 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878 course, that right clicking outside a selection will
4879 end Visual mode.
4880 Overview of what button does what for each model:
4881 mouse extend popup(_setpos) ~
4882 left click place cursor place cursor
4883 left drag start selection start selection
4884 shift-left search word extend selection
4885 right click extend selection popup menu (place cursor)
4886 right drag extend selection -
4887 middle click paste paste
4888
4889 In the "popup" model the right mouse button produces a pop-up menu.
4890 You need to define this first, see |popup-menu|.
4891
4892 Note that you can further refine the meaning of buttons with mappings.
4893 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4894 selection (because that's handled in the GUI code directly).
4895
4896 The 'mousemodel' option is set by the |:behave| command.
4897
4898 *'mouseshape'* *'mouses'* *E547*
4899'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004900 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901 global
4902 {not in Vi}
4903 {only available when compiled with the |+mouseshape|
4904 feature}
4905 This option tells Vim what the mouse pointer should look like in
4906 different modes. The option is a comma separated list of parts, much
4907 like used for 'guicursor'. Each part consist of a mode/location-list
4908 and an argument-list:
4909 mode-list:shape,mode-list:shape,..
4910 The mode-list is a dash separated list of these modes/locations:
4911 In a normal window: ~
4912 n Normal mode
4913 v Visual mode
4914 ve Visual mode with 'selection' "exclusive" (same as 'v',
4915 if not specified)
4916 o Operator-pending mode
4917 i Insert mode
4918 r Replace mode
4919
4920 Others: ~
4921 c appending to the command-line
4922 ci inserting in the command-line
4923 cr replacing in the command-line
4924 m at the 'Hit ENTER' or 'More' prompts
4925 ml idem, but cursor in the last line
4926 e any mode, pointer below last window
4927 s any mode, pointer on a status line
4928 sd any mode, while dragging a status line
4929 vs any mode, pointer on a vertical separator line
4930 vd any mode, while dragging a vertical separator line
4931 a everywhere
4932
4933 The shape is one of the following:
4934 avail name looks like ~
4935 w x arrow Normal mouse pointer
4936 w x blank no pointer at all (use with care!)
4937 w x beam I-beam
4938 w x updown up-down sizing arrows
4939 w x leftright left-right sizing arrows
4940 w x busy The system's usual busy pointer
4941 w x no The system's usual 'no input' pointer
4942 x udsizing indicates up-down resizing
4943 x lrsizing indicates left-right resizing
4944 x crosshair like a big thin +
4945 x hand1 black hand
4946 x hand2 white hand
4947 x pencil what you write with
4948 x question big ?
4949 x rightup-arrow arrow pointing right-up
4950 w x up-arrow arrow pointing up
4951 x <number> any X11 pointer number (see X11/cursorfont.h)
4952
4953 The "avail" column contains a 'w' if the shape is available for Win32,
4954 x for X11.
4955 Any modes not specified or shapes not available use the normal mouse
4956 pointer.
4957
4958 Example: >
4959 :set mouseshape=s:udsizing,m:no
4960< will make the mouse turn to a sizing arrow over the status lines and
4961 indicate no input when the hit-enter prompt is displayed (since
4962 clicking the mouse has no effect in this state.)
4963
4964 *'mousetime'* *'mouset'*
4965'mousetime' 'mouset' number (default 500)
4966 global
4967 {not in Vi}
4968 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4969 time in msec between two mouse clicks for the second click to be
4970 recognized as a multi click.
4971
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004972 *'mzquantum'* *'mzq'*
4973'mzquantum' 'mzq' number (default 100)
4974 global
4975 {not in Vi}
4976 {not available when compiled without the |+mzscheme|
4977 feature}
4978 The number of milliseconds between polls for MzScheme threads.
4979 Negative or zero value means no thread scheduling.
4980
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 *'nrformats'* *'nf'*
4982'nrformats' 'nf' string (default "octal,hex")
4983 local to buffer
4984 {not in Vi}
4985 This defines what bases Vim will consider for numbers when using the
4986 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4987 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004988 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02004990 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00004991 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004993 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004994 considered to be hexadecimal. Example: Using CTRL-X on
4995 "0x100" results in "0x0ff".
4996 Numbers which simply begin with a digit in the range 1-9 are always
4997 considered decimal. This also happens for numbers that are not
4998 recognized as octal or hex.
4999
5000 *'number'* *'nu'* *'nonumber'* *'nonu'*
5001'number' 'nu' boolean (default off)
5002 local to window
5003 Print the line number in front of each line. When the 'n' option is
5004 excluded from 'cpoptions' a wrapped line will not use the column of
5005 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005006 The 'numberwidth' option can be used to set the room used for the line
5007 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 When a long, wrapped line doesn't start with the first character, '-'
5009 characters are put before the number.
5010 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005011 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005013 *'numberwidth'* *'nuw'*
5014'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5015 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005016 {not in Vi}
5017 {only available when compiled with the |+linebreak|
5018 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005019 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005020 when the 'number' or 'relativenumber' option is set or printing lines
5021 with a line number. Since one space is always between the number and
5022 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005023 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005024 fit the highest line number in the buffer respectively the number of
5025 rows in the window, depending on whether 'number' or 'relativenumber'
5026 is set. Thus with the Vim default of 4 there is room for a line number
5027 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005028 The minimum value is 1, the maximum value is 10.
5029 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5030
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005031 *'omnifunc'* *'ofu'*
5032'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005033 local to buffer
5034 {not in Vi}
5035 {not available when compiled without the +eval
5036 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005037 This option specifies a function to be used for Insert mode omni
5038 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005039 See |complete-functions| for an explanation of how the function is
5040 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005041 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005042 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005043
5044
Bram Moolenaar02467872007-05-06 13:22:01 +00005045 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005046'opendevice' 'odev' boolean (default off)
5047 global
5048 {not in Vi}
5049 {only for MS-DOS, MS-Windows and OS/2}
5050 Enable reading and writing from devices. This may get Vim stuck on a
5051 device that can be opened but doesn't actually do the I/O. Therefore
5052 it is off by default.
5053 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5054 result in editing a device.
5055
5056
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005057 *'operatorfunc'* *'opfunc'*
5058'operatorfunc' 'opfunc' string (default: empty)
5059 global
5060 {not in Vi}
5061 This option specifies a function to be called by the |g@| operator.
5062 See |:map-operator| for more info and an example.
5063
5064 This option cannot be set from a |modeline| or in the |sandbox|, for
5065 security reasons.
5066
5067
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068 *'osfiletype'* *'oft'* *E366*
5069'osfiletype' 'oft' string (RISC-OS default: "Text",
5070 others default: "")
5071 local to buffer
5072 {not in Vi}
5073 {only available when compiled with the |+osfiletype|
5074 feature}
5075 Some operating systems store extra information about files besides
5076 name, datestamp and permissions. This option contains the extra
5077 information, the nature of which will vary between systems.
5078 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005079 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005080 It can affect the pattern matching of the automatic commands.
5081 |autocmd-osfiletypes|
5082
5083 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005084'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005085 global
5086 Specifies the nroff macros that separate paragraphs. These are pairs
5087 of two letters (see |object-motions|).
5088
5089 *'paste'* *'nopaste'*
5090'paste' boolean (default off)
5091 global
5092 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005093 Put Vim in Paste mode. This is useful if you want to cut or copy
5094 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095 unexpected effects.
5096 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005097 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 knows about pasting and will mostly do the right thing without 'paste'
5099 being set. The same is true for a terminal where Vim handles the
5100 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005101 This option is reset when starting the GUI. Thus if you set it in
5102 your .vimrc it will work in a terminal, but not in the GUI. Setting
5103 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5104 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105 When the 'paste' option is switched on (also when it was already on):
5106 - mapping in Insert mode and Command-line mode is disabled
5107 - abbreviations are disabled
5108 - 'textwidth' is set to 0
5109 - 'wrapmargin' is set to 0
5110 - 'autoindent' is reset
5111 - 'smartindent' is reset
5112 - 'softtabstop' is set to 0
5113 - 'revins' is reset
5114 - 'ruler' is reset
5115 - 'showmatch' is reset
5116 - 'formatoptions' is used like it is empty
5117 These options keep their value, but their effect is disabled:
5118 - 'lisp'
5119 - 'indentexpr'
5120 - 'cindent'
5121 NOTE: When you start editing another file while the 'paste' option is
5122 on, settings from the modelines or autocommands may change the
5123 settings again, causing trouble when pasting text. You might want to
5124 set the 'paste' option again.
5125 When the 'paste' option is reset the mentioned options are restored to
5126 the value before the moment 'paste' was switched from off to on.
5127 Resetting 'paste' before ever setting it does not have any effect.
5128 Since mapping doesn't work while 'paste' is active, you need to use
5129 the 'pastetoggle' option to toggle the 'paste' option with some key.
5130
5131 *'pastetoggle'* *'pt'*
5132'pastetoggle' 'pt' string (default "")
5133 global
5134 {not in Vi}
5135 When non-empty, specifies the key sequence that toggles the 'paste'
5136 option. This is like specifying a mapping: >
5137 :map {keys} :set invpaste<CR>
5138< Where {keys} is the value of 'pastetoggle'.
5139 The difference is that it will work even when 'paste' is set.
5140 'pastetoggle' works in Insert mode and Normal mode, but not in
5141 Command-line mode.
5142 Mappings are checked first, thus overrule 'pastetoggle'. However,
5143 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5144 this: >
5145 :map <F10> :set paste<CR>
5146 :map <F11> :set nopaste<CR>
5147 :imap <F10> <C-O>:set paste<CR>
5148 :imap <F11> <nop>
5149 :set pastetoggle=<F11>
5150< This will make <F10> start paste mode and <F11> stop paste mode.
5151 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5152 mode everything is inserted literally, except the 'pastetoggle' key
5153 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005154 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155
5156 *'pex'* *'patchexpr'*
5157'patchexpr' 'pex' string (default "")
5158 global
5159 {not in Vi}
5160 {not available when compiled without the |+diff|
5161 feature}
5162 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005163 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164
5165 *'patchmode'* *'pm'* *E206*
5166'patchmode' 'pm' string (default "")
5167 global
5168 {not in Vi}
5169 When non-empty the oldest version of a file is kept. This can be used
5170 to keep the original version of a file if you are changing files in a
5171 source distribution. Only the first time that a file is written a
5172 copy of the original file will be kept. The name of the copy is the
5173 name of the original file with the string in the 'patchmode' option
5174 appended. This option should start with a dot. Use a string like
5175 ".org". 'backupdir' must not be empty for this to work (Detail: The
5176 backup file is renamed to the patchmode file after the new file has
5177 been successfully written, that's why it must be possible to write a
5178 backup file). If there was no file to be backed up, an empty file is
5179 created.
5180 When the 'backupskip' pattern matches, a patchmode file is not made.
5181 Using 'patchmode' for compressed files appends the extension at the
5182 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5183 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005184 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185
5186 *'path'* *'pa'* *E343* *E345* *E347*
5187'path' 'pa' string (default on Unix: ".,/usr/include,,"
5188 on OS/2: ".,/emx/include,,"
5189 other systems: ".,,")
5190 global or local to buffer |global-local|
5191 {not in Vi}
5192 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005193 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5194 provided that the file being searched for has a relative path (not
5195 starting with "/", "./" or "../"). The directories in the 'path'
5196 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005197 - Use commas to separate directory names: >
5198 :set path=.,/usr/local/include,/usr/include
5199< - Spaces can also be used to separate directory names (for backwards
5200 compatibility with version 3.0). To have a space in a directory
5201 name, precede it with an extra backslash, and escape the space: >
5202 :set path=.,/dir/with\\\ space
5203< - To include a comma in a directory name precede it with an extra
5204 backslash: >
5205 :set path=.,/dir/with\\,comma
5206< - To search relative to the directory of the current file, use: >
5207 :set path=.
5208< - To search in the current directory use an empty string between two
5209 commas: >
5210 :set path=,,
5211< - A directory name may end in a ':' or '/'.
5212 - Environment variables are expanded |:set_env|.
5213 - When using |netrw.vim| URLs can be used. For example, adding
5214 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005215 - Search upwards and downwards in a directory tree using "*", "**" and
5216 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 {not available when compiled without the |+path_extra| feature}
5218 - Careful with '\' characters, type two to get one in the option: >
5219 :set path=.,c:\\include
5220< Or just use '/' instead: >
5221 :set path=.,c:/include
5222< Don't forget "." or files won't even be found in the same directory as
5223 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005224 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005225 it is something like 256 or 1024 characters.
5226 You can check if all the include files are found, using the value of
5227 'path', see |:checkpath|.
5228 The use of |:set+=| and |:set-=| is preferred when adding or removing
5229 directories from the list. This avoids problems when a future version
5230 uses another default. To remove the current directory use: >
5231 :set path-=
5232< To add the current directory use: >
5233 :set path+=
5234< To use an environment variable, you probably need to replace the
5235 separator. Here is an example to append $INCL, in which directory
5236 names are separated with a semi-colon: >
5237 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5238< Replace the ';' with a ':' or whatever separator is used. Note that
5239 this doesn't work when $INCL contains a comma or white space.
5240
5241 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5242'preserveindent' 'pi' boolean (default off)
5243 local to buffer
5244 {not in Vi}
5245 When changing the indent of the current line, preserve as much of the
5246 indent structure as possible. Normally the indent is replaced by a
5247 series of tabs followed by spaces as required (unless |'expandtab'| is
5248 enabled, in which case only spaces are used). Enabling this option
5249 means the indent will preserve as many existing characters as possible
5250 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005251 'expandtab' does not apply to the preserved white space, a Tab remains
5252 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 NOTE: When using ">>" multiple times the resulting indent is a mix of
5254 tabs and spaces. You might not like this.
5255 NOTE: 'preserveindent' is reset when 'compatible' is set.
5256 Also see 'copyindent'.
5257 Use |:retab| to clean up white space.
5258
5259 *'previewheight'* *'pvh'*
5260'previewheight' 'pvh' number (default 12)
5261 global
5262 {not in Vi}
5263 {not available when compiled without the |+windows| or
5264 |+quickfix| feature}
5265 Default height for a preview window. Used for |:ptag| and associated
5266 commands. Used for |CTRL-W_}| when no count is given.
5267
5268 *'previewwindow'* *'nopreviewwindow'*
5269 *'pvw'* *'nopvw'* *E590*
5270'previewwindow' 'pvw' boolean (default off)
5271 local to window
5272 {not in Vi}
5273 {not available when compiled without the |+windows| or
5274 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005275 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 set. It's normally not set directly, but by using one of the commands
5277 |:ptag|, |:pedit|, etc.
5278
5279 *'printdevice'* *'pdev'*
5280'printdevice' 'pdev' string (default empty)
5281 global
5282 {not in Vi}
5283 {only available when compiled with the |+printer|
5284 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005285 The name of the printer to be used for |:hardcopy|.
5286 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005287 This option cannot be set from a |modeline| or in the |sandbox|, for
5288 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289
Bram Moolenaar8299df92004-07-10 09:47:34 +00005290 *'printencoding'* *'penc'*
5291'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 global
5293 {not in Vi}
5294 {only available when compiled with the |+printer|
5295 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005296 Sets the character encoding used when printing.
5297 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298
5299 *'printexpr'* *'pexpr'*
5300'printexpr' 'pexpr' String (default: see below)
5301 global
5302 {not in Vi}
5303 {only available when compiled with the |+printer|
5304 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005305 Expression used to print the PostScript produced with |:hardcopy|.
5306 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307
Bram Moolenaar8299df92004-07-10 09:47:34 +00005308 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309'printfont' 'pfn' string (default "courier")
5310 global
5311 {not in Vi}
5312 {only available when compiled with the |+printer|
5313 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005314 The name of the font that will be used for |:hardcopy|.
5315 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316
5317 *'printheader'* *'pheader'*
5318'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5319 global
5320 {not in Vi}
5321 {only available when compiled with the |+printer|
5322 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005323 The format of the header produced in |:hardcopy| output.
5324 See |pheader-option|.
5325
5326 *'printmbcharset'* *'pmbcs'*
5327'printmbcharset' 'pmbcs' string (default "")
5328 global
5329 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005330 {only available when compiled with the |+printer|,
5331 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005332 The CJK character set to be used for CJK output from |:hardcopy|.
5333 See |pmbcs-option|.
5334
5335 *'printmbfont'* *'pmbfn'*
5336'printmbfont' 'pmbfn' string (default "")
5337 global
5338 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005339 {only available when compiled with the |+printer|,
5340 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005341 List of font names to be used for CJK output from |:hardcopy|.
5342 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343
5344 *'printoptions'* *'popt'*
5345'printoptions' 'popt' string (default "")
5346 global
5347 {not in Vi}
5348 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005349 List of items that control the format of the output of |:hardcopy|.
5350 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005352 *'prompt'* *'noprompt'*
5353'prompt' boolean (default on)
5354 global
5355 When on a ":" prompt is used in Ex mode.
5356
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005357 *'pumheight'* *'ph'*
5358'pumheight' 'ph' number (default 0)
5359 global
5360 {not available when compiled without the
5361 |+insert_expand| feature}
5362 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005363 Determines the maximum number of items to show in the popup menu for
5364 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005365 |ins-completion-menu|.
5366
5367
Bram Moolenaar677ee682005-01-27 14:41:15 +00005368 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005369'quoteescape' 'qe' string (default "\")
5370 local to buffer
5371 {not in Vi}
5372 The characters that are used to escape quotes in a string. Used for
5373 objects like a', a" and a` |a'|.
5374 When one of the characters in this option is found inside a string,
5375 the following character will be skipped. The default value makes the
5376 text "foo\"bar\\" considered to be one string.
5377
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5379'readonly' 'ro' boolean (default off)
5380 local to buffer
5381 If on, writes fail unless you use a '!'. Protects you from
5382 accidentally overwriting a file. Default on when Vim is started
5383 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005384 When using ":w!" the 'readonly' option is reset for the current
5385 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005387 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005389 *'redrawtime'* *'rdt'*
5390'redrawtime' 'rdt' number (default 2000)
5391 global
5392 {not in Vi}
5393 {only available when compiled with the |+reltime|
5394 feature}
5395 The time in milliseconds for redrawing the display. This applies to
5396 searching for patterns for 'hlsearch' and |:match| highlighting.
5397 When redrawing takes more than this many milliseconds no further
5398 matches will be highlighted. This is used to avoid that Vim hangs
5399 when using a very complicated pattern.
5400
Bram Moolenaar64486672010-05-16 15:46:46 +02005401 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5402'relativenumber' 'rnu' boolean (default off)
5403 local to window
5404 {not in Vi}
5405 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005406 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005407 precede some vertical motion commands (e.g. j k + -) with, without
5408 having to calculate it yourself. Especially useful in combination with
5409 other commands (e.g. y d c < > gq gw =).
5410 When the 'n' option is excluded from 'cpoptions' a wrapped
5411 line will not use the column of line numbers (this is the default when
5412 'compatible' isn't set).
5413 The 'numberwidth' option can be used to set the room used for the line
5414 number.
5415 When a long, wrapped line doesn't start with the first character, '-'
5416 characters are put before the number.
5417 See |hl-LineNr| for the highlighting used for the number.
5418 When setting this option, 'number' is reset.
5419
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420 *'remap'* *'noremap'*
5421'remap' boolean (default on)
5422 global
5423 Allows for mappings to work recursively. If you do not want this for
5424 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005425 NOTE: To avoid portability problems with Vim scripts, always keep
5426 this option at the default "on". Only switch it off when working with
5427 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005428
5429 *'report'*
5430'report' number (default 2)
5431 global
5432 Threshold for reporting number of lines changed. When the number of
5433 changed lines is more than 'report' a message will be given for most
5434 ":" commands. If you want it always, set 'report' to 0.
5435 For the ":substitute" command the number of substitutions is used
5436 instead of the number of lines.
5437
5438 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5439'restorescreen' 'rs' boolean (default on)
5440 global
5441 {not in Vi} {only in Windows 95/NT console version}
5442 When set, the screen contents is restored when exiting Vim. This also
5443 happens when executing external commands.
5444
5445 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5446 options in your .vimrc. To disable restoring:
5447 set t_ti= t_te=
5448 To enable restoring (for an xterm):
5449 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5450 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5451
5452 *'revins'* *'ri'* *'norevins'* *'nori'*
5453'revins' 'ri' boolean (default off)
5454 global
5455 {not in Vi}
5456 {only available when compiled with the |+rightleft|
5457 feature}
5458 Inserting characters in Insert mode will work backwards. See "typing
5459 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5460 command in Insert mode, when 'allowrevins' is set.
5461 NOTE: This option is reset when 'compatible' or 'paste' is set.
5462
5463 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5464'rightleft' 'rl' boolean (default off)
5465 local to window
5466 {not in Vi}
5467 {only available when compiled with the |+rightleft|
5468 feature}
5469 When on, display orientation becomes right-to-left, i.e., characters
5470 that are stored in the file appear from the right to the left.
5471 Using this option, it is possible to edit files for languages that
5472 are written from the right to the left such as Hebrew and Arabic.
5473 This option is per window, so it is possible to edit mixed files
5474 simultaneously, or to view the same file in both ways (this is
5475 useful whenever you have a mixed text file with both right-to-left
5476 and left-to-right strings so that both sets are displayed properly
5477 in different windows). Also see |rileft.txt|.
5478
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005479 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480'rightleftcmd' 'rlc' string (default "search")
5481 local to window
5482 {not in Vi}
5483 {only available when compiled with the |+rightleft|
5484 feature}
5485 Each word in this option enables the command line editing to work in
5486 right-to-left mode for a group of commands:
5487
5488 search "/" and "?" commands
5489
5490 This is useful for languages such as Hebrew, Arabic and Farsi.
5491 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5492
5493 *'ruler'* *'ru'* *'noruler'* *'noru'*
5494'ruler' 'ru' boolean (default off)
5495 global
5496 {not in Vi}
5497 {not available when compiled without the
5498 |+cmdline_info| feature}
5499 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005500 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005501 text in the file is shown on the far right:
5502 Top first line is visible
5503 Bot last line is visible
5504 All first and last line are visible
5505 45% relative position in the file
5506 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005507 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005509 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 this option takes precedence over 'ruler' and 'rulerformat'
5511 If the number of characters displayed is different from the number of
5512 bytes in the text (e.g., for a TAB or a multi-byte character), both
5513 the text column (byte number) and the screen column are shown,
5514 separated with a dash.
5515 For an empty line "0-1" is shown.
5516 For an empty buffer the line number will also be zero: "0,0-1".
5517 This option is reset when the 'paste' option is set.
5518 If you don't want to see the ruler all the time but want to know where
5519 you are, use "g CTRL-G" |g_CTRL-G|.
5520 NOTE: This option is reset when 'compatible' is set.
5521
5522 *'rulerformat'* *'ruf'*
5523'rulerformat' 'ruf' string (default empty)
5524 global
5525 {not in Vi}
5526 {not available when compiled without the |+statusline|
5527 feature}
5528 When this option is not empty, it determines the content of the ruler
5529 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005530 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531 The default ruler width is 17 characters. To make the ruler 15
5532 characters wide, put "%15(" at the start and "%)" at the end.
5533 Example: >
5534 :set rulerformat=%15(%c%V\ %p%%%)
5535<
5536 *'runtimepath'* *'rtp'* *vimfiles*
5537'runtimepath' 'rtp' string (default:
5538 Unix: "$HOME/.vim,
5539 $VIM/vimfiles,
5540 $VIMRUNTIME,
5541 $VIM/vimfiles/after,
5542 $HOME/.vim/after"
5543 Amiga: "home:vimfiles,
5544 $VIM/vimfiles,
5545 $VIMRUNTIME,
5546 $VIM/vimfiles/after,
5547 home:vimfiles/after"
5548 PC, OS/2: "$HOME/vimfiles,
5549 $VIM/vimfiles,
5550 $VIMRUNTIME,
5551 $VIM/vimfiles/after,
5552 $HOME/vimfiles/after"
5553 Macintosh: "$VIM:vimfiles,
5554 $VIMRUNTIME,
5555 $VIM:vimfiles:after"
5556 RISC-OS: "Choices:vimfiles,
5557 $VIMRUNTIME,
5558 Choices:vimfiles/after"
5559 VMS: "sys$login:vimfiles,
5560 $VIM/vimfiles,
5561 $VIMRUNTIME,
5562 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005563 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005564 global
5565 {not in Vi}
5566 This is a list of directories which will be searched for runtime
5567 files:
5568 filetype.vim filetypes by file name |new-filetype|
5569 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005570 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 colors/ color scheme files |:colorscheme|
5572 compiler/ compiler files |:compiler|
5573 doc/ documentation |write-local-help|
5574 ftplugin/ filetype plugins |write-filetype-plugin|
5575 indent/ indent scripts |indent-expression|
5576 keymap/ key mapping files |mbyte-keymap|
5577 lang/ menu translations |:menutrans|
5578 menu.vim GUI menus |menu.vim|
5579 plugin/ plugin scripts |write-plugin|
5580 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005581 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582 syntax/ syntax files |mysyntaxfile|
5583 tutor/ files for vimtutor |tutor|
5584
5585 And any other file searched for with the |:runtime| command.
5586
5587 The defaults for most systems are setup to search five locations:
5588 1. In your home directory, for your personal preferences.
5589 2. In a system-wide Vim directory, for preferences from the system
5590 administrator.
5591 3. In $VIMRUNTIME, for files distributed with Vim.
5592 *after-directory*
5593 4. In the "after" directory in the system-wide Vim directory. This is
5594 for the system administrator to overrule or add to the distributed
5595 defaults (rarely needed)
5596 5. In the "after" directory in your home directory. This is for
5597 personal preferences to overrule or add to the distributed defaults
5598 or system-wide settings (rarely needed).
5599
5600 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5601 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005602 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603 wildcards.
5604 See |:runtime|.
5605 Example: >
5606 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5607< This will use the directory "~/vimruntime" first (containing your
5608 personal Vim runtime files), then "/mygroup/vim" (shared between a
5609 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5610 files).
5611 You probably should always include $VIMRUNTIME somewhere, to use the
5612 distributed runtime files. You can put a directory before $VIMRUNTIME
5613 to find files which replace a distributed runtime files. You can put
5614 a directory after $VIMRUNTIME to find files which add to distributed
5615 runtime files.
5616 This option cannot be set from a |modeline| or in the |sandbox|, for
5617 security reasons.
5618
5619 *'scroll'* *'scr'*
5620'scroll' 'scr' number (default: half the window height)
5621 local to window
5622 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5623 set to half the number of lines in the window when the window size
5624 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005625 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5627 the number of screen lines instead of file lines, makes a difference
5628 when lines wrap}
5629
5630 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5631'scrollbind' 'scb' boolean (default off)
5632 local to window
5633 {not in Vi}
5634 {not available when compiled without the |+scrollbind|
5635 feature}
5636 See also |scroll-binding|. When this option is set, the current
5637 window scrolls as other scrollbind windows (windows that also have
5638 this option set) scroll. This option is useful for viewing the
5639 differences between two versions of a file, see 'diff'.
5640 See |'scrollopt'| for options that determine how this option should be
5641 interpreted.
5642 This option is mostly reset when splitting a window to edit another
5643 file. This means that ":split | edit file" results in two windows
5644 with scroll-binding, but ":split file" does not.
5645
5646 *'scrolljump'* *'sj'*
5647'scrolljump' 'sj' number (default 1)
5648 global
5649 {not in Vi}
5650 Minimal number of lines to scroll when the cursor gets off the
5651 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5652 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005653 When set to a negative number from -1 to -100 this is used as the
5654 percentage of the window height. Thus -50 scrolls half the window
5655 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005656 NOTE: This option is set to 1 when 'compatible' is set.
5657
5658 *'scrolloff'* *'so'*
5659'scrolloff' 'so' number (default 0)
5660 global
5661 {not in Vi}
5662 Minimal number of screen lines to keep above and below the cursor.
5663 This will make some context visible around where you are working. If
5664 you set it to a very large value (999) the cursor line will always be
5665 in the middle of the window (except at the start or end of the file or
5666 when long lines wrap).
5667 For scrolling horizontally see 'sidescrolloff'.
5668 NOTE: This option is set to 0 when 'compatible' is set.
5669
5670 *'scrollopt'* *'sbo'*
5671'scrollopt' 'sbo' string (default "ver,jump")
5672 global
5673 {not available when compiled without the |+scrollbind|
5674 feature}
5675 {not in Vi}
5676 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005677 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5678 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 The following words are available:
5680 ver Bind vertical scrolling for 'scrollbind' windows
5681 hor Bind horizontal scrolling for 'scrollbind' windows
5682 jump Applies to the offset between two windows for vertical
5683 scrolling. This offset is the difference in the first
5684 displayed line of the bound windows. When moving
5685 around in a window, another 'scrollbind' window may
5686 reach a position before the start or after the end of
5687 the buffer. The offset is not changed though, when
5688 moving back the 'scrollbind' window will try to scroll
5689 to the desired position when possible.
5690 When now making that window the current one, two
5691 things can be done with the relative offset:
5692 1. When "jump" is not included, the relative offset is
5693 adjusted for the scroll position in the new current
5694 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005695 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696 2. When "jump" is included, the other windows are
5697 scrolled to keep the same relative offset. When
5698 going back to the other window, it still uses the
5699 same relative offset.
5700 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005701 When 'diff' mode is active there always is vertical scroll binding,
5702 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703
5704 *'sections'* *'sect'*
5705'sections' 'sect' string (default "SHNHH HUnhsh")
5706 global
5707 Specifies the nroff macros that separate sections. These are pairs of
5708 two letters (See |object-motions|). The default makes a section start
5709 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5710
5711 *'secure'* *'nosecure'* *E523*
5712'secure' boolean (default off)
5713 global
5714 {not in Vi}
5715 When on, ":autocmd", shell and write commands are not allowed in
5716 ".vimrc" and ".exrc" in the current directory and map commands are
5717 displayed. Switch it off only if you know that you will not run into
5718 problems, or when the 'exrc' option is off. On Unix this option is
5719 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005720 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 'secure' at the end of your ~/.vimrc then.
5722 This option cannot be set from a |modeline| or in the |sandbox|, for
5723 security reasons.
5724
5725 *'selection'* *'sel'*
5726'selection' 'sel' string (default "inclusive")
5727 global
5728 {not in Vi}
5729 This option defines the behavior of the selection. It is only used
5730 in Visual and Select mode.
5731 Possible values:
5732 value past line inclusive ~
5733 old no yes
5734 inclusive yes yes
5735 exclusive yes no
5736 "past line" means that the cursor is allowed to be positioned one
5737 character past the line.
5738 "inclusive" means that the last character of the selection is included
5739 in an operation. For example, when "x" is used to delete the
5740 selection.
5741 Note that when "exclusive" is used and selecting from the end
5742 backwards, you cannot include the last character of a line, when
5743 starting in Normal mode and 'virtualedit' empty.
5744
5745 The 'selection' option is set by the |:behave| command.
5746
5747 *'selectmode'* *'slm'*
5748'selectmode' 'slm' string (default "")
5749 global
5750 {not in Vi}
5751 This is a comma separated list of words, which specifies when to start
5752 Select mode instead of Visual mode, when a selection is started.
5753 Possible values:
5754 mouse when using the mouse
5755 key when using shifted special keys
5756 cmd when using "v", "V" or CTRL-V
5757 See |Select-mode|.
5758 The 'selectmode' option is set by the |:behave| command.
5759
5760 *'sessionoptions'* *'ssop'*
5761'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005762 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 global
5764 {not in Vi}
5765 {not available when compiled without the +mksession
5766 feature}
5767 Changes the effect of the |:mksession| command. It is a comma
5768 separated list of words. Each word enables saving and restoring
5769 something:
5770 word save and restore ~
5771 blank empty windows
5772 buffers hidden and unloaded buffers, not just those in windows
5773 curdir the current directory
5774 folds manually created folds, opened/closed folds and local
5775 fold options
5776 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005777 and contain at least one lowercase letter. Only
5778 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005779 help the help window
5780 localoptions options and mappings local to a window or buffer (not
5781 global values for local options)
5782 options all options and mappings (also global values for local
5783 options)
5784 resize size of the Vim window: 'lines' and 'columns'
5785 sesdir the directory in which the session file is located
5786 will become the current directory (useful with
5787 projects accessed over a network from different
5788 systems)
5789 slash backslashes in file names replaced with forward
5790 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005791 tabpages all tab pages; without this only the current tab page
5792 is restored, so that you can make a session for each
5793 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794 unix with Unix end-of-line format (single <NL>), even when
5795 on Windows or DOS
5796 winpos position of the whole Vim window
5797 winsize window sizes
5798
5799 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005800 When neither "curdir" nor "sesdir" is included, file names are stored
5801 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005802 "slash" and "unix" are useful on Windows when sharing session files
5803 with Unix. The Unix version of Vim cannot source dos format scripts,
5804 but the Windows version of Vim can source unix format scripts.
5805
5806 *'shell'* *'sh'* *E91*
5807'shell' 'sh' string (default $SHELL or "sh",
5808 MS-DOS and Win32: "command.com" or
5809 "cmd.exe", OS/2: "cmd")
5810 global
5811 Name of the shell to use for ! and :! commands. When changing the
5812 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5813 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005814 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815 See |option-backslash| about including spaces and backslashes.
5816 Environment variables are expanded |:set_env|.
5817 If the name of the shell contains a space, you might need to enclose
5818 it in quotes. Example: >
5819 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5820< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005821 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822 "-f" is not inside the quotes, because it is not part of the command
5823 name. And Vim automagically recognizes the backslashes that are path
5824 separators.
5825 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5826 variable to change the way external commands are executed. See the
5827 libc.inf file of DJGPP.
5828 Under MS-Windows, when the executable ends in ".com" it must be
5829 included. Thus setting the shell to "command.com" or "4dos.com"
5830 works, but "command" and "4dos" do not work for all commands (e.g.,
5831 filtering).
5832 For unknown reasons, when using "4dos.com" the current directory is
5833 changed to "C:\". To avoid this set 'shell' like this: >
5834 :set shell=command.com\ /c\ 4dos
5835< This option cannot be set from a |modeline| or in the |sandbox|, for
5836 security reasons.
5837
5838 *'shellcmdflag'* *'shcf'*
5839'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5840 does not contain "sh" somewhere: "/c")
5841 global
5842 {not in Vi}
5843 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5844 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5845 systems, the default is set according to the value of 'shell', to
5846 reduce the need to set this option by the user. It's not used for
5847 OS/2 (EMX figures this out itself). See |option-backslash| about
5848 including spaces and backslashes. See |dos-shell|.
5849 This option cannot be set from a |modeline| or in the |sandbox|, for
5850 security reasons.
5851
5852 *'shellpipe'* *'sp'*
5853'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5854 global
5855 {not in Vi}
5856 {not available when compiled without the |+quickfix|
5857 feature}
5858 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005859 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005860 including spaces and backslashes.
5861 The name of the temporary file can be represented by "%s" if necessary
5862 (the file name is appended automatically if no %s appears in the value
5863 of this option).
5864 For the Amiga and MS-DOS the default is ">". The output is directly
5865 saved in a file and not echoed to the screen.
5866 For Unix the default it "| tee". The stdout of the compiler is saved
5867 in a file and echoed to the screen. If the 'shell' option is "csh" or
5868 "tcsh" after initializations, the default becomes "|& tee". If the
5869 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005870 "2>&1| tee". This means that stderr is also included. Before using
5871 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005872 The initialization of this option is done after reading the ".vimrc"
5873 and the other initializations, so that when the 'shell' option is set
5874 there, the 'shellpipe' option changes automatically, unless it was
5875 explicitly set before.
5876 When 'shellpipe' is set to an empty string, no redirection of the
5877 ":make" output will be done. This is useful if you use a 'makeprg'
5878 that writes to 'makeef' by itself. If you want no piping, but do
5879 want to include the 'makeef', set 'shellpipe' to a single space.
5880 Don't forget to precede the space with a backslash: ":set sp=\ ".
5881 In the future pipes may be used for filtering and this option will
5882 become obsolete (at least for Unix).
5883 This option cannot be set from a |modeline| or in the |sandbox|, for
5884 security reasons.
5885
5886 *'shellquote'* *'shq'*
5887'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5888 contains "sh" somewhere: "\"")
5889 global
5890 {not in Vi}
5891 Quoting character(s), put around the command passed to the shell, for
5892 the "!" and ":!" commands. The redirection is kept outside of the
5893 quoting. See 'shellxquote' to include the redirection. It's
5894 probably not useful to set both options.
5895 This is an empty string by default. Only known to be useful for
5896 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5897 or bash, where it should be "\"". The default is adjusted according
5898 the value of 'shell', to reduce the need to set this option by the
5899 user. See |dos-shell|.
5900 This option cannot be set from a |modeline| or in the |sandbox|, for
5901 security reasons.
5902
5903 *'shellredir'* *'srr'*
5904'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5905 global
5906 {not in Vi}
5907 String to be used to put the output of a filter command in a temporary
5908 file. See also |:!|. See |option-backslash| about including spaces
5909 and backslashes.
5910 The name of the temporary file can be represented by "%s" if necessary
5911 (the file name is appended automatically if no %s appears in the value
5912 of this option).
5913 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5914 or "zsh" during initializations, the default becomes ">&". If the
5915 'shell' option is "sh", "ksh" or "bash" the default becomes
5916 ">%s 2>&1". This means that stderr is also included.
5917 For Win32, the Unix checks are done and additionally "cmd" is checked
5918 for, which makes the default ">%s 2>&1". Also, the same names with
5919 ".exe" appended are checked for.
5920 The initialization of this option is done after reading the ".vimrc"
5921 and the other initializations, so that when the 'shell' option is set
5922 there, the 'shellredir' option changes automatically unless it was
5923 explicitly set before.
5924 In the future pipes may be used for filtering and this option will
5925 become obsolete (at least for Unix).
5926 This option cannot be set from a |modeline| or in the |sandbox|, for
5927 security reasons.
5928
5929 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5930'shellslash' 'ssl' boolean (default off)
5931 global
5932 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5933 When set, a forward slash is used when expanding file names. This is
5934 useful when a Unix-like shell is used instead of command.com or
5935 cmd.exe. Backward slashes can still be typed, but they are changed to
5936 forward slashes by Vim.
5937 Note that setting or resetting this option has no effect for some
5938 existing file names, thus this option needs to be set before opening
5939 any file for best results. This might change in the future.
5940 'shellslash' only works when a backslash can be used as a path
5941 separator. To test if this is so use: >
5942 if exists('+shellslash')
5943<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005944 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5945'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5946 global
5947 {not in Vi}
5948 When on, use temp files for shell commands. When off use a pipe.
5949 When using a pipe is not possible temp files are used anyway.
5950 Currently a pipe is only supported on Unix. You can check it with: >
5951 :if has("filterpipe")
5952< The advantage of using a pipe is that nobody can read the temp file
5953 and the 'shell' command does not need to support redirection.
5954 The advantage of using a temp file is that the file type and encoding
5955 can be detected.
5956 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5957 |FilterWritePost| autocommands event are not triggered when
5958 'shelltemp' is off.
5959
Bram Moolenaar071d4272004-06-13 20:20:40 +00005960 *'shelltype'* *'st'*
5961'shelltype' 'st' number (default 0)
5962 global
5963 {not in Vi} {only for the Amiga}
5964 On the Amiga this option influences the way how the commands work
5965 which use a shell.
5966 0 and 1: always use the shell
5967 2 and 3: use the shell only to filter lines
5968 4 and 5: use shell only for ':sh' command
5969 When not using the shell, the command is executed directly.
5970
5971 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5972 1 and 3: use "shell cmd" to start external commands
5973
5974 *'shellxquote'* *'sxq'*
5975'shellxquote' 'sxq' string (default: "";
5976 for Win32, when 'shell' contains "sh"
5977 somewhere: "\""
5978 for Unix, when using system(): "\"")
5979 global
5980 {not in Vi}
5981 Quoting character(s), put around the command passed to the shell, for
5982 the "!" and ":!" commands. Includes the redirection. See
5983 'shellquote' to exclude the redirection. It's probably not useful
5984 to set both options.
5985 This is an empty string by default. Known to be useful for
5986 third-party shells when using the Win32 version, such as the MKS Korn
5987 Shell or bash, where it should be "\"". The default is adjusted
5988 according the value of 'shell', to reduce the need to set this option
5989 by the user. See |dos-shell|.
5990 This option cannot be set from a |modeline| or in the |sandbox|, for
5991 security reasons.
5992
5993 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5994'shiftround' 'sr' boolean (default off)
5995 global
5996 {not in Vi}
5997 Round indent to multiple of 'shiftwidth'. Applies to > and <
5998 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5999 a multiple of 'shiftwidth' (this is Vi compatible).
6000 NOTE: This option is reset when 'compatible' is set.
6001
6002 *'shiftwidth'* *'sw'*
6003'shiftwidth' 'sw' number (default 8)
6004 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006005 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006006 |'cindent'|, |>>|, |<<|, etc.
6007
6008 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006009'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6010 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011 global
6012 {not in Vi}
6013 This option helps to avoid all the |hit-enter| prompts caused by file
6014 messages, for example with CTRL-G, and to avoid some other messages.
6015 It is a list of flags:
6016 flag meaning when present ~
6017 f use "(3 of 5)" instead of "(file 3 of 5)"
6018 i use "[noeol]" instead of "[Incomplete last line]"
6019 l use "999L, 888C" instead of "999 lines, 888 characters"
6020 m use "[+]" instead of "[Modified]"
6021 n use "[New]" instead of "[New File]"
6022 r use "[RO]" instead of "[readonly]"
6023 w use "[w]" instead of "written" for file write message
6024 and "[a]" instead of "appended" for ':w >> file' command
6025 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6026 "[unix format]" and "[mac]" instead of "[mac format]".
6027 a all of the above abbreviations
6028
6029 o overwrite message for writing a file with subsequent message
6030 for reading a file (useful for ":wn" or when 'autowrite' on)
6031 O message for reading a file overwrites any previous message.
6032 Also for quickfix message (e.g., ":cn").
6033 s don't give "search hit BOTTOM, continuing at TOP" or "search
6034 hit TOP, continuing at BOTTOM" messages
6035 t truncate file message at the start if it is too long to fit
6036 on the command-line, "<" will appear in the left most column.
6037 Ignored in Ex mode.
6038 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006039 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006040 Ignored in Ex mode.
6041 W don't give "written" or "[w]" when writing a file
6042 A don't give the "ATTENTION" message when an existing swap file
6043 is found.
6044 I don't give the intro message when starting Vim |:intro|.
6045
6046 This gives you the opportunity to avoid that a change between buffers
6047 requires you to hit <Enter>, but still gives as useful a message as
6048 possible for the space available. To get the whole message that you
6049 would have got with 'shm' empty, use ":file!"
6050 Useful values:
6051 shm= No abbreviation of message.
6052 shm=a Abbreviation, but no loss of information.
6053 shm=at Abbreviation, and truncate message when necessary.
6054
6055 NOTE: This option is set to the Vi default value when 'compatible' is
6056 set and to the Vim default value when 'compatible' is reset.
6057
6058 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6059'shortname' 'sn' boolean (default off)
6060 local to buffer
6061 {not in Vi, not in MS-DOS versions}
6062 Filenames are assumed to be 8 characters plus one extension of 3
6063 characters. Multiple dots in file names are not allowed. When this
6064 option is on, dots in file names are replaced with underscores when
6065 adding an extension (".~" or ".swp"). This option is not available
6066 for MS-DOS, because then it would always be on. This option is useful
6067 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6068 or crossdos. When running the Win32 GUI version under Win32s, this
6069 option is always on by default.
6070
6071 *'showbreak'* *'sbr'* *E595*
6072'showbreak' 'sbr' string (default "")
6073 global
6074 {not in Vi}
6075 {not available when compiled without the |+linebreak|
6076 feature}
6077 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006078 values are "> " or "+++ ": >
6079 :set showbreak=>\
6080< Note the backslash to escape the trailing space. It's easier like
6081 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006082 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006083< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 comma (in a future version the comma might be used to separate the
6085 part that is shown at the end and at the start of a line).
6086 The characters are highlighted according to the '@' flag in
6087 'highlight'.
6088 Note that tabs after the showbreak will be displayed differently.
6089 If you want the 'showbreak' to appear in between line numbers, add the
6090 "n" flag to 'cpoptions'.
6091
6092 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6093'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6094 off)
6095 global
6096 {not in Vi}
6097 {not available when compiled without the
6098 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006099 Show (partial) command in the last line of the screen. Set this
6100 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 In Visual mode the size of the selected area is shown:
6102 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006103 If the number of bytes is different it is also displayed: "2-6"
6104 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006106 - When selecting a block, the size in screen characters:
6107 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108 NOTE: This option is set to the Vi default value when 'compatible' is
6109 set and to the Vim default value when 'compatible' is reset.
6110
6111 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6112'showfulltag' 'sft' boolean (default off)
6113 global
6114 {not in Vi}
6115 When completing a word in insert mode (see |ins-completion|) from the
6116 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006117 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118 matched a C function, you can see a template for what arguments are
6119 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006120 Note that this doesn't work well together with having "longest" in
6121 'completeopt', because the completion from the search pattern may not
6122 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006123
6124 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6125'showmatch' 'sm' boolean (default off)
6126 global
6127 When a bracket is inserted, briefly jump to the matching one. The
6128 jump is only done if the match can be seen on the screen. The time to
6129 show the match can be set with 'matchtime'.
6130 A Beep is given if there is no match (no matter if the match can be
6131 seen or not). This option is reset when the 'paste' option is set.
6132 When the 'm' flag is not included in 'cpoptions', typing a character
6133 will immediately move the cursor back to where it belongs.
6134 See the "sm" field in 'guicursor' for setting the cursor shape and
6135 blinking when showing the match.
6136 The 'matchpairs' option can be used to specify the characters to show
6137 matches for. 'rightleft' and 'revins' are used to look for opposite
6138 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006139 Also see the matchparen plugin for highlighting the match when moving
6140 around |pi_paren.txt|.
6141 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142
6143 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6144'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6145 global
6146 If in Insert, Replace or Visual mode put a message on the last line.
6147 Use the 'M' flag in 'highlight' to set the type of highlighting for
6148 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006149 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150 doesn't mean XIM is really active, especially when 'imactivatekey' is
6151 not set.
6152 NOTE: This option is set to the Vi default value when 'compatible' is
6153 set and to the Vim default value when 'compatible' is reset.
6154
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006155 *'showtabline'* *'stal'*
6156'showtabline' 'stal' number (default 1)
6157 global
6158 {not in Vi}
6159 {not available when compiled without the +windows
6160 feature}
6161 The value of this option specifies when the line with tab page labels
6162 will be displayed:
6163 0: never
6164 1: only if there are at least two tab pages
6165 2: always
6166 This is both for the GUI and non-GUI implementation of the tab pages
6167 line.
6168 See |tab-page| for more information about tab pages.
6169
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170 *'sidescroll'* *'ss'*
6171'sidescroll' 'ss' number (default 0)
6172 global
6173 {not in Vi}
6174 The minimal number of columns to scroll horizontally. Used only when
6175 the 'wrap' option is off and the cursor is moved off of the screen.
6176 When it is zero the cursor will be put in the middle of the screen.
6177 When using a slow terminal set it to a large number or 0. When using
6178 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6179 commands.
6180
6181 *'sidescrolloff'* *'siso'*
6182'sidescrolloff' 'siso' number (default 0)
6183 global
6184 {not in Vi}
6185 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006186 right of the cursor if 'nowrap' is set. Setting this option to a
6187 value greater than 0 while having |'sidescroll'| also at a non-zero
6188 value makes some context visible in the line you are scrolling in
6189 horizontally (except at beginning of the line). Setting this option
6190 to a large value (like 999) has the effect of keeping the cursor
6191 horizontally centered in the window, as long as one does not come too
6192 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006193 NOTE: This option is set to 0 when 'compatible' is set.
6194
6195 Example: Try this together with 'sidescroll' and 'listchars' as
6196 in the following example to never allow the cursor to move
6197 onto the "extends" character:
6198
6199 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6200 :set sidescrolloff=1
6201
6202
6203 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6204'smartcase' 'scs' boolean (default off)
6205 global
6206 {not in Vi}
6207 Override the 'ignorecase' option if the search pattern contains upper
6208 case characters. Only used when the search pattern is typed and
6209 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006210 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6212 recalling the search pattern from history and hitting <Enter>.
6213 NOTE: This option is reset when 'compatible' is set.
6214
6215 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6216'smartindent' 'si' boolean (default off)
6217 local to buffer
6218 {not in Vi}
6219 {not available when compiled without the
6220 |+smartindent| feature}
6221 Do smart autoindenting when starting a new line. Works for C-like
6222 programs, but can also be used for other languages. 'cindent' does
6223 something like this, works better in most cases, but is more strict,
6224 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6225 'indentexpr' is a more advanced alternative.
6226 Normally 'autoindent' should also be on when using 'smartindent'.
6227 An indent is automatically inserted:
6228 - After a line ending in '{'.
6229 - After a line starting with a keyword from 'cinwords'.
6230 - Before a line starting with '}' (only with the "O" command).
6231 When typing '}' as the first character in a new line, that line is
6232 given the same indent as the matching '{'.
6233 When typing '#' as the first character in a new line, the indent for
6234 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006235 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006236 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6237 When using the ">>" command, lines starting with '#' are not shifted
6238 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006239 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006240 is set smart indenting is disabled.
6241
6242 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6243'smarttab' 'sta' boolean (default off)
6244 global
6245 {not in Vi}
6246 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006247 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6248 <BS> will delete a 'shiftwidth' worth of space at the start of the
6249 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006250 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006251 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6252 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006253 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006254 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006255 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 NOTE: This option is reset when 'compatible' is set.
6257
6258 *'softtabstop'* *'sts'*
6259'softtabstop' 'sts' number (default 0)
6260 local to buffer
6261 {not in Vi}
6262 Number of spaces that a <Tab> counts for while performing editing
6263 operations, like inserting a <Tab> or using <BS>. It "feels" like
6264 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6265 used. This is useful to keep the 'ts' setting at its standard value
6266 of 8, while being able to edit like it is set to 'sts'. However,
6267 commands like "x" still work on the actual characters.
6268 When 'sts' is zero, this feature is off.
6269 'softtabstop' is set to 0 when the 'paste' option is set.
6270 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6271 spaces is minimized by using <Tab>s.
6272 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6273 set.
6274 NOTE: This option is set to 0 when 'compatible' is set.
6275
Bram Moolenaar217ad922005-03-20 22:37:15 +00006276 *'spell'* *'nospell'*
6277'spell' boolean (default off)
6278 local to window
6279 {not in Vi}
6280 {not available when compiled without the |+syntax|
6281 feature}
6282 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006283 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006284
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006285 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006286'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006287 local to buffer
6288 {not in Vi}
6289 {not available when compiled without the |+syntax|
6290 feature}
6291 Pattern to locate the end of a sentence. The following word will be
6292 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006293 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006294 When this check is not wanted make this option empty.
6295 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006296 Be careful with special characters, see |option-backslash| about
6297 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006298 To set this option automatically depending on the language, see
6299 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006300
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006301 *'spellfile'* *'spf'*
6302'spellfile' 'spf' string (default empty)
6303 local to buffer
6304 {not in Vi}
6305 {not available when compiled without the |+syntax|
6306 feature}
6307 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006308 commands. It must end in ".{encoding}.add". You need to include the
6309 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006310 *E765*
6311 It may also be a comma separated list of names. A count before the
6312 |zg| and |zw| commands can be used to access each. This allows using
6313 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006314 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006315 you: Using the first directory in 'runtimepath' that is writable. If
6316 there is no "spell" directory yet it will be created. For the file
6317 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006318 ignoring the region.
6319 The resulting ".spl" file will be used for spell checking, it does not
6320 have to appear in 'spelllang'.
6321 Normally one file is used for all regions, but you can add the region
6322 name if you want to. However, it will then only be used when
6323 'spellfile' is set to it, for entries in 'spelllang' only files
6324 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006325 This option cannot be set from a |modeline| or in the |sandbox|, for
6326 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006327
Bram Moolenaar217ad922005-03-20 22:37:15 +00006328 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006329'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006330 local to buffer
6331 {not in Vi}
6332 {not available when compiled without the |+syntax|
6333 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006334 A comma separated list of word list names. When the 'spell' option is
6335 on spellchecking will be done for these languages. Example: >
6336 set spelllang=en_us,nl,medical
6337< This means US English, Dutch and medical words are recognized. Words
6338 that are not recognized will be highlighted.
6339 The word list name must not include a comma or dot. Using a dash is
6340 recommended to separate the two letter language name from a
6341 specification. Thus "en-rare" is used for rare English words.
6342 A region name must come last and have the form "_xx", where "xx" is
6343 the two-letter, lower case region name. You can use more than one
6344 region by listing them: "en_us,en_ca" supports both US and Canadian
6345 English, but not words specific for Australia, New Zealand or Great
6346 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006347 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006348 As a special case the name of a .spl file can be given as-is. The
6349 first "_xx" in the name is removed and used as the region name
6350 (_xx is an underscore, two letters and followed by a non-letter).
6351 This is mainly for testing purposes. You must make sure the correct
6352 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006353 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006354 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6355 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006356 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006357
Bram Moolenaar98692072006-02-04 00:57:42 +00006358 If the |spellfile.vim| plugin is active and you use a language name
6359 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6360 will ask you if you want to download the file.
6361
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006362 After this option has been set successfully, Vim will source the files
6363 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006364 up to the first comma, dot or underscore.
6365 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006366
6367
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006368 *'spellsuggest'* *'sps'*
6369'spellsuggest' 'sps' string (default "best")
6370 global
6371 {not in Vi}
6372 {not available when compiled without the |+syntax|
6373 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006374 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006375 the |spellsuggest()| function. This is a comma-separated list of
6376 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006377
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006378 best Internal method that works best for English. Finds
6379 changes like "fast" and uses a bit of sound-a-like
6380 scoring to improve the ordering.
6381
6382 double Internal method that uses two methods and mixes the
6383 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006384 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006385 word. That only works when the language specifies
6386 sound folding. Can be slow and doesn't always give
6387 better results.
6388
6389 fast Internal method that only checks for simple changes:
6390 character inserts/deletes/swaps. Works well for
6391 simple typing mistakes.
6392
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006393 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006394 Not used for |spellsuggest()|. The number of
6395 suggestions is never more than the value of 'lines'
6396 minus two.
6397
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006398 file:{filename} Read file {filename}, which must have two columns,
6399 separated by a slash. The first column contains the
6400 bad word, the second column the suggested good word.
6401 Example:
6402 theribal/terrible ~
6403 Use this for common mistakes that do not appear at the
6404 top of the suggestion list with the internal methods.
6405 Lines without a slash are ignored, use this for
6406 comments.
6407 The file is used for all languages.
6408
6409 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6410 trouble with spaces. |v:val| holds the badly spelled
6411 word. The expression must evaluate to a List of
6412 Lists, each with a suggestion and a score.
6413 Example:
6414 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006415 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006416 internal methods use. A lower score is better.
6417 This may invoke |spellsuggest()| if you temporarily
6418 set 'spellsuggest' to exclude the "expr:" part.
6419 Errors are silently ignored, unless you set the
6420 'verbose' option to a non-zero value.
6421
6422 Only one of "best", "double" or "fast" may be used. The others may
6423 appear several times in any order. Example: >
6424 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6425<
6426 This option cannot be set from a |modeline| or in the |sandbox|, for
6427 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006428
6429
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6431'splitbelow' 'sb' boolean (default off)
6432 global
6433 {not in Vi}
6434 {not available when compiled without the +windows
6435 feature}
6436 When on, splitting a window will put the new window below the current
6437 one. |:split|
6438
6439 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6440'splitright' 'spr' boolean (default off)
6441 global
6442 {not in Vi}
6443 {not available when compiled without the +vertsplit
6444 feature}
6445 When on, splitting a window will put the new window right of the
6446 current one. |:vsplit|
6447
6448 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6449'startofline' 'sol' boolean (default on)
6450 global
6451 {not in Vi}
6452 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006453 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006454 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006455 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456 with a linewise operator, with "%" with a count and to buffer changing
6457 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6458 only has a line number, e.g., ":25" or ":+".
6459 In case of buffer changing commands the cursor is placed at the column
6460 where it was the last time the buffer was edited.
6461 NOTE: This option is set when 'compatible' is set.
6462
6463 *'statusline'* *'stl'* *E540* *E541* *E542*
6464'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006465 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466 {not in Vi}
6467 {not available when compiled without the |+statusline|
6468 feature}
6469 When nonempty, this option determines the content of the status line.
6470 Also see |status-line|.
6471
6472 The option consists of printf style '%' items interspersed with
6473 normal text. Each status line item is of the form:
6474 %-0{minwid}.{maxwid}{item}
6475 All fields except the {item} is optional. A single percent sign can
6476 be given as "%%". Up to 80 items can be specified.
6477
Bram Moolenaar238a5642006-02-21 22:12:05 +00006478 When the option starts with "%!" then it is used as an expression,
6479 evaluated and the result is used as the option value. Example: >
6480 :set statusline=%!MyStatusLine()
6481< The result can contain %{} items that will be evaluated too.
6482
6483 When there is error while evaluating the option then it will be made
6484 empty to avoid further errors. Otherwise screen updating would loop.
6485
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486 Note that the only effect of 'ruler' when this option is set (and
6487 'laststatus' is 2) is controlling the output of |CTRL-G|.
6488
6489 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006490 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006492 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493 minwid Minimum width of the item, padding as set by '-' & '0'.
6494 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006495 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496 on the left for text items. Numeric items will be
6497 shifted down to maxwid-2 digits followed by '>'number
6498 where number is the amount of missing digits, much like
6499 an exponential notation.
6500 item A one letter code as described below.
6501
6502 Following is a description of the possible statusline items. The
6503 second character in "item" is the type:
6504 N for number
6505 S for string
6506 F for flags as described below
6507 - not applicable
6508
6509 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006510 f S Path to the file in the buffer, as typed or relative to current
6511 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512 F S Full path to the file in the buffer.
6513 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006514 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006516 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006518 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006520 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006522 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6524 {not available when compiled without |+autocmd| feature}
6525 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6526 being used: "<keymap>"
6527 n N Buffer number.
6528 b N Value of byte under cursor.
6529 B N As above, in hexadecimal.
6530 o N Byte number in file of byte under cursor, first byte is 1.
6531 Mnemonic: Offset from start of file (with one added)
6532 {not available when compiled without |+byte_offset| feature}
6533 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006534 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 l N Line number.
6536 L N Number of lines in buffer.
6537 c N Column number.
6538 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006539 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 p N Percentage through file in lines as in |CTRL-G|.
6541 P S Percentage through file of displayed window. This is like the
6542 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006543 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006545 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006546 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006547 ( - Start of item group. Can be used for setting the width and
6548 alignment of a section. Must be followed by %) somewhere.
6549 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006550 T N For 'tabline': start of tab page N label. Use %T after the last
6551 label. This information is used for mouse clicks.
6552 X N For 'tabline': start of close tab N label. Use %X after the
6553 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6554 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555 < - Where to truncate line if too long. Default is at the start.
6556 No width fields allowed.
6557 = - Separation point between left and right aligned items.
6558 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006559 # - Set highlight group. The name must follow and then a # again.
6560 Thus use %#HLname# for highlight group HLname. The same
6561 highlighting is used, also for the statusline of non-current
6562 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006564 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 The difference between User{N} and StatusLine will be applied
6566 to StatusLineNC for the statusline of non-current windows.
6567 The number N must be between 1 and 9. See |hl-User1..9|
6568
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006569 When displaying a flag, Vim removes the leading comma, if any, when
6570 that flag comes right after plaintext. This will make a nice display
6571 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006572
Bram Moolenaar582fd852005-03-28 20:58:01 +00006573 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006574 not set) and a minwid is not set for the group, the whole group will
6575 become empty. This will make a group like the following disappear
6576 completely from the statusline when none of the flags are set. >
6577 :set statusline=...%(\ [%M%R%H]%)...
6578<
6579 Beware that an expression is evaluated each and every time the status
6580 line is displayed. The current buffer and current window will be set
6581 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006582 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006584 real current buffer.
6585
6586 The 'statusline' option may be evaluated in the |sandbox|, see
6587 |sandbox-option|.
6588
6589 It is not allowed to change text or jump to another window while
6590 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591
6592 If the statusline is not updated when you want it (e.g., after setting
6593 a variable that's used in an expression), you can force an update by
6594 setting an option without changing its value. Example: >
6595 :let &ro = &ro
6596
6597< A result of all digits is regarded a number for display purposes.
6598 Otherwise the result is taken as flag text and applied to the rules
6599 described above.
6600
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006601 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006602 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6603 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6604
6605 Examples:
6606 Emulate standard status line with 'ruler' set >
6607 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6608< Similar, but add ASCII value of char under the cursor (like "ga") >
6609 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6610< Display byte count and byte value, modified flag in red. >
6611 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6612 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6613< Display a ,GZ flag if a compressed file is loaded >
6614 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6615< In the |:autocmd|'s: >
6616 :let b:gzflag = 1
6617< And: >
6618 :unlet b:gzflag
6619< And define this function: >
6620 :function VarExists(var, val)
6621 : if exists(a:var) | return a:val | else | return '' | endif
6622 :endfunction
6623<
6624 *'suffixes'* *'su'*
6625'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6626 global
6627 {not in Vi}
6628 Files with these suffixes get a lower priority when multiple files
6629 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006630 suffixes. Spaces after the comma are ignored. A dot is also seen as
6631 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 separator, precede it with a backslash (see |option-backslash| about
6633 including spaces and backslashes).
6634 See 'wildignore' for completely ignoring files.
6635 The use of |:set+=| and |:set-=| is preferred when adding or removing
6636 suffixes from the list. This avoids problems when a future version
6637 uses another default.
6638
6639 *'suffixesadd'* *'sua'*
6640'suffixesadd' 'sua' string (default "")
6641 local to buffer
6642 {not in Vi}
6643 {not available when compiled without the
6644 |+file_in_path| feature}
6645 Comma separated list of suffixes, which are used when searching for a
6646 file for the "gf", "[I", etc. commands. Example: >
6647 :set suffixesadd=.java
6648<
6649 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6650'swapfile' 'swf' boolean (default on)
6651 local to buffer
6652 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006653 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 swapfile is not wanted for a specific buffer. For example, with
6655 confidential information that even root must not be able to access.
6656 Careful: All text will be in memory:
6657 - Don't use this for big files.
6658 - Recovery will be impossible!
6659 A swapfile will only be present when |'updatecount'| is non-zero and
6660 'swapfile' is set.
6661 When 'swapfile' is reset, the swap file for the current buffer is
6662 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6663 non-zero, a swap file is immediately created.
6664 Also see |swap-file| and |'swapsync'|.
6665
6666 This option is used together with 'bufhidden' and 'buftype' to
6667 specify special kinds of buffers. See |special-buffers|.
6668
6669 *'swapsync'* *'sws'*
6670'swapsync' 'sws' string (default "fsync")
6671 global
6672 {not in Vi}
6673 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006674 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 When this option is empty parts of the swap file may be in memory and
6676 not written to disk. When the system crashes you may lose more work.
6677 On Unix the system does a sync now and then without Vim asking for it,
6678 so the disadvantage of setting this option off is small. On some
6679 systems the swap file will not be written at all. For a unix system
6680 setting it to "sync" will use the sync() call instead of the default
6681 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006682 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683
6684 *'switchbuf'* *'swb'*
6685'switchbuf' 'swb' string (default "")
6686 global
6687 {not in Vi}
6688 This option controls the behavior when switching between buffers.
6689 Possible values (comma separated list):
6690 useopen If included, jump to the first open window that
6691 contains the specified buffer (if there is one).
6692 Otherwise: Do not examine other windows.
6693 This setting is checked with |quickfix| commands, when
6694 jumping to errors (":cc", ":cn", "cp", etc.). It is
6695 also used in all buffer related split commands, for
6696 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006697 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006698 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006700 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006702 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006703 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006705 *'synmaxcol'* *'smc'*
6706'synmaxcol' 'smc' number (default 3000)
6707 local to buffer
6708 {not in Vi}
6709 {not available when compiled without the |+syntax|
6710 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006711 Maximum column in which to search for syntax items. In long lines the
6712 text after this column is not highlighted and following lines may not
6713 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006714 This helps to avoid very slow redrawing for an XML file that is one
6715 long line.
6716 Set to zero to remove the limit.
6717
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 *'syntax'* *'syn'*
6719'syntax' 'syn' string (default empty)
6720 local to buffer
6721 {not in Vi}
6722 {not available when compiled without the |+syntax|
6723 feature}
6724 When this option is set, the syntax with this name is loaded, unless
6725 syntax highlighting has been switched off with ":syntax off".
6726 Otherwise this option does not always reflect the current syntax (the
6727 b:current_syntax variable does).
6728 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006729 not automatically recognized. Example, in an IDL file:
6730 /* vim: set syntax=idl : */ ~
6731 When a dot appears in the value then this separates two filetype
6732 names. Example:
6733 /* vim: set syntax=c.doxygen : */ ~
6734 This will use the "c" syntax first, then the "doxygen" syntax.
6735 Note that the second one must be prepared to be loaded as an addition,
6736 otherwise it will be skipped. More than one dot may appear.
6737 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 :set syntax=OFF
6739< To switch syntax highlighting on according to the current value of the
6740 'filetype' option: >
6741 :set syntax=ON
6742< What actually happens when setting the 'syntax' option is that the
6743 Syntax autocommand event is triggered with the value as argument.
6744 This option is not copied to another buffer, independent of the 's' or
6745 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006746 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006748 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006749'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006750 global
6751 {not in Vi}
6752 {not available when compiled without the +windows
6753 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006754 When nonempty, this option determines the content of the tab pages
6755 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006756 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006757
6758 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006759 option and only when there is no GUI tab line. When 'e' is in
6760 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6761 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006762
6763 The value is evaluated like with 'statusline'. You can use
6764 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006765 the text to be displayed. Use "%1T" for the first label, "%2T" for
6766 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006767
6768 Keep in mind that only one of the tab pages is the current one, others
6769 are invisible and you can't jump to their windows.
6770
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006771
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006772 *'tabpagemax'* *'tpm'*
6773'tabpagemax' 'tpm' number (default 10)
6774 global
6775 {not in Vi}
6776 {not available when compiled without the +windows
6777 feature}
6778 Maximum number of tab pages to be opened by the |-p| command line
6779 argument or the ":tab all" command. |tabpage|
6780
6781
6782 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783'tabstop' 'ts' number (default 8)
6784 local to buffer
6785 Number of spaces that a <Tab> in the file counts for. Also see
6786 |:retab| command, and 'softtabstop' option.
6787
6788 Note: Setting 'tabstop' to any other value than 8 can make your file
6789 appear wrong in many places (e.g., when printing it).
6790
6791 There are four main ways to use tabs in Vim:
6792 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6793 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006794 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795 behave like a tab appears every 4 (or 3) characters.
6796 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6797 'expandtab'. This way you will always insert spaces. The
6798 formatting will never be messed up when 'tabstop' is changed.
6799 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006800 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 works when using Vim to edit the file.
6802 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6803 'noexpandtab'. This should then work (for initial indents only)
6804 for any tabstop setting that people use. It might be nice to have
6805 tabs after the first non-blank inserted as spaces if you do this
6806 though. Otherwise aligned comments will be wrong when 'tabstop' is
6807 changed.
6808
6809 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6810'tagbsearch' 'tbs' boolean (default on)
6811 global
6812 {not in Vi}
6813 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006814 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006815 searching makes searching for a tag a LOT faster, but a linear search
6816 will find more tags if the tags file wasn't properly sorted.
6817 Vim normally assumes that your tags files are sorted, or indicate that
6818 they are not sorted. Only when this is not the case does the
6819 'tagbsearch' option need to be switched off.
6820
6821 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006822 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 certain files, or retry all files with a linear search. When
6824 'tagbsearch' is off, only a linear search is done.
6825
6826 Linear searching is done anyway, for one file, when Vim finds a line
6827 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006828 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829< [The whitespace before and after the '0' must be a single <Tab>]
6830
6831 When a binary search was done and no match was found in any of the
6832 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6833 instead of a normal tag name, a retry is done with a linear search.
6834 Tags in unsorted tags files, and matches with different case will only
6835 be found in the retry.
6836
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006837 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 linear search can be avoided for the 'ignorecase' case. Use a value
6839 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6840 case-fold sorted with the -f switch to "sort" in most unices, as in
6841 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006842 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6843 for this as well. Note that case must be folded to uppercase for this
6844 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845
6846 When 'tagbsearch' is off, tags searching is slower when a full match
6847 exists, but faster when no full match exists. Tags in unsorted tags
6848 files may only be found with 'tagbsearch' off.
6849 When the tags file is not sorted, or sorted in a wrong way (not on
6850 ASCII byte value), 'tagbsearch' should be off, or the line given above
6851 must be included in the tags file.
6852 This option doesn't affect commands that find all matching tags (e.g.,
6853 command-line completion and ":help").
6854 {Vi: always uses binary search in some versions}
6855
6856 *'taglength'* *'tl'*
6857'taglength' 'tl' number (default 0)
6858 global
6859 If non-zero, tags are significant up to this number of characters.
6860
6861 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6862'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6863 global
6864 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006865 If on and using a tags file in another directory, file names in that
6866 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 NOTE: This option is set to the Vi default value when 'compatible' is
6868 set and to the Vim default value when 'compatible' is reset.
6869
6870 *'tags'* *'tag'* *E433*
6871'tags' 'tag' string (default "./tags,tags", when compiled with
6872 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6873 global or local to buffer |global-local|
6874 Filenames for the tag command, separated by spaces or commas. To
6875 include a space or comma in a file name, precede it with a backslash
6876 (see |option-backslash| about including spaces and backslashes).
6877 When a file name starts with "./", the '.' is replaced with the path
6878 of the current file. But only when the 'd' flag is not included in
6879 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6880 |tags-option|.
6881 "*", "**" and other wildcards can be used to search for tags files in
6882 a directory tree. See |file-searching|. {not available when compiled
6883 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006884 The |tagfiles()| function can be used to get a list of the file names
6885 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006886 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6887 files are also supported. They are automatically recognized. The
6888 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6889 differences are ignored (MS-Windows). |emacs-tags|
6890 The use of |:set+=| and |:set-=| is preferred when adding or removing
6891 file names from the list. This avoids problems when a future version
6892 uses another default.
6893 {Vi: default is "tags /usr/lib/tags"}
6894
6895 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6896'tagstack' 'tgst' boolean (default on)
6897 global
6898 {not in all versions of Vi}
6899 When on, the |tagstack| is used normally. When off, a ":tag" or
6900 ":tselect" command with an argument will not push the tag onto the
6901 tagstack. A following ":tag" without an argument, a ":pop" command or
6902 any other command that uses the tagstack will use the unmodified
6903 tagstack, but does change the pointer to the active entry.
6904 Resetting this option is useful when using a ":tag" command in a
6905 mapping which should not change the tagstack.
6906
6907 *'term'* *E529* *E530* *E531*
6908'term' string (default is $TERM, if that fails:
6909 in the GUI: "builtin_gui"
6910 on Amiga: "amiga"
6911 on BeOS: "beos-ansi"
6912 on Mac: "mac-ansi"
6913 on MiNT: "vt52"
6914 on MS-DOS: "pcterm"
6915 on OS/2: "os2ansi"
6916 on Unix: "ansi"
6917 on VMS: "ansi"
6918 on Win 32: "win32")
6919 global
6920 Name of the terminal. Used for choosing the terminal control
6921 characters. Environment variables are expanded |:set_env|.
6922 For example: >
6923 :set term=$TERM
6924< See |termcap|.
6925
6926 *'termbidi'* *'tbidi'*
6927 *'notermbidi'* *'notbidi'*
6928'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6929 global
6930 {not in Vi}
6931 {only available when compiled with the |+arabic|
6932 feature}
6933 The terminal is in charge of Bi-directionality of text (as specified
6934 by Unicode). The terminal is also expected to do the required shaping
6935 that some languages (such as Arabic) require.
6936 Setting this option implies that 'rightleft' will not be set when
6937 'arabic' is set and the value of 'arabicshape' will be ignored.
6938 Note that setting 'termbidi' has the immediate effect that
6939 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6940 This option is reset when the GUI is started.
6941 For further details see |arabic.txt|.
6942
6943 *'termencoding'* *'tenc'*
6944'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6945 Macintosh GUI: "macroman")
6946 global
6947 {only available when compiled with the |+multi_byte|
6948 feature}
6949 {not in Vi}
6950 Encoding used for the terminal. This specifies what character
6951 encoding the keyboard produces and the display will understand. For
6952 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006953 display). Except for the Mac when 'macatsui' is off, then
6954 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 In the Win32 console version the default value is the console codepage
6956 when it differs from the ANSI codepage.
6957 *E617*
6958 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6959 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6960 Any attempts to set a different value will be rejected, and an error
6961 message is shown.
6962 For the Win32 GUI 'termencoding' is not used for typed characters,
6963 because the Win32 system always passes Unicode characters.
6964 When empty, the same encoding is used as for the 'encoding' option.
6965 This is the normal value.
6966 Not all combinations for 'termencoding' and 'encoding' are valid. See
6967 |encoding-table|.
6968 The value for this option must be supported by internal conversions or
6969 iconv(). When this is not possible no conversion will be done and you
6970 will probably experience problems with non-ASCII characters.
6971 Example: You are working with the locale set to euc-jp (Japanese) and
6972 want to edit a UTF-8 file: >
6973 :let &termencoding = &encoding
6974 :set encoding=utf-8
6975< You need to do this when your system has no locale support for UTF-8.
6976
6977 *'terse'* *'noterse'*
6978'terse' boolean (default off)
6979 global
6980 When set: Add 's' flag to 'shortmess' option (this makes the message
6981 for a search that hits the start or end of the file not being
6982 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6983 shortens a lot of messages}
6984
6985 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6986'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6987 global
6988 {not in Vi}
6989 This option is obsolete. Use 'fileformats'.
6990 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6991 set to the default value for the current system. When 'textauto' is
6992 reset, 'fileformats' is made empty.
6993 NOTE: This option is set to the Vi default value when 'compatible' is
6994 set and to the Vim default value when 'compatible' is reset.
6995
6996 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6997'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6998 others: default off)
6999 local to buffer
7000 {not in Vi}
7001 This option is obsolete. Use 'fileformat'.
7002 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7003 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7004 "unix".
7005
7006 *'textwidth'* *'tw'*
7007'textwidth' 'tw' number (default 0)
7008 local to buffer
7009 {not in Vi}
7010 Maximum width of text that is being inserted. A longer line will be
7011 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007012 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7013 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007015 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 NOTE: This option is set to 0 when 'compatible' is set.
7017
7018 *'thesaurus'* *'tsr'*
7019'thesaurus' 'tsr' string (default "")
7020 global or local to buffer |global-local|
7021 {not in Vi}
7022 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007023 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 the file should contain words with similar meaning, separated by
7025 non-keyword characters (white space is preferred). Maximum line
7026 length is 510 bytes.
7027 To obtain a file to be used here, check out the wordlist FAQ at
7028 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007029 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 after a comma are ignored, otherwise spaces are included in the file
7031 name. See |option-backslash| about using backslashes.
7032 The use of |:set+=| and |:set-=| is preferred when adding or removing
7033 directories from the list. This avoids problems when a future version
7034 uses another default.
7035 Backticks cannot be used in this option for security reasons.
7036
7037 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7038'tildeop' 'top' boolean (default off)
7039 global
7040 {not in Vi}
7041 When on: The tilde command "~" behaves like an operator.
7042 NOTE: This option is reset when 'compatible' is set.
7043
7044 *'timeout'* *'to'* *'notimeout'* *'noto'*
7045'timeout' 'to' boolean (default on)
7046 global
7047 *'ttimeout'* *'nottimeout'*
7048'ttimeout' boolean (default off)
7049 global
7050 {not in Vi}
7051 These two options together determine the behavior when part of a
7052 mapped key sequence or keyboard code has been received:
7053
7054 'timeout' 'ttimeout' action ~
7055 off off do not time out
7056 on on or off time out on :mappings and key codes
7057 off on time out on key codes
7058
7059 If both options are off, Vim will wait until either the complete
7060 mapping or key sequence has been received, or it is clear that there
7061 is no mapping or key sequence for the received characters. For
7062 example: if you have mapped "vl" and Vim has received 'v', the next
7063 character is needed to see if the 'v' is followed by an 'l'.
7064 When one of the options is on, Vim will wait for about 1 second for
7065 the next character to arrive. After that the already received
7066 characters are interpreted as single characters. The waiting time can
7067 be changed with the 'timeoutlen' option.
7068 On slow terminals or very busy systems timing out may cause
7069 malfunctioning cursor keys. If both options are off, Vim waits
7070 forever after an entered <Esc> if there are key codes that start
7071 with <Esc>. You will have to type <Esc> twice. If you do not have
7072 problems with key codes, but would like to have :mapped key
7073 sequences not timing out in 1 second, set the 'ttimeout' option and
7074 reset the 'timeout' option.
7075
7076 NOTE: 'ttimeout' is reset when 'compatible' is set.
7077
7078 *'timeoutlen'* *'tm'*
7079'timeoutlen' 'tm' number (default 1000)
7080 global
7081 {not in all versions of Vi}
7082 *'ttimeoutlen'* *'ttm'*
7083'ttimeoutlen' 'ttm' number (default -1)
7084 global
7085 {not in Vi}
7086 The time in milliseconds that is waited for a key code or mapped key
7087 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7088 when part of a command has been typed.
7089 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7090 different timeout value for key codes is desired set 'ttimeoutlen' to
7091 a non-negative number.
7092
7093 ttimeoutlen mapping delay key code delay ~
7094 < 0 'timeoutlen' 'timeoutlen'
7095 >= 0 'timeoutlen' 'ttimeoutlen'
7096
7097 The timeout only happens when the 'timeout' and 'ttimeout' options
7098 tell so. A useful setting would be >
7099 :set timeout timeoutlen=3000 ttimeoutlen=100
7100< (time out on mapping after three seconds, time out on key codes after
7101 a tenth of a second).
7102
7103 *'title'* *'notitle'*
7104'title' boolean (default off, on when title can be restored)
7105 global
7106 {not in Vi}
7107 {not available when compiled without the |+title|
7108 feature}
7109 When on, the title of the window will be set to the value of
7110 'titlestring' (if it is not empty), or to:
7111 filename [+=-] (path) - VIM
7112 Where:
7113 filename the name of the file being edited
7114 - indicates the file cannot be modified, 'ma' off
7115 + indicates the file was modified
7116 = indicates the file is read-only
7117 =+ indicates the file is read-only and modified
7118 (path) is the path of the file being edited
7119 - VIM the server name |v:servername| or "VIM"
7120 Only works if the terminal supports setting window titles
7121 (currently Amiga console, Win32 console, all GUI versions and
7122 terminals with a non- empty 't_ts' option - these are Unix xterm and
7123 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7124 *X11*
7125 When Vim was compiled with HAVE_X11 defined, the original title will
7126 be restored if possible. The output of ":version" will include "+X11"
7127 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7128 works for the icon name |'icon'|.
7129 But: When Vim was started with the |-X| argument, restoring the title
7130 will not work (except in the GUI).
7131 If the title cannot be restored, it is set to the value of 'titleold'.
7132 You might want to restore the title outside of Vim then.
7133 When using an xterm from a remote machine you can use this command:
7134 rsh machine_name xterm -display $DISPLAY &
7135 then the WINDOWID environment variable should be inherited and the
7136 title of the window should change back to what it should be after
7137 exiting Vim.
7138
7139 *'titlelen'*
7140'titlelen' number (default 85)
7141 global
7142 {not in Vi}
7143 {not available when compiled without the |+title|
7144 feature}
7145 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007146 title. When the title is longer, only the end of the path name is
7147 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 Using a percentage makes this adapt to the width of the window. But
7149 it won't work perfectly, because the actual number of characters
7150 available also depends on the font used and other things in the title
7151 bar. When 'titlelen' is zero the full path is used. Otherwise,
7152 values from 1 to 30000 percent can be used.
7153 'titlelen' is also used for the 'titlestring' option.
7154
7155 *'titleold'*
7156'titleold' string (default "Thanks for flying Vim")
7157 global
7158 {not in Vi}
7159 {only available when compiled with the |+title|
7160 feature}
7161 This option will be used for the window title when exiting Vim if the
7162 original title cannot be restored. Only happens if 'title' is on or
7163 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007164 This option cannot be set from a |modeline| or in the |sandbox|, for
7165 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 *'titlestring'*
7167'titlestring' string (default "")
7168 global
7169 {not in Vi}
7170 {not available when compiled without the |+title|
7171 feature}
7172 When this option is not empty, it will be used for the title of the
7173 window. This happens only when the 'title' option is on.
7174 Only works if the terminal supports setting window titles (currently
7175 Amiga console, Win32 console, all GUI versions and terminals with a
7176 non-empty 't_ts' option).
7177 When Vim was compiled with HAVE_X11 defined, the original title will
7178 be restored if possible |X11|.
7179 When this option contains printf-style '%' items, they will be
7180 expanded according to the rules used for 'statusline'.
7181 Example: >
7182 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7183 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7184< The value of 'titlelen' is used to align items in the middle or right
7185 of the available space.
7186 Some people prefer to have the file name first: >
7187 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7188< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007189 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190 separating space only when needed.
7191 NOTE: Use of special characters in 'titlestring' may cause the display
7192 to be garbled (e.g., when it contains a CR or NL character).
7193 {not available when compiled without the |+statusline| feature}
7194
7195 *'toolbar'* *'tb'*
7196'toolbar' 'tb' string (default "icons,tooltips")
7197 global
7198 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7199 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007200 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201 possible values are:
7202 icons Toolbar buttons are shown with icons.
7203 text Toolbar buttons shown with text.
7204 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007205 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 tooltips Tooltips are active for toolbar buttons.
7207 Tooltips refer to the popup help text which appears after the mouse
7208 cursor is placed over a toolbar button for a brief moment.
7209
7210 If you want the toolbar to be shown with icons as well as text, do the
7211 following: >
7212 :set tb=icons,text
7213< Motif and Athena cannot display icons and text at the same time. They
7214 will show icons if both are requested.
7215
7216 If none of the strings specified in 'toolbar' are valid or if
7217 'toolbar' is empty, this option is ignored. If you want to disable
7218 the toolbar, you need to set the 'guioptions' option. For example: >
7219 :set guioptions-=T
7220< Also see |gui-toolbar|.
7221
7222 *'toolbariconsize'* *'tbis'*
7223'toolbariconsize' 'tbis' string (default "small")
7224 global
7225 {not in Vi}
7226 {only in the GTK+ 2 GUI}
7227 Controls the size of toolbar icons. The possible values are:
7228 tiny Use tiny toolbar icons.
7229 small Use small toolbar icons (default).
7230 medium Use medium-sized toolbar icons.
7231 large Use large toolbar icons.
7232 The exact dimensions in pixels of the various icon sizes depend on
7233 the current theme. Common dimensions are large=32x32, medium=24x24,
7234 small=20x20 and tiny=16x16.
7235
7236 If 'toolbariconsize' is empty, the global default size as determined
7237 by user preferences or the current theme is used.
7238
7239 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7240'ttybuiltin' 'tbi' boolean (default on)
7241 global
7242 {not in Vi}
7243 When on, the builtin termcaps are searched before the external ones.
7244 When off the builtin termcaps are searched after the external ones.
7245 When this option is changed, you should set the 'term' option next for
7246 the change to take effect, for example: >
7247 :set notbi term=$TERM
7248< See also |termcap|.
7249 Rationale: The default for this option is "on", because the builtin
7250 termcap entries are generally better (many systems contain faulty
7251 xterm entries...).
7252
7253 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7254'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7255 sun-cmd, screen, rxvt, dtterm or
7256 iris-ansi; also on when running Vim in
7257 a DOS console)
7258 global
7259 {not in Vi}
7260 Indicates a fast terminal connection. More characters will be sent to
7261 the screen for redrawing, instead of using insert/delete line
7262 commands. Improves smoothness of redrawing when there are multiple
7263 windows and the terminal does not support a scrolling region.
7264 Also enables the extra writing of characters at the end of each screen
7265 line for lines that wrap. This helps when using copy/paste with the
7266 mouse in an xterm and other terminals.
7267
7268 *'ttymouse'* *'ttym'*
7269'ttymouse' 'ttym' string (default depends on 'term')
7270 global
7271 {not in Vi}
7272 {only in Unix and VMS, doesn't work in the GUI; not
7273 available when compiled without |+mouse|}
7274 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007275 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276 *xterm-mouse*
7277 xterm xterm-like mouse handling. The mouse generates
7278 "<Esc>[Mscr", where "scr" is three bytes:
7279 "s" = button state
7280 "c" = column plus 33
7281 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007282 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007283 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 xterm2 Works like "xterm", but with the xterm reporting the
7285 mouse position while the mouse is dragged. This works
7286 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007287 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 work. See below for how Vim detects this
7289 automatically.
7290 *netterm-mouse*
7291 netterm NetTerm mouse handling. The mouse generates
7292 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7293 for the row and column.
7294 *dec-mouse*
7295 dec DEC terminal mouse handling. The mouse generates a
7296 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007297 This is also available for an Xterm, if it was
7298 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007299 *jsbterm-mouse*
7300 jsbterm JSB term mouse handling.
7301 *pterm-mouse*
7302 pterm QNX pterm mouse handling.
7303
7304 The mouse handling must be enabled at compile time |+mouse_xterm|
7305 |+mouse_dec| |+mouse_netterm|.
7306 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7307 recognized, if enabled at compile time. DEC terminal mouse codes
7308 are recognized if enabled at compile time, and 'ttymouse' is not
7309 "xterm" (because the xterm and dec mouse codes conflict).
7310 This option is automatically set to "xterm", when the 'term' option is
7311 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7312 or "xterm2" already. The main use of this option is to set it to
7313 "xterm", when the terminal name doesn't start with "xterm", but it can
7314 handle xterm mouse codes.
7315 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007316 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317 feature and if |t_RV| is set to the escape sequence to request the
7318 xterm version number. Otherwise "xterm2" must be set explicitly.
7319 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7320 t_RV to an empty string: >
7321 :set t_RV=
7322<
7323 *'ttyscroll'* *'tsl'*
7324'ttyscroll' 'tsl' number (default 999)
7325 global
7326 Maximum number of lines to scroll the screen. If there are more lines
7327 to scroll the window is redrawn. For terminals where scrolling is
7328 very slow and redrawing is not slow this can be set to a small number,
7329 e.g., 3, to speed up displaying.
7330
7331 *'ttytype'* *'tty'*
7332'ttytype' 'tty' string (default from $TERM)
7333 global
7334 Alias for 'term', see above.
7335
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007336 *'undodir'* *'udir'*
7337'undodir' 'udir' string (default ".")
7338 global
7339 {not in Vi}
7340 {only when compiled with the +persistent_undo feature}
7341 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007342 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007343 "." means using the directory of the file. The undo file name for
7344 "file.txt" is ".file.txt.un~".
7345 For other directories the file name is the full path of the edited
7346 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007347 When writing: The first directory that exists is used. "." always
7348 works, no directories after "." will be used for writing.
7349 When reading all entries are tried to find an undo file. The first
7350 undo file that exists is used. When it cannot be read an error is
7351 given, no further entry is used.
7352 See |undo-persistence|.
7353
7354 *'undofile'* *'udf'*
7355'undofile' 'udf' boolean (default off)
7356 local to buffer
7357 {not in Vi}
7358 {only when compiled with the +persistent_undo feature}
7359 When on, Vim automatically saves undo history to an undo file when
7360 writing a buffer to a file, and restores undo history from the same
7361 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007362 The directory where the undo file is stored is specified by 'undodir'.
7363 For more information about this feature see |undo-persistence|.
7364 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007365
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 *'undolevels'* *'ul'*
7367'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7368 Win32 and OS/2)
7369 global
7370 {not in Vi}
7371 Maximum number of changes that can be undone. Since undo information
7372 is kept in memory, higher numbers will cause more memory to be used
7373 (nevertheless, a single change can use an unlimited amount of memory).
7374 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7375 itself: >
7376 set ul=0
7377< But you can also get Vi compatibility by including the 'u' flag in
7378 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007379 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007380 Set to a negative number for no undo at all: >
7381 set ul=-1
7382< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007383 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384
7385 *'updatecount'* *'uc'*
7386'updatecount' 'uc' number (default: 200)
7387 global
7388 {not in Vi}
7389 After typing this many characters the swap file will be written to
7390 disk. When zero, no swap file will be created at all (see chapter on
7391 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7392 Vim with the "-n" option, see |startup|. When editing in readonly
7393 mode this option will be initialized to 10000.
7394 The swapfile can be disabled per buffer with |'swapfile'|.
7395 When 'updatecount' is set from zero to non-zero, swap files are
7396 created for all buffers that have 'swapfile' set. When 'updatecount'
7397 is set to zero, existing swap files are not deleted.
7398 Also see |'swapsync'|.
7399 This option has no meaning in buffers where |'buftype'| is "nofile"
7400 or "nowrite".
7401
7402 *'updatetime'* *'ut'*
7403'updatetime' 'ut' number (default 4000)
7404 global
7405 {not in Vi}
7406 If this many milliseconds nothing is typed the swap file will be
7407 written to disk (see |crash-recovery|). Also used for the
7408 |CursorHold| autocommand event.
7409
7410 *'verbose'* *'vbs'*
7411'verbose' 'vbs' number (default 0)
7412 global
7413 {not in Vi, although some versions have a boolean
7414 verbose option}
7415 When bigger than zero, Vim will give messages about what it is doing.
7416 Currently, these messages are given:
7417 >= 1 When the viminfo file is read or written.
7418 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007419 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420 >= 8 Files for which a group of autocommands is executed.
7421 >= 9 Every executed autocommand.
7422 >= 12 Every executed function.
7423 >= 13 When an exception is thrown, caught, finished, or discarded.
7424 >= 14 Anything pending in a ":finally" clause.
7425 >= 15 Every executed Ex command (truncated at 200 characters).
7426
7427 This option can also be set with the "-V" argument. See |-V|.
7428 This option is also set by the |:verbose| command.
7429
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007430 When the 'verbosefile' option is set then the verbose messages are not
7431 displayed.
7432
7433 *'verbosefile'* *'vfile'*
7434'verbosefile' 'vfile' string (default empty)
7435 global
7436 {not in Vi}
7437 When not empty all messages are written in a file with this name.
7438 When the file exists messages are appended.
7439 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007440 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007441 Setting 'verbosefile' to a new value is like making it empty first.
7442 The difference with |:redir| is that verbose messages are not
7443 displayed when 'verbosefile' is set.
7444
Bram Moolenaar071d4272004-06-13 20:20:40 +00007445 *'viewdir'* *'vdir'*
7446'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7447 "$VIM/vimfiles/view",
7448 for Unix: "~/.vim/view",
7449 for Macintosh: "$VIM:vimfiles:view"
7450 for VMS: "sys$login:vimfiles/view"
7451 for RiscOS: "Choices:vimfiles/view")
7452 global
7453 {not in Vi}
7454 {not available when compiled without the +mksession
7455 feature}
7456 Name of the directory where to store files for |:mkview|.
7457 This option cannot be set from a |modeline| or in the |sandbox|, for
7458 security reasons.
7459
7460 *'viewoptions'* *'vop'*
7461'viewoptions' 'vop' string (default: "folds,options,cursor")
7462 global
7463 {not in Vi}
7464 {not available when compiled without the +mksession
7465 feature}
7466 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007467 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 word save and restore ~
7469 cursor cursor position in file and in window
7470 folds manually created folds, opened/closed folds and local
7471 fold options
7472 options options and mappings local to a window or buffer (not
7473 global values for local options)
7474 slash backslashes in file names replaced with forward
7475 slashes
7476 unix with Unix end-of-line format (single <NL>), even when
7477 on Windows or DOS
7478
7479 "slash" and "unix" are useful on Windows when sharing view files
7480 with Unix. The Unix version of Vim cannot source dos format scripts,
7481 but the Windows version of Vim can source unix format scripts.
7482
7483 *'viminfo'* *'vi'* *E526* *E527* *E528*
7484'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007485 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7486 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7487 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 global
7489 {not in Vi}
7490 {not available when compiled without the |+viminfo|
7491 feature}
7492 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007493 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494 separated list of parameters, each consisting of a single character
7495 identifying the particular parameter, followed by a number or string
7496 which specifies the value of that parameter. If a particular
7497 character is left out, then the default value is used for that
7498 parameter. The following is a list of the identifying characters and
7499 the effect of their value.
7500 CHAR VALUE ~
7501 ! When included, save and restore global variables that start
7502 with an uppercase letter, and don't contain a lowercase
7503 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007504 and "_K_L_M" are not. Only String and Number types are
7505 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007506 " Maximum number of lines saved for each register. Old name of
7507 the '<' item, with the disadvantage that you need to put a
7508 backslash before the ", otherwise it will be recognized as the
7509 start of a comment!
7510 % When included, save and restore the buffer list. If Vim is
7511 started with a file name argument, the buffer list is not
7512 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007513 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514 without a file name and buffers for help files are not written
7515 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007516 When followed by a number, the number specifies the maximum
7517 number of buffers that are stored. Without a number all
7518 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 ' Maximum number of previously edited files for which the marks
7520 are remembered. This parameter must always be included when
7521 'viminfo' is non-empty.
7522 Including this item also means that the |jumplist| and the
7523 |changelist| are stored in the viminfo file.
7524 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007525 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526 patterns are also saved. When not included, the value of
7527 'history' is used.
7528 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007529 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007530 < Maximum number of lines saved for each register. If zero then
7531 registers are not saved. When not included, all lines are
7532 saved. '"' is the old name for this item.
7533 Also see the 's' item below: limit specified in Kbyte.
7534 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007535 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536 c When included, convert the text in the viminfo file from the
7537 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007538 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539 f Whether file marks need to be stored. If zero, file marks ('0
7540 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007541 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542 cursor position (when exiting or when doing ":wviminfo").
7543 h Disable the effect of 'hlsearch' when loading the viminfo
7544 file. When not included, it depends on whether ":nohlsearch"
7545 has been used since the last search command.
7546 n Name of the viminfo file. The name must immediately follow
7547 the 'n'. Must be the last one! If the "-i" argument was
7548 given when starting Vim, that file name overrides the one
7549 given here with 'viminfo'. Environment variables are expanded
7550 when opening the file, not when setting the option.
7551 r Removable media. The argument is a string (up to the next
7552 ','). This parameter can be given several times. Each
7553 specifies the start of a path for which no marks will be
7554 stored. This is to avoid removable media. For MS-DOS you
7555 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7556 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7557 ignored. Maximum length of each 'r' argument is 50
7558 characters.
7559 s Maximum size of an item in Kbyte. If zero then registers are
7560 not saved. Currently only applies to registers. The default
7561 "s10" will exclude registers with more than 10 Kbyte of text.
7562 Also see the '<' item above: line count limit.
7563
7564 Example: >
7565 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7566<
7567 '50 Marks will be remembered for the last 50 files you
7568 edited.
7569 <1000 Contents of registers (up to 1000 lines each) will be
7570 remembered.
7571 s100 Registers with more than 100 Kbyte text are skipped.
7572 :0 Command-line history will not be saved.
7573 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7574 no / Since '/' is not specified, the default will be used,
7575 that is, save all of the search history, and also the
7576 previous search and substitute patterns.
7577 no % The buffer list will not be saved nor read back.
7578 no h 'hlsearch' highlighting will be restored.
7579
7580 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7581 load the contents of the file, this is not done automatically.
7582
7583 This option cannot be set from a |modeline| or in the |sandbox|, for
7584 security reasons.
7585
7586 *'virtualedit'* *'ve'*
7587'virtualedit' 've' string (default "")
7588 global
7589 {not in Vi}
7590 {not available when compiled without the
7591 |+virtualedit| feature}
7592 A comma separated list of these words:
7593 block Allow virtual editing in Visual block mode.
7594 insert Allow virtual editing in Insert mode.
7595 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007596 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007597
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007599 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 of the line. Useful for selecting a rectangle in Visual mode and
7601 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007602 "onemore" is not the same, it will only allow moving the cursor just
7603 after the last character of the line. This makes some commands more
7604 consistent. Previously the cursor was always past the end of the line
7605 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007606 break some plugins or Vim scripts. For example because |l| can move
7607 the cursor after the last character. Use with care!
7608 Using the |$| command will move to the last character in the line, not
7609 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007610 It doesn't make sense to combine "all" with "onemore", but you will
7611 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612
7613 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7614'visualbell' 'vb' boolean (default off)
7615 global
7616 {not in Vi}
7617 Use visual bell instead of beeping. The terminal code to display the
7618 visual bell is given with 't_vb'. When no beep or flash is wanted,
7619 use ":set vb t_vb=".
7620 Note: When the GUI starts, 't_vb' is reset to its default value. You
7621 might want to set it again in your |gvimrc|.
7622 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7623 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7624 where 40 is the time in msec.
7625 Does not work on the Amiga, you always get a screen flash.
7626 Also see 'errorbells'.
7627
7628 *'warn'* *'nowarn'*
7629'warn' boolean (default on)
7630 global
7631 Give a warning message when a shell command is used while the buffer
7632 has been changed.
7633
7634 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7635'weirdinvert' 'wiv' boolean (default off)
7636 global
7637 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007638 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639 It is provided for backwards compatibility with version 4.x.
7640 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7641 vice versa. Has no effect when the GUI is running.
7642
7643 *'whichwrap'* *'ww'*
7644'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7645 global
7646 {not in Vi}
7647 Allow specified keys that move the cursor left/right to move to the
7648 previous/next line when the cursor is on the first/last character in
7649 the line. Concatenate characters to allow this for these keys:
7650 char key mode ~
7651 b <BS> Normal and Visual
7652 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007653 h "h" Normal and Visual (not recommended)
7654 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655 < <Left> Normal and Visual
7656 > <Right> Normal and Visual
7657 ~ "~" Normal
7658 [ <Left> Insert and Replace
7659 ] <Right> Insert and Replace
7660 For example: >
7661 :set ww=<,>,[,]
7662< allows wrap only when cursor keys are used.
7663 When the movement keys are used in combination with a delete or change
7664 operator, the <EOL> also counts for a character. This makes "3h"
7665 different from "3dh" when the cursor crosses the end of a line. This
7666 is also true for "x" and "X", because they do the same as "dl" and
7667 "dh". If you use this, you may also want to use the mapping
7668 ":map <BS> X" to make backspace delete the character in front of the
7669 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007670 When 'l' is included and it is used after an operator at the end of a
7671 line then it will not move to the next line. This makes "dl", "cl",
7672 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007673 NOTE: This option is set to the Vi default value when 'compatible' is
7674 set and to the Vim default value when 'compatible' is reset.
7675
7676 *'wildchar'* *'wc'*
7677'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7678 global
7679 {not in Vi}
7680 Character you have to type to start wildcard expansion in the
7681 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007682 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683 The character is not recognized when used inside a macro. See
7684 'wildcharm' for that.
7685 Although 'wc' is a number option, you can set it to a special key: >
7686 :set wc=<Esc>
7687< NOTE: This option is set to the Vi default value when 'compatible' is
7688 set and to the Vim default value when 'compatible' is reset.
7689
7690 *'wildcharm'* *'wcm'*
7691'wildcharm' 'wcm' number (default: none (0))
7692 global
7693 {not in Vi}
7694 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007695 recognized when used inside a macro. You can find "spare" command-line
7696 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007697 you'll never actually type 'wildcharm', just use it in mappings that
7698 automatically invoke completion mode, e.g.: >
7699 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007700 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007701< Then after typing :ss you can use CTRL-P & CTRL-N.
7702
7703 *'wildignore'* *'wig'*
7704'wildignore' 'wig' string (default "")
7705 global
7706 {not in Vi}
7707 {not available when compiled without the |+wildignore|
7708 feature}
7709 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007710 patterns is ignored when completing file or directory names, and
7711 influences the result of |expand()|, |glob()| and |globpath()| unless
7712 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7714 Also see 'suffixes'.
7715 Example: >
7716 :set wildignore=*.o,*.obj
7717< The use of |:set+=| and |:set-=| is preferred when adding or removing
7718 a pattern from the list. This avoids problems when a future version
7719 uses another default.
7720
7721 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7722'wildmenu' 'wmnu' boolean (default off)
7723 global
7724 {not in Vi}
7725 {not available if compiled without the |+wildmenu|
7726 feature}
7727 When 'wildmenu' is on, command-line completion operates in an enhanced
7728 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7729 the possible matches are shown just above the command line, with the
7730 first match highlighted (overwriting the status line, if there is
7731 one). Keys that show the previous/next match, such as <Tab> or
7732 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7733 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7734 specified. "longest" and "list" do not start "wildmenu" mode.
7735 If there are more matches than can fit in the line, a ">" is shown on
7736 the right and/or a "<" is shown on the left. The status line scrolls
7737 as needed.
7738 The "wildmenu" mode is abandoned when a key is hit that is not used
7739 for selecting a completion.
7740 While the "wildmenu" is active the following keys have special
7741 meanings:
7742
7743 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7744 <Down> - in filename/menu name completion: move into a
7745 subdirectory or submenu.
7746 <CR> - in menu completion, when the cursor is just after a
7747 dot: move into a submenu.
7748 <Up> - in filename/menu name completion: move up into
7749 parent directory or parent menu.
7750
7751 This makes the menus accessible from the console |console-menus|.
7752
7753 If you prefer the <Left> and <Right> keys to move the cursor instead
7754 of selecting a different match, use this: >
7755 :cnoremap <Left> <Space><BS><Left>
7756 :cnoremap <Right> <Space><BS><Right>
7757<
7758 The "WildMenu" highlighting is used for displaying the current match
7759 |hl-WildMenu|.
7760
7761 *'wildmode'* *'wim'*
7762'wildmode' 'wim' string (Vim default: "full")
7763 global
7764 {not in Vi}
7765 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007766 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007767 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768 first part specifies the behavior for the first use of 'wildchar',
7769 The second part for the second use, etc.
7770 These are the possible values for each part:
7771 "" Complete only the first match.
7772 "full" Complete the next full match. After the last match,
7773 the original string is used and then the first match
7774 again.
7775 "longest" Complete till longest common string. If this doesn't
7776 result in a longer string, use the next part.
7777 "longest:full" Like "longest", but also start 'wildmenu' if it is
7778 enabled.
7779 "list" When more than one match, list all matches.
7780 "list:full" When more than one match, list all matches and
7781 complete first match.
7782 "list:longest" When more than one match, list all matches and
7783 complete till longest common string.
7784 When there is only a single match, it is fully completed in all cases.
7785
7786 Examples: >
7787 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007788< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789 :set wildmode=longest,full
7790< Complete longest common string, then each full match >
7791 :set wildmode=list:full
7792< List all matches and complete each full match >
7793 :set wildmode=list,full
7794< List all matches without completing, then each full match >
7795 :set wildmode=longest,list
7796< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007797 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007798
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007799 *'wildoptions'* *'wop'*
7800'wildoptions' 'wop' string (default "")
7801 global
7802 {not in Vi}
7803 {not available when compiled without the |+wildignore|
7804 feature}
7805 A list of words that change how command line completion is done.
7806 Currently only one word is allowed:
7807 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007808 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007809 is displayed per line. Often used tag kinds are:
7810 d #define
7811 f function
7812 Also see |cmdline-completion|.
7813
Bram Moolenaar071d4272004-06-13 20:20:40 +00007814 *'winaltkeys'* *'wak'*
7815'winaltkeys' 'wak' string (default "menu")
7816 global
7817 {not in Vi}
7818 {only used in Win32, Motif, GTK and Photon GUI}
7819 Some GUI versions allow the access to menu entries by using the ALT
7820 key in combination with a character that appears underlined in the
7821 menu. This conflicts with the use of the ALT key for mappings and
7822 entering special characters. This option tells what to do:
7823 no Don't use ALT keys for menus. ALT key combinations can be
7824 mapped, but there is no automatic handling. This can then be
7825 done with the |:simalt| command.
7826 yes ALT key handling is done by the windowing system. ALT key
7827 combinations cannot be mapped.
7828 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007829 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830 keys can be mapped.
7831 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7832 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007833 This option is not used for <F10>; on Win32 and with GTK <F10> will
7834 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007836 *'window'* *'wi'*
7837'window' 'wi' number (default screen height - 1)
7838 global
7839 Window height. Do not confuse this with the height of the Vim window,
7840 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007841 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7842 value is smaller than 'lines' minus one. The screen will scroll
7843 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007844 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7845 in a much smarter way, taking care of wrapping lines.
7846 When resizing the Vim window, the value is smaller than 1 or more than
7847 or equal to 'lines' it will be set to 'lines' minus 1.
7848 {Vi also uses the option to specify the number of displayed lines}
7849
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850 *'winheight'* *'wh'* *E591*
7851'winheight' 'wh' number (default 1)
7852 global
7853 {not in Vi}
7854 {not available when compiled without the +windows
7855 feature}
7856 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007857 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007858 focus goes to a window that is smaller, its size is increased, at the
7859 cost of the height of other windows.
7860 Set 'winheight' to a small number for normal editing.
7861 Set it to 999 to make the current window fill most of the screen.
7862 Other windows will be only 'winminheight' high. This has the drawback
7863 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7864 to create only two windows, set the option after startup is done,
7865 using the |VimEnter| event: >
7866 au VimEnter * set winheight=999
7867< Minimum value is 1.
7868 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007869 height of the current window.
7870 'winheight' applies to the current window. Use 'winminheight' to set
7871 the minimal height for other windows.
7872
7873 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7874'winfixheight' 'wfh' boolean (default off)
7875 local to window
7876 {not in Vi}
7877 {not available when compiled without the +windows
7878 feature}
7879 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007880 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7881 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007882 The height may be changed anyway when running out of room.
7883
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007884 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7885'winfixwidth' 'wfw' boolean (default off)
7886 local to window
7887 {not in Vi}
7888 {not available when compiled without the +windows
7889 feature}
7890 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007891 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007892 The width may be changed anyway when running out of room.
7893
Bram Moolenaar071d4272004-06-13 20:20:40 +00007894 *'winminheight'* *'wmh'*
7895'winminheight' 'wmh' number (default 1)
7896 global
7897 {not in Vi}
7898 {not available when compiled without the +windows
7899 feature}
7900 The minimal height of a window, when it's not the current window.
7901 This is a hard minimum, windows will never become smaller.
7902 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7903 status bar) if necessary. They will return to at least one line when
7904 they become active (since the cursor has to have somewhere to go.)
7905 Use 'winheight' to set the minimal height of the current window.
7906 This option is only checked when making a window smaller. Don't use a
7907 large number, it will cause errors when opening more than a few
7908 windows. A value of 0 to 3 is reasonable.
7909
7910 *'winminwidth'* *'wmw'*
7911'winminwidth' 'wmw' number (default 1)
7912 global
7913 {not in Vi}
7914 {not available when compiled without the +vertsplit
7915 feature}
7916 The minimal width of a window, when it's not the current window.
7917 This is a hard minimum, windows will never become smaller.
7918 When set to zero, windows may be "squashed" to zero columns (i.e. just
7919 a vertical separator) if necessary. They will return to at least one
7920 line when they become active (since the cursor has to have somewhere
7921 to go.)
7922 Use 'winwidth' to set the minimal width of the current window.
7923 This option is only checked when making a window smaller. Don't use a
7924 large number, it will cause errors when opening more than a few
7925 windows. A value of 0 to 12 is reasonable.
7926
7927 *'winwidth'* *'wiw'* *E592*
7928'winwidth' 'wiw' number (default 20)
7929 global
7930 {not in Vi}
7931 {not available when compiled without the +vertsplit
7932 feature}
7933 Minimal number of columns for the current window. This is not a hard
7934 minimum, Vim will use fewer columns if there is not enough room. If
7935 the current window is smaller, its size is increased, at the cost of
7936 the width of other windows. Set it to 999 to make the current window
7937 always fill the screen. Set it to a small number for normal editing.
7938 The width is not adjusted after one of the commands to change the
7939 width of the current window.
7940 'winwidth' applies to the current window. Use 'winminwidth' to set
7941 the minimal width for other windows.
7942
7943 *'wrap'* *'nowrap'*
7944'wrap' boolean (default on)
7945 local to window
7946 {not in Vi}
7947 This option changes how text is displayed. It doesn't change the text
7948 in the buffer, see 'textwidth' for that.
7949 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007950 displaying continues on the next line. When off lines will not wrap
7951 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952 moved to a part that is not shown, the screen will scroll
7953 horizontally.
7954 The line will be broken in the middle of a word if necessary. See
7955 'linebreak' to get the break at a word boundary.
7956 To make scrolling horizontally a bit more useful, try this: >
7957 :set sidescroll=5
7958 :set listchars+=precedes:<,extends:>
7959< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007960 This option can't be set from a |modeline| when the 'diff' option is
7961 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007962
7963 *'wrapmargin'* *'wm'*
7964'wrapmargin' 'wm' number (default 0)
7965 local to buffer
7966 Number of characters from the right window border where wrapping
7967 starts. When typing text beyond this limit, an <EOL> will be inserted
7968 and inserting continues on the next line.
7969 Options that add a margin, such as 'number' and 'foldcolumn', cause
7970 the text width to be further reduced. This is Vi compatible.
7971 When 'textwidth' is non-zero, this option is not used.
7972 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7973 and less usefully}
7974
7975 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7976'wrapscan' 'ws' boolean (default on) *E384* *E385*
7977 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007978 Searches wrap around the end of the file. Also applies to |]s| and
7979 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007980
7981 *'write'* *'nowrite'*
7982'write' boolean (default on)
7983 global
7984 {not in Vi}
7985 Allows writing files. When not set, writing a file is not allowed.
7986 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007987 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 argument. Filtering text is still possible, even though this requires
7989 writing a temporary file.
7990
7991 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7992'writeany' 'wa' boolean (default off)
7993 global
7994 Allows writing to any file with no need for "!" override.
7995
7996 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7997'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7998 otherwise)
7999 global
8000 {not in Vi}
8001 Make a backup before overwriting a file. The backup is removed after
8002 the file was successfully written, unless the 'backup' option is
8003 also on. Reset this option if your file system is almost full. See
8004 |backup-table| for another explanation.
8005 When the 'backupskip' pattern matches, a backup is not made anyway.
8006 NOTE: This option is set to the default value when 'compatible' is
8007 set.
8008
8009 *'writedelay'* *'wd'*
8010'writedelay' 'wd' number (default 0)
8011 global
8012 {not in Vi}
8013 The number of microseconds to wait for each character sent to the
8014 screen. When non-zero, characters are sent to the terminal one by
8015 one. For MS-DOS pcterm this does not work. For debugging purposes.
8016
8017 vim:tw=78:ts=8:ft=help:norl: