blob: 763dab17802ecbfdecc8bc027873afe17bde7610 [file] [log] [blame]
Bram Moolenaar8bb1c3e2014-07-04 16:43:17 +02001*options.txt* For Vim version 7.4. Last change: 2014 Jun 26
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 Moolenaardb84e452010-08-15 13:50:43 +0200140{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141
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 Moolenaar0b2f94d2011-03-22 14:35:05 +0100153You can define any key codes, e.g.: >
154 :set t_xy=^[foo;
155There is no warning for using a name that isn't recognized. You can map these
156codes as you like: >
157 :map <t_xy> something
158< *E846*
159When a key code is not set, it's like it does not exist. Trying to get its
160value will result in an error: >
161 :set t_kb=
162 :set t_kb
163 E846: Key code not set: t_kb
164
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000165The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
166security reasons.
167
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000169at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170"set all" probably does not fit on the screen, causing Vim to give the
171|more-prompt|.
172
173 *option-backslash*
174To include white space in a string option value it has to be preceded with a
175backslash. To include a backslash you have to use two. Effectively this
176means that the number of backslashes in an option value is halved (rounded
177down).
178A few examples: >
179 :set tags=tags\ /usr/tags results in "tags /usr/tags"
180 :set tags=tags\\,file results in "tags\,file"
181 :set tags=tags\\\ file results in "tags\ file"
182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000183The "|" character separates a ":set" command from a following command. To
184include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185'titlestring' option to "hi|there": >
186 :set titlestring=hi\|there
187This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
188 :set titlestring=hi|set iconstring=there
189
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000190Similarly, the double quote character starts a comment. To include the '"' in
191the option value, use '\"' instead. This example sets the 'titlestring'
192option to 'hi "there"': >
193 :set titlestring=hi\ \"there\"
194
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000195For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196precise: For options that expect a file name (those where environment
197variables are expanded) a backslash before a normal file name character is not
198removed. But a backslash before a special character (space, backslash, comma,
199etc.) is used like explained above.
200There is one special situation, when the value starts with "\\": >
201 :set dir=\\machine\path results in "\\machine\path"
202 :set dir=\\\\machine\\path results in "\\machine\path"
203 :set dir=\\path\\file results in "\\path\file" (wrong!)
204For the first one the start is kept, but for the second one the backslashes
205are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000206halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207result which is probably not what you want. Avoid it.
208
209 *add-option-flags* *remove-option-flags*
210 *E539* *E550* *E551* *E552*
211Some options are a list of flags. When you want to add a flag to such an
212option, without changing the existing ones, you can do it like this: >
213 :set guioptions+=a
214Remove a flag from an option like this: >
215 :set guioptions-=a
216This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000217Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
219doesn't appear.
220
221 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000222Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000223environment variable exists the '$' and the following environment variable
224name is replaced with its value. If it does not exist the '$' and the name
225are not modified. Any non-id character (not a letter, digit or '_') may
226follow the environment variable name. That character and what follows is
227appended to the value of the environment variable. Examples: >
228 :set term=$TERM.new
229 :set path=/usr/$INCLUDE,$HOME/include,.
230When adding or removing a string from an option with ":set opt-=val" or ":set
231opt+=val" the expansion is done before the adding or removing.
232
233
234Handling of local options *local-options*
235
236Some of the options only apply to a window or buffer. Each window or buffer
237has its own copy of this option, thus can each have their own value. This
238allows you to set 'list' in one window but not in another. And set
239'shiftwidth' to 3 in one buffer and 4 in another.
240
241The following explains what happens to these local options in specific
242situations. You don't really need to know all of this, since Vim mostly uses
243the option values you would expect. Unfortunately, doing what the user
244expects is a bit complicated...
245
246When splitting a window, the local options are copied to the new window. Thus
247right after the split the contents of the two windows look the same.
248
249When editing a new buffer, its local option values must be initialized. Since
250the local options of the current buffer might be specifically for that buffer,
251these are not used. Instead, for each buffer-local option there also is a
252global value, which is used for new buffers. With ":set" both the local and
253global value is changed. With "setlocal" only the local value is changed,
254thus this value is not used when editing a new buffer.
255
256When editing a buffer that has been edited before, the last used window
257options are used again. If this buffer has been edited in this window, the
258values from back then are used. Otherwise the values from the window where
259the buffer was edited last are used.
260
261It's possible to set a local window option specifically for a type of buffer.
262When you edit another buffer in the same window, you don't want to keep
263using these local window options. Therefore Vim keeps a global value of the
264local window options, which is used when editing another buffer. Each window
265has its own copy of these values. Thus these are local to the window, but
266global to all buffers in the window. With this you can do: >
267 :e one
268 :set list
269 :e two
270Now the 'list' option will also be set in "two", since with the ":set list"
271command you have also set the global value. >
272 :set nolist
273 :e one
274 :setlocal list
275 :e two
276Now the 'list' option is not set, because ":set nolist" resets the global
277value, ":setlocal list" only changes the local value and ":e two" gets the
278global value. Note that if you do this next: >
279 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200280You will get back the 'list' value as it was the last time you edited "one".
281The options local to a window are remembered for each buffer. This also
282happens when the buffer is not loaded, but they are lost when the buffer is
283wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000284
285 *:setl* *:setlocal*
286:setl[ocal] ... Like ":set" but set only the value local to the
287 current buffer or window. Not all options have a
288 local value. If the option does not have a local
289 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200290 With the "all" argument: display local values for all
291 local options.
292 Without argument: Display local values for all local
293 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000294 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000295 local value. For a global/local boolean option, when
296 the global value is being used, "--" is displayed
297 before the option name.
298 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000299 shown (but that might change in the future).
300 {not in Vi}
301
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000302:setl[ocal] {option}< Set the local value of {option} to its global value by
303 copying the value.
304 {not in Vi}
305
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100306:se[t] {option}< For |global-local| options: Remove the local value of
307 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308 {not in Vi}
309
310 *:setg* *:setglobal*
311:setg[lobal] ... Like ":set" but set only the global value for a local
312 option without changing the local value.
313 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200314 With the "all" argument: display global values for all
315 local options.
316 Without argument: display global values for all local
317 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000318 {not in Vi}
319
320For buffer-local and window-local options:
321 Command global value local value ~
322 :set option=value set set
323 :setlocal option=value - set
324:setglobal option=value set -
325 :set option? - display
326 :setlocal option? - display
327:setglobal option? display -
328
329
330Global options with a local value *global-local*
331
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000332Options are global when you mostly use one value for all buffers and windows.
333For some global options it's useful to sometimes have a different local value.
334You can set the local value with ":setlocal". That buffer or window will then
335use the local value, while other buffers and windows continue using the global
336value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337
338For example, you have two windows, both on C source code. They use the global
339'makeprg' option. If you do this in one of the two windows: >
340 :set makeprg=gmake
341then the other window will switch to the same value. There is no need to set
342the 'makeprg' option in the other C source window too.
343However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000344another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000345files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346 :setlocal makeprg=perlmake
347You can switch back to using the global value by making the local value empty: >
348 :setlocal makeprg=
349This only works for a string option. For a boolean option you need to use the
350"<" flag, like this: >
351 :setlocal autoread<
352Note that for non-boolean options using "<" copies the global value to the
353local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000354when the global value changes later). You can also use: >
355 :set path<
356This will make the local value of 'path' empty, so that the global value is
357used. Thus it does the same as: >
358 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359Note: In the future more global options can be made global-local. Using
360":setlocal" on a global option might work differently then.
361
362
363Setting the filetype
364
365:setf[iletype] {filetype} *:setf* *:setfiletype*
366 Set the 'filetype' option to {filetype}, but only if
367 not done yet in a sequence of (nested) autocommands.
368 This is short for: >
369 :if !did_filetype()
370 : setlocal filetype={filetype}
371 :endif
372< This command is used in a filetype.vim file to avoid
373 setting the 'filetype' option twice, causing different
374 settings and syntax files to be loaded.
375 {not in Vi}
376
Bram Moolenaard58e9292011-02-09 17:07:58 +0100377 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
379:opt[ions] Open a window for viewing and setting all options.
380 Options are grouped by function.
381 Offers short help for each option. Hit <CR> on the
382 short help to open a help window with more help for
383 the option.
384 Modify the value of the option and hit <CR> on the
385 "set" line to set the new value. For window and
386 buffer specific options, the last accessed window is
387 used to set the option value in, unless this is a help
388 window, in which case the window below help window is
389 used (skipping the option-window).
390 {not available when compiled without the |+eval| or
391 |+autocmd| features}
392
393 *$HOME*
394Using "~" is like using "$HOME", but it is only recognized at the start of an
395option and after a space or comma.
396
397On Unix systems "~user" can be used too. It is replaced by the home directory
398of user "user". Example: >
399 :set path=~mool/include,/usr/include,.
400
401On Unix systems the form "${HOME}" can be used too. The name between {} can
402contain non-id characters then. Note that if you want to use this for the
403"gf" command, you need to add the '{' and '}' characters to 'isfname'.
404
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100405On MS-Windows, if $HOME is not defined as an environment variable, then
406at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
407
Bram Moolenaar071d4272004-06-13 20:20:40 +0000408NOTE: expanding environment variables and "~/" is only done with the ":set"
409command, not when assigning a value to an option with ":let".
410
411
412Note the maximum length of an expanded option is limited. How much depends on
413the system, mostly it is something like 256 or 1024 characters.
414
415 *:fix* *:fixdel*
416:fix[del] Set the value of 't_kD':
417 't_kb' is 't_kD' becomes ~
418 CTRL-? CTRL-H
419 not CTRL-? CTRL-?
420
421 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
422
423 If your delete key terminal code is wrong, but the
424 code for backspace is alright, you can put this in
425 your .vimrc: >
426 :fixdel
427< This works no matter what the actual code for
428 backspace is.
429
430 If the backspace key terminal code is wrong you can
431 use this: >
432 :if &term == "termname"
433 : set t_kb=^V<BS>
434 : fixdel
435 :endif
436< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000437 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438 with your terminal name.
439
440 If your <Delete> key sends a strange key sequence (not
441 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
442 :if &term == "termname"
443 : set t_kD=^V<Delete>
444 :endif
445< Where "^V" is CTRL-V and "<Delete>" is the delete key
446 (don't type eight characters!). Replace "termname"
447 with your terminal name.
448
449 *Linux-backspace*
450 Note about Linux: By default the backspace key
451 produces CTRL-?, which is wrong. You can fix it by
452 putting this line in your rc.local: >
453 echo "keycode 14 = BackSpace" | loadkeys
454<
455 *NetBSD-backspace*
456 Note about NetBSD: If your backspace doesn't produce
457 the right code, try this: >
458 xmodmap -e "keycode 22 = BackSpace"
459< If this works, add this in your .Xmodmap file: >
460 keysym 22 = BackSpace
461< You need to restart for this to take effect.
462
463==============================================================================
4642. Automatically setting options *auto-setting*
465
466Besides changing options with the ":set" command, there are three alternatives
467to set options automatically for one or more files:
468
4691. When starting Vim initializations are read from various places. See
470 |initialization|. Most of them are performed for all editing sessions,
471 and some of them depend on the directory where Vim is started.
472 You can create an initialization file with |:mkvimrc|, |:mkview| and
473 |:mksession|.
4742. If you start editing a new file, the automatic commands are executed.
475 This can be used to set options for files matching a particular pattern and
476 many other things. See |autocommand|.
4773. If you start editing a new file, and the 'modeline' option is on, a
478 number of lines at the beginning and end of the file are checked for
479 modelines. This is explained here.
480
481 *modeline* *vim:* *vi:* *ex:* *E520*
482There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200483 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000484
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200485[text] any text or empty
486{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200487{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200488[white] optional white space
489{options} a list of option settings, separated with white space
490 or ':', where each part between ':' is the argument
491 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492
Bram Moolenaar14b69452013-06-29 23:05:20 +0200493Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000494 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200495 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496
497The second form (this is compatible with some versions of Vi):
498
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200499 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200501[text] any text or empty
502{white} at least one blank character (<Space> or <Tab>)
503{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
504[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200505se[t] the string "set " or "se " (note the space); When
506 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200507{options} a list of options, separated with white space, which
508 is the argument for a ":set" command
509: a colon
510[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000511
Bram Moolenaar14b69452013-06-29 23:05:20 +0200512Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000513 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200514 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200516The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
517chance that a normal word like "lex:" is caught. There is one exception:
518"vi:" and "vim:" can also be at the start of the line (for compatibility with
519version 3.0). Using "ex:" at the start of the line will be ignored (this
520could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
522 *modeline-local*
523The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000524buffer and window that contain the file. Although it's possible to set global
525options from a modeline, this is unusual. If you have two windows open and
526the files in it set the same global option to a different value, the result
527depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000529When editing a file that was already loaded, only the window-local options
530from the modeline are used. Thus if you manually changed a buffer-local
531option after opening the file, it won't be changed if you edit the same buffer
532in another window. But window-local options will be set.
533
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534 *modeline-version*
535If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200536number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537 vim{vers}: version {vers} or later
538 vim<{vers}: version before {vers}
539 vim={vers}: version {vers}
540 vim>{vers}: version after {vers}
541{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000542For example, to use a modeline only for Vim 6.0 and later:
543 /* vim600: set foldmethod=marker: */ ~
544To use a modeline for Vim before version 5.7:
545 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000546There can be no blanks between "vim" and the ":".
547
548
549The number of lines that are checked can be set with the 'modelines' option.
550If 'modeline' is off or 'modelines' is 0 no lines are checked.
551
552Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000553like:
554 /* vi:ts=4: */ ~
555will give an error message for the trailing "*/". This line is OK:
556 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000557
558If an error is detected the rest of the line is skipped.
559
560If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000561backslash in front of the ':' will be removed. Example:
562 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563This sets the 'dir' option to "c:\tmp". Only a single backslash before the
564':' is removed. Thus to include "\:" you have to specify "\\:".
565
566No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000567might create a Trojan horse text file with modelines). And not all options
568can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000569|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000570causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
571are wrapped unexpectedly. So disable modelines before editing untrusted text.
572The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573
574Hint: If you would like to do something else than setting an option, you could
575define an autocommand that checks the file for a specific string. For
576example: >
577 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
578And define a function SetVar() that does something with the line containing
579"VAR".
580
581==============================================================================
5823. Options summary *option-summary*
583
584In the list below all the options are mentioned with their full name and with
585an abbreviation if there is one. Both forms may be used.
586
587In this document when a boolean option is "set" that means that ":set option"
588is entered. When an option is "reset", ":set nooption" is used.
589
590For some options there are two default values: The "Vim default", which is
591used when 'compatible' is not set, and the "Vi default", which is used when
592'compatible' is set.
593
594Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000595are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596different value in each window. For example the 'list' option can be set in
597one window and reset in another for the same text, giving both types of view
598at the same time. There are a few options that are specific to a certain
599file. These can have a different value for each file or buffer. For example
600the 'textwidth' option can be 78 for a normal text file and 0 for a C
601program.
602
603 global one option for all buffers and windows
604 local to window each window has its own copy of this option
605 local to buffer each buffer has its own copy of this option
606
607When creating a new window the option values from the currently active window
608are used as a default value for the window-specific options. For the
609buffer-specific options this depends on the 's' and 'S' flags in the
610'cpoptions' option. If 's' is included (which is the default) the values for
611buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000612first entered. If 'S' is present the options are copied each time the buffer
613is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614present, the options are copied from the currently active buffer when the
615buffer is created.
616
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000617Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000618
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000619Not all options are supported in all versions. This depends on the supported
620features and sometimes on the system. A remark about this is in curly braces
621below. When an option is not supported it may still be set without getting an
622error, this is called a hidden option. You can't get the value of a hidden
623option though, it is not stored.
624
625To test if option "foo" can be used with ":set" use something like this: >
626 if exists('&foo')
627This also returns true for a hidden option. To test if option "foo" is really
628supported use something like this: >
629 if exists('+foo')
630<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631 *E355*
632A jump table for the options with a short description can be found at |Q_op|.
633
634 *'aleph'* *'al'* *aleph* *Aleph*
635'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
636 global
637 {not in Vi}
638 {only available when compiled with the |+rightleft|
639 feature}
640 The ASCII code for the first letter of the Hebrew alphabet. The
641 routine that maps the keyboard in Hebrew mode, both in Insert mode
642 (when hkmap is set) and on the command-line (when hitting CTRL-_)
643 outputs the Hebrew characters in the range [aleph..aleph+26].
644 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
645 See |rileft.txt|.
646
647 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
648'allowrevins' 'ari' boolean (default off)
649 global
650 {not in Vi}
651 {only available when compiled with the |+rightleft|
652 feature}
653 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
654 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
655 into reverse Insert mode, and don't know how to get out. See
656 'revins'.
657 NOTE: This option is reset when 'compatible' is set.
658
659 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
660'altkeymap' 'akm' boolean (default off)
661 global
662 {not in Vi}
663 {only available when compiled with the |+farsi|
664 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000665 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 the keyboard map between Farsi and English, when 'allowrevins' set.
667
Bram Moolenaar582fd852005-03-28 20:58:01 +0000668 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669 is useful to start the Vim in native mode i.e. English (left-to-right
670 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000671 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672
673 *'ambiwidth'* *'ambw'*
674'ambiwidth' 'ambw' string (default: "single")
675 global
676 {not in Vi}
677 {only available when compiled with the |+multi_byte|
678 feature}
679 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
680 Tells Vim what to do with characters with East Asian Width Class
681 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
682 letters, Cyrillic letters).
683
684 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000685 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686 expected by most users.
687 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200688 *E834* *E835*
689 The value "double" cannot be used if 'listchars' or 'fillchars'
690 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691
692 There are a number of CJK fonts for which the width of glyphs for
693 those characters are solely based on how many octets they take in
694 legacy/traditional CJK encodings. In those encodings, Euro,
695 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000696 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000698 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699 Vim is running inside a terminal (emulators) that uses a CJK font
700 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
701 this option should be set to "double" to match the width perceived
702 by Vim with the width of glyphs in the font. Perhaps it also has
703 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
704 when the system locale is set to one of CJK locales. See Unicode
705 Standard Annex #11 (http://www.unicode.org/reports/tr11).
706
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100707 Vim may set this option automatically at startup time when Vim is
708 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200709 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100710
Bram Moolenaar071d4272004-06-13 20:20:40 +0000711 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
712'antialias' 'anti' boolean (default: off)
713 global
714 {not in Vi}
715 {only available when compiled with GUI enabled
716 on Mac OS X}
717 This option only has an effect in the GUI version of Vim on Mac OS X
718 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
719 which can be easier to read at certain sizes on certain displays.
720 Setting this option can sometimes cause problems if 'guifont' is set
721 to its default (empty string).
722
723 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
724'autochdir' 'acd' boolean (default off)
725 global
726 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200727 {only available when compiled with it, use
728 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000729 When on, Vim will change the current working directory whenever you
730 open a file, switch buffers, delete a buffer or open/close a window.
731 It will change to the directory containing the file which was opened
732 or selected.
733 This option is provided for backward compatibility with the Vim
734 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000735 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736
737 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
738'arabic' 'arab' boolean (default off)
739 local to window
740 {not in Vi}
741 {only available when compiled with the |+arabic|
742 feature}
743 This option can be set to start editing Arabic text.
744 Setting this option will:
745 - Set the 'rightleft' option, unless 'termbidi' is set.
746 - Set the 'arabicshape' option, unless 'termbidi' is set.
747 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
748 between typing English and Arabic key mapping.
749 - Set the 'delcombine' option
750 Note that 'encoding' must be "utf-8" for working with Arabic text.
751
752 Resetting this option will:
753 - Reset the 'rightleft' option.
754 - Disable the use of 'keymap' (without changing its value).
755 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200756 option).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757 Also see |arabic.txt|.
758
759 *'arabicshape'* *'arshape'*
760 *'noarabicshape'* *'noarshape'*
761'arabicshape' 'arshape' boolean (default on)
762 global
763 {not in Vi}
764 {only available when compiled with the |+arabic|
765 feature}
766 When on and 'termbidi' is off, the required visual character
767 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200768 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 one which encompasses:
770 a) the changing/morphing of characters based on their location
771 within a word (initial, medial, final and stand-alone).
772 b) the enabling of the ability to compose characters
773 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100774 When disabled the display shows each character's true stand-alone
775 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 Arabic is a complex language which requires other settings, for
777 further details see |arabic.txt|.
778
779 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
780'autoindent' 'ai' boolean (default off)
781 local to buffer
782 Copy indent from current line when starting a new line (typing <CR>
783 in Insert mode or when using the "o" or "O" command). If you do not
784 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000785 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
786 to another line has the same effect, unless the 'I' flag is included
787 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000788 When autoindent is on, formatting (with the "gq" command or when you
789 reach 'textwidth' in Insert mode) uses the indentation of the first
790 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 When 'smartindent' or 'cindent' is on the indent is changed in
792 a different way.
793 The 'autoindent' option is reset when the 'paste' option is set.
794 {small difference from Vi: After the indent is deleted when typing
795 <Esc> or <CR>, the cursor position when moving up or down is after the
796 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
797
798 *'autoread'* *'ar'* *'noautoread'* *'noar'*
799'autoread' 'ar' boolean (default off)
800 global or local to buffer |global-local|
801 {not in Vi}
802 When a file has been detected to have been changed outside of Vim and
803 it has not been changed inside of Vim, automatically read it again.
804 When the file has been deleted this is not done. |timestamp|
805 If this option has a local value, use this command to switch back to
806 using the global value: >
807 :set autoread<
808<
809 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
810'autowrite' 'aw' boolean (default off)
811 global
812 Write the contents of the file, if it has been modified, on each
813 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000814 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
816 Note that for some commands the 'autowrite' option is not used, see
817 'autowriteall' for that.
818
819 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
820'autowriteall' 'awa' boolean (default off)
821 global
822 {not in Vi}
823 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
824 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
825 Setting this option also implies that Vim behaves like 'autowrite' has
826 been set.
827
828 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200829'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830 global
831 {not in Vi}
832 When set to "dark", Vim will try to use colors that look good on a
833 dark background. When set to "light", Vim will try to use colors that
834 look good on a light background. Any other value is illegal.
835 Vim tries to set the default value according to the terminal used.
836 This will not always be correct.
837 Setting this option does not change the background color, it tells Vim
838 what the background color looks like. For changing the background
839 color, see |:hi-normal|.
840
841 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000842 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000843 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100844 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845 setting 'background' will cause the color scheme to be reloaded. If
846 the color scheme adjusts to the value of 'background' this will work.
847 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100848 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849
850 When setting 'background' to the default value with: >
851 :set background&
852< Vim will guess the value. In the GUI this should work correctly,
853 in other cases Vim might not be able to guess the right value.
854
855 When starting the GUI, the default value for 'background' will be
856 "light". When the value is not set in the .gvimrc, and Vim detects
857 that the background is actually quite dark, 'background' is set to
858 "dark". But this happens only AFTER the .gvimrc file has been read
859 (because the window needs to be opened to find the actual background
860 color). To get around this, force the GUI window to be opened by
861 putting a ":gui" command in the .gvimrc file, before where the value
862 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200863
864 For MS-DOS, Windows and OS/2 the default is "dark".
865 For other systems "dark" is used when 'term' is "linux",
866 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
867 background. Otherwise the default is "light".
868
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 Normally this option would be set in the .vimrc file. Possibly
870 depending on the terminal name. Example: >
871 :if &term == "pcterm"
872 : set background=dark
873 :endif
874< When this option is set, the default settings for the highlight groups
875 will change. To use other settings, place ":highlight" commands AFTER
876 the setting of the 'background' option.
877 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
878 to select the colors for syntax highlighting. After changing this
879 option, you must load syntax.vim again to see the result. This can be
880 done with ":syntax on".
881
882 *'backspace'* *'bs'*
883'backspace' 'bs' string (default "")
884 global
885 {not in Vi}
886 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
887 mode. This is a list of items, separated by commas. Each item allows
888 a way to backspace over something:
889 value effect ~
890 indent allow backspacing over autoindent
891 eol allow backspacing over line breaks (join lines)
892 start allow backspacing over the start of insert; CTRL-W and CTRL-U
893 stop once at the start of insert.
894
895 When the value is empty, Vi compatible backspacing is used.
896
897 For backwards compatibility with version 5.4 and earlier:
898 value effect ~
899 0 same as ":set backspace=" (Vi compatible)
900 1 same as ":set backspace=indent,eol"
901 2 same as ":set backspace=indent,eol,start"
902
903 See |:fixdel| if your <BS> or <Del> key does not do what you want.
904 NOTE: This option is set to "" when 'compatible' is set.
905
906 *'backup'* *'bk'* *'nobackup'* *'nobk'*
907'backup' 'bk' boolean (default off)
908 global
909 {not in Vi}
910 Make a backup before overwriting a file. Leave it around after the
911 file has been successfully written. If you do not want to keep the
912 backup file, but you do want a backup while the file is being
913 written, reset this option and set the 'writebackup' option (this is
914 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000915 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 |backup-table| for more explanations.
917 When the 'backupskip' pattern matches, a backup is not made anyway.
918 When 'patchmode' is set, the backup may be renamed to become the
919 oldest version of a file.
920 NOTE: This option is reset when 'compatible' is set.
921
922 *'backupcopy'* *'bkc'*
923'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
924 global
925 {not in Vi}
926 When writing a file and a backup is made, this option tells how it's
927 done. This is a comma separated list of words.
928
929 The main values are:
930 "yes" make a copy of the file and overwrite the original one
931 "no" rename the file and write a new one
932 "auto" one of the previous, what works best
933
934 Extra values that can be combined with the ones above are:
935 "breaksymlink" always break symlinks when writing
936 "breakhardlink" always break hardlinks when writing
937
938 Making a copy and overwriting the original file:
939 - Takes extra time to copy the file.
940 + When the file has special attributes, is a (hard/symbolic) link or
941 has a resource fork, all this is preserved.
942 - When the file is a link the backup will have the name of the link,
943 not of the real file.
944
945 Renaming the file and writing a new one:
946 + It's fast.
947 - Sometimes not all attributes of the file can be copied to the new
948 file.
949 - When the file is a link the new file will not be a link.
950
951 The "auto" value is the middle way: When Vim sees that renaming file
952 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000953 the file is not a link) that is used. When problems are expected, a
954 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955
956 The "breaksymlink" and "breakhardlink" values can be used in
957 combination with any of "yes", "no" and "auto". When included, they
958 force Vim to always break either symbolic or hard links by doing
959 exactly what the "no" option does, renaming the original file to
960 become the backup and writing a new file in its place. This can be
961 useful for example in source trees where all the files are symbolic or
962 hard links and any changes should stay in the local source tree, not
963 be propagated back to the original source.
964 *crontab*
965 One situation where "no" and "auto" will cause problems: A program
966 that opens a file, invokes Vim to edit that file, and then tests if
967 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000968 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969 example.
970
971 When a copy is made, the original file is truncated and then filled
972 with the new text. This means that protection bits, owner and
973 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000974 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975 group of the backup is set to the group of the original file. If this
976 fails, the protection bits for the group are made the same as for
977 others.
978
979 When the file is renamed this is the other way around: The backup has
980 the same attributes of the original file, and the newly written file
981 is owned by the current user. When the file was a (hard/symbolic)
982 link, the new file will not! That's why the "auto" value doesn't
983 rename when the file is a link. The owner and group of the newly
984 written file will be set to the same ones as the original file, but
985 the system may refuse to do this. In that case the "auto" value will
986 again not rename the file.
987
988 *'backupdir'* *'bdir'*
989'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +0100990 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 for Unix: ".,~/tmp,~/")
992 global
993 {not in Vi}
994 List of directories for the backup file, separated with commas.
995 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100996 where this is possible. The directory must exist, Vim will not
997 create it for you.
Bram Moolenaar34700a62013-03-07 13:20:54 +0100998 - Empty means that no backup file will be created ( 'patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 impossible!). Writing may fail because of this.
1000 - A directory "." means to put the backup file in the same directory
1001 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001002 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003 put the backup file relative to where the edited file is. The
1004 leading "." is replaced with the path name of the edited file.
1005 ("." inside a directory name has no special meaning).
1006 - Spaces after the comma are ignored, other spaces are considered part
1007 of the directory name. To have a space at the start of a directory
1008 name, precede it with a backslash.
1009 - To include a comma in a directory name precede it with a backslash.
1010 - A directory name may end in an '/'.
1011 - Environment variables are expanded |:set_env|.
1012 - Careful with '\' characters, type one before a space, type two to
1013 get one in the option (see |option-backslash|), for example: >
1014 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1015< - For backwards compatibility with Vim version 3.0 a '>' at the start
1016 of the option is removed.
1017 See also 'backup' and 'writebackup' options.
1018 If you want to hide your backup files on Unix, consider this value: >
1019 :set backupdir=./.backup,~/.backup,.,/tmp
1020< You must create a ".backup" directory in each directory and in your
1021 home directory for this to work properly.
1022 The use of |:set+=| and |:set-=| is preferred when adding or removing
1023 directories from the list. This avoids problems when a future version
1024 uses another default.
1025 This option cannot be set from a |modeline| or in the |sandbox|, for
1026 security reasons.
1027
1028 *'backupext'* *'bex'* *E589*
1029'backupext' 'bex' string (default "~", for VMS: "_")
1030 global
1031 {not in Vi}
1032 String which is appended to a file name to make the name of the
1033 backup file. The default is quite unusual, because this avoids
1034 accidentally overwriting existing files with a backup file. You might
1035 prefer using ".bak", but make sure that you don't have files with
1036 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001037 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001039 If you like to keep a lot of backups, you could use a BufWritePre
1040 autocommand to change 'backupext' just before writing the file to
1041 include a timestamp. >
1042 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1043< Use 'backupdir' to put the backup in a different directory.
1044
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045 *'backupskip'* *'bsk'*
1046'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1047 global
1048 {not in Vi}
1049 {not available when compiled without the |+wildignore|
1050 feature}
1051 A list of file patterns. When one of the patterns matches with the
1052 name of the file which is written, no backup file is created. Both
1053 the specified file name and the full path name of the file are used.
1054 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1055 Watch out for special characters, see |option-backslash|.
1056 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001057 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001058
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001059 WARNING: Not having a backup file means that when Vim fails to write
1060 your buffer correctly and then, for whatever reason, Vim exits, you
1061 lose both the original file and what you were writing. Only disable
1062 backups if you don't care about losing the file.
1063
Bram Moolenaar02467872007-05-06 13:22:01 +00001064 Note that environment variables are not expanded. If you want to use
1065 $HOME you must expand it explicitly, e.g.: >
1066 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1067
1068< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001069 backup would be made by renaming the original file crontab won't see
1070 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071
1072 *'balloondelay'* *'bdlay'*
1073'balloondelay' 'bdlay' number (default: 600)
1074 global
1075 {not in Vi}
1076 {only available when compiled with the |+balloon_eval|
1077 feature}
1078 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1079
1080 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1081'ballooneval' 'beval' boolean (default off)
1082 global
1083 {not in Vi}
1084 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001085 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 Switch on the |balloon-eval| functionality.
1087
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001088 *'balloonexpr'* *'bexpr'*
1089'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001090 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001091 {not in Vi}
1092 {only available when compiled with the |+balloon_eval|
1093 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001094 Expression for text to show in evaluation balloon. It is only used
1095 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001096
1097 v:beval_bufnr number of the buffer in which balloon is going to show
1098 v:beval_winnr number of the window
1099 v:beval_lnum line number
1100 v:beval_col column number (byte index)
1101 v:beval_text word under or after the mouse pointer
1102
1103 The evaluation of the expression must not have side effects!
1104 Example: >
1105 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001106 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001107 \', column ' . v:beval_col .
1108 \ ' of file ' . bufname(v:beval_bufnr) .
1109 \ ' on word "' . v:beval_text . '"'
1110 endfunction
1111 set bexpr=MyBalloonExpr()
1112 set ballooneval
1113<
1114 NOTE: The balloon is displayed only if the cursor is on a text
1115 character. If the result of evaluating 'balloonexpr' is not empty,
1116 Vim does not try to send a message to an external debugger (Netbeans
1117 or Sun Workshop).
1118
Bram Moolenaar30b65812012-07-12 22:01:11 +02001119 The expression will be evaluated in the |sandbox| when set from a
1120 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001121
1122 It is not allowed to change text or jump to another window while
1123 evaluating 'balloonexpr' |textlock|.
1124
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001125 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001126 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001127< When they are supported "\n" characters will start a new line. If the
1128 expression evaluates to a |List| this is equal to using each List item
1129 as a string and putting "\n" in between them.
1130
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1132'binary' 'bin' boolean (default off)
1133 local to buffer
1134 {not in Vi}
1135 This option should be set before editing a binary file. You can also
1136 use the |-b| Vim argument. When this option is switched on a few
1137 options will be changed (also when it already was on):
1138 'textwidth' will be set to 0
1139 'wrapmargin' will be set to 0
1140 'modeline' will be off
1141 'expandtab' will be off
1142 Also, 'fileformat' and 'fileformats' options will not be used, the
1143 file is read and written like 'fileformat' was "unix" (a single <NL>
1144 separates lines).
1145 The 'fileencoding' and 'fileencodings' options will not be used, the
1146 file is read without conversion.
1147 NOTE: When you start editing a(nother) file while the 'bin' option is
1148 on, settings from autocommands may change the settings again (e.g.,
1149 'textwidth'), causing trouble when editing. You might want to set
1150 'bin' again when the file has been loaded.
1151 The previous values of these options are remembered and restored when
1152 'bin' is switched from on to off. Each buffer has its own set of
1153 saved option values.
1154 To edit a file with 'binary' set you can use the |++bin| argument.
1155 This avoids you have to do ":set bin", which would have effect for all
1156 files you edit.
1157 When writing a file the <EOL> for the last line is only written if
1158 there was one in the original file (normally Vim appends an <EOL> to
1159 the last line if there is none; this would make the file longer). See
1160 the 'endofline' option.
1161
1162 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1163'bioskey' 'biosk' boolean (default on)
1164 global
1165 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001166 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 better to detect CTRL-C, but only works for the console. When using a
1168 terminal over a serial port reset this option.
1169 Also see |'conskey'|.
1170
1171 *'bomb'* *'nobomb'*
1172'bomb' boolean (default off)
1173 local to buffer
1174 {not in Vi}
1175 {only available when compiled with the |+multi_byte|
1176 feature}
1177 When writing a file and the following conditions are met, a BOM (Byte
1178 Order Mark) is prepended to the file:
1179 - this option is on
1180 - the 'binary' option is off
1181 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1182 endian variants.
1183 Some applications use the BOM to recognize the encoding of the file.
1184 Often used for UCS-2 files on MS-Windows. For other applications it
1185 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001186 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1188 check for the presence of the BOM is done and 'bomb' set accordingly.
1189 Unless 'binary' is set, it is removed from the first line, so that you
1190 don't see it when editing. When you don't change the options, the BOM
1191 will be restored when writing the file.
1192
1193 *'breakat'* *'brk'*
1194'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1195 global
1196 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001197 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198 feature}
1199 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001200 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1201 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001203 *'breakindent'* *'bri'*
1204'breakindent' 'bri' boolean (default off)
1205 local to window
1206 {not in Vi}
1207 {not available when compiled without the |+linebreak|
1208 feature}
1209 Every wrapped line will continue visually indented (same amount of
1210 space as the beginning of that line), thus preserving horizontal blocks
1211 of text.
1212
1213 *'breakindentopt'* *'briopt'*
1214'breakindentopt' 'briopt' string (default empty)
1215 local to window
1216 {not in Vi}
1217 {not available when compiled without the |+linebreak|
1218 feature}
1219 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001220 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001221 min:{n} Minimum text width that will be kept after
1222 applying 'breakindent', even if the resulting
1223 text should normally be narrower. This prevents
1224 text indented almost to the right window border
1225 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001226 shift:{n} After applying 'breakindent', the wrapped line's
1227 beginning will be shifted by the given number of
1228 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001229 indentation (negative) or emphasizing the line
1230 continuation (positive).
1231 sbr Display the 'showbreak' value before applying the
1232 additional indent.
1233 The default value for min is 20 and shift is 0.
1234
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001236'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001238 {not in Vi} {only for Motif, Athena, GTK, Mac and
1239 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001241 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001242 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243 buffer Use the directory of the related buffer.
1244 current Use the current directory.
1245 {path} Use the specified directory
1246
1247 *'bufhidden'* *'bh'*
1248'bufhidden' 'bh' string (default: "")
1249 local to buffer
1250 {not in Vi}
1251 {not available when compiled without the |+quickfix|
1252 feature}
1253 This option specifies what happens when a buffer is no longer
1254 displayed in a window:
1255 <empty> follow the global 'hidden' option
1256 hide hide the buffer (don't unload it), also when 'hidden'
1257 is not set
1258 unload unload the buffer, also when 'hidden' is set or using
1259 |:hide|
1260 delete delete the buffer from the buffer list, also when
1261 'hidden' is set or using |:hide|, like using
1262 |:bdelete|
1263 wipe wipe out the buffer from the buffer list, also when
1264 'hidden' is set or using |:hide|, like using
1265 |:bwipeout|
1266
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001267 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001268 are lost without a warning. Also, these values may break autocommands
1269 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270 This option is used together with 'buftype' and 'swapfile' to specify
1271 special kinds of buffers. See |special-buffers|.
1272
1273 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1274'buflisted' 'bl' boolean (default: on)
1275 local to buffer
1276 {not in Vi}
1277 When this option is set, the buffer shows up in the buffer list. If
1278 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1279 This option is reset by Vim for buffers that are only used to remember
1280 a file name or marks. Vim sets it when starting to edit a buffer.
1281 But not when moving to a buffer with ":buffer".
1282
1283 *'buftype'* *'bt'* *E382*
1284'buftype' 'bt' string (default: "")
1285 local to buffer
1286 {not in Vi}
1287 {not available when compiled without the |+quickfix|
1288 feature}
1289 The value of this option specifies the type of a buffer:
1290 <empty> normal buffer
1291 nofile buffer which is not related to a file and will not be
1292 written
1293 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001294 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001295 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001296 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001297 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001298 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299 help help buffer (you are not supposed to set this
1300 manually)
1301
1302 This option is used together with 'bufhidden' and 'swapfile' to
1303 specify special kinds of buffers. See |special-buffers|.
1304
1305 Be careful with changing this option, it can have many side effects!
1306
Bram Moolenaar280f1262006-01-30 00:14:18 +00001307 A "quickfix" buffer is only used for the error list and the location
1308 list. This value is set by the |:cwindow| and |:lwindow| commands and
1309 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001310
1311 "nofile" and "nowrite" buffers are similar:
1312 both: The buffer is not to be written to disk, ":w" doesn't
1313 work (":w filename" does work though).
1314 both: The buffer is never considered to be |'modified'|.
1315 There is no warning when the changes will be lost, for
1316 example when you quit Vim.
1317 both: A swap file is only created when using too much memory
1318 (when 'swapfile' has been reset there is never a swap
1319 file).
1320 nofile only: The buffer name is fixed, it is not handled like a
1321 file name. It is not modified in response to a |:cd|
1322 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001323 *E676*
1324 "acwrite" implies that the buffer name is not related to a file, like
1325 "nofile", but it will be written. Thus, in contrast to "nofile" and
1326 "nowrite", ":w" does work and a modified buffer can't be abandoned
1327 without saving. For writing there must be matching |BufWriteCmd|,
1328 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329
1330 *'casemap'* *'cmp'*
1331'casemap' 'cmp' string (default: "internal,keepascii")
1332 global
1333 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001334 {only available when compiled with the |+multi_byte|
1335 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 Specifies details about changing the case of letters. It may contain
1337 these words, separated by a comma:
1338 internal Use internal case mapping functions, the current
1339 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001340 matters when 'encoding' is a Unicode encoding,
1341 "latin1" or "iso-8859-15". When "internal" is
1342 omitted, the towupper() and towlower() system library
1343 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1345 case mapping, the current locale is not effective.
1346 This probably only matters for Turkish.
1347
1348 *'cdpath'* *'cd'* *E344* *E346*
1349'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1350 global
1351 {not in Vi}
1352 {not available when compiled without the
1353 |+file_in_path| feature}
1354 This is a list of directories which will be searched when using the
1355 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001356 for has a relative path, not an absolute part starting with "/", "./"
1357 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358 The 'cdpath' option's value has the same form and semantics as
1359 |'path'|. Also see |file-searching|.
1360 The default value is taken from $CDPATH, with a "," prepended to look
1361 in the current directory first.
1362 If the default value taken from $CDPATH is not what you want, include
1363 a modified version of the following command in your vimrc file to
1364 override it: >
1365 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1366< This option cannot be set from a |modeline| or in the |sandbox|, for
1367 security reasons.
1368 (parts of 'cdpath' can be passed to the shell to expand file names).
1369
1370 *'cedit'*
1371'cedit' string (Vi default: "", Vim default: CTRL-F)
1372 global
1373 {not in Vi}
1374 {not available when compiled without the |+vertsplit|
1375 feature}
1376 The key used in Command-line Mode to open the command-line window.
1377 The default is CTRL-F when 'compatible' is off.
1378 Only non-printable keys are allowed.
1379 The key can be specified as a single character, but it is difficult to
1380 type. The preferred way is to use the <> notation. Examples: >
1381 :set cedit=<C-Y>
1382 :set cedit=<Esc>
1383< |Nvi| also has this option, but it only uses the first character.
1384 See |cmdwin|.
1385
1386 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1387'charconvert' 'ccv' string (default "")
1388 global
1389 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001390 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 {not in Vi}
1392 An expression that is used for character encoding conversion. It is
1393 evaluated when a file that is to be read or has been written has a
1394 different encoding from what is desired.
1395 'charconvert' is not used when the internal iconv() function is
1396 supported and is able to do the conversion. Using iconv() is
1397 preferred, because it is much faster.
1398 'charconvert' is not used when reading stdin |--|, because there is no
1399 file to convert from. You will have to save the text in a file first.
1400 The expression must return zero or an empty string for success,
1401 non-zero for failure.
1402 The possible encoding names encountered are in 'encoding'.
1403 Additionally, names given in 'fileencodings' and 'fileencoding' are
1404 used.
1405 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1406 is done internally by Vim, 'charconvert' is not used for this.
1407 'charconvert' is also used to convert the viminfo file, if the 'c'
1408 flag is present in 'viminfo'. Also used for Unicode conversion.
1409 Example: >
1410 set charconvert=CharConvert()
1411 fun CharConvert()
1412 system("recode "
1413 \ . v:charconvert_from . ".." . v:charconvert_to
1414 \ . " <" . v:fname_in . " >" v:fname_out)
1415 return v:shell_error
1416 endfun
1417< The related Vim variables are:
1418 v:charconvert_from name of the current encoding
1419 v:charconvert_to name of the desired encoding
1420 v:fname_in name of the input file
1421 v:fname_out name of the output file
1422 Note that v:fname_in and v:fname_out will never be the same.
1423 Note that v:charconvert_from and v:charconvert_to may be different
1424 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1425 Encryption is not done by Vim when using 'charconvert'. If you want
1426 to encrypt the file after conversion, 'charconvert' should take care
1427 of this.
1428 This option cannot be set from a |modeline| or in the |sandbox|, for
1429 security reasons.
1430
1431 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1432'cindent' 'cin' boolean (default off)
1433 local to buffer
1434 {not in Vi}
1435 {not available when compiled without the |+cindent|
1436 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001437 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438 that trigger reindenting in insert mode and 'cinoptions' to set your
1439 preferred indent style.
1440 If 'indentexpr' is not empty, it overrules 'cindent'.
1441 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1442 the "=" operator indents using this algorithm rather than calling an
1443 external program.
1444 See |C-indenting|.
1445 When you don't like the way 'cindent' works, try the 'smartindent'
1446 option or 'indentexpr'.
1447 This option is not used when 'paste' is set.
1448 NOTE: This option is reset when 'compatible' is set.
1449
1450 *'cinkeys'* *'cink'*
1451'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1452 local to buffer
1453 {not in Vi}
1454 {not available when compiled without the |+cindent|
1455 feature}
1456 A list of keys that, when typed in Insert mode, cause reindenting of
1457 the current line. Only used if 'cindent' is on and 'indentexpr' is
1458 empty.
1459 For the format of this option see |cinkeys-format|.
1460 See |C-indenting|.
1461
1462 *'cinoptions'* *'cino'*
1463'cinoptions' 'cino' string (default "")
1464 local to buffer
1465 {not in Vi}
1466 {not available when compiled without the |+cindent|
1467 feature}
1468 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1469 program. See |cinoptions-values| for the values of this option, and
1470 |C-indenting| for info on C indenting in general.
1471
1472
1473 *'cinwords'* *'cinw'*
1474'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1475 local to buffer
1476 {not in Vi}
1477 {not available when compiled without both the
1478 |+cindent| and the |+smartindent| features}
1479 These keywords start an extra indent in the next line when
1480 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1481 an appropriate place (inside {}).
1482 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1483 matter, include the keyword both the uppercase and lowercase:
1484 "if,If,IF".
1485
1486 *'clipboard'* *'cb'*
1487'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1488 for X-windows, "" otherwise)
1489 global
1490 {not in Vi}
1491 {only in GUI versions or when the |+xterm_clipboard|
1492 feature is included}
1493 This option is a list of comma separated names.
1494 These names are recognized:
1495
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001496 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001497 unnamed When included, Vim will use the clipboard register '*'
1498 for all yank, delete, change and put operations which
1499 would normally go to the unnamed register. When a
1500 register is explicitly specified, it will always be
1501 used regardless of whether "unnamed" is in 'clipboard'
1502 or not. The clipboard register can always be
1503 explicitly accessed using the "* notation. Also see
1504 |gui-clipboard|.
1505
Bram Moolenaar30b65812012-07-12 22:01:11 +02001506 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001507 unnamedplus A variant of the "unnamed" flag which uses the
1508 clipboard register '+' (|quoteplus|) instead of
1509 register '*' for all yank, delete, change and put
1510 operations which would normally go to the unnamed
1511 register. When "unnamed" is also included to the
1512 option, yank operations (but not delete, change or
1513 put) will additionally copy the text into register
1514 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001515 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001516 Availability can be checked with: >
1517 if has('unnamedplus')
1518<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001519 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 autoselect Works like the 'a' flag in 'guioptions': If present,
1521 then whenever Visual mode is started, or the Visual
1522 area extended, Vim tries to become the owner of the
1523 windowing system's global selection or put the
1524 selected text on the clipboard used by the selection
1525 register "*. See |guioptions_a| and |quotestar| for
1526 details. When the GUI is active, the 'a' flag in
1527 'guioptions' is used, when the GUI is not active, this
1528 "autoselect" flag is used.
1529 Also applies to the modeless selection.
1530
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001531 *clipboard-autoselectplus*
1532 autoselectplus Like "autoselect" but using the + register instead of
1533 the * register. Compare to the 'P' flag in
1534 'guioptions'.
1535
1536 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537 autoselectml Like "autoselect", but for the modeless selection
1538 only. Compare to the 'A' flag in 'guioptions'.
1539
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001540 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001541 html When the clipboard contains HTML, use this when
1542 pasting. When putting text on the clipboard, mark it
1543 as HTML. This works to copy rendered HTML from
1544 Firefox, paste it as raw HTML in Vim, select the HTML
1545 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001546 You probably want to add this only temporarily,
1547 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001548 Only supported for GTK version 2 and later.
1549 Only available with the |+multi_byte| feature.
1550
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001551 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001552 exclude:{pattern}
1553 Defines a pattern that is matched against the name of
1554 the terminal 'term'. If there is a match, no
1555 connection will be made to the X server. This is
1556 useful in this situation:
1557 - Running Vim in a console.
1558 - $DISPLAY is set to start applications on another
1559 display.
1560 - You do not want to connect to the X server in the
1561 console, but do want this in a terminal emulator.
1562 To never connect to the X server use: >
1563 exclude:.*
1564< This has the same effect as using the |-X| argument.
1565 Note that when there is no connection to the X server
1566 the window title won't be restored and the clipboard
1567 cannot be accessed.
1568 The value of 'magic' is ignored, {pattern} is
1569 interpreted as if 'magic' was on.
1570 The rest of the option value will be used for
1571 {pattern}, this must be the last entry.
1572
1573 *'cmdheight'* *'ch'*
1574'cmdheight' 'ch' number (default 1)
1575 global
1576 {not in Vi}
1577 Number of screen lines to use for the command-line. Helps avoiding
1578 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001579 The value of this option is stored with the tab page, so that each tab
1580 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581
1582 *'cmdwinheight'* *'cwh'*
1583'cmdwinheight' 'cwh' number (default 7)
1584 global
1585 {not in Vi}
1586 {not available when compiled without the |+vertsplit|
1587 feature}
1588 Number of screen lines to use for the command-line window. |cmdwin|
1589
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001590 *'colorcolumn'* *'cc'*
1591'colorcolumn' 'cc' string (default "")
1592 local to window
1593 {not in Vi}
1594 {not available when compiled without the |+syntax|
1595 feature}
1596 'colorcolumn' is a comma separated list of screen columns that are
1597 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1598 text. Will make screen redrawing slower.
1599 The screen column can be an absolute number, or a number preceded with
1600 '+' or '-', which is added to or subtracted from 'textwidth'. >
1601
1602 :set cc=+1 " highlight column after 'textwidth'
1603 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1604 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1605<
1606 When 'textwidth' is zero then the items with '-' and '+' are not used.
1607 A maximum of 256 columns are highlighted.
1608
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609 *'columns'* *'co'* *E594*
1610'columns' 'co' number (default 80 or terminal width)
1611 global
1612 {not in Vi}
1613 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001614 initialization and does not have to be set by hand. Also see
1615 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 When Vim is running in the GUI or in a resizable window, setting this
1617 option will cause the window size to be changed. When you only want
1618 to use the size for the GUI, put the command in your |gvimrc| file.
1619 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001620 number of columns of the display, the display may be messed up. For
1621 the GUI it is always possible and Vim limits the number of columns to
1622 what fits on the screen. You can use this command to get the widest
1623 window possible: >
1624 :set columns=9999
1625< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626
1627 *'comments'* *'com'* *E524* *E525*
1628'comments' 'com' string (default
1629 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1630 local to buffer
1631 {not in Vi}
1632 {not available when compiled without the |+comments|
1633 feature}
1634 A comma separated list of strings that can start a comment line. See
1635 |format-comments|. See |option-backslash| about using backslashes to
1636 insert a space.
1637
1638 *'commentstring'* *'cms'* *E537*
1639'commentstring' 'cms' string (default "/*%s*/")
1640 local to buffer
1641 {not in Vi}
1642 {not available when compiled without the |+folding|
1643 feature}
1644 A template for a comment. The "%s" in the value is replaced with the
1645 comment text. Currently only used to add markers for folding, see
1646 |fold-marker|.
1647
1648 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001649'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1650 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651 global
1652 {not in Vi}
1653 This option has the effect of making Vim either more Vi-compatible, or
1654 make Vim behave in a more useful way.
1655 This is a special kind of option, because when it's set or reset,
1656 other options are also changed as a side effect. CAREFUL: Setting or
1657 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001658 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659 set this option in your vimrc file, you should probably put it at the
1660 very start.
1661 By default this option is on and the Vi defaults are used for the
1662 options. This default was chosen for those people who want to use Vim
1663 just like Vi, and don't even (want to) know about the 'compatible'
1664 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001665 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001666 this option is switched off, and all options that have not been
1667 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001668 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001669 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001670 happen for the system-wide vimrc or gvimrc file, nor for a file given
1671 with the |-u| argument). Also see |compatible-default| and
1672 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 You can also set this option with the "-C" argument, and reset it with
1674 "-N". See |-C| and |-N|.
1675 Switching this option off makes the Vim defaults be used for options
1676 that have a different Vi and Vim default value. See the options
1677 marked with a '+' below. Other options are not modified.
1678 At the moment this option is set, several other options will be set
1679 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001680 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681 editing.
1682 See also 'cpoptions'.
1683
1684 option + set value effect ~
1685
1686 'allowrevins' off no CTRL-_ command
1687 'backupcopy' Unix: "yes" backup file is a copy
1688 others: "auto" copy or rename backup file
1689 'backspace' "" normal backspace
1690 'backup' off no backup file
1691 'cindent' off no C code indentation
1692 'cedit' + "" no key to open the |cmdwin|
1693 'cpoptions' + (all flags) Vi-compatible flags
1694 'cscopetag' off don't use cscope for ":tag"
1695 'cscopetagorder' 0 see |cscopetagorder|
1696 'cscopeverbose' off see |cscopeverbose|
1697 'digraph' off no digraphs
1698 'esckeys' + off no <Esc>-keys in Insert mode
1699 'expandtab' off tabs not expanded to spaces
1700 'fileformats' + "" no automatic file format detection,
1701 "dos,unix" except for DOS, Windows and OS/2
1702 'formatoptions' + "vt" Vi compatible formatting
1703 'gdefault' off no default 'g' flag for ":s"
1704 'history' + 0 no commandline history
1705 'hkmap' off no Hebrew keyboard mapping
1706 'hkmapp' off no phonetic Hebrew keyboard mapping
1707 'hlsearch' off no highlighting of search matches
1708 'incsearch' off no incremental searching
1709 'indentexpr' "" no indenting by expression
1710 'insertmode' off do not start in Insert mode
1711 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1712 characters and '_'
1713 'joinspaces' on insert 2 spaces after period
1714 'modeline' + off no modelines
1715 'more' + off no pauses in listings
1716 'revins' off no reverse insert
1717 'ruler' off no ruler
1718 'scrolljump' 1 no jump scroll
1719 'scrolloff' 0 no scroll offset
1720 'shiftround' off indent not rounded to shiftwidth
1721 'shortmess' + "" no shortening of messages
1722 'showcmd' + off command characters not shown
1723 'showmode' + off current mode not shown
1724 'smartcase' off no automatic ignore case switch
1725 'smartindent' off no smart indentation
1726 'smarttab' off no smart tab size
1727 'softtabstop' 0 tabs are always 'tabstop' positions
1728 'startofline' on goto startofline with some commands
1729 'tagrelative' + off tag file names are not relative
1730 'textauto' + off no automatic textmode detection
1731 'textwidth' 0 no automatic line wrap
1732 'tildeop' off tilde is not an operator
1733 'ttimeout' off no terminal timeout
1734 'whichwrap' + "" left-right movements don't wrap
1735 'wildchar' + CTRL-E only when the current value is <Tab>
1736 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001737 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738
1739 *'complete'* *'cpt'* *E535*
1740'complete' 'cpt' string (default: ".,w,b,u,t,i")
1741 local to buffer
1742 {not in Vi}
1743 This option specifies how keyword completion |ins-completion| works
1744 when CTRL-P or CTRL-N are used. It is also used for whole-line
1745 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1746 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar34700a62013-03-07 13:20:54 +01001747 . scan the current buffer ( 'wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748 w scan buffers from other windows
1749 b scan other loaded buffers that are in the buffer list
1750 u scan the unloaded buffers that are in the buffer list
1751 U scan the buffers that are not in the buffer list
1752 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001753 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754 k{dict} scan the file {dict}. Several "k" flags can be given,
1755 patterns are valid too. For example: >
1756 :set cpt=k/usr/dict/*,k~/spanish
1757< s scan the files given with the 'thesaurus' option
1758 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1759 are valid too.
1760 i scan current and included files
1761 d scan current and included files for defined name or macro
1762 |i_CTRL-X_CTRL-D|
1763 ] tag completion
1764 t same as "]"
1765
1766 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1767 not executed, this may lead to unexpected completions from some files
1768 (gzipped files for example). Unloaded buffers are not scanned for
1769 whole-line completion.
1770
1771 The default is ".,w,b,u,t,i", which means to scan:
1772 1. the current buffer
1773 2. buffers in other windows
1774 3. other loaded buffers
1775 4. unloaded buffers
1776 5. tags
1777 6. included files
1778
1779 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001780 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1781 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001783 *'completefunc'* *'cfu'*
1784'completefunc' 'cfu' string (default: empty)
1785 local to buffer
1786 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001787 {not available when compiled without the |+eval|
1788 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001789 This option specifies a function to be used for Insert mode completion
1790 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001791 See |complete-functions| for an explanation of how the function is
1792 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001793 This option cannot be set from a |modeline| or in the |sandbox|, for
1794 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001795
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001796 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001797'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001798 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001799 {not available when compiled without the
1800 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001801 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001802 A comma separated list of options for Insert mode completion
1803 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001804
1805 menu Use a popup menu to show the possible completions. The
1806 menu is only shown when there is more than one match and
1807 sufficient colors are available. |ins-completion-menu|
1808
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001809 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001810 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001811 match, e.g., what file it comes from.
1812
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001813 longest Only insert the longest common text of the matches. If
1814 the menu is displayed you can use CTRL-L to add more
1815 characters. Whether case is ignored depends on the kind
1816 of completion. For buffer text the 'ignorecase' option is
1817 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001818
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001819 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001820 completion in the preview window. Only works in
1821 combination with "menu" or "menuone".
1822
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001823
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001824 *'concealcursor'* *'cocu'*
1825'concealcursor' 'cocu' string (default: "")
1826 local to window
1827 {not in Vi}
1828 {not available when compiled without the |+conceal|
1829 feature}
1830 Sets the modes in which text in the cursor line can also be concealed.
1831 When the current mode is listed then concealing happens just like in
1832 other lines.
1833 n Normal mode
1834 v Visual mode
1835 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001836 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001837
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001838 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001839 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001840 are moving around text is concealed, but when starting to insert text
1841 or selecting a Visual area the concealed text is displayed, so that
1842 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001843 Keep in mind that the cursor position is not always where it's
1844 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001845
1846
1847'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001848 number (default 0)
1849 local to window
1850 {not in Vi}
1851 {not available when compiled without the |+conceal|
1852 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001853 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1854 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001855
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001856 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001857 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001858 1 Each block of concealed text is replaced with one
1859 character. If the syntax item does not have a custom
1860 replacement character defined (see |:syn-cchar|) the
1861 character defined in 'listchars' is used (default is a
1862 space).
1863 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001864 2 Concealed text is completely hidden unless it has a
1865 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001866 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001867 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001868
Bram Moolenaara7781e02010-07-19 20:13:22 +02001869 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001870 edit and copy the text. This can be changed with the 'concealcursor'
1871 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001872
Bram Moolenaar071d4272004-06-13 20:20:40 +00001873 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1874'confirm' 'cf' boolean (default off)
1875 global
1876 {not in Vi}
1877 When 'confirm' is on, certain operations that would normally
1878 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1879 instead raise a |dialog| asking if you wish to save the current
1880 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1881 If 'confirm' is off you can still activate confirmation for one
1882 command only (this is most useful in mappings) with the |:confirm|
1883 command.
1884 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1885
1886 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1887'conskey' 'consk' boolean (default off)
1888 global
1889 {not in Vi} {only for MS-DOS}
1890 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001891 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 three methods of console input are available:
1893 'conskey' 'bioskey' action ~
1894 on on or off direct console input
1895 off on BIOS
1896 off off STDIN
1897
1898 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1899'copyindent' 'ci' boolean (default off)
1900 local to buffer
1901 {not in Vi}
1902 Copy the structure of the existing lines indent when autoindenting a
1903 new line. Normally the new indent is reconstructed by a series of
1904 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1905 in which case only spaces are used). Enabling this option makes the
1906 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001907 existing line. 'expandtab' has no effect on these characters, a Tab
1908 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909 line, the remaining space is filled in the normal manner.
1910 NOTE: 'copyindent' is reset when 'compatible' is set.
1911 Also see 'preserveindent'.
1912
1913 *'cpoptions'* *'cpo'*
1914'cpoptions' 'cpo' string (Vim default: "aABceFs",
1915 Vi default: all flags)
1916 global
1917 {not in Vi}
1918 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001919 this indicates Vi-compatible behavior. This is used for things where
1920 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001921 'cpoptions' stands for "compatible-options".
1922 Commas can be added for readability.
1923 To avoid problems with flags that are added in the future, use the
1924 "+=" and "-=" feature of ":set" |add-option-flags|.
1925 NOTE: This option is set to the Vi default value when 'compatible' is
1926 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001927 NOTE: This option is set to the POSIX default value at startup when
1928 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001929 variable exists |posix|. This means Vim tries to behave like the
1930 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931
1932 contains behavior ~
1933 *cpo-a*
1934 a When included, a ":read" command with a file name
1935 argument will set the alternate file name for the
1936 current window.
1937 *cpo-A*
1938 A When included, a ":write" command with a file name
1939 argument will set the alternate file name for the
1940 current window.
1941 *cpo-b*
1942 b "\|" in a ":map" command is recognized as the end of
1943 the map command. The '\' is included in the mapping,
1944 the text after the '|' is interpreted as the next
1945 command. Use a CTRL-V instead of a backslash to
1946 include the '|' in the mapping. Applies to all
1947 mapping, abbreviation, menu and autocmd commands.
1948 See also |map_bar|.
1949 *cpo-B*
1950 B A backslash has no special meaning in mappings,
1951 abbreviations and the "to" part of the menu commands.
1952 Remove this flag to be able to use a backslash like a
1953 CTRL-V. For example, the command ":map X \<Esc>"
1954 results in X being mapped to:
1955 'B' included: "\^[" (^[ is a real <Esc>)
1956 'B' excluded: "<Esc>" (5 characters)
1957 ('<' excluded in both cases)
1958 *cpo-c*
1959 c Searching continues at the end of any match at the
1960 cursor position, but not further than the start of the
1961 next line. When not present searching continues
1962 one character from the cursor position. With 'c'
1963 "abababababab" only gets three matches when repeating
1964 "/abab", without 'c' there are five matches.
1965 *cpo-C*
1966 C Do not concatenate sourced lines that start with a
1967 backslash. See |line-continuation|.
1968 *cpo-d*
1969 d Using "./" in the 'tags' option doesn't mean to use
1970 the tags file relative to the current file, but the
1971 tags file in the current directory.
1972 *cpo-D*
1973 D Can't use CTRL-K to enter a digraph after Normal mode
1974 commands with a character argument, like |r|, |f| and
1975 |t|.
1976 *cpo-e*
1977 e When executing a register with ":@r", always add a
1978 <CR> to the last line, also when the register is not
1979 linewise. If this flag is not present, the register
1980 is not linewise and the last line does not end in a
1981 <CR>, then the last line is put on the command-line
1982 and can be edited before hitting <CR>.
1983 *cpo-E*
1984 E It is an error when using "y", "d", "c", "g~", "gu" or
1985 "gU" on an Empty region. The operators only work when
1986 at least one character is to be operate on. Example:
1987 This makes "y0" fail in the first column.
1988 *cpo-f*
1989 f When included, a ":read" command with a file name
1990 argument will set the file name for the current buffer,
1991 if the current buffer doesn't have a file name yet.
1992 *cpo-F*
1993 F When included, a ":write" command with a file name
1994 argument will set the file name for the current
1995 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001996 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997 *cpo-g*
1998 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001999 *cpo-H*
2000 H When using "I" on a line with only blanks, insert
2001 before the last blank. Without this flag insert after
2002 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003 *cpo-i*
2004 i When included, interrupting the reading of a file will
2005 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002006 *cpo-I*
2007 I When moving the cursor up or down just after inserting
2008 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 *cpo-j*
2010 j When joining lines, only add two spaces after a '.',
2011 not after '!' or '?'. Also see 'joinspaces'.
2012 *cpo-J*
2013 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002014 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002015 white space.
2016 *cpo-k*
2017 k Disable the recognition of raw key codes in
2018 mappings, abbreviations, and the "to" part of menu
2019 commands. For example, if <Key> sends ^[OA (where ^[
2020 is <Esc>), the command ":map X ^[OA" results in X
2021 being mapped to:
2022 'k' included: "^[OA" (3 characters)
2023 'k' excluded: "<Key>" (one key code)
2024 Also see the '<' flag below.
2025 *cpo-K*
2026 K Don't wait for a key code to complete when it is
2027 halfway a mapping. This breaks mapping <F1><F1> when
2028 only part of the second <F1> has been read. It
2029 enables cancelling the mapping by typing <F1><Esc>.
2030 *cpo-l*
2031 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002032 literally, only "\]", "\^", "\-" and "\\" are special.
2033 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2035 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002036 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 *cpo-L*
2038 L When the 'list' option is set, 'wrapmargin',
2039 'textwidth', 'softtabstop' and Virtual Replace mode
2040 (see |gR|) count a <Tab> as two characters, instead of
2041 the normal behavior of a <Tab>.
2042 *cpo-m*
2043 m When included, a showmatch will always wait half a
2044 second. When not included, a showmatch will wait half
2045 a second or until a character is typed. |'showmatch'|
2046 *cpo-M*
2047 M When excluded, "%" matching will take backslashes into
2048 account. Thus in "( \( )" and "\( ( \)" the outer
2049 parenthesis match. When included "%" ignores
2050 backslashes, which is Vi compatible.
2051 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002052 n When included, the column used for 'number' and
2053 'relativenumber' will also be used for text of wrapped
2054 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 *cpo-o*
2056 o Line offset to search command is not remembered for
2057 next search.
2058 *cpo-O*
2059 O Don't complain if a file is being overwritten, even
2060 when it didn't exist when editing it. This is a
2061 protection against a file unexpectedly created by
2062 someone else. Vi didn't complain about this.
2063 *cpo-p*
2064 p Vi compatible Lisp indenting. When not present, a
2065 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002066 *cpo-P*
2067 P When included, a ":write" command that appends to a
2068 file will set the file name for the current buffer, if
2069 the current buffer doesn't have a file name yet and
2070 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002071 *cpo-q*
2072 q When joining multiple lines leave the cursor at the
2073 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074 *cpo-r*
2075 r Redo ("." command) uses "/" to repeat a search
2076 command, instead of the actually used search string.
2077 *cpo-R*
2078 R Remove marks from filtered lines. Without this flag
2079 marks are kept like |:keepmarks| was used.
2080 *cpo-s*
2081 s Set buffer options when entering the buffer for the
2082 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002083 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002084 set when the buffer is created.
2085 *cpo-S*
2086 S Set buffer options always when entering a buffer
2087 (except 'readonly', 'fileformat', 'filetype' and
2088 'syntax'). This is the (most) Vi compatible setting.
2089 The options are set to the values in the current
2090 buffer. When you change an option and go to another
2091 buffer, the value is copied. Effectively makes the
2092 buffer options global to all buffers.
2093
2094 's' 'S' copy buffer options
2095 no no when buffer created
2096 yes no when buffer first entered (default)
2097 X yes each time when buffer entered (vi comp.)
2098 *cpo-t*
2099 t Search pattern for the tag command is remembered for
2100 "n" command. Otherwise Vim only puts the pattern in
2101 the history for search pattern, but doesn't change the
2102 last used search pattern.
2103 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002104 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 *cpo-v*
2106 v Backspaced characters remain visible on the screen in
2107 Insert mode. Without this flag the characters are
2108 erased from the screen right away. With this flag the
2109 screen newly typed text overwrites backspaced
2110 characters.
2111 *cpo-w*
2112 w When using "cw" on a blank character, only change one
2113 character and not all blanks until the start of the
2114 next word.
2115 *cpo-W*
2116 W Don't overwrite a readonly file. When omitted, ":w!"
2117 overwrites a readonly file, if possible.
2118 *cpo-x*
2119 x <Esc> on the command-line executes the command-line.
2120 The default in Vim is to abandon the command-line,
2121 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002122 *cpo-X*
2123 X When using a count with "R" the replaced text is
2124 deleted only once. Also when repeating "R" with "."
2125 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 *cpo-y*
2127 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002128 *cpo-Z*
2129 Z When using "w!" while the 'readonly' option is set,
2130 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 *cpo-!*
2132 ! When redoing a filter command, use the last used
2133 external command, whatever it was. Otherwise the last
2134 used -filter- command is used.
2135 *cpo-$*
2136 $ When making a change to one line, don't redisplay the
2137 line, but put a '$' at the end of the changed text.
2138 The changed text will be overwritten when you type the
2139 new text. The line is redisplayed if you type any
2140 command that moves the cursor from the insertion
2141 point.
2142 *cpo-%*
2143 % Vi-compatible matching is done for the "%" command.
2144 Does not recognize "#if", "#endif", etc.
2145 Does not recognize "/*" and "*/".
2146 Parens inside single and double quotes are also
2147 counted, causing a string that contains a paren to
2148 disturb the matching. For example, in a line like
2149 "if (strcmp("foo(", s))" the first paren does not
2150 match the last one. When this flag is not included,
2151 parens inside single and double quotes are treated
2152 specially. When matching a paren outside of quotes,
2153 everything inside quotes is ignored. When matching a
2154 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002155 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002156 This flag is also used for other features, such as
2157 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002158 *cpo--*
2159 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002160 it would go above the first line or below the last
2161 line. Without it the cursor moves to the first or
2162 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002163 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002164 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002165 *cpo-+*
2166 + When included, a ":write file" command will reset the
2167 'modified' flag of the buffer, even though the buffer
2168 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002169 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170 * Use ":*" in the same way as ":@". When not included,
2171 ":*" is an alias for ":'<,'>", select the Visual area.
2172 *cpo-<*
2173 < Disable the recognition of special key codes in |<>|
2174 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002175 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 ":map X <Tab>" results in X being mapped to:
2177 '<' included: "<Tab>" (5 characters)
2178 '<' excluded: "^I" (^I is a real <Tab>)
2179 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002180 *cpo->*
2181 > When appending to a register, put a line break before
2182 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002183 *cpo-;*
2184 ; When using |,| or |;| to repeat the last |t| search
2185 and the cursor is right in front of the searched
2186 character, the cursor won't move. When not included,
2187 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002188 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002189
2190 POSIX flags. These are not included in the Vi default value, except
2191 when $VIM_POSIX was set on startup. |posix|
2192
2193 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002194 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002195 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002196 *cpo-&*
2197 & When ":preserve" was used keep the swap file when
2198 exiting normally while this buffer is still loaded.
2199 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002200 *cpo-\*
2201 \ Backslash in a [] range in a search pattern is taken
2202 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002203 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2204 '\' excluded: "/[ \-]" finds <Space> and '-'
2205 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002206 *cpo-/*
2207 / When "%" is used as the replacement string in a |:s|
2208 command, use the previous replacement string. |:s%|
2209 *cpo-{*
2210 { The |{| and |}| commands also stop at a "{" character
2211 at the start of a line.
2212 *cpo-.*
2213 . The ":chdir" and ":cd" commands fail if the current
2214 buffer is modified, unless ! is used. Vim doesn't
2215 need this, since it remembers the full path of an
2216 opened file.
2217 *cpo-bar*
2218 | The value of the $LINES and $COLUMNS environment
2219 variables overrule the terminal size values obtained
2220 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002221
Bram Moolenaar071d4272004-06-13 20:20:40 +00002222
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002223 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002224'cryptmethod' string (default "zip")
2225 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002226 {not in Vi}
2227 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002228 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002229 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002230 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002231 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002232 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002233 or later, files can NOT be read by Vim 7.2 and older.
2234 This adds a "seed" to the file, every time you write
2235 the file the encrypted bytes will be different.
2236
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002237 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002238 to the detected method of the file being read. Thus if you write it
2239 without changing 'cryptmethod' the same method will be used.
2240 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002241 explicitly write it, you don't get a warning unless there are other
2242 modifications. Also see |:X|.
2243
2244 When setting the global value to an empty string, it will end up with
2245 the value "zip". When setting the local value to an empty string the
2246 buffer will use the global value.
2247
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002248 When a new encryption method is added in a later version of Vim, and
2249 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002250 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002251
2252
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 *'cscopepathcomp'* *'cspc'*
2254'cscopepathcomp' 'cspc' number (default 0)
2255 global
2256 {not available when compiled without the |+cscope|
2257 feature}
2258 {not in Vi}
2259 Determines how many components of the path to show in a list of tags.
2260 See |cscopepathcomp|.
2261
2262 *'cscopeprg'* *'csprg'*
2263'cscopeprg' 'csprg' string (default "cscope")
2264 global
2265 {not available when compiled without the |+cscope|
2266 feature}
2267 {not in Vi}
2268 Specifies the command to execute cscope. See |cscopeprg|.
2269 This option cannot be set from a |modeline| or in the |sandbox|, for
2270 security reasons.
2271
2272 *'cscopequickfix'* *'csqf'*
2273'cscopequickfix' 'csqf' string (default "")
2274 global
2275 {not available when compiled without the |+cscope|
2276 or |+quickfix| features}
2277 {not in Vi}
2278 Specifies whether to use quickfix window to show cscope results.
2279 See |cscopequickfix|.
2280
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002281 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002282'cscoperelative' 'csre' boolean (default off)
2283 global
2284 {not available when compiled without the |+cscope|
2285 feature}
2286 {not in Vi}
2287 In the absence of a prefix (-P) for cscope. setting this option enables
2288 to use the basename of cscope.out path as the prefix.
2289 See |cscoperelative|.
2290
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2292'cscopetag' 'cst' boolean (default off)
2293 global
2294 {not available when compiled without the |+cscope|
2295 feature}
2296 {not in Vi}
2297 Use cscope for tag commands. See |cscope-options|.
2298 NOTE: This option is reset when 'compatible' is set.
2299
2300 *'cscopetagorder'* *'csto'*
2301'cscopetagorder' 'csto' number (default 0)
2302 global
2303 {not available when compiled without the |+cscope|
2304 feature}
2305 {not in Vi}
2306 Determines the order in which ":cstag" performs a search. See
2307 |cscopetagorder|.
2308 NOTE: This option is set to 0 when 'compatible' is set.
2309
2310 *'cscopeverbose'* *'csverb'*
2311 *'nocscopeverbose'* *'nocsverb'*
2312'cscopeverbose' 'csverb' boolean (default off)
2313 global
2314 {not available when compiled without the |+cscope|
2315 feature}
2316 {not in Vi}
2317 Give messages when adding a cscope database. See |cscopeverbose|.
2318 NOTE: This option is reset when 'compatible' is set.
2319
Bram Moolenaar860cae12010-06-05 23:22:07 +02002320 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2321'cursorbind' 'crb' boolean (default off)
2322 local to window
2323 {not in Vi}
2324 {not available when compiled without the |+cursorbind|
2325 feature}
2326 When this option is set, as the cursor in the current
2327 window moves other cursorbound windows (windows that also have
2328 this option set) move their cursors to the corresponding line and
2329 column. This option is useful for viewing the
2330 differences between two versions of a file (see 'diff'); in diff mode,
2331 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002332 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002333
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002334
2335 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2336'cursorcolumn' 'cuc' boolean (default off)
2337 local to window
2338 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002339 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002340 feature}
2341 Highlight the screen column of the cursor with CursorColumn
2342 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2343 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002344 If you only want the highlighting in the current window you can use
2345 these autocommands: >
2346 au WinLeave * set nocursorline nocursorcolumn
2347 au WinEnter * set cursorline cursorcolumn
2348<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002349
2350 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2351'cursorline' 'cul' boolean (default off)
2352 local to window
2353 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002354 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002355 feature}
2356 Highlight the screen line of the cursor with CursorLine
2357 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2358 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002359 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002360 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002361
2362
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 *'debug'*
2364'debug' string (default "")
2365 global
2366 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002367 These values can be used:
2368 msg Error messages that would otherwise be omitted will be given
2369 anyway.
2370 throw Error messages that would otherwise be omitted will be given
2371 anyway and also throw an exception and set |v:errmsg|.
2372 beep A message will be given when otherwise only a beep would be
2373 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002374 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002375 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2376 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377
2378 *'define'* *'def'*
2379'define' 'def' string (default "^\s*#\s*define")
2380 global or local to buffer |global-local|
2381 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002382 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383 pattern, just like for the "/" command. This option is used for the
2384 commands like "[i" and "[d" |include-search|. The 'isident' option is
2385 used to recognize the defined name after the match:
2386 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2387 See |option-backslash| about inserting backslashes to include a space
2388 or backslash.
2389 The default value is for C programs. For C++ this value would be
2390 useful, to include const type declarations: >
2391 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2392< When using the ":set" command, you need to double the backslashes!
2393
2394 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2395'delcombine' 'deco' boolean (default off)
2396 global
2397 {not in Vi}
2398 {only available when compiled with the |+multi_byte|
2399 feature}
2400 If editing Unicode and this option is set, backspace and Normal mode
2401 "x" delete each combining character on its own. When it is off (the
2402 default) the character along with its combining characters are
2403 deleted.
2404 Note: When 'delcombine' is set "xx" may work different from "2x"!
2405
2406 This is useful for Arabic, Hebrew and many other languages where one
2407 may have combining characters overtop of base characters, and want
2408 to remove only the combining ones.
2409
2410 *'dictionary'* *'dict'*
2411'dictionary' 'dict' string (default "")
2412 global or local to buffer |global-local|
2413 {not in Vi}
2414 List of file names, separated by commas, that are used to lookup words
2415 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2416 contain a list of words. This can be one word per line, or several
2417 words per line, separated by non-keyword characters (white space is
2418 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002419 When this option is empty, or an entry "spell" is present, spell
2420 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002421 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002422 after a comma are ignored, otherwise spaces are included in the file
2423 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002424 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002425 Where to find a list of words?
2426 - On FreeBSD, there is the file "/usr/share/dict/words".
2427 - In the Simtel archive, look in the "msdos/linguist" directory.
2428 - In "miscfiles" of the GNU collection.
2429 The use of |:set+=| and |:set-=| is preferred when adding or removing
2430 directories from the list. This avoids problems when a future version
2431 uses another default.
2432 Backticks cannot be used in this option for security reasons.
2433
2434 *'diff'* *'nodiff'*
2435'diff' boolean (default off)
2436 local to window
2437 {not in Vi}
2438 {not available when compiled without the |+diff|
2439 feature}
2440 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002441 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002442
2443 *'dex'* *'diffexpr'*
2444'diffexpr' 'dex' string (default "")
2445 global
2446 {not in Vi}
2447 {not available when compiled without the |+diff|
2448 feature}
2449 Expression which is evaluated to obtain an ed-style diff file from two
2450 versions of a file. See |diff-diffexpr|.
2451 This option cannot be set from a |modeline| or in the |sandbox|, for
2452 security reasons.
2453
2454 *'dip'* *'diffopt'*
2455'diffopt' 'dip' string (default "filler")
2456 global
2457 {not in Vi}
2458 {not available when compiled without the |+diff|
2459 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002460 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002461 All are optional. Items must be separated by a comma.
2462
2463 filler Show filler lines, to keep the text
2464 synchronized with a window that has inserted
2465 lines at the same position. Mostly useful
2466 when windows are side-by-side and 'scrollbind'
2467 is set.
2468
2469 context:{n} Use a context of {n} lines between a change
2470 and a fold that contains unchanged lines.
2471 When omitted a context of six lines is used.
2472 See |fold-diff|.
2473
2474 icase Ignore changes in case of text. "a" and "A"
2475 are considered the same. Adds the "-i" flag
2476 to the "diff" command if 'diffexpr' is empty.
2477
2478 iwhite Ignore changes in amount of white space. Adds
2479 the "-b" flag to the "diff" command if
2480 'diffexpr' is empty. Check the documentation
2481 of the "diff" command for what this does
2482 exactly. It should ignore adding trailing
2483 white space, but not leading white space.
2484
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002485 horizontal Start diff mode with horizontal splits (unless
2486 explicitly specified otherwise).
2487
2488 vertical Start diff mode with vertical splits (unless
2489 explicitly specified otherwise).
2490
2491 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2492 starting diff mode. Without this 2 is used.
2493
Bram Moolenaar071d4272004-06-13 20:20:40 +00002494 Examples: >
2495
2496 :set diffopt=filler,context:4
2497 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002498 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002499<
2500 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2501'digraph' 'dg' boolean (default off)
2502 global
2503 {not in Vi}
2504 {not available when compiled without the |+digraphs|
2505 feature}
2506 Enable the entering of digraphs in Insert mode with {char1} <BS>
2507 {char2}. See |digraphs|.
2508 NOTE: This option is reset when 'compatible' is set.
2509
2510 *'directory'* *'dir'*
2511'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002512 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002513 for Unix: ".,~/tmp,/var/tmp,/tmp")
2514 global
2515 List of directory names for the swap file, separated with commas.
2516 - The swap file will be created in the first directory where this is
2517 possible.
2518 - Empty means that no swap file will be used (recovery is
2519 impossible!).
2520 - A directory "." means to put the swap file in the same directory as
2521 the edited file. On Unix, a dot is prepended to the file name, so
2522 it doesn't show in a directory listing. On MS-Windows the "hidden"
2523 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002524 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 put the swap file relative to where the edited file is. The leading
2526 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002527 - For Unix and Win32, if a directory ends in two path separators "//"
2528 or "\\", the swap file name will be built from the complete path to
2529 the file with all path separators substituted to percent '%' signs.
2530 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002531 On Win32, when a separating comma is following, you must use "//",
2532 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002533 - Spaces after the comma are ignored, other spaces are considered part
2534 of the directory name. To have a space at the start of a directory
2535 name, precede it with a backslash.
2536 - To include a comma in a directory name precede it with a backslash.
2537 - A directory name may end in an ':' or '/'.
2538 - Environment variables are expanded |:set_env|.
2539 - Careful with '\' characters, type one before a space, type two to
2540 get one in the option (see |option-backslash|), for example: >
2541 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2542< - For backwards compatibility with Vim version 3.0 a '>' at the start
2543 of the option is removed.
2544 Using "." first in the list is recommended. This means that editing
2545 the same file twice will result in a warning. Using "/tmp" on Unix is
2546 discouraged: When the system crashes you lose the swap file.
2547 "/var/tmp" is often not cleared when rebooting, thus is a better
2548 choice than "/tmp". But it can contain a lot of files, your swap
2549 files get lost in the crowd. That is why a "tmp" directory in your
2550 home directory is tried first.
2551 The use of |:set+=| and |:set-=| is preferred when adding or removing
2552 directories from the list. This avoids problems when a future version
2553 uses another default.
2554 This option cannot be set from a |modeline| or in the |sandbox|, for
2555 security reasons.
2556 {Vi: directory to put temp file in, defaults to "/tmp"}
2557
2558 *'display'* *'dy'*
2559'display' 'dy' string (default "")
2560 global
2561 {not in Vi}
2562 Change the way text is displayed. This is comma separated list of
2563 flags:
2564 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002565 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566 last line that doesn't fit is replaced with "@" lines.
2567 uhex Show unprintable characters hexadecimal as <xx>
2568 instead of using ^C and ~C.
2569
2570 *'eadirection'* *'ead'*
2571'eadirection' 'ead' string (default "both")
2572 global
2573 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002574 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 feature}
2576 Tells when the 'equalalways' option applies:
2577 ver vertically, width of windows is not affected
2578 hor horizontally, height of windows is not affected
2579 both width and height of windows is affected
2580
2581 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2582'edcompatible' 'ed' boolean (default off)
2583 global
2584 Makes the 'g' and 'c' flags of the ":substitute" command to be
2585 toggled each time the flag is given. See |complex-change|. See
2586 also 'gdefault' option.
2587 Switching this option on is discouraged!
2588
2589 *'encoding'* *'enc'* *E543*
2590'encoding' 'enc' string (default: "latin1" or value from $LANG)
2591 global
2592 {only available when compiled with the |+multi_byte|
2593 feature}
2594 {not in Vi}
2595 Sets the character encoding used inside Vim. It applies to text in
2596 the buffers, registers, Strings in expressions, text stored in the
2597 viminfo file, etc. It sets the kind of characters which Vim can work
2598 with. See |encoding-names| for the possible values.
2599
2600 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002601 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002603 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002604
Bram Moolenaar865242e2010-07-14 21:12:05 +02002605 This option cannot be set from a |modeline|. It would most likely
2606 corrupt the text.
2607
Bram Moolenaar071d4272004-06-13 20:20:40 +00002608 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2609 "utf-8". Although care has been taken to allow different values of
2610 'encoding', "utf-8" is the natural choice for the environment and
2611 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002612 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002613 versions, and to avoid changing the encoding of newly created files
2614 without your knowledge (in case 'fileencodings' is empty).
2615
2616 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002617 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618 iconv() or as specified with 'charconvert'.
2619
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002620 If you need to know whether 'encoding' is a multi-byte encoding, you
2621 can use: >
2622 if has("multi_byte_encoding")
2623<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 Normally 'encoding' will be equal to your current locale. This will
2625 be the default if Vim recognizes your environment settings. If
2626 'encoding' is not set to the current locale, 'termencoding' must be
2627 set to convert typed and displayed text. See |encoding-table|.
2628
2629 When you set this option, it fires the |EncodingChanged| autocommand
2630 event so that you can set up fonts if necessary.
2631
2632 When the option is set, the value is converted to lowercase. Thus
2633 you can set it with uppercase values too. Underscores are translated
2634 to '-' signs.
2635 When the encoding is recognized, it is changed to the standard name.
2636 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2637 "iso-8859-2" and "utf8" becomes "utf-8".
2638
2639 Note: "latin1" is also used when the encoding could not be detected.
2640 This only works when editing files in the same encoding! When the
2641 actual character set is not latin1, make sure 'fileencoding' and
2642 'fileencodings' are empty. When conversion is needed, switch to using
2643 utf-8.
2644
2645 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2646 You don't notice this while editing, but it does matter for the
2647 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2648 setting 'encoding' to one of these values instead of utf-8 only has
2649 effect for encoding used for files when 'fileencoding' is empty.
2650
Bram Moolenaar661b1822005-07-28 22:36:45 +00002651 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2652 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653
2654 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2655'endofline' 'eol' boolean (default on)
2656 local to buffer
2657 {not in Vi}
2658 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002659 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660 option is automatically set when starting to edit a new file, unless
2661 the file does not have an <EOL> for the last line in the file, in
2662 which case it is reset. Normally you don't have to set or reset this
2663 option. When 'binary' is off the value is not used when writing the
2664 file. When 'binary' is on it is used to remember the presence of a
2665 <EOL> for the last line in the file, so that when you write the file
2666 the situation from the original file can be kept. But you can change
2667 it if you want to.
2668
2669 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2670'equalalways' 'ea' boolean (default on)
2671 global
2672 {not in Vi}
2673 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002674 splitting or closing a window. This also happens the moment the
2675 option is switched on. When off, splitting a window will reduce the
2676 size of the current window and leave the other windows the same. When
2677 closing a window the extra lines are given to the window next to it
2678 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679 When mixing vertically and horizontally split windows, a minimal size
2680 is computed and some windows may be larger if there is room. The
2681 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002682 Changing the height and width of a window can be avoided by setting
2683 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002684 If a window size is specified when creating a new window sizes are
2685 currently not equalized (it's complicated, but may be implemented in
2686 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687
2688 *'equalprg'* *'ep'*
2689'equalprg' 'ep' string (default "")
2690 global or local to buffer |global-local|
2691 {not in Vi}
2692 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002693 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002694 or 'indentexpr'. When Vim was compiled without internal formatting,
2695 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002696 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 about including spaces and backslashes.
2698 This option cannot be set from a |modeline| or in the |sandbox|, for
2699 security reasons.
2700
2701 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2702'errorbells' 'eb' boolean (default off)
2703 global
2704 Ring the bell (beep or screen flash) for error messages. This only
2705 makes a difference for error messages, the bell will be used always
2706 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002707 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 screen flash or do nothing.
2709
2710 *'errorfile'* *'ef'*
2711'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2712 others: "errors.err")
2713 global
2714 {not in Vi}
2715 {not available when compiled without the |+quickfix|
2716 feature}
2717 Name of the errorfile for the QuickFix mode (see |:cf|).
2718 When the "-q" command-line argument is used, 'errorfile' is set to the
2719 following argument. See |-q|.
2720 NOT used for the ":make" command. See 'makeef' for that.
2721 Environment variables are expanded |:set_env|.
2722 See |option-backslash| about including spaces and backslashes.
2723 This option cannot be set from a |modeline| or in the |sandbox|, for
2724 security reasons.
2725
2726 *'errorformat'* *'efm'*
2727'errorformat' 'efm' string (default is very long)
2728 global or local to buffer |global-local|
2729 {not in Vi}
2730 {not available when compiled without the |+quickfix|
2731 feature}
2732 Scanf-like description of the format for the lines in the error file
2733 (see |errorformat|).
2734
2735 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2736'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2737 global
2738 {not in Vi}
2739 Function keys that start with an <Esc> are recognized in Insert
2740 mode. When this option is off, the cursor and function keys cannot be
2741 used in Insert mode if they start with an <Esc>. The advantage of
2742 this is that the single <Esc> is recognized immediately, instead of
2743 after one second. Instead of resetting this option, you might want to
2744 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2745 when 'esckeys' is off, you can still map anything, but the cursor keys
2746 won't work by default.
2747 NOTE: This option is set to the Vi default value when 'compatible' is
2748 set and to the Vim default value when 'compatible' is reset.
2749
2750 *'eventignore'* *'ei'*
2751'eventignore' 'ei' string (default "")
2752 global
2753 {not in Vi}
2754 {not available when compiled without the |+autocmd|
2755 feature}
2756 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002757 When set to "all" or when "all" is one of the items, all autocommand
2758 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 Otherwise this is a comma separated list of event names. Example: >
2760 :set ei=WinEnter,WinLeave
2761<
2762 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2763'expandtab' 'et' boolean (default off)
2764 local to buffer
2765 {not in Vi}
2766 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002767 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2769 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2770 NOTE: This option is reset when 'compatible' is set.
2771
2772 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2773'exrc' 'ex' boolean (default off)
2774 global
2775 {not in Vi}
2776 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2777 directory. If you switch this option on you should also consider
2778 setting the 'secure' option (see |initialization|). Using a local
2779 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2780 also see |.vimrc| and |gui-init|.
2781 This option cannot be set from a |modeline| or in the |sandbox|, for
2782 security reasons.
2783
2784 *'fileencoding'* *'fenc'* *E213*
2785'fileencoding' 'fenc' string (default: "")
2786 local to buffer
2787 {only available when compiled with the |+multi_byte|
2788 feature}
2789 {not in Vi}
2790 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002791
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002793 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 When 'fileencoding' is empty, the same value as 'encoding' will be
2795 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002796 Conversion will also be done when 'encoding' and 'fileencoding' are
2797 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2798 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002800 'encoding' is "utf-8" or another Unicode encoding, conversion
2801 is most likely done in a way that the reverse conversion
2802 results in the same text. When 'encoding' is not "utf-8" some
2803 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002804
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805 See 'encoding' for the possible values. Additionally, values may be
2806 specified that can be handled by the converter, see
2807 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002808
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 When reading a file 'fileencoding' will be set from 'fileencodings'.
2810 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002811 'fileencoding', use the |++enc| argument. One exception: when
2812 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002813 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002814
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2816 When the option is set, the value is converted to lowercase. Thus
2817 you can set it with uppercase values too. '_' characters are
2818 replaced with '-'. If a name is recognized from the list for
2819 'encoding', it is replaced by the standard name. For example
2820 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002821
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 When this option is set, after starting to edit a file, the 'modified'
2823 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002824
2825 Keep in mind that changing 'fenc' from a modeline happens
2826 AFTER the text has been read, thus it applies to when the file will be
2827 written. If you do set 'fenc' in a modeline, you might want to set
2828 'nomodified' to avoid not being able to ":q".
2829
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 This option can not be changed when 'modifiable' is off.
2831
2832 *'fe'*
2833 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002834 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002835 old short name was 'fe', which is no longer used.
2836
2837 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002838'fileencodings' 'fencs' string (default: "ucs-bom",
2839 "ucs-bom,utf-8,default,latin1" when
2840 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841 global
2842 {only available when compiled with the |+multi_byte|
2843 feature}
2844 {not in Vi}
2845 This is a list of character encodings considered when starting to edit
2846 an existing file. When a file is read, Vim tries to use the first
2847 mentioned character encoding. If an error is detected, the next one
2848 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002849 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850 an empty string, which means the value of 'encoding' is used.
2851 WARNING: Conversion can cause loss of information! When
2852 'encoding' is "utf-8" (or one of the other Unicode variants)
2853 conversion is most likely done in a way that the reverse
2854 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002855 "utf-8" some non-ASCII characters may be lost! You can use
2856 the |++bad| argument to specify what is done with characters
2857 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858 For an empty file or a file with only ASCII characters most encodings
2859 will work and the first entry of 'fileencodings' will be used (except
2860 "ucs-bom", which requires the BOM to be present). If you prefer
2861 another encoding use an BufReadPost autocommand event to test if your
2862 preferred encoding is to be used. Example: >
2863 au BufReadPost * if search('\S', 'w') == 0 |
2864 \ set fenc=iso-2022-jp | endif
2865< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2866 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002867 When the |++enc| argument is used then the value of 'fileencodings' is
2868 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002869 Note that 'fileencodings' is not used for a new file, the global value
2870 of 'fileencoding' is used instead. You can set it with: >
2871 :setglobal fenc=iso-8859-2
2872< This means that a non-existing file may get a different encoding than
2873 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 The special value "ucs-bom" can be used to check for a Unicode BOM
2875 (Byte Order Mark) at the start of the file. It must not be preceded
2876 by "utf-8" or another Unicode encoding for this to work properly.
2877 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2878 because Vim cannot detect an error, thus the encoding is always
2879 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002880 The special value "default" can be used for the encoding from the
2881 environment. This is the default value for 'encoding'. It is useful
2882 when 'encoding' is set to "utf-8" and your environment uses a
2883 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002884 When 'encoding' is "utf-8" and a file contains an illegal byte
2885 sequence it won't be recognized as UTF-8. You can use the |8g8|
2886 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 WRONG VALUES: WHAT'S WRONG:
2888 latin1,utf-8 "latin1" will always be used
2889 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2890 file
2891 cp1250,latin1 "cp1250" will always be used
2892 If 'fileencodings' is empty, 'fileencoding' is not modified.
2893 See 'fileencoding' for the possible values.
2894 Setting this option does not have an effect until the next time a file
2895 is read.
2896
2897 *'fileformat'* *'ff'*
2898'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2899 Unix default: "unix",
2900 Macintosh default: "mac")
2901 local to buffer
2902 {not in Vi}
2903 This gives the <EOL> of the current buffer, which is used for
2904 reading/writing the buffer from/to a file:
2905 dos <CR> <NL>
2906 unix <NL>
2907 mac <CR>
2908 When "dos" is used, CTRL-Z at the end of a file is ignored.
2909 See |file-formats| and |file-read|.
2910 For the character encoding of the file see 'fileencoding'.
2911 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02002912 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913 This option is set automatically when starting to edit a file and
2914 'fileformats' is not empty and 'binary' is off.
2915 When this option is set, after starting to edit a file, the 'modified'
2916 option is set, because the file would be different when written.
2917 This option can not be changed when 'modifiable' is off.
2918 For backwards compatibility: When this option is set to "dos",
2919 'textmode' is set, otherwise 'textmode' is reset.
2920
2921 *'fileformats'* *'ffs'*
2922'fileformats' 'ffs' string (default:
2923 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2924 Vim Unix: "unix,dos",
2925 Vim Mac: "mac,unix,dos",
2926 Vi Cygwin: "unix,dos",
2927 Vi others: "")
2928 global
2929 {not in Vi}
2930 This gives the end-of-line (<EOL>) formats that will be tried when
2931 starting to edit a new buffer and when reading a file into an existing
2932 buffer:
2933 - When empty, the format defined with 'fileformat' will be used
2934 always. It is not set automatically.
2935 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002936 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937 'fileformats' name will be used when a file is read into an existing
2938 buffer, no matter what 'fileformat' for that buffer is set to.
2939 - When more than one name is present, separated by commas, automatic
2940 <EOL> detection will be done when reading a file. When starting to
2941 edit a file, a check is done for the <EOL>:
2942 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2943 'fileformat' is set to "dos".
2944 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002945 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002947 3. If 'fileformat' has not yet been set, and if 'fileformats'
2948 includes "mac", 'fileformat' is set to "mac".
2949 This means that "mac" is only chosen when:
2950 "unix" is not present or no <NL> is found in the file, and
2951 "dos" is not present or no <CR><NL> is found in the file.
2952 Except: if "unix" was chosen, but there is a <CR> before
2953 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002954 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 4. If 'fileformat' is still not set, the first name from
2956 'fileformats' is used.
2957 When reading a file into an existing buffer, the same is done, but
2958 this happens like 'fileformat' has been set appropriately for that
2959 file only, the option is not changed.
2960 When 'binary' is set, the value of 'fileformats' is not used.
2961
Bram Moolenaar81af9252010-12-10 20:35:50 +01002962 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002963 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002964
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2966 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2967 done:
2968 - When 'fileformats' is empty, there is no automatic detection. Dos
2969 format will be used.
2970 - When 'fileformats' is set to one or more names, automatic detection
2971 is done. This is based on the first <NL> in the file: If there is a
2972 <CR> in front of it, Dos format is used, otherwise Unix format is
2973 used.
2974 Also see |file-formats|.
2975 For backwards compatibility: When this option is set to an empty
2976 string or one format (no comma is included), 'textauto' is reset,
2977 otherwise 'textauto' is set.
2978 NOTE: This option is set to the Vi default value when 'compatible' is
2979 set and to the Vim default value when 'compatible' is reset.
2980
Bram Moolenaarbf884932013-04-05 22:26:15 +02002981 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
2982'fileignorecase' 'fic' boolean (default on for systems where case in file
2983 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002984 global
2985 {not in Vi}
2986 When set case is ignored when using file names and directories.
2987 See 'wildignorecase' for only ignoring case when doing completion.
2988
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 *'filetype'* *'ft'*
2990'filetype' 'ft' string (default: "")
2991 local to buffer
2992 {not in Vi}
2993 {not available when compiled without the |+autocmd|
2994 feature}
2995 When this option is set, the FileType autocommand event is triggered.
2996 All autocommands that match with the value of this option will be
2997 executed. Thus the value of 'filetype' is used in place of the file
2998 name.
2999 Otherwise this option does not always reflect the current file type.
3000 This option is normally set when the file type is detected. To enable
3001 this use the ":filetype on" command. |:filetype|
3002 Setting this option to a different value is most useful in a modeline,
3003 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003004 Example, for in an IDL file:
3005 /* vim: set filetype=idl : */ ~
3006 |FileType| |filetypes|
3007 When a dot appears in the value then this separates two filetype
3008 names. Example:
3009 /* vim: set filetype=c.doxygen : */ ~
3010 This will use the "c" filetype first, then the "doxygen" filetype.
3011 This works both for filetype plugins and for syntax files. More than
3012 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 This option is not copied to another buffer, independent of the 's' or
3014 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003015 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016
3017 *'fillchars'* *'fcs'*
3018'fillchars' 'fcs' string (default "vert:|,fold:-")
3019 global
3020 {not in Vi}
3021 {not available when compiled without the |+windows|
3022 and |+folding| features}
3023 Characters to fill the statuslines and vertical separators.
3024 It is a comma separated list of items:
3025
3026 item default Used for ~
3027 stl:c ' ' or '^' statusline of the current window
3028 stlnc:c ' ' or '-' statusline of the non-current windows
3029 vert:c '|' vertical separators |:vsplit|
3030 fold:c '-' filling 'foldtext'
3031 diff:c '-' deleted lines of the 'diff' option
3032
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003033 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 "stlnc" the space will be used when there is highlighting, '^' or '-'
3035 otherwise.
3036
3037 Example: >
3038 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
3039< This is similar to the default, except that these characters will also
3040 be used when there is highlighting.
3041
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003042 for "stl" and "stlnc" only single-byte values are supported.
3043
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 The highlighting used for these items:
3045 item highlight group ~
3046 stl:c StatusLine |hl-StatusLine|
3047 stlnc:c StatusLineNC |hl-StatusLineNC|
3048 vert:c VertSplit |hl-VertSplit|
3049 fold:c Folded |hl-Folded|
3050 diff:c DiffDelete |hl-DiffDelete|
3051
3052 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3053'fkmap' 'fk' boolean (default off) *E198*
3054 global
3055 {not in Vi}
3056 {only available when compiled with the |+rightleft|
3057 feature}
3058 When on, the keyboard is mapped for the Farsi character set.
3059 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003060 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061
3062 *'foldclose'* *'fcl'*
3063'foldclose' 'fcl' string (default "")
3064 global
3065 {not in Vi}
3066 {not available when compiled without the |+folding|
3067 feature}
3068 When set to "all", a fold is closed when the cursor isn't in it and
3069 its level is higher than 'foldlevel'. Useful if you want folds to
3070 automatically close when moving out of them.
3071
3072 *'foldcolumn'* *'fdc'*
3073'foldcolumn' 'fdc' number (default 0)
3074 local to window
3075 {not in Vi}
3076 {not available when compiled without the |+folding|
3077 feature}
3078 When non-zero, a column with the specified width is shown at the side
3079 of the window which indicates open and closed folds. The maximum
3080 value is 12.
3081 See |folding|.
3082
3083 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3084'foldenable' 'fen' boolean (default on)
3085 local to window
3086 {not in Vi}
3087 {not available when compiled without the |+folding|
3088 feature}
3089 When off, all folds are open. This option can be used to quickly
3090 switch between showing all text unfolded and viewing the text with
3091 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003092 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 'foldenable' is off.
3094 This option is set by commands that create a new fold or close a fold.
3095 See |folding|.
3096
3097 *'foldexpr'* *'fde'*
3098'foldexpr' 'fde' string (default: "0")
3099 local to window
3100 {not in Vi}
3101 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003102 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003104 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003105
Bram Moolenaar30b65812012-07-12 22:01:11 +02003106 The expression will be evaluated in the |sandbox| if set from a
3107 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003108 This option can't be set from a |modeline| when the 'diff' option is
3109 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003110
3111 It is not allowed to change text or jump to another window while
3112 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113
3114 *'foldignore'* *'fdi'*
3115'foldignore' 'fdi' string (default: "#")
3116 local to window
3117 {not in Vi}
3118 {not available when compiled without the |+folding|
3119 feature}
3120 Used only when 'foldmethod' is "indent". Lines starting with
3121 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003122 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 The default "#" works well for C programs. See |fold-indent|.
3124
3125 *'foldlevel'* *'fdl'*
3126'foldlevel' 'fdl' number (default: 0)
3127 local to window
3128 {not in Vi}
3129 {not available when compiled without the |+folding|
3130 feature}
3131 Sets the fold level: Folds with a higher level will be closed.
3132 Setting this option to zero will close all folds. Higher numbers will
3133 close fewer folds.
3134 This option is set by commands like |zm|, |zM| and |zR|.
3135 See |fold-foldlevel|.
3136
3137 *'foldlevelstart'* *'fdls'*
3138'foldlevelstart' 'fdls' number (default: -1)
3139 global
3140 {not in Vi}
3141 {not available when compiled without the |+folding|
3142 feature}
3143 Sets 'foldlevel' when starting to edit another buffer in a window.
3144 Useful to always start editing with all folds closed (value zero),
3145 some folds closed (one) or no folds closed (99).
3146 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003147 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 ignores this option and closes all folds.
3149 It is also done before BufReadPre autocommands, to allow an autocmd to
3150 overrule the 'foldlevel' value for specific files.
3151 When the value is negative, it is not used.
3152
3153 *'foldmarker'* *'fmr'* *E536*
3154'foldmarker' 'fmr' string (default: "{{{,}}}")
3155 local to window
3156 {not in Vi}
3157 {not available when compiled without the |+folding|
3158 feature}
3159 The start and end marker used when 'foldmethod' is "marker". There
3160 must be one comma, which separates the start and end marker. The
3161 marker is a literal string (a regular expression would be too slow).
3162 See |fold-marker|.
3163
3164 *'foldmethod'* *'fdm'*
3165'foldmethod' 'fdm' string (default: "manual")
3166 local to window
3167 {not in Vi}
3168 {not available when compiled without the |+folding|
3169 feature}
3170 The kind of folding used for the current window. Possible values:
3171 |fold-manual| manual Folds are created manually.
3172 |fold-indent| indent Lines with equal indent form a fold.
3173 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3174 |fold-marker| marker Markers are used to specify folds.
3175 |fold-syntax| syntax Syntax highlighting items specify folds.
3176 |fold-diff| diff Fold text that is not changed.
3177
3178 *'foldminlines'* *'fml'*
3179'foldminlines' 'fml' number (default: 1)
3180 local to window
3181 {not in Vi}
3182 {not available when compiled without the |+folding|
3183 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003184 Sets the number of screen lines above which a fold can be displayed
3185 closed. Also for manually closed folds. With the default value of
3186 one a fold can only be closed if it takes up two or more screen lines.
3187 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003188 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 "zc" to close a fold, which is displayed open because it's smaller
3190 than 'foldminlines', a following "zc" may close a containing fold.
3191
3192 *'foldnestmax'* *'fdn'*
3193'foldnestmax' 'fdn' number (default: 20)
3194 local to window
3195 {not in Vi}
3196 {not available when compiled without the |+folding|
3197 feature}
3198 Sets the maximum nesting of folds for the "indent" and "syntax"
3199 methods. This avoids that too many folds will be created. Using more
3200 than 20 doesn't work, because the internal limit is 20.
3201
3202 *'foldopen'* *'fdo'*
3203'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3204 search,tag,undo")
3205 global
3206 {not in Vi}
3207 {not available when compiled without the |+folding|
3208 feature}
3209 Specifies for which type of commands folds will be opened, if the
3210 command moves the cursor into a closed fold. It is a comma separated
3211 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003212 NOTE: When the command is part of a mapping this option is not used.
3213 Add the |zv| command to the mapping to get the same effect.
3214 (rationale: the mapping may want to control opening folds itself)
3215
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 item commands ~
3217 all any
3218 block "(", "{", "[[", "[{", etc.
3219 hor horizontal movements: "l", "w", "fx", etc.
3220 insert any command in Insert mode
3221 jump far jumps: "G", "gg", etc.
3222 mark jumping to a mark: "'m", CTRL-O, etc.
3223 percent "%"
3224 quickfix ":cn", ":crew", ":make", etc.
3225 search search for a pattern: "/", "n", "*", "gd", etc.
3226 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003227 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 tag jumping to a tag: ":ta", CTRL-T, etc.
3229 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 When a movement command is used for an operator (e.g., "dl" or "y%")
3231 this option is not used. This means the operator will include the
3232 whole closed fold.
3233 Note that vertical movements are not here, because it would make it
3234 very difficult to move onto a closed fold.
3235 In insert mode the folds containing the cursor will always be open
3236 when text is inserted.
3237 To close folds you can re-apply 'foldlevel' with the |zx| command or
3238 set the 'foldclose' option to "all".
3239
3240 *'foldtext'* *'fdt'*
3241'foldtext' 'fdt' string (default: "foldtext()")
3242 local to window
3243 {not in Vi}
3244 {not available when compiled without the |+folding|
3245 feature}
3246 An expression which is used to specify the text displayed for a closed
3247 fold. See |fold-foldtext|.
3248
Bram Moolenaar30b65812012-07-12 22:01:11 +02003249 The expression will be evaluated in the |sandbox| if set from a
3250 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003251
3252 It is not allowed to change text or jump to another window while
3253 evaluating 'foldtext' |textlock|.
3254
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 *'formatoptions'* *'fo'*
3256'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3257 local to buffer
3258 {not in Vi}
3259 This is a sequence of letters which describes how automatic
3260 formatting is to be done. See |fo-table|. When the 'paste' option is
3261 on, no formatting is done (like 'formatoptions' is empty). Commas can
3262 be inserted for readability.
3263 To avoid problems with flags that are added in the future, use the
3264 "+=" and "-=" feature of ":set" |add-option-flags|.
3265 NOTE: This option is set to the Vi default value when 'compatible' is
3266 set and to the Vim default value when 'compatible' is reset.
3267
Bram Moolenaar86b68352004-12-27 21:59:20 +00003268 *'formatlistpat'* *'flp'*
3269'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3270 local to buffer
3271 {not in Vi}
3272 A pattern that is used to recognize a list header. This is used for
3273 the "n" flag in 'formatoptions'.
3274 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003275 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003276 while still checking more characters. There must be a character
3277 following the pattern, when it matches the whole line it is handled
3278 like there is no match.
3279 The default recognizes a number, followed by an optional punctuation
3280 character and white space.
3281
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 *'formatprg'* *'fp'*
3283'formatprg' 'fp' string (default "")
3284 global
3285 {not in Vi}
3286 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003287 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003289 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003290 If the 'formatexpr' option is not empty it will be used instead.
3291 Otherwise, if 'formatprg' option is an empty string, the internal
3292 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003293 Environment variables are expanded |:set_env|. See |option-backslash|
3294 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003295 This option cannot be set from a |modeline| or in the |sandbox|, for
3296 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003298 *'formatexpr'* *'fex'*
3299'formatexpr' 'fex' string (default "")
3300 local to buffer
3301 {not in Vi}
3302 {not available when compiled without the |+eval|
3303 feature}
3304 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003305 operator or automatic formatting (see 'formatoptions'). When this
3306 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003307
3308 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003309 The |v:count| variable holds the number of lines to be formatted.
3310 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003311 inserted if the expression is being evaluated due to
3312 automatic formatting. This can be empty. Don't insert
3313 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003314
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003315 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003316 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003317< This will invoke the mylang#Format() function in the
3318 autoload/mylang.vim file in 'runtimepath'. |autoload|
3319
3320 The expression is also evaluated when 'textwidth' is set and adding
3321 text beyond that limit. This happens under the same conditions as
3322 when internal formatting is used. Make sure the cursor is kept in the
3323 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003324 return "i" or "R" in this situation.
3325
3326 When the expression evaluates to non-zero Vim will fall back to using
3327 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003328
Bram Moolenaar30b65812012-07-12 22:01:11 +02003329 The expression will be evaluated in the |sandbox| when set from a
3330 modeline, see |sandbox-option|. That stops the option from working,
3331 since changing the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003332
3333 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003334'fsync' 'fs' boolean (default on)
3335 global
3336 {not in Vi}
3337 When on, the library function fsync() will be called after writing a
3338 file. This will flush a file to disk, ensuring that it is safely
3339 written even on filesystems which do metadata-only journaling. This
3340 will force the harddrive to spin up on Linux systems running in laptop
3341 mode, so it may be undesirable in some situations. Be warned that
3342 turning this off increases the chances of data loss after a crash. On
3343 systems without an fsync() implementation, this variable is always
3344 off.
3345 Also see 'swapsync' for controlling fsync() on swap files.
3346
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3348'gdefault' 'gd' boolean (default off)
3349 global
3350 {not in Vi}
3351 When on, the ":substitute" flag 'g' is default on. This means that
3352 all matches in a line are substituted instead of one. When a 'g' flag
3353 is given to a ":substitute" command, this will toggle the substitution
3354 of all or one match. See |complex-change|.
3355
3356 command 'gdefault' on 'gdefault' off ~
3357 :s/// subst. all subst. one
3358 :s///g subst. one subst. all
3359 :s///gg subst. all subst. one
3360
3361 NOTE: This option is reset when 'compatible' is set.
3362
3363 *'grepformat'* *'gfm'*
3364'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3365 global
3366 {not in Vi}
3367 Format to recognize for the ":grep" command output.
3368 This is a scanf-like string that uses the same format as the
3369 'errorformat' option: see |errorformat|.
3370
3371 *'grepprg'* *'gp'*
3372'grepprg' 'gp' string (default "grep -n ",
3373 Unix: "grep -n $* /dev/null",
3374 Win32: "findstr /n" or "grep -n",
3375 VMS: "SEARCH/NUMBERS ")
3376 global or local to buffer |global-local|
3377 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003378 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 and '#' characters, which are expanded like when used in a command-
3380 line. The placeholder "$*" is allowed to specify where the arguments
3381 will be included. Environment variables are expanded |:set_env|. See
3382 |option-backslash| about including spaces and backslashes.
3383 When your "grep" accepts the "-H" argument, use this to make ":grep"
3384 also work well with a single file: >
3385 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003386< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003387 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3388 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003389 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 apply equally to 'grepprg'.
3391 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3392 otherwise it's "grep -n".
3393 This option cannot be set from a |modeline| or in the |sandbox|, for
3394 security reasons.
3395
3396 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3397'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3398 ve:ver35-Cursor,
3399 o:hor50-Cursor,
3400 i-ci:ver25-Cursor/lCursor,
3401 r-cr:hor20-Cursor/lCursor,
3402 sm:block-Cursor
3403 -blinkwait175-blinkoff150-blinkon175",
3404 for MS-DOS and Win32 console:
3405 "n-v-c:block,o:hor50,i-ci:hor15,
3406 r-cr:hor30,sm:block")
3407 global
3408 {not in Vi}
3409 {only available when compiled with GUI enabled, and
3410 for MS-DOS and Win32 console}
3411 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003412 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413 the height of the cursor can be changed. This can be done by
3414 specifying a block cursor, or a percentage for a vertical or
3415 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003416 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003418 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 mode-list and an argument-list:
3420 mode-list:argument-list,mode-list:argument-list,..
3421 The mode-list is a dash separated list of these modes:
3422 n Normal mode
3423 v Visual mode
3424 ve Visual mode with 'selection' "exclusive" (same as 'v',
3425 if not specified)
3426 o Operator-pending mode
3427 i Insert mode
3428 r Replace mode
3429 c Command-line Normal (append) mode
3430 ci Command-line Insert mode
3431 cr Command-line Replace mode
3432 sm showmatch in Insert mode
3433 a all modes
3434 The argument-list is a dash separated list of these arguments:
3435 hor{N} horizontal bar, {N} percent of the character height
3436 ver{N} vertical bar, {N} percent of the character width
3437 block block cursor, fills the whole character
3438 [only one of the above three should be present]
3439 blinkwait{N} *cursor-blinking*
3440 blinkon{N}
3441 blinkoff{N}
3442 blink times for cursor: blinkwait is the delay before
3443 the cursor starts blinking, blinkon is the time that
3444 the cursor is shown and blinkoff is the time that the
3445 cursor is not shown. The times are in msec. When one
3446 of the numbers is zero, there is no blinking. The
3447 default is: "blinkwait700-blinkon400-blinkoff250".
3448 These numbers are used for a missing entry. This
3449 means that blinking is enabled by default. To switch
3450 blinking off you can use "blinkon0". The cursor only
3451 blinks when Vim is waiting for input, not while
3452 executing a command.
3453 To make the cursor blink in an xterm, see
3454 |xterm-blink|.
3455 {group-name}
3456 a highlight group name, that sets the color and font
3457 for the cursor
3458 {group-name}/{group-name}
3459 Two highlight group names, the first is used when
3460 no language mappings are used, the other when they
3461 are. |language-mapping|
3462
3463 Examples of parts:
3464 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3465 block cursor with colors from the "nCursor"
3466 highlight group
3467 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3468 In Insert and Command-line Insert mode, use a
3469 30% vertical bar cursor with colors from the
3470 "iCursor" highlight group. Blink a bit
3471 faster.
3472
3473 The 'a' mode is different. It will set the given argument-list for
3474 all modes. It does not reset anything to defaults. This can be used
3475 to do a common setting for all modes. For example, to switch off
3476 blinking: "a:blinkon0"
3477
3478 Examples of cursor highlighting: >
3479 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3480 :highlight Cursor gui=NONE guifg=bg guibg=fg
3481<
3482 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003483 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484'guifont' 'gfn' string (default "")
3485 global
3486 {not in Vi}
3487 {only available when compiled with GUI enabled}
3488 This is a list of fonts which will be used for the GUI version of Vim.
3489 In its simplest form the value is just one font name. When
3490 the font cannot be found you will get an error message. To try other
3491 font names a list can be specified, font names separated with commas.
3492 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003493
Bram Moolenaar05159a02005-02-26 23:04:13 +00003494 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3495 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003496
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 Spaces after a comma are ignored. To include a comma in a font name
3498 precede it with a backslash. Setting an option requires an extra
3499 backslash before a space and a backslash. See also
3500 |option-backslash|. For example: >
3501 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003502< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003504
3505 If none of the fonts can be loaded, Vim will keep the current setting.
3506 If an empty font list is given, Vim will try using other resource
3507 settings (for X, it will use the Vim.font resource), and finally it
3508 will try some builtin default which should always be there ("7x13" in
3509 the case of X). The font names given should be "normal" fonts. Vim
3510 will try to find the related bold and italic fonts.
3511
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003512 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003513 :set guifont=*
3514< will bring up a font requester, where you can pick the font you want.
3515
3516 The font name depends on the GUI used. See |setting-guifont| for a
3517 way to set 'guifont' for various systems.
3518
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519 For the GTK+ 2 GUI the font name looks like this: >
3520 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003521< That's all. XLFDs are not used. For Chinese this is reported to work
3522 well: >
3523 if has("gui_gtk2")
3524 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3525 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3526 endif
3527<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003528 For Mac OSX you can use something like this: >
3529 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003530< Also see 'macatsui', it can help fix display problems.
3531 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003533 width). An exception is GTK 2: all fonts are accepted, but
3534 mono-spaced fonts look best.
3535
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 To preview a font on X11, you might be able to use the "xfontsel"
3537 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003538
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 For the Win32 GUI *E244* *E245*
3540 - takes these options in the font name:
3541 hXX - height is XX (points, can be floating-point)
3542 wXX - width is XX (points, can be floating-point)
3543 b - bold
3544 i - italic
3545 u - underline
3546 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003547 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3549 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3550 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003551 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552
3553 Use a ':' to separate the options.
3554 - A '_' can be used in the place of a space, so you don't need to use
3555 backslashes to escape the spaces.
3556 - Examples: >
3557 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3558 :set guifont=Andale_Mono:h7.5:w4.5
3559< See also |font-sizes|.
3560
3561 *'guifontset'* *'gfs'*
3562 *E250* *E252* *E234* *E597* *E598*
3563'guifontset' 'gfs' string (default "")
3564 global
3565 {not in Vi}
3566 {only available when compiled with GUI enabled and
3567 with the |+xfontset| feature}
3568 {not available in the GTK+ 2 GUI}
3569 When not empty, specifies two (or more) fonts to be used. The first
3570 one for normal English, the second one for your special language. See
3571 |xfontset|.
3572 Setting this option also means that all font names will be handled as
3573 a fontset name. Also the ones used for the "font" argument of the
3574 |:highlight| command.
3575 The fonts must match with the current locale. If fonts for the
3576 character sets that the current locale uses are not included, setting
3577 'guifontset' will fail.
3578 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3579 the comma-separated names are alternative names, one of which will be
3580 used. In 'guifontset' the whole string is one fontset name,
3581 including the commas. It is not possible to specify alternative
3582 fontset names.
3583 This example works on many X11 systems: >
3584 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3585<
3586 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3587'guifontwide' 'gfw' string (default "")
3588 global
3589 {not in Vi}
3590 {only available when compiled with GUI enabled}
3591 When not empty, specifies a comma-separated list of fonts to be used
3592 for double-width characters. The first font that can be loaded is
3593 used.
3594 Note: The size of these fonts must be exactly twice as wide as the one
3595 specified with 'guifont' and the same height.
3596
3597 All GUI versions but GTK+ 2:
3598
3599 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3600 'guifontset' is empty or invalid.
3601 When 'guifont' is set and a valid font is found in it and
3602 'guifontwide' is empty Vim will attempt to find a matching
3603 double-width font and set 'guifontwide' to it.
3604
3605 GTK+ 2 GUI only: *guifontwide_gtk2*
3606
3607 If set and valid, 'guifontwide' is always used for double width
3608 characters, even if 'encoding' is not set to "utf-8".
3609 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003610 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 font for characters not available in 'guifont'. Thus you do not need
3612 to set 'guifontwide' at all unless you want to override the choice
3613 made by Pango/Xft.
3614
Bram Moolenaar0f272122013-01-23 18:37:40 +01003615 Windows +multibyte only: *guifontwide_win_mbyte*
3616
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003617 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003618
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 *'guiheadroom'* *'ghr'*
3620'guiheadroom' 'ghr' number (default 50)
3621 global
3622 {not in Vi} {only for GTK and X11 GUI}
3623 The number of pixels subtracted from the screen height when fitting
3624 the GUI window on the screen. Set this before the GUI is started,
3625 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003626 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 lines will be left for window decorations and other items on the
3628 screen. Set it to a negative value to allow windows taller than the
3629 screen.
3630
3631 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003632'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3633 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 global
3635 {not in Vi}
3636 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003637 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 sequence of letters which describes what components and options of the
3639 GUI should be used.
3640 To avoid problems with flags that are added in the future, use the
3641 "+=" and "-=" feature of ":set" |add-option-flags|.
3642
3643 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003644 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 'a' Autoselect: If present, then whenever VISUAL mode is started,
3646 or the Visual area extended, Vim tries to become the owner of
3647 the windowing system's global selection. This means that the
3648 Visually highlighted text is available for pasting into other
3649 applications as well as into Vim itself. When the Visual mode
3650 ends, possibly due to an operation on the text, or when an
3651 application wants to paste the selection, the highlighted text
3652 is automatically yanked into the "* selection register.
3653 Thus the selection is still available for pasting into other
3654 applications after the VISUAL mode has ended.
3655 If not present, then Vim won't become the owner of the
3656 windowing system's global selection unless explicitly told to
3657 by a yank or delete operation for the "* register.
3658 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003659 *'go-P'*
3660 'P' Like autoselect but using the "+ register instead of the "*
3661 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003662 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003663 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 applies to the modeless selection.
3665
3666 'guioptions' autoselect Visual autoselect modeless ~
3667 "" - -
3668 "a" yes yes
3669 "A" - yes
3670 "aA" yes yes
3671
Bram Moolenaar02467872007-05-06 13:22:01 +00003672 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 'c' Use console dialogs instead of popup dialogs for simple
3674 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003675 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003676 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003677 'guitablabel' can be used to change the text in the labels.
3678 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003679 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003680 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003681 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 'f' Foreground: Don't use fork() to detach the GUI from the shell
3683 where it was started. Use this for programs that wait for the
3684 editor to finish (e.g., an e-mail program). Alternatively you
3685 can use "gvim -f" or ":gui -f" to start the GUI in the
3686 foreground. |gui-fork|
3687 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003688 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003689 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3691 corner of the window. It's black&white on non-GTK, because of
3692 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003693 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003695 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003696 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003698 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 file is sourced the system menu has already been loaded; the
3700 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003701 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 'g' Grey menu items: Make menu items that are not active grey. If
3703 'g' is not included inactive menu items are not shown at all.
3704 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003705 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 't' Include tearoff menu items. Currently only works for Win32,
3707 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003708 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003709 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003710 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003711 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003713 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 'R' Right-hand scrollbar is present when there is a vertically
3715 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003716 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003718 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 'L' Left-hand scrollbar is present when there is a vertically
3720 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003721 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3723 the longest visible line, or on the cursor line if the 'h'
3724 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003725 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 'h' Limit horizontal scrollbar size to the length of the cursor
3727 line. Reduces computations. |gui-horiz-scroll|
3728
3729 And yes, you may even have scrollbars on the left AND the right if
3730 you really want to :-). See |gui-scrollbars| for more information.
3731
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003732 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 'v' Use a vertical button layout for dialogs. When not included,
3734 a horizontal layout is preferred, but when it doesn't fit a
3735 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003736 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 'p' Use Pointer callbacks for X11 GUI. This is required for some
3738 window managers. If the cursor is not blinking or hollow at
3739 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003740 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003742 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003743 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744
Bram Moolenaar02467872007-05-06 13:22:01 +00003745
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 *'guipty'* *'noguipty'*
3747'guipty' boolean (default on)
3748 global
3749 {not in Vi}
3750 {only available when compiled with GUI enabled}
3751 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3752 I/O to/from shell commands. See |gui-pty|.
3753
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003754 *'guitablabel'* *'gtl'*
3755'guitablabel' 'gtl' string (default empty)
3756 global
3757 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003758 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003759 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003760 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003761 pages line. When empty and when the result is empty Vim will use a
3762 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003763
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003764 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003765 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003766
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003767 Only used when the GUI tab pages line is displayed. 'e' must be
3768 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3769 used.
3770
Bram Moolenaar57657d82006-04-21 22:12:41 +00003771 *'guitabtooltip'* *'gtt'*
3772'guitabtooltip' 'gtt' string (default empty)
3773 global
3774 {not in Vi}
3775 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003776 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003777 When nonempty describes the text to use in a tooltip for the GUI tab
3778 pages line. When empty Vim will use a default tooltip.
3779 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003780 You can include a line break. Simplest method is to use |:let|: >
3781 :let &guitabtooltip = "line one\nline two"
3782<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003783
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 *'helpfile'* *'hf'*
3785'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3786 (others) "$VIMRUNTIME/doc/help.txt")
3787 global
3788 {not in Vi}
3789 Name of the main help file. All distributed help files should be
3790 placed together in one directory. Additionally, all "doc" directories
3791 in 'runtimepath' will be used.
3792 Environment variables are expanded |:set_env|. For example:
3793 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003794 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 spaces and backslashes.
3796 This option cannot be set from a |modeline| or in the |sandbox|, for
3797 security reasons.
3798
3799 *'helpheight'* *'hh'*
3800'helpheight' 'hh' number (default 20)
3801 global
3802 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003803 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 feature}
3805 Minimal initial height of the help window when it is opened with the
3806 ":help" command. The initial height of the help window is half of the
3807 current window, or (when the 'ea' option is on) the same as other
3808 windows. When the height is less than 'helpheight', the height is
3809 set to 'helpheight'. Set to zero to disable.
3810
3811 *'helplang'* *'hlg'*
3812'helplang' 'hlg' string (default: messages language or empty)
3813 global
3814 {only available when compiled with the |+multi_lang|
3815 feature}
3816 {not in Vi}
3817 Comma separated list of languages. Vim will use the first language
3818 for which the desired help can be found. The English help will always
3819 be used as a last resort. You can add "en" to prefer English over
3820 another language, but that will only find tags that exist in that
3821 language and not in the English help.
3822 Example: >
3823 :set helplang=de,it
3824< This will first search German, then Italian and finally English help
3825 files.
3826 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3827 try to find the tag in the current language before using this option.
3828 See |help-translated|.
3829
3830 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3831'hidden' 'hid' boolean (default off)
3832 global
3833 {not in Vi}
3834 When off a buffer is unloaded when it is |abandon|ed. When on a
3835 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3836 displayed in another window, it does not become hidden, of course.
3837 The commands that move through the buffer list sometimes make a buffer
3838 hidden although the 'hidden' option is off: When the buffer is
3839 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003840 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003841 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842 This option is set for one command with ":hide {command}" |:hide|.
3843 WARNING: It's easy to forget that you have changes in hidden buffers.
3844 Think twice when using ":q!" or ":qa!".
3845
3846 *'highlight'* *'hl'*
3847'highlight' 'hl' string (default (as a single string):
3848 "8:SpecialKey,@:NonText,d:Directory,
3849 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003850 M:ModeMsg,n:LineNr,N:CursorLineNr,
3851 r:Question,s:StatusLine,S:StatusLineNC,
3852 c:VertSplit, t:Title,v:Visual,
3853 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 f:Folded,F:FoldColumn,A:DiffAdd,
3855 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003856 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003857 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003858 +:Pmenu,=:PmenuSel,
3859 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 global
3861 {not in Vi}
3862 This option can be used to set highlighting mode for various
3863 occasions. It is a comma separated list of character pairs. The
3864 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003865 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3867 |hl-NonText| @ '~' and '@' at the end of the window and
3868 characters from 'showbreak'
3869 |hl-Directory| d directories in CTRL-D listing and other special
3870 things in listings
3871 |hl-ErrorMsg| e error messages
3872 h (obsolete, ignored)
3873 |hl-IncSearch| i 'incsearch' highlighting
3874 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3875 |hl-MoreMsg| m |more-prompt|
3876 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003877 |hl-LineNr| n line number for ":number" and ":#" commands, and
3878 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003879 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3880 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 |hl-Question| r |hit-enter| prompt and yes/no questions
3882 |hl-StatusLine| s status line of current window |status-line|
3883 |hl-StatusLineNC| S status lines of not-current windows
3884 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3885 |hl-VertSplit| c column used to separate vertically split windows
3886 |hl-Visual| v Visual mode
3887 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3888 Selection" Only X11 Gui's |gui-x11| and
3889 |xterm-clipboard|.
3890 |hl-WarningMsg| w warning messages
3891 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3892 |hl-Folded| f line used for closed folds
3893 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003894 |hl-DiffAdd| A added line in diff mode
3895 |hl-DiffChange| C changed line in diff mode
3896 |hl-DiffDelete| D deleted line in diff mode
3897 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003899 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003900 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003901 |hl-SpellRare| R rare word |spell|
3902 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003903 |hl-Conceal| - the placeholders used for concealed characters
3904 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003905 |hl-Pmenu| + popup menu normal line
3906 |hl-PmenuSel| = popup menu normal line
3907 |hl-PmenuSbar| x popup menu scrollbar
3908 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909
3910 The display modes are:
3911 r reverse (termcap entry "mr" and "me")
3912 i italic (termcap entry "ZH" and "ZR")
3913 b bold (termcap entry "md" and "me")
3914 s standout (termcap entry "so" and "se")
3915 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003916 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 n no highlighting
3918 - no highlighting
3919 : use a highlight group
3920 The default is used for occasions that are not included.
3921 If you want to change what the display modes do, see |dos-colors|
3922 for an example.
3923 When using the ':' display mode, this must be followed by the name of
3924 a highlight group. A highlight group can be used to define any type
3925 of highlighting, including using color. See |:highlight| on how to
3926 define one. The default uses a different group for each occasion.
3927 See |highlight-default| for the default highlight groups.
3928
3929 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3930'hlsearch' 'hls' boolean (default off)
3931 global
3932 {not in Vi}
3933 {not available when compiled without the
3934 |+extra_search| feature}
3935 When there is a previous search pattern, highlight all its matches.
3936 The type of highlighting used can be set with the 'l' occasion in the
3937 'highlight' option. This uses the "Search" highlight group by
3938 default. Note that only the matching text is highlighted, any offsets
3939 are not applied.
3940 See also: 'incsearch' and |:match|.
3941 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003942 off with |:nohlsearch|. This does not change the option value, as
3943 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003944 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 When the search pattern can match an end-of-line, Vim will try to
3946 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003947 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003949 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003950 You can specify whether the highlight status is restored on startup
3951 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 NOTE: This option is reset when 'compatible' is set.
3953
3954 *'history'* *'hi'*
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003955'history' 'hi' number (Vim default: 50, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 global
3957 {not in Vi}
3958 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003959 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003961 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 NOTE: This option is set to the Vi default value when 'compatible' is
3963 set and to the Vim default value when 'compatible' is reset.
3964
3965 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3966'hkmap' 'hk' boolean (default off)
3967 global
3968 {not in Vi}
3969 {only available when compiled with the |+rightleft|
3970 feature}
3971 When on, the keyboard is mapped for the Hebrew character set.
3972 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3973 toggle this option. See |rileft.txt|.
3974 NOTE: This option is reset when 'compatible' is set.
3975
3976 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3977'hkmapp' 'hkp' boolean (default off)
3978 global
3979 {not in Vi}
3980 {only available when compiled with the |+rightleft|
3981 feature}
3982 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3983 This is useful if you have a non-Hebrew keyboard.
3984 See |rileft.txt|.
3985 NOTE: This option is reset when 'compatible' is set.
3986
3987 *'icon'* *'noicon'*
3988'icon' boolean (default off, on when title can be restored)
3989 global
3990 {not in Vi}
3991 {not available when compiled without the |+title|
3992 feature}
3993 When on, the icon text of the window will be set to the value of
3994 'iconstring' (if it is not empty), or to the name of the file
3995 currently being edited. Only the last part of the name is used.
3996 Overridden by the 'iconstring' option.
3997 Only works if the terminal supports setting window icons (currently
3998 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3999 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4000 builtin termcap).
4001 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004002 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003 X11.
4004
4005 *'iconstring'*
4006'iconstring' string (default "")
4007 global
4008 {not in Vi}
4009 {not available when compiled without the |+title|
4010 feature}
4011 When this option is not empty, it will be used for the icon text of
4012 the window. This happens only when the 'icon' option is on.
4013 Only works if the terminal supports setting window icon text
4014 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4015 Does not work for MS Windows.
4016 When Vim was compiled with HAVE_X11 defined, the original icon will be
4017 restored if possible |X11|.
4018 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004019 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 'titlestring' for example settings.
4021 {not available when compiled without the |+statusline| feature}
4022
4023 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4024'ignorecase' 'ic' boolean (default off)
4025 global
4026 Ignore case in search patterns. Also used when searching in the tags
4027 file.
4028 Also see 'smartcase'.
4029 Can be overruled by using "\c" or "\C" in the pattern, see
4030 |/ignorecase|.
4031
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004032 *'imactivatefunc'* *'imaf'*
4033'imactivatefunc' 'imaf' string (default "")
4034 global
4035 {not in Vi}
4036 {only available when compiled with |+xim| and
4037 |+GUI_GTK|}
4038 This option specifies a function that will be called to
4039 activate/inactivate Input Method.
4040
4041 Example: >
4042 function ImActivateFunc(active)
4043 if a:active
4044 ... do something
4045 else
4046 ... do something
4047 endif
4048 " return value is not used
4049 endfunction
4050 set imactivatefunc=ImActivateFunc
4051<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 *'imactivatekey'* *'imak'*
4053'imactivatekey' 'imak' string (default "")
4054 global
4055 {not in Vi}
4056 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004057 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 Specifies the key that your Input Method in X-Windows uses for
4059 activation. When this is specified correctly, vim can fully control
4060 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4061 You can't use this option to change the activation key, the option
4062 tells Vim what the key is.
4063 Format:
4064 [MODIFIER_FLAG-]KEY_STRING
4065
4066 These characters can be used for MODIFIER_FLAG (case is ignored):
4067 S Shift key
4068 L Lock key
4069 C Control key
4070 1 Mod1 key
4071 2 Mod2 key
4072 3 Mod3 key
4073 4 Mod4 key
4074 5 Mod5 key
4075 Combinations are allowed, for example "S-C-space" or "SC-space" are
4076 both shift+ctrl+space.
4077 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4078
4079 Example: >
4080 :set imactivatekey=S-space
4081< "S-space" means shift+space. This is the activation key for kinput2 +
4082 canna (Japanese), and ami (Korean).
4083
4084 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4085'imcmdline' 'imc' boolean (default off)
4086 global
4087 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004088 {only available when compiled with the |+xim|,
4089 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 When set the Input Method is always on when starting to edit a command
4091 line, unless entering a search pattern (see 'imsearch' for that).
4092 Setting this option is useful when your input method allows entering
4093 English characters directly, e.g., when it's used to type accented
4094 characters with dead keys.
4095
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004096 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4098 global
4099 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004100 {only available when compiled with the |+xim|,
4101 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 When set the Input Method is never used. This is useful to disable
4103 the IM when it doesn't work properly.
4104 Currently this option is on by default for SGI/IRIX machines. This
4105 may change in later releases.
4106
4107 *'iminsert'* *'imi'*
4108'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4109 local to buffer
4110 {not in Vi}
4111 Specifies whether :lmap or an Input Method (IM) is to be used in
4112 Insert mode. Valid values:
4113 0 :lmap is off and IM is off
4114 1 :lmap is ON and IM is off
4115 2 :lmap is off and IM is ON
4116 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4117 or |global-ime|.
4118 To always reset the option to zero when leaving Insert mode with <Esc>
4119 this can be used: >
4120 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4121< This makes :lmap and IM turn off automatically when leaving Insert
4122 mode.
4123 Note that this option changes when using CTRL-^ in Insert mode
4124 |i_CTRL-^|.
4125 The value is set to 1 when setting 'keymap' to a valid keymap name.
4126 It is also used for the argument of commands like "r" and "f".
4127 The value 0 may not work correctly with Athena and Motif with some XIM
4128 methods. Use 'imdisable' to disable XIM then.
4129
4130 *'imsearch'* *'ims'*
4131'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4132 local to buffer
4133 {not in Vi}
4134 Specifies whether :lmap or an Input Method (IM) is to be used when
4135 entering a search pattern. Valid values:
4136 -1 the value of 'iminsert' is used, makes it look like
4137 'iminsert' is also used when typing a search pattern
4138 0 :lmap is off and IM is off
4139 1 :lmap is ON and IM is off
4140 2 :lmap is off and IM is ON
4141 Note that this option changes when using CTRL-^ in Command-line mode
4142 |c_CTRL-^|.
4143 The value is set to 1 when it is not -1 and setting the 'keymap'
4144 option to a valid keymap name.
4145 The value 0 may not work correctly with Athena and Motif with some XIM
4146 methods. Use 'imdisable' to disable XIM then.
4147
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004148 *'imstatusfunc'* *'imsf'*
4149'imstatusfunc' 'imsf' string (default "")
4150 global
4151 {not in Vi}
4152 {only available when compiled with |+xim| and
4153 |+GUI_GTK|}
4154 This option specifies a function that is called to obtain the status
4155 of Input Method. It must return a positive number when IME is active.
4156
4157 Example: >
4158 function ImStatusFunc()
4159 let is_active = ...do something
4160 return is_active ? 1 : 0
4161 endfunction
4162 set imstatusfunc=ImStatusFunc
4163<
4164 NOTE: This function is invoked very often. Keep it fast.
4165
Bram Moolenaar071d4272004-06-13 20:20:40 +00004166 *'include'* *'inc'*
4167'include' 'inc' string (default "^\s*#\s*include")
4168 global or local to buffer |global-local|
4169 {not in Vi}
4170 {not available when compiled without the
4171 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004172 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 pattern, just like for the "/" command (See |pattern|). The default
4174 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004175 "]I", "[d", etc.
4176 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004177 comes after the matched pattern. But if "\zs" appears in the pattern
4178 then the text matched from "\zs" to the end, or until "\ze" if it
4179 appears, is used as the file name. Use this to include characters
4180 that are not in 'isfname', such as a space. You can then use
4181 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004182 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183
4184 *'includeexpr'* *'inex'*
4185'includeexpr' 'inex' string (default "")
4186 local to buffer
4187 {not in Vi}
4188 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004189 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004191 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 :set includeexpr=substitute(v:fname,'\\.','/','g')
4193< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004194
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004196 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 Also used for |<cfile>|.
4198
Bram Moolenaar30b65812012-07-12 22:01:11 +02004199 The expression will be evaluated in the |sandbox| when set from a
4200 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004201
4202 It is not allowed to change text or jump to another window while
4203 evaluating 'includeexpr' |textlock|.
4204
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4206'incsearch' 'is' boolean (default off)
4207 global
4208 {not in Vi}
4209 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004210 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004211 While typing a search command, show where the pattern, as it was typed
4212 so far, matches. The matched string is highlighted. If the pattern
4213 is invalid or not found, nothing is shown. The screen will be updated
4214 often, this is only useful on fast terminals.
4215 Note that the match will be shown, but the cursor will return to its
4216 original position when no match is found and when pressing <Esc>. You
4217 still need to finish the search command with <Enter> to move the
4218 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004219 When compiled with the |+reltime| feature Vim only searches for about
4220 half a second. With a complicated pattern and/or a lot of text the
4221 match may not be found. This is to avoid that Vim hangs while you
4222 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004223 The highlighting can be set with the 'i' flag in 'highlight'.
4224 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004225 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004226 to the command line. If 'ignorecase' and 'smartcase' are set and the
4227 command line has no uppercase characters, the added character is
4228 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004229 CTRL-R CTRL-W can be used to add the word at the end of the current
4230 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231 NOTE: This option is reset when 'compatible' is set.
4232
4233 *'indentexpr'* *'inde'*
4234'indentexpr' 'inde' string (default "")
4235 local to buffer
4236 {not in Vi}
4237 {not available when compiled without the |+cindent|
4238 or |+eval| features}
4239 Expression which is evaluated to obtain the proper indent for a line.
4240 It is used when a new line is created, for the |=| operator and
4241 in Insert mode as specified with the 'indentkeys' option.
4242 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004243 'smartindent' indenting. When 'lisp' is set, this option is
4244 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245 When 'paste' is set this option is not used for indenting.
4246 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004247 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 when the expression is evaluated (but it may be moved around).
4249 The expression must return the number of spaces worth of indent. It
4250 can return "-1" to keep the current indent (this means 'autoindent' is
4251 used for the indent).
4252 Functions useful for computing the indent are |indent()|, |cindent()|
4253 and |lispindent()|.
4254 The evaluation of the expression must not have side effects! It must
4255 not change the text, jump to another window, etc. Afterwards the
4256 cursor position is always restored, thus the cursor may be moved.
4257 Normally this option would be set to call a function: >
4258 :set indentexpr=GetMyIndent()
4259< Error messages will be suppressed, unless the 'debug' option contains
4260 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004261 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 NOTE: This option is made empty when 'compatible' is set.
4263
Bram Moolenaar30b65812012-07-12 22:01:11 +02004264 The expression will be evaluated in the |sandbox| when set from a
4265 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004266
4267 It is not allowed to change text or jump to another window while
4268 evaluating 'indentexpr' |textlock|.
4269
4270
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 *'indentkeys'* *'indk'*
4272'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4273 local to buffer
4274 {not in Vi}
4275 {not available when compiled without the |+cindent|
4276 feature}
4277 A list of keys that, when typed in Insert mode, cause reindenting of
4278 the current line. Only happens if 'indentexpr' isn't empty.
4279 The format is identical to 'cinkeys', see |indentkeys-format|.
4280 See |C-indenting| and |indent-expression|.
4281
4282 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4283'infercase' 'inf' boolean (default off)
4284 local to buffer
4285 {not in Vi}
4286 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004287 'ignorecase' is also on, the case of the match is adjusted depending
4288 on the typed text. If the typed text contains a lowercase letter
4289 where the match has an upper case letter, the completed part is made
4290 lowercase. If the typed text has no lowercase letters and the match
4291 has a lowercase letter where the typed text has an uppercase letter,
4292 and there is a letter before it, the completed part is made uppercase.
4293 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294
4295 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4296'insertmode' 'im' boolean (default off)
4297 global
4298 {not in Vi}
4299 Makes Vim work in a way that Insert mode is the default mode. Useful
4300 if you want to use Vim as a modeless editor. Used for |evim|.
4301 These Insert mode commands will be useful:
4302 - Use the cursor keys to move around.
4303 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4304 this is a mapping, it is executed as if 'insertmode' was off.
4305 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004307 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4308 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309
4310 These items change when 'insertmode' is set:
4311 - when starting to edit of a file, Vim goes to Insert mode.
4312 - <Esc> in Insert mode is a no-op and beeps.
4313 - <Esc> in Normal mode makes Vim go to Insert mode.
4314 - CTRL-L in Insert mode is a command, it is not inserted.
4315 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4316 However, when <Esc> is used inside a mapping, it behaves like
4317 'insertmode' was not set. This was done to be able to use the same
4318 mappings with 'insertmode' set or not set.
4319 When executing commands with |:normal| 'insertmode' is not used.
4320
4321 NOTE: This option is reset when 'compatible' is set.
4322
4323 *'isfname'* *'isf'*
4324'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4325 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4326 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4327 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4328 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4329 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4330 global
4331 {not in Vi}
4332 The characters specified by this option are included in file names and
4333 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004334 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 Multi-byte characters 256 and above are always included, only the
4336 characters up to 255 are specified with this option.
4337 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004338 Think twice before adding white space to this option. Although a
4339 space may appear inside a file name, the effect will be that Vim
4340 doesn't know where a file name starts or ends when doing completion.
4341 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342
4343 Note that on systems using a backslash as path separator, Vim tries to
4344 do its best to make it work as you would expect. That is a bit
4345 tricky, since Vi originally used the backslash to escape special
4346 characters. Vim will not remove a backslash in front of a normal file
4347 name character on these systems, but it will on Unix and alikes. The
4348 '&' and '^' are not included by default, because these are special for
4349 cmd.exe.
4350
4351 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004352 Each part can be a single character number or a range. A range is two
4353 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354 decimal number between 0 and 255 or the ASCII character itself (does
4355 not work for digits). Example:
4356 "_,-,128-140,#-43" (include '_' and '-' and the range
4357 128 to 140 and '#' to 43)
4358 If a part starts with '^', the following character number or range
4359 will be excluded from the option. The option is interpreted from left
4360 to right. Put the excluded character after the range where it is
4361 included. To include '^' itself use it as the last character of the
4362 option or the end of a range. Example:
4363 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4364 If the character is '@', all characters where isalpha() returns TRUE
4365 are included. Normally these are the characters a to z and A to Z,
4366 plus accented characters. To include '@' itself use "@-@". Examples:
4367 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004368 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369 "a-z,A-Z,@-@" All letters plus the '@' character.
4370 A comma can be included by using it where a character number is
4371 expected. Example:
4372 "48-57,,,_" Digits, comma and underscore.
4373 A comma can be excluded by prepending a '^'. Example:
4374 " -~,^,,9" All characters from space to '~', excluding
4375 comma, plus <Tab>.
4376 See |option-backslash| about including spaces and backslashes.
4377
4378 *'isident'* *'isi'*
4379'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4380 "@,48-57,_,128-167,224-235"
4381 otherwise: "@,48-57,_,192-255")
4382 global
4383 {not in Vi}
4384 The characters given by this option are included in identifiers.
4385 Identifiers are used in recognizing environment variables and after a
4386 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004387 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 option.
4389 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004390 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4392
4393 *'iskeyword'* *'isk'*
4394'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4395 "@,48-57,_,128-167,224-235"
4396 otherwise: "@,48-57,_,192-255"
4397 Vi default: "@,48-57,_")
4398 local to buffer
4399 {not in Vi}
4400 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004401 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 'isfname' for a description of the format of this option. For C
4403 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4404 For a help file it is set to all non-blank printable characters except
4405 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4406 command).
4407 When the 'lisp' option is on the '-' character is always included.
4408 NOTE: This option is set to the Vi default value when 'compatible' is
4409 set and to the Vim default value when 'compatible' is reset.
4410
4411 *'isprint'* *'isp'*
4412'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4413 "@,~-255"; otherwise: "@,161-255")
4414 global
4415 {not in Vi}
4416 The characters given by this option are displayed directly on the
4417 screen. It is also used for "\p" in a |pattern|. The characters from
4418 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4419 even when they are not included in 'isprint' or excluded. See
4420 'isfname' for a description of the format of this option.
4421
4422 Non-printable characters are displayed with two characters:
4423 0 - 31 "^@" - "^_"
4424 32 - 126 always single characters
4425 127 "^?"
4426 128 - 159 "~@" - "~_"
4427 160 - 254 "| " - "|~"
4428 255 "~?"
4429 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4430 displayed as <xx>, with the hexadecimal value of the byte.
4431 When 'display' contains "uhex" all unprintable characters are
4432 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004433 The SpecialKey highlighting will be used for unprintable characters.
4434 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435
4436 Multi-byte characters 256 and above are always included, only the
4437 characters up to 255 are specified with this option. When a character
4438 is printable but it is not available in the current font, a
4439 replacement character will be shown.
4440 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4441 There is no option to specify these characters.
4442
4443 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4444'joinspaces' 'js' boolean (default on)
4445 global
4446 {not in Vi}
4447 Insert two spaces after a '.', '?' and '!' with a join command.
4448 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4449 Otherwise only one space is inserted.
4450 NOTE: This option is set when 'compatible' is set.
4451
4452 *'key'*
4453'key' string (default "")
4454 local to buffer
4455 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004456 {only available when compiled with the |+cryptv|
4457 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004459 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 Careful: Do not set the key value by hand, someone might see the typed
4461 key. Use the |:X| command. But you can make 'key' empty: >
4462 :set key=
4463< It is not possible to get the value of this option with ":set key" or
4464 "echo &key". This is to avoid showing it to someone who shouldn't
4465 know. It also means you cannot see it yourself once you have set it,
4466 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004467 You can use "&key" in an expression to detect whether encryption is
4468 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469
4470 *'keymap'* *'kmp'* *E544*
4471'keymap' 'kmp' string (default "")
4472 local to buffer
4473 {not in Vi}
4474 {only available when compiled with the |+keymap|
4475 feature}
4476 Name of a keyboard mapping. See |mbyte-keymap|.
4477 Setting this option to a valid keymap name has the side effect of
4478 setting 'iminsert' to one, so that the keymap becomes effective.
4479 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004480 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481
4482 *'keymodel'* *'km'*
4483'keymodel' 'km' string (default "")
4484 global
4485 {not in Vi}
4486 List of comma separated words, which enable special things that keys
4487 can do. These values can be used:
4488 startsel Using a shifted special key starts selection (either
4489 Select mode or Visual mode, depending on "key" being
4490 present in 'selectmode').
4491 stopsel Using a not-shifted special key stops selection.
4492 Special keys in this context are the cursor keys, <End>, <Home>,
4493 <PageUp> and <PageDown>.
4494 The 'keymodel' option is set by the |:behave| command.
4495
4496 *'keywordprg'* *'kp'*
4497'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4498 OS/2: "view /", VMS: "help")
4499 global or local to buffer |global-local|
4500 {not in Vi}
4501 Program to use for the |K| command. Environment variables are
4502 expanded |:set_env|. ":help" may be used to access the Vim internal
4503 help. (Note that previously setting the global option to the empty
4504 value did this, which is now deprecated.)
4505 When "man" is used, Vim will automatically translate a count for the
4506 "K" command to a section number. Also for "man -s", in which case the
4507 "-s" is removed when there is no count.
4508 See |option-backslash| about including spaces and backslashes.
4509 Example: >
4510 :set keywordprg=man\ -s
4511< This option cannot be set from a |modeline| or in the |sandbox|, for
4512 security reasons.
4513
4514 *'langmap'* *'lmap'* *E357* *E358*
4515'langmap' 'lmap' string (default "")
4516 global
4517 {not in Vi}
4518 {only available when compiled with the |+langmap|
4519 feature}
4520 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004521 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 inserted directly. When in command mode the 'langmap' option takes
4523 care of translating these special characters to the original meaning
4524 of the key. This means you don't have to change the keyboard mode to
4525 be able to execute Normal mode commands.
4526 This is the opposite of the 'keymap' option, where characters are
4527 mapped in Insert mode.
Bram Moolenaare968e362014-05-13 20:23:24 +02004528 This option cannot be set from a |modeline| or in the |sandbox|, for
4529 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004531 Example (for Greek, in UTF-8): *greek* >
4532 :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 +00004533< Example (exchanges meaning of z and y for commands): >
4534 :set langmap=zy,yz,ZY,YZ
4535<
4536 The 'langmap' option is a list of parts, separated with commas. Each
4537 part can be in one of two forms:
4538 1. A list of pairs. Each pair is a "from" character immediately
4539 followed by the "to" character. Examples: "aA", "aAbBcC".
4540 2. A list of "from" characters, a semi-colon and a list of "to"
4541 characters. Example: "abc;ABC"
4542 Example: "aA,fgh;FGH,cCdDeE"
4543 Special characters need to be preceded with a backslash. These are
4544 ";", ',' and backslash itself.
4545
4546 This will allow you to activate vim actions without having to switch
4547 back and forth between the languages. Your language characters will
4548 be understood as normal vim English characters (according to the
4549 langmap mappings) in the following cases:
4550 o Normal/Visual mode (commands, buffer/register names, user mappings)
4551 o Insert/Replace Mode: Register names after CTRL-R
4552 o Insert/Replace Mode: Mappings
4553 Characters entered in Command-line mode will NOT be affected by
4554 this option. Note that this option can be changed at any time
4555 allowing to switch between mappings for different languages/encodings.
4556 Use a mapping to avoid having to type it each time!
4557
4558 *'langmenu'* *'lm'*
4559'langmenu' 'lm' string (default "")
4560 global
4561 {not in Vi}
4562 {only available when compiled with the |+menu| and
4563 |+multi_lang| features}
4564 Language to use for menu translation. Tells which file is loaded
4565 from the "lang" directory in 'runtimepath': >
4566 "lang/menu_" . &langmenu . ".vim"
4567< (without the spaces). For example, to always use the Dutch menus, no
4568 matter what $LANG is set to: >
4569 :set langmenu=nl_NL.ISO_8859-1
4570< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004571 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 If your $LANG is set to a non-English language but you do want to use
4573 the English menus: >
4574 :set langmenu=none
4575< This option must be set before loading menus, switching on filetype
4576 detection or syntax highlighting. Once the menus are defined setting
4577 this option has no effect. But you could do this: >
4578 :source $VIMRUNTIME/delmenu.vim
4579 :set langmenu=de_DE.ISO_8859-1
4580 :source $VIMRUNTIME/menu.vim
4581< Warning: This deletes all menus that you defined yourself!
4582
4583 *'laststatus'* *'ls'*
4584'laststatus' 'ls' number (default 1)
4585 global
4586 {not in Vi}
4587 The value of this option influences when the last window will have a
4588 status line:
4589 0: never
4590 1: only if there are at least two windows
4591 2: always
4592 The screen looks nicer with a status line if you have several
4593 windows, but it takes another screen line. |status-line|
4594
4595 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4596'lazyredraw' 'lz' boolean (default off)
4597 global
4598 {not in Vi}
4599 When this option is set, the screen will not be redrawn while
4600 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004601 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 update use |:redraw|.
4603
4604 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4605'linebreak' 'lbr' boolean (default off)
4606 local to window
4607 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004608 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004610 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 than at the last character that fits on the screen. Unlike
4612 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004613 it only affects the way the file is displayed, not its contents.
4614 If 'breakindent' is set, line is visually indented. Then, the value
4615 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004616 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 Note that <Tab> characters after an <EOL> are mostly not displayed
4618 with the right amount of white space.
4619
4620 *'lines'* *E593*
4621'lines' number (default 24 or terminal height)
4622 global
4623 Number of lines of the Vim window.
4624 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004625 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 When Vim is running in the GUI or in a resizable window, setting this
4627 option will cause the window size to be changed. When you only want
4628 to use the size for the GUI, put the command in your |gvimrc| file.
4629 Vim limits the number of lines to what fits on the screen. You can
4630 use this command to get the tallest window possible: >
4631 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004632< Minimum value is 2, maximum value is 1000.
4633 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 When you set this option and Vim is unable to change the physical
4635 number of lines of the display, the display may be messed up.
4636
4637 *'linespace'* *'lsp'*
4638'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4639 global
4640 {not in Vi}
4641 {only in the GUI}
4642 Number of pixel lines inserted between characters. Useful if the font
4643 uses the full character cell height, making lines touch each other.
4644 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004645 With some fonts there can be too much room between lines (to have
4646 space for ascents and descents). Then it makes sense to set
4647 'linespace' to a negative value. This may cause display problems
4648 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649
4650 *'lisp'* *'nolisp'*
4651'lisp' boolean (default off)
4652 local to buffer
4653 {not available when compiled without the |+lispindent|
4654 feature}
4655 Lisp mode: When <Enter> is typed in insert mode set the indent for
4656 the next line to Lisp standards (well, sort of). Also happens with
4657 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4658 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4659 better. Also see 'lispwords'.
4660 The '-' character is included in keyword characters. Redefines the
4661 "=" operator to use this same indentation algorithm rather than
4662 calling an external program if 'equalprg' is empty.
4663 This option is not used when 'paste' is set.
4664 {Vi: Does it a little bit differently}
4665
4666 *'lispwords'* *'lw'*
4667'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004668 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669 {not in Vi}
4670 {not available when compiled without the |+lispindent|
4671 feature}
4672 Comma separated list of words that influence the Lisp indenting.
4673 |'lisp'|
4674
4675 *'list'* *'nolist'*
4676'list' boolean (default off)
4677 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004678 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4679 line. Useful to see the difference between tabs and spaces and for
4680 trailing blanks. Further changed by the 'listchars' option.
4681
4682 The cursor is displayed at the start of the space a Tab character
4683 occupies, not at the end as usual in Normal mode. To get this cursor
4684 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004685 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004686<
4687 Note that list mode will also affect formatting (set with 'textwidth'
4688 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 changing the way tabs are displayed.
4690
4691 *'listchars'* *'lcs'*
4692'listchars' 'lcs' string (default "eol:$")
4693 global
4694 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004695 Strings to use in 'list' mode and for the |:list| command. It is a
4696 comma separated list of string settings.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004697 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698 eol:c Character to show at the end of each line. When
4699 omitted, there is no extra character at the end of the
4700 line.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004701 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004702 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004704 fill the space that the tab normally occupies.
4705 "tab:>-" will show a tab that takes four spaces as
4706 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004707 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004708 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709 trailing spaces are blank.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004710 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 extends:c Character to show in the last column, when 'wrap' is
4712 off and the line continues beyond the right of the
4713 screen.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004714 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 precedes:c Character to show in the first column, when 'wrap'
4716 is off and there is text preceding the character
4717 visible in the first column.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004718 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004719 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004720 'conceallevel' is set to 1.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004721 *lcs-nbsp*
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004722 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004723 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004725 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004727 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728
4729 Examples: >
4730 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004731 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 :set lcs=extends:>,precedes:<
4733< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004734 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004735 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736
4737 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4738'loadplugins' 'lpl' boolean (default on)
4739 global
4740 {not in Vi}
4741 When on the plugin scripts are loaded when starting up |load-plugins|.
4742 This option can be reset in your |vimrc| file to disable the loading
4743 of plugins.
4744 Note that using the "-u NONE" and "--noplugin" command line arguments
4745 reset this option. |-u| |--noplugin|
4746
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004747 *'macatsui'* *'nomacatsui'*
4748'macatsui' boolean (default on)
4749 global
4750 {only available in Mac GUI version}
4751 This is a workaround for when drawing doesn't work properly. When set
4752 and compiled with multi-byte support ATSUI text drawing is used. When
4753 not set ATSUI text drawing is not used. Switch this option off when
4754 you experience drawing problems. In a future version the problems may
4755 be solved and this option becomes obsolete. Therefore use this method
4756 to unset it: >
4757 if exists('&macatsui')
4758 set nomacatsui
4759 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004760< Another option to check if you have drawing problems is
4761 'termencoding'.
4762
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 *'magic'* *'nomagic'*
4764'magic' boolean (default on)
4765 global
4766 Changes the special characters that can be used in search patterns.
4767 See |pattern|.
4768 NOTE: To avoid portability problems with using patterns, always keep
4769 this option at the default "on". Only switch it off when working with
4770 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004771 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772
4773 *'makeef'* *'mef'*
4774'makeef' 'mef' string (default: "")
4775 global
4776 {not in Vi}
4777 {not available when compiled without the |+quickfix|
4778 feature}
4779 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4780 and the |:grep| command.
4781 When it is empty, an internally generated temp file will be used.
4782 When "##" is included, it is replaced by a number to make the name
4783 unique. This makes sure that the ":make" command doesn't overwrite an
4784 existing file.
4785 NOT used for the ":cf" command. See 'errorfile' for that.
4786 Environment variables are expanded |:set_env|.
4787 See |option-backslash| about including spaces and backslashes.
4788 This option cannot be set from a |modeline| or in the |sandbox|, for
4789 security reasons.
4790
4791 *'makeprg'* *'mp'*
4792'makeprg' 'mp' string (default "make", VMS: "MMS")
4793 global or local to buffer |global-local|
4794 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004795 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01004796 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4797 which are expanded to the current and alternate file name. Use |::S|
4798 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004799 Environment variables are expanded |:set_env|. See |option-backslash|
4800 about including spaces and backslashes.
4801 Note that a '|' must be escaped twice: once for ":set" and once for
4802 the interpretation of a command. When you use a filter called
4803 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 :set makeprg=gmake\ \\\|\ myfilter
4805< The placeholder "$*" can be given (even multiple times) to specify
4806 where the arguments will be included, for example: >
4807 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4808< This option cannot be set from a |modeline| or in the |sandbox|, for
4809 security reasons.
4810
4811 *'matchpairs'* *'mps'*
4812'matchpairs' 'mps' string (default "(:),{:},[:]")
4813 local to buffer
4814 {not in Vi}
4815 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004816 other.
4817 Only character pairs are allowed that are different, thus you cannot
4818 jump between two double quotes.
4819 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004820 The pairs must be separated by a comma. Example for including '<' and
4821 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 :set mps+=<:>
4823
4824< A more exotic example, to jump between the '=' and ';' in an
4825 assignment, useful for languages like C and Java: >
4826 :au FileType c,cpp,java set mps+==:;
4827
4828< For a more advanced way of using "%", see the matchit.vim plugin in
4829 the $VIMRUNTIME/macros directory. |add-local-help|
4830
4831 *'matchtime'* *'mat'*
4832'matchtime' 'mat' number (default 5)
4833 global
4834 {not in Vi}{in Nvi}
4835 Tenths of a second to show the matching paren, when 'showmatch' is
4836 set. Note that this is not in milliseconds, like other options that
4837 set a time. This is to be compatible with Nvi.
4838
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004839 *'maxcombine'* *'mco'*
4840'maxcombine' 'mco' number (default 2)
4841 global
4842 {not in Vi}
4843 {only available when compiled with the |+multi_byte|
4844 feature}
4845 The maximum number of combining characters supported for displaying.
4846 Only used when 'encoding' is "utf-8".
4847 The default is OK for most languages. Hebrew may require 4.
4848 Maximum value is 6.
4849 Even when this option is set to 2 you can still edit text with more
4850 combining characters, you just can't see them. Use |g8| or |ga|.
4851 See |mbyte-combining|.
4852
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 *'maxfuncdepth'* *'mfd'*
4854'maxfuncdepth' 'mfd' number (default 100)
4855 global
4856 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004857 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004858 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 Maximum depth of function calls for user functions. This normally
4860 catches endless recursion. When using a recursive function with
4861 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4862 more memory, there is the danger of failing when memory is exhausted.
4863 See also |:function|.
4864
4865 *'maxmapdepth'* *'mmd'* *E223*
4866'maxmapdepth' 'mmd' number (default 1000)
4867 global
4868 {not in Vi}
4869 Maximum number of times a mapping is done without resulting in a
4870 character to be used. This normally catches endless mappings, like
4871 ":map x y" with ":map y x". It still does not catch ":map g wg",
4872 because the 'w' is used before the next mapping is done. See also
4873 |key-mapping|.
4874
4875 *'maxmem'* *'mm'*
4876'maxmem' 'mm' number (default between 256 to 5120 (system
4877 dependent) or half the amount of memory
4878 available)
4879 global
4880 {not in Vi}
4881 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4882 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004883 other memory to be freed. The maximum usable value is about 2000000.
4884 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004886 *'maxmempattern'* *'mmp'*
4887'maxmempattern' 'mmp' number (default 1000)
4888 global
4889 {not in Vi}
4890 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004891 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004892 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004893 When Vim runs into the limit it gives an error message and mostly
4894 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004895 Running into the limit often means that the pattern is very
4896 inefficient or too complex. This may already happen with the pattern
4897 "\(.\)*" on a very long line. ".*" works much better.
4898 Vim may run out of memory before hitting the 'maxmempattern' limit.
4899
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 *'maxmemtot'* *'mmt'*
4901'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4902 dependent) or half the amount of memory
4903 available)
4904 global
4905 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004906 Maximum amount of memory in Kbyte to use for all buffers together.
4907 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4908 without a limit. On 64 bit machines higher values might work. But
4909 hey, do you really need more than 2 Gbyte for text editing?
4910 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911
4912 *'menuitems'* *'mis'*
4913'menuitems' 'mis' number (default 25)
4914 global
4915 {not in Vi}
4916 {not available when compiled without the |+menu|
4917 feature}
4918 Maximum number of items to use in a menu. Used for menus that are
4919 generated from a list of items, e.g., the Buffers menu. Changing this
4920 option has no direct effect, the menu must be refreshed first.
4921
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004922 *'mkspellmem'* *'msm'*
4923'mkspellmem' 'msm' string (default "460000,2000,500")
4924 global
4925 {not in Vi}
4926 {not available when compiled without the |+syntax|
4927 feature}
4928 Parameters for |:mkspell|. This tunes when to start compressing the
4929 word tree. Compression can be slow when there are many words, but
4930 it's needed to avoid running out of memory. The amount of memory used
4931 per word depends very much on how similar the words are, that's why
4932 this tuning is complicated.
4933
4934 There are three numbers, separated by commas:
4935 {start},{inc},{added}
4936
4937 For most languages the uncompressed word tree fits in memory. {start}
4938 gives the amount of memory in Kbyte that can be used before any
4939 compression is done. It should be a bit smaller than the amount of
4940 memory that is available to Vim.
4941
4942 When going over the {start} limit the {inc} number specifies the
4943 amount of memory in Kbyte that can be allocated before another
4944 compression is done. A low number means compression is done after
4945 less words are added, which is slow. A high number means more memory
4946 will be allocated.
4947
4948 After doing compression, {added} times 1024 words can be added before
4949 the {inc} limit is ignored and compression is done when any extra
4950 amount of memory is needed. A low number means there is a smaller
4951 chance of hitting the {inc} limit, less memory is used but it's
4952 slower.
4953
4954 The languages for which these numbers are important are Italian and
4955 Hungarian. The default works for when you have about 512 Mbyte. If
4956 you have 1 Gbyte you could use: >
4957 :set mkspellmem=900000,3000,800
4958< If you have less than 512 Mbyte |:mkspell| may fail for some
4959 languages, no matter what you set 'mkspellmem' to.
4960
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004962'modeline' 'ml' boolean (Vim default: on (off for root),
4963 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 local to buffer
4965 *'modelines'* *'mls'*
4966'modelines' 'mls' number (default 5)
4967 global
4968 {not in Vi}
4969 If 'modeline' is on 'modelines' gives the number of lines that is
4970 checked for set commands. If 'modeline' is off or 'modelines' is zero
4971 no lines are checked. See |modeline|.
4972 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4973 set and to the Vim default value when 'compatible' is reset.
4974
4975 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4976'modifiable' 'ma' boolean (default on)
4977 local to buffer
4978 {not in Vi} *E21*
4979 When off the buffer contents cannot be changed. The 'fileformat' and
4980 'fileencoding' options also can't be changed.
4981 Can be reset with the |-M| command line argument.
4982
4983 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4984'modified' 'mod' boolean (default off)
4985 local to buffer
4986 {not in Vi}
4987 When on, the buffer is considered to be modified. This option is set
4988 when:
4989 1. A change was made to the text since it was last written. Using the
4990 |undo| command to go back to the original text will reset the
4991 option. But undoing changes that were made before writing the
4992 buffer will set the option again, since the text is different from
4993 when it was written.
4994 2. 'fileformat' or 'fileencoding' is different from its original
4995 value. The original value is set when the buffer is read or
4996 written. A ":set nomodified" command also resets the original
4997 values to the current values and the 'modified' option will be
4998 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02004999 This option is not set when a change is made to the buffer as the
5000 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5001 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5002 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5004 will be ignored.
5005
5006 *'more'* *'nomore'*
5007'more' boolean (Vim default: on, Vi default: off)
5008 global
5009 {not in Vi}
5010 When on, listings pause when the whole screen is filled. You will get
5011 the |more-prompt|. When this option is off there are no pauses, the
5012 listing continues until finished.
5013 NOTE: This option is set to the Vi default value when 'compatible' is
5014 set and to the Vim default value when 'compatible' is reset.
5015
5016 *'mouse'* *E538*
5017'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
5018 global
5019 {not in Vi}
5020 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005021 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5022 sysmouse and Linux console with gpm). For using the mouse in the
5023 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024 The mouse can be enabled for different modes:
5025 n Normal mode
5026 v Visual mode
5027 i Insert mode
5028 c Command-line mode
5029 h all previous modes when editing a help file
5030 a all previous modes
5031 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005032 Normally you would enable the mouse in all four modes with: >
5033 :set mouse=a
5034< When the mouse is not enabled, the GUI will still use the mouse for
5035 modeless selection. This doesn't move the text cursor.
5036
5037 See |mouse-using|. Also see |'clipboard'|.
5038
5039 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005040 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005041 the mouse buttons can still be used by keeping the shift key pressed.
5042 Also see the 'clipboard' option.
5043
5044 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5045'mousefocus' 'mousef' boolean (default off)
5046 global
5047 {not in Vi}
5048 {only works in the GUI}
5049 The window that the mouse pointer is on is automatically activated.
5050 When changing the window layout or window focus in another way, the
5051 mouse pointer is moved to the window with keyboard focus. Off is the
5052 default because it makes using the pull down menus a little goofy, as
5053 a pointer transit may activate a window unintentionally.
5054
5055 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5056'mousehide' 'mh' boolean (default on)
5057 global
5058 {not in Vi}
5059 {only works in the GUI}
5060 When on, the mouse pointer is hidden when characters are typed.
5061 The mouse pointer is restored when the mouse is moved.
5062
5063 *'mousemodel'* *'mousem'*
5064'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5065 global
5066 {not in Vi}
5067 Sets the model to use for the mouse. The name mostly specifies what
5068 the right mouse button is used for:
5069 extend Right mouse button extends a selection. This works
5070 like in an xterm.
5071 popup Right mouse button pops up a menu. The shifted left
5072 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005073 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 popup_setpos Like "popup", but the cursor will be moved to the
5075 position where the mouse was clicked, and thus the
5076 selected operation will act upon the clicked object.
5077 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005078 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 course, that right clicking outside a selection will
5080 end Visual mode.
5081 Overview of what button does what for each model:
5082 mouse extend popup(_setpos) ~
5083 left click place cursor place cursor
5084 left drag start selection start selection
5085 shift-left search word extend selection
5086 right click extend selection popup menu (place cursor)
5087 right drag extend selection -
5088 middle click paste paste
5089
5090 In the "popup" model the right mouse button produces a pop-up menu.
5091 You need to define this first, see |popup-menu|.
5092
5093 Note that you can further refine the meaning of buttons with mappings.
5094 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5095 selection (because that's handled in the GUI code directly).
5096
5097 The 'mousemodel' option is set by the |:behave| command.
5098
5099 *'mouseshape'* *'mouses'* *E547*
5100'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005101 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 global
5103 {not in Vi}
5104 {only available when compiled with the |+mouseshape|
5105 feature}
5106 This option tells Vim what the mouse pointer should look like in
5107 different modes. The option is a comma separated list of parts, much
5108 like used for 'guicursor'. Each part consist of a mode/location-list
5109 and an argument-list:
5110 mode-list:shape,mode-list:shape,..
5111 The mode-list is a dash separated list of these modes/locations:
5112 In a normal window: ~
5113 n Normal mode
5114 v Visual mode
5115 ve Visual mode with 'selection' "exclusive" (same as 'v',
5116 if not specified)
5117 o Operator-pending mode
5118 i Insert mode
5119 r Replace mode
5120
5121 Others: ~
5122 c appending to the command-line
5123 ci inserting in the command-line
5124 cr replacing in the command-line
5125 m at the 'Hit ENTER' or 'More' prompts
5126 ml idem, but cursor in the last line
5127 e any mode, pointer below last window
5128 s any mode, pointer on a status line
5129 sd any mode, while dragging a status line
5130 vs any mode, pointer on a vertical separator line
5131 vd any mode, while dragging a vertical separator line
5132 a everywhere
5133
5134 The shape is one of the following:
5135 avail name looks like ~
5136 w x arrow Normal mouse pointer
5137 w x blank no pointer at all (use with care!)
5138 w x beam I-beam
5139 w x updown up-down sizing arrows
5140 w x leftright left-right sizing arrows
5141 w x busy The system's usual busy pointer
5142 w x no The system's usual 'no input' pointer
5143 x udsizing indicates up-down resizing
5144 x lrsizing indicates left-right resizing
5145 x crosshair like a big thin +
5146 x hand1 black hand
5147 x hand2 white hand
5148 x pencil what you write with
5149 x question big ?
5150 x rightup-arrow arrow pointing right-up
5151 w x up-arrow arrow pointing up
5152 x <number> any X11 pointer number (see X11/cursorfont.h)
5153
5154 The "avail" column contains a 'w' if the shape is available for Win32,
5155 x for X11.
5156 Any modes not specified or shapes not available use the normal mouse
5157 pointer.
5158
5159 Example: >
5160 :set mouseshape=s:udsizing,m:no
5161< will make the mouse turn to a sizing arrow over the status lines and
5162 indicate no input when the hit-enter prompt is displayed (since
5163 clicking the mouse has no effect in this state.)
5164
5165 *'mousetime'* *'mouset'*
5166'mousetime' 'mouset' number (default 500)
5167 global
5168 {not in Vi}
5169 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5170 time in msec between two mouse clicks for the second click to be
5171 recognized as a multi click.
5172
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005173 *'mzquantum'* *'mzq'*
5174'mzquantum' 'mzq' number (default 100)
5175 global
5176 {not in Vi}
5177 {not available when compiled without the |+mzscheme|
5178 feature}
5179 The number of milliseconds between polls for MzScheme threads.
5180 Negative or zero value means no thread scheduling.
5181
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 *'nrformats'* *'nf'*
5183'nrformats' 'nf' string (default "octal,hex")
5184 local to buffer
5185 {not in Vi}
5186 This defines what bases Vim will consider for numbers when using the
5187 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5188 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005189 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005191 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005192 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005194 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005195 considered to be hexadecimal. Example: Using CTRL-X on
5196 "0x100" results in "0x0ff".
5197 Numbers which simply begin with a digit in the range 1-9 are always
5198 considered decimal. This also happens for numbers that are not
5199 recognized as octal or hex.
5200
5201 *'number'* *'nu'* *'nonumber'* *'nonu'*
5202'number' 'nu' boolean (default off)
5203 local to window
5204 Print the line number in front of each line. When the 'n' option is
5205 excluded from 'cpoptions' a wrapped line will not use the column of
5206 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005207 The 'numberwidth' option can be used to set the room used for the line
5208 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 When a long, wrapped line doesn't start with the first character, '-'
5210 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005211 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5212 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005213 *number_relativenumber*
5214 The 'relativenumber' option changes the displayed number to be
5215 relative to the cursor. Together with 'number' there are these
5216 four combinations (cursor in line 3):
5217
5218 'nonu' 'nu' 'nonu' 'nu'
5219 'nornu' 'nornu' 'rnu' 'rnu'
5220
5221 |apple | 1 apple | 2 apple | 2 apple
5222 |pear | 2 pear | 1 pear | 1 pear
5223 |nobody | 3 nobody | 0 nobody |3 nobody
5224 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005225
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005226 *'numberwidth'* *'nuw'*
5227'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5228 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005229 {not in Vi}
5230 {only available when compiled with the |+linebreak|
5231 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005232 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005233 when the 'number' or 'relativenumber' option is set or printing lines
5234 with a line number. Since one space is always between the number and
5235 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005236 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005237 fit the highest line number in the buffer respectively the number of
5238 rows in the window, depending on whether 'number' or 'relativenumber'
5239 is set. Thus with the Vim default of 4 there is room for a line number
5240 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005241 The minimum value is 1, the maximum value is 10.
5242 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5243
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005244 *'omnifunc'* *'ofu'*
5245'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005246 local to buffer
5247 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005248 {not available when compiled without the |+eval|
5249 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005250 This option specifies a function to be used for Insert mode omni
5251 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005252 See |complete-functions| for an explanation of how the function is
5253 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005254 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005255 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005256 This option cannot be set from a |modeline| or in the |sandbox|, for
5257 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005258
5259
Bram Moolenaar02467872007-05-06 13:22:01 +00005260 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005261'opendevice' 'odev' boolean (default off)
5262 global
5263 {not in Vi}
5264 {only for MS-DOS, MS-Windows and OS/2}
5265 Enable reading and writing from devices. This may get Vim stuck on a
5266 device that can be opened but doesn't actually do the I/O. Therefore
5267 it is off by default.
5268 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5269 result in editing a device.
5270
5271
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005272 *'operatorfunc'* *'opfunc'*
5273'operatorfunc' 'opfunc' string (default: empty)
5274 global
5275 {not in Vi}
5276 This option specifies a function to be called by the |g@| operator.
5277 See |:map-operator| for more info and an example.
5278
5279 This option cannot be set from a |modeline| or in the |sandbox|, for
5280 security reasons.
5281
5282
Bram Moolenaar251e1912011-06-19 05:09:16 +02005283 *'osfiletype'* *'oft'*
5284'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 local to buffer
5286 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005287 This option was supported on RISC OS, which has been removed.
5288
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289
5290 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005291'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 global
5293 Specifies the nroff macros that separate paragraphs. These are pairs
5294 of two letters (see |object-motions|).
5295
5296 *'paste'* *'nopaste'*
5297'paste' boolean (default off)
5298 global
5299 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005300 Put Vim in Paste mode. This is useful if you want to cut or copy
5301 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005302 unexpected effects.
5303 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005304 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305 knows about pasting and will mostly do the right thing without 'paste'
5306 being set. The same is true for a terminal where Vim handles the
5307 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005308 This option is reset when starting the GUI. Thus if you set it in
5309 your .vimrc it will work in a terminal, but not in the GUI. Setting
5310 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5311 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312 When the 'paste' option is switched on (also when it was already on):
5313 - mapping in Insert mode and Command-line mode is disabled
5314 - abbreviations are disabled
5315 - 'textwidth' is set to 0
5316 - 'wrapmargin' is set to 0
5317 - 'autoindent' is reset
5318 - 'smartindent' is reset
5319 - 'softtabstop' is set to 0
5320 - 'revins' is reset
5321 - 'ruler' is reset
5322 - 'showmatch' is reset
5323 - 'formatoptions' is used like it is empty
5324 These options keep their value, but their effect is disabled:
5325 - 'lisp'
5326 - 'indentexpr'
5327 - 'cindent'
5328 NOTE: When you start editing another file while the 'paste' option is
5329 on, settings from the modelines or autocommands may change the
5330 settings again, causing trouble when pasting text. You might want to
5331 set the 'paste' option again.
5332 When the 'paste' option is reset the mentioned options are restored to
5333 the value before the moment 'paste' was switched from off to on.
5334 Resetting 'paste' before ever setting it does not have any effect.
5335 Since mapping doesn't work while 'paste' is active, you need to use
5336 the 'pastetoggle' option to toggle the 'paste' option with some key.
5337
5338 *'pastetoggle'* *'pt'*
5339'pastetoggle' 'pt' string (default "")
5340 global
5341 {not in Vi}
5342 When non-empty, specifies the key sequence that toggles the 'paste'
5343 option. This is like specifying a mapping: >
5344 :map {keys} :set invpaste<CR>
5345< Where {keys} is the value of 'pastetoggle'.
5346 The difference is that it will work even when 'paste' is set.
5347 'pastetoggle' works in Insert mode and Normal mode, but not in
5348 Command-line mode.
5349 Mappings are checked first, thus overrule 'pastetoggle'. However,
5350 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5351 this: >
5352 :map <F10> :set paste<CR>
5353 :map <F11> :set nopaste<CR>
5354 :imap <F10> <C-O>:set paste<CR>
5355 :imap <F11> <nop>
5356 :set pastetoggle=<F11>
5357< This will make <F10> start paste mode and <F11> stop paste mode.
5358 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5359 mode everything is inserted literally, except the 'pastetoggle' key
5360 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005361 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362
5363 *'pex'* *'patchexpr'*
5364'patchexpr' 'pex' string (default "")
5365 global
5366 {not in Vi}
5367 {not available when compiled without the |+diff|
5368 feature}
5369 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005370 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371
5372 *'patchmode'* *'pm'* *E206*
5373'patchmode' 'pm' string (default "")
5374 global
5375 {not in Vi}
5376 When non-empty the oldest version of a file is kept. This can be used
5377 to keep the original version of a file if you are changing files in a
5378 source distribution. Only the first time that a file is written a
5379 copy of the original file will be kept. The name of the copy is the
5380 name of the original file with the string in the 'patchmode' option
5381 appended. This option should start with a dot. Use a string like
5382 ".org". 'backupdir' must not be empty for this to work (Detail: The
5383 backup file is renamed to the patchmode file after the new file has
5384 been successfully written, that's why it must be possible to write a
5385 backup file). If there was no file to be backed up, an empty file is
5386 created.
5387 When the 'backupskip' pattern matches, a patchmode file is not made.
5388 Using 'patchmode' for compressed files appends the extension at the
5389 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5390 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005391 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005393 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394'path' 'pa' string (default on Unix: ".,/usr/include,,"
5395 on OS/2: ".,/emx/include,,"
5396 other systems: ".,,")
5397 global or local to buffer |global-local|
5398 {not in Vi}
5399 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005400 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5401 provided that the file being searched for has a relative path (not
5402 starting with "/", "./" or "../"). The directories in the 'path'
5403 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404 - Use commas to separate directory names: >
5405 :set path=.,/usr/local/include,/usr/include
5406< - Spaces can also be used to separate directory names (for backwards
5407 compatibility with version 3.0). To have a space in a directory
5408 name, precede it with an extra backslash, and escape the space: >
5409 :set path=.,/dir/with\\\ space
5410< - To include a comma in a directory name precede it with an extra
5411 backslash: >
5412 :set path=.,/dir/with\\,comma
5413< - To search relative to the directory of the current file, use: >
5414 :set path=.
5415< - To search in the current directory use an empty string between two
5416 commas: >
5417 :set path=,,
5418< - A directory name may end in a ':' or '/'.
5419 - Environment variables are expanded |:set_env|.
5420 - When using |netrw.vim| URLs can be used. For example, adding
5421 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005422 - Search upwards and downwards in a directory tree using "*", "**" and
5423 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424 {not available when compiled without the |+path_extra| feature}
5425 - Careful with '\' characters, type two to get one in the option: >
5426 :set path=.,c:\\include
5427< Or just use '/' instead: >
5428 :set path=.,c:/include
5429< Don't forget "." or files won't even be found in the same directory as
5430 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005431 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432 it is something like 256 or 1024 characters.
5433 You can check if all the include files are found, using the value of
5434 'path', see |:checkpath|.
5435 The use of |:set+=| and |:set-=| is preferred when adding or removing
5436 directories from the list. This avoids problems when a future version
5437 uses another default. To remove the current directory use: >
5438 :set path-=
5439< To add the current directory use: >
5440 :set path+=
5441< To use an environment variable, you probably need to replace the
5442 separator. Here is an example to append $INCL, in which directory
5443 names are separated with a semi-colon: >
5444 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5445< Replace the ';' with a ':' or whatever separator is used. Note that
5446 this doesn't work when $INCL contains a comma or white space.
5447
5448 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5449'preserveindent' 'pi' boolean (default off)
5450 local to buffer
5451 {not in Vi}
5452 When changing the indent of the current line, preserve as much of the
5453 indent structure as possible. Normally the indent is replaced by a
5454 series of tabs followed by spaces as required (unless |'expandtab'| is
5455 enabled, in which case only spaces are used). Enabling this option
5456 means the indent will preserve as many existing characters as possible
5457 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005458 'expandtab' does not apply to the preserved white space, a Tab remains
5459 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 NOTE: When using ">>" multiple times the resulting indent is a mix of
5461 tabs and spaces. You might not like this.
5462 NOTE: 'preserveindent' is reset when 'compatible' is set.
5463 Also see 'copyindent'.
5464 Use |:retab| to clean up white space.
5465
5466 *'previewheight'* *'pvh'*
5467'previewheight' 'pvh' number (default 12)
5468 global
5469 {not in Vi}
5470 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005471 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005472 Default height for a preview window. Used for |:ptag| and associated
5473 commands. Used for |CTRL-W_}| when no count is given.
5474
5475 *'previewwindow'* *'nopreviewwindow'*
5476 *'pvw'* *'nopvw'* *E590*
5477'previewwindow' 'pvw' boolean (default off)
5478 local to window
5479 {not in Vi}
5480 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005481 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005482 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 set. It's normally not set directly, but by using one of the commands
5484 |:ptag|, |:pedit|, etc.
5485
5486 *'printdevice'* *'pdev'*
5487'printdevice' 'pdev' string (default empty)
5488 global
5489 {not in Vi}
5490 {only available when compiled with the |+printer|
5491 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005492 The name of the printer to be used for |:hardcopy|.
5493 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005494 This option cannot be set from a |modeline| or in the |sandbox|, for
5495 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496
Bram Moolenaar8299df92004-07-10 09:47:34 +00005497 *'printencoding'* *'penc'*
5498'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 global
5500 {not in Vi}
5501 {only available when compiled with the |+printer|
5502 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005503 Sets the character encoding used when printing.
5504 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505
5506 *'printexpr'* *'pexpr'*
5507'printexpr' 'pexpr' String (default: see below)
5508 global
5509 {not in Vi}
5510 {only available when compiled with the |+printer|
5511 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005512 Expression used to print the PostScript produced with |:hardcopy|.
5513 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514
Bram Moolenaar8299df92004-07-10 09:47:34 +00005515 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516'printfont' 'pfn' string (default "courier")
5517 global
5518 {not in Vi}
5519 {only available when compiled with the |+printer|
5520 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005521 The name of the font that will be used for |:hardcopy|.
5522 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005523
5524 *'printheader'* *'pheader'*
5525'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5526 global
5527 {not in Vi}
5528 {only available when compiled with the |+printer|
5529 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005530 The format of the header produced in |:hardcopy| output.
5531 See |pheader-option|.
5532
5533 *'printmbcharset'* *'pmbcs'*
5534'printmbcharset' 'pmbcs' string (default "")
5535 global
5536 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005537 {only available when compiled with the |+printer|,
5538 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005539 The CJK character set to be used for CJK output from |:hardcopy|.
5540 See |pmbcs-option|.
5541
5542 *'printmbfont'* *'pmbfn'*
5543'printmbfont' 'pmbfn' string (default "")
5544 global
5545 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005546 {only available when compiled with the |+printer|,
5547 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005548 List of font names to be used for CJK output from |:hardcopy|.
5549 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550
5551 *'printoptions'* *'popt'*
5552'printoptions' 'popt' string (default "")
5553 global
5554 {not in Vi}
5555 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005556 List of items that control the format of the output of |:hardcopy|.
5557 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005559 *'prompt'* *'noprompt'*
5560'prompt' boolean (default on)
5561 global
5562 When on a ":" prompt is used in Ex mode.
5563
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005564 *'pumheight'* *'ph'*
5565'pumheight' 'ph' number (default 0)
5566 global
5567 {not available when compiled without the
5568 |+insert_expand| feature}
5569 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005570 Determines the maximum number of items to show in the popup menu for
5571 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005572 |ins-completion-menu|.
5573
5574
Bram Moolenaar677ee682005-01-27 14:41:15 +00005575 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005576'quoteescape' 'qe' string (default "\")
5577 local to buffer
5578 {not in Vi}
5579 The characters that are used to escape quotes in a string. Used for
5580 objects like a', a" and a` |a'|.
5581 When one of the characters in this option is found inside a string,
5582 the following character will be skipped. The default value makes the
5583 text "foo\"bar\\" considered to be one string.
5584
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5586'readonly' 'ro' boolean (default off)
5587 local to buffer
5588 If on, writes fail unless you use a '!'. Protects you from
5589 accidentally overwriting a file. Default on when Vim is started
5590 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005591 When using ":w!" the 'readonly' option is reset for the current
5592 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005594 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005596 *'redrawtime'* *'rdt'*
5597'redrawtime' 'rdt' number (default 2000)
5598 global
5599 {not in Vi}
5600 {only available when compiled with the |+reltime|
5601 feature}
5602 The time in milliseconds for redrawing the display. This applies to
5603 searching for patterns for 'hlsearch' and |:match| highlighting.
5604 When redrawing takes more than this many milliseconds no further
5605 matches will be highlighted. This is used to avoid that Vim hangs
5606 when using a very complicated pattern.
5607
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005608 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005609'regexpengine' 're' number (default 0)
5610 global
5611 {not in Vi}
5612 This selects the default regexp engine. |two-engines|
5613 The possible values are:
5614 0 automatic selection
5615 1 old engine
5616 2 NFA engine
5617 Note that when using the NFA engine and the pattern contains something
5618 that is not supported the pattern will not match. This is only useful
5619 for debugging the regexp engine.
5620
Bram Moolenaar64486672010-05-16 15:46:46 +02005621 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5622'relativenumber' 'rnu' boolean (default off)
5623 local to window
5624 {not in Vi}
5625 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005626 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005627 precede some vertical motion commands (e.g. j k + -) with, without
5628 having to calculate it yourself. Especially useful in combination with
5629 other commands (e.g. y d c < > gq gw =).
5630 When the 'n' option is excluded from 'cpoptions' a wrapped
5631 line will not use the column of line numbers (this is the default when
5632 'compatible' isn't set).
5633 The 'numberwidth' option can be used to set the room used for the line
5634 number.
5635 When a long, wrapped line doesn't start with the first character, '-'
5636 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005637 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5638 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005639
5640 The number in front of the cursor line also depends on the value of
5641 'number', see |number_relativenumber| for all combinations of the two
5642 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005643
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 *'remap'* *'noremap'*
5645'remap' boolean (default on)
5646 global
5647 Allows for mappings to work recursively. If you do not want this for
5648 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005649 NOTE: To avoid portability problems with Vim scripts, always keep
5650 this option at the default "on". Only switch it off when working with
5651 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005652
5653 *'report'*
5654'report' number (default 2)
5655 global
5656 Threshold for reporting number of lines changed. When the number of
5657 changed lines is more than 'report' a message will be given for most
5658 ":" commands. If you want it always, set 'report' to 0.
5659 For the ":substitute" command the number of substitutions is used
5660 instead of the number of lines.
5661
5662 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5663'restorescreen' 'rs' boolean (default on)
5664 global
5665 {not in Vi} {only in Windows 95/NT console version}
5666 When set, the screen contents is restored when exiting Vim. This also
5667 happens when executing external commands.
5668
5669 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5670 options in your .vimrc. To disable restoring:
5671 set t_ti= t_te=
5672 To enable restoring (for an xterm):
5673 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5674 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5675
5676 *'revins'* *'ri'* *'norevins'* *'nori'*
5677'revins' 'ri' boolean (default off)
5678 global
5679 {not in Vi}
5680 {only available when compiled with the |+rightleft|
5681 feature}
5682 Inserting characters in Insert mode will work backwards. See "typing
5683 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5684 command in Insert mode, when 'allowrevins' is set.
5685 NOTE: This option is reset when 'compatible' or 'paste' is set.
5686
5687 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5688'rightleft' 'rl' boolean (default off)
5689 local to window
5690 {not in Vi}
5691 {only available when compiled with the |+rightleft|
5692 feature}
5693 When on, display orientation becomes right-to-left, i.e., characters
5694 that are stored in the file appear from the right to the left.
5695 Using this option, it is possible to edit files for languages that
5696 are written from the right to the left such as Hebrew and Arabic.
5697 This option is per window, so it is possible to edit mixed files
5698 simultaneously, or to view the same file in both ways (this is
5699 useful whenever you have a mixed text file with both right-to-left
5700 and left-to-right strings so that both sets are displayed properly
5701 in different windows). Also see |rileft.txt|.
5702
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005703 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704'rightleftcmd' 'rlc' string (default "search")
5705 local to window
5706 {not in Vi}
5707 {only available when compiled with the |+rightleft|
5708 feature}
5709 Each word in this option enables the command line editing to work in
5710 right-to-left mode for a group of commands:
5711
5712 search "/" and "?" commands
5713
5714 This is useful for languages such as Hebrew, Arabic and Farsi.
5715 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5716
5717 *'ruler'* *'ru'* *'noruler'* *'noru'*
5718'ruler' 'ru' boolean (default off)
5719 global
5720 {not in Vi}
5721 {not available when compiled without the
5722 |+cmdline_info| feature}
5723 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005724 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725 text in the file is shown on the far right:
5726 Top first line is visible
5727 Bot last line is visible
5728 All first and last line are visible
5729 45% relative position in the file
5730 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005731 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005733 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 this option takes precedence over 'ruler' and 'rulerformat'
5735 If the number of characters displayed is different from the number of
5736 bytes in the text (e.g., for a TAB or a multi-byte character), both
5737 the text column (byte number) and the screen column are shown,
5738 separated with a dash.
5739 For an empty line "0-1" is shown.
5740 For an empty buffer the line number will also be zero: "0,0-1".
5741 This option is reset when the 'paste' option is set.
5742 If you don't want to see the ruler all the time but want to know where
5743 you are, use "g CTRL-G" |g_CTRL-G|.
5744 NOTE: This option is reset when 'compatible' is set.
5745
5746 *'rulerformat'* *'ruf'*
5747'rulerformat' 'ruf' string (default empty)
5748 global
5749 {not in Vi}
5750 {not available when compiled without the |+statusline|
5751 feature}
5752 When this option is not empty, it determines the content of the ruler
5753 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005754 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755 The default ruler width is 17 characters. To make the ruler 15
5756 characters wide, put "%15(" at the start and "%)" at the end.
5757 Example: >
5758 :set rulerformat=%15(%c%V\ %p%%%)
5759<
5760 *'runtimepath'* *'rtp'* *vimfiles*
5761'runtimepath' 'rtp' string (default:
5762 Unix: "$HOME/.vim,
5763 $VIM/vimfiles,
5764 $VIMRUNTIME,
5765 $VIM/vimfiles/after,
5766 $HOME/.vim/after"
5767 Amiga: "home:vimfiles,
5768 $VIM/vimfiles,
5769 $VIMRUNTIME,
5770 $VIM/vimfiles/after,
5771 home:vimfiles/after"
5772 PC, OS/2: "$HOME/vimfiles,
5773 $VIM/vimfiles,
5774 $VIMRUNTIME,
5775 $VIM/vimfiles/after,
5776 $HOME/vimfiles/after"
5777 Macintosh: "$VIM:vimfiles,
5778 $VIMRUNTIME,
5779 $VIM:vimfiles:after"
5780 RISC-OS: "Choices:vimfiles,
5781 $VIMRUNTIME,
5782 Choices:vimfiles/after"
5783 VMS: "sys$login:vimfiles,
5784 $VIM/vimfiles,
5785 $VIMRUNTIME,
5786 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005787 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 global
5789 {not in Vi}
5790 This is a list of directories which will be searched for runtime
5791 files:
5792 filetype.vim filetypes by file name |new-filetype|
5793 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005794 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 colors/ color scheme files |:colorscheme|
5796 compiler/ compiler files |:compiler|
5797 doc/ documentation |write-local-help|
5798 ftplugin/ filetype plugins |write-filetype-plugin|
5799 indent/ indent scripts |indent-expression|
5800 keymap/ key mapping files |mbyte-keymap|
5801 lang/ menu translations |:menutrans|
5802 menu.vim GUI menus |menu.vim|
5803 plugin/ plugin scripts |write-plugin|
5804 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005805 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005806 syntax/ syntax files |mysyntaxfile|
5807 tutor/ files for vimtutor |tutor|
5808
5809 And any other file searched for with the |:runtime| command.
5810
5811 The defaults for most systems are setup to search five locations:
5812 1. In your home directory, for your personal preferences.
5813 2. In a system-wide Vim directory, for preferences from the system
5814 administrator.
5815 3. In $VIMRUNTIME, for files distributed with Vim.
5816 *after-directory*
5817 4. In the "after" directory in the system-wide Vim directory. This is
5818 for the system administrator to overrule or add to the distributed
5819 defaults (rarely needed)
5820 5. In the "after" directory in your home directory. This is for
5821 personal preferences to overrule or add to the distributed defaults
5822 or system-wide settings (rarely needed).
5823
5824 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5825 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005826 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005827 wildcards.
5828 See |:runtime|.
5829 Example: >
5830 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5831< This will use the directory "~/vimruntime" first (containing your
5832 personal Vim runtime files), then "/mygroup/vim" (shared between a
5833 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5834 files).
5835 You probably should always include $VIMRUNTIME somewhere, to use the
5836 distributed runtime files. You can put a directory before $VIMRUNTIME
5837 to find files which replace a distributed runtime files. You can put
5838 a directory after $VIMRUNTIME to find files which add to distributed
5839 runtime files.
5840 This option cannot be set from a |modeline| or in the |sandbox|, for
5841 security reasons.
5842
5843 *'scroll'* *'scr'*
5844'scroll' 'scr' number (default: half the window height)
5845 local to window
5846 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5847 set to half the number of lines in the window when the window size
5848 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005849 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5851 the number of screen lines instead of file lines, makes a difference
5852 when lines wrap}
5853
5854 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5855'scrollbind' 'scb' boolean (default off)
5856 local to window
5857 {not in Vi}
5858 {not available when compiled without the |+scrollbind|
5859 feature}
5860 See also |scroll-binding|. When this option is set, the current
5861 window scrolls as other scrollbind windows (windows that also have
5862 this option set) scroll. This option is useful for viewing the
5863 differences between two versions of a file, see 'diff'.
5864 See |'scrollopt'| for options that determine how this option should be
5865 interpreted.
5866 This option is mostly reset when splitting a window to edit another
5867 file. This means that ":split | edit file" results in two windows
5868 with scroll-binding, but ":split file" does not.
5869
5870 *'scrolljump'* *'sj'*
5871'scrolljump' 'sj' number (default 1)
5872 global
5873 {not in Vi}
5874 Minimal number of lines to scroll when the cursor gets off the
5875 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5876 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005877 When set to a negative number from -1 to -100 this is used as the
5878 percentage of the window height. Thus -50 scrolls half the window
5879 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 NOTE: This option is set to 1 when 'compatible' is set.
5881
5882 *'scrolloff'* *'so'*
5883'scrolloff' 'so' number (default 0)
5884 global
5885 {not in Vi}
5886 Minimal number of screen lines to keep above and below the cursor.
5887 This will make some context visible around where you are working. If
5888 you set it to a very large value (999) the cursor line will always be
5889 in the middle of the window (except at the start or end of the file or
5890 when long lines wrap).
5891 For scrolling horizontally see 'sidescrolloff'.
5892 NOTE: This option is set to 0 when 'compatible' is set.
5893
5894 *'scrollopt'* *'sbo'*
5895'scrollopt' 'sbo' string (default "ver,jump")
5896 global
5897 {not available when compiled without the |+scrollbind|
5898 feature}
5899 {not in Vi}
5900 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005901 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5902 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005903 The following words are available:
5904 ver Bind vertical scrolling for 'scrollbind' windows
5905 hor Bind horizontal scrolling for 'scrollbind' windows
5906 jump Applies to the offset between two windows for vertical
5907 scrolling. This offset is the difference in the first
5908 displayed line of the bound windows. When moving
5909 around in a window, another 'scrollbind' window may
5910 reach a position before the start or after the end of
5911 the buffer. The offset is not changed though, when
5912 moving back the 'scrollbind' window will try to scroll
5913 to the desired position when possible.
5914 When now making that window the current one, two
5915 things can be done with the relative offset:
5916 1. When "jump" is not included, the relative offset is
5917 adjusted for the scroll position in the new current
5918 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005919 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920 2. When "jump" is included, the other windows are
5921 scrolled to keep the same relative offset. When
5922 going back to the other window, it still uses the
5923 same relative offset.
5924 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005925 When 'diff' mode is active there always is vertical scroll binding,
5926 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927
5928 *'sections'* *'sect'*
5929'sections' 'sect' string (default "SHNHH HUnhsh")
5930 global
5931 Specifies the nroff macros that separate sections. These are pairs of
5932 two letters (See |object-motions|). The default makes a section start
5933 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5934
5935 *'secure'* *'nosecure'* *E523*
5936'secure' boolean (default off)
5937 global
5938 {not in Vi}
5939 When on, ":autocmd", shell and write commands are not allowed in
5940 ".vimrc" and ".exrc" in the current directory and map commands are
5941 displayed. Switch it off only if you know that you will not run into
5942 problems, or when the 'exrc' option is off. On Unix this option is
5943 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005944 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005945 'secure' at the end of your ~/.vimrc then.
5946 This option cannot be set from a |modeline| or in the |sandbox|, for
5947 security reasons.
5948
5949 *'selection'* *'sel'*
5950'selection' 'sel' string (default "inclusive")
5951 global
5952 {not in Vi}
5953 This option defines the behavior of the selection. It is only used
5954 in Visual and Select mode.
5955 Possible values:
5956 value past line inclusive ~
5957 old no yes
5958 inclusive yes yes
5959 exclusive yes no
5960 "past line" means that the cursor is allowed to be positioned one
5961 character past the line.
5962 "inclusive" means that the last character of the selection is included
5963 in an operation. For example, when "x" is used to delete the
5964 selection.
5965 Note that when "exclusive" is used and selecting from the end
5966 backwards, you cannot include the last character of a line, when
5967 starting in Normal mode and 'virtualedit' empty.
5968
5969 The 'selection' option is set by the |:behave| command.
5970
5971 *'selectmode'* *'slm'*
5972'selectmode' 'slm' string (default "")
5973 global
5974 {not in Vi}
5975 This is a comma separated list of words, which specifies when to start
5976 Select mode instead of Visual mode, when a selection is started.
5977 Possible values:
5978 mouse when using the mouse
5979 key when using shifted special keys
5980 cmd when using "v", "V" or CTRL-V
5981 See |Select-mode|.
5982 The 'selectmode' option is set by the |:behave| command.
5983
5984 *'sessionoptions'* *'ssop'*
5985'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005986 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005987 global
5988 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005989 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005990 feature}
5991 Changes the effect of the |:mksession| command. It is a comma
5992 separated list of words. Each word enables saving and restoring
5993 something:
5994 word save and restore ~
5995 blank empty windows
5996 buffers hidden and unloaded buffers, not just those in windows
5997 curdir the current directory
5998 folds manually created folds, opened/closed folds and local
5999 fold options
6000 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006001 and contain at least one lowercase letter. Only
6002 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006003 help the help window
6004 localoptions options and mappings local to a window or buffer (not
6005 global values for local options)
6006 options all options and mappings (also global values for local
6007 options)
6008 resize size of the Vim window: 'lines' and 'columns'
6009 sesdir the directory in which the session file is located
6010 will become the current directory (useful with
6011 projects accessed over a network from different
6012 systems)
6013 slash backslashes in file names replaced with forward
6014 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006015 tabpages all tab pages; without this only the current tab page
6016 is restored, so that you can make a session for each
6017 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018 unix with Unix end-of-line format (single <NL>), even when
6019 on Windows or DOS
6020 winpos position of the whole Vim window
6021 winsize window sizes
6022
6023 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006024 When neither "curdir" nor "sesdir" is included, file names are stored
6025 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006026 "slash" and "unix" are useful on Windows when sharing session files
6027 with Unix. The Unix version of Vim cannot source dos format scripts,
6028 but the Windows version of Vim can source unix format scripts.
6029
6030 *'shell'* *'sh'* *E91*
6031'shell' 'sh' string (default $SHELL or "sh",
6032 MS-DOS and Win32: "command.com" or
6033 "cmd.exe", OS/2: "cmd")
6034 global
6035 Name of the shell to use for ! and :! commands. When changing the
6036 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6037 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006038 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 See |option-backslash| about including spaces and backslashes.
6040 Environment variables are expanded |:set_env|.
6041 If the name of the shell contains a space, you might need to enclose
6042 it in quotes. Example: >
6043 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6044< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006045 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 "-f" is not inside the quotes, because it is not part of the command
6047 name. And Vim automagically recognizes the backslashes that are path
6048 separators.
6049 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
6050 variable to change the way external commands are executed. See the
6051 libc.inf file of DJGPP.
6052 Under MS-Windows, when the executable ends in ".com" it must be
6053 included. Thus setting the shell to "command.com" or "4dos.com"
6054 works, but "command" and "4dos" do not work for all commands (e.g.,
6055 filtering).
6056 For unknown reasons, when using "4dos.com" the current directory is
6057 changed to "C:\". To avoid this set 'shell' like this: >
6058 :set shell=command.com\ /c\ 4dos
6059< This option cannot be set from a |modeline| or in the |sandbox|, for
6060 security reasons.
6061
6062 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006063'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006064 MS-DOS and Win32, when 'shell' does not
6065 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 global
6067 {not in Vi}
6068 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6069 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6070 systems, the default is set according to the value of 'shell', to
6071 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006072 OS/2 (EMX figures this out itself).
6073 On Unix it can have more than one flag. Each white space separated
6074 part is passed as an argument to the shell command.
6075 See |option-backslash| about including spaces and backslashes.
6076 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006077 This option cannot be set from a |modeline| or in the |sandbox|, for
6078 security reasons.
6079
6080 *'shellpipe'* *'sp'*
6081'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6082 global
6083 {not in Vi}
6084 {not available when compiled without the |+quickfix|
6085 feature}
6086 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006087 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006088 including spaces and backslashes.
6089 The name of the temporary file can be represented by "%s" if necessary
6090 (the file name is appended automatically if no %s appears in the value
6091 of this option).
6092 For the Amiga and MS-DOS the default is ">". The output is directly
6093 saved in a file and not echoed to the screen.
6094 For Unix the default it "| tee". The stdout of the compiler is saved
6095 in a file and echoed to the screen. If the 'shell' option is "csh" or
6096 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006097 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6098 default becomes "2>&1| tee". This means that stderr is also included.
6099 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6100 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 The initialization of this option is done after reading the ".vimrc"
6102 and the other initializations, so that when the 'shell' option is set
6103 there, the 'shellpipe' option changes automatically, unless it was
6104 explicitly set before.
6105 When 'shellpipe' is set to an empty string, no redirection of the
6106 ":make" output will be done. This is useful if you use a 'makeprg'
6107 that writes to 'makeef' by itself. If you want no piping, but do
6108 want to include the 'makeef', set 'shellpipe' to a single space.
6109 Don't forget to precede the space with a backslash: ":set sp=\ ".
6110 In the future pipes may be used for filtering and this option will
6111 become obsolete (at least for Unix).
6112 This option cannot be set from a |modeline| or in the |sandbox|, for
6113 security reasons.
6114
6115 *'shellquote'* *'shq'*
6116'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6117 contains "sh" somewhere: "\"")
6118 global
6119 {not in Vi}
6120 Quoting character(s), put around the command passed to the shell, for
6121 the "!" and ":!" commands. The redirection is kept outside of the
6122 quoting. See 'shellxquote' to include the redirection. It's
6123 probably not useful to set both options.
6124 This is an empty string by default. Only known to be useful for
6125 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6126 or bash, where it should be "\"". The default is adjusted according
6127 the value of 'shell', to reduce the need to set this option by the
6128 user. See |dos-shell|.
6129 This option cannot be set from a |modeline| or in the |sandbox|, for
6130 security reasons.
6131
6132 *'shellredir'* *'srr'*
6133'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6134 global
6135 {not in Vi}
6136 String to be used to put the output of a filter command in a temporary
6137 file. See also |:!|. See |option-backslash| about including spaces
6138 and backslashes.
6139 The name of the temporary file can be represented by "%s" if necessary
6140 (the file name is appended automatically if no %s appears in the value
6141 of this option).
6142 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6143 or "zsh" during initializations, the default becomes ">&". If the
6144 'shell' option is "sh", "ksh" or "bash" the default becomes
6145 ">%s 2>&1". This means that stderr is also included.
6146 For Win32, the Unix checks are done and additionally "cmd" is checked
6147 for, which makes the default ">%s 2>&1". Also, the same names with
6148 ".exe" appended are checked for.
6149 The initialization of this option is done after reading the ".vimrc"
6150 and the other initializations, so that when the 'shell' option is set
6151 there, the 'shellredir' option changes automatically unless it was
6152 explicitly set before.
6153 In the future pipes may be used for filtering and this option will
6154 become obsolete (at least for Unix).
6155 This option cannot be set from a |modeline| or in the |sandbox|, for
6156 security reasons.
6157
6158 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6159'shellslash' 'ssl' boolean (default off)
6160 global
6161 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6162 When set, a forward slash is used when expanding file names. This is
6163 useful when a Unix-like shell is used instead of command.com or
6164 cmd.exe. Backward slashes can still be typed, but they are changed to
6165 forward slashes by Vim.
6166 Note that setting or resetting this option has no effect for some
6167 existing file names, thus this option needs to be set before opening
6168 any file for best results. This might change in the future.
6169 'shellslash' only works when a backslash can be used as a path
6170 separator. To test if this is so use: >
6171 if exists('+shellslash')
6172<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006173 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6174'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6175 global
6176 {not in Vi}
6177 When on, use temp files for shell commands. When off use a pipe.
6178 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006179 Currently a pipe is only supported on Unix and MS-Windows 2K and
6180 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006181 :if has("filterpipe")
6182< The advantage of using a pipe is that nobody can read the temp file
6183 and the 'shell' command does not need to support redirection.
6184 The advantage of using a temp file is that the file type and encoding
6185 can be detected.
6186 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6187 |FilterWritePost| autocommands event are not triggered when
6188 'shelltemp' is off.
6189
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 *'shelltype'* *'st'*
6191'shelltype' 'st' number (default 0)
6192 global
6193 {not in Vi} {only for the Amiga}
6194 On the Amiga this option influences the way how the commands work
6195 which use a shell.
6196 0 and 1: always use the shell
6197 2 and 3: use the shell only to filter lines
6198 4 and 5: use shell only for ':sh' command
6199 When not using the shell, the command is executed directly.
6200
6201 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6202 1 and 3: use "shell cmd" to start external commands
6203
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006204 *'shellxescape'* *'sxe'*
6205'shellxescape' 'sxe' string (default: "";
6206 for MS-DOS and MS-Windows: "\"&|<>()@^")
6207 global
6208 {not in Vi}
6209 When 'shellxquote' is set to "(" then the characters listed in this
6210 option will be escaped with a '^' character. This makes it possible
6211 to execute most external commands with cmd.exe.
6212
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 *'shellxquote'* *'sxq'*
6214'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006215 for Win32, when 'shell' is cmd.exe: "("
6216 for Win32, when 'shell' contains "sh"
6217 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 for Unix, when using system(): "\"")
6219 global
6220 {not in Vi}
6221 Quoting character(s), put around the command passed to the shell, for
6222 the "!" and ":!" commands. Includes the redirection. See
6223 'shellquote' to exclude the redirection. It's probably not useful
6224 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006225 When the value is '(' then ')' is appended. When the value is '"('
6226 then ')"' is appended.
6227 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006228 This is an empty string by default on most systems, but is known to be
6229 useful for on Win32 version, either for cmd.exe which automatically
6230 strips off the first and last quote on a command, or 3rd-party shells
6231 such as the MKS Korn Shell or bash, where it should be "\"". The
6232 default is adjusted according the value of 'shell', to reduce the need
6233 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 This option cannot be set from a |modeline| or in the |sandbox|, for
6235 security reasons.
6236
6237 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6238'shiftround' 'sr' boolean (default off)
6239 global
6240 {not in Vi}
6241 Round indent to multiple of 'shiftwidth'. Applies to > and <
6242 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6243 a multiple of 'shiftwidth' (this is Vi compatible).
6244 NOTE: This option is reset when 'compatible' is set.
6245
6246 *'shiftwidth'* *'sw'*
6247'shiftwidth' 'sw' number (default 8)
6248 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006249 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006250 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006251 When zero the 'ts' value will be used. Use the |shiftwidth()|
6252 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253
6254 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006255'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6256 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 global
6258 {not in Vi}
6259 This option helps to avoid all the |hit-enter| prompts caused by file
6260 messages, for example with CTRL-G, and to avoid some other messages.
6261 It is a list of flags:
6262 flag meaning when present ~
6263 f use "(3 of 5)" instead of "(file 3 of 5)"
6264 i use "[noeol]" instead of "[Incomplete last line]"
6265 l use "999L, 888C" instead of "999 lines, 888 characters"
6266 m use "[+]" instead of "[Modified]"
6267 n use "[New]" instead of "[New File]"
6268 r use "[RO]" instead of "[readonly]"
6269 w use "[w]" instead of "written" for file write message
6270 and "[a]" instead of "appended" for ':w >> file' command
6271 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6272 "[unix format]" and "[mac]" instead of "[mac format]".
6273 a all of the above abbreviations
6274
6275 o overwrite message for writing a file with subsequent message
6276 for reading a file (useful for ":wn" or when 'autowrite' on)
6277 O message for reading a file overwrites any previous message.
6278 Also for quickfix message (e.g., ":cn").
6279 s don't give "search hit BOTTOM, continuing at TOP" or "search
6280 hit TOP, continuing at BOTTOM" messages
6281 t truncate file message at the start if it is too long to fit
6282 on the command-line, "<" will appear in the left most column.
6283 Ignored in Ex mode.
6284 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006285 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006286 Ignored in Ex mode.
6287 W don't give "written" or "[w]" when writing a file
6288 A don't give the "ATTENTION" message when an existing swap file
6289 is found.
6290 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006291 c don't give |ins-completion-menu| messages. For example,
6292 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6293 "Pattern not found", "Back at original", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294
6295 This gives you the opportunity to avoid that a change between buffers
6296 requires you to hit <Enter>, but still gives as useful a message as
6297 possible for the space available. To get the whole message that you
6298 would have got with 'shm' empty, use ":file!"
6299 Useful values:
6300 shm= No abbreviation of message.
6301 shm=a Abbreviation, but no loss of information.
6302 shm=at Abbreviation, and truncate message when necessary.
6303
6304 NOTE: This option is set to the Vi default value when 'compatible' is
6305 set and to the Vim default value when 'compatible' is reset.
6306
6307 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6308'shortname' 'sn' boolean (default off)
6309 local to buffer
6310 {not in Vi, not in MS-DOS versions}
6311 Filenames are assumed to be 8 characters plus one extension of 3
6312 characters. Multiple dots in file names are not allowed. When this
6313 option is on, dots in file names are replaced with underscores when
6314 adding an extension (".~" or ".swp"). This option is not available
6315 for MS-DOS, because then it would always be on. This option is useful
6316 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6317 or crossdos. When running the Win32 GUI version under Win32s, this
6318 option is always on by default.
6319
6320 *'showbreak'* *'sbr'* *E595*
6321'showbreak' 'sbr' string (default "")
6322 global
6323 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006324 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325 feature}
6326 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006327 values are "> " or "+++ ": >
6328 :set showbreak=>\
6329< Note the backslash to escape the trailing space. It's easier like
6330 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006331 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006332< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 comma (in a future version the comma might be used to separate the
6334 part that is shown at the end and at the start of a line).
6335 The characters are highlighted according to the '@' flag in
6336 'highlight'.
6337 Note that tabs after the showbreak will be displayed differently.
6338 If you want the 'showbreak' to appear in between line numbers, add the
6339 "n" flag to 'cpoptions'.
6340
6341 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6342'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6343 off)
6344 global
6345 {not in Vi}
6346 {not available when compiled without the
6347 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006348 Show (partial) command in the last line of the screen. Set this
6349 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350 In Visual mode the size of the selected area is shown:
6351 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006352 If the number of bytes is different it is also displayed: "2-6"
6353 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006355 - When selecting a block, the size in screen characters:
6356 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 NOTE: This option is set to the Vi default value when 'compatible' is
6358 set and to the Vim default value when 'compatible' is reset.
6359
6360 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6361'showfulltag' 'sft' boolean (default off)
6362 global
6363 {not in Vi}
6364 When completing a word in insert mode (see |ins-completion|) from the
6365 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006366 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367 matched a C function, you can see a template for what arguments are
6368 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006369 Note that this doesn't work well together with having "longest" in
6370 'completeopt', because the completion from the search pattern may not
6371 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372
6373 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6374'showmatch' 'sm' boolean (default off)
6375 global
6376 When a bracket is inserted, briefly jump to the matching one. The
6377 jump is only done if the match can be seen on the screen. The time to
6378 show the match can be set with 'matchtime'.
6379 A Beep is given if there is no match (no matter if the match can be
6380 seen or not). This option is reset when the 'paste' option is set.
6381 When the 'm' flag is not included in 'cpoptions', typing a character
6382 will immediately move the cursor back to where it belongs.
6383 See the "sm" field in 'guicursor' for setting the cursor shape and
6384 blinking when showing the match.
6385 The 'matchpairs' option can be used to specify the characters to show
6386 matches for. 'rightleft' and 'revins' are used to look for opposite
6387 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006388 Also see the matchparen plugin for highlighting the match when moving
6389 around |pi_paren.txt|.
6390 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391
6392 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6393'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6394 global
6395 If in Insert, Replace or Visual mode put a message on the last line.
6396 Use the 'M' flag in 'highlight' to set the type of highlighting for
6397 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006398 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 doesn't mean XIM is really active, especially when 'imactivatekey' is
6400 not set.
6401 NOTE: This option is set to the Vi default value when 'compatible' is
6402 set and to the Vim default value when 'compatible' is reset.
6403
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006404 *'showtabline'* *'stal'*
6405'showtabline' 'stal' number (default 1)
6406 global
6407 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006408 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006409 feature}
6410 The value of this option specifies when the line with tab page labels
6411 will be displayed:
6412 0: never
6413 1: only if there are at least two tab pages
6414 2: always
6415 This is both for the GUI and non-GUI implementation of the tab pages
6416 line.
6417 See |tab-page| for more information about tab pages.
6418
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419 *'sidescroll'* *'ss'*
6420'sidescroll' 'ss' number (default 0)
6421 global
6422 {not in Vi}
6423 The minimal number of columns to scroll horizontally. Used only when
6424 the 'wrap' option is off and the cursor is moved off of the screen.
6425 When it is zero the cursor will be put in the middle of the screen.
6426 When using a slow terminal set it to a large number or 0. When using
6427 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6428 commands.
6429
6430 *'sidescrolloff'* *'siso'*
6431'sidescrolloff' 'siso' number (default 0)
6432 global
6433 {not in Vi}
6434 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006435 right of the cursor if 'nowrap' is set. Setting this option to a
6436 value greater than 0 while having |'sidescroll'| also at a non-zero
6437 value makes some context visible in the line you are scrolling in
6438 horizontally (except at beginning of the line). Setting this option
6439 to a large value (like 999) has the effect of keeping the cursor
6440 horizontally centered in the window, as long as one does not come too
6441 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 NOTE: This option is set to 0 when 'compatible' is set.
6443
6444 Example: Try this together with 'sidescroll' and 'listchars' as
6445 in the following example to never allow the cursor to move
6446 onto the "extends" character:
6447
6448 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6449 :set sidescrolloff=1
6450
6451
6452 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6453'smartcase' 'scs' boolean (default off)
6454 global
6455 {not in Vi}
6456 Override the 'ignorecase' option if the search pattern contains upper
6457 case characters. Only used when the search pattern is typed and
6458 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006459 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6461 recalling the search pattern from history and hitting <Enter>.
6462 NOTE: This option is reset when 'compatible' is set.
6463
6464 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6465'smartindent' 'si' boolean (default off)
6466 local to buffer
6467 {not in Vi}
6468 {not available when compiled without the
6469 |+smartindent| feature}
6470 Do smart autoindenting when starting a new line. Works for C-like
6471 programs, but can also be used for other languages. 'cindent' does
6472 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006473 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006474 setting 'si' has no effect. 'indentexpr' is a more advanced
6475 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 Normally 'autoindent' should also be on when using 'smartindent'.
6477 An indent is automatically inserted:
6478 - After a line ending in '{'.
6479 - After a line starting with a keyword from 'cinwords'.
6480 - Before a line starting with '}' (only with the "O" command).
6481 When typing '}' as the first character in a new line, that line is
6482 given the same indent as the matching '{'.
6483 When typing '#' as the first character in a new line, the indent for
6484 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006485 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6487 When using the ">>" command, lines starting with '#' are not shifted
6488 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006489 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 is set smart indenting is disabled.
6491
6492 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6493'smarttab' 'sta' boolean (default off)
6494 global
6495 {not in Vi}
6496 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006497 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6498 <BS> will delete a 'shiftwidth' worth of space at the start of the
6499 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006500 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006501 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6502 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006503 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006504 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006505 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 NOTE: This option is reset when 'compatible' is set.
6507
6508 *'softtabstop'* *'sts'*
6509'softtabstop' 'sts' number (default 0)
6510 local to buffer
6511 {not in Vi}
6512 Number of spaces that a <Tab> counts for while performing editing
6513 operations, like inserting a <Tab> or using <BS>. It "feels" like
6514 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6515 used. This is useful to keep the 'ts' setting at its standard value
6516 of 8, while being able to edit like it is set to 'sts'. However,
6517 commands like "x" still work on the actual characters.
6518 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006519 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 'softtabstop' is set to 0 when the 'paste' option is set.
6521 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6522 spaces is minimized by using <Tab>s.
6523 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6524 set.
6525 NOTE: This option is set to 0 when 'compatible' is set.
6526
Bram Moolenaar217ad922005-03-20 22:37:15 +00006527 *'spell'* *'nospell'*
6528'spell' boolean (default off)
6529 local to window
6530 {not in Vi}
6531 {not available when compiled without the |+syntax|
6532 feature}
6533 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006534 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006535
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006536 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006537'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006538 local to buffer
6539 {not in Vi}
6540 {not available when compiled without the |+syntax|
6541 feature}
6542 Pattern to locate the end of a sentence. The following word will be
6543 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006544 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006545 When this check is not wanted make this option empty.
6546 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006547 Be careful with special characters, see |option-backslash| about
6548 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006549 To set this option automatically depending on the language, see
6550 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006551
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006552 *'spellfile'* *'spf'*
6553'spellfile' 'spf' string (default empty)
6554 local to buffer
6555 {not in Vi}
6556 {not available when compiled without the |+syntax|
6557 feature}
6558 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006559 commands. It must end in ".{encoding}.add". You need to include the
6560 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006561 *E765*
6562 It may also be a comma separated list of names. A count before the
6563 |zg| and |zw| commands can be used to access each. This allows using
6564 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006565 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006566 you: Using the first directory in 'runtimepath' that is writable. If
6567 there is no "spell" directory yet it will be created. For the file
6568 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006569 ignoring the region.
6570 The resulting ".spl" file will be used for spell checking, it does not
6571 have to appear in 'spelllang'.
6572 Normally one file is used for all regions, but you can add the region
6573 name if you want to. However, it will then only be used when
6574 'spellfile' is set to it, for entries in 'spelllang' only files
6575 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006576 This option cannot be set from a |modeline| or in the |sandbox|, for
6577 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006578
Bram Moolenaar217ad922005-03-20 22:37:15 +00006579 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006580'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006581 local to buffer
6582 {not in Vi}
6583 {not available when compiled without the |+syntax|
6584 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006585 A comma separated list of word list names. When the 'spell' option is
6586 on spellchecking will be done for these languages. Example: >
6587 set spelllang=en_us,nl,medical
6588< This means US English, Dutch and medical words are recognized. Words
6589 that are not recognized will be highlighted.
6590 The word list name must not include a comma or dot. Using a dash is
6591 recommended to separate the two letter language name from a
6592 specification. Thus "en-rare" is used for rare English words.
6593 A region name must come last and have the form "_xx", where "xx" is
6594 the two-letter, lower case region name. You can use more than one
6595 region by listing them: "en_us,en_ca" supports both US and Canadian
6596 English, but not words specific for Australia, New Zealand or Great
6597 Britain.
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006598 If the name "cjk" is included East Asian characters are excluded from
6599 spell checking. This is useful when editing text that also has Asian
6600 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006601 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006602 As a special case the name of a .spl file can be given as-is. The
6603 first "_xx" in the name is removed and used as the region name
6604 (_xx is an underscore, two letters and followed by a non-letter).
6605 This is mainly for testing purposes. You must make sure the correct
6606 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006607 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006608 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6609 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006610 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006611
Bram Moolenaar98692072006-02-04 00:57:42 +00006612 If the |spellfile.vim| plugin is active and you use a language name
6613 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6614 will ask you if you want to download the file.
6615
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006616 After this option has been set successfully, Vim will source the files
6617 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006618 up to the first comma, dot or underscore.
6619 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006620
6621
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006622 *'spellsuggest'* *'sps'*
6623'spellsuggest' 'sps' string (default "best")
6624 global
6625 {not in Vi}
6626 {not available when compiled without the |+syntax|
6627 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006628 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006629 the |spellsuggest()| function. This is a comma-separated list of
6630 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006631
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006632 best Internal method that works best for English. Finds
6633 changes like "fast" and uses a bit of sound-a-like
6634 scoring to improve the ordering.
6635
6636 double Internal method that uses two methods and mixes the
6637 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006638 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006639 word. That only works when the language specifies
6640 sound folding. Can be slow and doesn't always give
6641 better results.
6642
6643 fast Internal method that only checks for simple changes:
6644 character inserts/deletes/swaps. Works well for
6645 simple typing mistakes.
6646
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006647 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006648 Not used for |spellsuggest()|. The number of
6649 suggestions is never more than the value of 'lines'
6650 minus two.
6651
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006652 file:{filename} Read file {filename}, which must have two columns,
6653 separated by a slash. The first column contains the
6654 bad word, the second column the suggested good word.
6655 Example:
6656 theribal/terrible ~
6657 Use this for common mistakes that do not appear at the
6658 top of the suggestion list with the internal methods.
6659 Lines without a slash are ignored, use this for
6660 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006661 The word in the second column must be correct,
6662 otherwise it will not be used. Add the word to an
6663 ".add" file if it is currently flagged as a spelling
6664 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006665 The file is used for all languages.
6666
6667 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6668 trouble with spaces. |v:val| holds the badly spelled
6669 word. The expression must evaluate to a List of
6670 Lists, each with a suggestion and a score.
6671 Example:
6672 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006673 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006674 internal methods use. A lower score is better.
6675 This may invoke |spellsuggest()| if you temporarily
6676 set 'spellsuggest' to exclude the "expr:" part.
6677 Errors are silently ignored, unless you set the
6678 'verbose' option to a non-zero value.
6679
6680 Only one of "best", "double" or "fast" may be used. The others may
6681 appear several times in any order. Example: >
6682 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6683<
6684 This option cannot be set from a |modeline| or in the |sandbox|, for
6685 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006686
6687
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6689'splitbelow' 'sb' boolean (default off)
6690 global
6691 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006692 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 feature}
6694 When on, splitting a window will put the new window below the current
6695 one. |:split|
6696
6697 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6698'splitright' 'spr' boolean (default off)
6699 global
6700 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006701 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 feature}
6703 When on, splitting a window will put the new window right of the
6704 current one. |:vsplit|
6705
6706 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6707'startofline' 'sol' boolean (default on)
6708 global
6709 {not in Vi}
6710 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006711 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006712 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006713 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 with a linewise operator, with "%" with a count and to buffer changing
6715 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6716 only has a line number, e.g., ":25" or ":+".
6717 In case of buffer changing commands the cursor is placed at the column
6718 where it was the last time the buffer was edited.
6719 NOTE: This option is set when 'compatible' is set.
6720
Bram Moolenaar00654022011-02-25 14:42:19 +01006721 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006723 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 {not in Vi}
6725 {not available when compiled without the |+statusline|
6726 feature}
6727 When nonempty, this option determines the content of the status line.
6728 Also see |status-line|.
6729
6730 The option consists of printf style '%' items interspersed with
6731 normal text. Each status line item is of the form:
6732 %-0{minwid}.{maxwid}{item}
6733 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006734 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735
Bram Moolenaar238a5642006-02-21 22:12:05 +00006736 When the option starts with "%!" then it is used as an expression,
6737 evaluated and the result is used as the option value. Example: >
6738 :set statusline=%!MyStatusLine()
6739< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006740 Note that the "%!" expression is evaluated in the context of the
6741 current window and buffer, while %{} items are evaluated in the
6742 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006743
6744 When there is error while evaluating the option then it will be made
6745 empty to avoid further errors. Otherwise screen updating would loop.
6746
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 Note that the only effect of 'ruler' when this option is set (and
6748 'laststatus' is 2) is controlling the output of |CTRL-G|.
6749
6750 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006751 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006753 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 minwid Minimum width of the item, padding as set by '-' & '0'.
6755 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006756 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006757 on the left for text items. Numeric items will be
6758 shifted down to maxwid-2 digits followed by '>'number
6759 where number is the amount of missing digits, much like
6760 an exponential notation.
6761 item A one letter code as described below.
6762
6763 Following is a description of the possible statusline items. The
6764 second character in "item" is the type:
6765 N for number
6766 S for string
6767 F for flags as described below
6768 - not applicable
6769
6770 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006771 f S Path to the file in the buffer, as typed or relative to current
6772 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 F S Full path to the file in the buffer.
6774 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006775 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006777 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006778 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006779 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006780 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006781 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006783 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6785 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006786 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6788 being used: "<keymap>"
6789 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006790 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791 B N As above, in hexadecimal.
6792 o N Byte number in file of byte under cursor, first byte is 1.
6793 Mnemonic: Offset from start of file (with one added)
6794 {not available when compiled without |+byte_offset| feature}
6795 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006796 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 l N Line number.
6798 L N Number of lines in buffer.
6799 c N Column number.
6800 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006801 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006802 p N Percentage through file in lines as in |CTRL-G|.
6803 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02006804 percentage described for 'ruler'. Always 3 in length, unless
6805 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006806 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006807 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006808 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006809 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810 ( - Start of item group. Can be used for setting the width and
6811 alignment of a section. Must be followed by %) somewhere.
6812 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006813 T N For 'tabline': start of tab page N label. Use %T after the last
6814 label. This information is used for mouse clicks.
6815 X N For 'tabline': start of close tab N label. Use %X after the
6816 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6817 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 < - Where to truncate line if too long. Default is at the start.
6819 No width fields allowed.
6820 = - Separation point between left and right aligned items.
6821 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006822 # - Set highlight group. The name must follow and then a # again.
6823 Thus use %#HLname# for highlight group HLname. The same
6824 highlighting is used, also for the statusline of non-current
6825 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006827 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 The difference between User{N} and StatusLine will be applied
6829 to StatusLineNC for the statusline of non-current windows.
6830 The number N must be between 1 and 9. See |hl-User1..9|
6831
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006832 When displaying a flag, Vim removes the leading comma, if any, when
6833 that flag comes right after plaintext. This will make a nice display
6834 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835
Bram Moolenaar582fd852005-03-28 20:58:01 +00006836 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 not set) and a minwid is not set for the group, the whole group will
6838 become empty. This will make a group like the following disappear
6839 completely from the statusline when none of the flags are set. >
6840 :set statusline=...%(\ [%M%R%H]%)...
6841<
6842 Beware that an expression is evaluated each and every time the status
6843 line is displayed. The current buffer and current window will be set
6844 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006845 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006847 real current buffer.
6848
Bram Moolenaar30b65812012-07-12 22:01:11 +02006849 The 'statusline' option will be evaluated in the |sandbox| if set from
6850 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006851
6852 It is not allowed to change text or jump to another window while
6853 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854
6855 If the statusline is not updated when you want it (e.g., after setting
6856 a variable that's used in an expression), you can force an update by
6857 setting an option without changing its value. Example: >
6858 :let &ro = &ro
6859
6860< A result of all digits is regarded a number for display purposes.
6861 Otherwise the result is taken as flag text and applied to the rules
6862 described above.
6863
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006864 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006865 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6866 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6867
6868 Examples:
6869 Emulate standard status line with 'ruler' set >
6870 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6871< Similar, but add ASCII value of char under the cursor (like "ga") >
6872 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6873< Display byte count and byte value, modified flag in red. >
6874 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6875 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6876< Display a ,GZ flag if a compressed file is loaded >
6877 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6878< In the |:autocmd|'s: >
6879 :let b:gzflag = 1
6880< And: >
6881 :unlet b:gzflag
6882< And define this function: >
6883 :function VarExists(var, val)
6884 : if exists(a:var) | return a:val | else | return '' | endif
6885 :endfunction
6886<
6887 *'suffixes'* *'su'*
6888'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6889 global
6890 {not in Vi}
6891 Files with these suffixes get a lower priority when multiple files
6892 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006893 suffixes. Spaces after the comma are ignored. A dot is also seen as
6894 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 separator, precede it with a backslash (see |option-backslash| about
6896 including spaces and backslashes).
6897 See 'wildignore' for completely ignoring files.
6898 The use of |:set+=| and |:set-=| is preferred when adding or removing
6899 suffixes from the list. This avoids problems when a future version
6900 uses another default.
6901
6902 *'suffixesadd'* *'sua'*
6903'suffixesadd' 'sua' string (default "")
6904 local to buffer
6905 {not in Vi}
6906 {not available when compiled without the
6907 |+file_in_path| feature}
6908 Comma separated list of suffixes, which are used when searching for a
6909 file for the "gf", "[I", etc. commands. Example: >
6910 :set suffixesadd=.java
6911<
6912 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6913'swapfile' 'swf' boolean (default on)
6914 local to buffer
6915 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006916 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 swapfile is not wanted for a specific buffer. For example, with
6918 confidential information that even root must not be able to access.
6919 Careful: All text will be in memory:
6920 - Don't use this for big files.
6921 - Recovery will be impossible!
6922 A swapfile will only be present when |'updatecount'| is non-zero and
6923 'swapfile' is set.
6924 When 'swapfile' is reset, the swap file for the current buffer is
6925 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6926 non-zero, a swap file is immediately created.
6927 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01006928 If you want to open a new buffer without creating a swap file for it,
6929 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930
6931 This option is used together with 'bufhidden' and 'buftype' to
6932 specify special kinds of buffers. See |special-buffers|.
6933
6934 *'swapsync'* *'sws'*
6935'swapsync' 'sws' string (default "fsync")
6936 global
6937 {not in Vi}
6938 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006939 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 When this option is empty parts of the swap file may be in memory and
6941 not written to disk. When the system crashes you may lose more work.
6942 On Unix the system does a sync now and then without Vim asking for it,
6943 so the disadvantage of setting this option off is small. On some
6944 systems the swap file will not be written at all. For a unix system
6945 setting it to "sync" will use the sync() call instead of the default
6946 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006947 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948
6949 *'switchbuf'* *'swb'*
6950'switchbuf' 'swb' string (default "")
6951 global
6952 {not in Vi}
6953 This option controls the behavior when switching between buffers.
6954 Possible values (comma separated list):
6955 useopen If included, jump to the first open window that
6956 contains the specified buffer (if there is one).
6957 Otherwise: Do not examine other windows.
6958 This setting is checked with |quickfix| commands, when
6959 jumping to errors (":cc", ":cn", "cp", etc.). It is
6960 also used in all buffer related split commands, for
6961 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006962 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006963 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02006965 a buffer for a |quickfix| command that display errors.
6966 Otherwise: do not split, use current window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006967 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006968 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006970 *'synmaxcol'* *'smc'*
6971'synmaxcol' 'smc' number (default 3000)
6972 local to buffer
6973 {not in Vi}
6974 {not available when compiled without the |+syntax|
6975 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006976 Maximum column in which to search for syntax items. In long lines the
6977 text after this column is not highlighted and following lines may not
6978 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006979 This helps to avoid very slow redrawing for an XML file that is one
6980 long line.
6981 Set to zero to remove the limit.
6982
Bram Moolenaar071d4272004-06-13 20:20:40 +00006983 *'syntax'* *'syn'*
6984'syntax' 'syn' string (default empty)
6985 local to buffer
6986 {not in Vi}
6987 {not available when compiled without the |+syntax|
6988 feature}
6989 When this option is set, the syntax with this name is loaded, unless
6990 syntax highlighting has been switched off with ":syntax off".
6991 Otherwise this option does not always reflect the current syntax (the
6992 b:current_syntax variable does).
6993 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006994 not automatically recognized. Example, in an IDL file:
6995 /* vim: set syntax=idl : */ ~
6996 When a dot appears in the value then this separates two filetype
6997 names. Example:
6998 /* vim: set syntax=c.doxygen : */ ~
6999 This will use the "c" syntax first, then the "doxygen" syntax.
7000 Note that the second one must be prepared to be loaded as an addition,
7001 otherwise it will be skipped. More than one dot may appear.
7002 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 :set syntax=OFF
7004< To switch syntax highlighting on according to the current value of the
7005 'filetype' option: >
7006 :set syntax=ON
7007< What actually happens when setting the 'syntax' option is that the
7008 Syntax autocommand event is triggered with the value as argument.
7009 This option is not copied to another buffer, independent of the 's' or
7010 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007011 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007012
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007013 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007014'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007015 global
7016 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007017 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007018 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007019 When nonempty, this option determines the content of the tab pages
7020 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007021 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007022
7023 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007024 option and only when there is no GUI tab line. When 'e' is in
7025 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007026 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007027
7028 The value is evaluated like with 'statusline'. You can use
7029 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007030 the text to be displayed. Use "%1T" for the first label, "%2T" for
7031 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007032
7033 Keep in mind that only one of the tab pages is the current one, others
7034 are invisible and you can't jump to their windows.
7035
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007036
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007037 *'tabpagemax'* *'tpm'*
7038'tabpagemax' 'tpm' number (default 10)
7039 global
7040 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007041 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007042 feature}
7043 Maximum number of tab pages to be opened by the |-p| command line
7044 argument or the ":tab all" command. |tabpage|
7045
7046
7047 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048'tabstop' 'ts' number (default 8)
7049 local to buffer
7050 Number of spaces that a <Tab> in the file counts for. Also see
7051 |:retab| command, and 'softtabstop' option.
7052
7053 Note: Setting 'tabstop' to any other value than 8 can make your file
7054 appear wrong in many places (e.g., when printing it).
7055
7056 There are four main ways to use tabs in Vim:
7057 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7058 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007059 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 behave like a tab appears every 4 (or 3) characters.
7061 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7062 'expandtab'. This way you will always insert spaces. The
7063 formatting will never be messed up when 'tabstop' is changed.
7064 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007065 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066 works when using Vim to edit the file.
7067 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7068 'noexpandtab'. This should then work (for initial indents only)
7069 for any tabstop setting that people use. It might be nice to have
7070 tabs after the first non-blank inserted as spaces if you do this
7071 though. Otherwise aligned comments will be wrong when 'tabstop' is
7072 changed.
7073
7074 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7075'tagbsearch' 'tbs' boolean (default on)
7076 global
7077 {not in Vi}
7078 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007079 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080 searching makes searching for a tag a LOT faster, but a linear search
7081 will find more tags if the tags file wasn't properly sorted.
7082 Vim normally assumes that your tags files are sorted, or indicate that
7083 they are not sorted. Only when this is not the case does the
7084 'tagbsearch' option need to be switched off.
7085
7086 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007087 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007088 certain files, or retry all files with a linear search. When
7089 'tagbsearch' is off, only a linear search is done.
7090
7091 Linear searching is done anyway, for one file, when Vim finds a line
7092 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007093 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094< [The whitespace before and after the '0' must be a single <Tab>]
7095
7096 When a binary search was done and no match was found in any of the
7097 files listed in 'tags', and 'ignorecase' is set or a pattern is used
7098 instead of a normal tag name, a retry is done with a linear search.
7099 Tags in unsorted tags files, and matches with different case will only
7100 be found in the retry.
7101
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007102 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 linear search can be avoided for the 'ignorecase' case. Use a value
7104 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
7105 case-fold sorted with the -f switch to "sort" in most unices, as in
7106 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007107 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
7108 for this as well. Note that case must be folded to uppercase for this
7109 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110
7111 When 'tagbsearch' is off, tags searching is slower when a full match
7112 exists, but faster when no full match exists. Tags in unsorted tags
7113 files may only be found with 'tagbsearch' off.
7114 When the tags file is not sorted, or sorted in a wrong way (not on
7115 ASCII byte value), 'tagbsearch' should be off, or the line given above
7116 must be included in the tags file.
7117 This option doesn't affect commands that find all matching tags (e.g.,
7118 command-line completion and ":help").
7119 {Vi: always uses binary search in some versions}
7120
7121 *'taglength'* *'tl'*
7122'taglength' 'tl' number (default 0)
7123 global
7124 If non-zero, tags are significant up to this number of characters.
7125
7126 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7127'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7128 global
7129 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007130 If on and using a tags file in another directory, file names in that
7131 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007132 NOTE: This option is set to the Vi default value when 'compatible' is
7133 set and to the Vim default value when 'compatible' is reset.
7134
7135 *'tags'* *'tag'* *E433*
7136'tags' 'tag' string (default "./tags,tags", when compiled with
7137 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7138 global or local to buffer |global-local|
7139 Filenames for the tag command, separated by spaces or commas. To
7140 include a space or comma in a file name, precede it with a backslash
7141 (see |option-backslash| about including spaces and backslashes).
7142 When a file name starts with "./", the '.' is replaced with the path
7143 of the current file. But only when the 'd' flag is not included in
7144 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7145 |tags-option|.
7146 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007147 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7148 find all files named "tags" below "/lib". The filename itself cannot
7149 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7150 files called "tags?". {not available when compiled without the
7151 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007152 The |tagfiles()| function can be used to get a list of the file names
7153 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7155 files are also supported. They are automatically recognized. The
7156 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7157 differences are ignored (MS-Windows). |emacs-tags|
7158 The use of |:set+=| and |:set-=| is preferred when adding or removing
7159 file names from the list. This avoids problems when a future version
7160 uses another default.
7161 {Vi: default is "tags /usr/lib/tags"}
7162
7163 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7164'tagstack' 'tgst' boolean (default on)
7165 global
7166 {not in all versions of Vi}
7167 When on, the |tagstack| is used normally. When off, a ":tag" or
7168 ":tselect" command with an argument will not push the tag onto the
7169 tagstack. A following ":tag" without an argument, a ":pop" command or
7170 any other command that uses the tagstack will use the unmodified
7171 tagstack, but does change the pointer to the active entry.
7172 Resetting this option is useful when using a ":tag" command in a
7173 mapping which should not change the tagstack.
7174
7175 *'term'* *E529* *E530* *E531*
7176'term' string (default is $TERM, if that fails:
7177 in the GUI: "builtin_gui"
7178 on Amiga: "amiga"
7179 on BeOS: "beos-ansi"
7180 on Mac: "mac-ansi"
7181 on MiNT: "vt52"
7182 on MS-DOS: "pcterm"
7183 on OS/2: "os2ansi"
7184 on Unix: "ansi"
7185 on VMS: "ansi"
7186 on Win 32: "win32")
7187 global
7188 Name of the terminal. Used for choosing the terminal control
7189 characters. Environment variables are expanded |:set_env|.
7190 For example: >
7191 :set term=$TERM
7192< See |termcap|.
7193
7194 *'termbidi'* *'tbidi'*
7195 *'notermbidi'* *'notbidi'*
7196'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7197 global
7198 {not in Vi}
7199 {only available when compiled with the |+arabic|
7200 feature}
7201 The terminal is in charge of Bi-directionality of text (as specified
7202 by Unicode). The terminal is also expected to do the required shaping
7203 that some languages (such as Arabic) require.
7204 Setting this option implies that 'rightleft' will not be set when
7205 'arabic' is set and the value of 'arabicshape' will be ignored.
7206 Note that setting 'termbidi' has the immediate effect that
7207 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7208 This option is reset when the GUI is started.
7209 For further details see |arabic.txt|.
7210
7211 *'termencoding'* *'tenc'*
7212'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7213 Macintosh GUI: "macroman")
7214 global
7215 {only available when compiled with the |+multi_byte|
7216 feature}
7217 {not in Vi}
7218 Encoding used for the terminal. This specifies what character
7219 encoding the keyboard produces and the display will understand. For
Bram Moolenaar34700a62013-03-07 13:20:54 +01007220 the GUI it only applies to the keyboard ( 'encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007221 display). Except for the Mac when 'macatsui' is off, then
7222 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007223 In the Win32 console version the default value is the console codepage
7224 when it differs from the ANSI codepage.
7225 *E617*
7226 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7227 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7228 Any attempts to set a different value will be rejected, and an error
7229 message is shown.
7230 For the Win32 GUI 'termencoding' is not used for typed characters,
7231 because the Win32 system always passes Unicode characters.
7232 When empty, the same encoding is used as for the 'encoding' option.
7233 This is the normal value.
7234 Not all combinations for 'termencoding' and 'encoding' are valid. See
7235 |encoding-table|.
7236 The value for this option must be supported by internal conversions or
7237 iconv(). When this is not possible no conversion will be done and you
7238 will probably experience problems with non-ASCII characters.
7239 Example: You are working with the locale set to euc-jp (Japanese) and
7240 want to edit a UTF-8 file: >
7241 :let &termencoding = &encoding
7242 :set encoding=utf-8
7243< You need to do this when your system has no locale support for UTF-8.
7244
7245 *'terse'* *'noterse'*
7246'terse' boolean (default off)
7247 global
7248 When set: Add 's' flag to 'shortmess' option (this makes the message
7249 for a search that hits the start or end of the file not being
7250 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7251 shortens a lot of messages}
7252
7253 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7254'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7255 global
7256 {not in Vi}
7257 This option is obsolete. Use 'fileformats'.
7258 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7259 set to the default value for the current system. When 'textauto' is
7260 reset, 'fileformats' is made empty.
7261 NOTE: This option is set to the Vi default value when 'compatible' is
7262 set and to the Vim default value when 'compatible' is reset.
7263
7264 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7265'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7266 others: default off)
7267 local to buffer
7268 {not in Vi}
7269 This option is obsolete. Use 'fileformat'.
7270 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7271 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7272 "unix".
7273
7274 *'textwidth'* *'tw'*
7275'textwidth' 'tw' number (default 0)
7276 local to buffer
7277 {not in Vi}
7278 Maximum width of text that is being inserted. A longer line will be
7279 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007280 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7281 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007283 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 NOTE: This option is set to 0 when 'compatible' is set.
7285
7286 *'thesaurus'* *'tsr'*
7287'thesaurus' 'tsr' string (default "")
7288 global or local to buffer |global-local|
7289 {not in Vi}
7290 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007291 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 the file should contain words with similar meaning, separated by
7293 non-keyword characters (white space is preferred). Maximum line
7294 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007295 To obtain a file to be used here, check out this ftp site:
7296 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007297 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007298 after a comma are ignored, otherwise spaces are included in the file
7299 name. See |option-backslash| about using backslashes.
7300 The use of |:set+=| and |:set-=| is preferred when adding or removing
7301 directories from the list. This avoids problems when a future version
7302 uses another default.
7303 Backticks cannot be used in this option for security reasons.
7304
7305 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7306'tildeop' 'top' boolean (default off)
7307 global
7308 {not in Vi}
7309 When on: The tilde command "~" behaves like an operator.
7310 NOTE: This option is reset when 'compatible' is set.
7311
7312 *'timeout'* *'to'* *'notimeout'* *'noto'*
7313'timeout' 'to' boolean (default on)
7314 global
7315 *'ttimeout'* *'nottimeout'*
7316'ttimeout' boolean (default off)
7317 global
7318 {not in Vi}
7319 These two options together determine the behavior when part of a
7320 mapped key sequence or keyboard code has been received:
7321
7322 'timeout' 'ttimeout' action ~
7323 off off do not time out
7324 on on or off time out on :mappings and key codes
7325 off on time out on key codes
7326
7327 If both options are off, Vim will wait until either the complete
7328 mapping or key sequence has been received, or it is clear that there
7329 is no mapping or key sequence for the received characters. For
7330 example: if you have mapped "vl" and Vim has received 'v', the next
7331 character is needed to see if the 'v' is followed by an 'l'.
7332 When one of the options is on, Vim will wait for about 1 second for
7333 the next character to arrive. After that the already received
7334 characters are interpreted as single characters. The waiting time can
7335 be changed with the 'timeoutlen' option.
7336 On slow terminals or very busy systems timing out may cause
7337 malfunctioning cursor keys. If both options are off, Vim waits
7338 forever after an entered <Esc> if there are key codes that start
7339 with <Esc>. You will have to type <Esc> twice. If you do not have
7340 problems with key codes, but would like to have :mapped key
7341 sequences not timing out in 1 second, set the 'ttimeout' option and
7342 reset the 'timeout' option.
7343
7344 NOTE: 'ttimeout' is reset when 'compatible' is set.
7345
7346 *'timeoutlen'* *'tm'*
7347'timeoutlen' 'tm' number (default 1000)
7348 global
7349 {not in all versions of Vi}
7350 *'ttimeoutlen'* *'ttm'*
7351'ttimeoutlen' 'ttm' number (default -1)
7352 global
7353 {not in Vi}
7354 The time in milliseconds that is waited for a key code or mapped key
7355 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7356 when part of a command has been typed.
7357 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7358 different timeout value for key codes is desired set 'ttimeoutlen' to
7359 a non-negative number.
7360
7361 ttimeoutlen mapping delay key code delay ~
7362 < 0 'timeoutlen' 'timeoutlen'
7363 >= 0 'timeoutlen' 'ttimeoutlen'
7364
7365 The timeout only happens when the 'timeout' and 'ttimeout' options
7366 tell so. A useful setting would be >
7367 :set timeout timeoutlen=3000 ttimeoutlen=100
7368< (time out on mapping after three seconds, time out on key codes after
7369 a tenth of a second).
7370
7371 *'title'* *'notitle'*
7372'title' boolean (default off, on when title can be restored)
7373 global
7374 {not in Vi}
7375 {not available when compiled without the |+title|
7376 feature}
7377 When on, the title of the window will be set to the value of
7378 'titlestring' (if it is not empty), or to:
7379 filename [+=-] (path) - VIM
7380 Where:
7381 filename the name of the file being edited
7382 - indicates the file cannot be modified, 'ma' off
7383 + indicates the file was modified
7384 = indicates the file is read-only
7385 =+ indicates the file is read-only and modified
7386 (path) is the path of the file being edited
7387 - VIM the server name |v:servername| or "VIM"
7388 Only works if the terminal supports setting window titles
7389 (currently Amiga console, Win32 console, all GUI versions and
7390 terminals with a non- empty 't_ts' option - these are Unix xterm and
7391 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7392 *X11*
7393 When Vim was compiled with HAVE_X11 defined, the original title will
7394 be restored if possible. The output of ":version" will include "+X11"
7395 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7396 works for the icon name |'icon'|.
7397 But: When Vim was started with the |-X| argument, restoring the title
7398 will not work (except in the GUI).
7399 If the title cannot be restored, it is set to the value of 'titleold'.
7400 You might want to restore the title outside of Vim then.
7401 When using an xterm from a remote machine you can use this command:
7402 rsh machine_name xterm -display $DISPLAY &
7403 then the WINDOWID environment variable should be inherited and the
7404 title of the window should change back to what it should be after
7405 exiting Vim.
7406
7407 *'titlelen'*
7408'titlelen' number (default 85)
7409 global
7410 {not in Vi}
7411 {not available when compiled without the |+title|
7412 feature}
7413 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007414 title. When the title is longer, only the end of the path name is
7415 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 Using a percentage makes this adapt to the width of the window. But
7417 it won't work perfectly, because the actual number of characters
7418 available also depends on the font used and other things in the title
7419 bar. When 'titlelen' is zero the full path is used. Otherwise,
7420 values from 1 to 30000 percent can be used.
7421 'titlelen' is also used for the 'titlestring' option.
7422
7423 *'titleold'*
7424'titleold' string (default "Thanks for flying Vim")
7425 global
7426 {not in Vi}
7427 {only available when compiled with the |+title|
7428 feature}
7429 This option will be used for the window title when exiting Vim if the
7430 original title cannot be restored. Only happens if 'title' is on or
7431 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007432 This option cannot be set from a |modeline| or in the |sandbox|, for
7433 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434 *'titlestring'*
7435'titlestring' string (default "")
7436 global
7437 {not in Vi}
7438 {not available when compiled without the |+title|
7439 feature}
7440 When this option is not empty, it will be used for the title of the
7441 window. This happens only when the 'title' option is on.
7442 Only works if the terminal supports setting window titles (currently
7443 Amiga console, Win32 console, all GUI versions and terminals with a
7444 non-empty 't_ts' option).
7445 When Vim was compiled with HAVE_X11 defined, the original title will
7446 be restored if possible |X11|.
7447 When this option contains printf-style '%' items, they will be
7448 expanded according to the rules used for 'statusline'.
7449 Example: >
7450 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7451 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7452< The value of 'titlelen' is used to align items in the middle or right
7453 of the available space.
7454 Some people prefer to have the file name first: >
7455 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7456< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007457 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 separating space only when needed.
7459 NOTE: Use of special characters in 'titlestring' may cause the display
7460 to be garbled (e.g., when it contains a CR or NL character).
7461 {not available when compiled without the |+statusline| feature}
7462
7463 *'toolbar'* *'tb'*
7464'toolbar' 'tb' string (default "icons,tooltips")
7465 global
7466 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7467 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007468 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469 possible values are:
7470 icons Toolbar buttons are shown with icons.
7471 text Toolbar buttons shown with text.
7472 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007473 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474 tooltips Tooltips are active for toolbar buttons.
7475 Tooltips refer to the popup help text which appears after the mouse
7476 cursor is placed over a toolbar button for a brief moment.
7477
7478 If you want the toolbar to be shown with icons as well as text, do the
7479 following: >
7480 :set tb=icons,text
7481< Motif and Athena cannot display icons and text at the same time. They
7482 will show icons if both are requested.
7483
7484 If none of the strings specified in 'toolbar' are valid or if
7485 'toolbar' is empty, this option is ignored. If you want to disable
7486 the toolbar, you need to set the 'guioptions' option. For example: >
7487 :set guioptions-=T
7488< Also see |gui-toolbar|.
7489
7490 *'toolbariconsize'* *'tbis'*
7491'toolbariconsize' 'tbis' string (default "small")
7492 global
7493 {not in Vi}
7494 {only in the GTK+ 2 GUI}
7495 Controls the size of toolbar icons. The possible values are:
7496 tiny Use tiny toolbar icons.
7497 small Use small toolbar icons (default).
7498 medium Use medium-sized toolbar icons.
7499 large Use large toolbar icons.
7500 The exact dimensions in pixels of the various icon sizes depend on
7501 the current theme. Common dimensions are large=32x32, medium=24x24,
7502 small=20x20 and tiny=16x16.
7503
7504 If 'toolbariconsize' is empty, the global default size as determined
7505 by user preferences or the current theme is used.
7506
7507 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7508'ttybuiltin' 'tbi' boolean (default on)
7509 global
7510 {not in Vi}
7511 When on, the builtin termcaps are searched before the external ones.
7512 When off the builtin termcaps are searched after the external ones.
7513 When this option is changed, you should set the 'term' option next for
7514 the change to take effect, for example: >
7515 :set notbi term=$TERM
7516< See also |termcap|.
7517 Rationale: The default for this option is "on", because the builtin
7518 termcap entries are generally better (many systems contain faulty
7519 xterm entries...).
7520
7521 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7522'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7523 sun-cmd, screen, rxvt, dtterm or
7524 iris-ansi; also on when running Vim in
7525 a DOS console)
7526 global
7527 {not in Vi}
7528 Indicates a fast terminal connection. More characters will be sent to
7529 the screen for redrawing, instead of using insert/delete line
7530 commands. Improves smoothness of redrawing when there are multiple
7531 windows and the terminal does not support a scrolling region.
7532 Also enables the extra writing of characters at the end of each screen
7533 line for lines that wrap. This helps when using copy/paste with the
7534 mouse in an xterm and other terminals.
7535
7536 *'ttymouse'* *'ttym'*
7537'ttymouse' 'ttym' string (default depends on 'term')
7538 global
7539 {not in Vi}
7540 {only in Unix and VMS, doesn't work in the GUI; not
7541 available when compiled without |+mouse|}
7542 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007543 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 *xterm-mouse*
7545 xterm xterm-like mouse handling. The mouse generates
7546 "<Esc>[Mscr", where "scr" is three bytes:
7547 "s" = button state
7548 "c" = column plus 33
7549 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02007550 This only works up to 223 columns! See "dec",
7551 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 xterm2 Works like "xterm", but with the xterm reporting the
7553 mouse position while the mouse is dragged. This works
7554 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007555 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556 work. See below for how Vim detects this
7557 automatically.
7558 *netterm-mouse*
7559 netterm NetTerm mouse handling. The mouse generates
7560 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7561 for the row and column.
7562 *dec-mouse*
7563 dec DEC terminal mouse handling. The mouse generates a
7564 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007565 This is also available for an Xterm, if it was
7566 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567 *jsbterm-mouse*
7568 jsbterm JSB term mouse handling.
7569 *pterm-mouse*
7570 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007571 *urxvt-mouse*
7572 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02007573 The mouse works only if the terminal supports this
7574 encoding style, but it does not have 223 columns limit
7575 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02007576 *sgr-mouse*
7577 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02007578 mouse reporting. The mouse works even in columns
7579 beyond 223. This option is backward compatible with
7580 "xterm2" because it can also decode "xterm2" style
7581 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582
7583 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02007584 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
7585 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7587 recognized, if enabled at compile time. DEC terminal mouse codes
7588 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02007589 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
7590 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaare968e362014-05-13 20:23:24 +02007592 set to a name that starts with "xterm", "mlterm", or "screen", and
7593 'ttymouse' is not set already.
7594 Additionally, if vim is compiled with the |+termresponse| feature and
7595 |t_RV| is set to the escape sequence to request the xterm version
7596 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02007598 from 95 to 276. The "sgr" value will be set if the xterm version is
7599 277 or highter.
7600 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
7601 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602 :set t_RV=
7603<
7604 *'ttyscroll'* *'tsl'*
7605'ttyscroll' 'tsl' number (default 999)
7606 global
7607 Maximum number of lines to scroll the screen. If there are more lines
7608 to scroll the window is redrawn. For terminals where scrolling is
7609 very slow and redrawing is not slow this can be set to a small number,
7610 e.g., 3, to speed up displaying.
7611
7612 *'ttytype'* *'tty'*
7613'ttytype' 'tty' string (default from $TERM)
7614 global
7615 Alias for 'term', see above.
7616
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007617 *'undodir'* *'udir'*
7618'undodir' 'udir' string (default ".")
7619 global
7620 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007621 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007622 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007623 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007624 "." means using the directory of the file. The undo file name for
7625 "file.txt" is ".file.txt.un~".
7626 For other directories the file name is the full path of the edited
7627 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007628 When writing: The first directory that exists is used. "." always
7629 works, no directories after "." will be used for writing.
7630 When reading all entries are tried to find an undo file. The first
7631 undo file that exists is used. When it cannot be read an error is
7632 given, no further entry is used.
7633 See |undo-persistence|.
7634
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02007635 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007636'undofile' 'udf' boolean (default off)
7637 local to buffer
7638 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007639 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007640 When on, Vim automatically saves undo history to an undo file when
7641 writing a buffer to a file, and restores undo history from the same
7642 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007643 The directory where the undo file is stored is specified by 'undodir'.
7644 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007645 The undo file is not read when 'undoreload' causes the buffer from
7646 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007647 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007648
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 *'undolevels'* *'ul'*
7650'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7651 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007652 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007653 {not in Vi}
7654 Maximum number of changes that can be undone. Since undo information
7655 is kept in memory, higher numbers will cause more memory to be used
7656 (nevertheless, a single change can use an unlimited amount of memory).
7657 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7658 itself: >
7659 set ul=0
7660< But you can also get Vi compatibility by including the 'u' flag in
7661 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007662 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007663 Set to -1 for no undo at all. You might want to do this only for the
7664 current buffer: >
7665 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00007666< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007667 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007669 *'undoreload'* *'ur'*
7670'undoreload' 'ur' number (default 10000)
7671 global
7672 {not in Vi}
7673 Save the whole buffer for undo when reloading it. This applies to the
7674 ":e!" command and reloading for when the buffer changed outside of
7675 Vim. |FileChangedShell|
7676 The save only happens when this options is negative or when the number
7677 of lines is smaller than the value of this option.
7678 Set this option to zero to disable undo for a reload.
7679
7680 When saving undo for a reload, any undo file is not read.
7681
7682 Note that this causes the whole buffer to be stored in memory. Set
7683 this option to a lower value if you run out of memory.
7684
Bram Moolenaar071d4272004-06-13 20:20:40 +00007685 *'updatecount'* *'uc'*
7686'updatecount' 'uc' number (default: 200)
7687 global
7688 {not in Vi}
7689 After typing this many characters the swap file will be written to
7690 disk. When zero, no swap file will be created at all (see chapter on
7691 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7692 Vim with the "-n" option, see |startup|. When editing in readonly
7693 mode this option will be initialized to 10000.
7694 The swapfile can be disabled per buffer with |'swapfile'|.
7695 When 'updatecount' is set from zero to non-zero, swap files are
7696 created for all buffers that have 'swapfile' set. When 'updatecount'
7697 is set to zero, existing swap files are not deleted.
7698 Also see |'swapsync'|.
7699 This option has no meaning in buffers where |'buftype'| is "nofile"
7700 or "nowrite".
7701
7702 *'updatetime'* *'ut'*
7703'updatetime' 'ut' number (default 4000)
7704 global
7705 {not in Vi}
7706 If this many milliseconds nothing is typed the swap file will be
7707 written to disk (see |crash-recovery|). Also used for the
7708 |CursorHold| autocommand event.
7709
7710 *'verbose'* *'vbs'*
7711'verbose' 'vbs' number (default 0)
7712 global
7713 {not in Vi, although some versions have a boolean
7714 verbose option}
7715 When bigger than zero, Vim will give messages about what it is doing.
7716 Currently, these messages are given:
7717 >= 1 When the viminfo file is read or written.
7718 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007719 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007720 >= 8 Files for which a group of autocommands is executed.
7721 >= 9 Every executed autocommand.
7722 >= 12 Every executed function.
7723 >= 13 When an exception is thrown, caught, finished, or discarded.
7724 >= 14 Anything pending in a ":finally" clause.
7725 >= 15 Every executed Ex command (truncated at 200 characters).
7726
7727 This option can also be set with the "-V" argument. See |-V|.
7728 This option is also set by the |:verbose| command.
7729
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007730 When the 'verbosefile' option is set then the verbose messages are not
7731 displayed.
7732
7733 *'verbosefile'* *'vfile'*
7734'verbosefile' 'vfile' string (default empty)
7735 global
7736 {not in Vi}
7737 When not empty all messages are written in a file with this name.
7738 When the file exists messages are appended.
7739 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007740 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007741 Setting 'verbosefile' to a new value is like making it empty first.
7742 The difference with |:redir| is that verbose messages are not
7743 displayed when 'verbosefile' is set.
7744
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 *'viewdir'* *'vdir'*
7746'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7747 "$VIM/vimfiles/view",
7748 for Unix: "~/.vim/view",
7749 for Macintosh: "$VIM:vimfiles:view"
7750 for VMS: "sys$login:vimfiles/view"
7751 for RiscOS: "Choices:vimfiles/view")
7752 global
7753 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007754 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 feature}
7756 Name of the directory where to store files for |:mkview|.
7757 This option cannot be set from a |modeline| or in the |sandbox|, for
7758 security reasons.
7759
7760 *'viewoptions'* *'vop'*
7761'viewoptions' 'vop' string (default: "folds,options,cursor")
7762 global
7763 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007764 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765 feature}
7766 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007767 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768 word save and restore ~
7769 cursor cursor position in file and in window
7770 folds manually created folds, opened/closed folds and local
7771 fold options
7772 options options and mappings local to a window or buffer (not
7773 global values for local options)
7774 slash backslashes in file names replaced with forward
7775 slashes
7776 unix with Unix end-of-line format (single <NL>), even when
7777 on Windows or DOS
7778
7779 "slash" and "unix" are useful on Windows when sharing view files
7780 with Unix. The Unix version of Vim cannot source dos format scripts,
7781 but the Windows version of Vim can source unix format scripts.
7782
7783 *'viminfo'* *'vi'* *E526* *E527* *E528*
7784'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007785 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7786 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7787 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788 global
7789 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007790 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007791 feature}
7792 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007793 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007794 separated list of parameters, each consisting of a single character
7795 identifying the particular parameter, followed by a number or string
7796 which specifies the value of that parameter. If a particular
7797 character is left out, then the default value is used for that
7798 parameter. The following is a list of the identifying characters and
7799 the effect of their value.
7800 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007801 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007802 ! When included, save and restore global variables that start
7803 with an uppercase letter, and don't contain a lowercase
7804 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007805 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007806 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007807 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007808 " Maximum number of lines saved for each register. Old name of
7809 the '<' item, with the disadvantage that you need to put a
7810 backslash before the ", otherwise it will be recognized as the
7811 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007812 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007813 % When included, save and restore the buffer list. If Vim is
7814 started with a file name argument, the buffer list is not
7815 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007816 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817 without a file name and buffers for help files are not written
7818 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007819 When followed by a number, the number specifies the maximum
7820 number of buffers that are stored. Without a number all
7821 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007822 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 ' Maximum number of previously edited files for which the marks
7824 are remembered. This parameter must always be included when
7825 'viminfo' is non-empty.
7826 Including this item also means that the |jumplist| and the
7827 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007828 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007830 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007831 patterns are also saved. When not included, the value of
7832 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007833 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007835 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007836 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837 < Maximum number of lines saved for each register. If zero then
7838 registers are not saved. When not included, all lines are
7839 saved. '"' is the old name for this item.
7840 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007841 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007842 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007843 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007844 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 c When included, convert the text in the viminfo file from the
7846 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007847 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007848 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849 f Whether file marks need to be stored. If zero, file marks ('0
7850 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007851 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007852 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007853 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 h Disable the effect of 'hlsearch' when loading the viminfo
7855 file. When not included, it depends on whether ":nohlsearch"
7856 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007857 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007858 n Name of the viminfo file. The name must immediately follow
7859 the 'n'. Must be the last one! If the "-i" argument was
7860 given when starting Vim, that file name overrides the one
7861 given here with 'viminfo'. Environment variables are expanded
7862 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007863 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 r Removable media. The argument is a string (up to the next
7865 ','). This parameter can be given several times. Each
7866 specifies the start of a path for which no marks will be
7867 stored. This is to avoid removable media. For MS-DOS you
7868 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7869 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7870 ignored. Maximum length of each 'r' argument is 50
7871 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007872 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873 s Maximum size of an item in Kbyte. If zero then registers are
7874 not saved. Currently only applies to registers. The default
7875 "s10" will exclude registers with more than 10 Kbyte of text.
7876 Also see the '<' item above: line count limit.
7877
7878 Example: >
7879 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7880<
7881 '50 Marks will be remembered for the last 50 files you
7882 edited.
7883 <1000 Contents of registers (up to 1000 lines each) will be
7884 remembered.
7885 s100 Registers with more than 100 Kbyte text are skipped.
7886 :0 Command-line history will not be saved.
7887 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7888 no / Since '/' is not specified, the default will be used,
7889 that is, save all of the search history, and also the
7890 previous search and substitute patterns.
7891 no % The buffer list will not be saved nor read back.
7892 no h 'hlsearch' highlighting will be restored.
7893
7894 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7895 load the contents of the file, this is not done automatically.
7896
7897 This option cannot be set from a |modeline| or in the |sandbox|, for
7898 security reasons.
7899
7900 *'virtualedit'* *'ve'*
7901'virtualedit' 've' string (default "")
7902 global
7903 {not in Vi}
7904 {not available when compiled without the
7905 |+virtualedit| feature}
7906 A comma separated list of these words:
7907 block Allow virtual editing in Visual block mode.
7908 insert Allow virtual editing in Insert mode.
7909 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007910 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007911
Bram Moolenaar071d4272004-06-13 20:20:40 +00007912 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007913 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 of the line. Useful for selecting a rectangle in Visual mode and
7915 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007916 "onemore" is not the same, it will only allow moving the cursor just
7917 after the last character of the line. This makes some commands more
7918 consistent. Previously the cursor was always past the end of the line
7919 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007920 break some plugins or Vim scripts. For example because |l| can move
7921 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02007922 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007923 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02007924 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007925 It doesn't make sense to combine "all" with "onemore", but you will
7926 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007927
7928 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7929'visualbell' 'vb' boolean (default off)
7930 global
7931 {not in Vi}
7932 Use visual bell instead of beeping. The terminal code to display the
7933 visual bell is given with 't_vb'. When no beep or flash is wanted,
7934 use ":set vb t_vb=".
7935 Note: When the GUI starts, 't_vb' is reset to its default value. You
7936 might want to set it again in your |gvimrc|.
7937 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7938 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7939 where 40 is the time in msec.
7940 Does not work on the Amiga, you always get a screen flash.
7941 Also see 'errorbells'.
7942
7943 *'warn'* *'nowarn'*
7944'warn' boolean (default on)
7945 global
7946 Give a warning message when a shell command is used while the buffer
7947 has been changed.
7948
7949 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7950'weirdinvert' 'wiv' boolean (default off)
7951 global
7952 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007953 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 It is provided for backwards compatibility with version 4.x.
7955 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7956 vice versa. Has no effect when the GUI is running.
7957
7958 *'whichwrap'* *'ww'*
7959'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7960 global
7961 {not in Vi}
7962 Allow specified keys that move the cursor left/right to move to the
7963 previous/next line when the cursor is on the first/last character in
7964 the line. Concatenate characters to allow this for these keys:
7965 char key mode ~
7966 b <BS> Normal and Visual
7967 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007968 h "h" Normal and Visual (not recommended)
7969 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007970 < <Left> Normal and Visual
7971 > <Right> Normal and Visual
7972 ~ "~" Normal
7973 [ <Left> Insert and Replace
7974 ] <Right> Insert and Replace
7975 For example: >
7976 :set ww=<,>,[,]
7977< allows wrap only when cursor keys are used.
7978 When the movement keys are used in combination with a delete or change
7979 operator, the <EOL> also counts for a character. This makes "3h"
7980 different from "3dh" when the cursor crosses the end of a line. This
7981 is also true for "x" and "X", because they do the same as "dl" and
7982 "dh". If you use this, you may also want to use the mapping
7983 ":map <BS> X" to make backspace delete the character in front of the
7984 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007985 When 'l' is included and it is used after an operator at the end of a
7986 line then it will not move to the next line. This makes "dl", "cl",
7987 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 NOTE: This option is set to the Vi default value when 'compatible' is
7989 set and to the Vim default value when 'compatible' is reset.
7990
7991 *'wildchar'* *'wc'*
7992'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7993 global
7994 {not in Vi}
7995 Character you have to type to start wildcard expansion in the
7996 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007997 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007998 The character is not recognized when used inside a macro. See
7999 'wildcharm' for that.
8000 Although 'wc' is a number option, you can set it to a special key: >
8001 :set wc=<Esc>
8002< NOTE: This option is set to the Vi default value when 'compatible' is
8003 set and to the Vim default value when 'compatible' is reset.
8004
8005 *'wildcharm'* *'wcm'*
8006'wildcharm' 'wcm' number (default: none (0))
8007 global
8008 {not in Vi}
8009 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008010 recognized when used inside a macro. You can find "spare" command-line
8011 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008012 you'll never actually type 'wildcharm', just use it in mappings that
8013 automatically invoke completion mode, e.g.: >
8014 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008015 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008016< Then after typing :ss you can use CTRL-P & CTRL-N.
8017
8018 *'wildignore'* *'wig'*
8019'wildignore' 'wig' string (default "")
8020 global
8021 {not in Vi}
8022 {not available when compiled without the |+wildignore|
8023 feature}
8024 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008025 patterns is ignored when expanding |wildcards|, completing file or
8026 directory names, and influences the result of |expand()|, |glob()| and
8027 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8029 Also see 'suffixes'.
8030 Example: >
8031 :set wildignore=*.o,*.obj
8032< The use of |:set+=| and |:set-=| is preferred when adding or removing
8033 a pattern from the list. This avoids problems when a future version
8034 uses another default.
8035
Bram Moolenaar94950a92010-12-02 16:01:29 +01008036
Bram Moolenaar81af9252010-12-10 20:35:50 +01008037 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008038'wildignorecase' 'wic' boolean (default off)
8039 global
8040 {not in Vi}
8041 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008042 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008043 Does not apply when the shell is used to expand wildcards, which
8044 happens when there are special characters.
8045
8046
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
8048'wildmenu' 'wmnu' boolean (default off)
8049 global
8050 {not in Vi}
8051 {not available if compiled without the |+wildmenu|
8052 feature}
8053 When 'wildmenu' is on, command-line completion operates in an enhanced
8054 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8055 the possible matches are shown just above the command line, with the
8056 first match highlighted (overwriting the status line, if there is
8057 one). Keys that show the previous/next match, such as <Tab> or
8058 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8059 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8060 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008061 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 If there are more matches than can fit in the line, a ">" is shown on
8063 the right and/or a "<" is shown on the left. The status line scrolls
8064 as needed.
8065 The "wildmenu" mode is abandoned when a key is hit that is not used
8066 for selecting a completion.
8067 While the "wildmenu" is active the following keys have special
8068 meanings:
8069
8070 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8071 <Down> - in filename/menu name completion: move into a
8072 subdirectory or submenu.
8073 <CR> - in menu completion, when the cursor is just after a
8074 dot: move into a submenu.
8075 <Up> - in filename/menu name completion: move up into
8076 parent directory or parent menu.
8077
8078 This makes the menus accessible from the console |console-menus|.
8079
8080 If you prefer the <Left> and <Right> keys to move the cursor instead
8081 of selecting a different match, use this: >
8082 :cnoremap <Left> <Space><BS><Left>
8083 :cnoremap <Right> <Space><BS><Right>
8084<
8085 The "WildMenu" highlighting is used for displaying the current match
8086 |hl-WildMenu|.
8087
8088 *'wildmode'* *'wim'*
8089'wildmode' 'wim' string (Vim default: "full")
8090 global
8091 {not in Vi}
8092 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008093 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008094 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008095 first part specifies the behavior for the first use of 'wildchar',
8096 The second part for the second use, etc.
8097 These are the possible values for each part:
8098 "" Complete only the first match.
8099 "full" Complete the next full match. After the last match,
8100 the original string is used and then the first match
8101 again.
8102 "longest" Complete till longest common string. If this doesn't
8103 result in a longer string, use the next part.
8104 "longest:full" Like "longest", but also start 'wildmenu' if it is
8105 enabled.
8106 "list" When more than one match, list all matches.
8107 "list:full" When more than one match, list all matches and
8108 complete first match.
8109 "list:longest" When more than one match, list all matches and
8110 complete till longest common string.
8111 When there is only a single match, it is fully completed in all cases.
8112
8113 Examples: >
8114 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008115< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008116 :set wildmode=longest,full
8117< Complete longest common string, then each full match >
8118 :set wildmode=list:full
8119< List all matches and complete each full match >
8120 :set wildmode=list,full
8121< List all matches without completing, then each full match >
8122 :set wildmode=longest,list
8123< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008124 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008125
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008126 *'wildoptions'* *'wop'*
8127'wildoptions' 'wop' string (default "")
8128 global
8129 {not in Vi}
8130 {not available when compiled without the |+wildignore|
8131 feature}
8132 A list of words that change how command line completion is done.
8133 Currently only one word is allowed:
8134 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008135 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008136 is displayed per line. Often used tag kinds are:
8137 d #define
8138 f function
8139 Also see |cmdline-completion|.
8140
Bram Moolenaar071d4272004-06-13 20:20:40 +00008141 *'winaltkeys'* *'wak'*
8142'winaltkeys' 'wak' string (default "menu")
8143 global
8144 {not in Vi}
8145 {only used in Win32, Motif, GTK and Photon GUI}
8146 Some GUI versions allow the access to menu entries by using the ALT
8147 key in combination with a character that appears underlined in the
8148 menu. This conflicts with the use of the ALT key for mappings and
8149 entering special characters. This option tells what to do:
8150 no Don't use ALT keys for menus. ALT key combinations can be
8151 mapped, but there is no automatic handling. This can then be
8152 done with the |:simalt| command.
8153 yes ALT key handling is done by the windowing system. ALT key
8154 combinations cannot be mapped.
8155 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008156 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008157 keys can be mapped.
8158 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8159 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008160 This option is not used for <F10>; on Win32 and with GTK <F10> will
8161 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008162
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008163 *'window'* *'wi'*
8164'window' 'wi' number (default screen height - 1)
8165 global
8166 Window height. Do not confuse this with the height of the Vim window,
8167 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008168 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8169 value is smaller than 'lines' minus one. The screen will scroll
8170 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008171 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8172 in a much smarter way, taking care of wrapping lines.
8173 When resizing the Vim window, the value is smaller than 1 or more than
8174 or equal to 'lines' it will be set to 'lines' minus 1.
8175 {Vi also uses the option to specify the number of displayed lines}
8176
Bram Moolenaar071d4272004-06-13 20:20:40 +00008177 *'winheight'* *'wh'* *E591*
8178'winheight' 'wh' number (default 1)
8179 global
8180 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008181 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008182 feature}
8183 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008184 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008185 focus goes to a window that is smaller, its size is increased, at the
8186 cost of the height of other windows.
8187 Set 'winheight' to a small number for normal editing.
8188 Set it to 999 to make the current window fill most of the screen.
8189 Other windows will be only 'winminheight' high. This has the drawback
8190 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8191 to create only two windows, set the option after startup is done,
8192 using the |VimEnter| event: >
8193 au VimEnter * set winheight=999
8194< Minimum value is 1.
8195 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196 height of the current window.
8197 'winheight' applies to the current window. Use 'winminheight' to set
8198 the minimal height for other windows.
8199
8200 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8201'winfixheight' 'wfh' boolean (default off)
8202 local to window
8203 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008204 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008205 feature}
8206 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008207 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8208 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008209 The height may be changed anyway when running out of room.
8210
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008211 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8212'winfixwidth' 'wfw' boolean (default off)
8213 local to window
8214 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008215 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008216 feature}
8217 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008218 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008219 The width may be changed anyway when running out of room.
8220
Bram Moolenaar071d4272004-06-13 20:20:40 +00008221 *'winminheight'* *'wmh'*
8222'winminheight' 'wmh' number (default 1)
8223 global
8224 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008225 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008226 feature}
8227 The minimal height of a window, when it's not the current window.
8228 This is a hard minimum, windows will never become smaller.
8229 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8230 status bar) if necessary. They will return to at least one line when
8231 they become active (since the cursor has to have somewhere to go.)
8232 Use 'winheight' to set the minimal height of the current window.
8233 This option is only checked when making a window smaller. Don't use a
8234 large number, it will cause errors when opening more than a few
8235 windows. A value of 0 to 3 is reasonable.
8236
8237 *'winminwidth'* *'wmw'*
8238'winminwidth' 'wmw' number (default 1)
8239 global
8240 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008241 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008242 feature}
8243 The minimal width of a window, when it's not the current window.
8244 This is a hard minimum, windows will never become smaller.
8245 When set to zero, windows may be "squashed" to zero columns (i.e. just
8246 a vertical separator) if necessary. They will return to at least one
8247 line when they become active (since the cursor has to have somewhere
8248 to go.)
8249 Use 'winwidth' to set the minimal width of the current window.
8250 This option is only checked when making a window smaller. Don't use a
8251 large number, it will cause errors when opening more than a few
8252 windows. A value of 0 to 12 is reasonable.
8253
8254 *'winwidth'* *'wiw'* *E592*
8255'winwidth' 'wiw' number (default 20)
8256 global
8257 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008258 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008259 feature}
8260 Minimal number of columns for the current window. This is not a hard
8261 minimum, Vim will use fewer columns if there is not enough room. If
8262 the current window is smaller, its size is increased, at the cost of
8263 the width of other windows. Set it to 999 to make the current window
8264 always fill the screen. Set it to a small number for normal editing.
8265 The width is not adjusted after one of the commands to change the
8266 width of the current window.
8267 'winwidth' applies to the current window. Use 'winminwidth' to set
8268 the minimal width for other windows.
8269
8270 *'wrap'* *'nowrap'*
8271'wrap' boolean (default on)
8272 local to window
8273 {not in Vi}
8274 This option changes how text is displayed. It doesn't change the text
8275 in the buffer, see 'textwidth' for that.
8276 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008277 displaying continues on the next line. When off lines will not wrap
8278 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008279 moved to a part that is not shown, the screen will scroll
8280 horizontally.
8281 The line will be broken in the middle of a word if necessary. See
8282 'linebreak' to get the break at a word boundary.
8283 To make scrolling horizontally a bit more useful, try this: >
8284 :set sidescroll=5
8285 :set listchars+=precedes:<,extends:>
8286< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008287 This option can't be set from a |modeline| when the 'diff' option is
8288 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008289
8290 *'wrapmargin'* *'wm'*
8291'wrapmargin' 'wm' number (default 0)
8292 local to buffer
8293 Number of characters from the right window border where wrapping
8294 starts. When typing text beyond this limit, an <EOL> will be inserted
8295 and inserting continues on the next line.
8296 Options that add a margin, such as 'number' and 'foldcolumn', cause
8297 the text width to be further reduced. This is Vi compatible.
8298 When 'textwidth' is non-zero, this option is not used.
8299 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8300 and less usefully}
8301
8302 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8303'wrapscan' 'ws' boolean (default on) *E384* *E385*
8304 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008305 Searches wrap around the end of the file. Also applies to |]s| and
8306 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307
8308 *'write'* *'nowrite'*
8309'write' boolean (default on)
8310 global
8311 {not in Vi}
8312 Allows writing files. When not set, writing a file is not allowed.
8313 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008314 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008315 argument. Filtering text is still possible, even though this requires
8316 writing a temporary file.
8317
8318 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8319'writeany' 'wa' boolean (default off)
8320 global
8321 Allows writing to any file with no need for "!" override.
8322
8323 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8324'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8325 otherwise)
8326 global
8327 {not in Vi}
8328 Make a backup before overwriting a file. The backup is removed after
8329 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008330 also on.
8331 WARNING: Switching this option off means that when Vim fails to write
8332 your buffer correctly and then, for whatever reason, Vim exits, you
8333 lose both the original file and what you were writing. Only reset
8334 this option if your file system is almost full and it makes the write
8335 fail (and make sure not to exit Vim until the write was successful).
8336 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337 When the 'backupskip' pattern matches, a backup is not made anyway.
8338 NOTE: This option is set to the default value when 'compatible' is
8339 set.
8340
8341 *'writedelay'* *'wd'*
8342'writedelay' 'wd' number (default 0)
8343 global
8344 {not in Vi}
8345 The number of microseconds to wait for each character sent to the
8346 screen. When non-zero, characters are sent to the terminal one by
8347 one. For MS-DOS pcterm this does not work. For debugging purposes.
8348
8349 vim:tw=78:ts=8:ft=help:norl: