blob: acfbf60240c56695dc9b164be7c35e26f2c52784 [file] [log] [blame]
Bram Moolenaard28478b2010-07-18 23:29:58 +02001*options.txt* For Vim version 7.3b. Last change: 2010 May 13
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
53:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000054 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 'columns' are not changed. {not in Vi}
56
57 *:set-args* *E487* *E521*
58:se[t] {option}={value} or
59:se[t] {option}:{value}
60 Set string or number option to {value}.
61 For numeric options the value can be given in decimal,
62 hex (preceded with 0x) or octal (preceded with '0')
63 (hex and octal are only available for machines which
64 have the strtol() function).
65 The old value can be inserted by typing 'wildchar' (by
66 default this is a <Tab> or CTRL-E if 'compatible' is
67 set). See |cmdline-completion|.
68 White space between {option} and '=' is allowed and
69 will be ignored. White space between '=' and {value}
70 is not allowed.
71 See |option-backslash| for using white space and
72 backslashes in {value}.
73
74:se[t] {option}+={value} *:set+=*
75 Add the {value} to a number option, or append the
76 {value} to a string option. When the option is a
77 comma separated list, a comma is added, unless the
78 value was empty.
79 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000080 are removed. When adding a flag that was already
81 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000082 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 {not in Vi}
84
85:se[t] {option}^={value} *:set^=*
86 Multiply the {value} to a number option, or prepend
87 the {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 Also see |:set-args| above.
91 {not in Vi}
92
93:se[t] {option}-={value} *:set-=*
94 Subtract the {value} from a number option, or remove
95 the {value} from a string option, if it is there.
96 If the {value} is not found in a string option, there
97 is no error or warning. When the option is a comma
98 separated list, a comma is deleted, unless the option
99 becomes empty.
100 When the option is a list of flags, {value} must be
101 exactly as they appear in the option. Remove flags
102 one by one to avoid problems.
103 Also see |:set-args| above.
104 {not in Vi}
105
106The {option} arguments to ":set" may be repeated. For example: >
107 :set ai nosi sw=3 ts=3
108If you make an error in one of the arguments, an error message will be given
109and the following arguments will be ignored.
110
111 *:set-verbose*
112When 'verbose' is non-zero, displaying an option value will also tell where it
113was last set. Example: >
114 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000115< shiftwidth=4 ~
116 Last set from modeline ~
117 cindent ~
118 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
119This is only done when specific option values are requested, not for ":verbose
120set all" or ":verbose set" without an argument.
121When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122When the option was set while executing a function, user command or
123autocommand, the script in which it was defined is reported.
124Note that an option may also have been set as a side effect of setting
125'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000126A few special texts:
127 Last set from modeline ~
128 Option was set in a |modeline|.
129 Last set from --cmd argument ~
130 Option was set with command line argument |--cmd| or +.
131 Last set from -c argument ~
132 Option was set with command line argument |-c|, +, |-S| or
133 |-q|.
134 Last set from environment variable ~
135 Option was set from an environment variable, $VIMINIT,
136 $GVIMINIT or $EXINIT.
137 Last set from error handler ~
138 Option was cleared when evaluating it resulted in an error.
139
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140{not available when compiled without the +eval feature}
141
142 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000143For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144override the value from the termcap. You can then use it in a mapping. If
145the "xx" part contains special characters, use the <t_xx> form: >
146 :set <t_#4>=^[Ot
147This can also be used to translate a special code for a normal key. For
148example, if Alt-b produces <Esc>b, use this: >
149 :set <M-b>=^[b
150(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
151The advantage over a mapping is that it works in all situations.
152
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000153The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
154security reasons.
155
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000157at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158"set all" probably does not fit on the screen, causing Vim to give the
159|more-prompt|.
160
161 *option-backslash*
162To include white space in a string option value it has to be preceded with a
163backslash. To include a backslash you have to use two. Effectively this
164means that the number of backslashes in an option value is halved (rounded
165down).
166A few examples: >
167 :set tags=tags\ /usr/tags results in "tags /usr/tags"
168 :set tags=tags\\,file results in "tags\,file"
169 :set tags=tags\\\ file results in "tags\ file"
170
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000171The "|" character separates a ":set" command from a following command. To
172include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173'titlestring' option to "hi|there": >
174 :set titlestring=hi\|there
175This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
176 :set titlestring=hi|set iconstring=there
177
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000178Similarly, the double quote character starts a comment. To include the '"' in
179the option value, use '\"' instead. This example sets the 'titlestring'
180option to 'hi "there"': >
181 :set titlestring=hi\ \"there\"
182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000183For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184precise: For options that expect a file name (those where environment
185variables are expanded) a backslash before a normal file name character is not
186removed. But a backslash before a special character (space, backslash, comma,
187etc.) is used like explained above.
188There is one special situation, when the value starts with "\\": >
189 :set dir=\\machine\path results in "\\machine\path"
190 :set dir=\\\\machine\\path results in "\\machine\path"
191 :set dir=\\path\\file results in "\\path\file" (wrong!)
192For the first one the start is kept, but for the second one the backslashes
193are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000194halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195result which is probably not what you want. Avoid it.
196
197 *add-option-flags* *remove-option-flags*
198 *E539* *E550* *E551* *E552*
199Some options are a list of flags. When you want to add a flag to such an
200option, without changing the existing ones, you can do it like this: >
201 :set guioptions+=a
202Remove a flag from an option like this: >
203 :set guioptions-=a
204This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000205Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
207doesn't appear.
208
209 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000210Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211environment variable exists the '$' and the following environment variable
212name is replaced with its value. If it does not exist the '$' and the name
213are not modified. Any non-id character (not a letter, digit or '_') may
214follow the environment variable name. That character and what follows is
215appended to the value of the environment variable. Examples: >
216 :set term=$TERM.new
217 :set path=/usr/$INCLUDE,$HOME/include,.
218When adding or removing a string from an option with ":set opt-=val" or ":set
219opt+=val" the expansion is done before the adding or removing.
220
221
222Handling of local options *local-options*
223
224Some of the options only apply to a window or buffer. Each window or buffer
225has its own copy of this option, thus can each have their own value. This
226allows you to set 'list' in one window but not in another. And set
227'shiftwidth' to 3 in one buffer and 4 in another.
228
229The following explains what happens to these local options in specific
230situations. You don't really need to know all of this, since Vim mostly uses
231the option values you would expect. Unfortunately, doing what the user
232expects is a bit complicated...
233
234When splitting a window, the local options are copied to the new window. Thus
235right after the split the contents of the two windows look the same.
236
237When editing a new buffer, its local option values must be initialized. Since
238the local options of the current buffer might be specifically for that buffer,
239these are not used. Instead, for each buffer-local option there also is a
240global value, which is used for new buffers. With ":set" both the local and
241global value is changed. With "setlocal" only the local value is changed,
242thus this value is not used when editing a new buffer.
243
244When editing a buffer that has been edited before, the last used window
245options are used again. If this buffer has been edited in this window, the
246values from back then are used. Otherwise the values from the window where
247the buffer was edited last are used.
248
249It's possible to set a local window option specifically for a type of buffer.
250When you edit another buffer in the same window, you don't want to keep
251using these local window options. Therefore Vim keeps a global value of the
252local window options, which is used when editing another buffer. Each window
253has its own copy of these values. Thus these are local to the window, but
254global to all buffers in the window. With this you can do: >
255 :e one
256 :set list
257 :e two
258Now the 'list' option will also be set in "two", since with the ":set list"
259command you have also set the global value. >
260 :set nolist
261 :e one
262 :setlocal list
263 :e two
264Now the 'list' option is not set, because ":set nolist" resets the global
265value, ":setlocal list" only changes the local value and ":e two" gets the
266global value. Note that if you do this next: >
267 :e one
268You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000269"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270
271 *:setl* *:setlocal*
272:setl[ocal] ... Like ":set" but set only the value local to the
273 current buffer or window. Not all options have a
274 local value. If the option does not have a local
275 value the global value is set.
276 With the "all" argument: display all local option's
277 local values.
278 Without argument: Display all local option's local
279 values which are different from the default.
280 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000281 local value. For a global/local boolean option, when
282 the global value is being used, "--" is displayed
283 before the option name.
284 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285 shown (but that might change in the future).
286 {not in Vi}
287
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000288:setl[ocal] {option}< Set the local value of {option} to its global value by
289 copying the value.
290 {not in Vi}
291
292:se[t] {option}< Set the local value of {option} to its global value by
293 making it empty. Only makes sense for |global-local|
294 options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 {not in Vi}
296
297 *:setg* *:setglobal*
298:setg[lobal] ... Like ":set" but set only the global value for a local
299 option without changing the local value.
300 When displaying an option, the global value is shown.
301 With the "all" argument: display all local option's
302 global values.
303 Without argument: display all local option's global
304 values which are different from the default.
305 {not in Vi}
306
307For buffer-local and window-local options:
308 Command global value local value ~
309 :set option=value set set
310 :setlocal option=value - set
311:setglobal option=value set -
312 :set option? - display
313 :setlocal option? - display
314:setglobal option? display -
315
316
317Global options with a local value *global-local*
318
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000319Options are global when you mostly use one value for all buffers and windows.
320For some global options it's useful to sometimes have a different local value.
321You can set the local value with ":setlocal". That buffer or window will then
322use the local value, while other buffers and windows continue using the global
323value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324
325For example, you have two windows, both on C source code. They use the global
326'makeprg' option. If you do this in one of the two windows: >
327 :set makeprg=gmake
328then the other window will switch to the same value. There is no need to set
329the 'makeprg' option in the other C source window too.
330However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000331another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000332files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333 :setlocal makeprg=perlmake
334You can switch back to using the global value by making the local value empty: >
335 :setlocal makeprg=
336This only works for a string option. For a boolean option you need to use the
337"<" flag, like this: >
338 :setlocal autoread<
339Note that for non-boolean options using "<" copies the global value to the
340local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000341when the global value changes later). You can also use: >
342 :set path<
343This will make the local value of 'path' empty, so that the global value is
344used. Thus it does the same as: >
345 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346Note: In the future more global options can be made global-local. Using
347":setlocal" on a global option might work differently then.
348
349
350Setting the filetype
351
352:setf[iletype] {filetype} *:setf* *:setfiletype*
353 Set the 'filetype' option to {filetype}, but only if
354 not done yet in a sequence of (nested) autocommands.
355 This is short for: >
356 :if !did_filetype()
357 : setlocal filetype={filetype}
358 :endif
359< This command is used in a filetype.vim file to avoid
360 setting the 'filetype' option twice, causing different
361 settings and syntax files to be loaded.
362 {not in Vi}
363
364:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
365:opt[ions] Open a window for viewing and setting all options.
366 Options are grouped by function.
367 Offers short help for each option. Hit <CR> on the
368 short help to open a help window with more help for
369 the option.
370 Modify the value of the option and hit <CR> on the
371 "set" line to set the new value. For window and
372 buffer specific options, the last accessed window is
373 used to set the option value in, unless this is a help
374 window, in which case the window below help window is
375 used (skipping the option-window).
376 {not available when compiled without the |+eval| or
377 |+autocmd| features}
378
379 *$HOME*
380Using "~" is like using "$HOME", but it is only recognized at the start of an
381option and after a space or comma.
382
383On Unix systems "~user" can be used too. It is replaced by the home directory
384of user "user". Example: >
385 :set path=~mool/include,/usr/include,.
386
387On Unix systems the form "${HOME}" can be used too. The name between {} can
388contain non-id characters then. Note that if you want to use this for the
389"gf" command, you need to add the '{' and '}' characters to 'isfname'.
390
391NOTE: expanding environment variables and "~/" is only done with the ":set"
392command, not when assigning a value to an option with ":let".
393
394
395Note the maximum length of an expanded option is limited. How much depends on
396the system, mostly it is something like 256 or 1024 characters.
397
398 *:fix* *:fixdel*
399:fix[del] Set the value of 't_kD':
400 't_kb' is 't_kD' becomes ~
401 CTRL-? CTRL-H
402 not CTRL-? CTRL-?
403
404 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
405
406 If your delete key terminal code is wrong, but the
407 code for backspace is alright, you can put this in
408 your .vimrc: >
409 :fixdel
410< This works no matter what the actual code for
411 backspace is.
412
413 If the backspace key terminal code is wrong you can
414 use this: >
415 :if &term == "termname"
416 : set t_kb=^V<BS>
417 : fixdel
418 :endif
419< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000420 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421 with your terminal name.
422
423 If your <Delete> key sends a strange key sequence (not
424 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
425 :if &term == "termname"
426 : set t_kD=^V<Delete>
427 :endif
428< Where "^V" is CTRL-V and "<Delete>" is the delete key
429 (don't type eight characters!). Replace "termname"
430 with your terminal name.
431
432 *Linux-backspace*
433 Note about Linux: By default the backspace key
434 produces CTRL-?, which is wrong. You can fix it by
435 putting this line in your rc.local: >
436 echo "keycode 14 = BackSpace" | loadkeys
437<
438 *NetBSD-backspace*
439 Note about NetBSD: If your backspace doesn't produce
440 the right code, try this: >
441 xmodmap -e "keycode 22 = BackSpace"
442< If this works, add this in your .Xmodmap file: >
443 keysym 22 = BackSpace
444< You need to restart for this to take effect.
445
446==============================================================================
4472. Automatically setting options *auto-setting*
448
449Besides changing options with the ":set" command, there are three alternatives
450to set options automatically for one or more files:
451
4521. When starting Vim initializations are read from various places. See
453 |initialization|. Most of them are performed for all editing sessions,
454 and some of them depend on the directory where Vim is started.
455 You can create an initialization file with |:mkvimrc|, |:mkview| and
456 |:mksession|.
4572. If you start editing a new file, the automatic commands are executed.
458 This can be used to set options for files matching a particular pattern and
459 many other things. See |autocommand|.
4603. If you start editing a new file, and the 'modeline' option is on, a
461 number of lines at the beginning and end of the file are checked for
462 modelines. This is explained here.
463
464 *modeline* *vim:* *vi:* *ex:* *E520*
465There are two forms of modelines. The first form:
466 [text]{white}{vi:|vim:|ex:}[white]{options}
467
468[text] any text or empty
469{white} at least one blank character (<Space> or <Tab>)
470{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
471[white] optional white space
472{options} a list of option settings, separated with white space or ':',
473 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000474 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000476Example:
477 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478
479The second form (this is compatible with some versions of Vi):
480
481 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
482
483[text] any text or empty
484{white} at least one blank character (<Space> or <Tab>)
485{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
486[white] optional white space
487se[t] the string "set " or "se " (note the space)
488{options} a list of options, separated with white space, which is the
489 argument for a ":set" command
490: a colon
491[text] any text or empty
492
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000493Example:
494 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495
496The white space before {vi:|vim:|ex:} is required. This minimizes the chance
497that a normal word like "lex:" is caught. There is one exception: "vi:" and
498"vim:" can also be at the start of the line (for compatibility with version
4993.0). Using "ex:" at the start of the line will be ignored (this could be
500short for "example:").
501
502 *modeline-local*
503The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000504buffer and window that contain the file. Although it's possible to set global
505options from a modeline, this is unusual. If you have two windows open and
506the files in it set the same global option to a different value, the result
507depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000509When editing a file that was already loaded, only the window-local options
510from the modeline are used. Thus if you manually changed a buffer-local
511option after opening the file, it won't be changed if you edit the same buffer
512in another window. But window-local options will be set.
513
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514 *modeline-version*
515If the modeline is only to be used for some versions of Vim, the version
516number can be specified where "vim:" is used:
517 vim{vers}: version {vers} or later
518 vim<{vers}: version before {vers}
519 vim={vers}: version {vers}
520 vim>{vers}: version after {vers}
521{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000522For example, to use a modeline only for Vim 6.0 and later:
523 /* vim600: set foldmethod=marker: */ ~
524To use a modeline for Vim before version 5.7:
525 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526There can be no blanks between "vim" and the ":".
527
528
529The number of lines that are checked can be set with the 'modelines' option.
530If 'modeline' is off or 'modelines' is 0 no lines are checked.
531
532Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000533like:
534 /* vi:ts=4: */ ~
535will give an error message for the trailing "*/". This line is OK:
536 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538If an error is detected the rest of the line is skipped.
539
540If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000541backslash in front of the ':' will be removed. Example:
542 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543This sets the 'dir' option to "c:\tmp". Only a single backslash before the
544':' is removed. Thus to include "\:" you have to specify "\\:".
545
546No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000547might create a Trojan horse text file with modelines). And not all options
548can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000549|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000550causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
551are wrapped unexpectedly. So disable modelines before editing untrusted text.
552The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553
554Hint: If you would like to do something else than setting an option, you could
555define an autocommand that checks the file for a specific string. For
556example: >
557 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
558And define a function SetVar() that does something with the line containing
559"VAR".
560
561==============================================================================
5623. Options summary *option-summary*
563
564In the list below all the options are mentioned with their full name and with
565an abbreviation if there is one. Both forms may be used.
566
567In this document when a boolean option is "set" that means that ":set option"
568is entered. When an option is "reset", ":set nooption" is used.
569
570For some options there are two default values: The "Vim default", which is
571used when 'compatible' is not set, and the "Vi default", which is used when
572'compatible' is set.
573
574Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000575are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576different value in each window. For example the 'list' option can be set in
577one window and reset in another for the same text, giving both types of view
578at the same time. There are a few options that are specific to a certain
579file. These can have a different value for each file or buffer. For example
580the 'textwidth' option can be 78 for a normal text file and 0 for a C
581program.
582
583 global one option for all buffers and windows
584 local to window each window has its own copy of this option
585 local to buffer each buffer has its own copy of this option
586
587When creating a new window the option values from the currently active window
588are used as a default value for the window-specific options. For the
589buffer-specific options this depends on the 's' and 'S' flags in the
590'cpoptions' option. If 's' is included (which is the default) the values for
591buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000592first entered. If 'S' is present the options are copied each time the buffer
593is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594present, the options are copied from the currently active buffer when the
595buffer is created.
596
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000597Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000599Not all options are supported in all versions. This depends on the supported
600features and sometimes on the system. A remark about this is in curly braces
601below. When an option is not supported it may still be set without getting an
602error, this is called a hidden option. You can't get the value of a hidden
603option though, it is not stored.
604
605To test if option "foo" can be used with ":set" use something like this: >
606 if exists('&foo')
607This also returns true for a hidden option. To test if option "foo" is really
608supported use something like this: >
609 if exists('+foo')
610<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 *E355*
612A jump table for the options with a short description can be found at |Q_op|.
613
614 *'aleph'* *'al'* *aleph* *Aleph*
615'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
616 global
617 {not in Vi}
618 {only available when compiled with the |+rightleft|
619 feature}
620 The ASCII code for the first letter of the Hebrew alphabet. The
621 routine that maps the keyboard in Hebrew mode, both in Insert mode
622 (when hkmap is set) and on the command-line (when hitting CTRL-_)
623 outputs the Hebrew characters in the range [aleph..aleph+26].
624 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
625 See |rileft.txt|.
626
627 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
628'allowrevins' 'ari' boolean (default off)
629 global
630 {not in Vi}
631 {only available when compiled with the |+rightleft|
632 feature}
633 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
634 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
635 into reverse Insert mode, and don't know how to get out. See
636 'revins'.
637 NOTE: This option is reset when 'compatible' is set.
638
639 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
640'altkeymap' 'akm' boolean (default off)
641 global
642 {not in Vi}
643 {only available when compiled with the |+farsi|
644 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000645 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 the keyboard map between Farsi and English, when 'allowrevins' set.
647
Bram Moolenaar582fd852005-03-28 20:58:01 +0000648 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 is useful to start the Vim in native mode i.e. English (left-to-right
650 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000651 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
653 *'ambiwidth'* *'ambw'*
654'ambiwidth' 'ambw' string (default: "single")
655 global
656 {not in Vi}
657 {only available when compiled with the |+multi_byte|
658 feature}
659 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
660 Tells Vim what to do with characters with East Asian Width Class
661 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
662 letters, Cyrillic letters).
663
664 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000665 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 expected by most users.
667 "double": Use twice the width of ASCII characters.
668
669 There are a number of CJK fonts for which the width of glyphs for
670 those characters are solely based on how many octets they take in
671 legacy/traditional CJK encodings. In those encodings, Euro,
672 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000673 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000675 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 Vim is running inside a terminal (emulators) that uses a CJK font
677 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
678 this option should be set to "double" to match the width perceived
679 by Vim with the width of glyphs in the font. Perhaps it also has
680 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
681 when the system locale is set to one of CJK locales. See Unicode
682 Standard Annex #11 (http://www.unicode.org/reports/tr11).
683
684 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
685'antialias' 'anti' boolean (default: off)
686 global
687 {not in Vi}
688 {only available when compiled with GUI enabled
689 on Mac OS X}
690 This option only has an effect in the GUI version of Vim on Mac OS X
691 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
692 which can be easier to read at certain sizes on certain displays.
693 Setting this option can sometimes cause problems if 'guifont' is set
694 to its default (empty string).
695
696 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
697'autochdir' 'acd' boolean (default off)
698 global
699 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200700 {only available when compiled with it, use
701 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000702 When on, Vim will change the current working directory whenever you
703 open a file, switch buffers, delete a buffer or open/close a window.
704 It will change to the directory containing the file which was opened
705 or selected.
706 This option is provided for backward compatibility with the Vim
707 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000708 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709
710 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
711'arabic' 'arab' boolean (default off)
712 local to window
713 {not in Vi}
714 {only available when compiled with the |+arabic|
715 feature}
716 This option can be set to start editing Arabic text.
717 Setting this option will:
718 - Set the 'rightleft' option, unless 'termbidi' is set.
719 - Set the 'arabicshape' option, unless 'termbidi' is set.
720 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
721 between typing English and Arabic key mapping.
722 - Set the 'delcombine' option
723 Note that 'encoding' must be "utf-8" for working with Arabic text.
724
725 Resetting this option will:
726 - Reset the 'rightleft' option.
727 - Disable the use of 'keymap' (without changing its value).
728 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
729 option.
730 Also see |arabic.txt|.
731
732 *'arabicshape'* *'arshape'*
733 *'noarabicshape'* *'noarshape'*
734'arabicshape' 'arshape' boolean (default on)
735 global
736 {not in Vi}
737 {only available when compiled with the |+arabic|
738 feature}
739 When on and 'termbidi' is off, the required visual character
740 corrections that need to take place for displaying the Arabic language
741 take affect. Shaping, in essence, gets enabled; the term is a broad
742 one which encompasses:
743 a) the changing/morphing of characters based on their location
744 within a word (initial, medial, final and stand-alone).
745 b) the enabling of the ability to compose characters
746 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100747 When disabled the display shows each character's true stand-alone
748 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 Arabic is a complex language which requires other settings, for
750 further details see |arabic.txt|.
751
752 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
753'autoindent' 'ai' boolean (default off)
754 local to buffer
755 Copy indent from current line when starting a new line (typing <CR>
756 in Insert mode or when using the "o" or "O" command). If you do not
757 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000758 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
759 to another line has the same effect, unless the 'I' flag is included
760 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000761 When autoindent is on, formatting (with the "gq" command or when you
762 reach 'textwidth' in Insert mode) uses the indentation of the first
763 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 When 'smartindent' or 'cindent' is on the indent is changed in
765 a different way.
766 The 'autoindent' option is reset when the 'paste' option is set.
767 {small difference from Vi: After the indent is deleted when typing
768 <Esc> or <CR>, the cursor position when moving up or down is after the
769 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
770
771 *'autoread'* *'ar'* *'noautoread'* *'noar'*
772'autoread' 'ar' boolean (default off)
773 global or local to buffer |global-local|
774 {not in Vi}
775 When a file has been detected to have been changed outside of Vim and
776 it has not been changed inside of Vim, automatically read it again.
777 When the file has been deleted this is not done. |timestamp|
778 If this option has a local value, use this command to switch back to
779 using the global value: >
780 :set autoread<
781<
782 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
783'autowrite' 'aw' boolean (default off)
784 global
785 Write the contents of the file, if it has been modified, on each
786 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000787 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
789 Note that for some commands the 'autowrite' option is not used, see
790 'autowriteall' for that.
791
792 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
793'autowriteall' 'awa' boolean (default off)
794 global
795 {not in Vi}
796 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
797 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
798 Setting this option also implies that Vim behaves like 'autowrite' has
799 been set.
800
801 *'background'* *'bg'*
802'background' 'bg' string (default "dark" or "light")
803 global
804 {not in Vi}
805 When set to "dark", Vim will try to use colors that look good on a
806 dark background. When set to "light", Vim will try to use colors that
807 look good on a light background. Any other value is illegal.
808 Vim tries to set the default value according to the terminal used.
809 This will not always be correct.
810 Setting this option does not change the background color, it tells Vim
811 what the background color looks like. For changing the background
812 color, see |:hi-normal|.
813
814 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000815 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000816 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100817 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 setting 'background' will cause the color scheme to be reloaded. If
819 the color scheme adjusts to the value of 'background' this will work.
820 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100821 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822
823 When setting 'background' to the default value with: >
824 :set background&
825< Vim will guess the value. In the GUI this should work correctly,
826 in other cases Vim might not be able to guess the right value.
827
828 When starting the GUI, the default value for 'background' will be
829 "light". When the value is not set in the .gvimrc, and Vim detects
830 that the background is actually quite dark, 'background' is set to
831 "dark". But this happens only AFTER the .gvimrc file has been read
832 (because the window needs to be opened to find the actual background
833 color). To get around this, force the GUI window to be opened by
834 putting a ":gui" command in the .gvimrc file, before where the value
835 of 'background' is used (e.g., before ":syntax on").
836 Normally this option would be set in the .vimrc file. Possibly
837 depending on the terminal name. Example: >
838 :if &term == "pcterm"
839 : set background=dark
840 :endif
841< When this option is set, the default settings for the highlight groups
842 will change. To use other settings, place ":highlight" commands AFTER
843 the setting of the 'background' option.
844 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
845 to select the colors for syntax highlighting. After changing this
846 option, you must load syntax.vim again to see the result. This can be
847 done with ":syntax on".
848
849 *'backspace'* *'bs'*
850'backspace' 'bs' string (default "")
851 global
852 {not in Vi}
853 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
854 mode. This is a list of items, separated by commas. Each item allows
855 a way to backspace over something:
856 value effect ~
857 indent allow backspacing over autoindent
858 eol allow backspacing over line breaks (join lines)
859 start allow backspacing over the start of insert; CTRL-W and CTRL-U
860 stop once at the start of insert.
861
862 When the value is empty, Vi compatible backspacing is used.
863
864 For backwards compatibility with version 5.4 and earlier:
865 value effect ~
866 0 same as ":set backspace=" (Vi compatible)
867 1 same as ":set backspace=indent,eol"
868 2 same as ":set backspace=indent,eol,start"
869
870 See |:fixdel| if your <BS> or <Del> key does not do what you want.
871 NOTE: This option is set to "" when 'compatible' is set.
872
873 *'backup'* *'bk'* *'nobackup'* *'nobk'*
874'backup' 'bk' boolean (default off)
875 global
876 {not in Vi}
877 Make a backup before overwriting a file. Leave it around after the
878 file has been successfully written. If you do not want to keep the
879 backup file, but you do want a backup while the file is being
880 written, reset this option and set the 'writebackup' option (this is
881 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000882 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 |backup-table| for more explanations.
884 When the 'backupskip' pattern matches, a backup is not made anyway.
885 When 'patchmode' is set, the backup may be renamed to become the
886 oldest version of a file.
887 NOTE: This option is reset when 'compatible' is set.
888
889 *'backupcopy'* *'bkc'*
890'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
891 global
892 {not in Vi}
893 When writing a file and a backup is made, this option tells how it's
894 done. This is a comma separated list of words.
895
896 The main values are:
897 "yes" make a copy of the file and overwrite the original one
898 "no" rename the file and write a new one
899 "auto" one of the previous, what works best
900
901 Extra values that can be combined with the ones above are:
902 "breaksymlink" always break symlinks when writing
903 "breakhardlink" always break hardlinks when writing
904
905 Making a copy and overwriting the original file:
906 - Takes extra time to copy the file.
907 + When the file has special attributes, is a (hard/symbolic) link or
908 has a resource fork, all this is preserved.
909 - When the file is a link the backup will have the name of the link,
910 not of the real file.
911
912 Renaming the file and writing a new one:
913 + It's fast.
914 - Sometimes not all attributes of the file can be copied to the new
915 file.
916 - When the file is a link the new file will not be a link.
917
918 The "auto" value is the middle way: When Vim sees that renaming file
919 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000920 the file is not a link) that is used. When problems are expected, a
921 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922
923 The "breaksymlink" and "breakhardlink" values can be used in
924 combination with any of "yes", "no" and "auto". When included, they
925 force Vim to always break either symbolic or hard links by doing
926 exactly what the "no" option does, renaming the original file to
927 become the backup and writing a new file in its place. This can be
928 useful for example in source trees where all the files are symbolic or
929 hard links and any changes should stay in the local source tree, not
930 be propagated back to the original source.
931 *crontab*
932 One situation where "no" and "auto" will cause problems: A program
933 that opens a file, invokes Vim to edit that file, and then tests if
934 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000935 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 example.
937
938 When a copy is made, the original file is truncated and then filled
939 with the new text. This means that protection bits, owner and
940 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000941 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 group of the backup is set to the group of the original file. If this
943 fails, the protection bits for the group are made the same as for
944 others.
945
946 When the file is renamed this is the other way around: The backup has
947 the same attributes of the original file, and the newly written file
948 is owned by the current user. When the file was a (hard/symbolic)
949 link, the new file will not! That's why the "auto" value doesn't
950 rename when the file is a link. The owner and group of the newly
951 written file will be set to the same ones as the original file, but
952 the system may refuse to do this. In that case the "auto" value will
953 again not rename the file.
954
955 *'backupdir'* *'bdir'*
956'backupdir' 'bdir' string (default for Amiga: ".,t:",
957 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
958 for Unix: ".,~/tmp,~/")
959 global
960 {not in Vi}
961 List of directories for the backup file, separated with commas.
962 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100963 where this is possible. The directory must exist, Vim will not
964 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 - Empty means that no backup file will be created ('patchmode' is
966 impossible!). Writing may fail because of this.
967 - A directory "." means to put the backup file in the same directory
968 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000969 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 put the backup file relative to where the edited file is. The
971 leading "." is replaced with the path name of the edited file.
972 ("." inside a directory name has no special meaning).
973 - Spaces after the comma are ignored, other spaces are considered part
974 of the directory name. To have a space at the start of a directory
975 name, precede it with a backslash.
976 - To include a comma in a directory name precede it with a backslash.
977 - A directory name may end in an '/'.
978 - Environment variables are expanded |:set_env|.
979 - Careful with '\' characters, type one before a space, type two to
980 get one in the option (see |option-backslash|), for example: >
981 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
982< - For backwards compatibility with Vim version 3.0 a '>' at the start
983 of the option is removed.
984 See also 'backup' and 'writebackup' options.
985 If you want to hide your backup files on Unix, consider this value: >
986 :set backupdir=./.backup,~/.backup,.,/tmp
987< You must create a ".backup" directory in each directory and in your
988 home directory for this to work properly.
989 The use of |:set+=| and |:set-=| is preferred when adding or removing
990 directories from the list. This avoids problems when a future version
991 uses another default.
992 This option cannot be set from a |modeline| or in the |sandbox|, for
993 security reasons.
994
995 *'backupext'* *'bex'* *E589*
996'backupext' 'bex' string (default "~", for VMS: "_")
997 global
998 {not in Vi}
999 String which is appended to a file name to make the name of the
1000 backup file. The default is quite unusual, because this avoids
1001 accidentally overwriting existing files with a backup file. You might
1002 prefer using ".bak", but make sure that you don't have files with
1003 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001004 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001006 If you like to keep a lot of backups, you could use a BufWritePre
1007 autocommand to change 'backupext' just before writing the file to
1008 include a timestamp. >
1009 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1010< Use 'backupdir' to put the backup in a different directory.
1011
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 *'backupskip'* *'bsk'*
1013'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1014 global
1015 {not in Vi}
1016 {not available when compiled without the |+wildignore|
1017 feature}
1018 A list of file patterns. When one of the patterns matches with the
1019 name of the file which is written, no backup file is created. Both
1020 the specified file name and the full path name of the file are used.
1021 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1022 Watch out for special characters, see |option-backslash|.
1023 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001024 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001025
1026 Note that environment variables are not expanded. If you want to use
1027 $HOME you must expand it explicitly, e.g.: >
1028 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1029
1030< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001031 backup would be made by renaming the original file crontab won't see
1032 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033
1034 *'balloondelay'* *'bdlay'*
1035'balloondelay' 'bdlay' number (default: 600)
1036 global
1037 {not in Vi}
1038 {only available when compiled with the |+balloon_eval|
1039 feature}
1040 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1041
1042 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1043'ballooneval' 'beval' boolean (default off)
1044 global
1045 {not in Vi}
1046 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001047 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 Switch on the |balloon-eval| functionality.
1049
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001050 *'balloonexpr'* *'bexpr'*
1051'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001052 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001053 {not in Vi}
1054 {only available when compiled with the |+balloon_eval|
1055 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001056 Expression for text to show in evaluation balloon. It is only used
1057 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001058
1059 v:beval_bufnr number of the buffer in which balloon is going to show
1060 v:beval_winnr number of the window
1061 v:beval_lnum line number
1062 v:beval_col column number (byte index)
1063 v:beval_text word under or after the mouse pointer
1064
1065 The evaluation of the expression must not have side effects!
1066 Example: >
1067 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001068 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001069 \', column ' . v:beval_col .
1070 \ ' of file ' . bufname(v:beval_bufnr) .
1071 \ ' on word "' . v:beval_text . '"'
1072 endfunction
1073 set bexpr=MyBalloonExpr()
1074 set ballooneval
1075<
1076 NOTE: The balloon is displayed only if the cursor is on a text
1077 character. If the result of evaluating 'balloonexpr' is not empty,
1078 Vim does not try to send a message to an external debugger (Netbeans
1079 or Sun Workshop).
1080
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001081 The expression may be evaluated in the |sandbox|, see
1082 |sandbox-option|.
1083
1084 It is not allowed to change text or jump to another window while
1085 evaluating 'balloonexpr' |textlock|.
1086
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001087 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001088 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001089< When they are supported "\n" characters will start a new line. If the
1090 expression evaluates to a |List| this is equal to using each List item
1091 as a string and putting "\n" in between them.
1092
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1094'binary' 'bin' boolean (default off)
1095 local to buffer
1096 {not in Vi}
1097 This option should be set before editing a binary file. You can also
1098 use the |-b| Vim argument. When this option is switched on a few
1099 options will be changed (also when it already was on):
1100 'textwidth' will be set to 0
1101 'wrapmargin' will be set to 0
1102 'modeline' will be off
1103 'expandtab' will be off
1104 Also, 'fileformat' and 'fileformats' options will not be used, the
1105 file is read and written like 'fileformat' was "unix" (a single <NL>
1106 separates lines).
1107 The 'fileencoding' and 'fileencodings' options will not be used, the
1108 file is read without conversion.
1109 NOTE: When you start editing a(nother) file while the 'bin' option is
1110 on, settings from autocommands may change the settings again (e.g.,
1111 'textwidth'), causing trouble when editing. You might want to set
1112 'bin' again when the file has been loaded.
1113 The previous values of these options are remembered and restored when
1114 'bin' is switched from on to off. Each buffer has its own set of
1115 saved option values.
1116 To edit a file with 'binary' set you can use the |++bin| argument.
1117 This avoids you have to do ":set bin", which would have effect for all
1118 files you edit.
1119 When writing a file the <EOL> for the last line is only written if
1120 there was one in the original file (normally Vim appends an <EOL> to
1121 the last line if there is none; this would make the file longer). See
1122 the 'endofline' option.
1123
1124 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1125'bioskey' 'biosk' boolean (default on)
1126 global
1127 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001128 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129 better to detect CTRL-C, but only works for the console. When using a
1130 terminal over a serial port reset this option.
1131 Also see |'conskey'|.
1132
1133 *'bomb'* *'nobomb'*
1134'bomb' boolean (default off)
1135 local to buffer
1136 {not in Vi}
1137 {only available when compiled with the |+multi_byte|
1138 feature}
1139 When writing a file and the following conditions are met, a BOM (Byte
1140 Order Mark) is prepended to the file:
1141 - this option is on
1142 - the 'binary' option is off
1143 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1144 endian variants.
1145 Some applications use the BOM to recognize the encoding of the file.
1146 Often used for UCS-2 files on MS-Windows. For other applications it
1147 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001148 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1150 check for the presence of the BOM is done and 'bomb' set accordingly.
1151 Unless 'binary' is set, it is removed from the first line, so that you
1152 don't see it when editing. When you don't change the options, the BOM
1153 will be restored when writing the file.
1154
1155 *'breakat'* *'brk'*
1156'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1157 global
1158 {not in Vi}
1159 {not available when compiled without the |+linebreak|
1160 feature}
1161 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001162 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1163 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164
1165 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001166'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001168 {not in Vi} {only for Motif, Athena, GTK, Mac and
1169 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001171 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001172 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 buffer Use the directory of the related buffer.
1174 current Use the current directory.
1175 {path} Use the specified directory
1176
1177 *'bufhidden'* *'bh'*
1178'bufhidden' 'bh' string (default: "")
1179 local to buffer
1180 {not in Vi}
1181 {not available when compiled without the |+quickfix|
1182 feature}
1183 This option specifies what happens when a buffer is no longer
1184 displayed in a window:
1185 <empty> follow the global 'hidden' option
1186 hide hide the buffer (don't unload it), also when 'hidden'
1187 is not set
1188 unload unload the buffer, also when 'hidden' is set or using
1189 |:hide|
1190 delete delete the buffer from the buffer list, also when
1191 'hidden' is set or using |:hide|, like using
1192 |:bdelete|
1193 wipe wipe out the buffer from the buffer list, also when
1194 'hidden' is set or using |:hide|, like using
1195 |:bwipeout|
1196
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001197 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1198 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 This option is used together with 'buftype' and 'swapfile' to specify
1200 special kinds of buffers. See |special-buffers|.
1201
1202 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1203'buflisted' 'bl' boolean (default: on)
1204 local to buffer
1205 {not in Vi}
1206 When this option is set, the buffer shows up in the buffer list. If
1207 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1208 This option is reset by Vim for buffers that are only used to remember
1209 a file name or marks. Vim sets it when starting to edit a buffer.
1210 But not when moving to a buffer with ":buffer".
1211
1212 *'buftype'* *'bt'* *E382*
1213'buftype' 'bt' string (default: "")
1214 local to buffer
1215 {not in Vi}
1216 {not available when compiled without the |+quickfix|
1217 feature}
1218 The value of this option specifies the type of a buffer:
1219 <empty> normal buffer
1220 nofile buffer which is not related to a file and will not be
1221 written
1222 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001223 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001224 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001225 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001227 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228 help help buffer (you are not supposed to set this
1229 manually)
1230
1231 This option is used together with 'bufhidden' and 'swapfile' to
1232 specify special kinds of buffers. See |special-buffers|.
1233
1234 Be careful with changing this option, it can have many side effects!
1235
Bram Moolenaar280f1262006-01-30 00:14:18 +00001236 A "quickfix" buffer is only used for the error list and the location
1237 list. This value is set by the |:cwindow| and |:lwindow| commands and
1238 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239
1240 "nofile" and "nowrite" buffers are similar:
1241 both: The buffer is not to be written to disk, ":w" doesn't
1242 work (":w filename" does work though).
1243 both: The buffer is never considered to be |'modified'|.
1244 There is no warning when the changes will be lost, for
1245 example when you quit Vim.
1246 both: A swap file is only created when using too much memory
1247 (when 'swapfile' has been reset there is never a swap
1248 file).
1249 nofile only: The buffer name is fixed, it is not handled like a
1250 file name. It is not modified in response to a |:cd|
1251 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001252 *E676*
1253 "acwrite" implies that the buffer name is not related to a file, like
1254 "nofile", but it will be written. Thus, in contrast to "nofile" and
1255 "nowrite", ":w" does work and a modified buffer can't be abandoned
1256 without saving. For writing there must be matching |BufWriteCmd|,
1257 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258
1259 *'casemap'* *'cmp'*
1260'casemap' 'cmp' string (default: "internal,keepascii")
1261 global
1262 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001263 {only available when compiled with the |+multi_byte|
1264 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 Specifies details about changing the case of letters. It may contain
1266 these words, separated by a comma:
1267 internal Use internal case mapping functions, the current
1268 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001269 matters when 'encoding' is a Unicode encoding,
1270 "latin1" or "iso-8859-15". When "internal" is
1271 omitted, the towupper() and towlower() system library
1272 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1274 case mapping, the current locale is not effective.
1275 This probably only matters for Turkish.
1276
1277 *'cdpath'* *'cd'* *E344* *E346*
1278'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1279 global
1280 {not in Vi}
1281 {not available when compiled without the
1282 |+file_in_path| feature}
1283 This is a list of directories which will be searched when using the
1284 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001285 for has a relative path, not an absolute part starting with "/", "./"
1286 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 The 'cdpath' option's value has the same form and semantics as
1288 |'path'|. Also see |file-searching|.
1289 The default value is taken from $CDPATH, with a "," prepended to look
1290 in the current directory first.
1291 If the default value taken from $CDPATH is not what you want, include
1292 a modified version of the following command in your vimrc file to
1293 override it: >
1294 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1295< This option cannot be set from a |modeline| or in the |sandbox|, for
1296 security reasons.
1297 (parts of 'cdpath' can be passed to the shell to expand file names).
1298
1299 *'cedit'*
1300'cedit' string (Vi default: "", Vim default: CTRL-F)
1301 global
1302 {not in Vi}
1303 {not available when compiled without the |+vertsplit|
1304 feature}
1305 The key used in Command-line Mode to open the command-line window.
1306 The default is CTRL-F when 'compatible' is off.
1307 Only non-printable keys are allowed.
1308 The key can be specified as a single character, but it is difficult to
1309 type. The preferred way is to use the <> notation. Examples: >
1310 :set cedit=<C-Y>
1311 :set cedit=<Esc>
1312< |Nvi| also has this option, but it only uses the first character.
1313 See |cmdwin|.
1314
1315 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1316'charconvert' 'ccv' string (default "")
1317 global
1318 {only available when compiled with the |+multi_byte|
1319 feature and the |+eval| feature}
1320 {not in Vi}
1321 An expression that is used for character encoding conversion. It is
1322 evaluated when a file that is to be read or has been written has a
1323 different encoding from what is desired.
1324 'charconvert' is not used when the internal iconv() function is
1325 supported and is able to do the conversion. Using iconv() is
1326 preferred, because it is much faster.
1327 'charconvert' is not used when reading stdin |--|, because there is no
1328 file to convert from. You will have to save the text in a file first.
1329 The expression must return zero or an empty string for success,
1330 non-zero for failure.
1331 The possible encoding names encountered are in 'encoding'.
1332 Additionally, names given in 'fileencodings' and 'fileencoding' are
1333 used.
1334 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1335 is done internally by Vim, 'charconvert' is not used for this.
1336 'charconvert' is also used to convert the viminfo file, if the 'c'
1337 flag is present in 'viminfo'. Also used for Unicode conversion.
1338 Example: >
1339 set charconvert=CharConvert()
1340 fun CharConvert()
1341 system("recode "
1342 \ . v:charconvert_from . ".." . v:charconvert_to
1343 \ . " <" . v:fname_in . " >" v:fname_out)
1344 return v:shell_error
1345 endfun
1346< The related Vim variables are:
1347 v:charconvert_from name of the current encoding
1348 v:charconvert_to name of the desired encoding
1349 v:fname_in name of the input file
1350 v:fname_out name of the output file
1351 Note that v:fname_in and v:fname_out will never be the same.
1352 Note that v:charconvert_from and v:charconvert_to may be different
1353 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1354 Encryption is not done by Vim when using 'charconvert'. If you want
1355 to encrypt the file after conversion, 'charconvert' should take care
1356 of this.
1357 This option cannot be set from a |modeline| or in the |sandbox|, for
1358 security reasons.
1359
1360 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1361'cindent' 'cin' boolean (default off)
1362 local to buffer
1363 {not in Vi}
1364 {not available when compiled without the |+cindent|
1365 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001366 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 that trigger reindenting in insert mode and 'cinoptions' to set your
1368 preferred indent style.
1369 If 'indentexpr' is not empty, it overrules 'cindent'.
1370 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1371 the "=" operator indents using this algorithm rather than calling an
1372 external program.
1373 See |C-indenting|.
1374 When you don't like the way 'cindent' works, try the 'smartindent'
1375 option or 'indentexpr'.
1376 This option is not used when 'paste' is set.
1377 NOTE: This option is reset when 'compatible' is set.
1378
1379 *'cinkeys'* *'cink'*
1380'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1381 local to buffer
1382 {not in Vi}
1383 {not available when compiled without the |+cindent|
1384 feature}
1385 A list of keys that, when typed in Insert mode, cause reindenting of
1386 the current line. Only used if 'cindent' is on and 'indentexpr' is
1387 empty.
1388 For the format of this option see |cinkeys-format|.
1389 See |C-indenting|.
1390
1391 *'cinoptions'* *'cino'*
1392'cinoptions' 'cino' string (default "")
1393 local to buffer
1394 {not in Vi}
1395 {not available when compiled without the |+cindent|
1396 feature}
1397 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1398 program. See |cinoptions-values| for the values of this option, and
1399 |C-indenting| for info on C indenting in general.
1400
1401
1402 *'cinwords'* *'cinw'*
1403'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1404 local to buffer
1405 {not in Vi}
1406 {not available when compiled without both the
1407 |+cindent| and the |+smartindent| features}
1408 These keywords start an extra indent in the next line when
1409 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1410 an appropriate place (inside {}).
1411 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1412 matter, include the keyword both the uppercase and lowercase:
1413 "if,If,IF".
1414
1415 *'clipboard'* *'cb'*
1416'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1417 for X-windows, "" otherwise)
1418 global
1419 {not in Vi}
1420 {only in GUI versions or when the |+xterm_clipboard|
1421 feature is included}
1422 This option is a list of comma separated names.
1423 These names are recognized:
1424
1425 unnamed When included, Vim will use the clipboard register '*'
1426 for all yank, delete, change and put operations which
1427 would normally go to the unnamed register. When a
1428 register is explicitly specified, it will always be
1429 used regardless of whether "unnamed" is in 'clipboard'
1430 or not. The clipboard register can always be
1431 explicitly accessed using the "* notation. Also see
1432 |gui-clipboard|.
1433
1434 autoselect Works like the 'a' flag in 'guioptions': If present,
1435 then whenever Visual mode is started, or the Visual
1436 area extended, Vim tries to become the owner of the
1437 windowing system's global selection or put the
1438 selected text on the clipboard used by the selection
1439 register "*. See |guioptions_a| and |quotestar| for
1440 details. When the GUI is active, the 'a' flag in
1441 'guioptions' is used, when the GUI is not active, this
1442 "autoselect" flag is used.
1443 Also applies to the modeless selection.
1444
1445 autoselectml Like "autoselect", but for the modeless selection
1446 only. Compare to the 'A' flag in 'guioptions'.
1447
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001448 html When the clipboard contains HTML, use this when
1449 pasting. When putting text on the clipboard, mark it
1450 as HTML. This works to copy rendered HTML from
1451 Firefox, paste it as raw HTML in Vim, select the HTML
1452 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001453 You probably want to add this only temporarily,
1454 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001455 Only supported for GTK version 2 and later.
1456 Only available with the |+multi_byte| feature.
1457
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458 exclude:{pattern}
1459 Defines a pattern that is matched against the name of
1460 the terminal 'term'. If there is a match, no
1461 connection will be made to the X server. This is
1462 useful in this situation:
1463 - Running Vim in a console.
1464 - $DISPLAY is set to start applications on another
1465 display.
1466 - You do not want to connect to the X server in the
1467 console, but do want this in a terminal emulator.
1468 To never connect to the X server use: >
1469 exclude:.*
1470< This has the same effect as using the |-X| argument.
1471 Note that when there is no connection to the X server
1472 the window title won't be restored and the clipboard
1473 cannot be accessed.
1474 The value of 'magic' is ignored, {pattern} is
1475 interpreted as if 'magic' was on.
1476 The rest of the option value will be used for
1477 {pattern}, this must be the last entry.
1478
1479 *'cmdheight'* *'ch'*
1480'cmdheight' 'ch' number (default 1)
1481 global
1482 {not in Vi}
1483 Number of screen lines to use for the command-line. Helps avoiding
1484 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001485 The value of this option is stored with the tab page, so that each tab
1486 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487
1488 *'cmdwinheight'* *'cwh'*
1489'cmdwinheight' 'cwh' number (default 7)
1490 global
1491 {not in Vi}
1492 {not available when compiled without the |+vertsplit|
1493 feature}
1494 Number of screen lines to use for the command-line window. |cmdwin|
1495
1496 *'columns'* *'co'* *E594*
1497'columns' 'co' number (default 80 or terminal width)
1498 global
1499 {not in Vi}
1500 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001501 initialization and does not have to be set by hand. Also see
1502 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503 When Vim is running in the GUI or in a resizable window, setting this
1504 option will cause the window size to be changed. When you only want
1505 to use the size for the GUI, put the command in your |gvimrc| file.
1506 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001507 number of columns of the display, the display may be messed up. For
1508 the GUI it is always possible and Vim limits the number of columns to
1509 what fits on the screen. You can use this command to get the widest
1510 window possible: >
1511 :set columns=9999
1512< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513
1514 *'comments'* *'com'* *E524* *E525*
1515'comments' 'com' string (default
1516 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1517 local to buffer
1518 {not in Vi}
1519 {not available when compiled without the |+comments|
1520 feature}
1521 A comma separated list of strings that can start a comment line. See
1522 |format-comments|. See |option-backslash| about using backslashes to
1523 insert a space.
1524
1525 *'commentstring'* *'cms'* *E537*
1526'commentstring' 'cms' string (default "/*%s*/")
1527 local to buffer
1528 {not in Vi}
1529 {not available when compiled without the |+folding|
1530 feature}
1531 A template for a comment. The "%s" in the value is replaced with the
1532 comment text. Currently only used to add markers for folding, see
1533 |fold-marker|.
1534
1535 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001536'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1537 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 global
1539 {not in Vi}
1540 This option has the effect of making Vim either more Vi-compatible, or
1541 make Vim behave in a more useful way.
1542 This is a special kind of option, because when it's set or reset,
1543 other options are also changed as a side effect. CAREFUL: Setting or
1544 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001545 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 set this option in your vimrc file, you should probably put it at the
1547 very start.
1548 By default this option is on and the Vi defaults are used for the
1549 options. This default was chosen for those people who want to use Vim
1550 just like Vi, and don't even (want to) know about the 'compatible'
1551 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001552 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001553 this option is switched off, and all options that have not been
1554 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001555 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001556 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001557 happen for the system-wide vimrc or gvimrc file, nor for a file given
1558 with the |-u| argument). Also see |compatible-default| and
1559 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 You can also set this option with the "-C" argument, and reset it with
1561 "-N". See |-C| and |-N|.
1562 Switching this option off makes the Vim defaults be used for options
1563 that have a different Vi and Vim default value. See the options
1564 marked with a '+' below. Other options are not modified.
1565 At the moment this option is set, several other options will be set
1566 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001567 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 editing.
1569 See also 'cpoptions'.
1570
1571 option + set value effect ~
1572
1573 'allowrevins' off no CTRL-_ command
1574 'backupcopy' Unix: "yes" backup file is a copy
1575 others: "auto" copy or rename backup file
1576 'backspace' "" normal backspace
1577 'backup' off no backup file
1578 'cindent' off no C code indentation
1579 'cedit' + "" no key to open the |cmdwin|
1580 'cpoptions' + (all flags) Vi-compatible flags
1581 'cscopetag' off don't use cscope for ":tag"
1582 'cscopetagorder' 0 see |cscopetagorder|
1583 'cscopeverbose' off see |cscopeverbose|
1584 'digraph' off no digraphs
1585 'esckeys' + off no <Esc>-keys in Insert mode
1586 'expandtab' off tabs not expanded to spaces
1587 'fileformats' + "" no automatic file format detection,
1588 "dos,unix" except for DOS, Windows and OS/2
1589 'formatoptions' + "vt" Vi compatible formatting
1590 'gdefault' off no default 'g' flag for ":s"
1591 'history' + 0 no commandline history
1592 'hkmap' off no Hebrew keyboard mapping
1593 'hkmapp' off no phonetic Hebrew keyboard mapping
1594 'hlsearch' off no highlighting of search matches
1595 'incsearch' off no incremental searching
1596 'indentexpr' "" no indenting by expression
1597 'insertmode' off do not start in Insert mode
1598 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1599 characters and '_'
1600 'joinspaces' on insert 2 spaces after period
1601 'modeline' + off no modelines
1602 'more' + off no pauses in listings
1603 'revins' off no reverse insert
1604 'ruler' off no ruler
1605 'scrolljump' 1 no jump scroll
1606 'scrolloff' 0 no scroll offset
1607 'shiftround' off indent not rounded to shiftwidth
1608 'shortmess' + "" no shortening of messages
1609 'showcmd' + off command characters not shown
1610 'showmode' + off current mode not shown
1611 'smartcase' off no automatic ignore case switch
1612 'smartindent' off no smart indentation
1613 'smarttab' off no smart tab size
1614 'softtabstop' 0 tabs are always 'tabstop' positions
1615 'startofline' on goto startofline with some commands
1616 'tagrelative' + off tag file names are not relative
1617 'textauto' + off no automatic textmode detection
1618 'textwidth' 0 no automatic line wrap
1619 'tildeop' off tilde is not an operator
1620 'ttimeout' off no terminal timeout
1621 'whichwrap' + "" left-right movements don't wrap
1622 'wildchar' + CTRL-E only when the current value is <Tab>
1623 use CTRL-E for cmdline completion
1624 'writebackup' on or off depends on +writebackup feature
1625
1626 *'complete'* *'cpt'* *E535*
1627'complete' 'cpt' string (default: ".,w,b,u,t,i")
1628 local to buffer
1629 {not in Vi}
1630 This option specifies how keyword completion |ins-completion| works
1631 when CTRL-P or CTRL-N are used. It is also used for whole-line
1632 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1633 and the places to scan. It is a comma separated list of flags:
1634 . scan the current buffer ('wrapscan' is ignored)
1635 w scan buffers from other windows
1636 b scan other loaded buffers that are in the buffer list
1637 u scan the unloaded buffers that are in the buffer list
1638 U scan the buffers that are not in the buffer list
1639 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001640 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 k{dict} scan the file {dict}. Several "k" flags can be given,
1642 patterns are valid too. For example: >
1643 :set cpt=k/usr/dict/*,k~/spanish
1644< s scan the files given with the 'thesaurus' option
1645 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1646 are valid too.
1647 i scan current and included files
1648 d scan current and included files for defined name or macro
1649 |i_CTRL-X_CTRL-D|
1650 ] tag completion
1651 t same as "]"
1652
1653 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1654 not executed, this may lead to unexpected completions from some files
1655 (gzipped files for example). Unloaded buffers are not scanned for
1656 whole-line completion.
1657
1658 The default is ".,w,b,u,t,i", which means to scan:
1659 1. the current buffer
1660 2. buffers in other windows
1661 3. other loaded buffers
1662 4. unloaded buffers
1663 5. tags
1664 6. included files
1665
1666 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001667 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1668 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001670 *'completefunc'* *'cfu'*
1671'completefunc' 'cfu' string (default: empty)
1672 local to buffer
1673 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001674 {not available when compiled without the +eval
1675 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001676 This option specifies a function to be used for Insert mode completion
1677 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001678 See |complete-functions| for an explanation of how the function is
1679 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001680
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001681
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001682 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001683'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001684 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001685 {not available when compiled without the
1686 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001687 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001688 A comma separated list of options for Insert mode completion
1689 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001690
1691 menu Use a popup menu to show the possible completions. The
1692 menu is only shown when there is more than one match and
1693 sufficient colors are available. |ins-completion-menu|
1694
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001695 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001696 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001697 match, e.g., what file it comes from.
1698
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001699 longest Only insert the longest common text of the matches. If
1700 the menu is displayed you can use CTRL-L to add more
1701 characters. Whether case is ignored depends on the kind
1702 of completion. For buffer text the 'ignorecase' option is
1703 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001704
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001705 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001706 completion in the preview window. Only works in
1707 combination with "menu" or "menuone".
1708
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001709
Bram Moolenaar860cae12010-06-05 23:22:07 +02001710'conceallevel' 'conc' *'conceallevel'* *'conc'*
1711 number (default 0)
1712 local to window
1713 {not in Vi}
1714 {not available when compiled without the |+conceal|
1715 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001716 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1717 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001718
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001719 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001720 0 Text is shown normally
1721 1 Each block of concealed text is replaced with the
1722 character defined in 'listchars' (default is a dash)
1723 and highlighted with the "Conceal" highlight group.
1724 2 Concealed text is completely hidden unless it has a
1725 custom replacement character defined (see
1726 |:syn-cchar|.
Bram Moolenaara7781e02010-07-19 20:13:22 +02001727 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001728
Bram Moolenaara7781e02010-07-19 20:13:22 +02001729 Note: in the cursor line concealed text is not hidden, so that you can
1730 edit and copy the text.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001731
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1733'confirm' 'cf' boolean (default off)
1734 global
1735 {not in Vi}
1736 When 'confirm' is on, certain operations that would normally
1737 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1738 instead raise a |dialog| asking if you wish to save the current
1739 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1740 If 'confirm' is off you can still activate confirmation for one
1741 command only (this is most useful in mappings) with the |:confirm|
1742 command.
1743 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1744
1745 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1746'conskey' 'consk' boolean (default off)
1747 global
1748 {not in Vi} {only for MS-DOS}
1749 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001750 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751 three methods of console input are available:
1752 'conskey' 'bioskey' action ~
1753 on on or off direct console input
1754 off on BIOS
1755 off off STDIN
1756
1757 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1758'copyindent' 'ci' boolean (default off)
1759 local to buffer
1760 {not in Vi}
1761 Copy the structure of the existing lines indent when autoindenting a
1762 new line. Normally the new indent is reconstructed by a series of
1763 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1764 in which case only spaces are used). Enabling this option makes the
1765 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001766 existing line. 'expandtab' has no effect on these characters, a Tab
1767 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768 line, the remaining space is filled in the normal manner.
1769 NOTE: 'copyindent' is reset when 'compatible' is set.
1770 Also see 'preserveindent'.
1771
1772 *'cpoptions'* *'cpo'*
1773'cpoptions' 'cpo' string (Vim default: "aABceFs",
1774 Vi default: all flags)
1775 global
1776 {not in Vi}
1777 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001778 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 not being vi-compatible is mostly or sometimes preferred.
1780 'cpoptions' stands for "compatible-options".
1781 Commas can be added for readability.
1782 To avoid problems with flags that are added in the future, use the
1783 "+=" and "-=" feature of ":set" |add-option-flags|.
1784 NOTE: This option is set to the Vi default value when 'compatible' is
1785 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001786 NOTE: This option is set to the POSIX default value at startup when
1787 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001788 variable exists |posix|. This means Vim tries to behave like the
1789 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790
1791 contains behavior ~
1792 *cpo-a*
1793 a When included, a ":read" command with a file name
1794 argument will set the alternate file name for the
1795 current window.
1796 *cpo-A*
1797 A When included, a ":write" command with a file name
1798 argument will set the alternate file name for the
1799 current window.
1800 *cpo-b*
1801 b "\|" in a ":map" command is recognized as the end of
1802 the map command. The '\' is included in the mapping,
1803 the text after the '|' is interpreted as the next
1804 command. Use a CTRL-V instead of a backslash to
1805 include the '|' in the mapping. Applies to all
1806 mapping, abbreviation, menu and autocmd commands.
1807 See also |map_bar|.
1808 *cpo-B*
1809 B A backslash has no special meaning in mappings,
1810 abbreviations and the "to" part of the menu commands.
1811 Remove this flag to be able to use a backslash like a
1812 CTRL-V. For example, the command ":map X \<Esc>"
1813 results in X being mapped to:
1814 'B' included: "\^[" (^[ is a real <Esc>)
1815 'B' excluded: "<Esc>" (5 characters)
1816 ('<' excluded in both cases)
1817 *cpo-c*
1818 c Searching continues at the end of any match at the
1819 cursor position, but not further than the start of the
1820 next line. When not present searching continues
1821 one character from the cursor position. With 'c'
1822 "abababababab" only gets three matches when repeating
1823 "/abab", without 'c' there are five matches.
1824 *cpo-C*
1825 C Do not concatenate sourced lines that start with a
1826 backslash. See |line-continuation|.
1827 *cpo-d*
1828 d Using "./" in the 'tags' option doesn't mean to use
1829 the tags file relative to the current file, but the
1830 tags file in the current directory.
1831 *cpo-D*
1832 D Can't use CTRL-K to enter a digraph after Normal mode
1833 commands with a character argument, like |r|, |f| and
1834 |t|.
1835 *cpo-e*
1836 e When executing a register with ":@r", always add a
1837 <CR> to the last line, also when the register is not
1838 linewise. If this flag is not present, the register
1839 is not linewise and the last line does not end in a
1840 <CR>, then the last line is put on the command-line
1841 and can be edited before hitting <CR>.
1842 *cpo-E*
1843 E It is an error when using "y", "d", "c", "g~", "gu" or
1844 "gU" on an Empty region. The operators only work when
1845 at least one character is to be operate on. Example:
1846 This makes "y0" fail in the first column.
1847 *cpo-f*
1848 f When included, a ":read" command with a file name
1849 argument will set the file name for the current buffer,
1850 if the current buffer doesn't have a file name yet.
1851 *cpo-F*
1852 F When included, a ":write" command with a file name
1853 argument will set the file name for the current
1854 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001855 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 *cpo-g*
1857 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001858 *cpo-H*
1859 H When using "I" on a line with only blanks, insert
1860 before the last blank. Without this flag insert after
1861 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862 *cpo-i*
1863 i When included, interrupting the reading of a file will
1864 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001865 *cpo-I*
1866 I When moving the cursor up or down just after inserting
1867 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868 *cpo-j*
1869 j When joining lines, only add two spaces after a '.',
1870 not after '!' or '?'. Also see 'joinspaces'.
1871 *cpo-J*
1872 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001873 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874 white space.
1875 *cpo-k*
1876 k Disable the recognition of raw key codes in
1877 mappings, abbreviations, and the "to" part of menu
1878 commands. For example, if <Key> sends ^[OA (where ^[
1879 is <Esc>), the command ":map X ^[OA" results in X
1880 being mapped to:
1881 'k' included: "^[OA" (3 characters)
1882 'k' excluded: "<Key>" (one key code)
1883 Also see the '<' flag below.
1884 *cpo-K*
1885 K Don't wait for a key code to complete when it is
1886 halfway a mapping. This breaks mapping <F1><F1> when
1887 only part of the second <F1> has been read. It
1888 enables cancelling the mapping by typing <F1><Esc>.
1889 *cpo-l*
1890 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001891 literally, only "\]", "\^", "\-" and "\\" are special.
1892 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1894 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001895 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 *cpo-L*
1897 L When the 'list' option is set, 'wrapmargin',
1898 'textwidth', 'softtabstop' and Virtual Replace mode
1899 (see |gR|) count a <Tab> as two characters, instead of
1900 the normal behavior of a <Tab>.
1901 *cpo-m*
1902 m When included, a showmatch will always wait half a
1903 second. When not included, a showmatch will wait half
1904 a second or until a character is typed. |'showmatch'|
1905 *cpo-M*
1906 M When excluded, "%" matching will take backslashes into
1907 account. Thus in "( \( )" and "\( ( \)" the outer
1908 parenthesis match. When included "%" ignores
1909 backslashes, which is Vi compatible.
1910 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001911 n When included, the column used for 'number' and
1912 'relativenumber' will also be used for text of wrapped
1913 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 *cpo-o*
1915 o Line offset to search command is not remembered for
1916 next search.
1917 *cpo-O*
1918 O Don't complain if a file is being overwritten, even
1919 when it didn't exist when editing it. This is a
1920 protection against a file unexpectedly created by
1921 someone else. Vi didn't complain about this.
1922 *cpo-p*
1923 p Vi compatible Lisp indenting. When not present, a
1924 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001925 *cpo-P*
1926 P When included, a ":write" command that appends to a
1927 file will set the file name for the current buffer, if
1928 the current buffer doesn't have a file name yet and
1929 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001930 *cpo-q*
1931 q When joining multiple lines leave the cursor at the
1932 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 *cpo-r*
1934 r Redo ("." command) uses "/" to repeat a search
1935 command, instead of the actually used search string.
1936 *cpo-R*
1937 R Remove marks from filtered lines. Without this flag
1938 marks are kept like |:keepmarks| was used.
1939 *cpo-s*
1940 s Set buffer options when entering the buffer for the
1941 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001942 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 set when the buffer is created.
1944 *cpo-S*
1945 S Set buffer options always when entering a buffer
1946 (except 'readonly', 'fileformat', 'filetype' and
1947 'syntax'). This is the (most) Vi compatible setting.
1948 The options are set to the values in the current
1949 buffer. When you change an option and go to another
1950 buffer, the value is copied. Effectively makes the
1951 buffer options global to all buffers.
1952
1953 's' 'S' copy buffer options
1954 no no when buffer created
1955 yes no when buffer first entered (default)
1956 X yes each time when buffer entered (vi comp.)
1957 *cpo-t*
1958 t Search pattern for the tag command is remembered for
1959 "n" command. Otherwise Vim only puts the pattern in
1960 the history for search pattern, but doesn't change the
1961 last used search pattern.
1962 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001963 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964 *cpo-v*
1965 v Backspaced characters remain visible on the screen in
1966 Insert mode. Without this flag the characters are
1967 erased from the screen right away. With this flag the
1968 screen newly typed text overwrites backspaced
1969 characters.
1970 *cpo-w*
1971 w When using "cw" on a blank character, only change one
1972 character and not all blanks until the start of the
1973 next word.
1974 *cpo-W*
1975 W Don't overwrite a readonly file. When omitted, ":w!"
1976 overwrites a readonly file, if possible.
1977 *cpo-x*
1978 x <Esc> on the command-line executes the command-line.
1979 The default in Vim is to abandon the command-line,
1980 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001981 *cpo-X*
1982 X When using a count with "R" the replaced text is
1983 deleted only once. Also when repeating "R" with "."
1984 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001985 *cpo-y*
1986 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001987 *cpo-Z*
1988 Z When using "w!" while the 'readonly' option is set,
1989 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990 *cpo-!*
1991 ! When redoing a filter command, use the last used
1992 external command, whatever it was. Otherwise the last
1993 used -filter- command is used.
1994 *cpo-$*
1995 $ When making a change to one line, don't redisplay the
1996 line, but put a '$' at the end of the changed text.
1997 The changed text will be overwritten when you type the
1998 new text. The line is redisplayed if you type any
1999 command that moves the cursor from the insertion
2000 point.
2001 *cpo-%*
2002 % Vi-compatible matching is done for the "%" command.
2003 Does not recognize "#if", "#endif", etc.
2004 Does not recognize "/*" and "*/".
2005 Parens inside single and double quotes are also
2006 counted, causing a string that contains a paren to
2007 disturb the matching. For example, in a line like
2008 "if (strcmp("foo(", s))" the first paren does not
2009 match the last one. When this flag is not included,
2010 parens inside single and double quotes are treated
2011 specially. When matching a paren outside of quotes,
2012 everything inside quotes is ignored. When matching a
2013 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002014 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002015 This flag is also used for other features, such as
2016 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002017 *cpo--*
2018 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002019 it would go above the first line or below the last
2020 line. Without it the cursor moves to the first or
2021 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002022 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002023 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002024 *cpo-+*
2025 + When included, a ":write file" command will reset the
2026 'modified' flag of the buffer, even though the buffer
2027 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002028 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 * Use ":*" in the same way as ":@". When not included,
2030 ":*" is an alias for ":'<,'>", select the Visual area.
2031 *cpo-<*
2032 < Disable the recognition of special key codes in |<>|
2033 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002034 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035 ":map X <Tab>" results in X being mapped to:
2036 '<' included: "<Tab>" (5 characters)
2037 '<' excluded: "^I" (^I is a real <Tab>)
2038 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002039 *cpo->*
2040 > When appending to a register, put a line break before
2041 the appended text.
2042
2043 POSIX flags. These are not included in the Vi default value, except
2044 when $VIM_POSIX was set on startup. |posix|
2045
2046 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002047 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002048 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002049 *cpo-&*
2050 & When ":preserve" was used keep the swap file when
2051 exiting normally while this buffer is still loaded.
2052 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002053 *cpo-\*
2054 \ Backslash in a [] range in a search pattern is taken
2055 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002056 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2057 '\' excluded: "/[ \-]" finds <Space> and '-'
2058 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002059 *cpo-/*
2060 / When "%" is used as the replacement string in a |:s|
2061 command, use the previous replacement string. |:s%|
2062 *cpo-{*
2063 { The |{| and |}| commands also stop at a "{" character
2064 at the start of a line.
2065 *cpo-.*
2066 . The ":chdir" and ":cd" commands fail if the current
2067 buffer is modified, unless ! is used. Vim doesn't
2068 need this, since it remembers the full path of an
2069 opened file.
2070 *cpo-bar*
2071 | The value of the $LINES and $COLUMNS environment
2072 variables overrule the terminal size values obtained
2073 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002074
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002076 *'cryptmethod'* *'cm'*
2077'cryptmethod' number (default 0)
2078 local to buffer
2079 {not in Vi}
2080 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002081 *pkzip*
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002082 0 PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002083 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002084 *blowfish*
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002085 1 Blowfish method. Strong encryption. Requires Vim 7.3
2086 or later, files can NOT be read by Vim 7.2 and older.
2087 This adds a "seed" to the file, every time you write
2088 the file the encrypted bytes will be different.
2089
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002090 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002091 to the detected method of the file being read. Thus if you write it
2092 without changing 'cryptmethod' the same method will be used.
2093 Changing 'cryptmethod' does not mark the file as modified, you have to
2094 explicitly write it when not making modifications.
2095 Also see |:X|.
2096 When a new encryption method is added in a later version of Vim, and
2097 the current version does not recognize it, you will get *E821* .
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002098
2099
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100 *'cscopepathcomp'* *'cspc'*
2101'cscopepathcomp' 'cspc' number (default 0)
2102 global
2103 {not available when compiled without the |+cscope|
2104 feature}
2105 {not in Vi}
2106 Determines how many components of the path to show in a list of tags.
2107 See |cscopepathcomp|.
2108
2109 *'cscopeprg'* *'csprg'*
2110'cscopeprg' 'csprg' string (default "cscope")
2111 global
2112 {not available when compiled without the |+cscope|
2113 feature}
2114 {not in Vi}
2115 Specifies the command to execute cscope. See |cscopeprg|.
2116 This option cannot be set from a |modeline| or in the |sandbox|, for
2117 security reasons.
2118
2119 *'cscopequickfix'* *'csqf'*
2120'cscopequickfix' 'csqf' string (default "")
2121 global
2122 {not available when compiled without the |+cscope|
2123 or |+quickfix| features}
2124 {not in Vi}
2125 Specifies whether to use quickfix window to show cscope results.
2126 See |cscopequickfix|.
2127
2128 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2129'cscopetag' 'cst' boolean (default off)
2130 global
2131 {not available when compiled without the |+cscope|
2132 feature}
2133 {not in Vi}
2134 Use cscope for tag commands. See |cscope-options|.
2135 NOTE: This option is reset when 'compatible' is set.
2136
2137 *'cscopetagorder'* *'csto'*
2138'cscopetagorder' 'csto' number (default 0)
2139 global
2140 {not available when compiled without the |+cscope|
2141 feature}
2142 {not in Vi}
2143 Determines the order in which ":cstag" performs a search. See
2144 |cscopetagorder|.
2145 NOTE: This option is set to 0 when 'compatible' is set.
2146
2147 *'cscopeverbose'* *'csverb'*
2148 *'nocscopeverbose'* *'nocsverb'*
2149'cscopeverbose' 'csverb' boolean (default off)
2150 global
2151 {not available when compiled without the |+cscope|
2152 feature}
2153 {not in Vi}
2154 Give messages when adding a cscope database. See |cscopeverbose|.
2155 NOTE: This option is reset when 'compatible' is set.
2156
Bram Moolenaar860cae12010-06-05 23:22:07 +02002157 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2158'cursorbind' 'crb' boolean (default off)
2159 local to window
2160 {not in Vi}
2161 {not available when compiled without the |+cursorbind|
2162 feature}
2163 When this option is set, as the cursor in the current
2164 window moves other cursorbound windows (windows that also have
2165 this option set) move their cursors to the corresponding line and
2166 column. This option is useful for viewing the
2167 differences between two versions of a file (see 'diff'); in diff mode,
2168 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002169 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002170
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002171
2172 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2173'cursorcolumn' 'cuc' boolean (default off)
2174 local to window
2175 {not in Vi}
2176 {not available when compiled without the |+syntax|
2177 feature}
2178 Highlight the screen column of the cursor with CursorColumn
2179 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2180 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002181 If you only want the highlighting in the current window you can use
2182 these autocommands: >
2183 au WinLeave * set nocursorline nocursorcolumn
2184 au WinEnter * set cursorline cursorcolumn
2185<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002186
2187 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2188'cursorline' 'cul' boolean (default off)
2189 local to window
2190 {not in Vi}
2191 {not available when compiled without the |+syntax|
2192 feature}
2193 Highlight the screen line of the cursor with CursorLine
2194 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2195 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002196 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002197 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002198
2199
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200 *'debug'*
2201'debug' string (default "")
2202 global
2203 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002204 These values can be used:
2205 msg Error messages that would otherwise be omitted will be given
2206 anyway.
2207 throw Error messages that would otherwise be omitted will be given
2208 anyway and also throw an exception and set |v:errmsg|.
2209 beep A message will be given when otherwise only a beep would be
2210 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002211 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002212 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2213 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214
2215 *'define'* *'def'*
2216'define' 'def' string (default "^\s*#\s*define")
2217 global or local to buffer |global-local|
2218 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002219 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220 pattern, just like for the "/" command. This option is used for the
2221 commands like "[i" and "[d" |include-search|. The 'isident' option is
2222 used to recognize the defined name after the match:
2223 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2224 See |option-backslash| about inserting backslashes to include a space
2225 or backslash.
2226 The default value is for C programs. For C++ this value would be
2227 useful, to include const type declarations: >
2228 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2229< When using the ":set" command, you need to double the backslashes!
2230
2231 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2232'delcombine' 'deco' boolean (default off)
2233 global
2234 {not in Vi}
2235 {only available when compiled with the |+multi_byte|
2236 feature}
2237 If editing Unicode and this option is set, backspace and Normal mode
2238 "x" delete each combining character on its own. When it is off (the
2239 default) the character along with its combining characters are
2240 deleted.
2241 Note: When 'delcombine' is set "xx" may work different from "2x"!
2242
2243 This is useful for Arabic, Hebrew and many other languages where one
2244 may have combining characters overtop of base characters, and want
2245 to remove only the combining ones.
2246
2247 *'dictionary'* *'dict'*
2248'dictionary' 'dict' string (default "")
2249 global or local to buffer |global-local|
2250 {not in Vi}
2251 List of file names, separated by commas, that are used to lookup words
2252 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2253 contain a list of words. This can be one word per line, or several
2254 words per line, separated by non-keyword characters (white space is
2255 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002256 When this option is empty, or an entry "spell" is present, spell
2257 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002258 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 after a comma are ignored, otherwise spaces are included in the file
2260 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002261 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262 Where to find a list of words?
2263 - On FreeBSD, there is the file "/usr/share/dict/words".
2264 - In the Simtel archive, look in the "msdos/linguist" directory.
2265 - In "miscfiles" of the GNU collection.
2266 The use of |:set+=| and |:set-=| is preferred when adding or removing
2267 directories from the list. This avoids problems when a future version
2268 uses another default.
2269 Backticks cannot be used in this option for security reasons.
2270
2271 *'diff'* *'nodiff'*
2272'diff' boolean (default off)
2273 local to window
2274 {not in Vi}
2275 {not available when compiled without the |+diff|
2276 feature}
2277 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002278 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279
2280 *'dex'* *'diffexpr'*
2281'diffexpr' 'dex' string (default "")
2282 global
2283 {not in Vi}
2284 {not available when compiled without the |+diff|
2285 feature}
2286 Expression which is evaluated to obtain an ed-style diff file from two
2287 versions of a file. See |diff-diffexpr|.
2288 This option cannot be set from a |modeline| or in the |sandbox|, for
2289 security reasons.
2290
2291 *'dip'* *'diffopt'*
2292'diffopt' 'dip' string (default "filler")
2293 global
2294 {not in Vi}
2295 {not available when compiled without the |+diff|
2296 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002297 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002298 All are optional. Items must be separated by a comma.
2299
2300 filler Show filler lines, to keep the text
2301 synchronized with a window that has inserted
2302 lines at the same position. Mostly useful
2303 when windows are side-by-side and 'scrollbind'
2304 is set.
2305
2306 context:{n} Use a context of {n} lines between a change
2307 and a fold that contains unchanged lines.
2308 When omitted a context of six lines is used.
2309 See |fold-diff|.
2310
2311 icase Ignore changes in case of text. "a" and "A"
2312 are considered the same. Adds the "-i" flag
2313 to the "diff" command if 'diffexpr' is empty.
2314
2315 iwhite Ignore changes in amount of white space. Adds
2316 the "-b" flag to the "diff" command if
2317 'diffexpr' is empty. Check the documentation
2318 of the "diff" command for what this does
2319 exactly. It should ignore adding trailing
2320 white space, but not leading white space.
2321
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002322 horizontal Start diff mode with horizontal splits (unless
2323 explicitly specified otherwise).
2324
2325 vertical Start diff mode with vertical splits (unless
2326 explicitly specified otherwise).
2327
2328 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2329 starting diff mode. Without this 2 is used.
2330
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331 Examples: >
2332
2333 :set diffopt=filler,context:4
2334 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002335 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336<
2337 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2338'digraph' 'dg' boolean (default off)
2339 global
2340 {not in Vi}
2341 {not available when compiled without the |+digraphs|
2342 feature}
2343 Enable the entering of digraphs in Insert mode with {char1} <BS>
2344 {char2}. See |digraphs|.
2345 NOTE: This option is reset when 'compatible' is set.
2346
2347 *'directory'* *'dir'*
2348'directory' 'dir' string (default for Amiga: ".,t:",
2349 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2350 for Unix: ".,~/tmp,/var/tmp,/tmp")
2351 global
2352 List of directory names for the swap file, separated with commas.
2353 - The swap file will be created in the first directory where this is
2354 possible.
2355 - Empty means that no swap file will be used (recovery is
2356 impossible!).
2357 - A directory "." means to put the swap file in the same directory as
2358 the edited file. On Unix, a dot is prepended to the file name, so
2359 it doesn't show in a directory listing. On MS-Windows the "hidden"
2360 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002361 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002362 put the swap file relative to where the edited file is. The leading
2363 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002364 - For Unix and Win32, if a directory ends in two path separators "//"
2365 or "\\", the swap file name will be built from the complete path to
2366 the file with all path separators substituted to percent '%' signs.
2367 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002368 On Win32, when a separating comma is following, you must use "//",
2369 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370 - Spaces after the comma are ignored, other spaces are considered part
2371 of the directory name. To have a space at the start of a directory
2372 name, precede it with a backslash.
2373 - To include a comma in a directory name precede it with a backslash.
2374 - A directory name may end in an ':' or '/'.
2375 - Environment variables are expanded |:set_env|.
2376 - Careful with '\' characters, type one before a space, type two to
2377 get one in the option (see |option-backslash|), for example: >
2378 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2379< - For backwards compatibility with Vim version 3.0 a '>' at the start
2380 of the option is removed.
2381 Using "." first in the list is recommended. This means that editing
2382 the same file twice will result in a warning. Using "/tmp" on Unix is
2383 discouraged: When the system crashes you lose the swap file.
2384 "/var/tmp" is often not cleared when rebooting, thus is a better
2385 choice than "/tmp". But it can contain a lot of files, your swap
2386 files get lost in the crowd. That is why a "tmp" directory in your
2387 home directory is tried first.
2388 The use of |:set+=| and |:set-=| is preferred when adding or removing
2389 directories from the list. This avoids problems when a future version
2390 uses another default.
2391 This option cannot be set from a |modeline| or in the |sandbox|, for
2392 security reasons.
2393 {Vi: directory to put temp file in, defaults to "/tmp"}
2394
2395 *'display'* *'dy'*
2396'display' 'dy' string (default "")
2397 global
2398 {not in Vi}
2399 Change the way text is displayed. This is comma separated list of
2400 flags:
2401 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002402 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403 last line that doesn't fit is replaced with "@" lines.
2404 uhex Show unprintable characters hexadecimal as <xx>
2405 instead of using ^C and ~C.
2406
2407 *'eadirection'* *'ead'*
2408'eadirection' 'ead' string (default "both")
2409 global
2410 {not in Vi}
2411 {not available when compiled without the +vertsplit
2412 feature}
2413 Tells when the 'equalalways' option applies:
2414 ver vertically, width of windows is not affected
2415 hor horizontally, height of windows is not affected
2416 both width and height of windows is affected
2417
2418 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2419'edcompatible' 'ed' boolean (default off)
2420 global
2421 Makes the 'g' and 'c' flags of the ":substitute" command to be
2422 toggled each time the flag is given. See |complex-change|. See
2423 also 'gdefault' option.
2424 Switching this option on is discouraged!
2425
2426 *'encoding'* *'enc'* *E543*
2427'encoding' 'enc' string (default: "latin1" or value from $LANG)
2428 global
2429 {only available when compiled with the |+multi_byte|
2430 feature}
2431 {not in Vi}
2432 Sets the character encoding used inside Vim. It applies to text in
2433 the buffers, registers, Strings in expressions, text stored in the
2434 viminfo file, etc. It sets the kind of characters which Vim can work
2435 with. See |encoding-names| for the possible values.
2436
2437 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002438 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002440 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002441
Bram Moolenaar865242e2010-07-14 21:12:05 +02002442 This option cannot be set from a |modeline|. It would most likely
2443 corrupt the text.
2444
Bram Moolenaar071d4272004-06-13 20:20:40 +00002445 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2446 "utf-8". Although care has been taken to allow different values of
2447 'encoding', "utf-8" is the natural choice for the environment and
2448 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002449 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450 versions, and to avoid changing the encoding of newly created files
2451 without your knowledge (in case 'fileencodings' is empty).
2452
2453 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002454 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455 iconv() or as specified with 'charconvert'.
2456
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002457 If you need to know whether 'encoding' is a multi-byte encoding, you
2458 can use: >
2459 if has("multi_byte_encoding")
2460<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002461 Normally 'encoding' will be equal to your current locale. This will
2462 be the default if Vim recognizes your environment settings. If
2463 'encoding' is not set to the current locale, 'termencoding' must be
2464 set to convert typed and displayed text. See |encoding-table|.
2465
2466 When you set this option, it fires the |EncodingChanged| autocommand
2467 event so that you can set up fonts if necessary.
2468
2469 When the option is set, the value is converted to lowercase. Thus
2470 you can set it with uppercase values too. Underscores are translated
2471 to '-' signs.
2472 When the encoding is recognized, it is changed to the standard name.
2473 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2474 "iso-8859-2" and "utf8" becomes "utf-8".
2475
2476 Note: "latin1" is also used when the encoding could not be detected.
2477 This only works when editing files in the same encoding! When the
2478 actual character set is not latin1, make sure 'fileencoding' and
2479 'fileencodings' are empty. When conversion is needed, switch to using
2480 utf-8.
2481
2482 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2483 You don't notice this while editing, but it does matter for the
2484 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2485 setting 'encoding' to one of these values instead of utf-8 only has
2486 effect for encoding used for files when 'fileencoding' is empty.
2487
Bram Moolenaar661b1822005-07-28 22:36:45 +00002488 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2489 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002490
2491 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2492'endofline' 'eol' boolean (default on)
2493 local to buffer
2494 {not in Vi}
2495 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002496 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497 option is automatically set when starting to edit a new file, unless
2498 the file does not have an <EOL> for the last line in the file, in
2499 which case it is reset. Normally you don't have to set or reset this
2500 option. When 'binary' is off the value is not used when writing the
2501 file. When 'binary' is on it is used to remember the presence of a
2502 <EOL> for the last line in the file, so that when you write the file
2503 the situation from the original file can be kept. But you can change
2504 it if you want to.
2505
2506 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2507'equalalways' 'ea' boolean (default on)
2508 global
2509 {not in Vi}
2510 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002511 splitting or closing a window. This also happens the moment the
2512 option is switched on. When off, splitting a window will reduce the
2513 size of the current window and leave the other windows the same. When
2514 closing a window the extra lines are given to the window next to it
2515 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 When mixing vertically and horizontally split windows, a minimal size
2517 is computed and some windows may be larger if there is room. The
2518 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002519 Changing the height and width of a window can be avoided by setting
2520 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002521 If a window size is specified when creating a new window sizes are
2522 currently not equalized (it's complicated, but may be implemented in
2523 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524
2525 *'equalprg'* *'ep'*
2526'equalprg' 'ep' string (default "")
2527 global or local to buffer |global-local|
2528 {not in Vi}
2529 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002530 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002531 or 'indentexpr'. When Vim was compiled without internal formatting,
2532 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002533 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 about including spaces and backslashes.
2535 This option cannot be set from a |modeline| or in the |sandbox|, for
2536 security reasons.
2537
2538 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2539'errorbells' 'eb' boolean (default off)
2540 global
2541 Ring the bell (beep or screen flash) for error messages. This only
2542 makes a difference for error messages, the bell will be used always
2543 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002544 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545 screen flash or do nothing.
2546
2547 *'errorfile'* *'ef'*
2548'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2549 others: "errors.err")
2550 global
2551 {not in Vi}
2552 {not available when compiled without the |+quickfix|
2553 feature}
2554 Name of the errorfile for the QuickFix mode (see |:cf|).
2555 When the "-q" command-line argument is used, 'errorfile' is set to the
2556 following argument. See |-q|.
2557 NOT used for the ":make" command. See 'makeef' for that.
2558 Environment variables are expanded |:set_env|.
2559 See |option-backslash| about including spaces and backslashes.
2560 This option cannot be set from a |modeline| or in the |sandbox|, for
2561 security reasons.
2562
2563 *'errorformat'* *'efm'*
2564'errorformat' 'efm' string (default is very long)
2565 global or local to buffer |global-local|
2566 {not in Vi}
2567 {not available when compiled without the |+quickfix|
2568 feature}
2569 Scanf-like description of the format for the lines in the error file
2570 (see |errorformat|).
2571
2572 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2573'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2574 global
2575 {not in Vi}
2576 Function keys that start with an <Esc> are recognized in Insert
2577 mode. When this option is off, the cursor and function keys cannot be
2578 used in Insert mode if they start with an <Esc>. The advantage of
2579 this is that the single <Esc> is recognized immediately, instead of
2580 after one second. Instead of resetting this option, you might want to
2581 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2582 when 'esckeys' is off, you can still map anything, but the cursor keys
2583 won't work by default.
2584 NOTE: This option is set to the Vi default value when 'compatible' is
2585 set and to the Vim default value when 'compatible' is reset.
2586
2587 *'eventignore'* *'ei'*
2588'eventignore' 'ei' string (default "")
2589 global
2590 {not in Vi}
2591 {not available when compiled without the |+autocmd|
2592 feature}
2593 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002594 When set to "all" or when "all" is one of the items, all autocommand
2595 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 Otherwise this is a comma separated list of event names. Example: >
2597 :set ei=WinEnter,WinLeave
2598<
2599 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2600'expandtab' 'et' boolean (default off)
2601 local to buffer
2602 {not in Vi}
2603 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002604 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2606 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2607 NOTE: This option is reset when 'compatible' is set.
2608
2609 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2610'exrc' 'ex' boolean (default off)
2611 global
2612 {not in Vi}
2613 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2614 directory. If you switch this option on you should also consider
2615 setting the 'secure' option (see |initialization|). Using a local
2616 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2617 also see |.vimrc| and |gui-init|.
2618 This option cannot be set from a |modeline| or in the |sandbox|, for
2619 security reasons.
2620
2621 *'fileencoding'* *'fenc'* *E213*
2622'fileencoding' 'fenc' string (default: "")
2623 local to buffer
2624 {only available when compiled with the |+multi_byte|
2625 feature}
2626 {not in Vi}
2627 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002628
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002630 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631 When 'fileencoding' is empty, the same value as 'encoding' will be
2632 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002633 Conversion will also be done when 'encoding' and 'fileencoding' are
2634 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2635 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002637 'encoding' is "utf-8" or another Unicode encoding, conversion
2638 is most likely done in a way that the reverse conversion
2639 results in the same text. When 'encoding' is not "utf-8" some
2640 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002641
Bram Moolenaar071d4272004-06-13 20:20:40 +00002642 See 'encoding' for the possible values. Additionally, values may be
2643 specified that can be handled by the converter, see
2644 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002645
Bram Moolenaar071d4272004-06-13 20:20:40 +00002646 When reading a file 'fileencoding' will be set from 'fileencodings'.
2647 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002648 'fileencoding', use the |++enc| argument. One exception: when
2649 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002650 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002651
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2653 When the option is set, the value is converted to lowercase. Thus
2654 you can set it with uppercase values too. '_' characters are
2655 replaced with '-'. If a name is recognized from the list for
2656 'encoding', it is replaced by the standard name. For example
2657 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002658
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659 When this option is set, after starting to edit a file, the 'modified'
2660 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002661
2662 Keep in mind that changing 'fenc' from a modeline happens
2663 AFTER the text has been read, thus it applies to when the file will be
2664 written. If you do set 'fenc' in a modeline, you might want to set
2665 'nomodified' to avoid not being able to ":q".
2666
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 This option can not be changed when 'modifiable' is off.
2668
2669 *'fe'*
2670 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002671 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672 old short name was 'fe', which is no longer used.
2673
2674 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002675'fileencodings' 'fencs' string (default: "ucs-bom",
2676 "ucs-bom,utf-8,default,latin1" when
2677 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 global
2679 {only available when compiled with the |+multi_byte|
2680 feature}
2681 {not in Vi}
2682 This is a list of character encodings considered when starting to edit
2683 an existing file. When a file is read, Vim tries to use the first
2684 mentioned character encoding. If an error is detected, the next one
2685 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002686 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 an empty string, which means the value of 'encoding' is used.
2688 WARNING: Conversion can cause loss of information! When
2689 'encoding' is "utf-8" (or one of the other Unicode variants)
2690 conversion is most likely done in a way that the reverse
2691 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002692 "utf-8" some non-ASCII characters may be lost! You can use
2693 the |++bad| argument to specify what is done with characters
2694 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 For an empty file or a file with only ASCII characters most encodings
2696 will work and the first entry of 'fileencodings' will be used (except
2697 "ucs-bom", which requires the BOM to be present). If you prefer
2698 another encoding use an BufReadPost autocommand event to test if your
2699 preferred encoding is to be used. Example: >
2700 au BufReadPost * if search('\S', 'w') == 0 |
2701 \ set fenc=iso-2022-jp | endif
2702< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2703 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002704 When the |++enc| argument is used then the value of 'fileencodings' is
2705 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002706 Note that 'fileencodings' is not used for a new file, the global value
2707 of 'fileencoding' is used instead. You can set it with: >
2708 :setglobal fenc=iso-8859-2
2709< This means that a non-existing file may get a different encoding than
2710 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 The special value "ucs-bom" can be used to check for a Unicode BOM
2712 (Byte Order Mark) at the start of the file. It must not be preceded
2713 by "utf-8" or another Unicode encoding for this to work properly.
2714 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2715 because Vim cannot detect an error, thus the encoding is always
2716 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002717 The special value "default" can be used for the encoding from the
2718 environment. This is the default value for 'encoding'. It is useful
2719 when 'encoding' is set to "utf-8" and your environment uses a
2720 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002721 When 'encoding' is "utf-8" and a file contains an illegal byte
2722 sequence it won't be recognized as UTF-8. You can use the |8g8|
2723 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 WRONG VALUES: WHAT'S WRONG:
2725 latin1,utf-8 "latin1" will always be used
2726 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2727 file
2728 cp1250,latin1 "cp1250" will always be used
2729 If 'fileencodings' is empty, 'fileencoding' is not modified.
2730 See 'fileencoding' for the possible values.
2731 Setting this option does not have an effect until the next time a file
2732 is read.
2733
2734 *'fileformat'* *'ff'*
2735'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2736 Unix default: "unix",
2737 Macintosh default: "mac")
2738 local to buffer
2739 {not in Vi}
2740 This gives the <EOL> of the current buffer, which is used for
2741 reading/writing the buffer from/to a file:
2742 dos <CR> <NL>
2743 unix <NL>
2744 mac <CR>
2745 When "dos" is used, CTRL-Z at the end of a file is ignored.
2746 See |file-formats| and |file-read|.
2747 For the character encoding of the file see 'fileencoding'.
2748 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2749 works like it was set to "unix'.
2750 This option is set automatically when starting to edit a file and
2751 'fileformats' is not empty and 'binary' is off.
2752 When this option is set, after starting to edit a file, the 'modified'
2753 option is set, because the file would be different when written.
2754 This option can not be changed when 'modifiable' is off.
2755 For backwards compatibility: When this option is set to "dos",
2756 'textmode' is set, otherwise 'textmode' is reset.
2757
2758 *'fileformats'* *'ffs'*
2759'fileformats' 'ffs' string (default:
2760 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2761 Vim Unix: "unix,dos",
2762 Vim Mac: "mac,unix,dos",
2763 Vi Cygwin: "unix,dos",
2764 Vi others: "")
2765 global
2766 {not in Vi}
2767 This gives the end-of-line (<EOL>) formats that will be tried when
2768 starting to edit a new buffer and when reading a file into an existing
2769 buffer:
2770 - When empty, the format defined with 'fileformat' will be used
2771 always. It is not set automatically.
2772 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002773 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 'fileformats' name will be used when a file is read into an existing
2775 buffer, no matter what 'fileformat' for that buffer is set to.
2776 - When more than one name is present, separated by commas, automatic
2777 <EOL> detection will be done when reading a file. When starting to
2778 edit a file, a check is done for the <EOL>:
2779 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2780 'fileformat' is set to "dos".
2781 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002782 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 preceding <CR>, "unix" is preferred over "dos".
2784 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2785 This means that "mac" is only chosen when "unix" is not present,
2786 or when no <NL> is found in the file, and when "dos" is not
2787 present, or no <CR><NL> is present in the file.
2788 Also if "unix" was first chosen, but the first <CR> is before
2789 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2790 the file, then 'fileformat' is set to "mac".
2791 4. If 'fileformat' is still not set, the first name from
2792 'fileformats' is used.
2793 When reading a file into an existing buffer, the same is done, but
2794 this happens like 'fileformat' has been set appropriately for that
2795 file only, the option is not changed.
2796 When 'binary' is set, the value of 'fileformats' is not used.
2797
2798 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2799 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2800 done:
2801 - When 'fileformats' is empty, there is no automatic detection. Dos
2802 format will be used.
2803 - When 'fileformats' is set to one or more names, automatic detection
2804 is done. This is based on the first <NL> in the file: If there is a
2805 <CR> in front of it, Dos format is used, otherwise Unix format is
2806 used.
2807 Also see |file-formats|.
2808 For backwards compatibility: When this option is set to an empty
2809 string or one format (no comma is included), 'textauto' is reset,
2810 otherwise 'textauto' is set.
2811 NOTE: This option is set to the Vi default value when 'compatible' is
2812 set and to the Vim default value when 'compatible' is reset.
2813
2814 *'filetype'* *'ft'*
2815'filetype' 'ft' string (default: "")
2816 local to buffer
2817 {not in Vi}
2818 {not available when compiled without the |+autocmd|
2819 feature}
2820 When this option is set, the FileType autocommand event is triggered.
2821 All autocommands that match with the value of this option will be
2822 executed. Thus the value of 'filetype' is used in place of the file
2823 name.
2824 Otherwise this option does not always reflect the current file type.
2825 This option is normally set when the file type is detected. To enable
2826 this use the ":filetype on" command. |:filetype|
2827 Setting this option to a different value is most useful in a modeline,
2828 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002829 Example, for in an IDL file:
2830 /* vim: set filetype=idl : */ ~
2831 |FileType| |filetypes|
2832 When a dot appears in the value then this separates two filetype
2833 names. Example:
2834 /* vim: set filetype=c.doxygen : */ ~
2835 This will use the "c" filetype first, then the "doxygen" filetype.
2836 This works both for filetype plugins and for syntax files. More than
2837 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838 Do not confuse this option with 'osfiletype', which is for the file
2839 type that is actually stored with the file.
2840 This option is not copied to another buffer, independent of the 's' or
2841 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002842 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843
2844 *'fillchars'* *'fcs'*
2845'fillchars' 'fcs' string (default "vert:|,fold:-")
2846 global
2847 {not in Vi}
2848 {not available when compiled without the |+windows|
2849 and |+folding| features}
2850 Characters to fill the statuslines and vertical separators.
2851 It is a comma separated list of items:
2852
2853 item default Used for ~
2854 stl:c ' ' or '^' statusline of the current window
2855 stlnc:c ' ' or '-' statusline of the non-current windows
2856 vert:c '|' vertical separators |:vsplit|
2857 fold:c '-' filling 'foldtext'
2858 diff:c '-' deleted lines of the 'diff' option
2859
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002860 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861 "stlnc" the space will be used when there is highlighting, '^' or '-'
2862 otherwise.
2863
2864 Example: >
2865 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2866< This is similar to the default, except that these characters will also
2867 be used when there is highlighting.
2868
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002869 for "stl" and "stlnc" only single-byte values are supported.
2870
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 The highlighting used for these items:
2872 item highlight group ~
2873 stl:c StatusLine |hl-StatusLine|
2874 stlnc:c StatusLineNC |hl-StatusLineNC|
2875 vert:c VertSplit |hl-VertSplit|
2876 fold:c Folded |hl-Folded|
2877 diff:c DiffDelete |hl-DiffDelete|
2878
2879 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2880'fkmap' 'fk' boolean (default off) *E198*
2881 global
2882 {not in Vi}
2883 {only available when compiled with the |+rightleft|
2884 feature}
2885 When on, the keyboard is mapped for the Farsi character set.
2886 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002887 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888
2889 *'foldclose'* *'fcl'*
2890'foldclose' 'fcl' string (default "")
2891 global
2892 {not in Vi}
2893 {not available when compiled without the |+folding|
2894 feature}
2895 When set to "all", a fold is closed when the cursor isn't in it and
2896 its level is higher than 'foldlevel'. Useful if you want folds to
2897 automatically close when moving out of them.
2898
2899 *'foldcolumn'* *'fdc'*
2900'foldcolumn' 'fdc' number (default 0)
2901 local to window
2902 {not in Vi}
2903 {not available when compiled without the |+folding|
2904 feature}
2905 When non-zero, a column with the specified width is shown at the side
2906 of the window which indicates open and closed folds. The maximum
2907 value is 12.
2908 See |folding|.
2909
2910 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2911'foldenable' 'fen' boolean (default on)
2912 local to window
2913 {not in Vi}
2914 {not available when compiled without the |+folding|
2915 feature}
2916 When off, all folds are open. This option can be used to quickly
2917 switch between showing all text unfolded and viewing the text with
2918 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002919 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 'foldenable' is off.
2921 This option is set by commands that create a new fold or close a fold.
2922 See |folding|.
2923
2924 *'foldexpr'* *'fde'*
2925'foldexpr' 'fde' string (default: "0")
2926 local to window
2927 {not in Vi}
2928 {not available when compiled without the |+folding|
2929 or |+eval| feature}
2930 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002931 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002932
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002933 The expression may be evaluated in the |sandbox|, see
2934 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002935 This option can't be set from a |modeline| when the 'diff' option is
2936 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002937
2938 It is not allowed to change text or jump to another window while
2939 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940
2941 *'foldignore'* *'fdi'*
2942'foldignore' 'fdi' string (default: "#")
2943 local to window
2944 {not in Vi}
2945 {not available when compiled without the |+folding|
2946 feature}
2947 Used only when 'foldmethod' is "indent". Lines starting with
2948 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002949 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 The default "#" works well for C programs. See |fold-indent|.
2951
2952 *'foldlevel'* *'fdl'*
2953'foldlevel' 'fdl' number (default: 0)
2954 local to window
2955 {not in Vi}
2956 {not available when compiled without the |+folding|
2957 feature}
2958 Sets the fold level: Folds with a higher level will be closed.
2959 Setting this option to zero will close all folds. Higher numbers will
2960 close fewer folds.
2961 This option is set by commands like |zm|, |zM| and |zR|.
2962 See |fold-foldlevel|.
2963
2964 *'foldlevelstart'* *'fdls'*
2965'foldlevelstart' 'fdls' number (default: -1)
2966 global
2967 {not in Vi}
2968 {not available when compiled without the |+folding|
2969 feature}
2970 Sets 'foldlevel' when starting to edit another buffer in a window.
2971 Useful to always start editing with all folds closed (value zero),
2972 some folds closed (one) or no folds closed (99).
2973 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002974 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 ignores this option and closes all folds.
2976 It is also done before BufReadPre autocommands, to allow an autocmd to
2977 overrule the 'foldlevel' value for specific files.
2978 When the value is negative, it is not used.
2979
2980 *'foldmarker'* *'fmr'* *E536*
2981'foldmarker' 'fmr' string (default: "{{{,}}}")
2982 local to window
2983 {not in Vi}
2984 {not available when compiled without the |+folding|
2985 feature}
2986 The start and end marker used when 'foldmethod' is "marker". There
2987 must be one comma, which separates the start and end marker. The
2988 marker is a literal string (a regular expression would be too slow).
2989 See |fold-marker|.
2990
2991 *'foldmethod'* *'fdm'*
2992'foldmethod' 'fdm' string (default: "manual")
2993 local to window
2994 {not in Vi}
2995 {not available when compiled without the |+folding|
2996 feature}
2997 The kind of folding used for the current window. Possible values:
2998 |fold-manual| manual Folds are created manually.
2999 |fold-indent| indent Lines with equal indent form a fold.
3000 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3001 |fold-marker| marker Markers are used to specify folds.
3002 |fold-syntax| syntax Syntax highlighting items specify folds.
3003 |fold-diff| diff Fold text that is not changed.
3004
3005 *'foldminlines'* *'fml'*
3006'foldminlines' 'fml' number (default: 1)
3007 local to window
3008 {not in Vi}
3009 {not available when compiled without the |+folding|
3010 feature}
3011 Sets the minimum number of screen lines for a fold to be displayed
3012 closed. Also for manually closed folds.
3013 Note that this only has an effect of what is displayed. After using
3014 "zc" to close a fold, which is displayed open because it's smaller
3015 than 'foldminlines', a following "zc" may close a containing fold.
3016
3017 *'foldnestmax'* *'fdn'*
3018'foldnestmax' 'fdn' number (default: 20)
3019 local to window
3020 {not in Vi}
3021 {not available when compiled without the |+folding|
3022 feature}
3023 Sets the maximum nesting of folds for the "indent" and "syntax"
3024 methods. This avoids that too many folds will be created. Using more
3025 than 20 doesn't work, because the internal limit is 20.
3026
3027 *'foldopen'* *'fdo'*
3028'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3029 search,tag,undo")
3030 global
3031 {not in Vi}
3032 {not available when compiled without the |+folding|
3033 feature}
3034 Specifies for which type of commands folds will be opened, if the
3035 command moves the cursor into a closed fold. It is a comma separated
3036 list of items.
3037 item commands ~
3038 all any
3039 block "(", "{", "[[", "[{", etc.
3040 hor horizontal movements: "l", "w", "fx", etc.
3041 insert any command in Insert mode
3042 jump far jumps: "G", "gg", etc.
3043 mark jumping to a mark: "'m", CTRL-O, etc.
3044 percent "%"
3045 quickfix ":cn", ":crew", ":make", etc.
3046 search search for a pattern: "/", "n", "*", "gd", etc.
3047 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003048 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 tag jumping to a tag: ":ta", CTRL-T, etc.
3050 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003051 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 the |zv| command to the mapping to get the same effect.
3053 When a movement command is used for an operator (e.g., "dl" or "y%")
3054 this option is not used. This means the operator will include the
3055 whole closed fold.
3056 Note that vertical movements are not here, because it would make it
3057 very difficult to move onto a closed fold.
3058 In insert mode the folds containing the cursor will always be open
3059 when text is inserted.
3060 To close folds you can re-apply 'foldlevel' with the |zx| command or
3061 set the 'foldclose' option to "all".
3062
3063 *'foldtext'* *'fdt'*
3064'foldtext' 'fdt' string (default: "foldtext()")
3065 local to window
3066 {not in Vi}
3067 {not available when compiled without the |+folding|
3068 feature}
3069 An expression which is used to specify the text displayed for a closed
3070 fold. See |fold-foldtext|.
3071
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003072 The expression may be evaluated in the |sandbox|, see
3073 |sandbox-option|.
3074
3075 It is not allowed to change text or jump to another window while
3076 evaluating 'foldtext' |textlock|.
3077
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 *'formatoptions'* *'fo'*
3079'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3080 local to buffer
3081 {not in Vi}
3082 This is a sequence of letters which describes how automatic
3083 formatting is to be done. See |fo-table|. When the 'paste' option is
3084 on, no formatting is done (like 'formatoptions' is empty). Commas can
3085 be inserted for readability.
3086 To avoid problems with flags that are added in the future, use the
3087 "+=" and "-=" feature of ":set" |add-option-flags|.
3088 NOTE: This option is set to the Vi default value when 'compatible' is
3089 set and to the Vim default value when 'compatible' is reset.
3090
Bram Moolenaar86b68352004-12-27 21:59:20 +00003091 *'formatlistpat'* *'flp'*
3092'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3093 local to buffer
3094 {not in Vi}
3095 A pattern that is used to recognize a list header. This is used for
3096 the "n" flag in 'formatoptions'.
3097 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003098 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003099 while still checking more characters. There must be a character
3100 following the pattern, when it matches the whole line it is handled
3101 like there is no match.
3102 The default recognizes a number, followed by an optional punctuation
3103 character and white space.
3104
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 *'formatprg'* *'fp'*
3106'formatprg' 'fp' string (default "")
3107 global
3108 {not in Vi}
3109 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003110 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003112 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003113 If the 'formatexpr' option is not empty it will be used instead.
3114 Otherwise, if 'formatprg' option is an empty string, the internal
3115 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003116 Environment variables are expanded |:set_env|. See |option-backslash|
3117 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003118 The expression may be evaluated in the |sandbox|, see
3119 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003121 *'formatexpr'* *'fex'*
3122'formatexpr' 'fex' string (default "")
3123 local to buffer
3124 {not in Vi}
3125 {not available when compiled without the |+eval|
3126 feature}
3127 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003128 operator. When this option is empty 'formatprg' is used.
3129
3130 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003131 The |v:count| variable holds the number of lines to be formatted.
3132 The |v:char| variable holds the character that is going to be
3133 inserted. This can be empty. Don't insert it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003134
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003135 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003136 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003137< This will invoke the mylang#Format() function in the
3138 autoload/mylang.vim file in 'runtimepath'. |autoload|
3139
3140 The expression is also evaluated when 'textwidth' is set and adding
3141 text beyond that limit. This happens under the same conditions as
3142 when internal formatting is used. Make sure the cursor is kept in the
3143 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003144 return "i" or "R" in this situation.
3145
3146 When the expression evaluates to non-zero Vim will fall back to using
3147 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003148
3149 The expression may be evaluated in the |sandbox|, see
3150 |sandbox-option|.
3151
3152 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003153'fsync' 'fs' boolean (default on)
3154 global
3155 {not in Vi}
3156 When on, the library function fsync() will be called after writing a
3157 file. This will flush a file to disk, ensuring that it is safely
3158 written even on filesystems which do metadata-only journaling. This
3159 will force the harddrive to spin up on Linux systems running in laptop
3160 mode, so it may be undesirable in some situations. Be warned that
3161 turning this off increases the chances of data loss after a crash. On
3162 systems without an fsync() implementation, this variable is always
3163 off.
3164 Also see 'swapsync' for controlling fsync() on swap files.
3165
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3167'gdefault' 'gd' boolean (default off)
3168 global
3169 {not in Vi}
3170 When on, the ":substitute" flag 'g' is default on. This means that
3171 all matches in a line are substituted instead of one. When a 'g' flag
3172 is given to a ":substitute" command, this will toggle the substitution
3173 of all or one match. See |complex-change|.
3174
3175 command 'gdefault' on 'gdefault' off ~
3176 :s/// subst. all subst. one
3177 :s///g subst. one subst. all
3178 :s///gg subst. all subst. one
3179
3180 NOTE: This option is reset when 'compatible' is set.
3181
3182 *'grepformat'* *'gfm'*
3183'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3184 global
3185 {not in Vi}
3186 Format to recognize for the ":grep" command output.
3187 This is a scanf-like string that uses the same format as the
3188 'errorformat' option: see |errorformat|.
3189
3190 *'grepprg'* *'gp'*
3191'grepprg' 'gp' string (default "grep -n ",
3192 Unix: "grep -n $* /dev/null",
3193 Win32: "findstr /n" or "grep -n",
3194 VMS: "SEARCH/NUMBERS ")
3195 global or local to buffer |global-local|
3196 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003197 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 and '#' characters, which are expanded like when used in a command-
3199 line. The placeholder "$*" is allowed to specify where the arguments
3200 will be included. Environment variables are expanded |:set_env|. See
3201 |option-backslash| about including spaces and backslashes.
3202 When your "grep" accepts the "-H" argument, use this to make ":grep"
3203 also work well with a single file: >
3204 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003205< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003206 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3207 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003208 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209 apply equally to 'grepprg'.
3210 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3211 otherwise it's "grep -n".
3212 This option cannot be set from a |modeline| or in the |sandbox|, for
3213 security reasons.
3214
3215 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3216'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3217 ve:ver35-Cursor,
3218 o:hor50-Cursor,
3219 i-ci:ver25-Cursor/lCursor,
3220 r-cr:hor20-Cursor/lCursor,
3221 sm:block-Cursor
3222 -blinkwait175-blinkoff150-blinkon175",
3223 for MS-DOS and Win32 console:
3224 "n-v-c:block,o:hor50,i-ci:hor15,
3225 r-cr:hor30,sm:block")
3226 global
3227 {not in Vi}
3228 {only available when compiled with GUI enabled, and
3229 for MS-DOS and Win32 console}
3230 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003231 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 the height of the cursor can be changed. This can be done by
3233 specifying a block cursor, or a percentage for a vertical or
3234 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003235 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003237 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 mode-list and an argument-list:
3239 mode-list:argument-list,mode-list:argument-list,..
3240 The mode-list is a dash separated list of these modes:
3241 n Normal mode
3242 v Visual mode
3243 ve Visual mode with 'selection' "exclusive" (same as 'v',
3244 if not specified)
3245 o Operator-pending mode
3246 i Insert mode
3247 r Replace mode
3248 c Command-line Normal (append) mode
3249 ci Command-line Insert mode
3250 cr Command-line Replace mode
3251 sm showmatch in Insert mode
3252 a all modes
3253 The argument-list is a dash separated list of these arguments:
3254 hor{N} horizontal bar, {N} percent of the character height
3255 ver{N} vertical bar, {N} percent of the character width
3256 block block cursor, fills the whole character
3257 [only one of the above three should be present]
3258 blinkwait{N} *cursor-blinking*
3259 blinkon{N}
3260 blinkoff{N}
3261 blink times for cursor: blinkwait is the delay before
3262 the cursor starts blinking, blinkon is the time that
3263 the cursor is shown and blinkoff is the time that the
3264 cursor is not shown. The times are in msec. When one
3265 of the numbers is zero, there is no blinking. The
3266 default is: "blinkwait700-blinkon400-blinkoff250".
3267 These numbers are used for a missing entry. This
3268 means that blinking is enabled by default. To switch
3269 blinking off you can use "blinkon0". The cursor only
3270 blinks when Vim is waiting for input, not while
3271 executing a command.
3272 To make the cursor blink in an xterm, see
3273 |xterm-blink|.
3274 {group-name}
3275 a highlight group name, that sets the color and font
3276 for the cursor
3277 {group-name}/{group-name}
3278 Two highlight group names, the first is used when
3279 no language mappings are used, the other when they
3280 are. |language-mapping|
3281
3282 Examples of parts:
3283 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3284 block cursor with colors from the "nCursor"
3285 highlight group
3286 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3287 In Insert and Command-line Insert mode, use a
3288 30% vertical bar cursor with colors from the
3289 "iCursor" highlight group. Blink a bit
3290 faster.
3291
3292 The 'a' mode is different. It will set the given argument-list for
3293 all modes. It does not reset anything to defaults. This can be used
3294 to do a common setting for all modes. For example, to switch off
3295 blinking: "a:blinkon0"
3296
3297 Examples of cursor highlighting: >
3298 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3299 :highlight Cursor gui=NONE guifg=bg guibg=fg
3300<
3301 *'guifont'* *'gfn'*
3302 *E235* *E596* *E610* *E611*
3303'guifont' 'gfn' string (default "")
3304 global
3305 {not in Vi}
3306 {only available when compiled with GUI enabled}
3307 This is a list of fonts which will be used for the GUI version of Vim.
3308 In its simplest form the value is just one font name. When
3309 the font cannot be found you will get an error message. To try other
3310 font names a list can be specified, font names separated with commas.
3311 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003312
Bram Moolenaar05159a02005-02-26 23:04:13 +00003313 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3314 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003315
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316 Spaces after a comma are ignored. To include a comma in a font name
3317 precede it with a backslash. Setting an option requires an extra
3318 backslash before a space and a backslash. See also
3319 |option-backslash|. For example: >
3320 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003321< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003323
3324 If none of the fonts can be loaded, Vim will keep the current setting.
3325 If an empty font list is given, Vim will try using other resource
3326 settings (for X, it will use the Vim.font resource), and finally it
3327 will try some builtin default which should always be there ("7x13" in
3328 the case of X). The font names given should be "normal" fonts. Vim
3329 will try to find the related bold and italic fonts.
3330
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003331 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003332 :set guifont=*
3333< will bring up a font requester, where you can pick the font you want.
3334
3335 The font name depends on the GUI used. See |setting-guifont| for a
3336 way to set 'guifont' for various systems.
3337
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 For the GTK+ 2 GUI the font name looks like this: >
3339 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003340< That's all. XLFDs are not used. For Chinese this is reported to work
3341 well: >
3342 if has("gui_gtk2")
3343 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3344 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3345 endif
3346<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003347 For Mac OSX you can use something like this: >
3348 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003349< Also see 'macatsui', it can help fix display problems.
3350 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003352 width). An exception is GTK 2: all fonts are accepted, but
3353 mono-spaced fonts look best.
3354
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 To preview a font on X11, you might be able to use the "xfontsel"
3356 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003357
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 For the Win32 GUI *E244* *E245*
3359 - takes these options in the font name:
3360 hXX - height is XX (points, can be floating-point)
3361 wXX - width is XX (points, can be floating-point)
3362 b - bold
3363 i - italic
3364 u - underline
3365 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003366 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3368 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3369 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003370 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371
3372 Use a ':' to separate the options.
3373 - A '_' can be used in the place of a space, so you don't need to use
3374 backslashes to escape the spaces.
3375 - Examples: >
3376 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3377 :set guifont=Andale_Mono:h7.5:w4.5
3378< See also |font-sizes|.
3379
3380 *'guifontset'* *'gfs'*
3381 *E250* *E252* *E234* *E597* *E598*
3382'guifontset' 'gfs' string (default "")
3383 global
3384 {not in Vi}
3385 {only available when compiled with GUI enabled and
3386 with the |+xfontset| feature}
3387 {not available in the GTK+ 2 GUI}
3388 When not empty, specifies two (or more) fonts to be used. The first
3389 one for normal English, the second one for your special language. See
3390 |xfontset|.
3391 Setting this option also means that all font names will be handled as
3392 a fontset name. Also the ones used for the "font" argument of the
3393 |:highlight| command.
3394 The fonts must match with the current locale. If fonts for the
3395 character sets that the current locale uses are not included, setting
3396 'guifontset' will fail.
3397 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3398 the comma-separated names are alternative names, one of which will be
3399 used. In 'guifontset' the whole string is one fontset name,
3400 including the commas. It is not possible to specify alternative
3401 fontset names.
3402 This example works on many X11 systems: >
3403 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3404<
3405 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3406'guifontwide' 'gfw' string (default "")
3407 global
3408 {not in Vi}
3409 {only available when compiled with GUI enabled}
3410 When not empty, specifies a comma-separated list of fonts to be used
3411 for double-width characters. The first font that can be loaded is
3412 used.
3413 Note: The size of these fonts must be exactly twice as wide as the one
3414 specified with 'guifont' and the same height.
3415
3416 All GUI versions but GTK+ 2:
3417
3418 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3419 'guifontset' is empty or invalid.
3420 When 'guifont' is set and a valid font is found in it and
3421 'guifontwide' is empty Vim will attempt to find a matching
3422 double-width font and set 'guifontwide' to it.
3423
3424 GTK+ 2 GUI only: *guifontwide_gtk2*
3425
3426 If set and valid, 'guifontwide' is always used for double width
3427 characters, even if 'encoding' is not set to "utf-8".
3428 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003429 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 font for characters not available in 'guifont'. Thus you do not need
3431 to set 'guifontwide' at all unless you want to override the choice
3432 made by Pango/Xft.
3433
3434 *'guiheadroom'* *'ghr'*
3435'guiheadroom' 'ghr' number (default 50)
3436 global
3437 {not in Vi} {only for GTK and X11 GUI}
3438 The number of pixels subtracted from the screen height when fitting
3439 the GUI window on the screen. Set this before the GUI is started,
3440 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003441 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003442 lines will be left for window decorations and other items on the
3443 screen. Set it to a negative value to allow windows taller than the
3444 screen.
3445
3446 *'guioptions'* *'go'*
3447'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003448 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 global
3450 {not in Vi}
3451 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003452 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 sequence of letters which describes what components and options of the
3454 GUI should be used.
3455 To avoid problems with flags that are added in the future, use the
3456 "+=" and "-=" feature of ":set" |add-option-flags|.
3457
3458 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003459 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 'a' Autoselect: If present, then whenever VISUAL mode is started,
3461 or the Visual area extended, Vim tries to become the owner of
3462 the windowing system's global selection. This means that the
3463 Visually highlighted text is available for pasting into other
3464 applications as well as into Vim itself. When the Visual mode
3465 ends, possibly due to an operation on the text, or when an
3466 application wants to paste the selection, the highlighted text
3467 is automatically yanked into the "* selection register.
3468 Thus the selection is still available for pasting into other
3469 applications after the VISUAL mode has ended.
3470 If not present, then Vim won't become the owner of the
3471 windowing system's global selection unless explicitly told to
3472 by a yank or delete operation for the "* register.
3473 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003474 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003475 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 applies to the modeless selection.
3477
3478 'guioptions' autoselect Visual autoselect modeless ~
3479 "" - -
3480 "a" yes yes
3481 "A" - yes
3482 "aA" yes yes
3483
Bram Moolenaar02467872007-05-06 13:22:01 +00003484 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 'c' Use console dialogs instead of popup dialogs for simple
3486 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003487 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003488 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003489 'guitablabel' can be used to change the text in the labels.
3490 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003491 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003492 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003493 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 'f' Foreground: Don't use fork() to detach the GUI from the shell
3495 where it was started. Use this for programs that wait for the
3496 editor to finish (e.g., an e-mail program). Alternatively you
3497 can use "gvim -f" or ":gui -f" to start the GUI in the
3498 foreground. |gui-fork|
3499 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003500 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003501 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3503 corner of the window. It's black&white on non-GTK, because of
3504 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003505 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003507 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003508 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003510 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 file is sourced the system menu has already been loaded; the
3512 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003513 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 'g' Grey menu items: Make menu items that are not active grey. If
3515 'g' is not included inactive menu items are not shown at all.
3516 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003517 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 't' Include tearoff menu items. Currently only works for Win32,
3519 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003520 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003521 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003522 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003523 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003525 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 'R' Right-hand scrollbar is present when there is a vertically
3527 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003528 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003530 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531 'L' Left-hand scrollbar is present when there is a vertically
3532 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003533 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3535 the longest visible line, or on the cursor line if the 'h'
3536 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003537 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538 'h' Limit horizontal scrollbar size to the length of the cursor
3539 line. Reduces computations. |gui-horiz-scroll|
3540
3541 And yes, you may even have scrollbars on the left AND the right if
3542 you really want to :-). See |gui-scrollbars| for more information.
3543
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003544 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 'v' Use a vertical button layout for dialogs. When not included,
3546 a horizontal layout is preferred, but when it doesn't fit a
3547 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003548 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 'p' Use Pointer callbacks for X11 GUI. This is required for some
3550 window managers. If the cursor is not blinking or hollow at
3551 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003552 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003554 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003555 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556
Bram Moolenaar02467872007-05-06 13:22:01 +00003557
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 *'guipty'* *'noguipty'*
3559'guipty' boolean (default on)
3560 global
3561 {not in Vi}
3562 {only available when compiled with GUI enabled}
3563 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3564 I/O to/from shell commands. See |gui-pty|.
3565
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003566 *'guitablabel'* *'gtl'*
3567'guitablabel' 'gtl' string (default empty)
3568 global
3569 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003570 {only available when compiled with GUI enabled and
3571 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003572 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003573 pages line. When empty and when the result is empty Vim will use a
3574 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003575
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003576 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003577 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003578
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003579 Only used when the GUI tab pages line is displayed. 'e' must be
3580 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3581 used.
3582
Bram Moolenaar57657d82006-04-21 22:12:41 +00003583 *'guitabtooltip'* *'gtt'*
3584'guitabtooltip' 'gtt' string (default empty)
3585 global
3586 {not in Vi}
3587 {only available when compiled with GUI enabled and
3588 with the +windows feature}
3589 When nonempty describes the text to use in a tooltip for the GUI tab
3590 pages line. When empty Vim will use a default tooltip.
3591 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003592 You can include a line break. Simplest method is to use |:let|: >
3593 :let &guitabtooltip = "line one\nline two"
3594<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003595
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 *'helpfile'* *'hf'*
3597'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3598 (others) "$VIMRUNTIME/doc/help.txt")
3599 global
3600 {not in Vi}
3601 Name of the main help file. All distributed help files should be
3602 placed together in one directory. Additionally, all "doc" directories
3603 in 'runtimepath' will be used.
3604 Environment variables are expanded |:set_env|. For example:
3605 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003606 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607 spaces and backslashes.
3608 This option cannot be set from a |modeline| or in the |sandbox|, for
3609 security reasons.
3610
3611 *'helpheight'* *'hh'*
3612'helpheight' 'hh' number (default 20)
3613 global
3614 {not in Vi}
3615 {not available when compiled without the +windows
3616 feature}
3617 Minimal initial height of the help window when it is opened with the
3618 ":help" command. The initial height of the help window is half of the
3619 current window, or (when the 'ea' option is on) the same as other
3620 windows. When the height is less than 'helpheight', the height is
3621 set to 'helpheight'. Set to zero to disable.
3622
3623 *'helplang'* *'hlg'*
3624'helplang' 'hlg' string (default: messages language or empty)
3625 global
3626 {only available when compiled with the |+multi_lang|
3627 feature}
3628 {not in Vi}
3629 Comma separated list of languages. Vim will use the first language
3630 for which the desired help can be found. The English help will always
3631 be used as a last resort. You can add "en" to prefer English over
3632 another language, but that will only find tags that exist in that
3633 language and not in the English help.
3634 Example: >
3635 :set helplang=de,it
3636< This will first search German, then Italian and finally English help
3637 files.
3638 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3639 try to find the tag in the current language before using this option.
3640 See |help-translated|.
3641
3642 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3643'hidden' 'hid' boolean (default off)
3644 global
3645 {not in Vi}
3646 When off a buffer is unloaded when it is |abandon|ed. When on a
3647 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3648 displayed in another window, it does not become hidden, of course.
3649 The commands that move through the buffer list sometimes make a buffer
3650 hidden although the 'hidden' option is off: When the buffer is
3651 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003652 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003653 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 This option is set for one command with ":hide {command}" |:hide|.
3655 WARNING: It's easy to forget that you have changes in hidden buffers.
3656 Think twice when using ":q!" or ":qa!".
3657
3658 *'highlight'* *'hl'*
3659'highlight' 'hl' string (default (as a single string):
3660 "8:SpecialKey,@:NonText,d:Directory,
3661 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3662 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003663 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3665 f:Folded,F:FoldColumn,A:DiffAdd,
3666 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003667 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003668 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003669 +:Pmenu,=:PmenuSel,
3670 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 global
3672 {not in Vi}
3673 This option can be used to set highlighting mode for various
3674 occasions. It is a comma separated list of character pairs. The
3675 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003676 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3678 |hl-NonText| @ '~' and '@' at the end of the window and
3679 characters from 'showbreak'
3680 |hl-Directory| d directories in CTRL-D listing and other special
3681 things in listings
3682 |hl-ErrorMsg| e error messages
3683 h (obsolete, ignored)
3684 |hl-IncSearch| i 'incsearch' highlighting
3685 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3686 |hl-MoreMsg| m |more-prompt|
3687 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003688 |hl-LineNr| n line number for ":number" and ":#" commands, and
3689 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 |hl-Question| r |hit-enter| prompt and yes/no questions
3691 |hl-StatusLine| s status line of current window |status-line|
3692 |hl-StatusLineNC| S status lines of not-current windows
3693 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3694 |hl-VertSplit| c column used to separate vertically split windows
3695 |hl-Visual| v Visual mode
3696 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3697 Selection" Only X11 Gui's |gui-x11| and
3698 |xterm-clipboard|.
3699 |hl-WarningMsg| w warning messages
3700 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3701 |hl-Folded| f line used for closed folds
3702 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003703 |hl-DiffAdd| A added line in diff mode
3704 |hl-DiffChange| C changed line in diff mode
3705 |hl-DiffDelete| D deleted line in diff mode
3706 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003708 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003709 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003710 |hl-SpellRare| R rare word |spell|
3711 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003712 |hl-Conceal| - the placeholders used for concealed characters
3713 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003714 |hl-Pmenu| + popup menu normal line
3715 |hl-PmenuSel| = popup menu normal line
3716 |hl-PmenuSbar| x popup menu scrollbar
3717 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718
3719 The display modes are:
3720 r reverse (termcap entry "mr" and "me")
3721 i italic (termcap entry "ZH" and "ZR")
3722 b bold (termcap entry "md" and "me")
3723 s standout (termcap entry "so" and "se")
3724 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003725 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 n no highlighting
3727 - no highlighting
3728 : use a highlight group
3729 The default is used for occasions that are not included.
3730 If you want to change what the display modes do, see |dos-colors|
3731 for an example.
3732 When using the ':' display mode, this must be followed by the name of
3733 a highlight group. A highlight group can be used to define any type
3734 of highlighting, including using color. See |:highlight| on how to
3735 define one. The default uses a different group for each occasion.
3736 See |highlight-default| for the default highlight groups.
3737
3738 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3739'hlsearch' 'hls' boolean (default off)
3740 global
3741 {not in Vi}
3742 {not available when compiled without the
3743 |+extra_search| feature}
3744 When there is a previous search pattern, highlight all its matches.
3745 The type of highlighting used can be set with the 'l' occasion in the
3746 'highlight' option. This uses the "Search" highlight group by
3747 default. Note that only the matching text is highlighted, any offsets
3748 are not applied.
3749 See also: 'incsearch' and |:match|.
3750 When you get bored looking at the highlighted matches, you can turn it
3751 off with |:nohlsearch|. As soon as you use a search command, the
3752 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003753 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754 When the search pattern can match an end-of-line, Vim will try to
3755 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003756 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003758 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 NOTE: This option is reset when 'compatible' is set.
3760
3761 *'history'* *'hi'*
3762'history' 'hi' number (Vim default: 20, Vi default: 0)
3763 global
3764 {not in Vi}
3765 A history of ":" commands, and a history of previous search patterns
3766 are remembered. This option decides how many entries may be stored in
3767 each of these histories (see |cmdline-editing|).
3768 NOTE: This option is set to the Vi default value when 'compatible' is
3769 set and to the Vim default value when 'compatible' is reset.
3770
3771 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3772'hkmap' 'hk' boolean (default off)
3773 global
3774 {not in Vi}
3775 {only available when compiled with the |+rightleft|
3776 feature}
3777 When on, the keyboard is mapped for the Hebrew character set.
3778 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3779 toggle this option. See |rileft.txt|.
3780 NOTE: This option is reset when 'compatible' is set.
3781
3782 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3783'hkmapp' 'hkp' boolean (default off)
3784 global
3785 {not in Vi}
3786 {only available when compiled with the |+rightleft|
3787 feature}
3788 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3789 This is useful if you have a non-Hebrew keyboard.
3790 See |rileft.txt|.
3791 NOTE: This option is reset when 'compatible' is set.
3792
3793 *'icon'* *'noicon'*
3794'icon' boolean (default off, on when title can be restored)
3795 global
3796 {not in Vi}
3797 {not available when compiled without the |+title|
3798 feature}
3799 When on, the icon text of the window will be set to the value of
3800 'iconstring' (if it is not empty), or to the name of the file
3801 currently being edited. Only the last part of the name is used.
3802 Overridden by the 'iconstring' option.
3803 Only works if the terminal supports setting window icons (currently
3804 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3805 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3806 builtin termcap).
3807 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003808 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 X11.
3810
3811 *'iconstring'*
3812'iconstring' string (default "")
3813 global
3814 {not in Vi}
3815 {not available when compiled without the |+title|
3816 feature}
3817 When this option is not empty, it will be used for the icon text of
3818 the window. This happens only when the 'icon' option is on.
3819 Only works if the terminal supports setting window icon text
3820 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3821 Does not work for MS Windows.
3822 When Vim was compiled with HAVE_X11 defined, the original icon will be
3823 restored if possible |X11|.
3824 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003825 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 'titlestring' for example settings.
3827 {not available when compiled without the |+statusline| feature}
3828
3829 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3830'ignorecase' 'ic' boolean (default off)
3831 global
3832 Ignore case in search patterns. Also used when searching in the tags
3833 file.
3834 Also see 'smartcase'.
3835 Can be overruled by using "\c" or "\C" in the pattern, see
3836 |/ignorecase|.
3837
3838 *'imactivatekey'* *'imak'*
3839'imactivatekey' 'imak' string (default "")
3840 global
3841 {not in Vi}
3842 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003843 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 Specifies the key that your Input Method in X-Windows uses for
3845 activation. When this is specified correctly, vim can fully control
3846 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3847 You can't use this option to change the activation key, the option
3848 tells Vim what the key is.
3849 Format:
3850 [MODIFIER_FLAG-]KEY_STRING
3851
3852 These characters can be used for MODIFIER_FLAG (case is ignored):
3853 S Shift key
3854 L Lock key
3855 C Control key
3856 1 Mod1 key
3857 2 Mod2 key
3858 3 Mod3 key
3859 4 Mod4 key
3860 5 Mod5 key
3861 Combinations are allowed, for example "S-C-space" or "SC-space" are
3862 both shift+ctrl+space.
3863 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3864
3865 Example: >
3866 :set imactivatekey=S-space
3867< "S-space" means shift+space. This is the activation key for kinput2 +
3868 canna (Japanese), and ami (Korean).
3869
3870 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3871'imcmdline' 'imc' boolean (default off)
3872 global
3873 {not in Vi}
3874 {only available when compiled with the |+xim|
3875 |+multi_byte_ime| or |global-ime| feature}
3876 When set the Input Method is always on when starting to edit a command
3877 line, unless entering a search pattern (see 'imsearch' for that).
3878 Setting this option is useful when your input method allows entering
3879 English characters directly, e.g., when it's used to type accented
3880 characters with dead keys.
3881
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003882 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3884 global
3885 {not in Vi}
3886 {only available when compiled with the |+xim|
3887 |+multi_byte_ime| or |global-ime| feature}
3888 When set the Input Method is never used. This is useful to disable
3889 the IM when it doesn't work properly.
3890 Currently this option is on by default for SGI/IRIX machines. This
3891 may change in later releases.
3892
3893 *'iminsert'* *'imi'*
3894'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3895 local to buffer
3896 {not in Vi}
3897 Specifies whether :lmap or an Input Method (IM) is to be used in
3898 Insert mode. Valid values:
3899 0 :lmap is off and IM is off
3900 1 :lmap is ON and IM is off
3901 2 :lmap is off and IM is ON
3902 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3903 or |global-ime|.
3904 To always reset the option to zero when leaving Insert mode with <Esc>
3905 this can be used: >
3906 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3907< This makes :lmap and IM turn off automatically when leaving Insert
3908 mode.
3909 Note that this option changes when using CTRL-^ in Insert mode
3910 |i_CTRL-^|.
3911 The value is set to 1 when setting 'keymap' to a valid keymap name.
3912 It is also used for the argument of commands like "r" and "f".
3913 The value 0 may not work correctly with Athena and Motif with some XIM
3914 methods. Use 'imdisable' to disable XIM then.
3915
3916 *'imsearch'* *'ims'*
3917'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3918 local to buffer
3919 {not in Vi}
3920 Specifies whether :lmap or an Input Method (IM) is to be used when
3921 entering a search pattern. Valid values:
3922 -1 the value of 'iminsert' is used, makes it look like
3923 'iminsert' is also used when typing a search pattern
3924 0 :lmap is off and IM is off
3925 1 :lmap is ON and IM is off
3926 2 :lmap is off and IM is ON
3927 Note that this option changes when using CTRL-^ in Command-line mode
3928 |c_CTRL-^|.
3929 The value is set to 1 when it is not -1 and setting the 'keymap'
3930 option to a valid keymap name.
3931 The value 0 may not work correctly with Athena and Motif with some XIM
3932 methods. Use 'imdisable' to disable XIM then.
3933
3934 *'include'* *'inc'*
3935'include' 'inc' string (default "^\s*#\s*include")
3936 global or local to buffer |global-local|
3937 {not in Vi}
3938 {not available when compiled without the
3939 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003940 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 pattern, just like for the "/" command (See |pattern|). The default
3942 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003943 "]I", "[d", etc.
3944 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003945 comes after the matched pattern. But if "\zs" appears in the pattern
3946 then the text matched from "\zs" to the end, or until "\ze" if it
3947 appears, is used as the file name. Use this to include characters
3948 that are not in 'isfname', such as a space. You can then use
3949 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003950 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951
3952 *'includeexpr'* *'inex'*
3953'includeexpr' 'inex' string (default "")
3954 local to buffer
3955 {not in Vi}
3956 {not available when compiled without the
3957 |+find_in_path| or |+eval| feature}
3958 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003959 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 :set includeexpr=substitute(v:fname,'\\.','/','g')
3961< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003962
Bram Moolenaar071d4272004-06-13 20:20:40 +00003963 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003964 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 Also used for |<cfile>|.
3966
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003967 The expression may be evaluated in the |sandbox|, see
3968 |sandbox-option|.
3969
3970 It is not allowed to change text or jump to another window while
3971 evaluating 'includeexpr' |textlock|.
3972
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3974'incsearch' 'is' boolean (default off)
3975 global
3976 {not in Vi}
3977 {not available when compiled without the
3978 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003979 While typing a search command, show where the pattern, as it was typed
3980 so far, matches. The matched string is highlighted. If the pattern
3981 is invalid or not found, nothing is shown. The screen will be updated
3982 often, this is only useful on fast terminals.
3983 Note that the match will be shown, but the cursor will return to its
3984 original position when no match is found and when pressing <Esc>. You
3985 still need to finish the search command with <Enter> to move the
3986 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003987 When compiled with the |+reltime| feature Vim only searches for about
3988 half a second. With a complicated pattern and/or a lot of text the
3989 match may not be found. This is to avoid that Vim hangs while you
3990 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003991 The highlighting can be set with the 'i' flag in 'highlight'.
3992 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003993 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02003994 to the command line. If 'ignorecase' and 'smartcase' are set and the
3995 command line has no uppercase characters, the added character is
3996 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003997 CTRL-R CTRL-W can be used to add the word at the end of the current
3998 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 NOTE: This option is reset when 'compatible' is set.
4000
4001 *'indentexpr'* *'inde'*
4002'indentexpr' 'inde' string (default "")
4003 local to buffer
4004 {not in Vi}
4005 {not available when compiled without the |+cindent|
4006 or |+eval| features}
4007 Expression which is evaluated to obtain the proper indent for a line.
4008 It is used when a new line is created, for the |=| operator and
4009 in Insert mode as specified with the 'indentkeys' option.
4010 When this option is not empty, it overrules the 'cindent' and
4011 'smartindent' indenting.
4012 When 'paste' is set this option is not used for indenting.
4013 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004014 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 when the expression is evaluated (but it may be moved around).
4016 The expression must return the number of spaces worth of indent. It
4017 can return "-1" to keep the current indent (this means 'autoindent' is
4018 used for the indent).
4019 Functions useful for computing the indent are |indent()|, |cindent()|
4020 and |lispindent()|.
4021 The evaluation of the expression must not have side effects! It must
4022 not change the text, jump to another window, etc. Afterwards the
4023 cursor position is always restored, thus the cursor may be moved.
4024 Normally this option would be set to call a function: >
4025 :set indentexpr=GetMyIndent()
4026< Error messages will be suppressed, unless the 'debug' option contains
4027 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004028 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 NOTE: This option is made empty when 'compatible' is set.
4030
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004031 The expression may be evaluated in the |sandbox|, see
4032 |sandbox-option|.
4033
4034 It is not allowed to change text or jump to another window while
4035 evaluating 'indentexpr' |textlock|.
4036
4037
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 *'indentkeys'* *'indk'*
4039'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4040 local to buffer
4041 {not in Vi}
4042 {not available when compiled without the |+cindent|
4043 feature}
4044 A list of keys that, when typed in Insert mode, cause reindenting of
4045 the current line. Only happens if 'indentexpr' isn't empty.
4046 The format is identical to 'cinkeys', see |indentkeys-format|.
4047 See |C-indenting| and |indent-expression|.
4048
4049 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4050'infercase' 'inf' boolean (default off)
4051 local to buffer
4052 {not in Vi}
4053 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004054 'ignorecase' is also on, the case of the match is adjusted depending
4055 on the typed text. If the typed text contains a lowercase letter
4056 where the match has an upper case letter, the completed part is made
4057 lowercase. If the typed text has no lowercase letters and the match
4058 has a lowercase letter where the typed text has an uppercase letter,
4059 and there is a letter before it, the completed part is made uppercase.
4060 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061
4062 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4063'insertmode' 'im' boolean (default off)
4064 global
4065 {not in Vi}
4066 Makes Vim work in a way that Insert mode is the default mode. Useful
4067 if you want to use Vim as a modeless editor. Used for |evim|.
4068 These Insert mode commands will be useful:
4069 - Use the cursor keys to move around.
4070 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4071 this is a mapping, it is executed as if 'insertmode' was off.
4072 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004074 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4075 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076
4077 These items change when 'insertmode' is set:
4078 - when starting to edit of a file, Vim goes to Insert mode.
4079 - <Esc> in Insert mode is a no-op and beeps.
4080 - <Esc> in Normal mode makes Vim go to Insert mode.
4081 - CTRL-L in Insert mode is a command, it is not inserted.
4082 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4083 However, when <Esc> is used inside a mapping, it behaves like
4084 'insertmode' was not set. This was done to be able to use the same
4085 mappings with 'insertmode' set or not set.
4086 When executing commands with |:normal| 'insertmode' is not used.
4087
4088 NOTE: This option is reset when 'compatible' is set.
4089
4090 *'isfname'* *'isf'*
4091'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4092 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4093 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4094 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4095 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4096 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4097 global
4098 {not in Vi}
4099 The characters specified by this option are included in file names and
4100 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004101 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 Multi-byte characters 256 and above are always included, only the
4103 characters up to 255 are specified with this option.
4104 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004105 Think twice before adding white space to this option. Although a
4106 space may appear inside a file name, the effect will be that Vim
4107 doesn't know where a file name starts or ends when doing completion.
4108 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109
4110 Note that on systems using a backslash as path separator, Vim tries to
4111 do its best to make it work as you would expect. That is a bit
4112 tricky, since Vi originally used the backslash to escape special
4113 characters. Vim will not remove a backslash in front of a normal file
4114 name character on these systems, but it will on Unix and alikes. The
4115 '&' and '^' are not included by default, because these are special for
4116 cmd.exe.
4117
4118 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004119 Each part can be a single character number or a range. A range is two
4120 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 decimal number between 0 and 255 or the ASCII character itself (does
4122 not work for digits). Example:
4123 "_,-,128-140,#-43" (include '_' and '-' and the range
4124 128 to 140 and '#' to 43)
4125 If a part starts with '^', the following character number or range
4126 will be excluded from the option. The option is interpreted from left
4127 to right. Put the excluded character after the range where it is
4128 included. To include '^' itself use it as the last character of the
4129 option or the end of a range. Example:
4130 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4131 If the character is '@', all characters where isalpha() returns TRUE
4132 are included. Normally these are the characters a to z and A to Z,
4133 plus accented characters. To include '@' itself use "@-@". Examples:
4134 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004135 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 "a-z,A-Z,@-@" All letters plus the '@' character.
4137 A comma can be included by using it where a character number is
4138 expected. Example:
4139 "48-57,,,_" Digits, comma and underscore.
4140 A comma can be excluded by prepending a '^'. Example:
4141 " -~,^,,9" All characters from space to '~', excluding
4142 comma, plus <Tab>.
4143 See |option-backslash| about including spaces and backslashes.
4144
4145 *'isident'* *'isi'*
4146'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4147 "@,48-57,_,128-167,224-235"
4148 otherwise: "@,48-57,_,192-255")
4149 global
4150 {not in Vi}
4151 The characters given by this option are included in identifiers.
4152 Identifiers are used in recognizing environment variables and after a
4153 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004154 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 option.
4156 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004157 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4159
4160 *'iskeyword'* *'isk'*
4161'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4162 "@,48-57,_,128-167,224-235"
4163 otherwise: "@,48-57,_,192-255"
4164 Vi default: "@,48-57,_")
4165 local to buffer
4166 {not in Vi}
4167 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004168 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 'isfname' for a description of the format of this option. For C
4170 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4171 For a help file it is set to all non-blank printable characters except
4172 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4173 command).
4174 When the 'lisp' option is on the '-' character is always included.
4175 NOTE: This option is set to the Vi default value when 'compatible' is
4176 set and to the Vim default value when 'compatible' is reset.
4177
4178 *'isprint'* *'isp'*
4179'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4180 "@,~-255"; otherwise: "@,161-255")
4181 global
4182 {not in Vi}
4183 The characters given by this option are displayed directly on the
4184 screen. It is also used for "\p" in a |pattern|. The characters from
4185 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4186 even when they are not included in 'isprint' or excluded. See
4187 'isfname' for a description of the format of this option.
4188
4189 Non-printable characters are displayed with two characters:
4190 0 - 31 "^@" - "^_"
4191 32 - 126 always single characters
4192 127 "^?"
4193 128 - 159 "~@" - "~_"
4194 160 - 254 "| " - "|~"
4195 255 "~?"
4196 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4197 displayed as <xx>, with the hexadecimal value of the byte.
4198 When 'display' contains "uhex" all unprintable characters are
4199 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004200 The SpecialKey highlighting will be used for unprintable characters.
4201 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202
4203 Multi-byte characters 256 and above are always included, only the
4204 characters up to 255 are specified with this option. When a character
4205 is printable but it is not available in the current font, a
4206 replacement character will be shown.
4207 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4208 There is no option to specify these characters.
4209
4210 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4211'joinspaces' 'js' boolean (default on)
4212 global
4213 {not in Vi}
4214 Insert two spaces after a '.', '?' and '!' with a join command.
4215 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4216 Otherwise only one space is inserted.
4217 NOTE: This option is set when 'compatible' is set.
4218
4219 *'key'*
4220'key' string (default "")
4221 local to buffer
4222 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004223 {only available when compiled with the |+cryptv|
4224 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004226 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 Careful: Do not set the key value by hand, someone might see the typed
4228 key. Use the |:X| command. But you can make 'key' empty: >
4229 :set key=
4230< It is not possible to get the value of this option with ":set key" or
4231 "echo &key". This is to avoid showing it to someone who shouldn't
4232 know. It also means you cannot see it yourself once you have set it,
4233 be careful not to make a typing error!
4234
4235 *'keymap'* *'kmp'* *E544*
4236'keymap' 'kmp' string (default "")
4237 local to buffer
4238 {not in Vi}
4239 {only available when compiled with the |+keymap|
4240 feature}
4241 Name of a keyboard mapping. See |mbyte-keymap|.
4242 Setting this option to a valid keymap name has the side effect of
4243 setting 'iminsert' to one, so that the keymap becomes effective.
4244 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004245 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246
4247 *'keymodel'* *'km'*
4248'keymodel' 'km' string (default "")
4249 global
4250 {not in Vi}
4251 List of comma separated words, which enable special things that keys
4252 can do. These values can be used:
4253 startsel Using a shifted special key starts selection (either
4254 Select mode or Visual mode, depending on "key" being
4255 present in 'selectmode').
4256 stopsel Using a not-shifted special key stops selection.
4257 Special keys in this context are the cursor keys, <End>, <Home>,
4258 <PageUp> and <PageDown>.
4259 The 'keymodel' option is set by the |:behave| command.
4260
4261 *'keywordprg'* *'kp'*
4262'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4263 OS/2: "view /", VMS: "help")
4264 global or local to buffer |global-local|
4265 {not in Vi}
4266 Program to use for the |K| command. Environment variables are
4267 expanded |:set_env|. ":help" may be used to access the Vim internal
4268 help. (Note that previously setting the global option to the empty
4269 value did this, which is now deprecated.)
4270 When "man" is used, Vim will automatically translate a count for the
4271 "K" command to a section number. Also for "man -s", in which case the
4272 "-s" is removed when there is no count.
4273 See |option-backslash| about including spaces and backslashes.
4274 Example: >
4275 :set keywordprg=man\ -s
4276< This option cannot be set from a |modeline| or in the |sandbox|, for
4277 security reasons.
4278
4279 *'langmap'* *'lmap'* *E357* *E358*
4280'langmap' 'lmap' string (default "")
4281 global
4282 {not in Vi}
4283 {only available when compiled with the |+langmap|
4284 feature}
4285 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004286 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 inserted directly. When in command mode the 'langmap' option takes
4288 care of translating these special characters to the original meaning
4289 of the key. This means you don't have to change the keyboard mode to
4290 be able to execute Normal mode commands.
4291 This is the opposite of the 'keymap' option, where characters are
4292 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004294 Example (for Greek, in UTF-8): *greek* >
4295 :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 +00004296< Example (exchanges meaning of z and y for commands): >
4297 :set langmap=zy,yz,ZY,YZ
4298<
4299 The 'langmap' option is a list of parts, separated with commas. Each
4300 part can be in one of two forms:
4301 1. A list of pairs. Each pair is a "from" character immediately
4302 followed by the "to" character. Examples: "aA", "aAbBcC".
4303 2. A list of "from" characters, a semi-colon and a list of "to"
4304 characters. Example: "abc;ABC"
4305 Example: "aA,fgh;FGH,cCdDeE"
4306 Special characters need to be preceded with a backslash. These are
4307 ";", ',' and backslash itself.
4308
4309 This will allow you to activate vim actions without having to switch
4310 back and forth between the languages. Your language characters will
4311 be understood as normal vim English characters (according to the
4312 langmap mappings) in the following cases:
4313 o Normal/Visual mode (commands, buffer/register names, user mappings)
4314 o Insert/Replace Mode: Register names after CTRL-R
4315 o Insert/Replace Mode: Mappings
4316 Characters entered in Command-line mode will NOT be affected by
4317 this option. Note that this option can be changed at any time
4318 allowing to switch between mappings for different languages/encodings.
4319 Use a mapping to avoid having to type it each time!
4320
4321 *'langmenu'* *'lm'*
4322'langmenu' 'lm' string (default "")
4323 global
4324 {not in Vi}
4325 {only available when compiled with the |+menu| and
4326 |+multi_lang| features}
4327 Language to use for menu translation. Tells which file is loaded
4328 from the "lang" directory in 'runtimepath': >
4329 "lang/menu_" . &langmenu . ".vim"
4330< (without the spaces). For example, to always use the Dutch menus, no
4331 matter what $LANG is set to: >
4332 :set langmenu=nl_NL.ISO_8859-1
4333< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004334 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 If your $LANG is set to a non-English language but you do want to use
4336 the English menus: >
4337 :set langmenu=none
4338< This option must be set before loading menus, switching on filetype
4339 detection or syntax highlighting. Once the menus are defined setting
4340 this option has no effect. But you could do this: >
4341 :source $VIMRUNTIME/delmenu.vim
4342 :set langmenu=de_DE.ISO_8859-1
4343 :source $VIMRUNTIME/menu.vim
4344< Warning: This deletes all menus that you defined yourself!
4345
4346 *'laststatus'* *'ls'*
4347'laststatus' 'ls' number (default 1)
4348 global
4349 {not in Vi}
4350 The value of this option influences when the last window will have a
4351 status line:
4352 0: never
4353 1: only if there are at least two windows
4354 2: always
4355 The screen looks nicer with a status line if you have several
4356 windows, but it takes another screen line. |status-line|
4357
4358 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4359'lazyredraw' 'lz' boolean (default off)
4360 global
4361 {not in Vi}
4362 When this option is set, the screen will not be redrawn while
4363 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004364 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 update use |:redraw|.
4366
4367 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4368'linebreak' 'lbr' boolean (default off)
4369 local to window
4370 {not in Vi}
4371 {not available when compiled without the |+linebreak|
4372 feature}
4373 If on Vim will wrap long lines at a character in 'breakat' rather
4374 than at the last character that fits on the screen. Unlike
4375 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4376 it only affects the way the file is displayed, not its contents. The
4377 value of 'showbreak' is used to put in front of wrapped lines.
4378 This option is not used when the 'wrap' option is off or 'list' is on.
4379 Note that <Tab> characters after an <EOL> are mostly not displayed
4380 with the right amount of white space.
4381
4382 *'lines'* *E593*
4383'lines' number (default 24 or terminal height)
4384 global
4385 Number of lines of the Vim window.
4386 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004387 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 When Vim is running in the GUI or in a resizable window, setting this
4389 option will cause the window size to be changed. When you only want
4390 to use the size for the GUI, put the command in your |gvimrc| file.
4391 Vim limits the number of lines to what fits on the screen. You can
4392 use this command to get the tallest window possible: >
4393 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004394< Minimum value is 2, maximum value is 1000.
4395 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 When you set this option and Vim is unable to change the physical
4397 number of lines of the display, the display may be messed up.
4398
4399 *'linespace'* *'lsp'*
4400'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4401 global
4402 {not in Vi}
4403 {only in the GUI}
4404 Number of pixel lines inserted between characters. Useful if the font
4405 uses the full character cell height, making lines touch each other.
4406 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004407 With some fonts there can be too much room between lines (to have
4408 space for ascents and descents). Then it makes sense to set
4409 'linespace' to a negative value. This may cause display problems
4410 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411
4412 *'lisp'* *'nolisp'*
4413'lisp' boolean (default off)
4414 local to buffer
4415 {not available when compiled without the |+lispindent|
4416 feature}
4417 Lisp mode: When <Enter> is typed in insert mode set the indent for
4418 the next line to Lisp standards (well, sort of). Also happens with
4419 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4420 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4421 better. Also see 'lispwords'.
4422 The '-' character is included in keyword characters. Redefines the
4423 "=" operator to use this same indentation algorithm rather than
4424 calling an external program if 'equalprg' is empty.
4425 This option is not used when 'paste' is set.
4426 {Vi: Does it a little bit differently}
4427
4428 *'lispwords'* *'lw'*
4429'lispwords' 'lw' string (default is very long)
4430 global
4431 {not in Vi}
4432 {not available when compiled without the |+lispindent|
4433 feature}
4434 Comma separated list of words that influence the Lisp indenting.
4435 |'lisp'|
4436
4437 *'list'* *'nolist'*
4438'list' boolean (default off)
4439 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004440 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4441 line. Useful to see the difference between tabs and spaces and for
4442 trailing blanks. Further changed by the 'listchars' option.
4443
4444 The cursor is displayed at the start of the space a Tab character
4445 occupies, not at the end as usual in Normal mode. To get this cursor
4446 position while displaying Tabs with spaces, use: >
4447 :set list lcs=tab\ \
4448<
4449 Note that list mode will also affect formatting (set with 'textwidth'
4450 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 changing the way tabs are displayed.
4452
4453 *'listchars'* *'lcs'*
4454'listchars' 'lcs' string (default "eol:$")
4455 global
4456 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004457 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 settings.
4459 eol:c Character to show at the end of each line. When
4460 omitted, there is no extra character at the end of the
4461 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004462 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004464 fill the space that the tab normally occupies.
4465 "tab:>-" will show a tab that takes four spaces as
4466 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004467 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 trailing spaces are blank.
4469 extends:c Character to show in the last column, when 'wrap' is
4470 off and the line continues beyond the right of the
4471 screen.
4472 precedes:c Character to show in the first column, when 'wrap'
4473 is off and there is text preceding the character
4474 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004475 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004476 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004477 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004478 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004480 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004482 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483
4484 Examples: >
4485 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004486 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 :set lcs=extends:>,precedes:<
4488< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004489 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004490 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004491
4492 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4493'loadplugins' 'lpl' boolean (default on)
4494 global
4495 {not in Vi}
4496 When on the plugin scripts are loaded when starting up |load-plugins|.
4497 This option can be reset in your |vimrc| file to disable the loading
4498 of plugins.
4499 Note that using the "-u NONE" and "--noplugin" command line arguments
4500 reset this option. |-u| |--noplugin|
4501
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004502 *'macatsui'* *'nomacatsui'*
4503'macatsui' boolean (default on)
4504 global
4505 {only available in Mac GUI version}
4506 This is a workaround for when drawing doesn't work properly. When set
4507 and compiled with multi-byte support ATSUI text drawing is used. When
4508 not set ATSUI text drawing is not used. Switch this option off when
4509 you experience drawing problems. In a future version the problems may
4510 be solved and this option becomes obsolete. Therefore use this method
4511 to unset it: >
4512 if exists('&macatsui')
4513 set nomacatsui
4514 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004515< Another option to check if you have drawing problems is
4516 'termencoding'.
4517
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 *'magic'* *'nomagic'*
4519'magic' boolean (default on)
4520 global
4521 Changes the special characters that can be used in search patterns.
4522 See |pattern|.
4523 NOTE: To avoid portability problems with using patterns, always keep
4524 this option at the default "on". Only switch it off when working with
4525 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004526 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527
4528 *'makeef'* *'mef'*
4529'makeef' 'mef' string (default: "")
4530 global
4531 {not in Vi}
4532 {not available when compiled without the |+quickfix|
4533 feature}
4534 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4535 and the |:grep| command.
4536 When it is empty, an internally generated temp file will be used.
4537 When "##" is included, it is replaced by a number to make the name
4538 unique. This makes sure that the ":make" command doesn't overwrite an
4539 existing file.
4540 NOT used for the ":cf" command. See 'errorfile' for that.
4541 Environment variables are expanded |:set_env|.
4542 See |option-backslash| about including spaces and backslashes.
4543 This option cannot be set from a |modeline| or in the |sandbox|, for
4544 security reasons.
4545
4546 *'makeprg'* *'mp'*
4547'makeprg' 'mp' string (default "make", VMS: "MMS")
4548 global or local to buffer |global-local|
4549 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004550 Program to use for the ":make" command. See |:make_makeprg|.
4551 This option may contain '%' and '#' characters, which are expanded to
4552 the current and alternate file name. |:_%| |:_#|
4553 Environment variables are expanded |:set_env|. See |option-backslash|
4554 about including spaces and backslashes.
4555 Note that a '|' must be escaped twice: once for ":set" and once for
4556 the interpretation of a command. When you use a filter called
4557 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 :set makeprg=gmake\ \\\|\ myfilter
4559< The placeholder "$*" can be given (even multiple times) to specify
4560 where the arguments will be included, for example: >
4561 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4562< This option cannot be set from a |modeline| or in the |sandbox|, for
4563 security reasons.
4564
Bram Moolenaar1a384422010-07-14 19:53:30 +02004565 *'colorcolumn'* *'cc'*
4566'colorcolumn' 'cc' string (default "")
4567 local to window
4568 {not in Vi}
4569 {not available when compiled without the |+syntax|
4570 feature}
4571 'colorcolumn' is a comma separated list of screen columns that are
4572 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
4573 text. Will make screen redrawing slower.
4574 The screen column can be an absolute number, or a number preceded with
4575 '+' or '-', which is added to or subtracted from 'textwidth'. >
4576
4577 :set cc=+1 " highlight column after 'textwidth'
4578 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
4579 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
4580<
4581 When 'textwidth' is zero then the items with '-' and '+' are not used.
4582 A maximum of 256 columns are highlighted.
4583
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 *'matchpairs'* *'mps'*
4585'matchpairs' 'mps' string (default "(:),{:},[:]")
4586 local to buffer
4587 {not in Vi}
4588 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004589 other. Currently only single byte character pairs are allowed, and
4590 they must be different. The characters must be separated by a colon.
4591 The pairs must be separated by a comma. Example for including '<' and
4592 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 :set mps+=<:>
4594
4595< A more exotic example, to jump between the '=' and ';' in an
4596 assignment, useful for languages like C and Java: >
4597 :au FileType c,cpp,java set mps+==:;
4598
4599< For a more advanced way of using "%", see the matchit.vim plugin in
4600 the $VIMRUNTIME/macros directory. |add-local-help|
4601
4602 *'matchtime'* *'mat'*
4603'matchtime' 'mat' number (default 5)
4604 global
4605 {not in Vi}{in Nvi}
4606 Tenths of a second to show the matching paren, when 'showmatch' is
4607 set. Note that this is not in milliseconds, like other options that
4608 set a time. This is to be compatible with Nvi.
4609
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004610 *'maxcombine'* *'mco'*
4611'maxcombine' 'mco' number (default 2)
4612 global
4613 {not in Vi}
4614 {only available when compiled with the |+multi_byte|
4615 feature}
4616 The maximum number of combining characters supported for displaying.
4617 Only used when 'encoding' is "utf-8".
4618 The default is OK for most languages. Hebrew may require 4.
4619 Maximum value is 6.
4620 Even when this option is set to 2 you can still edit text with more
4621 combining characters, you just can't see them. Use |g8| or |ga|.
4622 See |mbyte-combining|.
4623
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 *'maxfuncdepth'* *'mfd'*
4625'maxfuncdepth' 'mfd' number (default 100)
4626 global
4627 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004628 {not available when compiled without the +eval
4629 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 Maximum depth of function calls for user functions. This normally
4631 catches endless recursion. When using a recursive function with
4632 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4633 more memory, there is the danger of failing when memory is exhausted.
4634 See also |:function|.
4635
4636 *'maxmapdepth'* *'mmd'* *E223*
4637'maxmapdepth' 'mmd' number (default 1000)
4638 global
4639 {not in Vi}
4640 Maximum number of times a mapping is done without resulting in a
4641 character to be used. This normally catches endless mappings, like
4642 ":map x y" with ":map y x". It still does not catch ":map g wg",
4643 because the 'w' is used before the next mapping is done. See also
4644 |key-mapping|.
4645
4646 *'maxmem'* *'mm'*
4647'maxmem' 'mm' number (default between 256 to 5120 (system
4648 dependent) or half the amount of memory
4649 available)
4650 global
4651 {not in Vi}
4652 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4653 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004654 other memory to be freed. The maximum usable value is about 2000000.
4655 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004657 *'maxmempattern'* *'mmp'*
4658'maxmempattern' 'mmp' number (default 1000)
4659 global
4660 {not in Vi}
4661 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004662 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004663 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004664 When Vim runs into the limit it gives an error message and mostly
4665 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004666 Running into the limit often means that the pattern is very
4667 inefficient or too complex. This may already happen with the pattern
4668 "\(.\)*" on a very long line. ".*" works much better.
4669 Vim may run out of memory before hitting the 'maxmempattern' limit.
4670
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 *'maxmemtot'* *'mmt'*
4672'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4673 dependent) or half the amount of memory
4674 available)
4675 global
4676 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004677 Maximum amount of memory in Kbyte to use for all buffers together.
4678 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4679 without a limit. On 64 bit machines higher values might work. But
4680 hey, do you really need more than 2 Gbyte for text editing?
4681 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682
4683 *'menuitems'* *'mis'*
4684'menuitems' 'mis' number (default 25)
4685 global
4686 {not in Vi}
4687 {not available when compiled without the |+menu|
4688 feature}
4689 Maximum number of items to use in a menu. Used for menus that are
4690 generated from a list of items, e.g., the Buffers menu. Changing this
4691 option has no direct effect, the menu must be refreshed first.
4692
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004693 *'mkspellmem'* *'msm'*
4694'mkspellmem' 'msm' string (default "460000,2000,500")
4695 global
4696 {not in Vi}
4697 {not available when compiled without the |+syntax|
4698 feature}
4699 Parameters for |:mkspell|. This tunes when to start compressing the
4700 word tree. Compression can be slow when there are many words, but
4701 it's needed to avoid running out of memory. The amount of memory used
4702 per word depends very much on how similar the words are, that's why
4703 this tuning is complicated.
4704
4705 There are three numbers, separated by commas:
4706 {start},{inc},{added}
4707
4708 For most languages the uncompressed word tree fits in memory. {start}
4709 gives the amount of memory in Kbyte that can be used before any
4710 compression is done. It should be a bit smaller than the amount of
4711 memory that is available to Vim.
4712
4713 When going over the {start} limit the {inc} number specifies the
4714 amount of memory in Kbyte that can be allocated before another
4715 compression is done. A low number means compression is done after
4716 less words are added, which is slow. A high number means more memory
4717 will be allocated.
4718
4719 After doing compression, {added} times 1024 words can be added before
4720 the {inc} limit is ignored and compression is done when any extra
4721 amount of memory is needed. A low number means there is a smaller
4722 chance of hitting the {inc} limit, less memory is used but it's
4723 slower.
4724
4725 The languages for which these numbers are important are Italian and
4726 Hungarian. The default works for when you have about 512 Mbyte. If
4727 you have 1 Gbyte you could use: >
4728 :set mkspellmem=900000,3000,800
4729< If you have less than 512 Mbyte |:mkspell| may fail for some
4730 languages, no matter what you set 'mkspellmem' to.
4731
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004733'modeline' 'ml' boolean (Vim default: on (off for root),
4734 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 local to buffer
4736 *'modelines'* *'mls'*
4737'modelines' 'mls' number (default 5)
4738 global
4739 {not in Vi}
4740 If 'modeline' is on 'modelines' gives the number of lines that is
4741 checked for set commands. If 'modeline' is off or 'modelines' is zero
4742 no lines are checked. See |modeline|.
4743 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4744 set and to the Vim default value when 'compatible' is reset.
4745
4746 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4747'modifiable' 'ma' boolean (default on)
4748 local to buffer
4749 {not in Vi} *E21*
4750 When off the buffer contents cannot be changed. The 'fileformat' and
4751 'fileencoding' options also can't be changed.
4752 Can be reset with the |-M| command line argument.
4753
4754 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4755'modified' 'mod' boolean (default off)
4756 local to buffer
4757 {not in Vi}
4758 When on, the buffer is considered to be modified. This option is set
4759 when:
4760 1. A change was made to the text since it was last written. Using the
4761 |undo| command to go back to the original text will reset the
4762 option. But undoing changes that were made before writing the
4763 buffer will set the option again, since the text is different from
4764 when it was written.
4765 2. 'fileformat' or 'fileencoding' is different from its original
4766 value. The original value is set when the buffer is read or
4767 written. A ":set nomodified" command also resets the original
4768 values to the current values and the 'modified' option will be
4769 reset.
4770 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4771 will be ignored.
4772
4773 *'more'* *'nomore'*
4774'more' boolean (Vim default: on, Vi default: off)
4775 global
4776 {not in Vi}
4777 When on, listings pause when the whole screen is filled. You will get
4778 the |more-prompt|. When this option is off there are no pauses, the
4779 listing continues until finished.
4780 NOTE: This option is set to the Vi default value when 'compatible' is
4781 set and to the Vim default value when 'compatible' is reset.
4782
4783 *'mouse'* *E538*
4784'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4785 global
4786 {not in Vi}
4787 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004788 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4789 sysmouse and Linux console with gpm). For using the mouse in the
4790 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 The mouse can be enabled for different modes:
4792 n Normal mode
4793 v Visual mode
4794 i Insert mode
4795 c Command-line mode
4796 h all previous modes when editing a help file
4797 a all previous modes
4798 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 Normally you would enable the mouse in all four modes with: >
4800 :set mouse=a
4801< When the mouse is not enabled, the GUI will still use the mouse for
4802 modeless selection. This doesn't move the text cursor.
4803
4804 See |mouse-using|. Also see |'clipboard'|.
4805
4806 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004807 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808 the mouse buttons can still be used by keeping the shift key pressed.
4809 Also see the 'clipboard' option.
4810
4811 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4812'mousefocus' 'mousef' boolean (default off)
4813 global
4814 {not in Vi}
4815 {only works in the GUI}
4816 The window that the mouse pointer is on is automatically activated.
4817 When changing the window layout or window focus in another way, the
4818 mouse pointer is moved to the window with keyboard focus. Off is the
4819 default because it makes using the pull down menus a little goofy, as
4820 a pointer transit may activate a window unintentionally.
4821
4822 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4823'mousehide' 'mh' boolean (default on)
4824 global
4825 {not in Vi}
4826 {only works in the GUI}
4827 When on, the mouse pointer is hidden when characters are typed.
4828 The mouse pointer is restored when the mouse is moved.
4829
4830 *'mousemodel'* *'mousem'*
4831'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4832 global
4833 {not in Vi}
4834 Sets the model to use for the mouse. The name mostly specifies what
4835 the right mouse button is used for:
4836 extend Right mouse button extends a selection. This works
4837 like in an xterm.
4838 popup Right mouse button pops up a menu. The shifted left
4839 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004840 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 popup_setpos Like "popup", but the cursor will be moved to the
4842 position where the mouse was clicked, and thus the
4843 selected operation will act upon the clicked object.
4844 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004845 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 course, that right clicking outside a selection will
4847 end Visual mode.
4848 Overview of what button does what for each model:
4849 mouse extend popup(_setpos) ~
4850 left click place cursor place cursor
4851 left drag start selection start selection
4852 shift-left search word extend selection
4853 right click extend selection popup menu (place cursor)
4854 right drag extend selection -
4855 middle click paste paste
4856
4857 In the "popup" model the right mouse button produces a pop-up menu.
4858 You need to define this first, see |popup-menu|.
4859
4860 Note that you can further refine the meaning of buttons with mappings.
4861 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4862 selection (because that's handled in the GUI code directly).
4863
4864 The 'mousemodel' option is set by the |:behave| command.
4865
4866 *'mouseshape'* *'mouses'* *E547*
4867'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004868 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 global
4870 {not in Vi}
4871 {only available when compiled with the |+mouseshape|
4872 feature}
4873 This option tells Vim what the mouse pointer should look like in
4874 different modes. The option is a comma separated list of parts, much
4875 like used for 'guicursor'. Each part consist of a mode/location-list
4876 and an argument-list:
4877 mode-list:shape,mode-list:shape,..
4878 The mode-list is a dash separated list of these modes/locations:
4879 In a normal window: ~
4880 n Normal mode
4881 v Visual mode
4882 ve Visual mode with 'selection' "exclusive" (same as 'v',
4883 if not specified)
4884 o Operator-pending mode
4885 i Insert mode
4886 r Replace mode
4887
4888 Others: ~
4889 c appending to the command-line
4890 ci inserting in the command-line
4891 cr replacing in the command-line
4892 m at the 'Hit ENTER' or 'More' prompts
4893 ml idem, but cursor in the last line
4894 e any mode, pointer below last window
4895 s any mode, pointer on a status line
4896 sd any mode, while dragging a status line
4897 vs any mode, pointer on a vertical separator line
4898 vd any mode, while dragging a vertical separator line
4899 a everywhere
4900
4901 The shape is one of the following:
4902 avail name looks like ~
4903 w x arrow Normal mouse pointer
4904 w x blank no pointer at all (use with care!)
4905 w x beam I-beam
4906 w x updown up-down sizing arrows
4907 w x leftright left-right sizing arrows
4908 w x busy The system's usual busy pointer
4909 w x no The system's usual 'no input' pointer
4910 x udsizing indicates up-down resizing
4911 x lrsizing indicates left-right resizing
4912 x crosshair like a big thin +
4913 x hand1 black hand
4914 x hand2 white hand
4915 x pencil what you write with
4916 x question big ?
4917 x rightup-arrow arrow pointing right-up
4918 w x up-arrow arrow pointing up
4919 x <number> any X11 pointer number (see X11/cursorfont.h)
4920
4921 The "avail" column contains a 'w' if the shape is available for Win32,
4922 x for X11.
4923 Any modes not specified or shapes not available use the normal mouse
4924 pointer.
4925
4926 Example: >
4927 :set mouseshape=s:udsizing,m:no
4928< will make the mouse turn to a sizing arrow over the status lines and
4929 indicate no input when the hit-enter prompt is displayed (since
4930 clicking the mouse has no effect in this state.)
4931
4932 *'mousetime'* *'mouset'*
4933'mousetime' 'mouset' number (default 500)
4934 global
4935 {not in Vi}
4936 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4937 time in msec between two mouse clicks for the second click to be
4938 recognized as a multi click.
4939
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004940 *'mzquantum'* *'mzq'*
4941'mzquantum' 'mzq' number (default 100)
4942 global
4943 {not in Vi}
4944 {not available when compiled without the |+mzscheme|
4945 feature}
4946 The number of milliseconds between polls for MzScheme threads.
4947 Negative or zero value means no thread scheduling.
4948
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949 *'nrformats'* *'nf'*
4950'nrformats' 'nf' string (default "octal,hex")
4951 local to buffer
4952 {not in Vi}
4953 This defines what bases Vim will consider for numbers when using the
4954 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4955 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004956 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02004958 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00004959 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004961 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962 considered to be hexadecimal. Example: Using CTRL-X on
4963 "0x100" results in "0x0ff".
4964 Numbers which simply begin with a digit in the range 1-9 are always
4965 considered decimal. This also happens for numbers that are not
4966 recognized as octal or hex.
4967
4968 *'number'* *'nu'* *'nonumber'* *'nonu'*
4969'number' 'nu' boolean (default off)
4970 local to window
4971 Print the line number in front of each line. When the 'n' option is
4972 excluded from 'cpoptions' a wrapped line will not use the column of
4973 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004974 The 'numberwidth' option can be used to set the room used for the line
4975 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 When a long, wrapped line doesn't start with the first character, '-'
4977 characters are put before the number.
4978 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02004979 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004981 *'numberwidth'* *'nuw'*
4982'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4983 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004984 {not in Vi}
4985 {only available when compiled with the |+linebreak|
4986 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004987 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02004988 when the 'number' or 'relativenumber' option is set or printing lines
4989 with a line number. Since one space is always between the number and
4990 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004991 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02004992 fit the highest line number in the buffer respectively the number of
4993 rows in the window, depending on whether 'number' or 'relativenumber'
4994 is set. Thus with the Vim default of 4 there is room for a line number
4995 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004996 The minimum value is 1, the maximum value is 10.
4997 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4998
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004999 *'omnifunc'* *'ofu'*
5000'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005001 local to buffer
5002 {not in Vi}
5003 {not available when compiled without the +eval
5004 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005005 This option specifies a function to be used for Insert mode omni
5006 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005007 See |complete-functions| for an explanation of how the function is
5008 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005009 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005010 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005011
5012
Bram Moolenaar02467872007-05-06 13:22:01 +00005013 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005014'opendevice' 'odev' boolean (default off)
5015 global
5016 {not in Vi}
5017 {only for MS-DOS, MS-Windows and OS/2}
5018 Enable reading and writing from devices. This may get Vim stuck on a
5019 device that can be opened but doesn't actually do the I/O. Therefore
5020 it is off by default.
5021 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5022 result in editing a device.
5023
5024
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005025 *'operatorfunc'* *'opfunc'*
5026'operatorfunc' 'opfunc' string (default: empty)
5027 global
5028 {not in Vi}
5029 This option specifies a function to be called by the |g@| operator.
5030 See |:map-operator| for more info and an example.
5031
5032 This option cannot be set from a |modeline| or in the |sandbox|, for
5033 security reasons.
5034
5035
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 *'osfiletype'* *'oft'* *E366*
5037'osfiletype' 'oft' string (RISC-OS default: "Text",
5038 others default: "")
5039 local to buffer
5040 {not in Vi}
5041 {only available when compiled with the |+osfiletype|
5042 feature}
5043 Some operating systems store extra information about files besides
5044 name, datestamp and permissions. This option contains the extra
5045 information, the nature of which will vary between systems.
5046 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005047 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 It can affect the pattern matching of the automatic commands.
5049 |autocmd-osfiletypes|
5050
5051 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005052'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053 global
5054 Specifies the nroff macros that separate paragraphs. These are pairs
5055 of two letters (see |object-motions|).
5056
5057 *'paste'* *'nopaste'*
5058'paste' boolean (default off)
5059 global
5060 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005061 Put Vim in Paste mode. This is useful if you want to cut or copy
5062 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063 unexpected effects.
5064 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005065 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066 knows about pasting and will mostly do the right thing without 'paste'
5067 being set. The same is true for a terminal where Vim handles the
5068 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005069 This option is reset when starting the GUI. Thus if you set it in
5070 your .vimrc it will work in a terminal, but not in the GUI. Setting
5071 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5072 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005073 When the 'paste' option is switched on (also when it was already on):
5074 - mapping in Insert mode and Command-line mode is disabled
5075 - abbreviations are disabled
5076 - 'textwidth' is set to 0
5077 - 'wrapmargin' is set to 0
5078 - 'autoindent' is reset
5079 - 'smartindent' is reset
5080 - 'softtabstop' is set to 0
5081 - 'revins' is reset
5082 - 'ruler' is reset
5083 - 'showmatch' is reset
5084 - 'formatoptions' is used like it is empty
5085 These options keep their value, but their effect is disabled:
5086 - 'lisp'
5087 - 'indentexpr'
5088 - 'cindent'
5089 NOTE: When you start editing another file while the 'paste' option is
5090 on, settings from the modelines or autocommands may change the
5091 settings again, causing trouble when pasting text. You might want to
5092 set the 'paste' option again.
5093 When the 'paste' option is reset the mentioned options are restored to
5094 the value before the moment 'paste' was switched from off to on.
5095 Resetting 'paste' before ever setting it does not have any effect.
5096 Since mapping doesn't work while 'paste' is active, you need to use
5097 the 'pastetoggle' option to toggle the 'paste' option with some key.
5098
5099 *'pastetoggle'* *'pt'*
5100'pastetoggle' 'pt' string (default "")
5101 global
5102 {not in Vi}
5103 When non-empty, specifies the key sequence that toggles the 'paste'
5104 option. This is like specifying a mapping: >
5105 :map {keys} :set invpaste<CR>
5106< Where {keys} is the value of 'pastetoggle'.
5107 The difference is that it will work even when 'paste' is set.
5108 'pastetoggle' works in Insert mode and Normal mode, but not in
5109 Command-line mode.
5110 Mappings are checked first, thus overrule 'pastetoggle'. However,
5111 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5112 this: >
5113 :map <F10> :set paste<CR>
5114 :map <F11> :set nopaste<CR>
5115 :imap <F10> <C-O>:set paste<CR>
5116 :imap <F11> <nop>
5117 :set pastetoggle=<F11>
5118< This will make <F10> start paste mode and <F11> stop paste mode.
5119 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5120 mode everything is inserted literally, except the 'pastetoggle' key
5121 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005122 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123
5124 *'pex'* *'patchexpr'*
5125'patchexpr' 'pex' string (default "")
5126 global
5127 {not in Vi}
5128 {not available when compiled without the |+diff|
5129 feature}
5130 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005131 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132
5133 *'patchmode'* *'pm'* *E206*
5134'patchmode' 'pm' string (default "")
5135 global
5136 {not in Vi}
5137 When non-empty the oldest version of a file is kept. This can be used
5138 to keep the original version of a file if you are changing files in a
5139 source distribution. Only the first time that a file is written a
5140 copy of the original file will be kept. The name of the copy is the
5141 name of the original file with the string in the 'patchmode' option
5142 appended. This option should start with a dot. Use a string like
5143 ".org". 'backupdir' must not be empty for this to work (Detail: The
5144 backup file is renamed to the patchmode file after the new file has
5145 been successfully written, that's why it must be possible to write a
5146 backup file). If there was no file to be backed up, an empty file is
5147 created.
5148 When the 'backupskip' pattern matches, a patchmode file is not made.
5149 Using 'patchmode' for compressed files appends the extension at the
5150 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5151 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005152 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153
5154 *'path'* *'pa'* *E343* *E345* *E347*
5155'path' 'pa' string (default on Unix: ".,/usr/include,,"
5156 on OS/2: ".,/emx/include,,"
5157 other systems: ".,,")
5158 global or local to buffer |global-local|
5159 {not in Vi}
5160 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005161 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5162 provided that the file being searched for has a relative path (not
5163 starting with "/", "./" or "../"). The directories in the 'path'
5164 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165 - Use commas to separate directory names: >
5166 :set path=.,/usr/local/include,/usr/include
5167< - Spaces can also be used to separate directory names (for backwards
5168 compatibility with version 3.0). To have a space in a directory
5169 name, precede it with an extra backslash, and escape the space: >
5170 :set path=.,/dir/with\\\ space
5171< - To include a comma in a directory name precede it with an extra
5172 backslash: >
5173 :set path=.,/dir/with\\,comma
5174< - To search relative to the directory of the current file, use: >
5175 :set path=.
5176< - To search in the current directory use an empty string between two
5177 commas: >
5178 :set path=,,
5179< - A directory name may end in a ':' or '/'.
5180 - Environment variables are expanded |:set_env|.
5181 - When using |netrw.vim| URLs can be used. For example, adding
5182 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005183 - Search upwards and downwards in a directory tree using "*", "**" and
5184 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 {not available when compiled without the |+path_extra| feature}
5186 - Careful with '\' characters, type two to get one in the option: >
5187 :set path=.,c:\\include
5188< Or just use '/' instead: >
5189 :set path=.,c:/include
5190< Don't forget "." or files won't even be found in the same directory as
5191 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005192 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 it is something like 256 or 1024 characters.
5194 You can check if all the include files are found, using the value of
5195 'path', see |:checkpath|.
5196 The use of |:set+=| and |:set-=| is preferred when adding or removing
5197 directories from the list. This avoids problems when a future version
5198 uses another default. To remove the current directory use: >
5199 :set path-=
5200< To add the current directory use: >
5201 :set path+=
5202< To use an environment variable, you probably need to replace the
5203 separator. Here is an example to append $INCL, in which directory
5204 names are separated with a semi-colon: >
5205 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5206< Replace the ';' with a ':' or whatever separator is used. Note that
5207 this doesn't work when $INCL contains a comma or white space.
5208
5209 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5210'preserveindent' 'pi' boolean (default off)
5211 local to buffer
5212 {not in Vi}
5213 When changing the indent of the current line, preserve as much of the
5214 indent structure as possible. Normally the indent is replaced by a
5215 series of tabs followed by spaces as required (unless |'expandtab'| is
5216 enabled, in which case only spaces are used). Enabling this option
5217 means the indent will preserve as many existing characters as possible
5218 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005219 'expandtab' does not apply to the preserved white space, a Tab remains
5220 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 NOTE: When using ">>" multiple times the resulting indent is a mix of
5222 tabs and spaces. You might not like this.
5223 NOTE: 'preserveindent' is reset when 'compatible' is set.
5224 Also see 'copyindent'.
5225 Use |:retab| to clean up white space.
5226
5227 *'previewheight'* *'pvh'*
5228'previewheight' 'pvh' number (default 12)
5229 global
5230 {not in Vi}
5231 {not available when compiled without the |+windows| or
5232 |+quickfix| feature}
5233 Default height for a preview window. Used for |:ptag| and associated
5234 commands. Used for |CTRL-W_}| when no count is given.
5235
5236 *'previewwindow'* *'nopreviewwindow'*
5237 *'pvw'* *'nopvw'* *E590*
5238'previewwindow' 'pvw' boolean (default off)
5239 local to window
5240 {not in Vi}
5241 {not available when compiled without the |+windows| or
5242 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005243 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244 set. It's normally not set directly, but by using one of the commands
5245 |:ptag|, |:pedit|, etc.
5246
5247 *'printdevice'* *'pdev'*
5248'printdevice' 'pdev' string (default empty)
5249 global
5250 {not in Vi}
5251 {only available when compiled with the |+printer|
5252 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005253 The name of the printer to be used for |:hardcopy|.
5254 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005255 This option cannot be set from a |modeline| or in the |sandbox|, for
5256 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257
Bram Moolenaar8299df92004-07-10 09:47:34 +00005258 *'printencoding'* *'penc'*
5259'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 global
5261 {not in Vi}
5262 {only available when compiled with the |+printer|
5263 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005264 Sets the character encoding used when printing.
5265 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266
5267 *'printexpr'* *'pexpr'*
5268'printexpr' 'pexpr' String (default: see below)
5269 global
5270 {not in Vi}
5271 {only available when compiled with the |+printer|
5272 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005273 Expression used to print the PostScript produced with |:hardcopy|.
5274 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275
Bram Moolenaar8299df92004-07-10 09:47:34 +00005276 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277'printfont' 'pfn' string (default "courier")
5278 global
5279 {not in Vi}
5280 {only available when compiled with the |+printer|
5281 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005282 The name of the font that will be used for |:hardcopy|.
5283 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284
5285 *'printheader'* *'pheader'*
5286'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5287 global
5288 {not in Vi}
5289 {only available when compiled with the |+printer|
5290 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005291 The format of the header produced in |:hardcopy| output.
5292 See |pheader-option|.
5293
5294 *'printmbcharset'* *'pmbcs'*
5295'printmbcharset' 'pmbcs' string (default "")
5296 global
5297 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005298 {only available when compiled with the |+printer|,
5299 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005300 The CJK character set to be used for CJK output from |:hardcopy|.
5301 See |pmbcs-option|.
5302
5303 *'printmbfont'* *'pmbfn'*
5304'printmbfont' 'pmbfn' string (default "")
5305 global
5306 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005307 {only available when compiled with the |+printer|,
5308 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005309 List of font names to be used for CJK output from |:hardcopy|.
5310 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311
5312 *'printoptions'* *'popt'*
5313'printoptions' 'popt' string (default "")
5314 global
5315 {not in Vi}
5316 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005317 List of items that control the format of the output of |:hardcopy|.
5318 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005320 *'prompt'* *'noprompt'*
5321'prompt' boolean (default on)
5322 global
5323 When on a ":" prompt is used in Ex mode.
5324
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005325 *'pumheight'* *'ph'*
5326'pumheight' 'ph' number (default 0)
5327 global
5328 {not available when compiled without the
5329 |+insert_expand| feature}
5330 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005331 Determines the maximum number of items to show in the popup menu for
5332 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005333 |ins-completion-menu|.
5334
5335
Bram Moolenaar677ee682005-01-27 14:41:15 +00005336 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005337'quoteescape' 'qe' string (default "\")
5338 local to buffer
5339 {not in Vi}
5340 The characters that are used to escape quotes in a string. Used for
5341 objects like a', a" and a` |a'|.
5342 When one of the characters in this option is found inside a string,
5343 the following character will be skipped. The default value makes the
5344 text "foo\"bar\\" considered to be one string.
5345
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5347'readonly' 'ro' boolean (default off)
5348 local to buffer
5349 If on, writes fail unless you use a '!'. Protects you from
5350 accidentally overwriting a file. Default on when Vim is started
5351 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005352 When using ":w!" the 'readonly' option is reset for the current
5353 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005355 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005356
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005357 *'redrawtime'* *'rdt'*
5358'redrawtime' 'rdt' number (default 2000)
5359 global
5360 {not in Vi}
5361 {only available when compiled with the |+reltime|
5362 feature}
5363 The time in milliseconds for redrawing the display. This applies to
5364 searching for patterns for 'hlsearch' and |:match| highlighting.
5365 When redrawing takes more than this many milliseconds no further
5366 matches will be highlighted. This is used to avoid that Vim hangs
5367 when using a very complicated pattern.
5368
Bram Moolenaar64486672010-05-16 15:46:46 +02005369 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5370'relativenumber' 'rnu' boolean (default off)
5371 local to window
5372 {not in Vi}
5373 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005374 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005375 precede some vertical motion commands (e.g. j k + -) with, without
5376 having to calculate it yourself. Especially useful in combination with
5377 other commands (e.g. y d c < > gq gw =).
5378 When the 'n' option is excluded from 'cpoptions' a wrapped
5379 line will not use the column of line numbers (this is the default when
5380 'compatible' isn't set).
5381 The 'numberwidth' option can be used to set the room used for the line
5382 number.
5383 When a long, wrapped line doesn't start with the first character, '-'
5384 characters are put before the number.
5385 See |hl-LineNr| for the highlighting used for the number.
5386 When setting this option, 'number' is reset.
5387
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 *'remap'* *'noremap'*
5389'remap' boolean (default on)
5390 global
5391 Allows for mappings to work recursively. If you do not want this for
5392 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005393 NOTE: To avoid portability problems with Vim scripts, always keep
5394 this option at the default "on". Only switch it off when working with
5395 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396
5397 *'report'*
5398'report' number (default 2)
5399 global
5400 Threshold for reporting number of lines changed. When the number of
5401 changed lines is more than 'report' a message will be given for most
5402 ":" commands. If you want it always, set 'report' to 0.
5403 For the ":substitute" command the number of substitutions is used
5404 instead of the number of lines.
5405
5406 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5407'restorescreen' 'rs' boolean (default on)
5408 global
5409 {not in Vi} {only in Windows 95/NT console version}
5410 When set, the screen contents is restored when exiting Vim. This also
5411 happens when executing external commands.
5412
5413 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5414 options in your .vimrc. To disable restoring:
5415 set t_ti= t_te=
5416 To enable restoring (for an xterm):
5417 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5418 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5419
5420 *'revins'* *'ri'* *'norevins'* *'nori'*
5421'revins' 'ri' boolean (default off)
5422 global
5423 {not in Vi}
5424 {only available when compiled with the |+rightleft|
5425 feature}
5426 Inserting characters in Insert mode will work backwards. See "typing
5427 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5428 command in Insert mode, when 'allowrevins' is set.
5429 NOTE: This option is reset when 'compatible' or 'paste' is set.
5430
5431 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5432'rightleft' 'rl' boolean (default off)
5433 local to window
5434 {not in Vi}
5435 {only available when compiled with the |+rightleft|
5436 feature}
5437 When on, display orientation becomes right-to-left, i.e., characters
5438 that are stored in the file appear from the right to the left.
5439 Using this option, it is possible to edit files for languages that
5440 are written from the right to the left such as Hebrew and Arabic.
5441 This option is per window, so it is possible to edit mixed files
5442 simultaneously, or to view the same file in both ways (this is
5443 useful whenever you have a mixed text file with both right-to-left
5444 and left-to-right strings so that both sets are displayed properly
5445 in different windows). Also see |rileft.txt|.
5446
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005447 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448'rightleftcmd' 'rlc' string (default "search")
5449 local to window
5450 {not in Vi}
5451 {only available when compiled with the |+rightleft|
5452 feature}
5453 Each word in this option enables the command line editing to work in
5454 right-to-left mode for a group of commands:
5455
5456 search "/" and "?" commands
5457
5458 This is useful for languages such as Hebrew, Arabic and Farsi.
5459 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5460
5461 *'ruler'* *'ru'* *'noruler'* *'noru'*
5462'ruler' 'ru' boolean (default off)
5463 global
5464 {not in Vi}
5465 {not available when compiled without the
5466 |+cmdline_info| feature}
5467 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005468 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 text in the file is shown on the far right:
5470 Top first line is visible
5471 Bot last line is visible
5472 All first and last line are visible
5473 45% relative position in the file
5474 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005475 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005477 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005478 this option takes precedence over 'ruler' and 'rulerformat'
5479 If the number of characters displayed is different from the number of
5480 bytes in the text (e.g., for a TAB or a multi-byte character), both
5481 the text column (byte number) and the screen column are shown,
5482 separated with a dash.
5483 For an empty line "0-1" is shown.
5484 For an empty buffer the line number will also be zero: "0,0-1".
5485 This option is reset when the 'paste' option is set.
5486 If you don't want to see the ruler all the time but want to know where
5487 you are, use "g CTRL-G" |g_CTRL-G|.
5488 NOTE: This option is reset when 'compatible' is set.
5489
5490 *'rulerformat'* *'ruf'*
5491'rulerformat' 'ruf' string (default empty)
5492 global
5493 {not in Vi}
5494 {not available when compiled without the |+statusline|
5495 feature}
5496 When this option is not empty, it determines the content of the ruler
5497 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005498 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 The default ruler width is 17 characters. To make the ruler 15
5500 characters wide, put "%15(" at the start and "%)" at the end.
5501 Example: >
5502 :set rulerformat=%15(%c%V\ %p%%%)
5503<
5504 *'runtimepath'* *'rtp'* *vimfiles*
5505'runtimepath' 'rtp' string (default:
5506 Unix: "$HOME/.vim,
5507 $VIM/vimfiles,
5508 $VIMRUNTIME,
5509 $VIM/vimfiles/after,
5510 $HOME/.vim/after"
5511 Amiga: "home:vimfiles,
5512 $VIM/vimfiles,
5513 $VIMRUNTIME,
5514 $VIM/vimfiles/after,
5515 home:vimfiles/after"
5516 PC, OS/2: "$HOME/vimfiles,
5517 $VIM/vimfiles,
5518 $VIMRUNTIME,
5519 $VIM/vimfiles/after,
5520 $HOME/vimfiles/after"
5521 Macintosh: "$VIM:vimfiles,
5522 $VIMRUNTIME,
5523 $VIM:vimfiles:after"
5524 RISC-OS: "Choices:vimfiles,
5525 $VIMRUNTIME,
5526 Choices:vimfiles/after"
5527 VMS: "sys$login:vimfiles,
5528 $VIM/vimfiles,
5529 $VIMRUNTIME,
5530 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005531 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 global
5533 {not in Vi}
5534 This is a list of directories which will be searched for runtime
5535 files:
5536 filetype.vim filetypes by file name |new-filetype|
5537 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005538 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005539 colors/ color scheme files |:colorscheme|
5540 compiler/ compiler files |:compiler|
5541 doc/ documentation |write-local-help|
5542 ftplugin/ filetype plugins |write-filetype-plugin|
5543 indent/ indent scripts |indent-expression|
5544 keymap/ key mapping files |mbyte-keymap|
5545 lang/ menu translations |:menutrans|
5546 menu.vim GUI menus |menu.vim|
5547 plugin/ plugin scripts |write-plugin|
5548 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005549 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550 syntax/ syntax files |mysyntaxfile|
5551 tutor/ files for vimtutor |tutor|
5552
5553 And any other file searched for with the |:runtime| command.
5554
5555 The defaults for most systems are setup to search five locations:
5556 1. In your home directory, for your personal preferences.
5557 2. In a system-wide Vim directory, for preferences from the system
5558 administrator.
5559 3. In $VIMRUNTIME, for files distributed with Vim.
5560 *after-directory*
5561 4. In the "after" directory in the system-wide Vim directory. This is
5562 for the system administrator to overrule or add to the distributed
5563 defaults (rarely needed)
5564 5. In the "after" directory in your home directory. This is for
5565 personal preferences to overrule or add to the distributed defaults
5566 or system-wide settings (rarely needed).
5567
5568 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5569 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005570 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 wildcards.
5572 See |:runtime|.
5573 Example: >
5574 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5575< This will use the directory "~/vimruntime" first (containing your
5576 personal Vim runtime files), then "/mygroup/vim" (shared between a
5577 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5578 files).
5579 You probably should always include $VIMRUNTIME somewhere, to use the
5580 distributed runtime files. You can put a directory before $VIMRUNTIME
5581 to find files which replace a distributed runtime files. You can put
5582 a directory after $VIMRUNTIME to find files which add to distributed
5583 runtime files.
5584 This option cannot be set from a |modeline| or in the |sandbox|, for
5585 security reasons.
5586
5587 *'scroll'* *'scr'*
5588'scroll' 'scr' number (default: half the window height)
5589 local to window
5590 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5591 set to half the number of lines in the window when the window size
5592 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005593 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5595 the number of screen lines instead of file lines, makes a difference
5596 when lines wrap}
5597
5598 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5599'scrollbind' 'scb' boolean (default off)
5600 local to window
5601 {not in Vi}
5602 {not available when compiled without the |+scrollbind|
5603 feature}
5604 See also |scroll-binding|. When this option is set, the current
5605 window scrolls as other scrollbind windows (windows that also have
5606 this option set) scroll. This option is useful for viewing the
5607 differences between two versions of a file, see 'diff'.
5608 See |'scrollopt'| for options that determine how this option should be
5609 interpreted.
5610 This option is mostly reset when splitting a window to edit another
5611 file. This means that ":split | edit file" results in two windows
5612 with scroll-binding, but ":split file" does not.
5613
5614 *'scrolljump'* *'sj'*
5615'scrolljump' 'sj' number (default 1)
5616 global
5617 {not in Vi}
5618 Minimal number of lines to scroll when the cursor gets off the
5619 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5620 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005621 When set to a negative number from -1 to -100 this is used as the
5622 percentage of the window height. Thus -50 scrolls half the window
5623 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005624 NOTE: This option is set to 1 when 'compatible' is set.
5625
5626 *'scrolloff'* *'so'*
5627'scrolloff' 'so' number (default 0)
5628 global
5629 {not in Vi}
5630 Minimal number of screen lines to keep above and below the cursor.
5631 This will make some context visible around where you are working. If
5632 you set it to a very large value (999) the cursor line will always be
5633 in the middle of the window (except at the start or end of the file or
5634 when long lines wrap).
5635 For scrolling horizontally see 'sidescrolloff'.
5636 NOTE: This option is set to 0 when 'compatible' is set.
5637
5638 *'scrollopt'* *'sbo'*
5639'scrollopt' 'sbo' string (default "ver,jump")
5640 global
5641 {not available when compiled without the |+scrollbind|
5642 feature}
5643 {not in Vi}
5644 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005645 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5646 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 The following words are available:
5648 ver Bind vertical scrolling for 'scrollbind' windows
5649 hor Bind horizontal scrolling for 'scrollbind' windows
5650 jump Applies to the offset between two windows for vertical
5651 scrolling. This offset is the difference in the first
5652 displayed line of the bound windows. When moving
5653 around in a window, another 'scrollbind' window may
5654 reach a position before the start or after the end of
5655 the buffer. The offset is not changed though, when
5656 moving back the 'scrollbind' window will try to scroll
5657 to the desired position when possible.
5658 When now making that window the current one, two
5659 things can be done with the relative offset:
5660 1. When "jump" is not included, the relative offset is
5661 adjusted for the scroll position in the new current
5662 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005663 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664 2. When "jump" is included, the other windows are
5665 scrolled to keep the same relative offset. When
5666 going back to the other window, it still uses the
5667 same relative offset.
5668 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005669 When 'diff' mode is active there always is vertical scroll binding,
5670 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671
5672 *'sections'* *'sect'*
5673'sections' 'sect' string (default "SHNHH HUnhsh")
5674 global
5675 Specifies the nroff macros that separate sections. These are pairs of
5676 two letters (See |object-motions|). The default makes a section start
5677 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5678
5679 *'secure'* *'nosecure'* *E523*
5680'secure' boolean (default off)
5681 global
5682 {not in Vi}
5683 When on, ":autocmd", shell and write commands are not allowed in
5684 ".vimrc" and ".exrc" in the current directory and map commands are
5685 displayed. Switch it off only if you know that you will not run into
5686 problems, or when the 'exrc' option is off. On Unix this option is
5687 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005688 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689 'secure' at the end of your ~/.vimrc then.
5690 This option cannot be set from a |modeline| or in the |sandbox|, for
5691 security reasons.
5692
5693 *'selection'* *'sel'*
5694'selection' 'sel' string (default "inclusive")
5695 global
5696 {not in Vi}
5697 This option defines the behavior of the selection. It is only used
5698 in Visual and Select mode.
5699 Possible values:
5700 value past line inclusive ~
5701 old no yes
5702 inclusive yes yes
5703 exclusive yes no
5704 "past line" means that the cursor is allowed to be positioned one
5705 character past the line.
5706 "inclusive" means that the last character of the selection is included
5707 in an operation. For example, when "x" is used to delete the
5708 selection.
5709 Note that when "exclusive" is used and selecting from the end
5710 backwards, you cannot include the last character of a line, when
5711 starting in Normal mode and 'virtualedit' empty.
5712
5713 The 'selection' option is set by the |:behave| command.
5714
5715 *'selectmode'* *'slm'*
5716'selectmode' 'slm' string (default "")
5717 global
5718 {not in Vi}
5719 This is a comma separated list of words, which specifies when to start
5720 Select mode instead of Visual mode, when a selection is started.
5721 Possible values:
5722 mouse when using the mouse
5723 key when using shifted special keys
5724 cmd when using "v", "V" or CTRL-V
5725 See |Select-mode|.
5726 The 'selectmode' option is set by the |:behave| command.
5727
5728 *'sessionoptions'* *'ssop'*
5729'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005730 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731 global
5732 {not in Vi}
5733 {not available when compiled without the +mksession
5734 feature}
5735 Changes the effect of the |:mksession| command. It is a comma
5736 separated list of words. Each word enables saving and restoring
5737 something:
5738 word save and restore ~
5739 blank empty windows
5740 buffers hidden and unloaded buffers, not just those in windows
5741 curdir the current directory
5742 folds manually created folds, opened/closed folds and local
5743 fold options
5744 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005745 and contain at least one lowercase letter. Only
5746 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747 help the help window
5748 localoptions options and mappings local to a window or buffer (not
5749 global values for local options)
5750 options all options and mappings (also global values for local
5751 options)
5752 resize size of the Vim window: 'lines' and 'columns'
5753 sesdir the directory in which the session file is located
5754 will become the current directory (useful with
5755 projects accessed over a network from different
5756 systems)
5757 slash backslashes in file names replaced with forward
5758 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005759 tabpages all tab pages; without this only the current tab page
5760 is restored, so that you can make a session for each
5761 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762 unix with Unix end-of-line format (single <NL>), even when
5763 on Windows or DOS
5764 winpos position of the whole Vim window
5765 winsize window sizes
5766
5767 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005768 When neither "curdir" nor "sesdir" is included, file names are stored
5769 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770 "slash" and "unix" are useful on Windows when sharing session files
5771 with Unix. The Unix version of Vim cannot source dos format scripts,
5772 but the Windows version of Vim can source unix format scripts.
5773
5774 *'shell'* *'sh'* *E91*
5775'shell' 'sh' string (default $SHELL or "sh",
5776 MS-DOS and Win32: "command.com" or
5777 "cmd.exe", OS/2: "cmd")
5778 global
5779 Name of the shell to use for ! and :! commands. When changing the
5780 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5781 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005782 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 See |option-backslash| about including spaces and backslashes.
5784 Environment variables are expanded |:set_env|.
5785 If the name of the shell contains a space, you might need to enclose
5786 it in quotes. Example: >
5787 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5788< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005789 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790 "-f" is not inside the quotes, because it is not part of the command
5791 name. And Vim automagically recognizes the backslashes that are path
5792 separators.
5793 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5794 variable to change the way external commands are executed. See the
5795 libc.inf file of DJGPP.
5796 Under MS-Windows, when the executable ends in ".com" it must be
5797 included. Thus setting the shell to "command.com" or "4dos.com"
5798 works, but "command" and "4dos" do not work for all commands (e.g.,
5799 filtering).
5800 For unknown reasons, when using "4dos.com" the current directory is
5801 changed to "C:\". To avoid this set 'shell' like this: >
5802 :set shell=command.com\ /c\ 4dos
5803< This option cannot be set from a |modeline| or in the |sandbox|, for
5804 security reasons.
5805
5806 *'shellcmdflag'* *'shcf'*
5807'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5808 does not contain "sh" somewhere: "/c")
5809 global
5810 {not in Vi}
5811 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5812 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5813 systems, the default is set according to the value of 'shell', to
5814 reduce the need to set this option by the user. It's not used for
5815 OS/2 (EMX figures this out itself). See |option-backslash| about
5816 including spaces and backslashes. See |dos-shell|.
5817 This option cannot be set from a |modeline| or in the |sandbox|, for
5818 security reasons.
5819
5820 *'shellpipe'* *'sp'*
5821'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5822 global
5823 {not in Vi}
5824 {not available when compiled without the |+quickfix|
5825 feature}
5826 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005827 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 including spaces and backslashes.
5829 The name of the temporary file can be represented by "%s" if necessary
5830 (the file name is appended automatically if no %s appears in the value
5831 of this option).
5832 For the Amiga and MS-DOS the default is ">". The output is directly
5833 saved in a file and not echoed to the screen.
5834 For Unix the default it "| tee". The stdout of the compiler is saved
5835 in a file and echoed to the screen. If the 'shell' option is "csh" or
5836 "tcsh" after initializations, the default becomes "|& tee". If the
5837 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005838 "2>&1| tee". This means that stderr is also included. Before using
5839 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005840 The initialization of this option is done after reading the ".vimrc"
5841 and the other initializations, so that when the 'shell' option is set
5842 there, the 'shellpipe' option changes automatically, unless it was
5843 explicitly set before.
5844 When 'shellpipe' is set to an empty string, no redirection of the
5845 ":make" output will be done. This is useful if you use a 'makeprg'
5846 that writes to 'makeef' by itself. If you want no piping, but do
5847 want to include the 'makeef', set 'shellpipe' to a single space.
5848 Don't forget to precede the space with a backslash: ":set sp=\ ".
5849 In the future pipes may be used for filtering and this option will
5850 become obsolete (at least for Unix).
5851 This option cannot be set from a |modeline| or in the |sandbox|, for
5852 security reasons.
5853
5854 *'shellquote'* *'shq'*
5855'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5856 contains "sh" somewhere: "\"")
5857 global
5858 {not in Vi}
5859 Quoting character(s), put around the command passed to the shell, for
5860 the "!" and ":!" commands. The redirection is kept outside of the
5861 quoting. See 'shellxquote' to include the redirection. It's
5862 probably not useful to set both options.
5863 This is an empty string by default. Only known to be useful for
5864 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5865 or bash, where it should be "\"". The default is adjusted according
5866 the value of 'shell', to reduce the need to set this option by the
5867 user. See |dos-shell|.
5868 This option cannot be set from a |modeline| or in the |sandbox|, for
5869 security reasons.
5870
5871 *'shellredir'* *'srr'*
5872'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5873 global
5874 {not in Vi}
5875 String to be used to put the output of a filter command in a temporary
5876 file. See also |:!|. See |option-backslash| about including spaces
5877 and backslashes.
5878 The name of the temporary file can be represented by "%s" if necessary
5879 (the file name is appended automatically if no %s appears in the value
5880 of this option).
5881 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5882 or "zsh" during initializations, the default becomes ">&". If the
5883 'shell' option is "sh", "ksh" or "bash" the default becomes
5884 ">%s 2>&1". This means that stderr is also included.
5885 For Win32, the Unix checks are done and additionally "cmd" is checked
5886 for, which makes the default ">%s 2>&1". Also, the same names with
5887 ".exe" appended are checked for.
5888 The initialization of this option is done after reading the ".vimrc"
5889 and the other initializations, so that when the 'shell' option is set
5890 there, the 'shellredir' option changes automatically unless it was
5891 explicitly set before.
5892 In the future pipes may be used for filtering and this option will
5893 become obsolete (at least for Unix).
5894 This option cannot be set from a |modeline| or in the |sandbox|, for
5895 security reasons.
5896
5897 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5898'shellslash' 'ssl' boolean (default off)
5899 global
5900 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5901 When set, a forward slash is used when expanding file names. This is
5902 useful when a Unix-like shell is used instead of command.com or
5903 cmd.exe. Backward slashes can still be typed, but they are changed to
5904 forward slashes by Vim.
5905 Note that setting or resetting this option has no effect for some
5906 existing file names, thus this option needs to be set before opening
5907 any file for best results. This might change in the future.
5908 'shellslash' only works when a backslash can be used as a path
5909 separator. To test if this is so use: >
5910 if exists('+shellslash')
5911<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005912 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5913'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5914 global
5915 {not in Vi}
5916 When on, use temp files for shell commands. When off use a pipe.
5917 When using a pipe is not possible temp files are used anyway.
5918 Currently a pipe is only supported on Unix. You can check it with: >
5919 :if has("filterpipe")
5920< The advantage of using a pipe is that nobody can read the temp file
5921 and the 'shell' command does not need to support redirection.
5922 The advantage of using a temp file is that the file type and encoding
5923 can be detected.
5924 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5925 |FilterWritePost| autocommands event are not triggered when
5926 'shelltemp' is off.
5927
Bram Moolenaar071d4272004-06-13 20:20:40 +00005928 *'shelltype'* *'st'*
5929'shelltype' 'st' number (default 0)
5930 global
5931 {not in Vi} {only for the Amiga}
5932 On the Amiga this option influences the way how the commands work
5933 which use a shell.
5934 0 and 1: always use the shell
5935 2 and 3: use the shell only to filter lines
5936 4 and 5: use shell only for ':sh' command
5937 When not using the shell, the command is executed directly.
5938
5939 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5940 1 and 3: use "shell cmd" to start external commands
5941
5942 *'shellxquote'* *'sxq'*
5943'shellxquote' 'sxq' string (default: "";
5944 for Win32, when 'shell' contains "sh"
5945 somewhere: "\""
5946 for Unix, when using system(): "\"")
5947 global
5948 {not in Vi}
5949 Quoting character(s), put around the command passed to the shell, for
5950 the "!" and ":!" commands. Includes the redirection. See
5951 'shellquote' to exclude the redirection. It's probably not useful
5952 to set both options.
5953 This is an empty string by default. Known to be useful for
5954 third-party shells when using the Win32 version, such as the MKS Korn
5955 Shell or bash, where it should be "\"". The default is adjusted
5956 according the value of 'shell', to reduce the need to set this option
5957 by the user. See |dos-shell|.
5958 This option cannot be set from a |modeline| or in the |sandbox|, for
5959 security reasons.
5960
5961 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5962'shiftround' 'sr' boolean (default off)
5963 global
5964 {not in Vi}
5965 Round indent to multiple of 'shiftwidth'. Applies to > and <
5966 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5967 a multiple of 'shiftwidth' (this is Vi compatible).
5968 NOTE: This option is reset when 'compatible' is set.
5969
5970 *'shiftwidth'* *'sw'*
5971'shiftwidth' 'sw' number (default 8)
5972 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005973 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974 |'cindent'|, |>>|, |<<|, etc.
5975
5976 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005977'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5978 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005979 global
5980 {not in Vi}
5981 This option helps to avoid all the |hit-enter| prompts caused by file
5982 messages, for example with CTRL-G, and to avoid some other messages.
5983 It is a list of flags:
5984 flag meaning when present ~
5985 f use "(3 of 5)" instead of "(file 3 of 5)"
5986 i use "[noeol]" instead of "[Incomplete last line]"
5987 l use "999L, 888C" instead of "999 lines, 888 characters"
5988 m use "[+]" instead of "[Modified]"
5989 n use "[New]" instead of "[New File]"
5990 r use "[RO]" instead of "[readonly]"
5991 w use "[w]" instead of "written" for file write message
5992 and "[a]" instead of "appended" for ':w >> file' command
5993 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5994 "[unix format]" and "[mac]" instead of "[mac format]".
5995 a all of the above abbreviations
5996
5997 o overwrite message for writing a file with subsequent message
5998 for reading a file (useful for ":wn" or when 'autowrite' on)
5999 O message for reading a file overwrites any previous message.
6000 Also for quickfix message (e.g., ":cn").
6001 s don't give "search hit BOTTOM, continuing at TOP" or "search
6002 hit TOP, continuing at BOTTOM" messages
6003 t truncate file message at the start if it is too long to fit
6004 on the command-line, "<" will appear in the left most column.
6005 Ignored in Ex mode.
6006 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006007 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 Ignored in Ex mode.
6009 W don't give "written" or "[w]" when writing a file
6010 A don't give the "ATTENTION" message when an existing swap file
6011 is found.
6012 I don't give the intro message when starting Vim |:intro|.
6013
6014 This gives you the opportunity to avoid that a change between buffers
6015 requires you to hit <Enter>, but still gives as useful a message as
6016 possible for the space available. To get the whole message that you
6017 would have got with 'shm' empty, use ":file!"
6018 Useful values:
6019 shm= No abbreviation of message.
6020 shm=a Abbreviation, but no loss of information.
6021 shm=at Abbreviation, and truncate message when necessary.
6022
6023 NOTE: This option is set to the Vi default value when 'compatible' is
6024 set and to the Vim default value when 'compatible' is reset.
6025
6026 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6027'shortname' 'sn' boolean (default off)
6028 local to buffer
6029 {not in Vi, not in MS-DOS versions}
6030 Filenames are assumed to be 8 characters plus one extension of 3
6031 characters. Multiple dots in file names are not allowed. When this
6032 option is on, dots in file names are replaced with underscores when
6033 adding an extension (".~" or ".swp"). This option is not available
6034 for MS-DOS, because then it would always be on. This option is useful
6035 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6036 or crossdos. When running the Win32 GUI version under Win32s, this
6037 option is always on by default.
6038
6039 *'showbreak'* *'sbr'* *E595*
6040'showbreak' 'sbr' string (default "")
6041 global
6042 {not in Vi}
6043 {not available when compiled without the |+linebreak|
6044 feature}
6045 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006046 values are "> " or "+++ ": >
6047 :set showbreak=>\
6048< Note the backslash to escape the trailing space. It's easier like
6049 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006050 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006051< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006052 comma (in a future version the comma might be used to separate the
6053 part that is shown at the end and at the start of a line).
6054 The characters are highlighted according to the '@' flag in
6055 'highlight'.
6056 Note that tabs after the showbreak will be displayed differently.
6057 If you want the 'showbreak' to appear in between line numbers, add the
6058 "n" flag to 'cpoptions'.
6059
6060 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6061'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6062 off)
6063 global
6064 {not in Vi}
6065 {not available when compiled without the
6066 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006067 Show (partial) command in the last line of the screen. Set this
6068 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006069 In Visual mode the size of the selected area is shown:
6070 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006071 If the number of bytes is different it is also displayed: "2-6"
6072 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006073 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006074 - When selecting a block, the size in screen characters:
6075 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006076 NOTE: This option is set to the Vi default value when 'compatible' is
6077 set and to the Vim default value when 'compatible' is reset.
6078
6079 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6080'showfulltag' 'sft' boolean (default off)
6081 global
6082 {not in Vi}
6083 When completing a word in insert mode (see |ins-completion|) from the
6084 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006085 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006086 matched a C function, you can see a template for what arguments are
6087 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006088 Note that this doesn't work well together with having "longest" in
6089 'completeopt', because the completion from the search pattern may not
6090 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091
6092 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6093'showmatch' 'sm' boolean (default off)
6094 global
6095 When a bracket is inserted, briefly jump to the matching one. The
6096 jump is only done if the match can be seen on the screen. The time to
6097 show the match can be set with 'matchtime'.
6098 A Beep is given if there is no match (no matter if the match can be
6099 seen or not). This option is reset when the 'paste' option is set.
6100 When the 'm' flag is not included in 'cpoptions', typing a character
6101 will immediately move the cursor back to where it belongs.
6102 See the "sm" field in 'guicursor' for setting the cursor shape and
6103 blinking when showing the match.
6104 The 'matchpairs' option can be used to specify the characters to show
6105 matches for. 'rightleft' and 'revins' are used to look for opposite
6106 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006107 Also see the matchparen plugin for highlighting the match when moving
6108 around |pi_paren.txt|.
6109 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006110
6111 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6112'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6113 global
6114 If in Insert, Replace or Visual mode put a message on the last line.
6115 Use the 'M' flag in 'highlight' to set the type of highlighting for
6116 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006117 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118 doesn't mean XIM is really active, especially when 'imactivatekey' is
6119 not set.
6120 NOTE: This option is set to the Vi default value when 'compatible' is
6121 set and to the Vim default value when 'compatible' is reset.
6122
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006123 *'showtabline'* *'stal'*
6124'showtabline' 'stal' number (default 1)
6125 global
6126 {not in Vi}
6127 {not available when compiled without the +windows
6128 feature}
6129 The value of this option specifies when the line with tab page labels
6130 will be displayed:
6131 0: never
6132 1: only if there are at least two tab pages
6133 2: always
6134 This is both for the GUI and non-GUI implementation of the tab pages
6135 line.
6136 See |tab-page| for more information about tab pages.
6137
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 *'sidescroll'* *'ss'*
6139'sidescroll' 'ss' number (default 0)
6140 global
6141 {not in Vi}
6142 The minimal number of columns to scroll horizontally. Used only when
6143 the 'wrap' option is off and the cursor is moved off of the screen.
6144 When it is zero the cursor will be put in the middle of the screen.
6145 When using a slow terminal set it to a large number or 0. When using
6146 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6147 commands.
6148
6149 *'sidescrolloff'* *'siso'*
6150'sidescrolloff' 'siso' number (default 0)
6151 global
6152 {not in Vi}
6153 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006154 right of the cursor if 'nowrap' is set. Setting this option to a
6155 value greater than 0 while having |'sidescroll'| also at a non-zero
6156 value makes some context visible in the line you are scrolling in
6157 horizontally (except at beginning of the line). Setting this option
6158 to a large value (like 999) has the effect of keeping the cursor
6159 horizontally centered in the window, as long as one does not come too
6160 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 NOTE: This option is set to 0 when 'compatible' is set.
6162
6163 Example: Try this together with 'sidescroll' and 'listchars' as
6164 in the following example to never allow the cursor to move
6165 onto the "extends" character:
6166
6167 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6168 :set sidescrolloff=1
6169
6170
6171 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6172'smartcase' 'scs' boolean (default off)
6173 global
6174 {not in Vi}
6175 Override the 'ignorecase' option if the search pattern contains upper
6176 case characters. Only used when the search pattern is typed and
6177 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006178 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6180 recalling the search pattern from history and hitting <Enter>.
6181 NOTE: This option is reset when 'compatible' is set.
6182
6183 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6184'smartindent' 'si' boolean (default off)
6185 local to buffer
6186 {not in Vi}
6187 {not available when compiled without the
6188 |+smartindent| feature}
6189 Do smart autoindenting when starting a new line. Works for C-like
6190 programs, but can also be used for other languages. 'cindent' does
6191 something like this, works better in most cases, but is more strict,
6192 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6193 'indentexpr' is a more advanced alternative.
6194 Normally 'autoindent' should also be on when using 'smartindent'.
6195 An indent is automatically inserted:
6196 - After a line ending in '{'.
6197 - After a line starting with a keyword from 'cinwords'.
6198 - Before a line starting with '}' (only with the "O" command).
6199 When typing '}' as the first character in a new line, that line is
6200 given the same indent as the matching '{'.
6201 When typing '#' as the first character in a new line, the indent for
6202 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006203 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6205 When using the ">>" command, lines starting with '#' are not shifted
6206 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006207 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 is set smart indenting is disabled.
6209
6210 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6211'smarttab' 'sta' boolean (default off)
6212 global
6213 {not in Vi}
6214 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006215 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6216 <BS> will delete a 'shiftwidth' worth of space at the start of the
6217 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006218 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006219 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6220 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006221 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006222 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006223 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006224 NOTE: This option is reset when 'compatible' is set.
6225
6226 *'softtabstop'* *'sts'*
6227'softtabstop' 'sts' number (default 0)
6228 local to buffer
6229 {not in Vi}
6230 Number of spaces that a <Tab> counts for while performing editing
6231 operations, like inserting a <Tab> or using <BS>. It "feels" like
6232 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6233 used. This is useful to keep the 'ts' setting at its standard value
6234 of 8, while being able to edit like it is set to 'sts'. However,
6235 commands like "x" still work on the actual characters.
6236 When 'sts' is zero, this feature is off.
6237 'softtabstop' is set to 0 when the 'paste' option is set.
6238 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6239 spaces is minimized by using <Tab>s.
6240 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6241 set.
6242 NOTE: This option is set to 0 when 'compatible' is set.
6243
Bram Moolenaar217ad922005-03-20 22:37:15 +00006244 *'spell'* *'nospell'*
6245'spell' boolean (default off)
6246 local to window
6247 {not in Vi}
6248 {not available when compiled without the |+syntax|
6249 feature}
6250 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006251 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006252
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006253 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006254'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006255 local to buffer
6256 {not in Vi}
6257 {not available when compiled without the |+syntax|
6258 feature}
6259 Pattern to locate the end of a sentence. The following word will be
6260 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006261 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006262 When this check is not wanted make this option empty.
6263 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006264 Be careful with special characters, see |option-backslash| about
6265 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006266 To set this option automatically depending on the language, see
6267 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006268
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006269 *'spellfile'* *'spf'*
6270'spellfile' 'spf' string (default empty)
6271 local to buffer
6272 {not in Vi}
6273 {not available when compiled without the |+syntax|
6274 feature}
6275 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006276 commands. It must end in ".{encoding}.add". You need to include the
6277 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006278 *E765*
6279 It may also be a comma separated list of names. A count before the
6280 |zg| and |zw| commands can be used to access each. This allows using
6281 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006282 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006283 you: Using the first directory in 'runtimepath' that is writable. If
6284 there is no "spell" directory yet it will be created. For the file
6285 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006286 ignoring the region.
6287 The resulting ".spl" file will be used for spell checking, it does not
6288 have to appear in 'spelllang'.
6289 Normally one file is used for all regions, but you can add the region
6290 name if you want to. However, it will then only be used when
6291 'spellfile' is set to it, for entries in 'spelllang' only files
6292 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006293 This option cannot be set from a |modeline| or in the |sandbox|, for
6294 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006295
Bram Moolenaar217ad922005-03-20 22:37:15 +00006296 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006297'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006298 local to buffer
6299 {not in Vi}
6300 {not available when compiled without the |+syntax|
6301 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006302 A comma separated list of word list names. When the 'spell' option is
6303 on spellchecking will be done for these languages. Example: >
6304 set spelllang=en_us,nl,medical
6305< This means US English, Dutch and medical words are recognized. Words
6306 that are not recognized will be highlighted.
6307 The word list name must not include a comma or dot. Using a dash is
6308 recommended to separate the two letter language name from a
6309 specification. Thus "en-rare" is used for rare English words.
6310 A region name must come last and have the form "_xx", where "xx" is
6311 the two-letter, lower case region name. You can use more than one
6312 region by listing them: "en_us,en_ca" supports both US and Canadian
6313 English, but not words specific for Australia, New Zealand or Great
6314 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006315 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006316 As a special case the name of a .spl file can be given as-is. The
6317 first "_xx" in the name is removed and used as the region name
6318 (_xx is an underscore, two letters and followed by a non-letter).
6319 This is mainly for testing purposes. You must make sure the correct
6320 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006321 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006322 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6323 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006324 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006325
Bram Moolenaar98692072006-02-04 00:57:42 +00006326 If the |spellfile.vim| plugin is active and you use a language name
6327 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6328 will ask you if you want to download the file.
6329
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006330 After this option has been set successfully, Vim will source the files
6331 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006332 up to the first comma, dot or underscore.
6333 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006334
6335
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006336 *'spellsuggest'* *'sps'*
6337'spellsuggest' 'sps' string (default "best")
6338 global
6339 {not in Vi}
6340 {not available when compiled without the |+syntax|
6341 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006342 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006343 the |spellsuggest()| function. This is a comma-separated list of
6344 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006345
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006346 best Internal method that works best for English. Finds
6347 changes like "fast" and uses a bit of sound-a-like
6348 scoring to improve the ordering.
6349
6350 double Internal method that uses two methods and mixes the
6351 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006352 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006353 word. That only works when the language specifies
6354 sound folding. Can be slow and doesn't always give
6355 better results.
6356
6357 fast Internal method that only checks for simple changes:
6358 character inserts/deletes/swaps. Works well for
6359 simple typing mistakes.
6360
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006361 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006362 Not used for |spellsuggest()|. The number of
6363 suggestions is never more than the value of 'lines'
6364 minus two.
6365
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006366 file:{filename} Read file {filename}, which must have two columns,
6367 separated by a slash. The first column contains the
6368 bad word, the second column the suggested good word.
6369 Example:
6370 theribal/terrible ~
6371 Use this for common mistakes that do not appear at the
6372 top of the suggestion list with the internal methods.
6373 Lines without a slash are ignored, use this for
6374 comments.
6375 The file is used for all languages.
6376
6377 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6378 trouble with spaces. |v:val| holds the badly spelled
6379 word. The expression must evaluate to a List of
6380 Lists, each with a suggestion and a score.
6381 Example:
6382 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006383 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006384 internal methods use. A lower score is better.
6385 This may invoke |spellsuggest()| if you temporarily
6386 set 'spellsuggest' to exclude the "expr:" part.
6387 Errors are silently ignored, unless you set the
6388 'verbose' option to a non-zero value.
6389
6390 Only one of "best", "double" or "fast" may be used. The others may
6391 appear several times in any order. Example: >
6392 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6393<
6394 This option cannot be set from a |modeline| or in the |sandbox|, for
6395 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006396
6397
Bram Moolenaar071d4272004-06-13 20:20:40 +00006398 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6399'splitbelow' 'sb' boolean (default off)
6400 global
6401 {not in Vi}
6402 {not available when compiled without the +windows
6403 feature}
6404 When on, splitting a window will put the new window below the current
6405 one. |:split|
6406
6407 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6408'splitright' 'spr' boolean (default off)
6409 global
6410 {not in Vi}
6411 {not available when compiled without the +vertsplit
6412 feature}
6413 When on, splitting a window will put the new window right of the
6414 current one. |:vsplit|
6415
6416 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6417'startofline' 'sol' boolean (default on)
6418 global
6419 {not in Vi}
6420 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006421 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006422 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006423 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424 with a linewise operator, with "%" with a count and to buffer changing
6425 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6426 only has a line number, e.g., ":25" or ":+".
6427 In case of buffer changing commands the cursor is placed at the column
6428 where it was the last time the buffer was edited.
6429 NOTE: This option is set when 'compatible' is set.
6430
6431 *'statusline'* *'stl'* *E540* *E541* *E542*
6432'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006433 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006434 {not in Vi}
6435 {not available when compiled without the |+statusline|
6436 feature}
6437 When nonempty, this option determines the content of the status line.
6438 Also see |status-line|.
6439
6440 The option consists of printf style '%' items interspersed with
6441 normal text. Each status line item is of the form:
6442 %-0{minwid}.{maxwid}{item}
6443 All fields except the {item} is optional. A single percent sign can
6444 be given as "%%". Up to 80 items can be specified.
6445
Bram Moolenaar238a5642006-02-21 22:12:05 +00006446 When the option starts with "%!" then it is used as an expression,
6447 evaluated and the result is used as the option value. Example: >
6448 :set statusline=%!MyStatusLine()
6449< The result can contain %{} items that will be evaluated too.
6450
6451 When there is error while evaluating the option then it will be made
6452 empty to avoid further errors. Otherwise screen updating would loop.
6453
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454 Note that the only effect of 'ruler' when this option is set (and
6455 'laststatus' is 2) is controlling the output of |CTRL-G|.
6456
6457 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006458 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006460 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 minwid Minimum width of the item, padding as set by '-' & '0'.
6462 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006463 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464 on the left for text items. Numeric items will be
6465 shifted down to maxwid-2 digits followed by '>'number
6466 where number is the amount of missing digits, much like
6467 an exponential notation.
6468 item A one letter code as described below.
6469
6470 Following is a description of the possible statusline items. The
6471 second character in "item" is the type:
6472 N for number
6473 S for string
6474 F for flags as described below
6475 - not applicable
6476
6477 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006478 f S Path to the file in the buffer, as typed or relative to current
6479 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 F S Full path to the file in the buffer.
6481 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006482 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006484 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006486 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006488 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006489 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006490 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6492 {not available when compiled without |+autocmd| feature}
6493 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6494 being used: "<keymap>"
6495 n N Buffer number.
6496 b N Value of byte under cursor.
6497 B N As above, in hexadecimal.
6498 o N Byte number in file of byte under cursor, first byte is 1.
6499 Mnemonic: Offset from start of file (with one added)
6500 {not available when compiled without |+byte_offset| feature}
6501 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006502 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 l N Line number.
6504 L N Number of lines in buffer.
6505 c N Column number.
6506 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006507 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 p N Percentage through file in lines as in |CTRL-G|.
6509 P S Percentage through file of displayed window. This is like the
6510 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006511 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006513 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006514 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 ( - Start of item group. Can be used for setting the width and
6516 alignment of a section. Must be followed by %) somewhere.
6517 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006518 T N For 'tabline': start of tab page N label. Use %T after the last
6519 label. This information is used for mouse clicks.
6520 X N For 'tabline': start of close tab N label. Use %X after the
6521 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6522 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523 < - Where to truncate line if too long. Default is at the start.
6524 No width fields allowed.
6525 = - Separation point between left and right aligned items.
6526 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006527 # - Set highlight group. The name must follow and then a # again.
6528 Thus use %#HLname# for highlight group HLname. The same
6529 highlighting is used, also for the statusline of non-current
6530 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006532 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533 The difference between User{N} and StatusLine will be applied
6534 to StatusLineNC for the statusline of non-current windows.
6535 The number N must be between 1 and 9. See |hl-User1..9|
6536
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006537 When displaying a flag, Vim removes the leading comma, if any, when
6538 that flag comes right after plaintext. This will make a nice display
6539 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540
Bram Moolenaar582fd852005-03-28 20:58:01 +00006541 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006542 not set) and a minwid is not set for the group, the whole group will
6543 become empty. This will make a group like the following disappear
6544 completely from the statusline when none of the flags are set. >
6545 :set statusline=...%(\ [%M%R%H]%)...
6546<
6547 Beware that an expression is evaluated each and every time the status
6548 line is displayed. The current buffer and current window will be set
6549 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006550 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006552 real current buffer.
6553
6554 The 'statusline' option may be evaluated in the |sandbox|, see
6555 |sandbox-option|.
6556
6557 It is not allowed to change text or jump to another window while
6558 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559
6560 If the statusline is not updated when you want it (e.g., after setting
6561 a variable that's used in an expression), you can force an update by
6562 setting an option without changing its value. Example: >
6563 :let &ro = &ro
6564
6565< A result of all digits is regarded a number for display purposes.
6566 Otherwise the result is taken as flag text and applied to the rules
6567 described above.
6568
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006569 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6571 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6572
6573 Examples:
6574 Emulate standard status line with 'ruler' set >
6575 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6576< Similar, but add ASCII value of char under the cursor (like "ga") >
6577 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6578< Display byte count and byte value, modified flag in red. >
6579 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6580 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6581< Display a ,GZ flag if a compressed file is loaded >
6582 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6583< In the |:autocmd|'s: >
6584 :let b:gzflag = 1
6585< And: >
6586 :unlet b:gzflag
6587< And define this function: >
6588 :function VarExists(var, val)
6589 : if exists(a:var) | return a:val | else | return '' | endif
6590 :endfunction
6591<
6592 *'suffixes'* *'su'*
6593'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6594 global
6595 {not in Vi}
6596 Files with these suffixes get a lower priority when multiple files
6597 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006598 suffixes. Spaces after the comma are ignored. A dot is also seen as
6599 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 separator, precede it with a backslash (see |option-backslash| about
6601 including spaces and backslashes).
6602 See 'wildignore' for completely ignoring files.
6603 The use of |:set+=| and |:set-=| is preferred when adding or removing
6604 suffixes from the list. This avoids problems when a future version
6605 uses another default.
6606
6607 *'suffixesadd'* *'sua'*
6608'suffixesadd' 'sua' string (default "")
6609 local to buffer
6610 {not in Vi}
6611 {not available when compiled without the
6612 |+file_in_path| feature}
6613 Comma separated list of suffixes, which are used when searching for a
6614 file for the "gf", "[I", etc. commands. Example: >
6615 :set suffixesadd=.java
6616<
6617 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6618'swapfile' 'swf' boolean (default on)
6619 local to buffer
6620 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006621 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 swapfile is not wanted for a specific buffer. For example, with
6623 confidential information that even root must not be able to access.
6624 Careful: All text will be in memory:
6625 - Don't use this for big files.
6626 - Recovery will be impossible!
6627 A swapfile will only be present when |'updatecount'| is non-zero and
6628 'swapfile' is set.
6629 When 'swapfile' is reset, the swap file for the current buffer is
6630 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6631 non-zero, a swap file is immediately created.
6632 Also see |swap-file| and |'swapsync'|.
6633
6634 This option is used together with 'bufhidden' and 'buftype' to
6635 specify special kinds of buffers. See |special-buffers|.
6636
6637 *'swapsync'* *'sws'*
6638'swapsync' 'sws' string (default "fsync")
6639 global
6640 {not in Vi}
6641 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006642 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006643 When this option is empty parts of the swap file may be in memory and
6644 not written to disk. When the system crashes you may lose more work.
6645 On Unix the system does a sync now and then without Vim asking for it,
6646 so the disadvantage of setting this option off is small. On some
6647 systems the swap file will not be written at all. For a unix system
6648 setting it to "sync" will use the sync() call instead of the default
6649 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006650 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651
6652 *'switchbuf'* *'swb'*
6653'switchbuf' 'swb' string (default "")
6654 global
6655 {not in Vi}
6656 This option controls the behavior when switching between buffers.
6657 Possible values (comma separated list):
6658 useopen If included, jump to the first open window that
6659 contains the specified buffer (if there is one).
6660 Otherwise: Do not examine other windows.
6661 This setting is checked with |quickfix| commands, when
6662 jumping to errors (":cc", ":cn", "cp", etc.). It is
6663 also used in all buffer related split commands, for
6664 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006665 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006666 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006668 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006670 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006671 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006673 *'synmaxcol'* *'smc'*
6674'synmaxcol' 'smc' number (default 3000)
6675 local to buffer
6676 {not in Vi}
6677 {not available when compiled without the |+syntax|
6678 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006679 Maximum column in which to search for syntax items. In long lines the
6680 text after this column is not highlighted and following lines may not
6681 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006682 This helps to avoid very slow redrawing for an XML file that is one
6683 long line.
6684 Set to zero to remove the limit.
6685
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686 *'syntax'* *'syn'*
6687'syntax' 'syn' string (default empty)
6688 local to buffer
6689 {not in Vi}
6690 {not available when compiled without the |+syntax|
6691 feature}
6692 When this option is set, the syntax with this name is loaded, unless
6693 syntax highlighting has been switched off with ":syntax off".
6694 Otherwise this option does not always reflect the current syntax (the
6695 b:current_syntax variable does).
6696 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006697 not automatically recognized. Example, in an IDL file:
6698 /* vim: set syntax=idl : */ ~
6699 When a dot appears in the value then this separates two filetype
6700 names. Example:
6701 /* vim: set syntax=c.doxygen : */ ~
6702 This will use the "c" syntax first, then the "doxygen" syntax.
6703 Note that the second one must be prepared to be loaded as an addition,
6704 otherwise it will be skipped. More than one dot may appear.
6705 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 :set syntax=OFF
6707< To switch syntax highlighting on according to the current value of the
6708 'filetype' option: >
6709 :set syntax=ON
6710< What actually happens when setting the 'syntax' option is that the
6711 Syntax autocommand event is triggered with the value as argument.
6712 This option is not copied to another buffer, independent of the 's' or
6713 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006714 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006716 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006717'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006718 global
6719 {not in Vi}
6720 {not available when compiled without the +windows
6721 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006722 When nonempty, this option determines the content of the tab pages
6723 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006724 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006725
6726 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006727 option and only when there is no GUI tab line. When 'e' is in
6728 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6729 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006730
6731 The value is evaluated like with 'statusline'. You can use
6732 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006733 the text to be displayed. Use "%1T" for the first label, "%2T" for
6734 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006735
6736 Keep in mind that only one of the tab pages is the current one, others
6737 are invisible and you can't jump to their windows.
6738
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006739
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006740 *'tabpagemax'* *'tpm'*
6741'tabpagemax' 'tpm' number (default 10)
6742 global
6743 {not in Vi}
6744 {not available when compiled without the +windows
6745 feature}
6746 Maximum number of tab pages to be opened by the |-p| command line
6747 argument or the ":tab all" command. |tabpage|
6748
6749
6750 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751'tabstop' 'ts' number (default 8)
6752 local to buffer
6753 Number of spaces that a <Tab> in the file counts for. Also see
6754 |:retab| command, and 'softtabstop' option.
6755
6756 Note: Setting 'tabstop' to any other value than 8 can make your file
6757 appear wrong in many places (e.g., when printing it).
6758
6759 There are four main ways to use tabs in Vim:
6760 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6761 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006762 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 behave like a tab appears every 4 (or 3) characters.
6764 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6765 'expandtab'. This way you will always insert spaces. The
6766 formatting will never be messed up when 'tabstop' is changed.
6767 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006768 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769 works when using Vim to edit the file.
6770 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6771 'noexpandtab'. This should then work (for initial indents only)
6772 for any tabstop setting that people use. It might be nice to have
6773 tabs after the first non-blank inserted as spaces if you do this
6774 though. Otherwise aligned comments will be wrong when 'tabstop' is
6775 changed.
6776
6777 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6778'tagbsearch' 'tbs' boolean (default on)
6779 global
6780 {not in Vi}
6781 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006782 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 searching makes searching for a tag a LOT faster, but a linear search
6784 will find more tags if the tags file wasn't properly sorted.
6785 Vim normally assumes that your tags files are sorted, or indicate that
6786 they are not sorted. Only when this is not the case does the
6787 'tagbsearch' option need to be switched off.
6788
6789 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006790 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791 certain files, or retry all files with a linear search. When
6792 'tagbsearch' is off, only a linear search is done.
6793
6794 Linear searching is done anyway, for one file, when Vim finds a line
6795 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006796 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797< [The whitespace before and after the '0' must be a single <Tab>]
6798
6799 When a binary search was done and no match was found in any of the
6800 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6801 instead of a normal tag name, a retry is done with a linear search.
6802 Tags in unsorted tags files, and matches with different case will only
6803 be found in the retry.
6804
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006805 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 linear search can be avoided for the 'ignorecase' case. Use a value
6807 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6808 case-fold sorted with the -f switch to "sort" in most unices, as in
6809 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006810 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6811 for this as well. Note that case must be folded to uppercase for this
6812 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813
6814 When 'tagbsearch' is off, tags searching is slower when a full match
6815 exists, but faster when no full match exists. Tags in unsorted tags
6816 files may only be found with 'tagbsearch' off.
6817 When the tags file is not sorted, or sorted in a wrong way (not on
6818 ASCII byte value), 'tagbsearch' should be off, or the line given above
6819 must be included in the tags file.
6820 This option doesn't affect commands that find all matching tags (e.g.,
6821 command-line completion and ":help").
6822 {Vi: always uses binary search in some versions}
6823
6824 *'taglength'* *'tl'*
6825'taglength' 'tl' number (default 0)
6826 global
6827 If non-zero, tags are significant up to this number of characters.
6828
6829 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6830'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6831 global
6832 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006833 If on and using a tags file in another directory, file names in that
6834 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835 NOTE: This option is set to the Vi default value when 'compatible' is
6836 set and to the Vim default value when 'compatible' is reset.
6837
6838 *'tags'* *'tag'* *E433*
6839'tags' 'tag' string (default "./tags,tags", when compiled with
6840 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6841 global or local to buffer |global-local|
6842 Filenames for the tag command, separated by spaces or commas. To
6843 include a space or comma in a file name, precede it with a backslash
6844 (see |option-backslash| about including spaces and backslashes).
6845 When a file name starts with "./", the '.' is replaced with the path
6846 of the current file. But only when the 'd' flag is not included in
6847 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6848 |tags-option|.
6849 "*", "**" and other wildcards can be used to search for tags files in
6850 a directory tree. See |file-searching|. {not available when compiled
6851 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006852 The |tagfiles()| function can be used to get a list of the file names
6853 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6855 files are also supported. They are automatically recognized. The
6856 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6857 differences are ignored (MS-Windows). |emacs-tags|
6858 The use of |:set+=| and |:set-=| is preferred when adding or removing
6859 file names from the list. This avoids problems when a future version
6860 uses another default.
6861 {Vi: default is "tags /usr/lib/tags"}
6862
6863 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6864'tagstack' 'tgst' boolean (default on)
6865 global
6866 {not in all versions of Vi}
6867 When on, the |tagstack| is used normally. When off, a ":tag" or
6868 ":tselect" command with an argument will not push the tag onto the
6869 tagstack. A following ":tag" without an argument, a ":pop" command or
6870 any other command that uses the tagstack will use the unmodified
6871 tagstack, but does change the pointer to the active entry.
6872 Resetting this option is useful when using a ":tag" command in a
6873 mapping which should not change the tagstack.
6874
6875 *'term'* *E529* *E530* *E531*
6876'term' string (default is $TERM, if that fails:
6877 in the GUI: "builtin_gui"
6878 on Amiga: "amiga"
6879 on BeOS: "beos-ansi"
6880 on Mac: "mac-ansi"
6881 on MiNT: "vt52"
6882 on MS-DOS: "pcterm"
6883 on OS/2: "os2ansi"
6884 on Unix: "ansi"
6885 on VMS: "ansi"
6886 on Win 32: "win32")
6887 global
6888 Name of the terminal. Used for choosing the terminal control
6889 characters. Environment variables are expanded |:set_env|.
6890 For example: >
6891 :set term=$TERM
6892< See |termcap|.
6893
6894 *'termbidi'* *'tbidi'*
6895 *'notermbidi'* *'notbidi'*
6896'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6897 global
6898 {not in Vi}
6899 {only available when compiled with the |+arabic|
6900 feature}
6901 The terminal is in charge of Bi-directionality of text (as specified
6902 by Unicode). The terminal is also expected to do the required shaping
6903 that some languages (such as Arabic) require.
6904 Setting this option implies that 'rightleft' will not be set when
6905 'arabic' is set and the value of 'arabicshape' will be ignored.
6906 Note that setting 'termbidi' has the immediate effect that
6907 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6908 This option is reset when the GUI is started.
6909 For further details see |arabic.txt|.
6910
6911 *'termencoding'* *'tenc'*
6912'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6913 Macintosh GUI: "macroman")
6914 global
6915 {only available when compiled with the |+multi_byte|
6916 feature}
6917 {not in Vi}
6918 Encoding used for the terminal. This specifies what character
6919 encoding the keyboard produces and the display will understand. For
6920 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006921 display). Except for the Mac when 'macatsui' is off, then
6922 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923 In the Win32 console version the default value is the console codepage
6924 when it differs from the ANSI codepage.
6925 *E617*
6926 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6927 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6928 Any attempts to set a different value will be rejected, and an error
6929 message is shown.
6930 For the Win32 GUI 'termencoding' is not used for typed characters,
6931 because the Win32 system always passes Unicode characters.
6932 When empty, the same encoding is used as for the 'encoding' option.
6933 This is the normal value.
6934 Not all combinations for 'termencoding' and 'encoding' are valid. See
6935 |encoding-table|.
6936 The value for this option must be supported by internal conversions or
6937 iconv(). When this is not possible no conversion will be done and you
6938 will probably experience problems with non-ASCII characters.
6939 Example: You are working with the locale set to euc-jp (Japanese) and
6940 want to edit a UTF-8 file: >
6941 :let &termencoding = &encoding
6942 :set encoding=utf-8
6943< You need to do this when your system has no locale support for UTF-8.
6944
6945 *'terse'* *'noterse'*
6946'terse' boolean (default off)
6947 global
6948 When set: Add 's' flag to 'shortmess' option (this makes the message
6949 for a search that hits the start or end of the file not being
6950 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6951 shortens a lot of messages}
6952
6953 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6954'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6955 global
6956 {not in Vi}
6957 This option is obsolete. Use 'fileformats'.
6958 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6959 set to the default value for the current system. When 'textauto' is
6960 reset, 'fileformats' is made empty.
6961 NOTE: This option is set to the Vi default value when 'compatible' is
6962 set and to the Vim default value when 'compatible' is reset.
6963
6964 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6965'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6966 others: default off)
6967 local to buffer
6968 {not in Vi}
6969 This option is obsolete. Use 'fileformat'.
6970 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6971 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6972 "unix".
6973
6974 *'textwidth'* *'tw'*
6975'textwidth' 'tw' number (default 0)
6976 local to buffer
6977 {not in Vi}
6978 Maximum width of text that is being inserted. A longer line will be
6979 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006980 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6981 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00006983 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006984 NOTE: This option is set to 0 when 'compatible' is set.
6985
6986 *'thesaurus'* *'tsr'*
6987'thesaurus' 'tsr' string (default "")
6988 global or local to buffer |global-local|
6989 {not in Vi}
6990 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006991 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 the file should contain words with similar meaning, separated by
6993 non-keyword characters (white space is preferred). Maximum line
6994 length is 510 bytes.
6995 To obtain a file to be used here, check out the wordlist FAQ at
6996 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006997 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998 after a comma are ignored, otherwise spaces are included in the file
6999 name. See |option-backslash| about using backslashes.
7000 The use of |:set+=| and |:set-=| is preferred when adding or removing
7001 directories from the list. This avoids problems when a future version
7002 uses another default.
7003 Backticks cannot be used in this option for security reasons.
7004
7005 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7006'tildeop' 'top' boolean (default off)
7007 global
7008 {not in Vi}
7009 When on: The tilde command "~" behaves like an operator.
7010 NOTE: This option is reset when 'compatible' is set.
7011
7012 *'timeout'* *'to'* *'notimeout'* *'noto'*
7013'timeout' 'to' boolean (default on)
7014 global
7015 *'ttimeout'* *'nottimeout'*
7016'ttimeout' boolean (default off)
7017 global
7018 {not in Vi}
7019 These two options together determine the behavior when part of a
7020 mapped key sequence or keyboard code has been received:
7021
7022 'timeout' 'ttimeout' action ~
7023 off off do not time out
7024 on on or off time out on :mappings and key codes
7025 off on time out on key codes
7026
7027 If both options are off, Vim will wait until either the complete
7028 mapping or key sequence has been received, or it is clear that there
7029 is no mapping or key sequence for the received characters. For
7030 example: if you have mapped "vl" and Vim has received 'v', the next
7031 character is needed to see if the 'v' is followed by an 'l'.
7032 When one of the options is on, Vim will wait for about 1 second for
7033 the next character to arrive. After that the already received
7034 characters are interpreted as single characters. The waiting time can
7035 be changed with the 'timeoutlen' option.
7036 On slow terminals or very busy systems timing out may cause
7037 malfunctioning cursor keys. If both options are off, Vim waits
7038 forever after an entered <Esc> if there are key codes that start
7039 with <Esc>. You will have to type <Esc> twice. If you do not have
7040 problems with key codes, but would like to have :mapped key
7041 sequences not timing out in 1 second, set the 'ttimeout' option and
7042 reset the 'timeout' option.
7043
7044 NOTE: 'ttimeout' is reset when 'compatible' is set.
7045
7046 *'timeoutlen'* *'tm'*
7047'timeoutlen' 'tm' number (default 1000)
7048 global
7049 {not in all versions of Vi}
7050 *'ttimeoutlen'* *'ttm'*
7051'ttimeoutlen' 'ttm' number (default -1)
7052 global
7053 {not in Vi}
7054 The time in milliseconds that is waited for a key code or mapped key
7055 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7056 when part of a command has been typed.
7057 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7058 different timeout value for key codes is desired set 'ttimeoutlen' to
7059 a non-negative number.
7060
7061 ttimeoutlen mapping delay key code delay ~
7062 < 0 'timeoutlen' 'timeoutlen'
7063 >= 0 'timeoutlen' 'ttimeoutlen'
7064
7065 The timeout only happens when the 'timeout' and 'ttimeout' options
7066 tell so. A useful setting would be >
7067 :set timeout timeoutlen=3000 ttimeoutlen=100
7068< (time out on mapping after three seconds, time out on key codes after
7069 a tenth of a second).
7070
7071 *'title'* *'notitle'*
7072'title' boolean (default off, on when title can be restored)
7073 global
7074 {not in Vi}
7075 {not available when compiled without the |+title|
7076 feature}
7077 When on, the title of the window will be set to the value of
7078 'titlestring' (if it is not empty), or to:
7079 filename [+=-] (path) - VIM
7080 Where:
7081 filename the name of the file being edited
7082 - indicates the file cannot be modified, 'ma' off
7083 + indicates the file was modified
7084 = indicates the file is read-only
7085 =+ indicates the file is read-only and modified
7086 (path) is the path of the file being edited
7087 - VIM the server name |v:servername| or "VIM"
7088 Only works if the terminal supports setting window titles
7089 (currently Amiga console, Win32 console, all GUI versions and
7090 terminals with a non- empty 't_ts' option - these are Unix xterm and
7091 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7092 *X11*
7093 When Vim was compiled with HAVE_X11 defined, the original title will
7094 be restored if possible. The output of ":version" will include "+X11"
7095 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7096 works for the icon name |'icon'|.
7097 But: When Vim was started with the |-X| argument, restoring the title
7098 will not work (except in the GUI).
7099 If the title cannot be restored, it is set to the value of 'titleold'.
7100 You might want to restore the title outside of Vim then.
7101 When using an xterm from a remote machine you can use this command:
7102 rsh machine_name xterm -display $DISPLAY &
7103 then the WINDOWID environment variable should be inherited and the
7104 title of the window should change back to what it should be after
7105 exiting Vim.
7106
7107 *'titlelen'*
7108'titlelen' number (default 85)
7109 global
7110 {not in Vi}
7111 {not available when compiled without the |+title|
7112 feature}
7113 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007114 title. When the title is longer, only the end of the path name is
7115 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 Using a percentage makes this adapt to the width of the window. But
7117 it won't work perfectly, because the actual number of characters
7118 available also depends on the font used and other things in the title
7119 bar. When 'titlelen' is zero the full path is used. Otherwise,
7120 values from 1 to 30000 percent can be used.
7121 'titlelen' is also used for the 'titlestring' option.
7122
7123 *'titleold'*
7124'titleold' string (default "Thanks for flying Vim")
7125 global
7126 {not in Vi}
7127 {only available when compiled with the |+title|
7128 feature}
7129 This option will be used for the window title when exiting Vim if the
7130 original title cannot be restored. Only happens if 'title' is on or
7131 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007132 This option cannot be set from a |modeline| or in the |sandbox|, for
7133 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 *'titlestring'*
7135'titlestring' string (default "")
7136 global
7137 {not in Vi}
7138 {not available when compiled without the |+title|
7139 feature}
7140 When this option is not empty, it will be used for the title of the
7141 window. This happens only when the 'title' option is on.
7142 Only works if the terminal supports setting window titles (currently
7143 Amiga console, Win32 console, all GUI versions and terminals with a
7144 non-empty 't_ts' option).
7145 When Vim was compiled with HAVE_X11 defined, the original title will
7146 be restored if possible |X11|.
7147 When this option contains printf-style '%' items, they will be
7148 expanded according to the rules used for 'statusline'.
7149 Example: >
7150 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7151 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7152< The value of 'titlelen' is used to align items in the middle or right
7153 of the available space.
7154 Some people prefer to have the file name first: >
7155 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7156< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007157 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007158 separating space only when needed.
7159 NOTE: Use of special characters in 'titlestring' may cause the display
7160 to be garbled (e.g., when it contains a CR or NL character).
7161 {not available when compiled without the |+statusline| feature}
7162
7163 *'toolbar'* *'tb'*
7164'toolbar' 'tb' string (default "icons,tooltips")
7165 global
7166 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7167 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007168 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 possible values are:
7170 icons Toolbar buttons are shown with icons.
7171 text Toolbar buttons shown with text.
7172 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007173 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174 tooltips Tooltips are active for toolbar buttons.
7175 Tooltips refer to the popup help text which appears after the mouse
7176 cursor is placed over a toolbar button for a brief moment.
7177
7178 If you want the toolbar to be shown with icons as well as text, do the
7179 following: >
7180 :set tb=icons,text
7181< Motif and Athena cannot display icons and text at the same time. They
7182 will show icons if both are requested.
7183
7184 If none of the strings specified in 'toolbar' are valid or if
7185 'toolbar' is empty, this option is ignored. If you want to disable
7186 the toolbar, you need to set the 'guioptions' option. For example: >
7187 :set guioptions-=T
7188< Also see |gui-toolbar|.
7189
7190 *'toolbariconsize'* *'tbis'*
7191'toolbariconsize' 'tbis' string (default "small")
7192 global
7193 {not in Vi}
7194 {only in the GTK+ 2 GUI}
7195 Controls the size of toolbar icons. The possible values are:
7196 tiny Use tiny toolbar icons.
7197 small Use small toolbar icons (default).
7198 medium Use medium-sized toolbar icons.
7199 large Use large toolbar icons.
7200 The exact dimensions in pixels of the various icon sizes depend on
7201 the current theme. Common dimensions are large=32x32, medium=24x24,
7202 small=20x20 and tiny=16x16.
7203
7204 If 'toolbariconsize' is empty, the global default size as determined
7205 by user preferences or the current theme is used.
7206
7207 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7208'ttybuiltin' 'tbi' boolean (default on)
7209 global
7210 {not in Vi}
7211 When on, the builtin termcaps are searched before the external ones.
7212 When off the builtin termcaps are searched after the external ones.
7213 When this option is changed, you should set the 'term' option next for
7214 the change to take effect, for example: >
7215 :set notbi term=$TERM
7216< See also |termcap|.
7217 Rationale: The default for this option is "on", because the builtin
7218 termcap entries are generally better (many systems contain faulty
7219 xterm entries...).
7220
7221 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7222'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7223 sun-cmd, screen, rxvt, dtterm or
7224 iris-ansi; also on when running Vim in
7225 a DOS console)
7226 global
7227 {not in Vi}
7228 Indicates a fast terminal connection. More characters will be sent to
7229 the screen for redrawing, instead of using insert/delete line
7230 commands. Improves smoothness of redrawing when there are multiple
7231 windows and the terminal does not support a scrolling region.
7232 Also enables the extra writing of characters at the end of each screen
7233 line for lines that wrap. This helps when using copy/paste with the
7234 mouse in an xterm and other terminals.
7235
7236 *'ttymouse'* *'ttym'*
7237'ttymouse' 'ttym' string (default depends on 'term')
7238 global
7239 {not in Vi}
7240 {only in Unix and VMS, doesn't work in the GUI; not
7241 available when compiled without |+mouse|}
7242 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007243 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007244 *xterm-mouse*
7245 xterm xterm-like mouse handling. The mouse generates
7246 "<Esc>[Mscr", where "scr" is three bytes:
7247 "s" = button state
7248 "c" = column plus 33
7249 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007250 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007251 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 xterm2 Works like "xterm", but with the xterm reporting the
7253 mouse position while the mouse is dragged. This works
7254 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007255 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007256 work. See below for how Vim detects this
7257 automatically.
7258 *netterm-mouse*
7259 netterm NetTerm mouse handling. The mouse generates
7260 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7261 for the row and column.
7262 *dec-mouse*
7263 dec DEC terminal mouse handling. The mouse generates a
7264 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007265 This is also available for an Xterm, if it was
7266 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007267 *jsbterm-mouse*
7268 jsbterm JSB term mouse handling.
7269 *pterm-mouse*
7270 pterm QNX pterm mouse handling.
7271
7272 The mouse handling must be enabled at compile time |+mouse_xterm|
7273 |+mouse_dec| |+mouse_netterm|.
7274 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7275 recognized, if enabled at compile time. DEC terminal mouse codes
7276 are recognized if enabled at compile time, and 'ttymouse' is not
7277 "xterm" (because the xterm and dec mouse codes conflict).
7278 This option is automatically set to "xterm", when the 'term' option is
7279 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7280 or "xterm2" already. The main use of this option is to set it to
7281 "xterm", when the terminal name doesn't start with "xterm", but it can
7282 handle xterm mouse codes.
7283 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007284 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285 feature and if |t_RV| is set to the escape sequence to request the
7286 xterm version number. Otherwise "xterm2" must be set explicitly.
7287 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7288 t_RV to an empty string: >
7289 :set t_RV=
7290<
7291 *'ttyscroll'* *'tsl'*
7292'ttyscroll' 'tsl' number (default 999)
7293 global
7294 Maximum number of lines to scroll the screen. If there are more lines
7295 to scroll the window is redrawn. For terminals where scrolling is
7296 very slow and redrawing is not slow this can be set to a small number,
7297 e.g., 3, to speed up displaying.
7298
7299 *'ttytype'* *'tty'*
7300'ttytype' 'tty' string (default from $TERM)
7301 global
7302 Alias for 'term', see above.
7303
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007304 *'undodir'* *'udir'*
7305'undodir' 'udir' string (default ".")
7306 global
7307 {not in Vi}
7308 {only when compiled with the +persistent_undo feature}
7309 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007310 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007311 "." means using the directory of the file. The undo file name for
7312 "file.txt" is ".file.txt.un~".
7313 For other directories the file name is the full path of the edited
7314 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007315 When writing: The first directory that exists is used. "." always
7316 works, no directories after "." will be used for writing.
7317 When reading all entries are tried to find an undo file. The first
7318 undo file that exists is used. When it cannot be read an error is
7319 given, no further entry is used.
7320 See |undo-persistence|.
7321
7322 *'undofile'* *'udf'*
7323'undofile' 'udf' boolean (default off)
7324 local to buffer
7325 {not in Vi}
7326 {only when compiled with the +persistent_undo feature}
7327 When on, Vim automatically saves undo history to an undo file when
7328 writing a buffer to a file, and restores undo history from the same
7329 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007330 The directory where the undo file is stored is specified by 'undodir'.
7331 For more information about this feature see |undo-persistence|.
7332 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007333
Bram Moolenaar071d4272004-06-13 20:20:40 +00007334 *'undolevels'* *'ul'*
7335'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7336 Win32 and OS/2)
7337 global
7338 {not in Vi}
7339 Maximum number of changes that can be undone. Since undo information
7340 is kept in memory, higher numbers will cause more memory to be used
7341 (nevertheless, a single change can use an unlimited amount of memory).
7342 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7343 itself: >
7344 set ul=0
7345< But you can also get Vi compatibility by including the 'u' flag in
7346 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007347 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007348 Set to a negative number for no undo at all: >
7349 set ul=-1
7350< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007351 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007352
7353 *'updatecount'* *'uc'*
7354'updatecount' 'uc' number (default: 200)
7355 global
7356 {not in Vi}
7357 After typing this many characters the swap file will be written to
7358 disk. When zero, no swap file will be created at all (see chapter on
7359 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7360 Vim with the "-n" option, see |startup|. When editing in readonly
7361 mode this option will be initialized to 10000.
7362 The swapfile can be disabled per buffer with |'swapfile'|.
7363 When 'updatecount' is set from zero to non-zero, swap files are
7364 created for all buffers that have 'swapfile' set. When 'updatecount'
7365 is set to zero, existing swap files are not deleted.
7366 Also see |'swapsync'|.
7367 This option has no meaning in buffers where |'buftype'| is "nofile"
7368 or "nowrite".
7369
7370 *'updatetime'* *'ut'*
7371'updatetime' 'ut' number (default 4000)
7372 global
7373 {not in Vi}
7374 If this many milliseconds nothing is typed the swap file will be
7375 written to disk (see |crash-recovery|). Also used for the
7376 |CursorHold| autocommand event.
7377
7378 *'verbose'* *'vbs'*
7379'verbose' 'vbs' number (default 0)
7380 global
7381 {not in Vi, although some versions have a boolean
7382 verbose option}
7383 When bigger than zero, Vim will give messages about what it is doing.
7384 Currently, these messages are given:
7385 >= 1 When the viminfo file is read or written.
7386 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007387 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388 >= 8 Files for which a group of autocommands is executed.
7389 >= 9 Every executed autocommand.
7390 >= 12 Every executed function.
7391 >= 13 When an exception is thrown, caught, finished, or discarded.
7392 >= 14 Anything pending in a ":finally" clause.
7393 >= 15 Every executed Ex command (truncated at 200 characters).
7394
7395 This option can also be set with the "-V" argument. See |-V|.
7396 This option is also set by the |:verbose| command.
7397
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007398 When the 'verbosefile' option is set then the verbose messages are not
7399 displayed.
7400
7401 *'verbosefile'* *'vfile'*
7402'verbosefile' 'vfile' string (default empty)
7403 global
7404 {not in Vi}
7405 When not empty all messages are written in a file with this name.
7406 When the file exists messages are appended.
7407 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007408 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007409 Setting 'verbosefile' to a new value is like making it empty first.
7410 The difference with |:redir| is that verbose messages are not
7411 displayed when 'verbosefile' is set.
7412
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413 *'viewdir'* *'vdir'*
7414'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7415 "$VIM/vimfiles/view",
7416 for Unix: "~/.vim/view",
7417 for Macintosh: "$VIM:vimfiles:view"
7418 for VMS: "sys$login:vimfiles/view"
7419 for RiscOS: "Choices:vimfiles/view")
7420 global
7421 {not in Vi}
7422 {not available when compiled without the +mksession
7423 feature}
7424 Name of the directory where to store files for |:mkview|.
7425 This option cannot be set from a |modeline| or in the |sandbox|, for
7426 security reasons.
7427
7428 *'viewoptions'* *'vop'*
7429'viewoptions' 'vop' string (default: "folds,options,cursor")
7430 global
7431 {not in Vi}
7432 {not available when compiled without the +mksession
7433 feature}
7434 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007435 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 word save and restore ~
7437 cursor cursor position in file and in window
7438 folds manually created folds, opened/closed folds and local
7439 fold options
7440 options options and mappings local to a window or buffer (not
7441 global values for local options)
7442 slash backslashes in file names replaced with forward
7443 slashes
7444 unix with Unix end-of-line format (single <NL>), even when
7445 on Windows or DOS
7446
7447 "slash" and "unix" are useful on Windows when sharing view files
7448 with Unix. The Unix version of Vim cannot source dos format scripts,
7449 but the Windows version of Vim can source unix format scripts.
7450
7451 *'viminfo'* *'vi'* *E526* *E527* *E528*
7452'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007453 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7454 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7455 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007456 global
7457 {not in Vi}
7458 {not available when compiled without the |+viminfo|
7459 feature}
7460 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007461 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 separated list of parameters, each consisting of a single character
7463 identifying the particular parameter, followed by a number or string
7464 which specifies the value of that parameter. If a particular
7465 character is left out, then the default value is used for that
7466 parameter. The following is a list of the identifying characters and
7467 the effect of their value.
7468 CHAR VALUE ~
7469 ! When included, save and restore global variables that start
7470 with an uppercase letter, and don't contain a lowercase
7471 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007472 and "_K_L_M" are not. Only String and Number types are
7473 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474 " Maximum number of lines saved for each register. Old name of
7475 the '<' item, with the disadvantage that you need to put a
7476 backslash before the ", otherwise it will be recognized as the
7477 start of a comment!
7478 % When included, save and restore the buffer list. If Vim is
7479 started with a file name argument, the buffer list is not
7480 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007481 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 without a file name and buffers for help files are not written
7483 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007484 When followed by a number, the number specifies the maximum
7485 number of buffers that are stored. Without a number all
7486 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 ' Maximum number of previously edited files for which the marks
7488 are remembered. This parameter must always be included when
7489 'viminfo' is non-empty.
7490 Including this item also means that the |jumplist| and the
7491 |changelist| are stored in the viminfo file.
7492 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007493 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494 patterns are also saved. When not included, the value of
7495 'history' is used.
7496 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007497 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498 < Maximum number of lines saved for each register. If zero then
7499 registers are not saved. When not included, all lines are
7500 saved. '"' is the old name for this item.
7501 Also see the 's' item below: limit specified in Kbyte.
7502 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007503 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007504 c When included, convert the text in the viminfo file from the
7505 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007506 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 f Whether file marks need to be stored. If zero, file marks ('0
7508 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007509 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007510 cursor position (when exiting or when doing ":wviminfo").
7511 h Disable the effect of 'hlsearch' when loading the viminfo
7512 file. When not included, it depends on whether ":nohlsearch"
7513 has been used since the last search command.
7514 n Name of the viminfo file. The name must immediately follow
7515 the 'n'. Must be the last one! If the "-i" argument was
7516 given when starting Vim, that file name overrides the one
7517 given here with 'viminfo'. Environment variables are expanded
7518 when opening the file, not when setting the option.
7519 r Removable media. The argument is a string (up to the next
7520 ','). This parameter can be given several times. Each
7521 specifies the start of a path for which no marks will be
7522 stored. This is to avoid removable media. For MS-DOS you
7523 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7524 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7525 ignored. Maximum length of each 'r' argument is 50
7526 characters.
7527 s Maximum size of an item in Kbyte. If zero then registers are
7528 not saved. Currently only applies to registers. The default
7529 "s10" will exclude registers with more than 10 Kbyte of text.
7530 Also see the '<' item above: line count limit.
7531
7532 Example: >
7533 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7534<
7535 '50 Marks will be remembered for the last 50 files you
7536 edited.
7537 <1000 Contents of registers (up to 1000 lines each) will be
7538 remembered.
7539 s100 Registers with more than 100 Kbyte text are skipped.
7540 :0 Command-line history will not be saved.
7541 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7542 no / Since '/' is not specified, the default will be used,
7543 that is, save all of the search history, and also the
7544 previous search and substitute patterns.
7545 no % The buffer list will not be saved nor read back.
7546 no h 'hlsearch' highlighting will be restored.
7547
7548 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7549 load the contents of the file, this is not done automatically.
7550
7551 This option cannot be set from a |modeline| or in the |sandbox|, for
7552 security reasons.
7553
7554 *'virtualedit'* *'ve'*
7555'virtualedit' 've' string (default "")
7556 global
7557 {not in Vi}
7558 {not available when compiled without the
7559 |+virtualedit| feature}
7560 A comma separated list of these words:
7561 block Allow virtual editing in Visual block mode.
7562 insert Allow virtual editing in Insert mode.
7563 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007564 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007565
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007567 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 of the line. Useful for selecting a rectangle in Visual mode and
7569 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007570 "onemore" is not the same, it will only allow moving the cursor just
7571 after the last character of the line. This makes some commands more
7572 consistent. Previously the cursor was always past the end of the line
7573 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007574 break some plugins or Vim scripts. For example because |l| can move
7575 the cursor after the last character. Use with care!
7576 Using the |$| command will move to the last character in the line, not
7577 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007578 It doesn't make sense to combine "all" with "onemore", but you will
7579 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580
7581 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7582'visualbell' 'vb' boolean (default off)
7583 global
7584 {not in Vi}
7585 Use visual bell instead of beeping. The terminal code to display the
7586 visual bell is given with 't_vb'. When no beep or flash is wanted,
7587 use ":set vb t_vb=".
7588 Note: When the GUI starts, 't_vb' is reset to its default value. You
7589 might want to set it again in your |gvimrc|.
7590 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7591 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7592 where 40 is the time in msec.
7593 Does not work on the Amiga, you always get a screen flash.
7594 Also see 'errorbells'.
7595
7596 *'warn'* *'nowarn'*
7597'warn' boolean (default on)
7598 global
7599 Give a warning message when a shell command is used while the buffer
7600 has been changed.
7601
7602 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7603'weirdinvert' 'wiv' boolean (default off)
7604 global
7605 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007606 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007607 It is provided for backwards compatibility with version 4.x.
7608 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7609 vice versa. Has no effect when the GUI is running.
7610
7611 *'whichwrap'* *'ww'*
7612'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7613 global
7614 {not in Vi}
7615 Allow specified keys that move the cursor left/right to move to the
7616 previous/next line when the cursor is on the first/last character in
7617 the line. Concatenate characters to allow this for these keys:
7618 char key mode ~
7619 b <BS> Normal and Visual
7620 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007621 h "h" Normal and Visual (not recommended)
7622 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007623 < <Left> Normal and Visual
7624 > <Right> Normal and Visual
7625 ~ "~" Normal
7626 [ <Left> Insert and Replace
7627 ] <Right> Insert and Replace
7628 For example: >
7629 :set ww=<,>,[,]
7630< allows wrap only when cursor keys are used.
7631 When the movement keys are used in combination with a delete or change
7632 operator, the <EOL> also counts for a character. This makes "3h"
7633 different from "3dh" when the cursor crosses the end of a line. This
7634 is also true for "x" and "X", because they do the same as "dl" and
7635 "dh". If you use this, you may also want to use the mapping
7636 ":map <BS> X" to make backspace delete the character in front of the
7637 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007638 When 'l' is included and it is used after an operator at the end of a
7639 line then it will not move to the next line. This makes "dl", "cl",
7640 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007641 NOTE: This option is set to the Vi default value when 'compatible' is
7642 set and to the Vim default value when 'compatible' is reset.
7643
7644 *'wildchar'* *'wc'*
7645'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7646 global
7647 {not in Vi}
7648 Character you have to type to start wildcard expansion in the
7649 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007650 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007651 The character is not recognized when used inside a macro. See
7652 'wildcharm' for that.
7653 Although 'wc' is a number option, you can set it to a special key: >
7654 :set wc=<Esc>
7655< NOTE: This option is set to the Vi default value when 'compatible' is
7656 set and to the Vim default value when 'compatible' is reset.
7657
7658 *'wildcharm'* *'wcm'*
7659'wildcharm' 'wcm' number (default: none (0))
7660 global
7661 {not in Vi}
7662 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007663 recognized when used inside a macro. You can find "spare" command-line
7664 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007665 you'll never actually type 'wildcharm', just use it in mappings that
7666 automatically invoke completion mode, e.g.: >
7667 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007668 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007669< Then after typing :ss you can use CTRL-P & CTRL-N.
7670
7671 *'wildignore'* *'wig'*
7672'wildignore' 'wig' string (default "")
7673 global
7674 {not in Vi}
7675 {not available when compiled without the |+wildignore|
7676 feature}
7677 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007678 patterns is ignored when completing file or directory names, and
7679 influences the result of |expand()|, |glob()| and |globpath()| unless
7680 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007681 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7682 Also see 'suffixes'.
7683 Example: >
7684 :set wildignore=*.o,*.obj
7685< The use of |:set+=| and |:set-=| is preferred when adding or removing
7686 a pattern from the list. This avoids problems when a future version
7687 uses another default.
7688
7689 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7690'wildmenu' 'wmnu' boolean (default off)
7691 global
7692 {not in Vi}
7693 {not available if compiled without the |+wildmenu|
7694 feature}
7695 When 'wildmenu' is on, command-line completion operates in an enhanced
7696 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7697 the possible matches are shown just above the command line, with the
7698 first match highlighted (overwriting the status line, if there is
7699 one). Keys that show the previous/next match, such as <Tab> or
7700 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7701 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7702 specified. "longest" and "list" do not start "wildmenu" mode.
7703 If there are more matches than can fit in the line, a ">" is shown on
7704 the right and/or a "<" is shown on the left. The status line scrolls
7705 as needed.
7706 The "wildmenu" mode is abandoned when a key is hit that is not used
7707 for selecting a completion.
7708 While the "wildmenu" is active the following keys have special
7709 meanings:
7710
7711 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7712 <Down> - in filename/menu name completion: move into a
7713 subdirectory or submenu.
7714 <CR> - in menu completion, when the cursor is just after a
7715 dot: move into a submenu.
7716 <Up> - in filename/menu name completion: move up into
7717 parent directory or parent menu.
7718
7719 This makes the menus accessible from the console |console-menus|.
7720
7721 If you prefer the <Left> and <Right> keys to move the cursor instead
7722 of selecting a different match, use this: >
7723 :cnoremap <Left> <Space><BS><Left>
7724 :cnoremap <Right> <Space><BS><Right>
7725<
7726 The "WildMenu" highlighting is used for displaying the current match
7727 |hl-WildMenu|.
7728
7729 *'wildmode'* *'wim'*
7730'wildmode' 'wim' string (Vim default: "full")
7731 global
7732 {not in Vi}
7733 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007734 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007735 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007736 first part specifies the behavior for the first use of 'wildchar',
7737 The second part for the second use, etc.
7738 These are the possible values for each part:
7739 "" Complete only the first match.
7740 "full" Complete the next full match. After the last match,
7741 the original string is used and then the first match
7742 again.
7743 "longest" Complete till longest common string. If this doesn't
7744 result in a longer string, use the next part.
7745 "longest:full" Like "longest", but also start 'wildmenu' if it is
7746 enabled.
7747 "list" When more than one match, list all matches.
7748 "list:full" When more than one match, list all matches and
7749 complete first match.
7750 "list:longest" When more than one match, list all matches and
7751 complete till longest common string.
7752 When there is only a single match, it is fully completed in all cases.
7753
7754 Examples: >
7755 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007756< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757 :set wildmode=longest,full
7758< Complete longest common string, then each full match >
7759 :set wildmode=list:full
7760< List all matches and complete each full match >
7761 :set wildmode=list,full
7762< List all matches without completing, then each full match >
7763 :set wildmode=longest,list
7764< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007765 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007766
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007767 *'wildoptions'* *'wop'*
7768'wildoptions' 'wop' string (default "")
7769 global
7770 {not in Vi}
7771 {not available when compiled without the |+wildignore|
7772 feature}
7773 A list of words that change how command line completion is done.
7774 Currently only one word is allowed:
7775 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007776 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007777 is displayed per line. Often used tag kinds are:
7778 d #define
7779 f function
7780 Also see |cmdline-completion|.
7781
Bram Moolenaar071d4272004-06-13 20:20:40 +00007782 *'winaltkeys'* *'wak'*
7783'winaltkeys' 'wak' string (default "menu")
7784 global
7785 {not in Vi}
7786 {only used in Win32, Motif, GTK and Photon GUI}
7787 Some GUI versions allow the access to menu entries by using the ALT
7788 key in combination with a character that appears underlined in the
7789 menu. This conflicts with the use of the ALT key for mappings and
7790 entering special characters. This option tells what to do:
7791 no Don't use ALT keys for menus. ALT key combinations can be
7792 mapped, but there is no automatic handling. This can then be
7793 done with the |:simalt| command.
7794 yes ALT key handling is done by the windowing system. ALT key
7795 combinations cannot be mapped.
7796 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007797 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007798 keys can be mapped.
7799 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7800 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007801 This option is not used for <F10>; on Win32 and with GTK <F10> will
7802 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007803
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007804 *'window'* *'wi'*
7805'window' 'wi' number (default screen height - 1)
7806 global
7807 Window height. Do not confuse this with the height of the Vim window,
7808 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007809 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7810 value is smaller than 'lines' minus one. The screen will scroll
7811 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007812 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7813 in a much smarter way, taking care of wrapping lines.
7814 When resizing the Vim window, the value is smaller than 1 or more than
7815 or equal to 'lines' it will be set to 'lines' minus 1.
7816 {Vi also uses the option to specify the number of displayed lines}
7817
Bram Moolenaar071d4272004-06-13 20:20:40 +00007818 *'winheight'* *'wh'* *E591*
7819'winheight' 'wh' number (default 1)
7820 global
7821 {not in Vi}
7822 {not available when compiled without the +windows
7823 feature}
7824 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007825 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007826 focus goes to a window that is smaller, its size is increased, at the
7827 cost of the height of other windows.
7828 Set 'winheight' to a small number for normal editing.
7829 Set it to 999 to make the current window fill most of the screen.
7830 Other windows will be only 'winminheight' high. This has the drawback
7831 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7832 to create only two windows, set the option after startup is done,
7833 using the |VimEnter| event: >
7834 au VimEnter * set winheight=999
7835< Minimum value is 1.
7836 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837 height of the current window.
7838 'winheight' applies to the current window. Use 'winminheight' to set
7839 the minimal height for other windows.
7840
7841 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7842'winfixheight' 'wfh' boolean (default off)
7843 local to window
7844 {not in Vi}
7845 {not available when compiled without the +windows
7846 feature}
7847 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007848 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7849 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850 The height may be changed anyway when running out of room.
7851
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007852 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7853'winfixwidth' 'wfw' boolean (default off)
7854 local to window
7855 {not in Vi}
7856 {not available when compiled without the +windows
7857 feature}
7858 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007859 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007860 The width may be changed anyway when running out of room.
7861
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 *'winminheight'* *'wmh'*
7863'winminheight' 'wmh' number (default 1)
7864 global
7865 {not in Vi}
7866 {not available when compiled without the +windows
7867 feature}
7868 The minimal height of a window, when it's not the current window.
7869 This is a hard minimum, windows will never become smaller.
7870 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7871 status bar) if necessary. They will return to at least one line when
7872 they become active (since the cursor has to have somewhere to go.)
7873 Use 'winheight' to set the minimal height of the current window.
7874 This option is only checked when making a window smaller. Don't use a
7875 large number, it will cause errors when opening more than a few
7876 windows. A value of 0 to 3 is reasonable.
7877
7878 *'winminwidth'* *'wmw'*
7879'winminwidth' 'wmw' number (default 1)
7880 global
7881 {not in Vi}
7882 {not available when compiled without the +vertsplit
7883 feature}
7884 The minimal width of a window, when it's not the current window.
7885 This is a hard minimum, windows will never become smaller.
7886 When set to zero, windows may be "squashed" to zero columns (i.e. just
7887 a vertical separator) if necessary. They will return to at least one
7888 line when they become active (since the cursor has to have somewhere
7889 to go.)
7890 Use 'winwidth' to set the minimal width of the current window.
7891 This option is only checked when making a window smaller. Don't use a
7892 large number, it will cause errors when opening more than a few
7893 windows. A value of 0 to 12 is reasonable.
7894
7895 *'winwidth'* *'wiw'* *E592*
7896'winwidth' 'wiw' number (default 20)
7897 global
7898 {not in Vi}
7899 {not available when compiled without the +vertsplit
7900 feature}
7901 Minimal number of columns for the current window. This is not a hard
7902 minimum, Vim will use fewer columns if there is not enough room. If
7903 the current window is smaller, its size is increased, at the cost of
7904 the width of other windows. Set it to 999 to make the current window
7905 always fill the screen. Set it to a small number for normal editing.
7906 The width is not adjusted after one of the commands to change the
7907 width of the current window.
7908 'winwidth' applies to the current window. Use 'winminwidth' to set
7909 the minimal width for other windows.
7910
7911 *'wrap'* *'nowrap'*
7912'wrap' boolean (default on)
7913 local to window
7914 {not in Vi}
7915 This option changes how text is displayed. It doesn't change the text
7916 in the buffer, see 'textwidth' for that.
7917 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007918 displaying continues on the next line. When off lines will not wrap
7919 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007920 moved to a part that is not shown, the screen will scroll
7921 horizontally.
7922 The line will be broken in the middle of a word if necessary. See
7923 'linebreak' to get the break at a word boundary.
7924 To make scrolling horizontally a bit more useful, try this: >
7925 :set sidescroll=5
7926 :set listchars+=precedes:<,extends:>
7927< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007928 This option can't be set from a |modeline| when the 'diff' option is
7929 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007930
7931 *'wrapmargin'* *'wm'*
7932'wrapmargin' 'wm' number (default 0)
7933 local to buffer
7934 Number of characters from the right window border where wrapping
7935 starts. When typing text beyond this limit, an <EOL> will be inserted
7936 and inserting continues on the next line.
7937 Options that add a margin, such as 'number' and 'foldcolumn', cause
7938 the text width to be further reduced. This is Vi compatible.
7939 When 'textwidth' is non-zero, this option is not used.
7940 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7941 and less usefully}
7942
7943 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7944'wrapscan' 'ws' boolean (default on) *E384* *E385*
7945 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007946 Searches wrap around the end of the file. Also applies to |]s| and
7947 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007948
7949 *'write'* *'nowrite'*
7950'write' boolean (default on)
7951 global
7952 {not in Vi}
7953 Allows writing files. When not set, writing a file is not allowed.
7954 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007955 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 argument. Filtering text is still possible, even though this requires
7957 writing a temporary file.
7958
7959 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7960'writeany' 'wa' boolean (default off)
7961 global
7962 Allows writing to any file with no need for "!" override.
7963
7964 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7965'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7966 otherwise)
7967 global
7968 {not in Vi}
7969 Make a backup before overwriting a file. The backup is removed after
7970 the file was successfully written, unless the 'backup' option is
7971 also on. Reset this option if your file system is almost full. See
7972 |backup-table| for another explanation.
7973 When the 'backupskip' pattern matches, a backup is not made anyway.
7974 NOTE: This option is set to the default value when 'compatible' is
7975 set.
7976
7977 *'writedelay'* *'wd'*
7978'writedelay' 'wd' number (default 0)
7979 global
7980 {not in Vi}
7981 The number of microseconds to wait for each character sent to the
7982 screen. When non-zero, characters are sent to the terminal one by
7983 one. For MS-DOS pcterm this does not work. For debugging purposes.
7984
7985 vim:tw=78:ts=8:ft=help:norl: