blob: 8b613b75508871157815fbabd0e1c05d5f469097 [file] [log] [blame]
Bram Moolenaarfff2bee2010-05-15 13:56:02 +02001*options.txt* For Vim version 7.3a. 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|.
1727 3 Concealed text is completely hidden.
1728
1729
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1731'confirm' 'cf' boolean (default off)
1732 global
1733 {not in Vi}
1734 When 'confirm' is on, certain operations that would normally
1735 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1736 instead raise a |dialog| asking if you wish to save the current
1737 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1738 If 'confirm' is off you can still activate confirmation for one
1739 command only (this is most useful in mappings) with the |:confirm|
1740 command.
1741 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1742
1743 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1744'conskey' 'consk' boolean (default off)
1745 global
1746 {not in Vi} {only for MS-DOS}
1747 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001748 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749 three methods of console input are available:
1750 'conskey' 'bioskey' action ~
1751 on on or off direct console input
1752 off on BIOS
1753 off off STDIN
1754
1755 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1756'copyindent' 'ci' boolean (default off)
1757 local to buffer
1758 {not in Vi}
1759 Copy the structure of the existing lines indent when autoindenting a
1760 new line. Normally the new indent is reconstructed by a series of
1761 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1762 in which case only spaces are used). Enabling this option makes the
1763 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001764 existing line. 'expandtab' has no effect on these characters, a Tab
1765 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 line, the remaining space is filled in the normal manner.
1767 NOTE: 'copyindent' is reset when 'compatible' is set.
1768 Also see 'preserveindent'.
1769
1770 *'cpoptions'* *'cpo'*
1771'cpoptions' 'cpo' string (Vim default: "aABceFs",
1772 Vi default: all flags)
1773 global
1774 {not in Vi}
1775 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001776 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777 not being vi-compatible is mostly or sometimes preferred.
1778 'cpoptions' stands for "compatible-options".
1779 Commas can be added for readability.
1780 To avoid problems with flags that are added in the future, use the
1781 "+=" and "-=" feature of ":set" |add-option-flags|.
1782 NOTE: This option is set to the Vi default value when 'compatible' is
1783 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001784 NOTE: This option is set to the POSIX default value at startup when
1785 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001786 variable exists |posix|. This means Vim tries to behave like the
1787 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788
1789 contains behavior ~
1790 *cpo-a*
1791 a When included, a ":read" command with a file name
1792 argument will set the alternate file name for the
1793 current window.
1794 *cpo-A*
1795 A When included, a ":write" command with a file name
1796 argument will set the alternate file name for the
1797 current window.
1798 *cpo-b*
1799 b "\|" in a ":map" command is recognized as the end of
1800 the map command. The '\' is included in the mapping,
1801 the text after the '|' is interpreted as the next
1802 command. Use a CTRL-V instead of a backslash to
1803 include the '|' in the mapping. Applies to all
1804 mapping, abbreviation, menu and autocmd commands.
1805 See also |map_bar|.
1806 *cpo-B*
1807 B A backslash has no special meaning in mappings,
1808 abbreviations and the "to" part of the menu commands.
1809 Remove this flag to be able to use a backslash like a
1810 CTRL-V. For example, the command ":map X \<Esc>"
1811 results in X being mapped to:
1812 'B' included: "\^[" (^[ is a real <Esc>)
1813 'B' excluded: "<Esc>" (5 characters)
1814 ('<' excluded in both cases)
1815 *cpo-c*
1816 c Searching continues at the end of any match at the
1817 cursor position, but not further than the start of the
1818 next line. When not present searching continues
1819 one character from the cursor position. With 'c'
1820 "abababababab" only gets three matches when repeating
1821 "/abab", without 'c' there are five matches.
1822 *cpo-C*
1823 C Do not concatenate sourced lines that start with a
1824 backslash. See |line-continuation|.
1825 *cpo-d*
1826 d Using "./" in the 'tags' option doesn't mean to use
1827 the tags file relative to the current file, but the
1828 tags file in the current directory.
1829 *cpo-D*
1830 D Can't use CTRL-K to enter a digraph after Normal mode
1831 commands with a character argument, like |r|, |f| and
1832 |t|.
1833 *cpo-e*
1834 e When executing a register with ":@r", always add a
1835 <CR> to the last line, also when the register is not
1836 linewise. If this flag is not present, the register
1837 is not linewise and the last line does not end in a
1838 <CR>, then the last line is put on the command-line
1839 and can be edited before hitting <CR>.
1840 *cpo-E*
1841 E It is an error when using "y", "d", "c", "g~", "gu" or
1842 "gU" on an Empty region. The operators only work when
1843 at least one character is to be operate on. Example:
1844 This makes "y0" fail in the first column.
1845 *cpo-f*
1846 f When included, a ":read" command with a file name
1847 argument will set the file name for the current buffer,
1848 if the current buffer doesn't have a file name yet.
1849 *cpo-F*
1850 F When included, a ":write" command with a file name
1851 argument will set the file name for the current
1852 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001853 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854 *cpo-g*
1855 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001856 *cpo-H*
1857 H When using "I" on a line with only blanks, insert
1858 before the last blank. Without this flag insert after
1859 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 *cpo-i*
1861 i When included, interrupting the reading of a file will
1862 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001863 *cpo-I*
1864 I When moving the cursor up or down just after inserting
1865 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 *cpo-j*
1867 j When joining lines, only add two spaces after a '.',
1868 not after '!' or '?'. Also see 'joinspaces'.
1869 *cpo-J*
1870 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001871 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 white space.
1873 *cpo-k*
1874 k Disable the recognition of raw key codes in
1875 mappings, abbreviations, and the "to" part of menu
1876 commands. For example, if <Key> sends ^[OA (where ^[
1877 is <Esc>), the command ":map X ^[OA" results in X
1878 being mapped to:
1879 'k' included: "^[OA" (3 characters)
1880 'k' excluded: "<Key>" (one key code)
1881 Also see the '<' flag below.
1882 *cpo-K*
1883 K Don't wait for a key code to complete when it is
1884 halfway a mapping. This breaks mapping <F1><F1> when
1885 only part of the second <F1> has been read. It
1886 enables cancelling the mapping by typing <F1><Esc>.
1887 *cpo-l*
1888 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001889 literally, only "\]", "\^", "\-" and "\\" are special.
1890 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1892 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001893 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 *cpo-L*
1895 L When the 'list' option is set, 'wrapmargin',
1896 'textwidth', 'softtabstop' and Virtual Replace mode
1897 (see |gR|) count a <Tab> as two characters, instead of
1898 the normal behavior of a <Tab>.
1899 *cpo-m*
1900 m When included, a showmatch will always wait half a
1901 second. When not included, a showmatch will wait half
1902 a second or until a character is typed. |'showmatch'|
1903 *cpo-M*
1904 M When excluded, "%" matching will take backslashes into
1905 account. Thus in "( \( )" and "\( ( \)" the outer
1906 parenthesis match. When included "%" ignores
1907 backslashes, which is Vi compatible.
1908 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001909 n When included, the column used for 'number' and
1910 'relativenumber' will also be used for text of wrapped
1911 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912 *cpo-o*
1913 o Line offset to search command is not remembered for
1914 next search.
1915 *cpo-O*
1916 O Don't complain if a file is being overwritten, even
1917 when it didn't exist when editing it. This is a
1918 protection against a file unexpectedly created by
1919 someone else. Vi didn't complain about this.
1920 *cpo-p*
1921 p Vi compatible Lisp indenting. When not present, a
1922 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001923 *cpo-P*
1924 P When included, a ":write" command that appends to a
1925 file will set the file name for the current buffer, if
1926 the current buffer doesn't have a file name yet and
1927 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001928 *cpo-q*
1929 q When joining multiple lines leave the cursor at the
1930 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931 *cpo-r*
1932 r Redo ("." command) uses "/" to repeat a search
1933 command, instead of the actually used search string.
1934 *cpo-R*
1935 R Remove marks from filtered lines. Without this flag
1936 marks are kept like |:keepmarks| was used.
1937 *cpo-s*
1938 s Set buffer options when entering the buffer for the
1939 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001940 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001941 set when the buffer is created.
1942 *cpo-S*
1943 S Set buffer options always when entering a buffer
1944 (except 'readonly', 'fileformat', 'filetype' and
1945 'syntax'). This is the (most) Vi compatible setting.
1946 The options are set to the values in the current
1947 buffer. When you change an option and go to another
1948 buffer, the value is copied. Effectively makes the
1949 buffer options global to all buffers.
1950
1951 's' 'S' copy buffer options
1952 no no when buffer created
1953 yes no when buffer first entered (default)
1954 X yes each time when buffer entered (vi comp.)
1955 *cpo-t*
1956 t Search pattern for the tag command is remembered for
1957 "n" command. Otherwise Vim only puts the pattern in
1958 the history for search pattern, but doesn't change the
1959 last used search pattern.
1960 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001961 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962 *cpo-v*
1963 v Backspaced characters remain visible on the screen in
1964 Insert mode. Without this flag the characters are
1965 erased from the screen right away. With this flag the
1966 screen newly typed text overwrites backspaced
1967 characters.
1968 *cpo-w*
1969 w When using "cw" on a blank character, only change one
1970 character and not all blanks until the start of the
1971 next word.
1972 *cpo-W*
1973 W Don't overwrite a readonly file. When omitted, ":w!"
1974 overwrites a readonly file, if possible.
1975 *cpo-x*
1976 x <Esc> on the command-line executes the command-line.
1977 The default in Vim is to abandon the command-line,
1978 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001979 *cpo-X*
1980 X When using a count with "R" the replaced text is
1981 deleted only once. Also when repeating "R" with "."
1982 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001983 *cpo-y*
1984 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001985 *cpo-Z*
1986 Z When using "w!" while the 'readonly' option is set,
1987 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 *cpo-!*
1989 ! When redoing a filter command, use the last used
1990 external command, whatever it was. Otherwise the last
1991 used -filter- command is used.
1992 *cpo-$*
1993 $ When making a change to one line, don't redisplay the
1994 line, but put a '$' at the end of the changed text.
1995 The changed text will be overwritten when you type the
1996 new text. The line is redisplayed if you type any
1997 command that moves the cursor from the insertion
1998 point.
1999 *cpo-%*
2000 % Vi-compatible matching is done for the "%" command.
2001 Does not recognize "#if", "#endif", etc.
2002 Does not recognize "/*" and "*/".
2003 Parens inside single and double quotes are also
2004 counted, causing a string that contains a paren to
2005 disturb the matching. For example, in a line like
2006 "if (strcmp("foo(", s))" the first paren does not
2007 match the last one. When this flag is not included,
2008 parens inside single and double quotes are treated
2009 specially. When matching a paren outside of quotes,
2010 everything inside quotes is ignored. When matching a
2011 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002012 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002013 This flag is also used for other features, such as
2014 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002015 *cpo--*
2016 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002017 it would go above the first line or below the last
2018 line. Without it the cursor moves to the first or
2019 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002020 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002021 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002022 *cpo-+*
2023 + When included, a ":write file" command will reset the
2024 'modified' flag of the buffer, even though the buffer
2025 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002026 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 * Use ":*" in the same way as ":@". When not included,
2028 ":*" is an alias for ":'<,'>", select the Visual area.
2029 *cpo-<*
2030 < Disable the recognition of special key codes in |<>|
2031 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002032 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 ":map X <Tab>" results in X being mapped to:
2034 '<' included: "<Tab>" (5 characters)
2035 '<' excluded: "^I" (^I is a real <Tab>)
2036 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002037 *cpo->*
2038 > When appending to a register, put a line break before
2039 the appended text.
2040
2041 POSIX flags. These are not included in the Vi default value, except
2042 when $VIM_POSIX was set on startup. |posix|
2043
2044 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002045 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002046 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002047 *cpo-&*
2048 & When ":preserve" was used keep the swap file when
2049 exiting normally while this buffer is still loaded.
2050 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002051 *cpo-\*
2052 \ Backslash in a [] range in a search pattern is taken
2053 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002054 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2055 '\' excluded: "/[ \-]" finds <Space> and '-'
2056 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002057 *cpo-/*
2058 / When "%" is used as the replacement string in a |:s|
2059 command, use the previous replacement string. |:s%|
2060 *cpo-{*
2061 { The |{| and |}| commands also stop at a "{" character
2062 at the start of a line.
2063 *cpo-.*
2064 . The ":chdir" and ":cd" commands fail if the current
2065 buffer is modified, unless ! is used. Vim doesn't
2066 need this, since it remembers the full path of an
2067 opened file.
2068 *cpo-bar*
2069 | The value of the $LINES and $COLUMNS environment
2070 variables overrule the terminal size values obtained
2071 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002072
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002074 *'cryptmethod'* *'cm'*
2075'cryptmethod' number (default 0)
2076 local to buffer
2077 {not in Vi}
2078 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002079 *pkzip*
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002080 0 PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002081 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002082 *blowfish*
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002083 1 Blowfish method. Strong encryption. Requires Vim 7.3
2084 or later, files can NOT be read by Vim 7.2 and older.
2085 This adds a "seed" to the file, every time you write
2086 the file the encrypted bytes will be different.
2087
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002088 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002089 to the detected method of the file being read. Thus if you write it
2090 without changing 'cryptmethod' the same method will be used.
2091 Changing 'cryptmethod' does not mark the file as modified, you have to
2092 explicitly write it when not making modifications.
2093 Also see |:X|.
2094 When a new encryption method is added in a later version of Vim, and
2095 the current version does not recognize it, you will get *E821* .
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002096
2097
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098 *'cscopepathcomp'* *'cspc'*
2099'cscopepathcomp' 'cspc' number (default 0)
2100 global
2101 {not available when compiled without the |+cscope|
2102 feature}
2103 {not in Vi}
2104 Determines how many components of the path to show in a list of tags.
2105 See |cscopepathcomp|.
2106
2107 *'cscopeprg'* *'csprg'*
2108'cscopeprg' 'csprg' string (default "cscope")
2109 global
2110 {not available when compiled without the |+cscope|
2111 feature}
2112 {not in Vi}
2113 Specifies the command to execute cscope. See |cscopeprg|.
2114 This option cannot be set from a |modeline| or in the |sandbox|, for
2115 security reasons.
2116
2117 *'cscopequickfix'* *'csqf'*
2118'cscopequickfix' 'csqf' string (default "")
2119 global
2120 {not available when compiled without the |+cscope|
2121 or |+quickfix| features}
2122 {not in Vi}
2123 Specifies whether to use quickfix window to show cscope results.
2124 See |cscopequickfix|.
2125
2126 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2127'cscopetag' 'cst' boolean (default off)
2128 global
2129 {not available when compiled without the |+cscope|
2130 feature}
2131 {not in Vi}
2132 Use cscope for tag commands. See |cscope-options|.
2133 NOTE: This option is reset when 'compatible' is set.
2134
2135 *'cscopetagorder'* *'csto'*
2136'cscopetagorder' 'csto' number (default 0)
2137 global
2138 {not available when compiled without the |+cscope|
2139 feature}
2140 {not in Vi}
2141 Determines the order in which ":cstag" performs a search. See
2142 |cscopetagorder|.
2143 NOTE: This option is set to 0 when 'compatible' is set.
2144
2145 *'cscopeverbose'* *'csverb'*
2146 *'nocscopeverbose'* *'nocsverb'*
2147'cscopeverbose' 'csverb' boolean (default off)
2148 global
2149 {not available when compiled without the |+cscope|
2150 feature}
2151 {not in Vi}
2152 Give messages when adding a cscope database. See |cscopeverbose|.
2153 NOTE: This option is reset when 'compatible' is set.
2154
Bram Moolenaar860cae12010-06-05 23:22:07 +02002155 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2156'cursorbind' 'crb' boolean (default off)
2157 local to window
2158 {not in Vi}
2159 {not available when compiled without the |+cursorbind|
2160 feature}
2161 When this option is set, as the cursor in the current
2162 window moves other cursorbound windows (windows that also have
2163 this option set) move their cursors to the corresponding line and
2164 column. This option is useful for viewing the
2165 differences between two versions of a file (see 'diff'); in diff mode,
2166 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002167 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002168
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002169
2170 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2171'cursorcolumn' 'cuc' boolean (default off)
2172 local to window
2173 {not in Vi}
2174 {not available when compiled without the |+syntax|
2175 feature}
2176 Highlight the screen column of the cursor with CursorColumn
2177 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2178 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002179 If you only want the highlighting in the current window you can use
2180 these autocommands: >
2181 au WinLeave * set nocursorline nocursorcolumn
2182 au WinEnter * set cursorline cursorcolumn
2183<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002184
2185 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2186'cursorline' 'cul' boolean (default off)
2187 local to window
2188 {not in Vi}
2189 {not available when compiled without the |+syntax|
2190 feature}
2191 Highlight the screen line of the cursor with CursorLine
2192 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2193 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002194 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002195 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002196
2197
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198 *'debug'*
2199'debug' string (default "")
2200 global
2201 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002202 These values can be used:
2203 msg Error messages that would otherwise be omitted will be given
2204 anyway.
2205 throw Error messages that would otherwise be omitted will be given
2206 anyway and also throw an exception and set |v:errmsg|.
2207 beep A message will be given when otherwise only a beep would be
2208 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002209 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002210 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2211 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212
2213 *'define'* *'def'*
2214'define' 'def' string (default "^\s*#\s*define")
2215 global or local to buffer |global-local|
2216 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002217 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 pattern, just like for the "/" command. This option is used for the
2219 commands like "[i" and "[d" |include-search|. The 'isident' option is
2220 used to recognize the defined name after the match:
2221 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2222 See |option-backslash| about inserting backslashes to include a space
2223 or backslash.
2224 The default value is for C programs. For C++ this value would be
2225 useful, to include const type declarations: >
2226 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2227< When using the ":set" command, you need to double the backslashes!
2228
2229 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2230'delcombine' 'deco' boolean (default off)
2231 global
2232 {not in Vi}
2233 {only available when compiled with the |+multi_byte|
2234 feature}
2235 If editing Unicode and this option is set, backspace and Normal mode
2236 "x" delete each combining character on its own. When it is off (the
2237 default) the character along with its combining characters are
2238 deleted.
2239 Note: When 'delcombine' is set "xx" may work different from "2x"!
2240
2241 This is useful for Arabic, Hebrew and many other languages where one
2242 may have combining characters overtop of base characters, and want
2243 to remove only the combining ones.
2244
2245 *'dictionary'* *'dict'*
2246'dictionary' 'dict' string (default "")
2247 global or local to buffer |global-local|
2248 {not in Vi}
2249 List of file names, separated by commas, that are used to lookup words
2250 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2251 contain a list of words. This can be one word per line, or several
2252 words per line, separated by non-keyword characters (white space is
2253 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002254 When this option is empty, or an entry "spell" is present, spell
2255 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002256 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257 after a comma are ignored, otherwise spaces are included in the file
2258 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002259 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260 Where to find a list of words?
2261 - On FreeBSD, there is the file "/usr/share/dict/words".
2262 - In the Simtel archive, look in the "msdos/linguist" directory.
2263 - In "miscfiles" of the GNU collection.
2264 The use of |:set+=| and |:set-=| is preferred when adding or removing
2265 directories from the list. This avoids problems when a future version
2266 uses another default.
2267 Backticks cannot be used in this option for security reasons.
2268
2269 *'diff'* *'nodiff'*
2270'diff' boolean (default off)
2271 local to window
2272 {not in Vi}
2273 {not available when compiled without the |+diff|
2274 feature}
2275 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002276 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002277
2278 *'dex'* *'diffexpr'*
2279'diffexpr' 'dex' string (default "")
2280 global
2281 {not in Vi}
2282 {not available when compiled without the |+diff|
2283 feature}
2284 Expression which is evaluated to obtain an ed-style diff file from two
2285 versions of a file. See |diff-diffexpr|.
2286 This option cannot be set from a |modeline| or in the |sandbox|, for
2287 security reasons.
2288
2289 *'dip'* *'diffopt'*
2290'diffopt' 'dip' string (default "filler")
2291 global
2292 {not in Vi}
2293 {not available when compiled without the |+diff|
2294 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002295 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296 All are optional. Items must be separated by a comma.
2297
2298 filler Show filler lines, to keep the text
2299 synchronized with a window that has inserted
2300 lines at the same position. Mostly useful
2301 when windows are side-by-side and 'scrollbind'
2302 is set.
2303
2304 context:{n} Use a context of {n} lines between a change
2305 and a fold that contains unchanged lines.
2306 When omitted a context of six lines is used.
2307 See |fold-diff|.
2308
2309 icase Ignore changes in case of text. "a" and "A"
2310 are considered the same. Adds the "-i" flag
2311 to the "diff" command if 'diffexpr' is empty.
2312
2313 iwhite Ignore changes in amount of white space. Adds
2314 the "-b" flag to the "diff" command if
2315 'diffexpr' is empty. Check the documentation
2316 of the "diff" command for what this does
2317 exactly. It should ignore adding trailing
2318 white space, but not leading white space.
2319
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002320 horizontal Start diff mode with horizontal splits (unless
2321 explicitly specified otherwise).
2322
2323 vertical Start diff mode with vertical splits (unless
2324 explicitly specified otherwise).
2325
2326 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2327 starting diff mode. Without this 2 is used.
2328
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 Examples: >
2330
2331 :set diffopt=filler,context:4
2332 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002333 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334<
2335 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2336'digraph' 'dg' boolean (default off)
2337 global
2338 {not in Vi}
2339 {not available when compiled without the |+digraphs|
2340 feature}
2341 Enable the entering of digraphs in Insert mode with {char1} <BS>
2342 {char2}. See |digraphs|.
2343 NOTE: This option is reset when 'compatible' is set.
2344
2345 *'directory'* *'dir'*
2346'directory' 'dir' string (default for Amiga: ".,t:",
2347 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2348 for Unix: ".,~/tmp,/var/tmp,/tmp")
2349 global
2350 List of directory names for the swap file, separated with commas.
2351 - The swap file will be created in the first directory where this is
2352 possible.
2353 - Empty means that no swap file will be used (recovery is
2354 impossible!).
2355 - A directory "." means to put the swap file in the same directory as
2356 the edited file. On Unix, a dot is prepended to the file name, so
2357 it doesn't show in a directory listing. On MS-Windows the "hidden"
2358 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002359 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 put the swap file relative to where the edited file is. The leading
2361 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002362 - For Unix and Win32, if a directory ends in two path separators "//"
2363 or "\\", the swap file name will be built from the complete path to
2364 the file with all path separators substituted to percent '%' signs.
2365 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002366 On Win32, when a separating comma is following, you must use "//",
2367 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368 - Spaces after the comma are ignored, other spaces are considered part
2369 of the directory name. To have a space at the start of a directory
2370 name, precede it with a backslash.
2371 - To include a comma in a directory name precede it with a backslash.
2372 - A directory name may end in an ':' or '/'.
2373 - Environment variables are expanded |:set_env|.
2374 - Careful with '\' characters, type one before a space, type two to
2375 get one in the option (see |option-backslash|), for example: >
2376 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2377< - For backwards compatibility with Vim version 3.0 a '>' at the start
2378 of the option is removed.
2379 Using "." first in the list is recommended. This means that editing
2380 the same file twice will result in a warning. Using "/tmp" on Unix is
2381 discouraged: When the system crashes you lose the swap file.
2382 "/var/tmp" is often not cleared when rebooting, thus is a better
2383 choice than "/tmp". But it can contain a lot of files, your swap
2384 files get lost in the crowd. That is why a "tmp" directory in your
2385 home directory is tried first.
2386 The use of |:set+=| and |:set-=| is preferred when adding or removing
2387 directories from the list. This avoids problems when a future version
2388 uses another default.
2389 This option cannot be set from a |modeline| or in the |sandbox|, for
2390 security reasons.
2391 {Vi: directory to put temp file in, defaults to "/tmp"}
2392
2393 *'display'* *'dy'*
2394'display' 'dy' string (default "")
2395 global
2396 {not in Vi}
2397 Change the way text is displayed. This is comma separated list of
2398 flags:
2399 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002400 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 last line that doesn't fit is replaced with "@" lines.
2402 uhex Show unprintable characters hexadecimal as <xx>
2403 instead of using ^C and ~C.
2404
2405 *'eadirection'* *'ead'*
2406'eadirection' 'ead' string (default "both")
2407 global
2408 {not in Vi}
2409 {not available when compiled without the +vertsplit
2410 feature}
2411 Tells when the 'equalalways' option applies:
2412 ver vertically, width of windows is not affected
2413 hor horizontally, height of windows is not affected
2414 both width and height of windows is affected
2415
2416 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2417'edcompatible' 'ed' boolean (default off)
2418 global
2419 Makes the 'g' and 'c' flags of the ":substitute" command to be
2420 toggled each time the flag is given. See |complex-change|. See
2421 also 'gdefault' option.
2422 Switching this option on is discouraged!
2423
2424 *'encoding'* *'enc'* *E543*
2425'encoding' 'enc' string (default: "latin1" or value from $LANG)
2426 global
2427 {only available when compiled with the |+multi_byte|
2428 feature}
2429 {not in Vi}
2430 Sets the character encoding used inside Vim. It applies to text in
2431 the buffers, registers, Strings in expressions, text stored in the
2432 viminfo file, etc. It sets the kind of characters which Vim can work
2433 with. See |encoding-names| for the possible values.
2434
2435 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002436 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002438 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439
Bram Moolenaar865242e2010-07-14 21:12:05 +02002440 This option cannot be set from a |modeline|. It would most likely
2441 corrupt the text.
2442
Bram Moolenaar071d4272004-06-13 20:20:40 +00002443 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2444 "utf-8". Although care has been taken to allow different values of
2445 'encoding', "utf-8" is the natural choice for the environment and
2446 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002447 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448 versions, and to avoid changing the encoding of newly created files
2449 without your knowledge (in case 'fileencodings' is empty).
2450
2451 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002452 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002453 iconv() or as specified with 'charconvert'.
2454
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002455 If you need to know whether 'encoding' is a multi-byte encoding, you
2456 can use: >
2457 if has("multi_byte_encoding")
2458<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459 Normally 'encoding' will be equal to your current locale. This will
2460 be the default if Vim recognizes your environment settings. If
2461 'encoding' is not set to the current locale, 'termencoding' must be
2462 set to convert typed and displayed text. See |encoding-table|.
2463
2464 When you set this option, it fires the |EncodingChanged| autocommand
2465 event so that you can set up fonts if necessary.
2466
2467 When the option is set, the value is converted to lowercase. Thus
2468 you can set it with uppercase values too. Underscores are translated
2469 to '-' signs.
2470 When the encoding is recognized, it is changed to the standard name.
2471 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2472 "iso-8859-2" and "utf8" becomes "utf-8".
2473
2474 Note: "latin1" is also used when the encoding could not be detected.
2475 This only works when editing files in the same encoding! When the
2476 actual character set is not latin1, make sure 'fileencoding' and
2477 'fileencodings' are empty. When conversion is needed, switch to using
2478 utf-8.
2479
2480 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2481 You don't notice this while editing, but it does matter for the
2482 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2483 setting 'encoding' to one of these values instead of utf-8 only has
2484 effect for encoding used for files when 'fileencoding' is empty.
2485
Bram Moolenaar661b1822005-07-28 22:36:45 +00002486 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2487 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488
2489 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2490'endofline' 'eol' boolean (default on)
2491 local to buffer
2492 {not in Vi}
2493 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002494 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495 option is automatically set when starting to edit a new file, unless
2496 the file does not have an <EOL> for the last line in the file, in
2497 which case it is reset. Normally you don't have to set or reset this
2498 option. When 'binary' is off the value is not used when writing the
2499 file. When 'binary' is on it is used to remember the presence of a
2500 <EOL> for the last line in the file, so that when you write the file
2501 the situation from the original file can be kept. But you can change
2502 it if you want to.
2503
2504 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2505'equalalways' 'ea' boolean (default on)
2506 global
2507 {not in Vi}
2508 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002509 splitting or closing a window. This also happens the moment the
2510 option is switched on. When off, splitting a window will reduce the
2511 size of the current window and leave the other windows the same. When
2512 closing a window the extra lines are given to the window next to it
2513 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002514 When mixing vertically and horizontally split windows, a minimal size
2515 is computed and some windows may be larger if there is room. The
2516 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002517 Changing the height and width of a window can be avoided by setting
2518 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002519 If a window size is specified when creating a new window sizes are
2520 currently not equalized (it's complicated, but may be implemented in
2521 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522
2523 *'equalprg'* *'ep'*
2524'equalprg' 'ep' string (default "")
2525 global or local to buffer |global-local|
2526 {not in Vi}
2527 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002528 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002529 or 'indentexpr'. When Vim was compiled without internal formatting,
2530 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002531 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532 about including spaces and backslashes.
2533 This option cannot be set from a |modeline| or in the |sandbox|, for
2534 security reasons.
2535
2536 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2537'errorbells' 'eb' boolean (default off)
2538 global
2539 Ring the bell (beep or screen flash) for error messages. This only
2540 makes a difference for error messages, the bell will be used always
2541 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002542 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543 screen flash or do nothing.
2544
2545 *'errorfile'* *'ef'*
2546'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2547 others: "errors.err")
2548 global
2549 {not in Vi}
2550 {not available when compiled without the |+quickfix|
2551 feature}
2552 Name of the errorfile for the QuickFix mode (see |:cf|).
2553 When the "-q" command-line argument is used, 'errorfile' is set to the
2554 following argument. See |-q|.
2555 NOT used for the ":make" command. See 'makeef' for that.
2556 Environment variables are expanded |:set_env|.
2557 See |option-backslash| about including spaces and backslashes.
2558 This option cannot be set from a |modeline| or in the |sandbox|, for
2559 security reasons.
2560
2561 *'errorformat'* *'efm'*
2562'errorformat' 'efm' string (default is very long)
2563 global or local to buffer |global-local|
2564 {not in Vi}
2565 {not available when compiled without the |+quickfix|
2566 feature}
2567 Scanf-like description of the format for the lines in the error file
2568 (see |errorformat|).
2569
2570 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2571'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2572 global
2573 {not in Vi}
2574 Function keys that start with an <Esc> are recognized in Insert
2575 mode. When this option is off, the cursor and function keys cannot be
2576 used in Insert mode if they start with an <Esc>. The advantage of
2577 this is that the single <Esc> is recognized immediately, instead of
2578 after one second. Instead of resetting this option, you might want to
2579 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2580 when 'esckeys' is off, you can still map anything, but the cursor keys
2581 won't work by default.
2582 NOTE: This option is set to the Vi default value when 'compatible' is
2583 set and to the Vim default value when 'compatible' is reset.
2584
2585 *'eventignore'* *'ei'*
2586'eventignore' 'ei' string (default "")
2587 global
2588 {not in Vi}
2589 {not available when compiled without the |+autocmd|
2590 feature}
2591 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002592 When set to "all" or when "all" is one of the items, all autocommand
2593 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 Otherwise this is a comma separated list of event names. Example: >
2595 :set ei=WinEnter,WinLeave
2596<
2597 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2598'expandtab' 'et' boolean (default off)
2599 local to buffer
2600 {not in Vi}
2601 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002602 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002603 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2604 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2605 NOTE: This option is reset when 'compatible' is set.
2606
2607 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2608'exrc' 'ex' boolean (default off)
2609 global
2610 {not in Vi}
2611 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2612 directory. If you switch this option on you should also consider
2613 setting the 'secure' option (see |initialization|). Using a local
2614 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2615 also see |.vimrc| and |gui-init|.
2616 This option cannot be set from a |modeline| or in the |sandbox|, for
2617 security reasons.
2618
2619 *'fileencoding'* *'fenc'* *E213*
2620'fileencoding' 'fenc' string (default: "")
2621 local to buffer
2622 {only available when compiled with the |+multi_byte|
2623 feature}
2624 {not in Vi}
2625 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002626
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002628 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629 When 'fileencoding' is empty, the same value as 'encoding' will be
2630 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002631 Conversion will also be done when 'encoding' and 'fileencoding' are
2632 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2633 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002635 'encoding' is "utf-8" or another Unicode encoding, conversion
2636 is most likely done in a way that the reverse conversion
2637 results in the same text. When 'encoding' is not "utf-8" some
2638 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002639
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640 See 'encoding' for the possible values. Additionally, values may be
2641 specified that can be handled by the converter, see
2642 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002643
Bram Moolenaar071d4272004-06-13 20:20:40 +00002644 When reading a file 'fileencoding' will be set from 'fileencodings'.
2645 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002646 'fileencoding', use the |++enc| argument. One exception: when
2647 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002648 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002649
Bram Moolenaar071d4272004-06-13 20:20:40 +00002650 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2651 When the option is set, the value is converted to lowercase. Thus
2652 you can set it with uppercase values too. '_' characters are
2653 replaced with '-'. If a name is recognized from the list for
2654 'encoding', it is replaced by the standard name. For example
2655 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002656
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657 When this option is set, after starting to edit a file, the 'modified'
2658 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002659
2660 Keep in mind that changing 'fenc' from a modeline happens
2661 AFTER the text has been read, thus it applies to when the file will be
2662 written. If you do set 'fenc' in a modeline, you might want to set
2663 'nomodified' to avoid not being able to ":q".
2664
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 This option can not be changed when 'modifiable' is off.
2666
2667 *'fe'*
2668 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002669 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 old short name was 'fe', which is no longer used.
2671
2672 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002673'fileencodings' 'fencs' string (default: "ucs-bom",
2674 "ucs-bom,utf-8,default,latin1" when
2675 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 global
2677 {only available when compiled with the |+multi_byte|
2678 feature}
2679 {not in Vi}
2680 This is a list of character encodings considered when starting to edit
2681 an existing file. When a file is read, Vim tries to use the first
2682 mentioned character encoding. If an error is detected, the next one
2683 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002684 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 an empty string, which means the value of 'encoding' is used.
2686 WARNING: Conversion can cause loss of information! When
2687 'encoding' is "utf-8" (or one of the other Unicode variants)
2688 conversion is most likely done in a way that the reverse
2689 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002690 "utf-8" some non-ASCII characters may be lost! You can use
2691 the |++bad| argument to specify what is done with characters
2692 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693 For an empty file or a file with only ASCII characters most encodings
2694 will work and the first entry of 'fileencodings' will be used (except
2695 "ucs-bom", which requires the BOM to be present). If you prefer
2696 another encoding use an BufReadPost autocommand event to test if your
2697 preferred encoding is to be used. Example: >
2698 au BufReadPost * if search('\S', 'w') == 0 |
2699 \ set fenc=iso-2022-jp | endif
2700< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2701 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002702 When the |++enc| argument is used then the value of 'fileencodings' is
2703 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002704 Note that 'fileencodings' is not used for a new file, the global value
2705 of 'fileencoding' is used instead. You can set it with: >
2706 :setglobal fenc=iso-8859-2
2707< This means that a non-existing file may get a different encoding than
2708 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 The special value "ucs-bom" can be used to check for a Unicode BOM
2710 (Byte Order Mark) at the start of the file. It must not be preceded
2711 by "utf-8" or another Unicode encoding for this to work properly.
2712 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2713 because Vim cannot detect an error, thus the encoding is always
2714 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002715 The special value "default" can be used for the encoding from the
2716 environment. This is the default value for 'encoding'. It is useful
2717 when 'encoding' is set to "utf-8" and your environment uses a
2718 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002719 When 'encoding' is "utf-8" and a file contains an illegal byte
2720 sequence it won't be recognized as UTF-8. You can use the |8g8|
2721 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722 WRONG VALUES: WHAT'S WRONG:
2723 latin1,utf-8 "latin1" will always be used
2724 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2725 file
2726 cp1250,latin1 "cp1250" will always be used
2727 If 'fileencodings' is empty, 'fileencoding' is not modified.
2728 See 'fileencoding' for the possible values.
2729 Setting this option does not have an effect until the next time a file
2730 is read.
2731
2732 *'fileformat'* *'ff'*
2733'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2734 Unix default: "unix",
2735 Macintosh default: "mac")
2736 local to buffer
2737 {not in Vi}
2738 This gives the <EOL> of the current buffer, which is used for
2739 reading/writing the buffer from/to a file:
2740 dos <CR> <NL>
2741 unix <NL>
2742 mac <CR>
2743 When "dos" is used, CTRL-Z at the end of a file is ignored.
2744 See |file-formats| and |file-read|.
2745 For the character encoding of the file see 'fileencoding'.
2746 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2747 works like it was set to "unix'.
2748 This option is set automatically when starting to edit a file and
2749 'fileformats' is not empty and 'binary' is off.
2750 When this option is set, after starting to edit a file, the 'modified'
2751 option is set, because the file would be different when written.
2752 This option can not be changed when 'modifiable' is off.
2753 For backwards compatibility: When this option is set to "dos",
2754 'textmode' is set, otherwise 'textmode' is reset.
2755
2756 *'fileformats'* *'ffs'*
2757'fileformats' 'ffs' string (default:
2758 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2759 Vim Unix: "unix,dos",
2760 Vim Mac: "mac,unix,dos",
2761 Vi Cygwin: "unix,dos",
2762 Vi others: "")
2763 global
2764 {not in Vi}
2765 This gives the end-of-line (<EOL>) formats that will be tried when
2766 starting to edit a new buffer and when reading a file into an existing
2767 buffer:
2768 - When empty, the format defined with 'fileformat' will be used
2769 always. It is not set automatically.
2770 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002771 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 'fileformats' name will be used when a file is read into an existing
2773 buffer, no matter what 'fileformat' for that buffer is set to.
2774 - When more than one name is present, separated by commas, automatic
2775 <EOL> detection will be done when reading a file. When starting to
2776 edit a file, a check is done for the <EOL>:
2777 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2778 'fileformat' is set to "dos".
2779 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002780 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 preceding <CR>, "unix" is preferred over "dos".
2782 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2783 This means that "mac" is only chosen when "unix" is not present,
2784 or when no <NL> is found in the file, and when "dos" is not
2785 present, or no <CR><NL> is present in the file.
2786 Also if "unix" was first chosen, but the first <CR> is before
2787 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2788 the file, then 'fileformat' is set to "mac".
2789 4. If 'fileformat' is still not set, the first name from
2790 'fileformats' is used.
2791 When reading a file into an existing buffer, the same is done, but
2792 this happens like 'fileformat' has been set appropriately for that
2793 file only, the option is not changed.
2794 When 'binary' is set, the value of 'fileformats' is not used.
2795
2796 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2797 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2798 done:
2799 - When 'fileformats' is empty, there is no automatic detection. Dos
2800 format will be used.
2801 - When 'fileformats' is set to one or more names, automatic detection
2802 is done. This is based on the first <NL> in the file: If there is a
2803 <CR> in front of it, Dos format is used, otherwise Unix format is
2804 used.
2805 Also see |file-formats|.
2806 For backwards compatibility: When this option is set to an empty
2807 string or one format (no comma is included), 'textauto' is reset,
2808 otherwise 'textauto' is set.
2809 NOTE: This option is set to the Vi default value when 'compatible' is
2810 set and to the Vim default value when 'compatible' is reset.
2811
2812 *'filetype'* *'ft'*
2813'filetype' 'ft' string (default: "")
2814 local to buffer
2815 {not in Vi}
2816 {not available when compiled without the |+autocmd|
2817 feature}
2818 When this option is set, the FileType autocommand event is triggered.
2819 All autocommands that match with the value of this option will be
2820 executed. Thus the value of 'filetype' is used in place of the file
2821 name.
2822 Otherwise this option does not always reflect the current file type.
2823 This option is normally set when the file type is detected. To enable
2824 this use the ":filetype on" command. |:filetype|
2825 Setting this option to a different value is most useful in a modeline,
2826 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002827 Example, for in an IDL file:
2828 /* vim: set filetype=idl : */ ~
2829 |FileType| |filetypes|
2830 When a dot appears in the value then this separates two filetype
2831 names. Example:
2832 /* vim: set filetype=c.doxygen : */ ~
2833 This will use the "c" filetype first, then the "doxygen" filetype.
2834 This works both for filetype plugins and for syntax files. More than
2835 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836 Do not confuse this option with 'osfiletype', which is for the file
2837 type that is actually stored with the file.
2838 This option is not copied to another buffer, independent of the 's' or
2839 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002840 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841
2842 *'fillchars'* *'fcs'*
2843'fillchars' 'fcs' string (default "vert:|,fold:-")
2844 global
2845 {not in Vi}
2846 {not available when compiled without the |+windows|
2847 and |+folding| features}
2848 Characters to fill the statuslines and vertical separators.
2849 It is a comma separated list of items:
2850
2851 item default Used for ~
2852 stl:c ' ' or '^' statusline of the current window
2853 stlnc:c ' ' or '-' statusline of the non-current windows
2854 vert:c '|' vertical separators |:vsplit|
2855 fold:c '-' filling 'foldtext'
2856 diff:c '-' deleted lines of the 'diff' option
2857
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002858 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859 "stlnc" the space will be used when there is highlighting, '^' or '-'
2860 otherwise.
2861
2862 Example: >
2863 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2864< This is similar to the default, except that these characters will also
2865 be used when there is highlighting.
2866
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002867 for "stl" and "stlnc" only single-byte values are supported.
2868
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869 The highlighting used for these items:
2870 item highlight group ~
2871 stl:c StatusLine |hl-StatusLine|
2872 stlnc:c StatusLineNC |hl-StatusLineNC|
2873 vert:c VertSplit |hl-VertSplit|
2874 fold:c Folded |hl-Folded|
2875 diff:c DiffDelete |hl-DiffDelete|
2876
2877 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2878'fkmap' 'fk' boolean (default off) *E198*
2879 global
2880 {not in Vi}
2881 {only available when compiled with the |+rightleft|
2882 feature}
2883 When on, the keyboard is mapped for the Farsi character set.
2884 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002885 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886
2887 *'foldclose'* *'fcl'*
2888'foldclose' 'fcl' string (default "")
2889 global
2890 {not in Vi}
2891 {not available when compiled without the |+folding|
2892 feature}
2893 When set to "all", a fold is closed when the cursor isn't in it and
2894 its level is higher than 'foldlevel'. Useful if you want folds to
2895 automatically close when moving out of them.
2896
2897 *'foldcolumn'* *'fdc'*
2898'foldcolumn' 'fdc' number (default 0)
2899 local to window
2900 {not in Vi}
2901 {not available when compiled without the |+folding|
2902 feature}
2903 When non-zero, a column with the specified width is shown at the side
2904 of the window which indicates open and closed folds. The maximum
2905 value is 12.
2906 See |folding|.
2907
2908 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2909'foldenable' 'fen' boolean (default on)
2910 local to window
2911 {not in Vi}
2912 {not available when compiled without the |+folding|
2913 feature}
2914 When off, all folds are open. This option can be used to quickly
2915 switch between showing all text unfolded and viewing the text with
2916 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002917 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 'foldenable' is off.
2919 This option is set by commands that create a new fold or close a fold.
2920 See |folding|.
2921
2922 *'foldexpr'* *'fde'*
2923'foldexpr' 'fde' string (default: "0")
2924 local to window
2925 {not in Vi}
2926 {not available when compiled without the |+folding|
2927 or |+eval| feature}
2928 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002929 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002930
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002931 The expression may be evaluated in the |sandbox|, see
2932 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002933 This option can't be set from a |modeline| when the 'diff' option is
2934 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002935
2936 It is not allowed to change text or jump to another window while
2937 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002938
2939 *'foldignore'* *'fdi'*
2940'foldignore' 'fdi' string (default: "#")
2941 local to window
2942 {not in Vi}
2943 {not available when compiled without the |+folding|
2944 feature}
2945 Used only when 'foldmethod' is "indent". Lines starting with
2946 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002947 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 The default "#" works well for C programs. See |fold-indent|.
2949
2950 *'foldlevel'* *'fdl'*
2951'foldlevel' 'fdl' number (default: 0)
2952 local to window
2953 {not in Vi}
2954 {not available when compiled without the |+folding|
2955 feature}
2956 Sets the fold level: Folds with a higher level will be closed.
2957 Setting this option to zero will close all folds. Higher numbers will
2958 close fewer folds.
2959 This option is set by commands like |zm|, |zM| and |zR|.
2960 See |fold-foldlevel|.
2961
2962 *'foldlevelstart'* *'fdls'*
2963'foldlevelstart' 'fdls' number (default: -1)
2964 global
2965 {not in Vi}
2966 {not available when compiled without the |+folding|
2967 feature}
2968 Sets 'foldlevel' when starting to edit another buffer in a window.
2969 Useful to always start editing with all folds closed (value zero),
2970 some folds closed (one) or no folds closed (99).
2971 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002972 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 ignores this option and closes all folds.
2974 It is also done before BufReadPre autocommands, to allow an autocmd to
2975 overrule the 'foldlevel' value for specific files.
2976 When the value is negative, it is not used.
2977
2978 *'foldmarker'* *'fmr'* *E536*
2979'foldmarker' 'fmr' string (default: "{{{,}}}")
2980 local to window
2981 {not in Vi}
2982 {not available when compiled without the |+folding|
2983 feature}
2984 The start and end marker used when 'foldmethod' is "marker". There
2985 must be one comma, which separates the start and end marker. The
2986 marker is a literal string (a regular expression would be too slow).
2987 See |fold-marker|.
2988
2989 *'foldmethod'* *'fdm'*
2990'foldmethod' 'fdm' string (default: "manual")
2991 local to window
2992 {not in Vi}
2993 {not available when compiled without the |+folding|
2994 feature}
2995 The kind of folding used for the current window. Possible values:
2996 |fold-manual| manual Folds are created manually.
2997 |fold-indent| indent Lines with equal indent form a fold.
2998 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2999 |fold-marker| marker Markers are used to specify folds.
3000 |fold-syntax| syntax Syntax highlighting items specify folds.
3001 |fold-diff| diff Fold text that is not changed.
3002
3003 *'foldminlines'* *'fml'*
3004'foldminlines' 'fml' number (default: 1)
3005 local to window
3006 {not in Vi}
3007 {not available when compiled without the |+folding|
3008 feature}
3009 Sets the minimum number of screen lines for a fold to be displayed
3010 closed. Also for manually closed folds.
3011 Note that this only has an effect of what is displayed. After using
3012 "zc" to close a fold, which is displayed open because it's smaller
3013 than 'foldminlines', a following "zc" may close a containing fold.
3014
3015 *'foldnestmax'* *'fdn'*
3016'foldnestmax' 'fdn' number (default: 20)
3017 local to window
3018 {not in Vi}
3019 {not available when compiled without the |+folding|
3020 feature}
3021 Sets the maximum nesting of folds for the "indent" and "syntax"
3022 methods. This avoids that too many folds will be created. Using more
3023 than 20 doesn't work, because the internal limit is 20.
3024
3025 *'foldopen'* *'fdo'*
3026'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3027 search,tag,undo")
3028 global
3029 {not in Vi}
3030 {not available when compiled without the |+folding|
3031 feature}
3032 Specifies for which type of commands folds will be opened, if the
3033 command moves the cursor into a closed fold. It is a comma separated
3034 list of items.
3035 item commands ~
3036 all any
3037 block "(", "{", "[[", "[{", etc.
3038 hor horizontal movements: "l", "w", "fx", etc.
3039 insert any command in Insert mode
3040 jump far jumps: "G", "gg", etc.
3041 mark jumping to a mark: "'m", CTRL-O, etc.
3042 percent "%"
3043 quickfix ":cn", ":crew", ":make", etc.
3044 search search for a pattern: "/", "n", "*", "gd", etc.
3045 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003046 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 tag jumping to a tag: ":ta", CTRL-T, etc.
3048 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003049 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050 the |zv| command to the mapping to get the same effect.
3051 When a movement command is used for an operator (e.g., "dl" or "y%")
3052 this option is not used. This means the operator will include the
3053 whole closed fold.
3054 Note that vertical movements are not here, because it would make it
3055 very difficult to move onto a closed fold.
3056 In insert mode the folds containing the cursor will always be open
3057 when text is inserted.
3058 To close folds you can re-apply 'foldlevel' with the |zx| command or
3059 set the 'foldclose' option to "all".
3060
3061 *'foldtext'* *'fdt'*
3062'foldtext' 'fdt' string (default: "foldtext()")
3063 local to window
3064 {not in Vi}
3065 {not available when compiled without the |+folding|
3066 feature}
3067 An expression which is used to specify the text displayed for a closed
3068 fold. See |fold-foldtext|.
3069
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003070 The expression may be evaluated in the |sandbox|, see
3071 |sandbox-option|.
3072
3073 It is not allowed to change text or jump to another window while
3074 evaluating 'foldtext' |textlock|.
3075
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 *'formatoptions'* *'fo'*
3077'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3078 local to buffer
3079 {not in Vi}
3080 This is a sequence of letters which describes how automatic
3081 formatting is to be done. See |fo-table|. When the 'paste' option is
3082 on, no formatting is done (like 'formatoptions' is empty). Commas can
3083 be inserted for readability.
3084 To avoid problems with flags that are added in the future, use the
3085 "+=" and "-=" feature of ":set" |add-option-flags|.
3086 NOTE: This option is set to the Vi default value when 'compatible' is
3087 set and to the Vim default value when 'compatible' is reset.
3088
Bram Moolenaar86b68352004-12-27 21:59:20 +00003089 *'formatlistpat'* *'flp'*
3090'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3091 local to buffer
3092 {not in Vi}
3093 A pattern that is used to recognize a list header. This is used for
3094 the "n" flag in 'formatoptions'.
3095 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003096 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003097 while still checking more characters. There must be a character
3098 following the pattern, when it matches the whole line it is handled
3099 like there is no match.
3100 The default recognizes a number, followed by an optional punctuation
3101 character and white space.
3102
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 *'formatprg'* *'fp'*
3104'formatprg' 'fp' string (default "")
3105 global
3106 {not in Vi}
3107 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003108 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003110 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003111 If the 'formatexpr' option is not empty it will be used instead.
3112 Otherwise, if 'formatprg' option is an empty string, the internal
3113 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003114 Environment variables are expanded |:set_env|. See |option-backslash|
3115 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003116 The expression may be evaluated in the |sandbox|, see
3117 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003119 *'formatexpr'* *'fex'*
3120'formatexpr' 'fex' string (default "")
3121 local to buffer
3122 {not in Vi}
3123 {not available when compiled without the |+eval|
3124 feature}
3125 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003126 operator. When this option is empty 'formatprg' is used.
3127
3128 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003129 The |v:count| variable holds the number of lines to be formatted.
3130 The |v:char| variable holds the character that is going to be
3131 inserted. This can be empty. Don't insert it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003132
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003133 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003134 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003135< This will invoke the mylang#Format() function in the
3136 autoload/mylang.vim file in 'runtimepath'. |autoload|
3137
3138 The expression is also evaluated when 'textwidth' is set and adding
3139 text beyond that limit. This happens under the same conditions as
3140 when internal formatting is used. Make sure the cursor is kept in the
3141 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003142 return "i" or "R" in this situation.
3143
3144 When the expression evaluates to non-zero Vim will fall back to using
3145 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003146
3147 The expression may be evaluated in the |sandbox|, see
3148 |sandbox-option|.
3149
3150 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003151'fsync' 'fs' boolean (default on)
3152 global
3153 {not in Vi}
3154 When on, the library function fsync() will be called after writing a
3155 file. This will flush a file to disk, ensuring that it is safely
3156 written even on filesystems which do metadata-only journaling. This
3157 will force the harddrive to spin up on Linux systems running in laptop
3158 mode, so it may be undesirable in some situations. Be warned that
3159 turning this off increases the chances of data loss after a crash. On
3160 systems without an fsync() implementation, this variable is always
3161 off.
3162 Also see 'swapsync' for controlling fsync() on swap files.
3163
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3165'gdefault' 'gd' boolean (default off)
3166 global
3167 {not in Vi}
3168 When on, the ":substitute" flag 'g' is default on. This means that
3169 all matches in a line are substituted instead of one. When a 'g' flag
3170 is given to a ":substitute" command, this will toggle the substitution
3171 of all or one match. See |complex-change|.
3172
3173 command 'gdefault' on 'gdefault' off ~
3174 :s/// subst. all subst. one
3175 :s///g subst. one subst. all
3176 :s///gg subst. all subst. one
3177
3178 NOTE: This option is reset when 'compatible' is set.
3179
3180 *'grepformat'* *'gfm'*
3181'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3182 global
3183 {not in Vi}
3184 Format to recognize for the ":grep" command output.
3185 This is a scanf-like string that uses the same format as the
3186 'errorformat' option: see |errorformat|.
3187
3188 *'grepprg'* *'gp'*
3189'grepprg' 'gp' string (default "grep -n ",
3190 Unix: "grep -n $* /dev/null",
3191 Win32: "findstr /n" or "grep -n",
3192 VMS: "SEARCH/NUMBERS ")
3193 global or local to buffer |global-local|
3194 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003195 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 and '#' characters, which are expanded like when used in a command-
3197 line. The placeholder "$*" is allowed to specify where the arguments
3198 will be included. Environment variables are expanded |:set_env|. See
3199 |option-backslash| about including spaces and backslashes.
3200 When your "grep" accepts the "-H" argument, use this to make ":grep"
3201 also work well with a single file: >
3202 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003203< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003204 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3205 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003206 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 apply equally to 'grepprg'.
3208 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3209 otherwise it's "grep -n".
3210 This option cannot be set from a |modeline| or in the |sandbox|, for
3211 security reasons.
3212
3213 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3214'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3215 ve:ver35-Cursor,
3216 o:hor50-Cursor,
3217 i-ci:ver25-Cursor/lCursor,
3218 r-cr:hor20-Cursor/lCursor,
3219 sm:block-Cursor
3220 -blinkwait175-blinkoff150-blinkon175",
3221 for MS-DOS and Win32 console:
3222 "n-v-c:block,o:hor50,i-ci:hor15,
3223 r-cr:hor30,sm:block")
3224 global
3225 {not in Vi}
3226 {only available when compiled with GUI enabled, and
3227 for MS-DOS and Win32 console}
3228 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003229 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 the height of the cursor can be changed. This can be done by
3231 specifying a block cursor, or a percentage for a vertical or
3232 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003233 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003235 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 mode-list and an argument-list:
3237 mode-list:argument-list,mode-list:argument-list,..
3238 The mode-list is a dash separated list of these modes:
3239 n Normal mode
3240 v Visual mode
3241 ve Visual mode with 'selection' "exclusive" (same as 'v',
3242 if not specified)
3243 o Operator-pending mode
3244 i Insert mode
3245 r Replace mode
3246 c Command-line Normal (append) mode
3247 ci Command-line Insert mode
3248 cr Command-line Replace mode
3249 sm showmatch in Insert mode
3250 a all modes
3251 The argument-list is a dash separated list of these arguments:
3252 hor{N} horizontal bar, {N} percent of the character height
3253 ver{N} vertical bar, {N} percent of the character width
3254 block block cursor, fills the whole character
3255 [only one of the above three should be present]
3256 blinkwait{N} *cursor-blinking*
3257 blinkon{N}
3258 blinkoff{N}
3259 blink times for cursor: blinkwait is the delay before
3260 the cursor starts blinking, blinkon is the time that
3261 the cursor is shown and blinkoff is the time that the
3262 cursor is not shown. The times are in msec. When one
3263 of the numbers is zero, there is no blinking. The
3264 default is: "blinkwait700-blinkon400-blinkoff250".
3265 These numbers are used for a missing entry. This
3266 means that blinking is enabled by default. To switch
3267 blinking off you can use "blinkon0". The cursor only
3268 blinks when Vim is waiting for input, not while
3269 executing a command.
3270 To make the cursor blink in an xterm, see
3271 |xterm-blink|.
3272 {group-name}
3273 a highlight group name, that sets the color and font
3274 for the cursor
3275 {group-name}/{group-name}
3276 Two highlight group names, the first is used when
3277 no language mappings are used, the other when they
3278 are. |language-mapping|
3279
3280 Examples of parts:
3281 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3282 block cursor with colors from the "nCursor"
3283 highlight group
3284 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3285 In Insert and Command-line Insert mode, use a
3286 30% vertical bar cursor with colors from the
3287 "iCursor" highlight group. Blink a bit
3288 faster.
3289
3290 The 'a' mode is different. It will set the given argument-list for
3291 all modes. It does not reset anything to defaults. This can be used
3292 to do a common setting for all modes. For example, to switch off
3293 blinking: "a:blinkon0"
3294
3295 Examples of cursor highlighting: >
3296 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3297 :highlight Cursor gui=NONE guifg=bg guibg=fg
3298<
3299 *'guifont'* *'gfn'*
3300 *E235* *E596* *E610* *E611*
3301'guifont' 'gfn' string (default "")
3302 global
3303 {not in Vi}
3304 {only available when compiled with GUI enabled}
3305 This is a list of fonts which will be used for the GUI version of Vim.
3306 In its simplest form the value is just one font name. When
3307 the font cannot be found you will get an error message. To try other
3308 font names a list can be specified, font names separated with commas.
3309 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003310
Bram Moolenaar05159a02005-02-26 23:04:13 +00003311 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3312 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003313
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 Spaces after a comma are ignored. To include a comma in a font name
3315 precede it with a backslash. Setting an option requires an extra
3316 backslash before a space and a backslash. See also
3317 |option-backslash|. For example: >
3318 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003319< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003321
3322 If none of the fonts can be loaded, Vim will keep the current setting.
3323 If an empty font list is given, Vim will try using other resource
3324 settings (for X, it will use the Vim.font resource), and finally it
3325 will try some builtin default which should always be there ("7x13" in
3326 the case of X). The font names given should be "normal" fonts. Vim
3327 will try to find the related bold and italic fonts.
3328
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003329 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003330 :set guifont=*
3331< will bring up a font requester, where you can pick the font you want.
3332
3333 The font name depends on the GUI used. See |setting-guifont| for a
3334 way to set 'guifont' for various systems.
3335
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 For the GTK+ 2 GUI the font name looks like this: >
3337 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003338< That's all. XLFDs are not used. For Chinese this is reported to work
3339 well: >
3340 if has("gui_gtk2")
3341 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3342 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3343 endif
3344<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003345 For Mac OSX you can use something like this: >
3346 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003347< Also see 'macatsui', it can help fix display problems.
3348 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003350 width). An exception is GTK 2: all fonts are accepted, but
3351 mono-spaced fonts look best.
3352
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 To preview a font on X11, you might be able to use the "xfontsel"
3354 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003355
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 For the Win32 GUI *E244* *E245*
3357 - takes these options in the font name:
3358 hXX - height is XX (points, can be floating-point)
3359 wXX - width is XX (points, can be floating-point)
3360 b - bold
3361 i - italic
3362 u - underline
3363 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003364 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3366 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3367 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003368 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369
3370 Use a ':' to separate the options.
3371 - A '_' can be used in the place of a space, so you don't need to use
3372 backslashes to escape the spaces.
3373 - Examples: >
3374 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3375 :set guifont=Andale_Mono:h7.5:w4.5
3376< See also |font-sizes|.
3377
3378 *'guifontset'* *'gfs'*
3379 *E250* *E252* *E234* *E597* *E598*
3380'guifontset' 'gfs' string (default "")
3381 global
3382 {not in Vi}
3383 {only available when compiled with GUI enabled and
3384 with the |+xfontset| feature}
3385 {not available in the GTK+ 2 GUI}
3386 When not empty, specifies two (or more) fonts to be used. The first
3387 one for normal English, the second one for your special language. See
3388 |xfontset|.
3389 Setting this option also means that all font names will be handled as
3390 a fontset name. Also the ones used for the "font" argument of the
3391 |:highlight| command.
3392 The fonts must match with the current locale. If fonts for the
3393 character sets that the current locale uses are not included, setting
3394 'guifontset' will fail.
3395 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3396 the comma-separated names are alternative names, one of which will be
3397 used. In 'guifontset' the whole string is one fontset name,
3398 including the commas. It is not possible to specify alternative
3399 fontset names.
3400 This example works on many X11 systems: >
3401 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3402<
3403 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3404'guifontwide' 'gfw' string (default "")
3405 global
3406 {not in Vi}
3407 {only available when compiled with GUI enabled}
3408 When not empty, specifies a comma-separated list of fonts to be used
3409 for double-width characters. The first font that can be loaded is
3410 used.
3411 Note: The size of these fonts must be exactly twice as wide as the one
3412 specified with 'guifont' and the same height.
3413
3414 All GUI versions but GTK+ 2:
3415
3416 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3417 'guifontset' is empty or invalid.
3418 When 'guifont' is set and a valid font is found in it and
3419 'guifontwide' is empty Vim will attempt to find a matching
3420 double-width font and set 'guifontwide' to it.
3421
3422 GTK+ 2 GUI only: *guifontwide_gtk2*
3423
3424 If set and valid, 'guifontwide' is always used for double width
3425 characters, even if 'encoding' is not set to "utf-8".
3426 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003427 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428 font for characters not available in 'guifont'. Thus you do not need
3429 to set 'guifontwide' at all unless you want to override the choice
3430 made by Pango/Xft.
3431
3432 *'guiheadroom'* *'ghr'*
3433'guiheadroom' 'ghr' number (default 50)
3434 global
3435 {not in Vi} {only for GTK and X11 GUI}
3436 The number of pixels subtracted from the screen height when fitting
3437 the GUI window on the screen. Set this before the GUI is started,
3438 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003439 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 lines will be left for window decorations and other items on the
3441 screen. Set it to a negative value to allow windows taller than the
3442 screen.
3443
3444 *'guioptions'* *'go'*
3445'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003446 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447 global
3448 {not in Vi}
3449 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003450 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 sequence of letters which describes what components and options of the
3452 GUI should be used.
3453 To avoid problems with flags that are added in the future, use the
3454 "+=" and "-=" feature of ":set" |add-option-flags|.
3455
3456 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003457 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458 'a' Autoselect: If present, then whenever VISUAL mode is started,
3459 or the Visual area extended, Vim tries to become the owner of
3460 the windowing system's global selection. This means that the
3461 Visually highlighted text is available for pasting into other
3462 applications as well as into Vim itself. When the Visual mode
3463 ends, possibly due to an operation on the text, or when an
3464 application wants to paste the selection, the highlighted text
3465 is automatically yanked into the "* selection register.
3466 Thus the selection is still available for pasting into other
3467 applications after the VISUAL mode has ended.
3468 If not present, then Vim won't become the owner of the
3469 windowing system's global selection unless explicitly told to
3470 by a yank or delete operation for the "* register.
3471 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003472 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003473 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474 applies to the modeless selection.
3475
3476 'guioptions' autoselect Visual autoselect modeless ~
3477 "" - -
3478 "a" yes yes
3479 "A" - yes
3480 "aA" yes yes
3481
Bram Moolenaar02467872007-05-06 13:22:01 +00003482 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 'c' Use console dialogs instead of popup dialogs for simple
3484 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003485 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003486 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003487 'guitablabel' can be used to change the text in the labels.
3488 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003489 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003490 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003491 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 'f' Foreground: Don't use fork() to detach the GUI from the shell
3493 where it was started. Use this for programs that wait for the
3494 editor to finish (e.g., an e-mail program). Alternatively you
3495 can use "gvim -f" or ":gui -f" to start the GUI in the
3496 foreground. |gui-fork|
3497 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003498 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003499 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3501 corner of the window. It's black&white on non-GTK, because of
3502 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003503 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003505 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003506 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003508 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 file is sourced the system menu has already been loaded; the
3510 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003511 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512 'g' Grey menu items: Make menu items that are not active grey. If
3513 'g' is not included inactive menu items are not shown at all.
3514 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003515 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 't' Include tearoff menu items. Currently only works for Win32,
3517 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003518 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003519 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003520 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003521 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003523 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524 'R' Right-hand scrollbar is present when there is a vertically
3525 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003526 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003528 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 'L' Left-hand scrollbar is present when there is a vertically
3530 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003531 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3533 the longest visible line, or on the cursor line if the 'h'
3534 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003535 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 'h' Limit horizontal scrollbar size to the length of the cursor
3537 line. Reduces computations. |gui-horiz-scroll|
3538
3539 And yes, you may even have scrollbars on the left AND the right if
3540 you really want to :-). See |gui-scrollbars| for more information.
3541
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003542 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 'v' Use a vertical button layout for dialogs. When not included,
3544 a horizontal layout is preferred, but when it doesn't fit a
3545 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003546 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 'p' Use Pointer callbacks for X11 GUI. This is required for some
3548 window managers. If the cursor is not blinking or hollow at
3549 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003550 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003552 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003553 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554
Bram Moolenaar02467872007-05-06 13:22:01 +00003555
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 *'guipty'* *'noguipty'*
3557'guipty' boolean (default on)
3558 global
3559 {not in Vi}
3560 {only available when compiled with GUI enabled}
3561 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3562 I/O to/from shell commands. See |gui-pty|.
3563
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003564 *'guitablabel'* *'gtl'*
3565'guitablabel' 'gtl' string (default empty)
3566 global
3567 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003568 {only available when compiled with GUI enabled and
3569 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003570 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003571 pages line. When empty and when the result is empty Vim will use a
3572 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003573
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003574 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003575 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003576
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003577 Only used when the GUI tab pages line is displayed. 'e' must be
3578 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3579 used.
3580
Bram Moolenaar57657d82006-04-21 22:12:41 +00003581 *'guitabtooltip'* *'gtt'*
3582'guitabtooltip' 'gtt' string (default empty)
3583 global
3584 {not in Vi}
3585 {only available when compiled with GUI enabled and
3586 with the +windows feature}
3587 When nonempty describes the text to use in a tooltip for the GUI tab
3588 pages line. When empty Vim will use a default tooltip.
3589 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003590 You can include a line break. Simplest method is to use |:let|: >
3591 :let &guitabtooltip = "line one\nline two"
3592<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003593
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 *'helpfile'* *'hf'*
3595'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3596 (others) "$VIMRUNTIME/doc/help.txt")
3597 global
3598 {not in Vi}
3599 Name of the main help file. All distributed help files should be
3600 placed together in one directory. Additionally, all "doc" directories
3601 in 'runtimepath' will be used.
3602 Environment variables are expanded |:set_env|. For example:
3603 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003604 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 spaces and backslashes.
3606 This option cannot be set from a |modeline| or in the |sandbox|, for
3607 security reasons.
3608
3609 *'helpheight'* *'hh'*
3610'helpheight' 'hh' number (default 20)
3611 global
3612 {not in Vi}
3613 {not available when compiled without the +windows
3614 feature}
3615 Minimal initial height of the help window when it is opened with the
3616 ":help" command. The initial height of the help window is half of the
3617 current window, or (when the 'ea' option is on) the same as other
3618 windows. When the height is less than 'helpheight', the height is
3619 set to 'helpheight'. Set to zero to disable.
3620
3621 *'helplang'* *'hlg'*
3622'helplang' 'hlg' string (default: messages language or empty)
3623 global
3624 {only available when compiled with the |+multi_lang|
3625 feature}
3626 {not in Vi}
3627 Comma separated list of languages. Vim will use the first language
3628 for which the desired help can be found. The English help will always
3629 be used as a last resort. You can add "en" to prefer English over
3630 another language, but that will only find tags that exist in that
3631 language and not in the English help.
3632 Example: >
3633 :set helplang=de,it
3634< This will first search German, then Italian and finally English help
3635 files.
3636 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3637 try to find the tag in the current language before using this option.
3638 See |help-translated|.
3639
3640 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3641'hidden' 'hid' boolean (default off)
3642 global
3643 {not in Vi}
3644 When off a buffer is unloaded when it is |abandon|ed. When on a
3645 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3646 displayed in another window, it does not become hidden, of course.
3647 The commands that move through the buffer list sometimes make a buffer
3648 hidden although the 'hidden' option is off: When the buffer is
3649 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003650 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003651 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 This option is set for one command with ":hide {command}" |:hide|.
3653 WARNING: It's easy to forget that you have changes in hidden buffers.
3654 Think twice when using ":q!" or ":qa!".
3655
3656 *'highlight'* *'hl'*
3657'highlight' 'hl' string (default (as a single string):
3658 "8:SpecialKey,@:NonText,d:Directory,
3659 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3660 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003661 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3663 f:Folded,F:FoldColumn,A:DiffAdd,
3664 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003665 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003666 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003667 +:Pmenu,=:PmenuSel,
3668 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 global
3670 {not in Vi}
3671 This option can be used to set highlighting mode for various
3672 occasions. It is a comma separated list of character pairs. The
3673 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003674 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3676 |hl-NonText| @ '~' and '@' at the end of the window and
3677 characters from 'showbreak'
3678 |hl-Directory| d directories in CTRL-D listing and other special
3679 things in listings
3680 |hl-ErrorMsg| e error messages
3681 h (obsolete, ignored)
3682 |hl-IncSearch| i 'incsearch' highlighting
3683 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3684 |hl-MoreMsg| m |more-prompt|
3685 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003686 |hl-LineNr| n line number for ":number" and ":#" commands, and
3687 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 |hl-Question| r |hit-enter| prompt and yes/no questions
3689 |hl-StatusLine| s status line of current window |status-line|
3690 |hl-StatusLineNC| S status lines of not-current windows
3691 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3692 |hl-VertSplit| c column used to separate vertically split windows
3693 |hl-Visual| v Visual mode
3694 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3695 Selection" Only X11 Gui's |gui-x11| and
3696 |xterm-clipboard|.
3697 |hl-WarningMsg| w warning messages
3698 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3699 |hl-Folded| f line used for closed folds
3700 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003701 |hl-DiffAdd| A added line in diff mode
3702 |hl-DiffChange| C changed line in diff mode
3703 |hl-DiffDelete| D deleted line in diff mode
3704 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003706 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003707 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003708 |hl-SpellRare| R rare word |spell|
3709 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003710 |hl-Conceal| - the placeholders used for concealed characters
3711 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003712 |hl-Pmenu| + popup menu normal line
3713 |hl-PmenuSel| = popup menu normal line
3714 |hl-PmenuSbar| x popup menu scrollbar
3715 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716
3717 The display modes are:
3718 r reverse (termcap entry "mr" and "me")
3719 i italic (termcap entry "ZH" and "ZR")
3720 b bold (termcap entry "md" and "me")
3721 s standout (termcap entry "so" and "se")
3722 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003723 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 n no highlighting
3725 - no highlighting
3726 : use a highlight group
3727 The default is used for occasions that are not included.
3728 If you want to change what the display modes do, see |dos-colors|
3729 for an example.
3730 When using the ':' display mode, this must be followed by the name of
3731 a highlight group. A highlight group can be used to define any type
3732 of highlighting, including using color. See |:highlight| on how to
3733 define one. The default uses a different group for each occasion.
3734 See |highlight-default| for the default highlight groups.
3735
3736 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3737'hlsearch' 'hls' boolean (default off)
3738 global
3739 {not in Vi}
3740 {not available when compiled without the
3741 |+extra_search| feature}
3742 When there is a previous search pattern, highlight all its matches.
3743 The type of highlighting used can be set with the 'l' occasion in the
3744 'highlight' option. This uses the "Search" highlight group by
3745 default. Note that only the matching text is highlighted, any offsets
3746 are not applied.
3747 See also: 'incsearch' and |:match|.
3748 When you get bored looking at the highlighted matches, you can turn it
3749 off with |:nohlsearch|. As soon as you use a search command, the
3750 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003751 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 When the search pattern can match an end-of-line, Vim will try to
3753 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003754 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003756 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 NOTE: This option is reset when 'compatible' is set.
3758
3759 *'history'* *'hi'*
3760'history' 'hi' number (Vim default: 20, Vi default: 0)
3761 global
3762 {not in Vi}
3763 A history of ":" commands, and a history of previous search patterns
3764 are remembered. This option decides how many entries may be stored in
3765 each of these histories (see |cmdline-editing|).
3766 NOTE: This option is set to the Vi default value when 'compatible' is
3767 set and to the Vim default value when 'compatible' is reset.
3768
3769 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3770'hkmap' 'hk' boolean (default off)
3771 global
3772 {not in Vi}
3773 {only available when compiled with the |+rightleft|
3774 feature}
3775 When on, the keyboard is mapped for the Hebrew character set.
3776 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3777 toggle this option. See |rileft.txt|.
3778 NOTE: This option is reset when 'compatible' is set.
3779
3780 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3781'hkmapp' 'hkp' boolean (default off)
3782 global
3783 {not in Vi}
3784 {only available when compiled with the |+rightleft|
3785 feature}
3786 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3787 This is useful if you have a non-Hebrew keyboard.
3788 See |rileft.txt|.
3789 NOTE: This option is reset when 'compatible' is set.
3790
3791 *'icon'* *'noicon'*
3792'icon' boolean (default off, on when title can be restored)
3793 global
3794 {not in Vi}
3795 {not available when compiled without the |+title|
3796 feature}
3797 When on, the icon text of the window will be set to the value of
3798 'iconstring' (if it is not empty), or to the name of the file
3799 currently being edited. Only the last part of the name is used.
3800 Overridden by the 'iconstring' option.
3801 Only works if the terminal supports setting window icons (currently
3802 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3803 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3804 builtin termcap).
3805 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003806 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 X11.
3808
3809 *'iconstring'*
3810'iconstring' string (default "")
3811 global
3812 {not in Vi}
3813 {not available when compiled without the |+title|
3814 feature}
3815 When this option is not empty, it will be used for the icon text of
3816 the window. This happens only when the 'icon' option is on.
3817 Only works if the terminal supports setting window icon text
3818 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3819 Does not work for MS Windows.
3820 When Vim was compiled with HAVE_X11 defined, the original icon will be
3821 restored if possible |X11|.
3822 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003823 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 'titlestring' for example settings.
3825 {not available when compiled without the |+statusline| feature}
3826
3827 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3828'ignorecase' 'ic' boolean (default off)
3829 global
3830 Ignore case in search patterns. Also used when searching in the tags
3831 file.
3832 Also see 'smartcase'.
3833 Can be overruled by using "\c" or "\C" in the pattern, see
3834 |/ignorecase|.
3835
3836 *'imactivatekey'* *'imak'*
3837'imactivatekey' 'imak' string (default "")
3838 global
3839 {not in Vi}
3840 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003841 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842 Specifies the key that your Input Method in X-Windows uses for
3843 activation. When this is specified correctly, vim can fully control
3844 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3845 You can't use this option to change the activation key, the option
3846 tells Vim what the key is.
3847 Format:
3848 [MODIFIER_FLAG-]KEY_STRING
3849
3850 These characters can be used for MODIFIER_FLAG (case is ignored):
3851 S Shift key
3852 L Lock key
3853 C Control key
3854 1 Mod1 key
3855 2 Mod2 key
3856 3 Mod3 key
3857 4 Mod4 key
3858 5 Mod5 key
3859 Combinations are allowed, for example "S-C-space" or "SC-space" are
3860 both shift+ctrl+space.
3861 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3862
3863 Example: >
3864 :set imactivatekey=S-space
3865< "S-space" means shift+space. This is the activation key for kinput2 +
3866 canna (Japanese), and ami (Korean).
3867
3868 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3869'imcmdline' 'imc' boolean (default off)
3870 global
3871 {not in Vi}
3872 {only available when compiled with the |+xim|
3873 |+multi_byte_ime| or |global-ime| feature}
3874 When set the Input Method is always on when starting to edit a command
3875 line, unless entering a search pattern (see 'imsearch' for that).
3876 Setting this option is useful when your input method allows entering
3877 English characters directly, e.g., when it's used to type accented
3878 characters with dead keys.
3879
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003880 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3882 global
3883 {not in Vi}
3884 {only available when compiled with the |+xim|
3885 |+multi_byte_ime| or |global-ime| feature}
3886 When set the Input Method is never used. This is useful to disable
3887 the IM when it doesn't work properly.
3888 Currently this option is on by default for SGI/IRIX machines. This
3889 may change in later releases.
3890
3891 *'iminsert'* *'imi'*
3892'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3893 local to buffer
3894 {not in Vi}
3895 Specifies whether :lmap or an Input Method (IM) is to be used in
3896 Insert mode. Valid values:
3897 0 :lmap is off and IM is off
3898 1 :lmap is ON and IM is off
3899 2 :lmap is off and IM is ON
3900 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3901 or |global-ime|.
3902 To always reset the option to zero when leaving Insert mode with <Esc>
3903 this can be used: >
3904 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3905< This makes :lmap and IM turn off automatically when leaving Insert
3906 mode.
3907 Note that this option changes when using CTRL-^ in Insert mode
3908 |i_CTRL-^|.
3909 The value is set to 1 when setting 'keymap' to a valid keymap name.
3910 It is also used for the argument of commands like "r" and "f".
3911 The value 0 may not work correctly with Athena and Motif with some XIM
3912 methods. Use 'imdisable' to disable XIM then.
3913
3914 *'imsearch'* *'ims'*
3915'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3916 local to buffer
3917 {not in Vi}
3918 Specifies whether :lmap or an Input Method (IM) is to be used when
3919 entering a search pattern. Valid values:
3920 -1 the value of 'iminsert' is used, makes it look like
3921 'iminsert' is also used when typing a search pattern
3922 0 :lmap is off and IM is off
3923 1 :lmap is ON and IM is off
3924 2 :lmap is off and IM is ON
3925 Note that this option changes when using CTRL-^ in Command-line mode
3926 |c_CTRL-^|.
3927 The value is set to 1 when it is not -1 and setting the 'keymap'
3928 option to a valid keymap name.
3929 The value 0 may not work correctly with Athena and Motif with some XIM
3930 methods. Use 'imdisable' to disable XIM then.
3931
3932 *'include'* *'inc'*
3933'include' 'inc' string (default "^\s*#\s*include")
3934 global or local to buffer |global-local|
3935 {not in Vi}
3936 {not available when compiled without the
3937 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003938 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 pattern, just like for the "/" command (See |pattern|). The default
3940 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003941 "]I", "[d", etc.
3942 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003943 comes after the matched pattern. But if "\zs" appears in the pattern
3944 then the text matched from "\zs" to the end, or until "\ze" if it
3945 appears, is used as the file name. Use this to include characters
3946 that are not in 'isfname', such as a space. You can then use
3947 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003948 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949
3950 *'includeexpr'* *'inex'*
3951'includeexpr' 'inex' string (default "")
3952 local to buffer
3953 {not in Vi}
3954 {not available when compiled without the
3955 |+find_in_path| or |+eval| feature}
3956 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003957 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 :set includeexpr=substitute(v:fname,'\\.','/','g')
3959< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003960
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003962 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003963 Also used for |<cfile>|.
3964
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003965 The expression may be evaluated in the |sandbox|, see
3966 |sandbox-option|.
3967
3968 It is not allowed to change text or jump to another window while
3969 evaluating 'includeexpr' |textlock|.
3970
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3972'incsearch' 'is' boolean (default off)
3973 global
3974 {not in Vi}
3975 {not available when compiled without the
3976 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003977 While typing a search command, show where the pattern, as it was typed
3978 so far, matches. The matched string is highlighted. If the pattern
3979 is invalid or not found, nothing is shown. The screen will be updated
3980 often, this is only useful on fast terminals.
3981 Note that the match will be shown, but the cursor will return to its
3982 original position when no match is found and when pressing <Esc>. You
3983 still need to finish the search command with <Enter> to move the
3984 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003985 When compiled with the |+reltime| feature Vim only searches for about
3986 half a second. With a complicated pattern and/or a lot of text the
3987 match may not be found. This is to avoid that Vim hangs while you
3988 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003989 The highlighting can be set with the 'i' flag in 'highlight'.
3990 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003991 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02003992 to the command line. If 'ignorecase' and 'smartcase' are set and the
3993 command line has no uppercase characters, the added character is
3994 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003995 CTRL-R CTRL-W can be used to add the word at the end of the current
3996 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 NOTE: This option is reset when 'compatible' is set.
3998
3999 *'indentexpr'* *'inde'*
4000'indentexpr' 'inde' string (default "")
4001 local to buffer
4002 {not in Vi}
4003 {not available when compiled without the |+cindent|
4004 or |+eval| features}
4005 Expression which is evaluated to obtain the proper indent for a line.
4006 It is used when a new line is created, for the |=| operator and
4007 in Insert mode as specified with the 'indentkeys' option.
4008 When this option is not empty, it overrules the 'cindent' and
4009 'smartindent' indenting.
4010 When 'paste' is set this option is not used for indenting.
4011 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004012 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013 when the expression is evaluated (but it may be moved around).
4014 The expression must return the number of spaces worth of indent. It
4015 can return "-1" to keep the current indent (this means 'autoindent' is
4016 used for the indent).
4017 Functions useful for computing the indent are |indent()|, |cindent()|
4018 and |lispindent()|.
4019 The evaluation of the expression must not have side effects! It must
4020 not change the text, jump to another window, etc. Afterwards the
4021 cursor position is always restored, thus the cursor may be moved.
4022 Normally this option would be set to call a function: >
4023 :set indentexpr=GetMyIndent()
4024< Error messages will be suppressed, unless the 'debug' option contains
4025 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004026 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 NOTE: This option is made empty when 'compatible' is set.
4028
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004029 The expression may be evaluated in the |sandbox|, see
4030 |sandbox-option|.
4031
4032 It is not allowed to change text or jump to another window while
4033 evaluating 'indentexpr' |textlock|.
4034
4035
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 *'indentkeys'* *'indk'*
4037'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4038 local to buffer
4039 {not in Vi}
4040 {not available when compiled without the |+cindent|
4041 feature}
4042 A list of keys that, when typed in Insert mode, cause reindenting of
4043 the current line. Only happens if 'indentexpr' isn't empty.
4044 The format is identical to 'cinkeys', see |indentkeys-format|.
4045 See |C-indenting| and |indent-expression|.
4046
4047 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4048'infercase' 'inf' boolean (default off)
4049 local to buffer
4050 {not in Vi}
4051 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004052 'ignorecase' is also on, the case of the match is adjusted depending
4053 on the typed text. If the typed text contains a lowercase letter
4054 where the match has an upper case letter, the completed part is made
4055 lowercase. If the typed text has no lowercase letters and the match
4056 has a lowercase letter where the typed text has an uppercase letter,
4057 and there is a letter before it, the completed part is made uppercase.
4058 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059
4060 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4061'insertmode' 'im' boolean (default off)
4062 global
4063 {not in Vi}
4064 Makes Vim work in a way that Insert mode is the default mode. Useful
4065 if you want to use Vim as a modeless editor. Used for |evim|.
4066 These Insert mode commands will be useful:
4067 - Use the cursor keys to move around.
4068 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4069 this is a mapping, it is executed as if 'insertmode' was off.
4070 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004072 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4073 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074
4075 These items change when 'insertmode' is set:
4076 - when starting to edit of a file, Vim goes to Insert mode.
4077 - <Esc> in Insert mode is a no-op and beeps.
4078 - <Esc> in Normal mode makes Vim go to Insert mode.
4079 - CTRL-L in Insert mode is a command, it is not inserted.
4080 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4081 However, when <Esc> is used inside a mapping, it behaves like
4082 'insertmode' was not set. This was done to be able to use the same
4083 mappings with 'insertmode' set or not set.
4084 When executing commands with |:normal| 'insertmode' is not used.
4085
4086 NOTE: This option is reset when 'compatible' is set.
4087
4088 *'isfname'* *'isf'*
4089'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4090 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4091 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4092 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4093 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4094 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4095 global
4096 {not in Vi}
4097 The characters specified by this option are included in file names and
4098 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004099 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100 Multi-byte characters 256 and above are always included, only the
4101 characters up to 255 are specified with this option.
4102 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004103 Think twice before adding white space to this option. Although a
4104 space may appear inside a file name, the effect will be that Vim
4105 doesn't know where a file name starts or ends when doing completion.
4106 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107
4108 Note that on systems using a backslash as path separator, Vim tries to
4109 do its best to make it work as you would expect. That is a bit
4110 tricky, since Vi originally used the backslash to escape special
4111 characters. Vim will not remove a backslash in front of a normal file
4112 name character on these systems, but it will on Unix and alikes. The
4113 '&' and '^' are not included by default, because these are special for
4114 cmd.exe.
4115
4116 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004117 Each part can be a single character number or a range. A range is two
4118 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 decimal number between 0 and 255 or the ASCII character itself (does
4120 not work for digits). Example:
4121 "_,-,128-140,#-43" (include '_' and '-' and the range
4122 128 to 140 and '#' to 43)
4123 If a part starts with '^', the following character number or range
4124 will be excluded from the option. The option is interpreted from left
4125 to right. Put the excluded character after the range where it is
4126 included. To include '^' itself use it as the last character of the
4127 option or the end of a range. Example:
4128 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4129 If the character is '@', all characters where isalpha() returns TRUE
4130 are included. Normally these are the characters a to z and A to Z,
4131 plus accented characters. To include '@' itself use "@-@". Examples:
4132 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004133 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134 "a-z,A-Z,@-@" All letters plus the '@' character.
4135 A comma can be included by using it where a character number is
4136 expected. Example:
4137 "48-57,,,_" Digits, comma and underscore.
4138 A comma can be excluded by prepending a '^'. Example:
4139 " -~,^,,9" All characters from space to '~', excluding
4140 comma, plus <Tab>.
4141 See |option-backslash| about including spaces and backslashes.
4142
4143 *'isident'* *'isi'*
4144'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4145 "@,48-57,_,128-167,224-235"
4146 otherwise: "@,48-57,_,192-255")
4147 global
4148 {not in Vi}
4149 The characters given by this option are included in identifiers.
4150 Identifiers are used in recognizing environment variables and after a
4151 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004152 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 option.
4154 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004155 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004156 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4157
4158 *'iskeyword'* *'isk'*
4159'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4160 "@,48-57,_,128-167,224-235"
4161 otherwise: "@,48-57,_,192-255"
4162 Vi default: "@,48-57,_")
4163 local to buffer
4164 {not in Vi}
4165 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004166 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 'isfname' for a description of the format of this option. For C
4168 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4169 For a help file it is set to all non-blank printable characters except
4170 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4171 command).
4172 When the 'lisp' option is on the '-' character is always included.
4173 NOTE: This option is set to the Vi default value when 'compatible' is
4174 set and to the Vim default value when 'compatible' is reset.
4175
4176 *'isprint'* *'isp'*
4177'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4178 "@,~-255"; otherwise: "@,161-255")
4179 global
4180 {not in Vi}
4181 The characters given by this option are displayed directly on the
4182 screen. It is also used for "\p" in a |pattern|. The characters from
4183 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4184 even when they are not included in 'isprint' or excluded. See
4185 'isfname' for a description of the format of this option.
4186
4187 Non-printable characters are displayed with two characters:
4188 0 - 31 "^@" - "^_"
4189 32 - 126 always single characters
4190 127 "^?"
4191 128 - 159 "~@" - "~_"
4192 160 - 254 "| " - "|~"
4193 255 "~?"
4194 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4195 displayed as <xx>, with the hexadecimal value of the byte.
4196 When 'display' contains "uhex" all unprintable characters are
4197 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004198 The SpecialKey highlighting will be used for unprintable characters.
4199 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200
4201 Multi-byte characters 256 and above are always included, only the
4202 characters up to 255 are specified with this option. When a character
4203 is printable but it is not available in the current font, a
4204 replacement character will be shown.
4205 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4206 There is no option to specify these characters.
4207
4208 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4209'joinspaces' 'js' boolean (default on)
4210 global
4211 {not in Vi}
4212 Insert two spaces after a '.', '?' and '!' with a join command.
4213 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4214 Otherwise only one space is inserted.
4215 NOTE: This option is set when 'compatible' is set.
4216
4217 *'key'*
4218'key' string (default "")
4219 local to buffer
4220 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004221 {only available when compiled with the |+cryptv|
4222 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004224 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 Careful: Do not set the key value by hand, someone might see the typed
4226 key. Use the |:X| command. But you can make 'key' empty: >
4227 :set key=
4228< It is not possible to get the value of this option with ":set key" or
4229 "echo &key". This is to avoid showing it to someone who shouldn't
4230 know. It also means you cannot see it yourself once you have set it,
4231 be careful not to make a typing error!
4232
4233 *'keymap'* *'kmp'* *E544*
4234'keymap' 'kmp' string (default "")
4235 local to buffer
4236 {not in Vi}
4237 {only available when compiled with the |+keymap|
4238 feature}
4239 Name of a keyboard mapping. See |mbyte-keymap|.
4240 Setting this option to a valid keymap name has the side effect of
4241 setting 'iminsert' to one, so that the keymap becomes effective.
4242 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004243 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244
4245 *'keymodel'* *'km'*
4246'keymodel' 'km' string (default "")
4247 global
4248 {not in Vi}
4249 List of comma separated words, which enable special things that keys
4250 can do. These values can be used:
4251 startsel Using a shifted special key starts selection (either
4252 Select mode or Visual mode, depending on "key" being
4253 present in 'selectmode').
4254 stopsel Using a not-shifted special key stops selection.
4255 Special keys in this context are the cursor keys, <End>, <Home>,
4256 <PageUp> and <PageDown>.
4257 The 'keymodel' option is set by the |:behave| command.
4258
4259 *'keywordprg'* *'kp'*
4260'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4261 OS/2: "view /", VMS: "help")
4262 global or local to buffer |global-local|
4263 {not in Vi}
4264 Program to use for the |K| command. Environment variables are
4265 expanded |:set_env|. ":help" may be used to access the Vim internal
4266 help. (Note that previously setting the global option to the empty
4267 value did this, which is now deprecated.)
4268 When "man" is used, Vim will automatically translate a count for the
4269 "K" command to a section number. Also for "man -s", in which case the
4270 "-s" is removed when there is no count.
4271 See |option-backslash| about including spaces and backslashes.
4272 Example: >
4273 :set keywordprg=man\ -s
4274< This option cannot be set from a |modeline| or in the |sandbox|, for
4275 security reasons.
4276
4277 *'langmap'* *'lmap'* *E357* *E358*
4278'langmap' 'lmap' string (default "")
4279 global
4280 {not in Vi}
4281 {only available when compiled with the |+langmap|
4282 feature}
4283 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004284 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 inserted directly. When in command mode the 'langmap' option takes
4286 care of translating these special characters to the original meaning
4287 of the key. This means you don't have to change the keyboard mode to
4288 be able to execute Normal mode commands.
4289 This is the opposite of the 'keymap' option, where characters are
4290 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004292 Example (for Greek, in UTF-8): *greek* >
4293 :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 +00004294< Example (exchanges meaning of z and y for commands): >
4295 :set langmap=zy,yz,ZY,YZ
4296<
4297 The 'langmap' option is a list of parts, separated with commas. Each
4298 part can be in one of two forms:
4299 1. A list of pairs. Each pair is a "from" character immediately
4300 followed by the "to" character. Examples: "aA", "aAbBcC".
4301 2. A list of "from" characters, a semi-colon and a list of "to"
4302 characters. Example: "abc;ABC"
4303 Example: "aA,fgh;FGH,cCdDeE"
4304 Special characters need to be preceded with a backslash. These are
4305 ";", ',' and backslash itself.
4306
4307 This will allow you to activate vim actions without having to switch
4308 back and forth between the languages. Your language characters will
4309 be understood as normal vim English characters (according to the
4310 langmap mappings) in the following cases:
4311 o Normal/Visual mode (commands, buffer/register names, user mappings)
4312 o Insert/Replace Mode: Register names after CTRL-R
4313 o Insert/Replace Mode: Mappings
4314 Characters entered in Command-line mode will NOT be affected by
4315 this option. Note that this option can be changed at any time
4316 allowing to switch between mappings for different languages/encodings.
4317 Use a mapping to avoid having to type it each time!
4318
4319 *'langmenu'* *'lm'*
4320'langmenu' 'lm' string (default "")
4321 global
4322 {not in Vi}
4323 {only available when compiled with the |+menu| and
4324 |+multi_lang| features}
4325 Language to use for menu translation. Tells which file is loaded
4326 from the "lang" directory in 'runtimepath': >
4327 "lang/menu_" . &langmenu . ".vim"
4328< (without the spaces). For example, to always use the Dutch menus, no
4329 matter what $LANG is set to: >
4330 :set langmenu=nl_NL.ISO_8859-1
4331< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004332 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 If your $LANG is set to a non-English language but you do want to use
4334 the English menus: >
4335 :set langmenu=none
4336< This option must be set before loading menus, switching on filetype
4337 detection or syntax highlighting. Once the menus are defined setting
4338 this option has no effect. But you could do this: >
4339 :source $VIMRUNTIME/delmenu.vim
4340 :set langmenu=de_DE.ISO_8859-1
4341 :source $VIMRUNTIME/menu.vim
4342< Warning: This deletes all menus that you defined yourself!
4343
4344 *'laststatus'* *'ls'*
4345'laststatus' 'ls' number (default 1)
4346 global
4347 {not in Vi}
4348 The value of this option influences when the last window will have a
4349 status line:
4350 0: never
4351 1: only if there are at least two windows
4352 2: always
4353 The screen looks nicer with a status line if you have several
4354 windows, but it takes another screen line. |status-line|
4355
4356 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4357'lazyredraw' 'lz' boolean (default off)
4358 global
4359 {not in Vi}
4360 When this option is set, the screen will not be redrawn while
4361 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004362 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 update use |:redraw|.
4364
4365 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4366'linebreak' 'lbr' boolean (default off)
4367 local to window
4368 {not in Vi}
4369 {not available when compiled without the |+linebreak|
4370 feature}
4371 If on Vim will wrap long lines at a character in 'breakat' rather
4372 than at the last character that fits on the screen. Unlike
4373 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4374 it only affects the way the file is displayed, not its contents. The
4375 value of 'showbreak' is used to put in front of wrapped lines.
4376 This option is not used when the 'wrap' option is off or 'list' is on.
4377 Note that <Tab> characters after an <EOL> are mostly not displayed
4378 with the right amount of white space.
4379
4380 *'lines'* *E593*
4381'lines' number (default 24 or terminal height)
4382 global
4383 Number of lines of the Vim window.
4384 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004385 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 When Vim is running in the GUI or in a resizable window, setting this
4387 option will cause the window size to be changed. When you only want
4388 to use the size for the GUI, put the command in your |gvimrc| file.
4389 Vim limits the number of lines to what fits on the screen. You can
4390 use this command to get the tallest window possible: >
4391 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004392< Minimum value is 2, maximum value is 1000.
4393 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 When you set this option and Vim is unable to change the physical
4395 number of lines of the display, the display may be messed up.
4396
4397 *'linespace'* *'lsp'*
4398'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4399 global
4400 {not in Vi}
4401 {only in the GUI}
4402 Number of pixel lines inserted between characters. Useful if the font
4403 uses the full character cell height, making lines touch each other.
4404 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004405 With some fonts there can be too much room between lines (to have
4406 space for ascents and descents). Then it makes sense to set
4407 'linespace' to a negative value. This may cause display problems
4408 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409
4410 *'lisp'* *'nolisp'*
4411'lisp' boolean (default off)
4412 local to buffer
4413 {not available when compiled without the |+lispindent|
4414 feature}
4415 Lisp mode: When <Enter> is typed in insert mode set the indent for
4416 the next line to Lisp standards (well, sort of). Also happens with
4417 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4418 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4419 better. Also see 'lispwords'.
4420 The '-' character is included in keyword characters. Redefines the
4421 "=" operator to use this same indentation algorithm rather than
4422 calling an external program if 'equalprg' is empty.
4423 This option is not used when 'paste' is set.
4424 {Vi: Does it a little bit differently}
4425
4426 *'lispwords'* *'lw'*
4427'lispwords' 'lw' string (default is very long)
4428 global
4429 {not in Vi}
4430 {not available when compiled without the |+lispindent|
4431 feature}
4432 Comma separated list of words that influence the Lisp indenting.
4433 |'lisp'|
4434
4435 *'list'* *'nolist'*
4436'list' boolean (default off)
4437 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004438 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4439 line. Useful to see the difference between tabs and spaces and for
4440 trailing blanks. Further changed by the 'listchars' option.
4441
4442 The cursor is displayed at the start of the space a Tab character
4443 occupies, not at the end as usual in Normal mode. To get this cursor
4444 position while displaying Tabs with spaces, use: >
4445 :set list lcs=tab\ \
4446<
4447 Note that list mode will also affect formatting (set with 'textwidth'
4448 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449 changing the way tabs are displayed.
4450
4451 *'listchars'* *'lcs'*
4452'listchars' 'lcs' string (default "eol:$")
4453 global
4454 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004455 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 settings.
4457 eol:c Character to show at the end of each line. When
4458 omitted, there is no extra character at the end of the
4459 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004460 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004462 fill the space that the tab normally occupies.
4463 "tab:>-" will show a tab that takes four spaces as
4464 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004465 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 trailing spaces are blank.
4467 extends:c Character to show in the last column, when 'wrap' is
4468 off and the line continues beyond the right of the
4469 screen.
4470 precedes:c Character to show in the first column, when 'wrap'
4471 is off and there is text preceding the character
4472 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004473 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004474 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004475 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004476 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004478 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004480 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481
4482 Examples: >
4483 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004484 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 :set lcs=extends:>,precedes:<
4486< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004487 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004488 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489
4490 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4491'loadplugins' 'lpl' boolean (default on)
4492 global
4493 {not in Vi}
4494 When on the plugin scripts are loaded when starting up |load-plugins|.
4495 This option can be reset in your |vimrc| file to disable the loading
4496 of plugins.
4497 Note that using the "-u NONE" and "--noplugin" command line arguments
4498 reset this option. |-u| |--noplugin|
4499
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004500 *'macatsui'* *'nomacatsui'*
4501'macatsui' boolean (default on)
4502 global
4503 {only available in Mac GUI version}
4504 This is a workaround for when drawing doesn't work properly. When set
4505 and compiled with multi-byte support ATSUI text drawing is used. When
4506 not set ATSUI text drawing is not used. Switch this option off when
4507 you experience drawing problems. In a future version the problems may
4508 be solved and this option becomes obsolete. Therefore use this method
4509 to unset it: >
4510 if exists('&macatsui')
4511 set nomacatsui
4512 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004513< Another option to check if you have drawing problems is
4514 'termencoding'.
4515
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 *'magic'* *'nomagic'*
4517'magic' boolean (default on)
4518 global
4519 Changes the special characters that can be used in search patterns.
4520 See |pattern|.
4521 NOTE: To avoid portability problems with using patterns, always keep
4522 this option at the default "on". Only switch it off when working with
4523 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004524 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525
4526 *'makeef'* *'mef'*
4527'makeef' 'mef' string (default: "")
4528 global
4529 {not in Vi}
4530 {not available when compiled without the |+quickfix|
4531 feature}
4532 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4533 and the |:grep| command.
4534 When it is empty, an internally generated temp file will be used.
4535 When "##" is included, it is replaced by a number to make the name
4536 unique. This makes sure that the ":make" command doesn't overwrite an
4537 existing file.
4538 NOT used for the ":cf" command. See 'errorfile' for that.
4539 Environment variables are expanded |:set_env|.
4540 See |option-backslash| about including spaces and backslashes.
4541 This option cannot be set from a |modeline| or in the |sandbox|, for
4542 security reasons.
4543
4544 *'makeprg'* *'mp'*
4545'makeprg' 'mp' string (default "make", VMS: "MMS")
4546 global or local to buffer |global-local|
4547 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004548 Program to use for the ":make" command. See |:make_makeprg|.
4549 This option may contain '%' and '#' characters, which are expanded to
4550 the current and alternate file name. |:_%| |:_#|
4551 Environment variables are expanded |:set_env|. See |option-backslash|
4552 about including spaces and backslashes.
4553 Note that a '|' must be escaped twice: once for ":set" and once for
4554 the interpretation of a command. When you use a filter called
4555 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 :set makeprg=gmake\ \\\|\ myfilter
4557< The placeholder "$*" can be given (even multiple times) to specify
4558 where the arguments will be included, for example: >
4559 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4560< This option cannot be set from a |modeline| or in the |sandbox|, for
4561 security reasons.
4562
Bram Moolenaar1a384422010-07-14 19:53:30 +02004563 *'colorcolumn'* *'cc'*
4564'colorcolumn' 'cc' string (default "")
4565 local to window
4566 {not in Vi}
4567 {not available when compiled without the |+syntax|
4568 feature}
4569 'colorcolumn' is a comma separated list of screen columns that are
4570 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
4571 text. Will make screen redrawing slower.
4572 The screen column can be an absolute number, or a number preceded with
4573 '+' or '-', which is added to or subtracted from 'textwidth'. >
4574
4575 :set cc=+1 " highlight column after 'textwidth'
4576 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
4577 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
4578<
4579 When 'textwidth' is zero then the items with '-' and '+' are not used.
4580 A maximum of 256 columns are highlighted.
4581
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 *'matchpairs'* *'mps'*
4583'matchpairs' 'mps' string (default "(:),{:},[:]")
4584 local to buffer
4585 {not in Vi}
4586 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004587 other. Currently only single byte character pairs are allowed, and
4588 they must be different. The characters must be separated by a colon.
4589 The pairs must be separated by a comma. Example for including '<' and
4590 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 :set mps+=<:>
4592
4593< A more exotic example, to jump between the '=' and ';' in an
4594 assignment, useful for languages like C and Java: >
4595 :au FileType c,cpp,java set mps+==:;
4596
4597< For a more advanced way of using "%", see the matchit.vim plugin in
4598 the $VIMRUNTIME/macros directory. |add-local-help|
4599
4600 *'matchtime'* *'mat'*
4601'matchtime' 'mat' number (default 5)
4602 global
4603 {not in Vi}{in Nvi}
4604 Tenths of a second to show the matching paren, when 'showmatch' is
4605 set. Note that this is not in milliseconds, like other options that
4606 set a time. This is to be compatible with Nvi.
4607
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004608 *'maxcombine'* *'mco'*
4609'maxcombine' 'mco' number (default 2)
4610 global
4611 {not in Vi}
4612 {only available when compiled with the |+multi_byte|
4613 feature}
4614 The maximum number of combining characters supported for displaying.
4615 Only used when 'encoding' is "utf-8".
4616 The default is OK for most languages. Hebrew may require 4.
4617 Maximum value is 6.
4618 Even when this option is set to 2 you can still edit text with more
4619 combining characters, you just can't see them. Use |g8| or |ga|.
4620 See |mbyte-combining|.
4621
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 *'maxfuncdepth'* *'mfd'*
4623'maxfuncdepth' 'mfd' number (default 100)
4624 global
4625 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004626 {not available when compiled without the +eval
4627 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 Maximum depth of function calls for user functions. This normally
4629 catches endless recursion. When using a recursive function with
4630 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4631 more memory, there is the danger of failing when memory is exhausted.
4632 See also |:function|.
4633
4634 *'maxmapdepth'* *'mmd'* *E223*
4635'maxmapdepth' 'mmd' number (default 1000)
4636 global
4637 {not in Vi}
4638 Maximum number of times a mapping is done without resulting in a
4639 character to be used. This normally catches endless mappings, like
4640 ":map x y" with ":map y x". It still does not catch ":map g wg",
4641 because the 'w' is used before the next mapping is done. See also
4642 |key-mapping|.
4643
4644 *'maxmem'* *'mm'*
4645'maxmem' 'mm' number (default between 256 to 5120 (system
4646 dependent) or half the amount of memory
4647 available)
4648 global
4649 {not in Vi}
4650 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4651 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004652 other memory to be freed. The maximum usable value is about 2000000.
4653 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004655 *'maxmempattern'* *'mmp'*
4656'maxmempattern' 'mmp' number (default 1000)
4657 global
4658 {not in Vi}
4659 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004660 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004661 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004662 When Vim runs into the limit it gives an error message and mostly
4663 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004664 Running into the limit often means that the pattern is very
4665 inefficient or too complex. This may already happen with the pattern
4666 "\(.\)*" on a very long line. ".*" works much better.
4667 Vim may run out of memory before hitting the 'maxmempattern' limit.
4668
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669 *'maxmemtot'* *'mmt'*
4670'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4671 dependent) or half the amount of memory
4672 available)
4673 global
4674 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004675 Maximum amount of memory in Kbyte to use for all buffers together.
4676 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4677 without a limit. On 64 bit machines higher values might work. But
4678 hey, do you really need more than 2 Gbyte for text editing?
4679 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680
4681 *'menuitems'* *'mis'*
4682'menuitems' 'mis' number (default 25)
4683 global
4684 {not in Vi}
4685 {not available when compiled without the |+menu|
4686 feature}
4687 Maximum number of items to use in a menu. Used for menus that are
4688 generated from a list of items, e.g., the Buffers menu. Changing this
4689 option has no direct effect, the menu must be refreshed first.
4690
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004691 *'mkspellmem'* *'msm'*
4692'mkspellmem' 'msm' string (default "460000,2000,500")
4693 global
4694 {not in Vi}
4695 {not available when compiled without the |+syntax|
4696 feature}
4697 Parameters for |:mkspell|. This tunes when to start compressing the
4698 word tree. Compression can be slow when there are many words, but
4699 it's needed to avoid running out of memory. The amount of memory used
4700 per word depends very much on how similar the words are, that's why
4701 this tuning is complicated.
4702
4703 There are three numbers, separated by commas:
4704 {start},{inc},{added}
4705
4706 For most languages the uncompressed word tree fits in memory. {start}
4707 gives the amount of memory in Kbyte that can be used before any
4708 compression is done. It should be a bit smaller than the amount of
4709 memory that is available to Vim.
4710
4711 When going over the {start} limit the {inc} number specifies the
4712 amount of memory in Kbyte that can be allocated before another
4713 compression is done. A low number means compression is done after
4714 less words are added, which is slow. A high number means more memory
4715 will be allocated.
4716
4717 After doing compression, {added} times 1024 words can be added before
4718 the {inc} limit is ignored and compression is done when any extra
4719 amount of memory is needed. A low number means there is a smaller
4720 chance of hitting the {inc} limit, less memory is used but it's
4721 slower.
4722
4723 The languages for which these numbers are important are Italian and
4724 Hungarian. The default works for when you have about 512 Mbyte. If
4725 you have 1 Gbyte you could use: >
4726 :set mkspellmem=900000,3000,800
4727< If you have less than 512 Mbyte |:mkspell| may fail for some
4728 languages, no matter what you set 'mkspellmem' to.
4729
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004731'modeline' 'ml' boolean (Vim default: on (off for root),
4732 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004733 local to buffer
4734 *'modelines'* *'mls'*
4735'modelines' 'mls' number (default 5)
4736 global
4737 {not in Vi}
4738 If 'modeline' is on 'modelines' gives the number of lines that is
4739 checked for set commands. If 'modeline' is off or 'modelines' is zero
4740 no lines are checked. See |modeline|.
4741 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4742 set and to the Vim default value when 'compatible' is reset.
4743
4744 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4745'modifiable' 'ma' boolean (default on)
4746 local to buffer
4747 {not in Vi} *E21*
4748 When off the buffer contents cannot be changed. The 'fileformat' and
4749 'fileencoding' options also can't be changed.
4750 Can be reset with the |-M| command line argument.
4751
4752 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4753'modified' 'mod' boolean (default off)
4754 local to buffer
4755 {not in Vi}
4756 When on, the buffer is considered to be modified. This option is set
4757 when:
4758 1. A change was made to the text since it was last written. Using the
4759 |undo| command to go back to the original text will reset the
4760 option. But undoing changes that were made before writing the
4761 buffer will set the option again, since the text is different from
4762 when it was written.
4763 2. 'fileformat' or 'fileencoding' is different from its original
4764 value. The original value is set when the buffer is read or
4765 written. A ":set nomodified" command also resets the original
4766 values to the current values and the 'modified' option will be
4767 reset.
4768 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4769 will be ignored.
4770
4771 *'more'* *'nomore'*
4772'more' boolean (Vim default: on, Vi default: off)
4773 global
4774 {not in Vi}
4775 When on, listings pause when the whole screen is filled. You will get
4776 the |more-prompt|. When this option is off there are no pauses, the
4777 listing continues until finished.
4778 NOTE: This option is set to the Vi default value when 'compatible' is
4779 set and to the Vim default value when 'compatible' is reset.
4780
4781 *'mouse'* *E538*
4782'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4783 global
4784 {not in Vi}
4785 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004786 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4787 sysmouse and Linux console with gpm). For using the mouse in the
4788 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 The mouse can be enabled for different modes:
4790 n Normal mode
4791 v Visual mode
4792 i Insert mode
4793 c Command-line mode
4794 h all previous modes when editing a help file
4795 a all previous modes
4796 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004797 Normally you would enable the mouse in all four modes with: >
4798 :set mouse=a
4799< When the mouse is not enabled, the GUI will still use the mouse for
4800 modeless selection. This doesn't move the text cursor.
4801
4802 See |mouse-using|. Also see |'clipboard'|.
4803
4804 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004805 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 the mouse buttons can still be used by keeping the shift key pressed.
4807 Also see the 'clipboard' option.
4808
4809 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4810'mousefocus' 'mousef' boolean (default off)
4811 global
4812 {not in Vi}
4813 {only works in the GUI}
4814 The window that the mouse pointer is on is automatically activated.
4815 When changing the window layout or window focus in another way, the
4816 mouse pointer is moved to the window with keyboard focus. Off is the
4817 default because it makes using the pull down menus a little goofy, as
4818 a pointer transit may activate a window unintentionally.
4819
4820 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4821'mousehide' 'mh' boolean (default on)
4822 global
4823 {not in Vi}
4824 {only works in the GUI}
4825 When on, the mouse pointer is hidden when characters are typed.
4826 The mouse pointer is restored when the mouse is moved.
4827
4828 *'mousemodel'* *'mousem'*
4829'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4830 global
4831 {not in Vi}
4832 Sets the model to use for the mouse. The name mostly specifies what
4833 the right mouse button is used for:
4834 extend Right mouse button extends a selection. This works
4835 like in an xterm.
4836 popup Right mouse button pops up a menu. The shifted left
4837 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004838 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839 popup_setpos Like "popup", but the cursor will be moved to the
4840 position where the mouse was clicked, and thus the
4841 selected operation will act upon the clicked object.
4842 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004843 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 course, that right clicking outside a selection will
4845 end Visual mode.
4846 Overview of what button does what for each model:
4847 mouse extend popup(_setpos) ~
4848 left click place cursor place cursor
4849 left drag start selection start selection
4850 shift-left search word extend selection
4851 right click extend selection popup menu (place cursor)
4852 right drag extend selection -
4853 middle click paste paste
4854
4855 In the "popup" model the right mouse button produces a pop-up menu.
4856 You need to define this first, see |popup-menu|.
4857
4858 Note that you can further refine the meaning of buttons with mappings.
4859 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4860 selection (because that's handled in the GUI code directly).
4861
4862 The 'mousemodel' option is set by the |:behave| command.
4863
4864 *'mouseshape'* *'mouses'* *E547*
4865'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004866 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 global
4868 {not in Vi}
4869 {only available when compiled with the |+mouseshape|
4870 feature}
4871 This option tells Vim what the mouse pointer should look like in
4872 different modes. The option is a comma separated list of parts, much
4873 like used for 'guicursor'. Each part consist of a mode/location-list
4874 and an argument-list:
4875 mode-list:shape,mode-list:shape,..
4876 The mode-list is a dash separated list of these modes/locations:
4877 In a normal window: ~
4878 n Normal mode
4879 v Visual mode
4880 ve Visual mode with 'selection' "exclusive" (same as 'v',
4881 if not specified)
4882 o Operator-pending mode
4883 i Insert mode
4884 r Replace mode
4885
4886 Others: ~
4887 c appending to the command-line
4888 ci inserting in the command-line
4889 cr replacing in the command-line
4890 m at the 'Hit ENTER' or 'More' prompts
4891 ml idem, but cursor in the last line
4892 e any mode, pointer below last window
4893 s any mode, pointer on a status line
4894 sd any mode, while dragging a status line
4895 vs any mode, pointer on a vertical separator line
4896 vd any mode, while dragging a vertical separator line
4897 a everywhere
4898
4899 The shape is one of the following:
4900 avail name looks like ~
4901 w x arrow Normal mouse pointer
4902 w x blank no pointer at all (use with care!)
4903 w x beam I-beam
4904 w x updown up-down sizing arrows
4905 w x leftright left-right sizing arrows
4906 w x busy The system's usual busy pointer
4907 w x no The system's usual 'no input' pointer
4908 x udsizing indicates up-down resizing
4909 x lrsizing indicates left-right resizing
4910 x crosshair like a big thin +
4911 x hand1 black hand
4912 x hand2 white hand
4913 x pencil what you write with
4914 x question big ?
4915 x rightup-arrow arrow pointing right-up
4916 w x up-arrow arrow pointing up
4917 x <number> any X11 pointer number (see X11/cursorfont.h)
4918
4919 The "avail" column contains a 'w' if the shape is available for Win32,
4920 x for X11.
4921 Any modes not specified or shapes not available use the normal mouse
4922 pointer.
4923
4924 Example: >
4925 :set mouseshape=s:udsizing,m:no
4926< will make the mouse turn to a sizing arrow over the status lines and
4927 indicate no input when the hit-enter prompt is displayed (since
4928 clicking the mouse has no effect in this state.)
4929
4930 *'mousetime'* *'mouset'*
4931'mousetime' 'mouset' number (default 500)
4932 global
4933 {not in Vi}
4934 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4935 time in msec between two mouse clicks for the second click to be
4936 recognized as a multi click.
4937
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004938 *'mzquantum'* *'mzq'*
4939'mzquantum' 'mzq' number (default 100)
4940 global
4941 {not in Vi}
4942 {not available when compiled without the |+mzscheme|
4943 feature}
4944 The number of milliseconds between polls for MzScheme threads.
4945 Negative or zero value means no thread scheduling.
4946
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947 *'nrformats'* *'nf'*
4948'nrformats' 'nf' string (default "octal,hex")
4949 local to buffer
4950 {not in Vi}
4951 This defines what bases Vim will consider for numbers when using the
4952 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4953 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004954 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004955 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02004956 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00004957 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004959 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 considered to be hexadecimal. Example: Using CTRL-X on
4961 "0x100" results in "0x0ff".
4962 Numbers which simply begin with a digit in the range 1-9 are always
4963 considered decimal. This also happens for numbers that are not
4964 recognized as octal or hex.
4965
4966 *'number'* *'nu'* *'nonumber'* *'nonu'*
4967'number' 'nu' boolean (default off)
4968 local to window
4969 Print the line number in front of each line. When the 'n' option is
4970 excluded from 'cpoptions' a wrapped line will not use the column of
4971 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004972 The 'numberwidth' option can be used to set the room used for the line
4973 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974 When a long, wrapped line doesn't start with the first character, '-'
4975 characters are put before the number.
4976 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02004977 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004979 *'numberwidth'* *'nuw'*
4980'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4981 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004982 {not in Vi}
4983 {only available when compiled with the |+linebreak|
4984 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004985 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02004986 when the 'number' or 'relativenumber' option is set or printing lines
4987 with a line number. Since one space is always between the number and
4988 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004989 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02004990 fit the highest line number in the buffer respectively the number of
4991 rows in the window, depending on whether 'number' or 'relativenumber'
4992 is set. Thus with the Vim default of 4 there is room for a line number
4993 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004994 The minimum value is 1, the maximum value is 10.
4995 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4996
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004997 *'omnifunc'* *'ofu'*
4998'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004999 local to buffer
5000 {not in Vi}
5001 {not available when compiled without the +eval
5002 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005003 This option specifies a function to be used for Insert mode omni
5004 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005005 See |complete-functions| for an explanation of how the function is
5006 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005007 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005008 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005009
5010
Bram Moolenaar02467872007-05-06 13:22:01 +00005011 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005012'opendevice' 'odev' boolean (default off)
5013 global
5014 {not in Vi}
5015 {only for MS-DOS, MS-Windows and OS/2}
5016 Enable reading and writing from devices. This may get Vim stuck on a
5017 device that can be opened but doesn't actually do the I/O. Therefore
5018 it is off by default.
5019 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5020 result in editing a device.
5021
5022
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005023 *'operatorfunc'* *'opfunc'*
5024'operatorfunc' 'opfunc' string (default: empty)
5025 global
5026 {not in Vi}
5027 This option specifies a function to be called by the |g@| operator.
5028 See |:map-operator| for more info and an example.
5029
5030 This option cannot be set from a |modeline| or in the |sandbox|, for
5031 security reasons.
5032
5033
Bram Moolenaar071d4272004-06-13 20:20:40 +00005034 *'osfiletype'* *'oft'* *E366*
5035'osfiletype' 'oft' string (RISC-OS default: "Text",
5036 others default: "")
5037 local to buffer
5038 {not in Vi}
5039 {only available when compiled with the |+osfiletype|
5040 feature}
5041 Some operating systems store extra information about files besides
5042 name, datestamp and permissions. This option contains the extra
5043 information, the nature of which will vary between systems.
5044 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005045 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046 It can affect the pattern matching of the automatic commands.
5047 |autocmd-osfiletypes|
5048
5049 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005050'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 global
5052 Specifies the nroff macros that separate paragraphs. These are pairs
5053 of two letters (see |object-motions|).
5054
5055 *'paste'* *'nopaste'*
5056'paste' boolean (default off)
5057 global
5058 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005059 Put Vim in Paste mode. This is useful if you want to cut or copy
5060 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005061 unexpected effects.
5062 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005063 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005064 knows about pasting and will mostly do the right thing without 'paste'
5065 being set. The same is true for a terminal where Vim handles the
5066 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005067 This option is reset when starting the GUI. Thus if you set it in
5068 your .vimrc it will work in a terminal, but not in the GUI. Setting
5069 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5070 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071 When the 'paste' option is switched on (also when it was already on):
5072 - mapping in Insert mode and Command-line mode is disabled
5073 - abbreviations are disabled
5074 - 'textwidth' is set to 0
5075 - 'wrapmargin' is set to 0
5076 - 'autoindent' is reset
5077 - 'smartindent' is reset
5078 - 'softtabstop' is set to 0
5079 - 'revins' is reset
5080 - 'ruler' is reset
5081 - 'showmatch' is reset
5082 - 'formatoptions' is used like it is empty
5083 These options keep their value, but their effect is disabled:
5084 - 'lisp'
5085 - 'indentexpr'
5086 - 'cindent'
5087 NOTE: When you start editing another file while the 'paste' option is
5088 on, settings from the modelines or autocommands may change the
5089 settings again, causing trouble when pasting text. You might want to
5090 set the 'paste' option again.
5091 When the 'paste' option is reset the mentioned options are restored to
5092 the value before the moment 'paste' was switched from off to on.
5093 Resetting 'paste' before ever setting it does not have any effect.
5094 Since mapping doesn't work while 'paste' is active, you need to use
5095 the 'pastetoggle' option to toggle the 'paste' option with some key.
5096
5097 *'pastetoggle'* *'pt'*
5098'pastetoggle' 'pt' string (default "")
5099 global
5100 {not in Vi}
5101 When non-empty, specifies the key sequence that toggles the 'paste'
5102 option. This is like specifying a mapping: >
5103 :map {keys} :set invpaste<CR>
5104< Where {keys} is the value of 'pastetoggle'.
5105 The difference is that it will work even when 'paste' is set.
5106 'pastetoggle' works in Insert mode and Normal mode, but not in
5107 Command-line mode.
5108 Mappings are checked first, thus overrule 'pastetoggle'. However,
5109 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5110 this: >
5111 :map <F10> :set paste<CR>
5112 :map <F11> :set nopaste<CR>
5113 :imap <F10> <C-O>:set paste<CR>
5114 :imap <F11> <nop>
5115 :set pastetoggle=<F11>
5116< This will make <F10> start paste mode and <F11> stop paste mode.
5117 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5118 mode everything is inserted literally, except the 'pastetoggle' key
5119 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005120 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121
5122 *'pex'* *'patchexpr'*
5123'patchexpr' 'pex' string (default "")
5124 global
5125 {not in Vi}
5126 {not available when compiled without the |+diff|
5127 feature}
5128 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005129 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005130
5131 *'patchmode'* *'pm'* *E206*
5132'patchmode' 'pm' string (default "")
5133 global
5134 {not in Vi}
5135 When non-empty the oldest version of a file is kept. This can be used
5136 to keep the original version of a file if you are changing files in a
5137 source distribution. Only the first time that a file is written a
5138 copy of the original file will be kept. The name of the copy is the
5139 name of the original file with the string in the 'patchmode' option
5140 appended. This option should start with a dot. Use a string like
5141 ".org". 'backupdir' must not be empty for this to work (Detail: The
5142 backup file is renamed to the patchmode file after the new file has
5143 been successfully written, that's why it must be possible to write a
5144 backup file). If there was no file to be backed up, an empty file is
5145 created.
5146 When the 'backupskip' pattern matches, a patchmode file is not made.
5147 Using 'patchmode' for compressed files appends the extension at the
5148 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5149 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005150 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151
5152 *'path'* *'pa'* *E343* *E345* *E347*
5153'path' 'pa' string (default on Unix: ".,/usr/include,,"
5154 on OS/2: ".,/emx/include,,"
5155 other systems: ".,,")
5156 global or local to buffer |global-local|
5157 {not in Vi}
5158 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005159 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5160 provided that the file being searched for has a relative path (not
5161 starting with "/", "./" or "../"). The directories in the 'path'
5162 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 - Use commas to separate directory names: >
5164 :set path=.,/usr/local/include,/usr/include
5165< - Spaces can also be used to separate directory names (for backwards
5166 compatibility with version 3.0). To have a space in a directory
5167 name, precede it with an extra backslash, and escape the space: >
5168 :set path=.,/dir/with\\\ space
5169< - To include a comma in a directory name precede it with an extra
5170 backslash: >
5171 :set path=.,/dir/with\\,comma
5172< - To search relative to the directory of the current file, use: >
5173 :set path=.
5174< - To search in the current directory use an empty string between two
5175 commas: >
5176 :set path=,,
5177< - A directory name may end in a ':' or '/'.
5178 - Environment variables are expanded |:set_env|.
5179 - When using |netrw.vim| URLs can be used. For example, adding
5180 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005181 - Search upwards and downwards in a directory tree using "*", "**" and
5182 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 {not available when compiled without the |+path_extra| feature}
5184 - Careful with '\' characters, type two to get one in the option: >
5185 :set path=.,c:\\include
5186< Or just use '/' instead: >
5187 :set path=.,c:/include
5188< Don't forget "." or files won't even be found in the same directory as
5189 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005190 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191 it is something like 256 or 1024 characters.
5192 You can check if all the include files are found, using the value of
5193 'path', see |:checkpath|.
5194 The use of |:set+=| and |:set-=| is preferred when adding or removing
5195 directories from the list. This avoids problems when a future version
5196 uses another default. To remove the current directory use: >
5197 :set path-=
5198< To add the current directory use: >
5199 :set path+=
5200< To use an environment variable, you probably need to replace the
5201 separator. Here is an example to append $INCL, in which directory
5202 names are separated with a semi-colon: >
5203 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5204< Replace the ';' with a ':' or whatever separator is used. Note that
5205 this doesn't work when $INCL contains a comma or white space.
5206
5207 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5208'preserveindent' 'pi' boolean (default off)
5209 local to buffer
5210 {not in Vi}
5211 When changing the indent of the current line, preserve as much of the
5212 indent structure as possible. Normally the indent is replaced by a
5213 series of tabs followed by spaces as required (unless |'expandtab'| is
5214 enabled, in which case only spaces are used). Enabling this option
5215 means the indent will preserve as many existing characters as possible
5216 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005217 'expandtab' does not apply to the preserved white space, a Tab remains
5218 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005219 NOTE: When using ">>" multiple times the resulting indent is a mix of
5220 tabs and spaces. You might not like this.
5221 NOTE: 'preserveindent' is reset when 'compatible' is set.
5222 Also see 'copyindent'.
5223 Use |:retab| to clean up white space.
5224
5225 *'previewheight'* *'pvh'*
5226'previewheight' 'pvh' number (default 12)
5227 global
5228 {not in Vi}
5229 {not available when compiled without the |+windows| or
5230 |+quickfix| feature}
5231 Default height for a preview window. Used for |:ptag| and associated
5232 commands. Used for |CTRL-W_}| when no count is given.
5233
5234 *'previewwindow'* *'nopreviewwindow'*
5235 *'pvw'* *'nopvw'* *E590*
5236'previewwindow' 'pvw' boolean (default off)
5237 local to window
5238 {not in Vi}
5239 {not available when compiled without the |+windows| or
5240 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005241 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242 set. It's normally not set directly, but by using one of the commands
5243 |:ptag|, |:pedit|, etc.
5244
5245 *'printdevice'* *'pdev'*
5246'printdevice' 'pdev' string (default empty)
5247 global
5248 {not in Vi}
5249 {only available when compiled with the |+printer|
5250 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005251 The name of the printer to be used for |:hardcopy|.
5252 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005253 This option cannot be set from a |modeline| or in the |sandbox|, for
5254 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005255
Bram Moolenaar8299df92004-07-10 09:47:34 +00005256 *'printencoding'* *'penc'*
5257'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005258 global
5259 {not in Vi}
5260 {only available when compiled with the |+printer|
5261 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005262 Sets the character encoding used when printing.
5263 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264
5265 *'printexpr'* *'pexpr'*
5266'printexpr' 'pexpr' String (default: see below)
5267 global
5268 {not in Vi}
5269 {only available when compiled with the |+printer|
5270 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005271 Expression used to print the PostScript produced with |:hardcopy|.
5272 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005273
Bram Moolenaar8299df92004-07-10 09:47:34 +00005274 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275'printfont' 'pfn' string (default "courier")
5276 global
5277 {not in Vi}
5278 {only available when compiled with the |+printer|
5279 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005280 The name of the font that will be used for |:hardcopy|.
5281 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282
5283 *'printheader'* *'pheader'*
5284'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5285 global
5286 {not in Vi}
5287 {only available when compiled with the |+printer|
5288 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005289 The format of the header produced in |:hardcopy| output.
5290 See |pheader-option|.
5291
5292 *'printmbcharset'* *'pmbcs'*
5293'printmbcharset' 'pmbcs' string (default "")
5294 global
5295 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005296 {only available when compiled with the |+printer|,
5297 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005298 The CJK character set to be used for CJK output from |:hardcopy|.
5299 See |pmbcs-option|.
5300
5301 *'printmbfont'* *'pmbfn'*
5302'printmbfont' 'pmbfn' string (default "")
5303 global
5304 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005305 {only available when compiled with the |+printer|,
5306 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005307 List of font names to be used for CJK output from |:hardcopy|.
5308 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309
5310 *'printoptions'* *'popt'*
5311'printoptions' 'popt' string (default "")
5312 global
5313 {not in Vi}
5314 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005315 List of items that control the format of the output of |:hardcopy|.
5316 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005318 *'prompt'* *'noprompt'*
5319'prompt' boolean (default on)
5320 global
5321 When on a ":" prompt is used in Ex mode.
5322
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005323 *'pumheight'* *'ph'*
5324'pumheight' 'ph' number (default 0)
5325 global
5326 {not available when compiled without the
5327 |+insert_expand| feature}
5328 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005329 Determines the maximum number of items to show in the popup menu for
5330 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005331 |ins-completion-menu|.
5332
5333
Bram Moolenaar677ee682005-01-27 14:41:15 +00005334 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005335'quoteescape' 'qe' string (default "\")
5336 local to buffer
5337 {not in Vi}
5338 The characters that are used to escape quotes in a string. Used for
5339 objects like a', a" and a` |a'|.
5340 When one of the characters in this option is found inside a string,
5341 the following character will be skipped. The default value makes the
5342 text "foo\"bar\\" considered to be one string.
5343
Bram Moolenaar071d4272004-06-13 20:20:40 +00005344 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5345'readonly' 'ro' boolean (default off)
5346 local to buffer
5347 If on, writes fail unless you use a '!'. Protects you from
5348 accidentally overwriting a file. Default on when Vim is started
5349 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005350 When using ":w!" the 'readonly' option is reset for the current
5351 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005352 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005353 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005355 *'redrawtime'* *'rdt'*
5356'redrawtime' 'rdt' number (default 2000)
5357 global
5358 {not in Vi}
5359 {only available when compiled with the |+reltime|
5360 feature}
5361 The time in milliseconds for redrawing the display. This applies to
5362 searching for patterns for 'hlsearch' and |:match| highlighting.
5363 When redrawing takes more than this many milliseconds no further
5364 matches will be highlighted. This is used to avoid that Vim hangs
5365 when using a very complicated pattern.
5366
Bram Moolenaar64486672010-05-16 15:46:46 +02005367 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5368'relativenumber' 'rnu' boolean (default off)
5369 local to window
5370 {not in Vi}
5371 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005372 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005373 precede some vertical motion commands (e.g. j k + -) with, without
5374 having to calculate it yourself. Especially useful in combination with
5375 other commands (e.g. y d c < > gq gw =).
5376 When the 'n' option is excluded from 'cpoptions' a wrapped
5377 line will not use the column of line numbers (this is the default when
5378 'compatible' isn't set).
5379 The 'numberwidth' option can be used to set the room used for the line
5380 number.
5381 When a long, wrapped line doesn't start with the first character, '-'
5382 characters are put before the number.
5383 See |hl-LineNr| for the highlighting used for the number.
5384 When setting this option, 'number' is reset.
5385
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386 *'remap'* *'noremap'*
5387'remap' boolean (default on)
5388 global
5389 Allows for mappings to work recursively. If you do not want this for
5390 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005391 NOTE: To avoid portability problems with Vim scripts, always keep
5392 this option at the default "on". Only switch it off when working with
5393 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394
5395 *'report'*
5396'report' number (default 2)
5397 global
5398 Threshold for reporting number of lines changed. When the number of
5399 changed lines is more than 'report' a message will be given for most
5400 ":" commands. If you want it always, set 'report' to 0.
5401 For the ":substitute" command the number of substitutions is used
5402 instead of the number of lines.
5403
5404 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5405'restorescreen' 'rs' boolean (default on)
5406 global
5407 {not in Vi} {only in Windows 95/NT console version}
5408 When set, the screen contents is restored when exiting Vim. This also
5409 happens when executing external commands.
5410
5411 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5412 options in your .vimrc. To disable restoring:
5413 set t_ti= t_te=
5414 To enable restoring (for an xterm):
5415 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5416 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5417
5418 *'revins'* *'ri'* *'norevins'* *'nori'*
5419'revins' 'ri' boolean (default off)
5420 global
5421 {not in Vi}
5422 {only available when compiled with the |+rightleft|
5423 feature}
5424 Inserting characters in Insert mode will work backwards. See "typing
5425 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5426 command in Insert mode, when 'allowrevins' is set.
5427 NOTE: This option is reset when 'compatible' or 'paste' is set.
5428
5429 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5430'rightleft' 'rl' boolean (default off)
5431 local to window
5432 {not in Vi}
5433 {only available when compiled with the |+rightleft|
5434 feature}
5435 When on, display orientation becomes right-to-left, i.e., characters
5436 that are stored in the file appear from the right to the left.
5437 Using this option, it is possible to edit files for languages that
5438 are written from the right to the left such as Hebrew and Arabic.
5439 This option is per window, so it is possible to edit mixed files
5440 simultaneously, or to view the same file in both ways (this is
5441 useful whenever you have a mixed text file with both right-to-left
5442 and left-to-right strings so that both sets are displayed properly
5443 in different windows). Also see |rileft.txt|.
5444
5445 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5446'rightleftcmd' 'rlc' string (default "search")
5447 local to window
5448 {not in Vi}
5449 {only available when compiled with the |+rightleft|
5450 feature}
5451 Each word in this option enables the command line editing to work in
5452 right-to-left mode for a group of commands:
5453
5454 search "/" and "?" commands
5455
5456 This is useful for languages such as Hebrew, Arabic and Farsi.
5457 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5458
5459 *'ruler'* *'ru'* *'noruler'* *'noru'*
5460'ruler' 'ru' boolean (default off)
5461 global
5462 {not in Vi}
5463 {not available when compiled without the
5464 |+cmdline_info| feature}
5465 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005466 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467 text in the file is shown on the far right:
5468 Top first line is visible
5469 Bot last line is visible
5470 All first and last line are visible
5471 45% relative position in the file
5472 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005473 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005475 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 this option takes precedence over 'ruler' and 'rulerformat'
5477 If the number of characters displayed is different from the number of
5478 bytes in the text (e.g., for a TAB or a multi-byte character), both
5479 the text column (byte number) and the screen column are shown,
5480 separated with a dash.
5481 For an empty line "0-1" is shown.
5482 For an empty buffer the line number will also be zero: "0,0-1".
5483 This option is reset when the 'paste' option is set.
5484 If you don't want to see the ruler all the time but want to know where
5485 you are, use "g CTRL-G" |g_CTRL-G|.
5486 NOTE: This option is reset when 'compatible' is set.
5487
5488 *'rulerformat'* *'ruf'*
5489'rulerformat' 'ruf' string (default empty)
5490 global
5491 {not in Vi}
5492 {not available when compiled without the |+statusline|
5493 feature}
5494 When this option is not empty, it determines the content of the ruler
5495 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005496 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005497 The default ruler width is 17 characters. To make the ruler 15
5498 characters wide, put "%15(" at the start and "%)" at the end.
5499 Example: >
5500 :set rulerformat=%15(%c%V\ %p%%%)
5501<
5502 *'runtimepath'* *'rtp'* *vimfiles*
5503'runtimepath' 'rtp' string (default:
5504 Unix: "$HOME/.vim,
5505 $VIM/vimfiles,
5506 $VIMRUNTIME,
5507 $VIM/vimfiles/after,
5508 $HOME/.vim/after"
5509 Amiga: "home:vimfiles,
5510 $VIM/vimfiles,
5511 $VIMRUNTIME,
5512 $VIM/vimfiles/after,
5513 home:vimfiles/after"
5514 PC, OS/2: "$HOME/vimfiles,
5515 $VIM/vimfiles,
5516 $VIMRUNTIME,
5517 $VIM/vimfiles/after,
5518 $HOME/vimfiles/after"
5519 Macintosh: "$VIM:vimfiles,
5520 $VIMRUNTIME,
5521 $VIM:vimfiles:after"
5522 RISC-OS: "Choices:vimfiles,
5523 $VIMRUNTIME,
5524 Choices:vimfiles/after"
5525 VMS: "sys$login:vimfiles,
5526 $VIM/vimfiles,
5527 $VIMRUNTIME,
5528 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005529 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530 global
5531 {not in Vi}
5532 This is a list of directories which will be searched for runtime
5533 files:
5534 filetype.vim filetypes by file name |new-filetype|
5535 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005536 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 colors/ color scheme files |:colorscheme|
5538 compiler/ compiler files |:compiler|
5539 doc/ documentation |write-local-help|
5540 ftplugin/ filetype plugins |write-filetype-plugin|
5541 indent/ indent scripts |indent-expression|
5542 keymap/ key mapping files |mbyte-keymap|
5543 lang/ menu translations |:menutrans|
5544 menu.vim GUI menus |menu.vim|
5545 plugin/ plugin scripts |write-plugin|
5546 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005547 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 syntax/ syntax files |mysyntaxfile|
5549 tutor/ files for vimtutor |tutor|
5550
5551 And any other file searched for with the |:runtime| command.
5552
5553 The defaults for most systems are setup to search five locations:
5554 1. In your home directory, for your personal preferences.
5555 2. In a system-wide Vim directory, for preferences from the system
5556 administrator.
5557 3. In $VIMRUNTIME, for files distributed with Vim.
5558 *after-directory*
5559 4. In the "after" directory in the system-wide Vim directory. This is
5560 for the system administrator to overrule or add to the distributed
5561 defaults (rarely needed)
5562 5. In the "after" directory in your home directory. This is for
5563 personal preferences to overrule or add to the distributed defaults
5564 or system-wide settings (rarely needed).
5565
5566 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5567 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005568 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005569 wildcards.
5570 See |:runtime|.
5571 Example: >
5572 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5573< This will use the directory "~/vimruntime" first (containing your
5574 personal Vim runtime files), then "/mygroup/vim" (shared between a
5575 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5576 files).
5577 You probably should always include $VIMRUNTIME somewhere, to use the
5578 distributed runtime files. You can put a directory before $VIMRUNTIME
5579 to find files which replace a distributed runtime files. You can put
5580 a directory after $VIMRUNTIME to find files which add to distributed
5581 runtime files.
5582 This option cannot be set from a |modeline| or in the |sandbox|, for
5583 security reasons.
5584
5585 *'scroll'* *'scr'*
5586'scroll' 'scr' number (default: half the window height)
5587 local to window
5588 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5589 set to half the number of lines in the window when the window size
5590 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005591 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5593 the number of screen lines instead of file lines, makes a difference
5594 when lines wrap}
5595
5596 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5597'scrollbind' 'scb' boolean (default off)
5598 local to window
5599 {not in Vi}
5600 {not available when compiled without the |+scrollbind|
5601 feature}
5602 See also |scroll-binding|. When this option is set, the current
5603 window scrolls as other scrollbind windows (windows that also have
5604 this option set) scroll. This option is useful for viewing the
5605 differences between two versions of a file, see 'diff'.
5606 See |'scrollopt'| for options that determine how this option should be
5607 interpreted.
5608 This option is mostly reset when splitting a window to edit another
5609 file. This means that ":split | edit file" results in two windows
5610 with scroll-binding, but ":split file" does not.
5611
5612 *'scrolljump'* *'sj'*
5613'scrolljump' 'sj' number (default 1)
5614 global
5615 {not in Vi}
5616 Minimal number of lines to scroll when the cursor gets off the
5617 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5618 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005619 When set to a negative number from -1 to -100 this is used as the
5620 percentage of the window height. Thus -50 scrolls half the window
5621 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622 NOTE: This option is set to 1 when 'compatible' is set.
5623
5624 *'scrolloff'* *'so'*
5625'scrolloff' 'so' number (default 0)
5626 global
5627 {not in Vi}
5628 Minimal number of screen lines to keep above and below the cursor.
5629 This will make some context visible around where you are working. If
5630 you set it to a very large value (999) the cursor line will always be
5631 in the middle of the window (except at the start or end of the file or
5632 when long lines wrap).
5633 For scrolling horizontally see 'sidescrolloff'.
5634 NOTE: This option is set to 0 when 'compatible' is set.
5635
5636 *'scrollopt'* *'sbo'*
5637'scrollopt' 'sbo' string (default "ver,jump")
5638 global
5639 {not available when compiled without the |+scrollbind|
5640 feature}
5641 {not in Vi}
5642 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005643 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5644 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005645 The following words are available:
5646 ver Bind vertical scrolling for 'scrollbind' windows
5647 hor Bind horizontal scrolling for 'scrollbind' windows
5648 jump Applies to the offset between two windows for vertical
5649 scrolling. This offset is the difference in the first
5650 displayed line of the bound windows. When moving
5651 around in a window, another 'scrollbind' window may
5652 reach a position before the start or after the end of
5653 the buffer. The offset is not changed though, when
5654 moving back the 'scrollbind' window will try to scroll
5655 to the desired position when possible.
5656 When now making that window the current one, two
5657 things can be done with the relative offset:
5658 1. When "jump" is not included, the relative offset is
5659 adjusted for the scroll position in the new current
5660 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005661 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662 2. When "jump" is included, the other windows are
5663 scrolled to keep the same relative offset. When
5664 going back to the other window, it still uses the
5665 same relative offset.
5666 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005667 When 'diff' mode is active there always is vertical scroll binding,
5668 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669
5670 *'sections'* *'sect'*
5671'sections' 'sect' string (default "SHNHH HUnhsh")
5672 global
5673 Specifies the nroff macros that separate sections. These are pairs of
5674 two letters (See |object-motions|). The default makes a section start
5675 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5676
5677 *'secure'* *'nosecure'* *E523*
5678'secure' boolean (default off)
5679 global
5680 {not in Vi}
5681 When on, ":autocmd", shell and write commands are not allowed in
5682 ".vimrc" and ".exrc" in the current directory and map commands are
5683 displayed. Switch it off only if you know that you will not run into
5684 problems, or when the 'exrc' option is off. On Unix this option is
5685 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005686 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 'secure' at the end of your ~/.vimrc then.
5688 This option cannot be set from a |modeline| or in the |sandbox|, for
5689 security reasons.
5690
5691 *'selection'* *'sel'*
5692'selection' 'sel' string (default "inclusive")
5693 global
5694 {not in Vi}
5695 This option defines the behavior of the selection. It is only used
5696 in Visual and Select mode.
5697 Possible values:
5698 value past line inclusive ~
5699 old no yes
5700 inclusive yes yes
5701 exclusive yes no
5702 "past line" means that the cursor is allowed to be positioned one
5703 character past the line.
5704 "inclusive" means that the last character of the selection is included
5705 in an operation. For example, when "x" is used to delete the
5706 selection.
5707 Note that when "exclusive" is used and selecting from the end
5708 backwards, you cannot include the last character of a line, when
5709 starting in Normal mode and 'virtualedit' empty.
5710
5711 The 'selection' option is set by the |:behave| command.
5712
5713 *'selectmode'* *'slm'*
5714'selectmode' 'slm' string (default "")
5715 global
5716 {not in Vi}
5717 This is a comma separated list of words, which specifies when to start
5718 Select mode instead of Visual mode, when a selection is started.
5719 Possible values:
5720 mouse when using the mouse
5721 key when using shifted special keys
5722 cmd when using "v", "V" or CTRL-V
5723 See |Select-mode|.
5724 The 'selectmode' option is set by the |:behave| command.
5725
5726 *'sessionoptions'* *'ssop'*
5727'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005728 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 global
5730 {not in Vi}
5731 {not available when compiled without the +mksession
5732 feature}
5733 Changes the effect of the |:mksession| command. It is a comma
5734 separated list of words. Each word enables saving and restoring
5735 something:
5736 word save and restore ~
5737 blank empty windows
5738 buffers hidden and unloaded buffers, not just those in windows
5739 curdir the current directory
5740 folds manually created folds, opened/closed folds and local
5741 fold options
5742 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005743 and contain at least one lowercase letter. Only
5744 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005745 help the help window
5746 localoptions options and mappings local to a window or buffer (not
5747 global values for local options)
5748 options all options and mappings (also global values for local
5749 options)
5750 resize size of the Vim window: 'lines' and 'columns'
5751 sesdir the directory in which the session file is located
5752 will become the current directory (useful with
5753 projects accessed over a network from different
5754 systems)
5755 slash backslashes in file names replaced with forward
5756 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005757 tabpages all tab pages; without this only the current tab page
5758 is restored, so that you can make a session for each
5759 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005760 unix with Unix end-of-line format (single <NL>), even when
5761 on Windows or DOS
5762 winpos position of the whole Vim window
5763 winsize window sizes
5764
5765 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005766 When neither "curdir" nor "sesdir" is included, file names are stored
5767 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005768 "slash" and "unix" are useful on Windows when sharing session files
5769 with Unix. The Unix version of Vim cannot source dos format scripts,
5770 but the Windows version of Vim can source unix format scripts.
5771
5772 *'shell'* *'sh'* *E91*
5773'shell' 'sh' string (default $SHELL or "sh",
5774 MS-DOS and Win32: "command.com" or
5775 "cmd.exe", OS/2: "cmd")
5776 global
5777 Name of the shell to use for ! and :! commands. When changing the
5778 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5779 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005780 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781 See |option-backslash| about including spaces and backslashes.
5782 Environment variables are expanded |:set_env|.
5783 If the name of the shell contains a space, you might need to enclose
5784 it in quotes. Example: >
5785 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5786< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005787 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 "-f" is not inside the quotes, because it is not part of the command
5789 name. And Vim automagically recognizes the backslashes that are path
5790 separators.
5791 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5792 variable to change the way external commands are executed. See the
5793 libc.inf file of DJGPP.
5794 Under MS-Windows, when the executable ends in ".com" it must be
5795 included. Thus setting the shell to "command.com" or "4dos.com"
5796 works, but "command" and "4dos" do not work for all commands (e.g.,
5797 filtering).
5798 For unknown reasons, when using "4dos.com" the current directory is
5799 changed to "C:\". To avoid this set 'shell' like this: >
5800 :set shell=command.com\ /c\ 4dos
5801< This option cannot be set from a |modeline| or in the |sandbox|, for
5802 security reasons.
5803
5804 *'shellcmdflag'* *'shcf'*
5805'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5806 does not contain "sh" somewhere: "/c")
5807 global
5808 {not in Vi}
5809 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5810 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5811 systems, the default is set according to the value of 'shell', to
5812 reduce the need to set this option by the user. It's not used for
5813 OS/2 (EMX figures this out itself). See |option-backslash| about
5814 including spaces and backslashes. See |dos-shell|.
5815 This option cannot be set from a |modeline| or in the |sandbox|, for
5816 security reasons.
5817
5818 *'shellpipe'* *'sp'*
5819'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5820 global
5821 {not in Vi}
5822 {not available when compiled without the |+quickfix|
5823 feature}
5824 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005825 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826 including spaces and backslashes.
5827 The name of the temporary file can be represented by "%s" if necessary
5828 (the file name is appended automatically if no %s appears in the value
5829 of this option).
5830 For the Amiga and MS-DOS the default is ">". The output is directly
5831 saved in a file and not echoed to the screen.
5832 For Unix the default it "| tee". The stdout of the compiler is saved
5833 in a file and echoed to the screen. If the 'shell' option is "csh" or
5834 "tcsh" after initializations, the default becomes "|& tee". If the
5835 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005836 "2>&1| tee". This means that stderr is also included. Before using
5837 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838 The initialization of this option is done after reading the ".vimrc"
5839 and the other initializations, so that when the 'shell' option is set
5840 there, the 'shellpipe' option changes automatically, unless it was
5841 explicitly set before.
5842 When 'shellpipe' is set to an empty string, no redirection of the
5843 ":make" output will be done. This is useful if you use a 'makeprg'
5844 that writes to 'makeef' by itself. If you want no piping, but do
5845 want to include the 'makeef', set 'shellpipe' to a single space.
5846 Don't forget to precede the space with a backslash: ":set sp=\ ".
5847 In the future pipes may be used for filtering and this option will
5848 become obsolete (at least for Unix).
5849 This option cannot be set from a |modeline| or in the |sandbox|, for
5850 security reasons.
5851
5852 *'shellquote'* *'shq'*
5853'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5854 contains "sh" somewhere: "\"")
5855 global
5856 {not in Vi}
5857 Quoting character(s), put around the command passed to the shell, for
5858 the "!" and ":!" commands. The redirection is kept outside of the
5859 quoting. See 'shellxquote' to include the redirection. It's
5860 probably not useful to set both options.
5861 This is an empty string by default. Only known to be useful for
5862 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5863 or bash, where it should be "\"". The default is adjusted according
5864 the value of 'shell', to reduce the need to set this option by the
5865 user. See |dos-shell|.
5866 This option cannot be set from a |modeline| or in the |sandbox|, for
5867 security reasons.
5868
5869 *'shellredir'* *'srr'*
5870'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5871 global
5872 {not in Vi}
5873 String to be used to put the output of a filter command in a temporary
5874 file. See also |:!|. See |option-backslash| about including spaces
5875 and backslashes.
5876 The name of the temporary file can be represented by "%s" if necessary
5877 (the file name is appended automatically if no %s appears in the value
5878 of this option).
5879 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5880 or "zsh" during initializations, the default becomes ">&". If the
5881 'shell' option is "sh", "ksh" or "bash" the default becomes
5882 ">%s 2>&1". This means that stderr is also included.
5883 For Win32, the Unix checks are done and additionally "cmd" is checked
5884 for, which makes the default ">%s 2>&1". Also, the same names with
5885 ".exe" appended are checked for.
5886 The initialization of this option is done after reading the ".vimrc"
5887 and the other initializations, so that when the 'shell' option is set
5888 there, the 'shellredir' option changes automatically unless it was
5889 explicitly set before.
5890 In the future pipes may be used for filtering and this option will
5891 become obsolete (at least for Unix).
5892 This option cannot be set from a |modeline| or in the |sandbox|, for
5893 security reasons.
5894
5895 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5896'shellslash' 'ssl' boolean (default off)
5897 global
5898 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5899 When set, a forward slash is used when expanding file names. This is
5900 useful when a Unix-like shell is used instead of command.com or
5901 cmd.exe. Backward slashes can still be typed, but they are changed to
5902 forward slashes by Vim.
5903 Note that setting or resetting this option has no effect for some
5904 existing file names, thus this option needs to be set before opening
5905 any file for best results. This might change in the future.
5906 'shellslash' only works when a backslash can be used as a path
5907 separator. To test if this is so use: >
5908 if exists('+shellslash')
5909<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005910 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5911'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5912 global
5913 {not in Vi}
5914 When on, use temp files for shell commands. When off use a pipe.
5915 When using a pipe is not possible temp files are used anyway.
5916 Currently a pipe is only supported on Unix. You can check it with: >
5917 :if has("filterpipe")
5918< The advantage of using a pipe is that nobody can read the temp file
5919 and the 'shell' command does not need to support redirection.
5920 The advantage of using a temp file is that the file type and encoding
5921 can be detected.
5922 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5923 |FilterWritePost| autocommands event are not triggered when
5924 'shelltemp' is off.
5925
Bram Moolenaar071d4272004-06-13 20:20:40 +00005926 *'shelltype'* *'st'*
5927'shelltype' 'st' number (default 0)
5928 global
5929 {not in Vi} {only for the Amiga}
5930 On the Amiga this option influences the way how the commands work
5931 which use a shell.
5932 0 and 1: always use the shell
5933 2 and 3: use the shell only to filter lines
5934 4 and 5: use shell only for ':sh' command
5935 When not using the shell, the command is executed directly.
5936
5937 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5938 1 and 3: use "shell cmd" to start external commands
5939
5940 *'shellxquote'* *'sxq'*
5941'shellxquote' 'sxq' string (default: "";
5942 for Win32, when 'shell' contains "sh"
5943 somewhere: "\""
5944 for Unix, when using system(): "\"")
5945 global
5946 {not in Vi}
5947 Quoting character(s), put around the command passed to the shell, for
5948 the "!" and ":!" commands. Includes the redirection. See
5949 'shellquote' to exclude the redirection. It's probably not useful
5950 to set both options.
5951 This is an empty string by default. Known to be useful for
5952 third-party shells when using the Win32 version, such as the MKS Korn
5953 Shell or bash, where it should be "\"". The default is adjusted
5954 according the value of 'shell', to reduce the need to set this option
5955 by the user. See |dos-shell|.
5956 This option cannot be set from a |modeline| or in the |sandbox|, for
5957 security reasons.
5958
5959 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5960'shiftround' 'sr' boolean (default off)
5961 global
5962 {not in Vi}
5963 Round indent to multiple of 'shiftwidth'. Applies to > and <
5964 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5965 a multiple of 'shiftwidth' (this is Vi compatible).
5966 NOTE: This option is reset when 'compatible' is set.
5967
5968 *'shiftwidth'* *'sw'*
5969'shiftwidth' 'sw' number (default 8)
5970 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005971 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005972 |'cindent'|, |>>|, |<<|, etc.
5973
5974 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005975'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5976 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005977 global
5978 {not in Vi}
5979 This option helps to avoid all the |hit-enter| prompts caused by file
5980 messages, for example with CTRL-G, and to avoid some other messages.
5981 It is a list of flags:
5982 flag meaning when present ~
5983 f use "(3 of 5)" instead of "(file 3 of 5)"
5984 i use "[noeol]" instead of "[Incomplete last line]"
5985 l use "999L, 888C" instead of "999 lines, 888 characters"
5986 m use "[+]" instead of "[Modified]"
5987 n use "[New]" instead of "[New File]"
5988 r use "[RO]" instead of "[readonly]"
5989 w use "[w]" instead of "written" for file write message
5990 and "[a]" instead of "appended" for ':w >> file' command
5991 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5992 "[unix format]" and "[mac]" instead of "[mac format]".
5993 a all of the above abbreviations
5994
5995 o overwrite message for writing a file with subsequent message
5996 for reading a file (useful for ":wn" or when 'autowrite' on)
5997 O message for reading a file overwrites any previous message.
5998 Also for quickfix message (e.g., ":cn").
5999 s don't give "search hit BOTTOM, continuing at TOP" or "search
6000 hit TOP, continuing at BOTTOM" messages
6001 t truncate file message at the start if it is too long to fit
6002 on the command-line, "<" will appear in the left most column.
6003 Ignored in Ex mode.
6004 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006005 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006006 Ignored in Ex mode.
6007 W don't give "written" or "[w]" when writing a file
6008 A don't give the "ATTENTION" message when an existing swap file
6009 is found.
6010 I don't give the intro message when starting Vim |:intro|.
6011
6012 This gives you the opportunity to avoid that a change between buffers
6013 requires you to hit <Enter>, but still gives as useful a message as
6014 possible for the space available. To get the whole message that you
6015 would have got with 'shm' empty, use ":file!"
6016 Useful values:
6017 shm= No abbreviation of message.
6018 shm=a Abbreviation, but no loss of information.
6019 shm=at Abbreviation, and truncate message when necessary.
6020
6021 NOTE: This option is set to the Vi default value when 'compatible' is
6022 set and to the Vim default value when 'compatible' is reset.
6023
6024 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6025'shortname' 'sn' boolean (default off)
6026 local to buffer
6027 {not in Vi, not in MS-DOS versions}
6028 Filenames are assumed to be 8 characters plus one extension of 3
6029 characters. Multiple dots in file names are not allowed. When this
6030 option is on, dots in file names are replaced with underscores when
6031 adding an extension (".~" or ".swp"). This option is not available
6032 for MS-DOS, because then it would always be on. This option is useful
6033 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6034 or crossdos. When running the Win32 GUI version under Win32s, this
6035 option is always on by default.
6036
6037 *'showbreak'* *'sbr'* *E595*
6038'showbreak' 'sbr' string (default "")
6039 global
6040 {not in Vi}
6041 {not available when compiled without the |+linebreak|
6042 feature}
6043 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006044 values are "> " or "+++ ": >
6045 :set showbreak=>\
6046< Note the backslash to escape the trailing space. It's easier like
6047 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006048 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006049< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050 comma (in a future version the comma might be used to separate the
6051 part that is shown at the end and at the start of a line).
6052 The characters are highlighted according to the '@' flag in
6053 'highlight'.
6054 Note that tabs after the showbreak will be displayed differently.
6055 If you want the 'showbreak' to appear in between line numbers, add the
6056 "n" flag to 'cpoptions'.
6057
6058 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6059'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6060 off)
6061 global
6062 {not in Vi}
6063 {not available when compiled without the
6064 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006065 Show (partial) command in the last line of the screen. Set this
6066 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006067 In Visual mode the size of the selected area is shown:
6068 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006069 If the number of bytes is different it is also displayed: "2-6"
6070 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006072 - When selecting a block, the size in screen characters:
6073 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 NOTE: This option is set to the Vi default value when 'compatible' is
6075 set and to the Vim default value when 'compatible' is reset.
6076
6077 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6078'showfulltag' 'sft' boolean (default off)
6079 global
6080 {not in Vi}
6081 When completing a word in insert mode (see |ins-completion|) from the
6082 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006083 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 matched a C function, you can see a template for what arguments are
6085 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006086 Note that this doesn't work well together with having "longest" in
6087 'completeopt', because the completion from the search pattern may not
6088 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089
6090 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6091'showmatch' 'sm' boolean (default off)
6092 global
6093 When a bracket is inserted, briefly jump to the matching one. The
6094 jump is only done if the match can be seen on the screen. The time to
6095 show the match can be set with 'matchtime'.
6096 A Beep is given if there is no match (no matter if the match can be
6097 seen or not). This option is reset when the 'paste' option is set.
6098 When the 'm' flag is not included in 'cpoptions', typing a character
6099 will immediately move the cursor back to where it belongs.
6100 See the "sm" field in 'guicursor' for setting the cursor shape and
6101 blinking when showing the match.
6102 The 'matchpairs' option can be used to specify the characters to show
6103 matches for. 'rightleft' and 'revins' are used to look for opposite
6104 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006105 Also see the matchparen plugin for highlighting the match when moving
6106 around |pi_paren.txt|.
6107 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108
6109 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6110'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6111 global
6112 If in Insert, Replace or Visual mode put a message on the last line.
6113 Use the 'M' flag in 'highlight' to set the type of highlighting for
6114 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006115 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006116 doesn't mean XIM is really active, especially when 'imactivatekey' is
6117 not set.
6118 NOTE: This option is set to the Vi default value when 'compatible' is
6119 set and to the Vim default value when 'compatible' is reset.
6120
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006121 *'showtabline'* *'stal'*
6122'showtabline' 'stal' number (default 1)
6123 global
6124 {not in Vi}
6125 {not available when compiled without the +windows
6126 feature}
6127 The value of this option specifies when the line with tab page labels
6128 will be displayed:
6129 0: never
6130 1: only if there are at least two tab pages
6131 2: always
6132 This is both for the GUI and non-GUI implementation of the tab pages
6133 line.
6134 See |tab-page| for more information about tab pages.
6135
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136 *'sidescroll'* *'ss'*
6137'sidescroll' 'ss' number (default 0)
6138 global
6139 {not in Vi}
6140 The minimal number of columns to scroll horizontally. Used only when
6141 the 'wrap' option is off and the cursor is moved off of the screen.
6142 When it is zero the cursor will be put in the middle of the screen.
6143 When using a slow terminal set it to a large number or 0. When using
6144 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6145 commands.
6146
6147 *'sidescrolloff'* *'siso'*
6148'sidescrolloff' 'siso' number (default 0)
6149 global
6150 {not in Vi}
6151 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006152 right of the cursor if 'nowrap' is set. Setting this option to a
6153 value greater than 0 while having |'sidescroll'| also at a non-zero
6154 value makes some context visible in the line you are scrolling in
6155 horizontally (except at beginning of the line). Setting this option
6156 to a large value (like 999) has the effect of keeping the cursor
6157 horizontally centered in the window, as long as one does not come too
6158 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159 NOTE: This option is set to 0 when 'compatible' is set.
6160
6161 Example: Try this together with 'sidescroll' and 'listchars' as
6162 in the following example to never allow the cursor to move
6163 onto the "extends" character:
6164
6165 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6166 :set sidescrolloff=1
6167
6168
6169 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6170'smartcase' 'scs' boolean (default off)
6171 global
6172 {not in Vi}
6173 Override the 'ignorecase' option if the search pattern contains upper
6174 case characters. Only used when the search pattern is typed and
6175 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006176 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006177 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6178 recalling the search pattern from history and hitting <Enter>.
6179 NOTE: This option is reset when 'compatible' is set.
6180
6181 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6182'smartindent' 'si' boolean (default off)
6183 local to buffer
6184 {not in Vi}
6185 {not available when compiled without the
6186 |+smartindent| feature}
6187 Do smart autoindenting when starting a new line. Works for C-like
6188 programs, but can also be used for other languages. 'cindent' does
6189 something like this, works better in most cases, but is more strict,
6190 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6191 'indentexpr' is a more advanced alternative.
6192 Normally 'autoindent' should also be on when using 'smartindent'.
6193 An indent is automatically inserted:
6194 - After a line ending in '{'.
6195 - After a line starting with a keyword from 'cinwords'.
6196 - Before a line starting with '}' (only with the "O" command).
6197 When typing '}' as the first character in a new line, that line is
6198 given the same indent as the matching '{'.
6199 When typing '#' as the first character in a new line, the indent for
6200 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006201 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6203 When using the ">>" command, lines starting with '#' are not shifted
6204 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006205 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206 is set smart indenting is disabled.
6207
6208 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6209'smarttab' 'sta' boolean (default off)
6210 global
6211 {not in Vi}
6212 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006213 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6214 <BS> will delete a 'shiftwidth' worth of space at the start of the
6215 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006216 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006217 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6218 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006219 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006221 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006222 NOTE: This option is reset when 'compatible' is set.
6223
6224 *'softtabstop'* *'sts'*
6225'softtabstop' 'sts' number (default 0)
6226 local to buffer
6227 {not in Vi}
6228 Number of spaces that a <Tab> counts for while performing editing
6229 operations, like inserting a <Tab> or using <BS>. It "feels" like
6230 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6231 used. This is useful to keep the 'ts' setting at its standard value
6232 of 8, while being able to edit like it is set to 'sts'. However,
6233 commands like "x" still work on the actual characters.
6234 When 'sts' is zero, this feature is off.
6235 'softtabstop' is set to 0 when the 'paste' option is set.
6236 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6237 spaces is minimized by using <Tab>s.
6238 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6239 set.
6240 NOTE: This option is set to 0 when 'compatible' is set.
6241
Bram Moolenaar217ad922005-03-20 22:37:15 +00006242 *'spell'* *'nospell'*
6243'spell' boolean (default off)
6244 local to window
6245 {not in Vi}
6246 {not available when compiled without the |+syntax|
6247 feature}
6248 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006249 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006250
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006251 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006252'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006253 local to buffer
6254 {not in Vi}
6255 {not available when compiled without the |+syntax|
6256 feature}
6257 Pattern to locate the end of a sentence. The following word will be
6258 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006259 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006260 When this check is not wanted make this option empty.
6261 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006262 Be careful with special characters, see |option-backslash| about
6263 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006264 To set this option automatically depending on the language, see
6265 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006266
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006267 *'spellfile'* *'spf'*
6268'spellfile' 'spf' string (default empty)
6269 local to buffer
6270 {not in Vi}
6271 {not available when compiled without the |+syntax|
6272 feature}
6273 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006274 commands. It must end in ".{encoding}.add". You need to include the
6275 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006276 *E765*
6277 It may also be a comma separated list of names. A count before the
6278 |zg| and |zw| commands can be used to access each. This allows using
6279 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006280 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006281 you: Using the first directory in 'runtimepath' that is writable. If
6282 there is no "spell" directory yet it will be created. For the file
6283 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006284 ignoring the region.
6285 The resulting ".spl" file will be used for spell checking, it does not
6286 have to appear in 'spelllang'.
6287 Normally one file is used for all regions, but you can add the region
6288 name if you want to. However, it will then only be used when
6289 'spellfile' is set to it, for entries in 'spelllang' only files
6290 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006291 This option cannot be set from a |modeline| or in the |sandbox|, for
6292 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006293
Bram Moolenaar217ad922005-03-20 22:37:15 +00006294 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006295'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006296 local to buffer
6297 {not in Vi}
6298 {not available when compiled without the |+syntax|
6299 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006300 A comma separated list of word list names. When the 'spell' option is
6301 on spellchecking will be done for these languages. Example: >
6302 set spelllang=en_us,nl,medical
6303< This means US English, Dutch and medical words are recognized. Words
6304 that are not recognized will be highlighted.
6305 The word list name must not include a comma or dot. Using a dash is
6306 recommended to separate the two letter language name from a
6307 specification. Thus "en-rare" is used for rare English words.
6308 A region name must come last and have the form "_xx", where "xx" is
6309 the two-letter, lower case region name. You can use more than one
6310 region by listing them: "en_us,en_ca" supports both US and Canadian
6311 English, but not words specific for Australia, New Zealand or Great
6312 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006313 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006314 As a special case the name of a .spl file can be given as-is. The
6315 first "_xx" in the name is removed and used as the region name
6316 (_xx is an underscore, two letters and followed by a non-letter).
6317 This is mainly for testing purposes. You must make sure the correct
6318 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006319 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006320 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6321 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006322 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006323
Bram Moolenaar98692072006-02-04 00:57:42 +00006324 If the |spellfile.vim| plugin is active and you use a language name
6325 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6326 will ask you if you want to download the file.
6327
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006328 After this option has been set successfully, Vim will source the files
6329 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006330 up to the first comma, dot or underscore.
6331 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006332
6333
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006334 *'spellsuggest'* *'sps'*
6335'spellsuggest' 'sps' string (default "best")
6336 global
6337 {not in Vi}
6338 {not available when compiled without the |+syntax|
6339 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006340 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006341 the |spellsuggest()| function. This is a comma-separated list of
6342 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006343
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006344 best Internal method that works best for English. Finds
6345 changes like "fast" and uses a bit of sound-a-like
6346 scoring to improve the ordering.
6347
6348 double Internal method that uses two methods and mixes the
6349 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006350 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006351 word. That only works when the language specifies
6352 sound folding. Can be slow and doesn't always give
6353 better results.
6354
6355 fast Internal method that only checks for simple changes:
6356 character inserts/deletes/swaps. Works well for
6357 simple typing mistakes.
6358
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006359 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006360 Not used for |spellsuggest()|. The number of
6361 suggestions is never more than the value of 'lines'
6362 minus two.
6363
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006364 file:{filename} Read file {filename}, which must have two columns,
6365 separated by a slash. The first column contains the
6366 bad word, the second column the suggested good word.
6367 Example:
6368 theribal/terrible ~
6369 Use this for common mistakes that do not appear at the
6370 top of the suggestion list with the internal methods.
6371 Lines without a slash are ignored, use this for
6372 comments.
6373 The file is used for all languages.
6374
6375 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6376 trouble with spaces. |v:val| holds the badly spelled
6377 word. The expression must evaluate to a List of
6378 Lists, each with a suggestion and a score.
6379 Example:
6380 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006381 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006382 internal methods use. A lower score is better.
6383 This may invoke |spellsuggest()| if you temporarily
6384 set 'spellsuggest' to exclude the "expr:" part.
6385 Errors are silently ignored, unless you set the
6386 'verbose' option to a non-zero value.
6387
6388 Only one of "best", "double" or "fast" may be used. The others may
6389 appear several times in any order. Example: >
6390 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6391<
6392 This option cannot be set from a |modeline| or in the |sandbox|, for
6393 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006394
6395
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6397'splitbelow' 'sb' boolean (default off)
6398 global
6399 {not in Vi}
6400 {not available when compiled without the +windows
6401 feature}
6402 When on, splitting a window will put the new window below the current
6403 one. |:split|
6404
6405 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6406'splitright' 'spr' boolean (default off)
6407 global
6408 {not in Vi}
6409 {not available when compiled without the +vertsplit
6410 feature}
6411 When on, splitting a window will put the new window right of the
6412 current one. |:vsplit|
6413
6414 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6415'startofline' 'sol' boolean (default on)
6416 global
6417 {not in Vi}
6418 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006419 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006420 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006421 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 with a linewise operator, with "%" with a count and to buffer changing
6423 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6424 only has a line number, e.g., ":25" or ":+".
6425 In case of buffer changing commands the cursor is placed at the column
6426 where it was the last time the buffer was edited.
6427 NOTE: This option is set when 'compatible' is set.
6428
6429 *'statusline'* *'stl'* *E540* *E541* *E542*
6430'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006431 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 {not in Vi}
6433 {not available when compiled without the |+statusline|
6434 feature}
6435 When nonempty, this option determines the content of the status line.
6436 Also see |status-line|.
6437
6438 The option consists of printf style '%' items interspersed with
6439 normal text. Each status line item is of the form:
6440 %-0{minwid}.{maxwid}{item}
6441 All fields except the {item} is optional. A single percent sign can
6442 be given as "%%". Up to 80 items can be specified.
6443
Bram Moolenaar238a5642006-02-21 22:12:05 +00006444 When the option starts with "%!" then it is used as an expression,
6445 evaluated and the result is used as the option value. Example: >
6446 :set statusline=%!MyStatusLine()
6447< The result can contain %{} items that will be evaluated too.
6448
6449 When there is error while evaluating the option then it will be made
6450 empty to avoid further errors. Otherwise screen updating would loop.
6451
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452 Note that the only effect of 'ruler' when this option is set (and
6453 'laststatus' is 2) is controlling the output of |CTRL-G|.
6454
6455 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006456 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006458 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 minwid Minimum width of the item, padding as set by '-' & '0'.
6460 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006461 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462 on the left for text items. Numeric items will be
6463 shifted down to maxwid-2 digits followed by '>'number
6464 where number is the amount of missing digits, much like
6465 an exponential notation.
6466 item A one letter code as described below.
6467
6468 Following is a description of the possible statusline items. The
6469 second character in "item" is the type:
6470 N for number
6471 S for string
6472 F for flags as described below
6473 - not applicable
6474
6475 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006476 f S Path to the file in the buffer, as typed or relative to current
6477 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 F S Full path to the file in the buffer.
6479 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006480 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006482 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006484 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006486 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006488 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006489 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6490 {not available when compiled without |+autocmd| feature}
6491 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6492 being used: "<keymap>"
6493 n N Buffer number.
6494 b N Value of byte under cursor.
6495 B N As above, in hexadecimal.
6496 o N Byte number in file of byte under cursor, first byte is 1.
6497 Mnemonic: Offset from start of file (with one added)
6498 {not available when compiled without |+byte_offset| feature}
6499 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006500 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 l N Line number.
6502 L N Number of lines in buffer.
6503 c N Column number.
6504 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006505 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 p N Percentage through file in lines as in |CTRL-G|.
6507 P S Percentage through file of displayed window. This is like the
6508 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006509 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006511 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006512 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513 ( - Start of item group. Can be used for setting the width and
6514 alignment of a section. Must be followed by %) somewhere.
6515 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006516 T N For 'tabline': start of tab page N label. Use %T after the last
6517 label. This information is used for mouse clicks.
6518 X N For 'tabline': start of close tab N label. Use %X after the
6519 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6520 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 < - Where to truncate line if too long. Default is at the start.
6522 No width fields allowed.
6523 = - Separation point between left and right aligned items.
6524 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006525 # - Set highlight group. The name must follow and then a # again.
6526 Thus use %#HLname# for highlight group HLname. The same
6527 highlighting is used, also for the statusline of non-current
6528 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006530 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531 The difference between User{N} and StatusLine will be applied
6532 to StatusLineNC for the statusline of non-current windows.
6533 The number N must be between 1 and 9. See |hl-User1..9|
6534
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006535 When displaying a flag, Vim removes the leading comma, if any, when
6536 that flag comes right after plaintext. This will make a nice display
6537 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538
Bram Moolenaar582fd852005-03-28 20:58:01 +00006539 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 not set) and a minwid is not set for the group, the whole group will
6541 become empty. This will make a group like the following disappear
6542 completely from the statusline when none of the flags are set. >
6543 :set statusline=...%(\ [%M%R%H]%)...
6544<
6545 Beware that an expression is evaluated each and every time the status
6546 line is displayed. The current buffer and current window will be set
6547 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006548 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006550 real current buffer.
6551
6552 The 'statusline' option may be evaluated in the |sandbox|, see
6553 |sandbox-option|.
6554
6555 It is not allowed to change text or jump to another window while
6556 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557
6558 If the statusline is not updated when you want it (e.g., after setting
6559 a variable that's used in an expression), you can force an update by
6560 setting an option without changing its value. Example: >
6561 :let &ro = &ro
6562
6563< A result of all digits is regarded a number for display purposes.
6564 Otherwise the result is taken as flag text and applied to the rules
6565 described above.
6566
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006567 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6569 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6570
6571 Examples:
6572 Emulate standard status line with 'ruler' set >
6573 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6574< Similar, but add ASCII value of char under the cursor (like "ga") >
6575 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6576< Display byte count and byte value, modified flag in red. >
6577 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6578 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6579< Display a ,GZ flag if a compressed file is loaded >
6580 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6581< In the |:autocmd|'s: >
6582 :let b:gzflag = 1
6583< And: >
6584 :unlet b:gzflag
6585< And define this function: >
6586 :function VarExists(var, val)
6587 : if exists(a:var) | return a:val | else | return '' | endif
6588 :endfunction
6589<
6590 *'suffixes'* *'su'*
6591'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6592 global
6593 {not in Vi}
6594 Files with these suffixes get a lower priority when multiple files
6595 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006596 suffixes. Spaces after the comma are ignored. A dot is also seen as
6597 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006598 separator, precede it with a backslash (see |option-backslash| about
6599 including spaces and backslashes).
6600 See 'wildignore' for completely ignoring files.
6601 The use of |:set+=| and |:set-=| is preferred when adding or removing
6602 suffixes from the list. This avoids problems when a future version
6603 uses another default.
6604
6605 *'suffixesadd'* *'sua'*
6606'suffixesadd' 'sua' string (default "")
6607 local to buffer
6608 {not in Vi}
6609 {not available when compiled without the
6610 |+file_in_path| feature}
6611 Comma separated list of suffixes, which are used when searching for a
6612 file for the "gf", "[I", etc. commands. Example: >
6613 :set suffixesadd=.java
6614<
6615 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6616'swapfile' 'swf' boolean (default on)
6617 local to buffer
6618 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006619 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 swapfile is not wanted for a specific buffer. For example, with
6621 confidential information that even root must not be able to access.
6622 Careful: All text will be in memory:
6623 - Don't use this for big files.
6624 - Recovery will be impossible!
6625 A swapfile will only be present when |'updatecount'| is non-zero and
6626 'swapfile' is set.
6627 When 'swapfile' is reset, the swap file for the current buffer is
6628 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6629 non-zero, a swap file is immediately created.
6630 Also see |swap-file| and |'swapsync'|.
6631
6632 This option is used together with 'bufhidden' and 'buftype' to
6633 specify special kinds of buffers. See |special-buffers|.
6634
6635 *'swapsync'* *'sws'*
6636'swapsync' 'sws' string (default "fsync")
6637 global
6638 {not in Vi}
6639 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006640 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006641 When this option is empty parts of the swap file may be in memory and
6642 not written to disk. When the system crashes you may lose more work.
6643 On Unix the system does a sync now and then without Vim asking for it,
6644 so the disadvantage of setting this option off is small. On some
6645 systems the swap file will not be written at all. For a unix system
6646 setting it to "sync" will use the sync() call instead of the default
6647 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006648 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649
6650 *'switchbuf'* *'swb'*
6651'switchbuf' 'swb' string (default "")
6652 global
6653 {not in Vi}
6654 This option controls the behavior when switching between buffers.
6655 Possible values (comma separated list):
6656 useopen If included, jump to the first open window that
6657 contains the specified buffer (if there is one).
6658 Otherwise: Do not examine other windows.
6659 This setting is checked with |quickfix| commands, when
6660 jumping to errors (":cc", ":cn", "cp", etc.). It is
6661 also used in all buffer related split commands, for
6662 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006663 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006664 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006666 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006668 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006669 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006671 *'synmaxcol'* *'smc'*
6672'synmaxcol' 'smc' number (default 3000)
6673 local to buffer
6674 {not in Vi}
6675 {not available when compiled without the |+syntax|
6676 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006677 Maximum column in which to search for syntax items. In long lines the
6678 text after this column is not highlighted and following lines may not
6679 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006680 This helps to avoid very slow redrawing for an XML file that is one
6681 long line.
6682 Set to zero to remove the limit.
6683
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 *'syntax'* *'syn'*
6685'syntax' 'syn' string (default empty)
6686 local to buffer
6687 {not in Vi}
6688 {not available when compiled without the |+syntax|
6689 feature}
6690 When this option is set, the syntax with this name is loaded, unless
6691 syntax highlighting has been switched off with ":syntax off".
6692 Otherwise this option does not always reflect the current syntax (the
6693 b:current_syntax variable does).
6694 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006695 not automatically recognized. Example, in an IDL file:
6696 /* vim: set syntax=idl : */ ~
6697 When a dot appears in the value then this separates two filetype
6698 names. Example:
6699 /* vim: set syntax=c.doxygen : */ ~
6700 This will use the "c" syntax first, then the "doxygen" syntax.
6701 Note that the second one must be prepared to be loaded as an addition,
6702 otherwise it will be skipped. More than one dot may appear.
6703 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704 :set syntax=OFF
6705< To switch syntax highlighting on according to the current value of the
6706 'filetype' option: >
6707 :set syntax=ON
6708< What actually happens when setting the 'syntax' option is that the
6709 Syntax autocommand event is triggered with the value as argument.
6710 This option is not copied to another buffer, independent of the 's' or
6711 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006712 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006714 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006715'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006716 global
6717 {not in Vi}
6718 {not available when compiled without the +windows
6719 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006720 When nonempty, this option determines the content of the tab pages
6721 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006722 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006723
6724 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006725 option and only when there is no GUI tab line. When 'e' is in
6726 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6727 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006728
6729 The value is evaluated like with 'statusline'. You can use
6730 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006731 the text to be displayed. Use "%1T" for the first label, "%2T" for
6732 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006733
6734 Keep in mind that only one of the tab pages is the current one, others
6735 are invisible and you can't jump to their windows.
6736
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006737
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006738 *'tabpagemax'* *'tpm'*
6739'tabpagemax' 'tpm' number (default 10)
6740 global
6741 {not in Vi}
6742 {not available when compiled without the +windows
6743 feature}
6744 Maximum number of tab pages to be opened by the |-p| command line
6745 argument or the ":tab all" command. |tabpage|
6746
6747
6748 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749'tabstop' 'ts' number (default 8)
6750 local to buffer
6751 Number of spaces that a <Tab> in the file counts for. Also see
6752 |:retab| command, and 'softtabstop' option.
6753
6754 Note: Setting 'tabstop' to any other value than 8 can make your file
6755 appear wrong in many places (e.g., when printing it).
6756
6757 There are four main ways to use tabs in Vim:
6758 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6759 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006760 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 behave like a tab appears every 4 (or 3) characters.
6762 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6763 'expandtab'. This way you will always insert spaces. The
6764 formatting will never be messed up when 'tabstop' is changed.
6765 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006766 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006767 works when using Vim to edit the file.
6768 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6769 'noexpandtab'. This should then work (for initial indents only)
6770 for any tabstop setting that people use. It might be nice to have
6771 tabs after the first non-blank inserted as spaces if you do this
6772 though. Otherwise aligned comments will be wrong when 'tabstop' is
6773 changed.
6774
6775 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6776'tagbsearch' 'tbs' boolean (default on)
6777 global
6778 {not in Vi}
6779 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006780 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781 searching makes searching for a tag a LOT faster, but a linear search
6782 will find more tags if the tags file wasn't properly sorted.
6783 Vim normally assumes that your tags files are sorted, or indicate that
6784 they are not sorted. Only when this is not the case does the
6785 'tagbsearch' option need to be switched off.
6786
6787 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006788 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 certain files, or retry all files with a linear search. When
6790 'tagbsearch' is off, only a linear search is done.
6791
6792 Linear searching is done anyway, for one file, when Vim finds a line
6793 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006794 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795< [The whitespace before and after the '0' must be a single <Tab>]
6796
6797 When a binary search was done and no match was found in any of the
6798 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6799 instead of a normal tag name, a retry is done with a linear search.
6800 Tags in unsorted tags files, and matches with different case will only
6801 be found in the retry.
6802
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006803 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006804 linear search can be avoided for the 'ignorecase' case. Use a value
6805 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6806 case-fold sorted with the -f switch to "sort" in most unices, as in
6807 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006808 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6809 for this as well. Note that case must be folded to uppercase for this
6810 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811
6812 When 'tagbsearch' is off, tags searching is slower when a full match
6813 exists, but faster when no full match exists. Tags in unsorted tags
6814 files may only be found with 'tagbsearch' off.
6815 When the tags file is not sorted, or sorted in a wrong way (not on
6816 ASCII byte value), 'tagbsearch' should be off, or the line given above
6817 must be included in the tags file.
6818 This option doesn't affect commands that find all matching tags (e.g.,
6819 command-line completion and ":help").
6820 {Vi: always uses binary search in some versions}
6821
6822 *'taglength'* *'tl'*
6823'taglength' 'tl' number (default 0)
6824 global
6825 If non-zero, tags are significant up to this number of characters.
6826
6827 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6828'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6829 global
6830 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006831 If on and using a tags file in another directory, file names in that
6832 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833 NOTE: This option is set to the Vi default value when 'compatible' is
6834 set and to the Vim default value when 'compatible' is reset.
6835
6836 *'tags'* *'tag'* *E433*
6837'tags' 'tag' string (default "./tags,tags", when compiled with
6838 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6839 global or local to buffer |global-local|
6840 Filenames for the tag command, separated by spaces or commas. To
6841 include a space or comma in a file name, precede it with a backslash
6842 (see |option-backslash| about including spaces and backslashes).
6843 When a file name starts with "./", the '.' is replaced with the path
6844 of the current file. But only when the 'd' flag is not included in
6845 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6846 |tags-option|.
6847 "*", "**" and other wildcards can be used to search for tags files in
6848 a directory tree. See |file-searching|. {not available when compiled
6849 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006850 The |tagfiles()| function can be used to get a list of the file names
6851 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6853 files are also supported. They are automatically recognized. The
6854 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6855 differences are ignored (MS-Windows). |emacs-tags|
6856 The use of |:set+=| and |:set-=| is preferred when adding or removing
6857 file names from the list. This avoids problems when a future version
6858 uses another default.
6859 {Vi: default is "tags /usr/lib/tags"}
6860
6861 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6862'tagstack' 'tgst' boolean (default on)
6863 global
6864 {not in all versions of Vi}
6865 When on, the |tagstack| is used normally. When off, a ":tag" or
6866 ":tselect" command with an argument will not push the tag onto the
6867 tagstack. A following ":tag" without an argument, a ":pop" command or
6868 any other command that uses the tagstack will use the unmodified
6869 tagstack, but does change the pointer to the active entry.
6870 Resetting this option is useful when using a ":tag" command in a
6871 mapping which should not change the tagstack.
6872
6873 *'term'* *E529* *E530* *E531*
6874'term' string (default is $TERM, if that fails:
6875 in the GUI: "builtin_gui"
6876 on Amiga: "amiga"
6877 on BeOS: "beos-ansi"
6878 on Mac: "mac-ansi"
6879 on MiNT: "vt52"
6880 on MS-DOS: "pcterm"
6881 on OS/2: "os2ansi"
6882 on Unix: "ansi"
6883 on VMS: "ansi"
6884 on Win 32: "win32")
6885 global
6886 Name of the terminal. Used for choosing the terminal control
6887 characters. Environment variables are expanded |:set_env|.
6888 For example: >
6889 :set term=$TERM
6890< See |termcap|.
6891
6892 *'termbidi'* *'tbidi'*
6893 *'notermbidi'* *'notbidi'*
6894'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6895 global
6896 {not in Vi}
6897 {only available when compiled with the |+arabic|
6898 feature}
6899 The terminal is in charge of Bi-directionality of text (as specified
6900 by Unicode). The terminal is also expected to do the required shaping
6901 that some languages (such as Arabic) require.
6902 Setting this option implies that 'rightleft' will not be set when
6903 'arabic' is set and the value of 'arabicshape' will be ignored.
6904 Note that setting 'termbidi' has the immediate effect that
6905 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6906 This option is reset when the GUI is started.
6907 For further details see |arabic.txt|.
6908
6909 *'termencoding'* *'tenc'*
6910'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6911 Macintosh GUI: "macroman")
6912 global
6913 {only available when compiled with the |+multi_byte|
6914 feature}
6915 {not in Vi}
6916 Encoding used for the terminal. This specifies what character
6917 encoding the keyboard produces and the display will understand. For
6918 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006919 display). Except for the Mac when 'macatsui' is off, then
6920 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921 In the Win32 console version the default value is the console codepage
6922 when it differs from the ANSI codepage.
6923 *E617*
6924 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6925 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6926 Any attempts to set a different value will be rejected, and an error
6927 message is shown.
6928 For the Win32 GUI 'termencoding' is not used for typed characters,
6929 because the Win32 system always passes Unicode characters.
6930 When empty, the same encoding is used as for the 'encoding' option.
6931 This is the normal value.
6932 Not all combinations for 'termencoding' and 'encoding' are valid. See
6933 |encoding-table|.
6934 The value for this option must be supported by internal conversions or
6935 iconv(). When this is not possible no conversion will be done and you
6936 will probably experience problems with non-ASCII characters.
6937 Example: You are working with the locale set to euc-jp (Japanese) and
6938 want to edit a UTF-8 file: >
6939 :let &termencoding = &encoding
6940 :set encoding=utf-8
6941< You need to do this when your system has no locale support for UTF-8.
6942
6943 *'terse'* *'noterse'*
6944'terse' boolean (default off)
6945 global
6946 When set: Add 's' flag to 'shortmess' option (this makes the message
6947 for a search that hits the start or end of the file not being
6948 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6949 shortens a lot of messages}
6950
6951 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6952'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6953 global
6954 {not in Vi}
6955 This option is obsolete. Use 'fileformats'.
6956 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6957 set to the default value for the current system. When 'textauto' is
6958 reset, 'fileformats' is made empty.
6959 NOTE: This option is set to the Vi default value when 'compatible' is
6960 set and to the Vim default value when 'compatible' is reset.
6961
6962 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6963'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6964 others: default off)
6965 local to buffer
6966 {not in Vi}
6967 This option is obsolete. Use 'fileformat'.
6968 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6969 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6970 "unix".
6971
6972 *'textwidth'* *'tw'*
6973'textwidth' 'tw' number (default 0)
6974 local to buffer
6975 {not in Vi}
6976 Maximum width of text that is being inserted. A longer line will be
6977 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006978 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6979 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00006981 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982 NOTE: This option is set to 0 when 'compatible' is set.
6983
6984 *'thesaurus'* *'tsr'*
6985'thesaurus' 'tsr' string (default "")
6986 global or local to buffer |global-local|
6987 {not in Vi}
6988 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006989 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990 the file should contain words with similar meaning, separated by
6991 non-keyword characters (white space is preferred). Maximum line
6992 length is 510 bytes.
6993 To obtain a file to be used here, check out the wordlist FAQ at
6994 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006995 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006996 after a comma are ignored, otherwise spaces are included in the file
6997 name. See |option-backslash| about using backslashes.
6998 The use of |:set+=| and |:set-=| is preferred when adding or removing
6999 directories from the list. This avoids problems when a future version
7000 uses another default.
7001 Backticks cannot be used in this option for security reasons.
7002
7003 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7004'tildeop' 'top' boolean (default off)
7005 global
7006 {not in Vi}
7007 When on: The tilde command "~" behaves like an operator.
7008 NOTE: This option is reset when 'compatible' is set.
7009
7010 *'timeout'* *'to'* *'notimeout'* *'noto'*
7011'timeout' 'to' boolean (default on)
7012 global
7013 *'ttimeout'* *'nottimeout'*
7014'ttimeout' boolean (default off)
7015 global
7016 {not in Vi}
7017 These two options together determine the behavior when part of a
7018 mapped key sequence or keyboard code has been received:
7019
7020 'timeout' 'ttimeout' action ~
7021 off off do not time out
7022 on on or off time out on :mappings and key codes
7023 off on time out on key codes
7024
7025 If both options are off, Vim will wait until either the complete
7026 mapping or key sequence has been received, or it is clear that there
7027 is no mapping or key sequence for the received characters. For
7028 example: if you have mapped "vl" and Vim has received 'v', the next
7029 character is needed to see if the 'v' is followed by an 'l'.
7030 When one of the options is on, Vim will wait for about 1 second for
7031 the next character to arrive. After that the already received
7032 characters are interpreted as single characters. The waiting time can
7033 be changed with the 'timeoutlen' option.
7034 On slow terminals or very busy systems timing out may cause
7035 malfunctioning cursor keys. If both options are off, Vim waits
7036 forever after an entered <Esc> if there are key codes that start
7037 with <Esc>. You will have to type <Esc> twice. If you do not have
7038 problems with key codes, but would like to have :mapped key
7039 sequences not timing out in 1 second, set the 'ttimeout' option and
7040 reset the 'timeout' option.
7041
7042 NOTE: 'ttimeout' is reset when 'compatible' is set.
7043
7044 *'timeoutlen'* *'tm'*
7045'timeoutlen' 'tm' number (default 1000)
7046 global
7047 {not in all versions of Vi}
7048 *'ttimeoutlen'* *'ttm'*
7049'ttimeoutlen' 'ttm' number (default -1)
7050 global
7051 {not in Vi}
7052 The time in milliseconds that is waited for a key code or mapped key
7053 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7054 when part of a command has been typed.
7055 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7056 different timeout value for key codes is desired set 'ttimeoutlen' to
7057 a non-negative number.
7058
7059 ttimeoutlen mapping delay key code delay ~
7060 < 0 'timeoutlen' 'timeoutlen'
7061 >= 0 'timeoutlen' 'ttimeoutlen'
7062
7063 The timeout only happens when the 'timeout' and 'ttimeout' options
7064 tell so. A useful setting would be >
7065 :set timeout timeoutlen=3000 ttimeoutlen=100
7066< (time out on mapping after three seconds, time out on key codes after
7067 a tenth of a second).
7068
7069 *'title'* *'notitle'*
7070'title' boolean (default off, on when title can be restored)
7071 global
7072 {not in Vi}
7073 {not available when compiled without the |+title|
7074 feature}
7075 When on, the title of the window will be set to the value of
7076 'titlestring' (if it is not empty), or to:
7077 filename [+=-] (path) - VIM
7078 Where:
7079 filename the name of the file being edited
7080 - indicates the file cannot be modified, 'ma' off
7081 + indicates the file was modified
7082 = indicates the file is read-only
7083 =+ indicates the file is read-only and modified
7084 (path) is the path of the file being edited
7085 - VIM the server name |v:servername| or "VIM"
7086 Only works if the terminal supports setting window titles
7087 (currently Amiga console, Win32 console, all GUI versions and
7088 terminals with a non- empty 't_ts' option - these are Unix xterm and
7089 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7090 *X11*
7091 When Vim was compiled with HAVE_X11 defined, the original title will
7092 be restored if possible. The output of ":version" will include "+X11"
7093 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7094 works for the icon name |'icon'|.
7095 But: When Vim was started with the |-X| argument, restoring the title
7096 will not work (except in the GUI).
7097 If the title cannot be restored, it is set to the value of 'titleold'.
7098 You might want to restore the title outside of Vim then.
7099 When using an xterm from a remote machine you can use this command:
7100 rsh machine_name xterm -display $DISPLAY &
7101 then the WINDOWID environment variable should be inherited and the
7102 title of the window should change back to what it should be after
7103 exiting Vim.
7104
7105 *'titlelen'*
7106'titlelen' number (default 85)
7107 global
7108 {not in Vi}
7109 {not available when compiled without the |+title|
7110 feature}
7111 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007112 title. When the title is longer, only the end of the path name is
7113 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 Using a percentage makes this adapt to the width of the window. But
7115 it won't work perfectly, because the actual number of characters
7116 available also depends on the font used and other things in the title
7117 bar. When 'titlelen' is zero the full path is used. Otherwise,
7118 values from 1 to 30000 percent can be used.
7119 'titlelen' is also used for the 'titlestring' option.
7120
7121 *'titleold'*
7122'titleold' string (default "Thanks for flying Vim")
7123 global
7124 {not in Vi}
7125 {only available when compiled with the |+title|
7126 feature}
7127 This option will be used for the window title when exiting Vim if the
7128 original title cannot be restored. Only happens if 'title' is on or
7129 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007130 This option cannot be set from a |modeline| or in the |sandbox|, for
7131 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007132 *'titlestring'*
7133'titlestring' string (default "")
7134 global
7135 {not in Vi}
7136 {not available when compiled without the |+title|
7137 feature}
7138 When this option is not empty, it will be used for the title of the
7139 window. This happens only when the 'title' option is on.
7140 Only works if the terminal supports setting window titles (currently
7141 Amiga console, Win32 console, all GUI versions and terminals with a
7142 non-empty 't_ts' option).
7143 When Vim was compiled with HAVE_X11 defined, the original title will
7144 be restored if possible |X11|.
7145 When this option contains printf-style '%' items, they will be
7146 expanded according to the rules used for 'statusline'.
7147 Example: >
7148 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7149 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7150< The value of 'titlelen' is used to align items in the middle or right
7151 of the available space.
7152 Some people prefer to have the file name first: >
7153 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7154< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007155 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 separating space only when needed.
7157 NOTE: Use of special characters in 'titlestring' may cause the display
7158 to be garbled (e.g., when it contains a CR or NL character).
7159 {not available when compiled without the |+statusline| feature}
7160
7161 *'toolbar'* *'tb'*
7162'toolbar' 'tb' string (default "icons,tooltips")
7163 global
7164 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7165 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007166 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007167 possible values are:
7168 icons Toolbar buttons are shown with icons.
7169 text Toolbar buttons shown with text.
7170 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007171 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 tooltips Tooltips are active for toolbar buttons.
7173 Tooltips refer to the popup help text which appears after the mouse
7174 cursor is placed over a toolbar button for a brief moment.
7175
7176 If you want the toolbar to be shown with icons as well as text, do the
7177 following: >
7178 :set tb=icons,text
7179< Motif and Athena cannot display icons and text at the same time. They
7180 will show icons if both are requested.
7181
7182 If none of the strings specified in 'toolbar' are valid or if
7183 'toolbar' is empty, this option is ignored. If you want to disable
7184 the toolbar, you need to set the 'guioptions' option. For example: >
7185 :set guioptions-=T
7186< Also see |gui-toolbar|.
7187
7188 *'toolbariconsize'* *'tbis'*
7189'toolbariconsize' 'tbis' string (default "small")
7190 global
7191 {not in Vi}
7192 {only in the GTK+ 2 GUI}
7193 Controls the size of toolbar icons. The possible values are:
7194 tiny Use tiny toolbar icons.
7195 small Use small toolbar icons (default).
7196 medium Use medium-sized toolbar icons.
7197 large Use large toolbar icons.
7198 The exact dimensions in pixels of the various icon sizes depend on
7199 the current theme. Common dimensions are large=32x32, medium=24x24,
7200 small=20x20 and tiny=16x16.
7201
7202 If 'toolbariconsize' is empty, the global default size as determined
7203 by user preferences or the current theme is used.
7204
7205 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7206'ttybuiltin' 'tbi' boolean (default on)
7207 global
7208 {not in Vi}
7209 When on, the builtin termcaps are searched before the external ones.
7210 When off the builtin termcaps are searched after the external ones.
7211 When this option is changed, you should set the 'term' option next for
7212 the change to take effect, for example: >
7213 :set notbi term=$TERM
7214< See also |termcap|.
7215 Rationale: The default for this option is "on", because the builtin
7216 termcap entries are generally better (many systems contain faulty
7217 xterm entries...).
7218
7219 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7220'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7221 sun-cmd, screen, rxvt, dtterm or
7222 iris-ansi; also on when running Vim in
7223 a DOS console)
7224 global
7225 {not in Vi}
7226 Indicates a fast terminal connection. More characters will be sent to
7227 the screen for redrawing, instead of using insert/delete line
7228 commands. Improves smoothness of redrawing when there are multiple
7229 windows and the terminal does not support a scrolling region.
7230 Also enables the extra writing of characters at the end of each screen
7231 line for lines that wrap. This helps when using copy/paste with the
7232 mouse in an xterm and other terminals.
7233
7234 *'ttymouse'* *'ttym'*
7235'ttymouse' 'ttym' string (default depends on 'term')
7236 global
7237 {not in Vi}
7238 {only in Unix and VMS, doesn't work in the GUI; not
7239 available when compiled without |+mouse|}
7240 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007241 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242 *xterm-mouse*
7243 xterm xterm-like mouse handling. The mouse generates
7244 "<Esc>[Mscr", where "scr" is three bytes:
7245 "s" = button state
7246 "c" = column plus 33
7247 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007248 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007249 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007250 xterm2 Works like "xterm", but with the xterm reporting the
7251 mouse position while the mouse is dragged. This works
7252 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007253 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254 work. See below for how Vim detects this
7255 automatically.
7256 *netterm-mouse*
7257 netterm NetTerm mouse handling. The mouse generates
7258 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7259 for the row and column.
7260 *dec-mouse*
7261 dec DEC terminal mouse handling. The mouse generates a
7262 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007263 This is also available for an Xterm, if it was
7264 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265 *jsbterm-mouse*
7266 jsbterm JSB term mouse handling.
7267 *pterm-mouse*
7268 pterm QNX pterm mouse handling.
7269
7270 The mouse handling must be enabled at compile time |+mouse_xterm|
7271 |+mouse_dec| |+mouse_netterm|.
7272 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7273 recognized, if enabled at compile time. DEC terminal mouse codes
7274 are recognized if enabled at compile time, and 'ttymouse' is not
7275 "xterm" (because the xterm and dec mouse codes conflict).
7276 This option is automatically set to "xterm", when the 'term' option is
7277 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7278 or "xterm2" already. The main use of this option is to set it to
7279 "xterm", when the terminal name doesn't start with "xterm", but it can
7280 handle xterm mouse codes.
7281 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007282 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283 feature and if |t_RV| is set to the escape sequence to request the
7284 xterm version number. Otherwise "xterm2" must be set explicitly.
7285 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7286 t_RV to an empty string: >
7287 :set t_RV=
7288<
7289 *'ttyscroll'* *'tsl'*
7290'ttyscroll' 'tsl' number (default 999)
7291 global
7292 Maximum number of lines to scroll the screen. If there are more lines
7293 to scroll the window is redrawn. For terminals where scrolling is
7294 very slow and redrawing is not slow this can be set to a small number,
7295 e.g., 3, to speed up displaying.
7296
7297 *'ttytype'* *'tty'*
7298'ttytype' 'tty' string (default from $TERM)
7299 global
7300 Alias for 'term', see above.
7301
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007302 *'undodir'* *'udir'*
7303'undodir' 'udir' string (default ".")
7304 global
7305 {not in Vi}
7306 {only when compiled with the +persistent_undo feature}
7307 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007308 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007309 "." means using the directory of the file. The undo file name for
7310 "file.txt" is ".file.txt.un~".
7311 For other directories the file name is the full path of the edited
7312 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007313 When writing: The first directory that exists is used. "." always
7314 works, no directories after "." will be used for writing.
7315 When reading all entries are tried to find an undo file. The first
7316 undo file that exists is used. When it cannot be read an error is
7317 given, no further entry is used.
7318 See |undo-persistence|.
7319
7320 *'undofile'* *'udf'*
7321'undofile' 'udf' boolean (default off)
7322 local to buffer
7323 {not in Vi}
7324 {only when compiled with the +persistent_undo feature}
7325 When on, Vim automatically saves undo history to an undo file when
7326 writing a buffer to a file, and restores undo history from the same
7327 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007328 The directory where the undo file is stored is specified by 'undodir'.
7329 For more information about this feature see |undo-persistence|.
7330 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007331
Bram Moolenaar071d4272004-06-13 20:20:40 +00007332 *'undolevels'* *'ul'*
7333'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7334 Win32 and OS/2)
7335 global
7336 {not in Vi}
7337 Maximum number of changes that can be undone. Since undo information
7338 is kept in memory, higher numbers will cause more memory to be used
7339 (nevertheless, a single change can use an unlimited amount of memory).
7340 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7341 itself: >
7342 set ul=0
7343< But you can also get Vi compatibility by including the 'u' flag in
7344 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007345 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346 Set to a negative number for no undo at all: >
7347 set ul=-1
7348< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007349 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007350
7351 *'updatecount'* *'uc'*
7352'updatecount' 'uc' number (default: 200)
7353 global
7354 {not in Vi}
7355 After typing this many characters the swap file will be written to
7356 disk. When zero, no swap file will be created at all (see chapter on
7357 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7358 Vim with the "-n" option, see |startup|. When editing in readonly
7359 mode this option will be initialized to 10000.
7360 The swapfile can be disabled per buffer with |'swapfile'|.
7361 When 'updatecount' is set from zero to non-zero, swap files are
7362 created for all buffers that have 'swapfile' set. When 'updatecount'
7363 is set to zero, existing swap files are not deleted.
7364 Also see |'swapsync'|.
7365 This option has no meaning in buffers where |'buftype'| is "nofile"
7366 or "nowrite".
7367
7368 *'updatetime'* *'ut'*
7369'updatetime' 'ut' number (default 4000)
7370 global
7371 {not in Vi}
7372 If this many milliseconds nothing is typed the swap file will be
7373 written to disk (see |crash-recovery|). Also used for the
7374 |CursorHold| autocommand event.
7375
7376 *'verbose'* *'vbs'*
7377'verbose' 'vbs' number (default 0)
7378 global
7379 {not in Vi, although some versions have a boolean
7380 verbose option}
7381 When bigger than zero, Vim will give messages about what it is doing.
7382 Currently, these messages are given:
7383 >= 1 When the viminfo file is read or written.
7384 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007385 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007386 >= 8 Files for which a group of autocommands is executed.
7387 >= 9 Every executed autocommand.
7388 >= 12 Every executed function.
7389 >= 13 When an exception is thrown, caught, finished, or discarded.
7390 >= 14 Anything pending in a ":finally" clause.
7391 >= 15 Every executed Ex command (truncated at 200 characters).
7392
7393 This option can also be set with the "-V" argument. See |-V|.
7394 This option is also set by the |:verbose| command.
7395
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007396 When the 'verbosefile' option is set then the verbose messages are not
7397 displayed.
7398
7399 *'verbosefile'* *'vfile'*
7400'verbosefile' 'vfile' string (default empty)
7401 global
7402 {not in Vi}
7403 When not empty all messages are written in a file with this name.
7404 When the file exists messages are appended.
7405 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007406 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007407 Setting 'verbosefile' to a new value is like making it empty first.
7408 The difference with |:redir| is that verbose messages are not
7409 displayed when 'verbosefile' is set.
7410
Bram Moolenaar071d4272004-06-13 20:20:40 +00007411 *'viewdir'* *'vdir'*
7412'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7413 "$VIM/vimfiles/view",
7414 for Unix: "~/.vim/view",
7415 for Macintosh: "$VIM:vimfiles:view"
7416 for VMS: "sys$login:vimfiles/view"
7417 for RiscOS: "Choices:vimfiles/view")
7418 global
7419 {not in Vi}
7420 {not available when compiled without the +mksession
7421 feature}
7422 Name of the directory where to store files for |:mkview|.
7423 This option cannot be set from a |modeline| or in the |sandbox|, for
7424 security reasons.
7425
7426 *'viewoptions'* *'vop'*
7427'viewoptions' 'vop' string (default: "folds,options,cursor")
7428 global
7429 {not in Vi}
7430 {not available when compiled without the +mksession
7431 feature}
7432 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007433 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434 word save and restore ~
7435 cursor cursor position in file and in window
7436 folds manually created folds, opened/closed folds and local
7437 fold options
7438 options options and mappings local to a window or buffer (not
7439 global values for local options)
7440 slash backslashes in file names replaced with forward
7441 slashes
7442 unix with Unix end-of-line format (single <NL>), even when
7443 on Windows or DOS
7444
7445 "slash" and "unix" are useful on Windows when sharing view files
7446 with Unix. The Unix version of Vim cannot source dos format scripts,
7447 but the Windows version of Vim can source unix format scripts.
7448
7449 *'viminfo'* *'vi'* *E526* *E527* *E528*
7450'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007451 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7452 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7453 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454 global
7455 {not in Vi}
7456 {not available when compiled without the |+viminfo|
7457 feature}
7458 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007459 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460 separated list of parameters, each consisting of a single character
7461 identifying the particular parameter, followed by a number or string
7462 which specifies the value of that parameter. If a particular
7463 character is left out, then the default value is used for that
7464 parameter. The following is a list of the identifying characters and
7465 the effect of their value.
7466 CHAR VALUE ~
7467 ! When included, save and restore global variables that start
7468 with an uppercase letter, and don't contain a lowercase
7469 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007470 and "_K_L_M" are not. Only String and Number types are
7471 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007472 " Maximum number of lines saved for each register. Old name of
7473 the '<' item, with the disadvantage that you need to put a
7474 backslash before the ", otherwise it will be recognized as the
7475 start of a comment!
7476 % When included, save and restore the buffer list. If Vim is
7477 started with a file name argument, the buffer list is not
7478 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007479 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007480 without a file name and buffers for help files are not written
7481 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007482 When followed by a number, the number specifies the maximum
7483 number of buffers that are stored. Without a number all
7484 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 ' Maximum number of previously edited files for which the marks
7486 are remembered. This parameter must always be included when
7487 'viminfo' is non-empty.
7488 Including this item also means that the |jumplist| and the
7489 |changelist| are stored in the viminfo file.
7490 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007491 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492 patterns are also saved. When not included, the value of
7493 'history' is used.
7494 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007495 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 < Maximum number of lines saved for each register. If zero then
7497 registers are not saved. When not included, all lines are
7498 saved. '"' is the old name for this item.
7499 Also see the 's' item below: limit specified in Kbyte.
7500 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007501 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502 c When included, convert the text in the viminfo file from the
7503 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007504 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 f Whether file marks need to be stored. If zero, file marks ('0
7506 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007507 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 cursor position (when exiting or when doing ":wviminfo").
7509 h Disable the effect of 'hlsearch' when loading the viminfo
7510 file. When not included, it depends on whether ":nohlsearch"
7511 has been used since the last search command.
7512 n Name of the viminfo file. The name must immediately follow
7513 the 'n'. Must be the last one! If the "-i" argument was
7514 given when starting Vim, that file name overrides the one
7515 given here with 'viminfo'. Environment variables are expanded
7516 when opening the file, not when setting the option.
7517 r Removable media. The argument is a string (up to the next
7518 ','). This parameter can be given several times. Each
7519 specifies the start of a path for which no marks will be
7520 stored. This is to avoid removable media. For MS-DOS you
7521 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7522 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7523 ignored. Maximum length of each 'r' argument is 50
7524 characters.
7525 s Maximum size of an item in Kbyte. If zero then registers are
7526 not saved. Currently only applies to registers. The default
7527 "s10" will exclude registers with more than 10 Kbyte of text.
7528 Also see the '<' item above: line count limit.
7529
7530 Example: >
7531 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7532<
7533 '50 Marks will be remembered for the last 50 files you
7534 edited.
7535 <1000 Contents of registers (up to 1000 lines each) will be
7536 remembered.
7537 s100 Registers with more than 100 Kbyte text are skipped.
7538 :0 Command-line history will not be saved.
7539 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7540 no / Since '/' is not specified, the default will be used,
7541 that is, save all of the search history, and also the
7542 previous search and substitute patterns.
7543 no % The buffer list will not be saved nor read back.
7544 no h 'hlsearch' highlighting will be restored.
7545
7546 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7547 load the contents of the file, this is not done automatically.
7548
7549 This option cannot be set from a |modeline| or in the |sandbox|, for
7550 security reasons.
7551
7552 *'virtualedit'* *'ve'*
7553'virtualedit' 've' string (default "")
7554 global
7555 {not in Vi}
7556 {not available when compiled without the
7557 |+virtualedit| feature}
7558 A comma separated list of these words:
7559 block Allow virtual editing in Visual block mode.
7560 insert Allow virtual editing in Insert mode.
7561 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007562 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007563
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007565 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 of the line. Useful for selecting a rectangle in Visual mode and
7567 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007568 "onemore" is not the same, it will only allow moving the cursor just
7569 after the last character of the line. This makes some commands more
7570 consistent. Previously the cursor was always past the end of the line
7571 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007572 break some plugins or Vim scripts. For example because |l| can move
7573 the cursor after the last character. Use with care!
7574 Using the |$| command will move to the last character in the line, not
7575 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007576 It doesn't make sense to combine "all" with "onemore", but you will
7577 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578
7579 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7580'visualbell' 'vb' boolean (default off)
7581 global
7582 {not in Vi}
7583 Use visual bell instead of beeping. The terminal code to display the
7584 visual bell is given with 't_vb'. When no beep or flash is wanted,
7585 use ":set vb t_vb=".
7586 Note: When the GUI starts, 't_vb' is reset to its default value. You
7587 might want to set it again in your |gvimrc|.
7588 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7589 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7590 where 40 is the time in msec.
7591 Does not work on the Amiga, you always get a screen flash.
7592 Also see 'errorbells'.
7593
7594 *'warn'* *'nowarn'*
7595'warn' boolean (default on)
7596 global
7597 Give a warning message when a shell command is used while the buffer
7598 has been changed.
7599
7600 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7601'weirdinvert' 'wiv' boolean (default off)
7602 global
7603 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007604 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007605 It is provided for backwards compatibility with version 4.x.
7606 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7607 vice versa. Has no effect when the GUI is running.
7608
7609 *'whichwrap'* *'ww'*
7610'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7611 global
7612 {not in Vi}
7613 Allow specified keys that move the cursor left/right to move to the
7614 previous/next line when the cursor is on the first/last character in
7615 the line. Concatenate characters to allow this for these keys:
7616 char key mode ~
7617 b <BS> Normal and Visual
7618 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007619 h "h" Normal and Visual (not recommended)
7620 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007621 < <Left> Normal and Visual
7622 > <Right> Normal and Visual
7623 ~ "~" Normal
7624 [ <Left> Insert and Replace
7625 ] <Right> Insert and Replace
7626 For example: >
7627 :set ww=<,>,[,]
7628< allows wrap only when cursor keys are used.
7629 When the movement keys are used in combination with a delete or change
7630 operator, the <EOL> also counts for a character. This makes "3h"
7631 different from "3dh" when the cursor crosses the end of a line. This
7632 is also true for "x" and "X", because they do the same as "dl" and
7633 "dh". If you use this, you may also want to use the mapping
7634 ":map <BS> X" to make backspace delete the character in front of the
7635 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007636 When 'l' is included and it is used after an operator at the end of a
7637 line then it will not move to the next line. This makes "dl", "cl",
7638 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639 NOTE: This option is set to the Vi default value when 'compatible' is
7640 set and to the Vim default value when 'compatible' is reset.
7641
7642 *'wildchar'* *'wc'*
7643'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7644 global
7645 {not in Vi}
7646 Character you have to type to start wildcard expansion in the
7647 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007648 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 The character is not recognized when used inside a macro. See
7650 'wildcharm' for that.
7651 Although 'wc' is a number option, you can set it to a special key: >
7652 :set wc=<Esc>
7653< NOTE: This option is set to the Vi default value when 'compatible' is
7654 set and to the Vim default value when 'compatible' is reset.
7655
7656 *'wildcharm'* *'wcm'*
7657'wildcharm' 'wcm' number (default: none (0))
7658 global
7659 {not in Vi}
7660 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007661 recognized when used inside a macro. You can find "spare" command-line
7662 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007663 you'll never actually type 'wildcharm', just use it in mappings that
7664 automatically invoke completion mode, e.g.: >
7665 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007666 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667< Then after typing :ss you can use CTRL-P & CTRL-N.
7668
7669 *'wildignore'* *'wig'*
7670'wildignore' 'wig' string (default "")
7671 global
7672 {not in Vi}
7673 {not available when compiled without the |+wildignore|
7674 feature}
7675 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007676 patterns is ignored when completing file or directory names, and
7677 influences the result of |expand()|, |glob()| and |globpath()| unless
7678 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007679 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7680 Also see 'suffixes'.
7681 Example: >
7682 :set wildignore=*.o,*.obj
7683< The use of |:set+=| and |:set-=| is preferred when adding or removing
7684 a pattern from the list. This avoids problems when a future version
7685 uses another default.
7686
7687 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7688'wildmenu' 'wmnu' boolean (default off)
7689 global
7690 {not in Vi}
7691 {not available if compiled without the |+wildmenu|
7692 feature}
7693 When 'wildmenu' is on, command-line completion operates in an enhanced
7694 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7695 the possible matches are shown just above the command line, with the
7696 first match highlighted (overwriting the status line, if there is
7697 one). Keys that show the previous/next match, such as <Tab> or
7698 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7699 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7700 specified. "longest" and "list" do not start "wildmenu" mode.
7701 If there are more matches than can fit in the line, a ">" is shown on
7702 the right and/or a "<" is shown on the left. The status line scrolls
7703 as needed.
7704 The "wildmenu" mode is abandoned when a key is hit that is not used
7705 for selecting a completion.
7706 While the "wildmenu" is active the following keys have special
7707 meanings:
7708
7709 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7710 <Down> - in filename/menu name completion: move into a
7711 subdirectory or submenu.
7712 <CR> - in menu completion, when the cursor is just after a
7713 dot: move into a submenu.
7714 <Up> - in filename/menu name completion: move up into
7715 parent directory or parent menu.
7716
7717 This makes the menus accessible from the console |console-menus|.
7718
7719 If you prefer the <Left> and <Right> keys to move the cursor instead
7720 of selecting a different match, use this: >
7721 :cnoremap <Left> <Space><BS><Left>
7722 :cnoremap <Right> <Space><BS><Right>
7723<
7724 The "WildMenu" highlighting is used for displaying the current match
7725 |hl-WildMenu|.
7726
7727 *'wildmode'* *'wim'*
7728'wildmode' 'wim' string (Vim default: "full")
7729 global
7730 {not in Vi}
7731 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007732 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007733 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734 first part specifies the behavior for the first use of 'wildchar',
7735 The second part for the second use, etc.
7736 These are the possible values for each part:
7737 "" Complete only the first match.
7738 "full" Complete the next full match. After the last match,
7739 the original string is used and then the first match
7740 again.
7741 "longest" Complete till longest common string. If this doesn't
7742 result in a longer string, use the next part.
7743 "longest:full" Like "longest", but also start 'wildmenu' if it is
7744 enabled.
7745 "list" When more than one match, list all matches.
7746 "list:full" When more than one match, list all matches and
7747 complete first match.
7748 "list:longest" When more than one match, list all matches and
7749 complete till longest common string.
7750 When there is only a single match, it is fully completed in all cases.
7751
7752 Examples: >
7753 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007754< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 :set wildmode=longest,full
7756< Complete longest common string, then each full match >
7757 :set wildmode=list:full
7758< List all matches and complete each full match >
7759 :set wildmode=list,full
7760< List all matches without completing, then each full match >
7761 :set wildmode=longest,list
7762< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007763 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007764
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007765 *'wildoptions'* *'wop'*
7766'wildoptions' 'wop' string (default "")
7767 global
7768 {not in Vi}
7769 {not available when compiled without the |+wildignore|
7770 feature}
7771 A list of words that change how command line completion is done.
7772 Currently only one word is allowed:
7773 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007774 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007775 is displayed per line. Often used tag kinds are:
7776 d #define
7777 f function
7778 Also see |cmdline-completion|.
7779
Bram Moolenaar071d4272004-06-13 20:20:40 +00007780 *'winaltkeys'* *'wak'*
7781'winaltkeys' 'wak' string (default "menu")
7782 global
7783 {not in Vi}
7784 {only used in Win32, Motif, GTK and Photon GUI}
7785 Some GUI versions allow the access to menu entries by using the ALT
7786 key in combination with a character that appears underlined in the
7787 menu. This conflicts with the use of the ALT key for mappings and
7788 entering special characters. This option tells what to do:
7789 no Don't use ALT keys for menus. ALT key combinations can be
7790 mapped, but there is no automatic handling. This can then be
7791 done with the |:simalt| command.
7792 yes ALT key handling is done by the windowing system. ALT key
7793 combinations cannot be mapped.
7794 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007795 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007796 keys can be mapped.
7797 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7798 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007799 This option is not used for <F10>; on Win32 and with GTK <F10> will
7800 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007801
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007802 *'window'* *'wi'*
7803'window' 'wi' number (default screen height - 1)
7804 global
7805 Window height. Do not confuse this with the height of the Vim window,
7806 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007807 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7808 value is smaller than 'lines' minus one. The screen will scroll
7809 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007810 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7811 in a much smarter way, taking care of wrapping lines.
7812 When resizing the Vim window, the value is smaller than 1 or more than
7813 or equal to 'lines' it will be set to 'lines' minus 1.
7814 {Vi also uses the option to specify the number of displayed lines}
7815
Bram Moolenaar071d4272004-06-13 20:20:40 +00007816 *'winheight'* *'wh'* *E591*
7817'winheight' 'wh' number (default 1)
7818 global
7819 {not in Vi}
7820 {not available when compiled without the +windows
7821 feature}
7822 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007823 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007824 focus goes to a window that is smaller, its size is increased, at the
7825 cost of the height of other windows.
7826 Set 'winheight' to a small number for normal editing.
7827 Set it to 999 to make the current window fill most of the screen.
7828 Other windows will be only 'winminheight' high. This has the drawback
7829 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7830 to create only two windows, set the option after startup is done,
7831 using the |VimEnter| event: >
7832 au VimEnter * set winheight=999
7833< Minimum value is 1.
7834 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835 height of the current window.
7836 'winheight' applies to the current window. Use 'winminheight' to set
7837 the minimal height for other windows.
7838
7839 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7840'winfixheight' 'wfh' boolean (default off)
7841 local to window
7842 {not in Vi}
7843 {not available when compiled without the +windows
7844 feature}
7845 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007846 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7847 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 The height may be changed anyway when running out of room.
7849
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007850 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7851'winfixwidth' 'wfw' boolean (default off)
7852 local to window
7853 {not in Vi}
7854 {not available when compiled without the +windows
7855 feature}
7856 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007857 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007858 The width may be changed anyway when running out of room.
7859
Bram Moolenaar071d4272004-06-13 20:20:40 +00007860 *'winminheight'* *'wmh'*
7861'winminheight' 'wmh' number (default 1)
7862 global
7863 {not in Vi}
7864 {not available when compiled without the +windows
7865 feature}
7866 The minimal height of a window, when it's not the current window.
7867 This is a hard minimum, windows will never become smaller.
7868 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7869 status bar) if necessary. They will return to at least one line when
7870 they become active (since the cursor has to have somewhere to go.)
7871 Use 'winheight' to set the minimal height of the current window.
7872 This option is only checked when making a window smaller. Don't use a
7873 large number, it will cause errors when opening more than a few
7874 windows. A value of 0 to 3 is reasonable.
7875
7876 *'winminwidth'* *'wmw'*
7877'winminwidth' 'wmw' number (default 1)
7878 global
7879 {not in Vi}
7880 {not available when compiled without the +vertsplit
7881 feature}
7882 The minimal width of a window, when it's not the current window.
7883 This is a hard minimum, windows will never become smaller.
7884 When set to zero, windows may be "squashed" to zero columns (i.e. just
7885 a vertical separator) if necessary. They will return to at least one
7886 line when they become active (since the cursor has to have somewhere
7887 to go.)
7888 Use 'winwidth' to set the minimal width of the current window.
7889 This option is only checked when making a window smaller. Don't use a
7890 large number, it will cause errors when opening more than a few
7891 windows. A value of 0 to 12 is reasonable.
7892
7893 *'winwidth'* *'wiw'* *E592*
7894'winwidth' 'wiw' number (default 20)
7895 global
7896 {not in Vi}
7897 {not available when compiled without the +vertsplit
7898 feature}
7899 Minimal number of columns for the current window. This is not a hard
7900 minimum, Vim will use fewer columns if there is not enough room. If
7901 the current window is smaller, its size is increased, at the cost of
7902 the width of other windows. Set it to 999 to make the current window
7903 always fill the screen. Set it to a small number for normal editing.
7904 The width is not adjusted after one of the commands to change the
7905 width of the current window.
7906 'winwidth' applies to the current window. Use 'winminwidth' to set
7907 the minimal width for other windows.
7908
7909 *'wrap'* *'nowrap'*
7910'wrap' boolean (default on)
7911 local to window
7912 {not in Vi}
7913 This option changes how text is displayed. It doesn't change the text
7914 in the buffer, see 'textwidth' for that.
7915 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007916 displaying continues on the next line. When off lines will not wrap
7917 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 moved to a part that is not shown, the screen will scroll
7919 horizontally.
7920 The line will be broken in the middle of a word if necessary. See
7921 'linebreak' to get the break at a word boundary.
7922 To make scrolling horizontally a bit more useful, try this: >
7923 :set sidescroll=5
7924 :set listchars+=precedes:<,extends:>
7925< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007926 This option can't be set from a |modeline| when the 'diff' option is
7927 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007928
7929 *'wrapmargin'* *'wm'*
7930'wrapmargin' 'wm' number (default 0)
7931 local to buffer
7932 Number of characters from the right window border where wrapping
7933 starts. When typing text beyond this limit, an <EOL> will be inserted
7934 and inserting continues on the next line.
7935 Options that add a margin, such as 'number' and 'foldcolumn', cause
7936 the text width to be further reduced. This is Vi compatible.
7937 When 'textwidth' is non-zero, this option is not used.
7938 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7939 and less usefully}
7940
7941 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7942'wrapscan' 'ws' boolean (default on) *E384* *E385*
7943 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007944 Searches wrap around the end of the file. Also applies to |]s| and
7945 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946
7947 *'write'* *'nowrite'*
7948'write' boolean (default on)
7949 global
7950 {not in Vi}
7951 Allows writing files. When not set, writing a file is not allowed.
7952 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007953 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 argument. Filtering text is still possible, even though this requires
7955 writing a temporary file.
7956
7957 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7958'writeany' 'wa' boolean (default off)
7959 global
7960 Allows writing to any file with no need for "!" override.
7961
7962 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7963'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7964 otherwise)
7965 global
7966 {not in Vi}
7967 Make a backup before overwriting a file. The backup is removed after
7968 the file was successfully written, unless the 'backup' option is
7969 also on. Reset this option if your file system is almost full. See
7970 |backup-table| for another explanation.
7971 When the 'backupskip' pattern matches, a backup is not made anyway.
7972 NOTE: This option is set to the default value when 'compatible' is
7973 set.
7974
7975 *'writedelay'* *'wd'*
7976'writedelay' 'wd' number (default 0)
7977 global
7978 {not in Vi}
7979 The number of microseconds to wait for each character sent to the
7980 screen. When non-zero, characters are sent to the terminal one by
7981 one. For MS-DOS pcterm this does not work. For debugging purposes.
7982
7983 vim:tw=78:ts=8:ft=help:norl: