blob: 3072793b72da9ab0fd1fa7738b1c63bc0d7c4964 [file] [log] [blame]
Bram Moolenaarc572da52017-08-27 16:52:01 +02001*options.txt* For Vim version 8.0. Last change: 2017 Aug 27
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
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
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
Bram Moolenaar88774fd2015-08-25 19:52:04 +020053:se[t] all& Set all options to their default value. The values of
54 these options are not changed:
55 all terminal options, starting with t_
56 'columns'
57 'cryptmethod'
58 'encoding'
59 'key'
60 'lines'
61 'term'
62 'ttymouse'
63 'ttytype'
64 Warning: This may have a lot of side effects.
65 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +000066
67 *:set-args* *E487* *E521*
68:se[t] {option}={value} or
69:se[t] {option}:{value}
70 Set string or number option to {value}.
71 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010072 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000073 The old value can be inserted by typing 'wildchar' (by
74 default this is a <Tab> or CTRL-E if 'compatible' is
75 set). See |cmdline-completion|.
76 White space between {option} and '=' is allowed and
77 will be ignored. White space between '=' and {value}
78 is not allowed.
79 See |option-backslash| for using white space and
80 backslashes in {value}.
81
82:se[t] {option}+={value} *:set+=*
83 Add the {value} to a number option, or append the
84 {value} to a string option. When the option is a
85 comma separated list, a comma is added, unless the
86 value was empty.
87 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000088 are removed. When adding a flag that was already
89 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000090 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 {not in Vi}
92
93:se[t] {option}^={value} *:set^=*
94 Multiply the {value} to a number option, or prepend
95 the {value} to a string option. When the option is a
96 comma separated list, a comma is added, unless the
97 value was empty.
98 Also see |:set-args| above.
99 {not in Vi}
100
101:se[t] {option}-={value} *:set-=*
102 Subtract the {value} from a number option, or remove
103 the {value} from a string option, if it is there.
104 If the {value} is not found in a string option, there
105 is no error or warning. When the option is a comma
106 separated list, a comma is deleted, unless the option
107 becomes empty.
108 When the option is a list of flags, {value} must be
109 exactly as they appear in the option. Remove flags
110 one by one to avoid problems.
111 Also see |:set-args| above.
112 {not in Vi}
113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123< shiftwidth=4 ~
124 Last set from modeline ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
135 Last set from modeline ~
136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000198Similarly, the double quote character starts a comment. To include the '"' in
199the option value, use '\"' instead. This example sets the 'titlestring'
200option to 'hi "there"': >
201 :set titlestring=hi\ \"there\"
202
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000203For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204precise: For options that expect a file name (those where environment
205variables are expanded) a backslash before a normal file name character is not
206removed. But a backslash before a special character (space, backslash, comma,
207etc.) is used like explained above.
208There is one special situation, when the value starts with "\\": >
209 :set dir=\\machine\path results in "\\machine\path"
210 :set dir=\\\\machine\\path results in "\\machine\path"
211 :set dir=\\path\\file results in "\\path\file" (wrong!)
212For the first one the start is kept, but for the second one the backslashes
213are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000214halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215result which is probably not what you want. Avoid it.
216
217 *add-option-flags* *remove-option-flags*
218 *E539* *E550* *E551* *E552*
219Some options are a list of flags. When you want to add a flag to such an
220option, without changing the existing ones, you can do it like this: >
221 :set guioptions+=a
222Remove a flag from an option like this: >
223 :set guioptions-=a
224This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
227doesn't appear.
228
229 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000230Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231environment variable exists the '$' and the following environment variable
232name is replaced with its value. If it does not exist the '$' and the name
233are not modified. Any non-id character (not a letter, digit or '_') may
234follow the environment variable name. That character and what follows is
235appended to the value of the environment variable. Examples: >
236 :set term=$TERM.new
237 :set path=/usr/$INCLUDE,$HOME/include,.
238When adding or removing a string from an option with ":set opt-=val" or ":set
239opt+=val" the expansion is done before the adding or removing.
240
241
242Handling of local options *local-options*
243
244Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100245has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246allows you to set 'list' in one window but not in another. And set
247'shiftwidth' to 3 in one buffer and 4 in another.
248
249The following explains what happens to these local options in specific
250situations. You don't really need to know all of this, since Vim mostly uses
251the option values you would expect. Unfortunately, doing what the user
252expects is a bit complicated...
253
254When splitting a window, the local options are copied to the new window. Thus
255right after the split the contents of the two windows look the same.
256
257When editing a new buffer, its local option values must be initialized. Since
258the local options of the current buffer might be specifically for that buffer,
259these are not used. Instead, for each buffer-local option there also is a
260global value, which is used for new buffers. With ":set" both the local and
261global value is changed. With "setlocal" only the local value is changed,
262thus this value is not used when editing a new buffer.
263
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200264When editing a buffer that has been edited before, the options from the window
265that was last closed are used again. If this buffer has been edited in this
266window, the values from back then are used. Otherwise the values from the
267last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
294:setl[ocal] ... Like ":set" but set only the value local to the
295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
308 {not in Vi}
309
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000310:setl[ocal] {option}< Set the local value of {option} to its global value by
311 copying the value.
312 {not in Vi}
313
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100314:se[t] {option}< For |global-local| options: Remove the local value of
315 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 {not in Vi}
317
318 *:setg* *:setglobal*
319:setg[lobal] ... Like ":set" but set only the global value for a local
320 option without changing the local value.
321 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200322 With the "all" argument: display global values for all
323 local options.
324 Without argument: display global values for all local
325 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 {not in Vi}
327
328For buffer-local and window-local options:
329 Command global value local value ~
330 :set option=value set set
331 :setlocal option=value - set
332:setglobal option=value set -
333 :set option? - display
334 :setlocal option? - display
335:setglobal option? display -
336
337
338Global options with a local value *global-local*
339
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000340Options are global when you mostly use one value for all buffers and windows.
341For some global options it's useful to sometimes have a different local value.
342You can set the local value with ":setlocal". That buffer or window will then
343use the local value, while other buffers and windows continue using the global
344value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345
346For example, you have two windows, both on C source code. They use the global
347'makeprg' option. If you do this in one of the two windows: >
348 :set makeprg=gmake
349then the other window will switch to the same value. There is no need to set
350the 'makeprg' option in the other C source window too.
351However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000352another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000353files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 :setlocal makeprg=perlmake
355You can switch back to using the global value by making the local value empty: >
356 :setlocal makeprg=
357This only works for a string option. For a boolean option you need to use the
358"<" flag, like this: >
359 :setlocal autoread<
360Note that for non-boolean options using "<" copies the global value to the
361local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000362when the global value changes later). You can also use: >
363 :set path<
364This will make the local value of 'path' empty, so that the global value is
365used. Thus it does the same as: >
366 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367Note: In the future more global options can be made global-local. Using
368":setlocal" on a global option might work differently then.
369
370
371Setting the filetype
372
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200373:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374 Set the 'filetype' option to {filetype}, but only if
375 not done yet in a sequence of (nested) autocommands.
376 This is short for: >
377 :if !did_filetype()
378 : setlocal filetype={filetype}
379 :endif
380< This command is used in a filetype.vim file to avoid
381 setting the 'filetype' option twice, causing different
382 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200383
384 When the optional FALLBACK argument is present, a
385 later :setfiletype command will override the
386 'filetype'. This is to used for filetype detections
387 that are just a guess. |did_filetype()| will return
388 false after this command.
389
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390 {not in Vi}
391
Bram Moolenaard58e9292011-02-09 17:07:58 +0100392 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
394:opt[ions] Open a window for viewing and setting all options.
395 Options are grouped by function.
396 Offers short help for each option. Hit <CR> on the
397 short help to open a help window with more help for
398 the option.
399 Modify the value of the option and hit <CR> on the
400 "set" line to set the new value. For window and
401 buffer specific options, the last accessed window is
402 used to set the option value in, unless this is a help
403 window, in which case the window below help window is
404 used (skipping the option-window).
405 {not available when compiled without the |+eval| or
406 |+autocmd| features}
407
408 *$HOME*
409Using "~" is like using "$HOME", but it is only recognized at the start of an
410option and after a space or comma.
411
412On Unix systems "~user" can be used too. It is replaced by the home directory
413of user "user". Example: >
414 :set path=~mool/include,/usr/include,.
415
416On Unix systems the form "${HOME}" can be used too. The name between {} can
417contain non-id characters then. Note that if you want to use this for the
418"gf" command, you need to add the '{' and '}' characters to 'isfname'.
419
420NOTE: expanding environment variables and "~/" is only done with the ":set"
421command, not when assigning a value to an option with ":let".
422
Bram Moolenaarc572da52017-08-27 16:52:01 +0200423 *$HOME-windows*
424On MS-Windows, if $HOME is not defined as an environment variable, then
425at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
426
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427
428Note the maximum length of an expanded option is limited. How much depends on
429the system, mostly it is something like 256 or 1024 characters.
430
431 *:fix* *:fixdel*
432:fix[del] Set the value of 't_kD':
433 't_kb' is 't_kD' becomes ~
434 CTRL-? CTRL-H
435 not CTRL-? CTRL-?
436
437 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
438
439 If your delete key terminal code is wrong, but the
440 code for backspace is alright, you can put this in
441 your .vimrc: >
442 :fixdel
443< This works no matter what the actual code for
444 backspace is.
445
446 If the backspace key terminal code is wrong you can
447 use this: >
448 :if &term == "termname"
449 : set t_kb=^V<BS>
450 : fixdel
451 :endif
452< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000453 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454 with your terminal name.
455
456 If your <Delete> key sends a strange key sequence (not
457 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
458 :if &term == "termname"
459 : set t_kD=^V<Delete>
460 :endif
461< Where "^V" is CTRL-V and "<Delete>" is the delete key
462 (don't type eight characters!). Replace "termname"
463 with your terminal name.
464
465 *Linux-backspace*
466 Note about Linux: By default the backspace key
467 produces CTRL-?, which is wrong. You can fix it by
468 putting this line in your rc.local: >
469 echo "keycode 14 = BackSpace" | loadkeys
470<
471 *NetBSD-backspace*
472 Note about NetBSD: If your backspace doesn't produce
473 the right code, try this: >
474 xmodmap -e "keycode 22 = BackSpace"
475< If this works, add this in your .Xmodmap file: >
476 keysym 22 = BackSpace
477< You need to restart for this to take effect.
478
479==============================================================================
4802. Automatically setting options *auto-setting*
481
482Besides changing options with the ":set" command, there are three alternatives
483to set options automatically for one or more files:
484
4851. When starting Vim initializations are read from various places. See
486 |initialization|. Most of them are performed for all editing sessions,
487 and some of them depend on the directory where Vim is started.
488 You can create an initialization file with |:mkvimrc|, |:mkview| and
489 |:mksession|.
4902. If you start editing a new file, the automatic commands are executed.
491 This can be used to set options for files matching a particular pattern and
492 many other things. See |autocommand|.
4933. If you start editing a new file, and the 'modeline' option is on, a
494 number of lines at the beginning and end of the file are checked for
495 modelines. This is explained here.
496
497 *modeline* *vim:* *vi:* *ex:* *E520*
498There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200499 [text]{white}{vi:|vim:|ex:}[white]{options}
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>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200504[white] optional white space
505{options} a list of option settings, separated with white space
506 or ':', where each part between ':' is the argument
507 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar14b69452013-06-29 23:05:20 +0200509Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000510 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200511 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000512
513The second form (this is compatible with some versions of Vi):
514
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200515 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000516
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200517[text] any text or empty
518{white} at least one blank character (<Space> or <Tab>)
519{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
520[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200521se[t] the string "set " or "se " (note the space); When
522 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200523{options} a list of options, separated with white space, which
524 is the argument for a ":set" command
525: a colon
526[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527
Bram Moolenaar14b69452013-06-29 23:05:20 +0200528Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000529 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200530 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000531
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200532The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
533chance that a normal word like "lex:" is caught. There is one exception:
534"vi:" and "vim:" can also be at the start of the line (for compatibility with
535version 3.0). Using "ex:" at the start of the line will be ignored (this
536could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538 *modeline-local*
539The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000540buffer and window that contain the file. Although it's possible to set global
541options from a modeline, this is unusual. If you have two windows open and
542the files in it set the same global option to a different value, the result
543depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000545When editing a file that was already loaded, only the window-local options
546from the modeline are used. Thus if you manually changed a buffer-local
547option after opening the file, it won't be changed if you edit the same buffer
548in another window. But window-local options will be set.
549
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 *modeline-version*
551If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200552number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553 vim{vers}: version {vers} or later
554 vim<{vers}: version before {vers}
555 vim={vers}: version {vers}
556 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100557{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
558For example, to use a modeline only for Vim 7.0:
559 /* vim700: set foldmethod=marker */ ~
560To use a modeline for Vim after version 7.2:
561 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562There can be no blanks between "vim" and the ":".
563
564
565The number of lines that are checked can be set with the 'modelines' option.
566If 'modeline' is off or 'modelines' is 0 no lines are checked.
567
568Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000569like:
570 /* vi:ts=4: */ ~
571will give an error message for the trailing "*/". This line is OK:
572 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573
574If an error is detected the rest of the line is skipped.
575
576If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000577backslash in front of the ':' will be removed. Example:
578 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579This sets the 'dir' option to "c:\tmp". Only a single backslash before the
580':' is removed. Thus to include "\:" you have to specify "\\:".
581
582No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000583might create a Trojan horse text file with modelines). And not all options
584can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000585|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000586causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
587are wrapped unexpectedly. So disable modelines before editing untrusted text.
588The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589
590Hint: If you would like to do something else than setting an option, you could
591define an autocommand that checks the file for a specific string. For
592example: >
593 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
594And define a function SetVar() that does something with the line containing
595"VAR".
596
597==============================================================================
5983. Options summary *option-summary*
599
600In the list below all the options are mentioned with their full name and with
601an abbreviation if there is one. Both forms may be used.
602
603In this document when a boolean option is "set" that means that ":set option"
604is entered. When an option is "reset", ":set nooption" is used.
605
606For some options there are two default values: The "Vim default", which is
607used when 'compatible' is not set, and the "Vi default", which is used when
608'compatible' is set.
609
610Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000611are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612different value in each window. For example the 'list' option can be set in
613one window and reset in another for the same text, giving both types of view
614at the same time. There are a few options that are specific to a certain
615file. These can have a different value for each file or buffer. For example
616the 'textwidth' option can be 78 for a normal text file and 0 for a C
617program.
618
619 global one option for all buffers and windows
620 local to window each window has its own copy of this option
621 local to buffer each buffer has its own copy of this option
622
623When creating a new window the option values from the currently active window
624are used as a default value for the window-specific options. For the
625buffer-specific options this depends on the 's' and 'S' flags in the
626'cpoptions' option. If 's' is included (which is the default) the values for
627buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000628first entered. If 'S' is present the options are copied each time the buffer
629is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630present, the options are copied from the currently active buffer when the
631buffer is created.
632
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000633Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000634
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000635Not all options are supported in all versions. This depends on the supported
636features and sometimes on the system. A remark about this is in curly braces
637below. When an option is not supported it may still be set without getting an
638error, this is called a hidden option. You can't get the value of a hidden
639option though, it is not stored.
640
641To test if option "foo" can be used with ":set" use something like this: >
642 if exists('&foo')
643This also returns true for a hidden option. To test if option "foo" is really
644supported use something like this: >
645 if exists('+foo')
646<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647 *E355*
648A jump table for the options with a short description can be found at |Q_op|.
649
650 *'aleph'* *'al'* *aleph* *Aleph*
651'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
652 global
653 {not in Vi}
654 {only available when compiled with the |+rightleft|
655 feature}
656 The ASCII code for the first letter of the Hebrew alphabet. The
657 routine that maps the keyboard in Hebrew mode, both in Insert mode
658 (when hkmap is set) and on the command-line (when hitting CTRL-_)
659 outputs the Hebrew characters in the range [aleph..aleph+26].
660 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
661 See |rileft.txt|.
662
663 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
664'allowrevins' 'ari' boolean (default off)
665 global
666 {not in Vi}
667 {only available when compiled with the |+rightleft|
668 feature}
669 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
670 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
671 into reverse Insert mode, and don't know how to get out. See
672 'revins'.
673 NOTE: This option is reset when 'compatible' is set.
674
675 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
676'altkeymap' 'akm' boolean (default off)
677 global
678 {not in Vi}
679 {only available when compiled with the |+farsi|
680 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000681 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682 the keyboard map between Farsi and English, when 'allowrevins' set.
683
Bram Moolenaar582fd852005-03-28 20:58:01 +0000684 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685 is useful to start the Vim in native mode i.e. English (left-to-right
686 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000687 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688
689 *'ambiwidth'* *'ambw'*
690'ambiwidth' 'ambw' string (default: "single")
691 global
692 {not in Vi}
693 {only available when compiled with the |+multi_byte|
694 feature}
695 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
696 Tells Vim what to do with characters with East Asian Width Class
697 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
698 letters, Cyrillic letters).
699
700 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000701 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000702 expected by most users.
703 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200704 *E834* *E835*
705 The value "double" cannot be used if 'listchars' or 'fillchars'
706 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707
708 There are a number of CJK fonts for which the width of glyphs for
709 those characters are solely based on how many octets they take in
710 legacy/traditional CJK encodings. In those encodings, Euro,
711 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000712 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000714 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715 Vim is running inside a terminal (emulators) that uses a CJK font
716 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
717 this option should be set to "double" to match the width perceived
718 by Vim with the width of glyphs in the font. Perhaps it also has
719 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
720 when the system locale is set to one of CJK locales. See Unicode
721 Standard Annex #11 (http://www.unicode.org/reports/tr11).
722
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100723 Vim may set this option automatically at startup time when Vim is
724 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200725 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100726
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
728'antialias' 'anti' boolean (default: off)
729 global
730 {not in Vi}
731 {only available when compiled with GUI enabled
732 on Mac OS X}
733 This option only has an effect in the GUI version of Vim on Mac OS X
734 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
735 which can be easier to read at certain sizes on certain displays.
736 Setting this option can sometimes cause problems if 'guifont' is set
737 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100738 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739
740 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
741'autochdir' 'acd' boolean (default off)
742 global
743 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200744 {only available when compiled with it, use
745 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000746 When on, Vim will change the current working directory whenever you
747 open a file, switch buffers, delete a buffer or open/close a window.
748 It will change to the directory containing the file which was opened
749 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000750 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751
752 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
753'arabic' 'arab' boolean (default off)
754 local to window
755 {not in Vi}
756 {only available when compiled with the |+arabic|
757 feature}
758 This option can be set to start editing Arabic text.
759 Setting this option will:
760 - Set the 'rightleft' option, unless 'termbidi' is set.
761 - Set the 'arabicshape' option, unless 'termbidi' is set.
762 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
763 between typing English and Arabic key mapping.
764 - Set the 'delcombine' option
765 Note that 'encoding' must be "utf-8" for working with Arabic text.
766
767 Resetting this option will:
768 - Reset the 'rightleft' option.
769 - Disable the use of 'keymap' (without changing its value).
770 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200771 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100772 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773 Also see |arabic.txt|.
774
775 *'arabicshape'* *'arshape'*
776 *'noarabicshape'* *'noarshape'*
777'arabicshape' 'arshape' boolean (default on)
778 global
779 {not in Vi}
780 {only available when compiled with the |+arabic|
781 feature}
782 When on and 'termbidi' is off, the required visual character
783 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200784 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785 one which encompasses:
786 a) the changing/morphing of characters based on their location
787 within a word (initial, medial, final and stand-alone).
788 b) the enabling of the ability to compose characters
789 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100790 When disabled the display shows each character's true stand-alone
791 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792 Arabic is a complex language which requires other settings, for
793 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100794 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795
796 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
797'autoindent' 'ai' boolean (default off)
798 local to buffer
799 Copy indent from current line when starting a new line (typing <CR>
800 in Insert mode or when using the "o" or "O" command). If you do not
801 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000802 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
803 to another line has the same effect, unless the 'I' flag is included
804 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000805 When autoindent is on, formatting (with the "gq" command or when you
806 reach 'textwidth' in Insert mode) uses the indentation of the first
807 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808 When 'smartindent' or 'cindent' is on the indent is changed in
809 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200810 The 'autoindent' option is reset when the 'paste' option is set and
811 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000812 {small difference from Vi: After the indent is deleted when typing
813 <Esc> or <CR>, the cursor position when moving up or down is after the
814 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
815
816 *'autoread'* *'ar'* *'noautoread'* *'noar'*
817'autoread' 'ar' boolean (default off)
818 global or local to buffer |global-local|
819 {not in Vi}
820 When a file has been detected to have been changed outside of Vim and
821 it has not been changed inside of Vim, automatically read it again.
822 When the file has been deleted this is not done. |timestamp|
823 If this option has a local value, use this command to switch back to
824 using the global value: >
825 :set autoread<
826<
827 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
828'autowrite' 'aw' boolean (default off)
829 global
830 Write the contents of the file, if it has been modified, on each
831 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000832 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
834 Note that for some commands the 'autowrite' option is not used, see
835 'autowriteall' for that.
836
837 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
838'autowriteall' 'awa' boolean (default off)
839 global
840 {not in Vi}
841 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
842 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
843 Setting this option also implies that Vim behaves like 'autowrite' has
844 been set.
845
846 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200847'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848 global
849 {not in Vi}
850 When set to "dark", Vim will try to use colors that look good on a
851 dark background. When set to "light", Vim will try to use colors that
852 look good on a light background. Any other value is illegal.
853 Vim tries to set the default value according to the terminal used.
854 This will not always be correct.
855 Setting this option does not change the background color, it tells Vim
856 what the background color looks like. For changing the background
857 color, see |:hi-normal|.
858
859 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000860 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000861 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100862 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 setting 'background' will cause the color scheme to be reloaded. If
864 the color scheme adjusts to the value of 'background' this will work.
865 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100866 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867
868 When setting 'background' to the default value with: >
869 :set background&
870< Vim will guess the value. In the GUI this should work correctly,
871 in other cases Vim might not be able to guess the right value.
872
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200873 When the t_BG option is set, Vim will use it to request the background
874 color from the terminal. If the returned RGB value is dark/light and
875 'background' is not dark/light, 'background' will be set and the
876 screen is redrawn. This may have side effects, make t_BG empty in
877 your .vimrc if you suspect this problem.
878
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879 When starting the GUI, the default value for 'background' will be
880 "light". When the value is not set in the .gvimrc, and Vim detects
881 that the background is actually quite dark, 'background' is set to
882 "dark". But this happens only AFTER the .gvimrc file has been read
883 (because the window needs to be opened to find the actual background
884 color). To get around this, force the GUI window to be opened by
885 putting a ":gui" command in the .gvimrc file, before where the value
886 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200887
888 For MS-DOS, Windows and OS/2 the default is "dark".
889 For other systems "dark" is used when 'term' is "linux",
890 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
891 background. Otherwise the default is "light".
892
Bram Moolenaarc572da52017-08-27 16:52:01 +0200893 The |:terminal| command and the |term_start()| function use the
894 'background' value to decide whether the terminal window will start
895 with a white or black background.
896
Bram Moolenaar071d4272004-06-13 20:20:40 +0000897 Normally this option would be set in the .vimrc file. Possibly
898 depending on the terminal name. Example: >
899 :if &term == "pcterm"
900 : set background=dark
901 :endif
902< When this option is set, the default settings for the highlight groups
903 will change. To use other settings, place ":highlight" commands AFTER
904 the setting of the 'background' option.
905 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
906 to select the colors for syntax highlighting. After changing this
907 option, you must load syntax.vim again to see the result. This can be
908 done with ":syntax on".
909
910 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200911'backspace' 'bs' string (default "", set to "indent,eol,start"
912 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913 global
914 {not in Vi}
915 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
916 mode. This is a list of items, separated by commas. Each item allows
917 a way to backspace over something:
918 value effect ~
919 indent allow backspacing over autoindent
920 eol allow backspacing over line breaks (join lines)
921 start allow backspacing over the start of insert; CTRL-W and CTRL-U
922 stop once at the start of insert.
923
924 When the value is empty, Vi compatible backspacing is used.
925
926 For backwards compatibility with version 5.4 and earlier:
927 value effect ~
928 0 same as ":set backspace=" (Vi compatible)
929 1 same as ":set backspace=indent,eol"
930 2 same as ":set backspace=indent,eol,start"
931
932 See |:fixdel| if your <BS> or <Del> key does not do what you want.
933 NOTE: This option is set to "" when 'compatible' is set.
934
935 *'backup'* *'bk'* *'nobackup'* *'nobk'*
936'backup' 'bk' boolean (default off)
937 global
938 {not in Vi}
939 Make a backup before overwriting a file. Leave it around after the
940 file has been successfully written. If you do not want to keep the
941 backup file, but you do want a backup while the file is being
942 written, reset this option and set the 'writebackup' option (this is
943 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000944 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945 |backup-table| for more explanations.
946 When the 'backupskip' pattern matches, a backup is not made anyway.
947 When 'patchmode' is set, the backup may be renamed to become the
948 oldest version of a file.
949 NOTE: This option is reset when 'compatible' is set.
950
951 *'backupcopy'* *'bkc'*
952'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200953 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000954 {not in Vi}
955 When writing a file and a backup is made, this option tells how it's
956 done. This is a comma separated list of words.
957
958 The main values are:
959 "yes" make a copy of the file and overwrite the original one
960 "no" rename the file and write a new one
961 "auto" one of the previous, what works best
962
963 Extra values that can be combined with the ones above are:
964 "breaksymlink" always break symlinks when writing
965 "breakhardlink" always break hardlinks when writing
966
967 Making a copy and overwriting the original file:
968 - Takes extra time to copy the file.
969 + When the file has special attributes, is a (hard/symbolic) link or
970 has a resource fork, all this is preserved.
971 - When the file is a link the backup will have the name of the link,
972 not of the real file.
973
974 Renaming the file and writing a new one:
975 + It's fast.
976 - Sometimes not all attributes of the file can be copied to the new
977 file.
978 - When the file is a link the new file will not be a link.
979
980 The "auto" value is the middle way: When Vim sees that renaming file
981 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000982 the file is not a link) that is used. When problems are expected, a
983 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000984
985 The "breaksymlink" and "breakhardlink" values can be used in
986 combination with any of "yes", "no" and "auto". When included, they
987 force Vim to always break either symbolic or hard links by doing
988 exactly what the "no" option does, renaming the original file to
989 become the backup and writing a new file in its place. This can be
990 useful for example in source trees where all the files are symbolic or
991 hard links and any changes should stay in the local source tree, not
992 be propagated back to the original source.
993 *crontab*
994 One situation where "no" and "auto" will cause problems: A program
995 that opens a file, invokes Vim to edit that file, and then tests if
996 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000997 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998 example.
999
1000 When a copy is made, the original file is truncated and then filled
1001 with the new text. This means that protection bits, owner and
1002 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001003 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 group of the backup is set to the group of the original file. If this
1005 fails, the protection bits for the group are made the same as for
1006 others.
1007
1008 When the file is renamed this is the other way around: The backup has
1009 the same attributes of the original file, and the newly written file
1010 is owned by the current user. When the file was a (hard/symbolic)
1011 link, the new file will not! That's why the "auto" value doesn't
1012 rename when the file is a link. The owner and group of the newly
1013 written file will be set to the same ones as the original file, but
1014 the system may refuse to do this. In that case the "auto" value will
1015 again not rename the file.
1016
Bram Moolenaar036986f2017-03-16 17:41:02 +01001017 NOTE: This option is set to the Vi default value when 'compatible' is
1018 set and to the Vim default value when 'compatible' is reset.
1019
Bram Moolenaar071d4272004-06-13 20:20:40 +00001020 *'backupdir'* *'bdir'*
1021'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001022 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023 for Unix: ".,~/tmp,~/")
1024 global
1025 {not in Vi}
1026 List of directories for the backup file, separated with commas.
1027 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001028 where this is possible. The directory must exist, Vim will not
1029 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001030 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031 impossible!). Writing may fail because of this.
1032 - A directory "." means to put the backup file in the same directory
1033 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001034 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035 put the backup file relative to where the edited file is. The
1036 leading "." is replaced with the path name of the edited file.
1037 ("." inside a directory name has no special meaning).
1038 - Spaces after the comma are ignored, other spaces are considered part
1039 of the directory name. To have a space at the start of a directory
1040 name, precede it with a backslash.
1041 - To include a comma in a directory name precede it with a backslash.
1042 - A directory name may end in an '/'.
1043 - Environment variables are expanded |:set_env|.
1044 - Careful with '\' characters, type one before a space, type two to
1045 get one in the option (see |option-backslash|), for example: >
1046 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1047< - For backwards compatibility with Vim version 3.0 a '>' at the start
1048 of the option is removed.
1049 See also 'backup' and 'writebackup' options.
1050 If you want to hide your backup files on Unix, consider this value: >
1051 :set backupdir=./.backup,~/.backup,.,/tmp
1052< You must create a ".backup" directory in each directory and in your
1053 home directory for this to work properly.
1054 The use of |:set+=| and |:set-=| is preferred when adding or removing
1055 directories from the list. This avoids problems when a future version
1056 uses another default.
1057 This option cannot be set from a |modeline| or in the |sandbox|, for
1058 security reasons.
1059
1060 *'backupext'* *'bex'* *E589*
1061'backupext' 'bex' string (default "~", for VMS: "_")
1062 global
1063 {not in Vi}
1064 String which is appended to a file name to make the name of the
1065 backup file. The default is quite unusual, because this avoids
1066 accidentally overwriting existing files with a backup file. You might
1067 prefer using ".bak", but make sure that you don't have files with
1068 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001069 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001071 If you like to keep a lot of backups, you could use a BufWritePre
1072 autocommand to change 'backupext' just before writing the file to
1073 include a timestamp. >
1074 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1075< Use 'backupdir' to put the backup in a different directory.
1076
Bram Moolenaar071d4272004-06-13 20:20:40 +00001077 *'backupskip'* *'bsk'*
1078'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1079 global
1080 {not in Vi}
1081 {not available when compiled without the |+wildignore|
1082 feature}
1083 A list of file patterns. When one of the patterns matches with the
1084 name of the file which is written, no backup file is created. Both
1085 the specified file name and the full path name of the file are used.
1086 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1087 Watch out for special characters, see |option-backslash|.
1088 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001089 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001090
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001091 WARNING: Not having a backup file means that when Vim fails to write
1092 your buffer correctly and then, for whatever reason, Vim exits, you
1093 lose both the original file and what you were writing. Only disable
1094 backups if you don't care about losing the file.
1095
Bram Moolenaar02467872007-05-06 13:22:01 +00001096 Note that environment variables are not expanded. If you want to use
1097 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001098 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001099
1100< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001101 backup would be made by renaming the original file crontab won't see
1102 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001103
1104 *'balloondelay'* *'bdlay'*
1105'balloondelay' 'bdlay' number (default: 600)
1106 global
1107 {not in Vi}
1108 {only available when compiled with the |+balloon_eval|
1109 feature}
1110 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1111
1112 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1113'ballooneval' 'beval' boolean (default off)
1114 global
1115 {not in Vi}
1116 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001117 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118 Switch on the |balloon-eval| functionality.
1119
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001120 *'balloonexpr'* *'bexpr'*
1121'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001122 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001123 {not in Vi}
1124 {only available when compiled with the |+balloon_eval|
1125 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001126 Expression for text to show in evaluation balloon. It is only used
1127 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001128
1129 v:beval_bufnr number of the buffer in which balloon is going to show
1130 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001131 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001132 v:beval_lnum line number
1133 v:beval_col column number (byte index)
1134 v:beval_text word under or after the mouse pointer
1135
1136 The evaluation of the expression must not have side effects!
1137 Example: >
1138 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001139 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001140 \', column ' . v:beval_col .
1141 \ ' of file ' . bufname(v:beval_bufnr) .
1142 \ ' on word "' . v:beval_text . '"'
1143 endfunction
1144 set bexpr=MyBalloonExpr()
1145 set ballooneval
1146<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001147 Also see |balloon_show()|, can be used if the content of the balloon
1148 is to be fetched asynchronously.
1149
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001150 NOTE: The balloon is displayed only if the cursor is on a text
1151 character. If the result of evaluating 'balloonexpr' is not empty,
1152 Vim does not try to send a message to an external debugger (Netbeans
1153 or Sun Workshop).
1154
Bram Moolenaar30b65812012-07-12 22:01:11 +02001155 The expression will be evaluated in the |sandbox| when set from a
1156 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001157
1158 It is not allowed to change text or jump to another window while
1159 evaluating 'balloonexpr' |textlock|.
1160
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001161 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001162 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001163< When they are supported "\n" characters will start a new line. If the
1164 expression evaluates to a |List| this is equal to using each List item
1165 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001166 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001167
Bram Moolenaar165bc692015-07-21 17:53:25 +02001168 *'belloff'* *'bo'*
1169'belloff' 'bo' string (default "")
1170 global
1171 {not in Vi}
1172 Specifies for which events the bell will not be rung. It is a comma
1173 separated list of items. For each item that is present, the bell
1174 will be silenced. This is most useful to specify specific events in
1175 insert mode to be silenced.
1176
1177 item meaning when present ~
1178 all All events.
1179 backspace When hitting <BS> or <Del> and deleting results in an
1180 error.
1181 cursor Fail to move around using the cursor keys or
1182 <PageUp>/<PageDown> in |Insert-mode|.
1183 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1184 |i_CTRL-X_CTRL-T|.
1185 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1186 |i_CTRL-E|.
1187 ctrlg Unknown Char after <C-G> in Insert mode.
1188 error Other Error occurred (e.g. try to join last line)
1189 (mostly used in |Normal-mode| or |Cmdline-mode|).
1190 esc hitting <Esc> in |Normal-mode|.
1191 ex In |Visual-mode|, hitting |Q| results in an error.
1192 hangul Error occurred when using hangul input.
1193 insertmode Pressing <Esc> in 'insertmode'.
1194 lang Calling the beep module for Lua/Mzscheme/TCL.
1195 mess No output available for |g<|.
1196 showmatch Error occurred for 'showmatch' function.
1197 operator Empty region error |cpo-E|.
1198 register Unknown register after <C-R> in |Insert-mode|.
1199 shell Bell from shell output |:!|.
1200 spell Error happened on spell suggest.
1201 wildmode More matches in |cmdline-completion| available
1202 (depends on the 'wildmode' setting).
1203
Bram Moolenaar036986f2017-03-16 17:41:02 +01001204 This is most useful to fine tune when in Insert mode the bell should
1205 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001206 indicate that an error occurred. It can be silenced by adding the
1207 "error" keyword.
1208
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1210'binary' 'bin' boolean (default off)
1211 local to buffer
1212 {not in Vi}
1213 This option should be set before editing a binary file. You can also
1214 use the |-b| Vim argument. When this option is switched on a few
1215 options will be changed (also when it already was on):
1216 'textwidth' will be set to 0
1217 'wrapmargin' will be set to 0
1218 'modeline' will be off
1219 'expandtab' will be off
1220 Also, 'fileformat' and 'fileformats' options will not be used, the
1221 file is read and written like 'fileformat' was "unix" (a single <NL>
1222 separates lines).
1223 The 'fileencoding' and 'fileencodings' options will not be used, the
1224 file is read without conversion.
1225 NOTE: When you start editing a(nother) file while the 'bin' option is
1226 on, settings from autocommands may change the settings again (e.g.,
1227 'textwidth'), causing trouble when editing. You might want to set
1228 'bin' again when the file has been loaded.
1229 The previous values of these options are remembered and restored when
1230 'bin' is switched from on to off. Each buffer has its own set of
1231 saved option values.
1232 To edit a file with 'binary' set you can use the |++bin| argument.
1233 This avoids you have to do ":set bin", which would have effect for all
1234 files you edit.
1235 When writing a file the <EOL> for the last line is only written if
1236 there was one in the original file (normally Vim appends an <EOL> to
1237 the last line if there is none; this would make the file longer). See
1238 the 'endofline' option.
1239
1240 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1241'bioskey' 'biosk' boolean (default on)
1242 global
1243 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001244 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245
1246 *'bomb'* *'nobomb'*
1247'bomb' boolean (default off)
1248 local to buffer
1249 {not in Vi}
1250 {only available when compiled with the |+multi_byte|
1251 feature}
1252 When writing a file and the following conditions are met, a BOM (Byte
1253 Order Mark) is prepended to the file:
1254 - this option is on
1255 - the 'binary' option is off
1256 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1257 endian variants.
1258 Some applications use the BOM to recognize the encoding of the file.
1259 Often used for UCS-2 files on MS-Windows. For other applications it
1260 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001261 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1263 check for the presence of the BOM is done and 'bomb' set accordingly.
1264 Unless 'binary' is set, it is removed from the first line, so that you
1265 don't see it when editing. When you don't change the options, the BOM
1266 will be restored when writing the file.
1267
1268 *'breakat'* *'brk'*
1269'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1270 global
1271 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001272 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273 feature}
1274 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001275 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1276 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001278 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001279'breakindent' 'bri' boolean (default off)
1280 local to window
1281 {not in Vi}
1282 {not available when compiled without the |+linebreak|
1283 feature}
1284 Every wrapped line will continue visually indented (same amount of
1285 space as the beginning of that line), thus preserving horizontal blocks
1286 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001287 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001288
1289 *'breakindentopt'* *'briopt'*
1290'breakindentopt' 'briopt' string (default empty)
1291 local to window
1292 {not in Vi}
1293 {not available when compiled without the |+linebreak|
1294 feature}
1295 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001296 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001297 min:{n} Minimum text width that will be kept after
1298 applying 'breakindent', even if the resulting
1299 text should normally be narrower. This prevents
1300 text indented almost to the right window border
1301 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001302 shift:{n} After applying 'breakindent', the wrapped line's
1303 beginning will be shifted by the given number of
1304 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001305 indentation (negative) or emphasizing the line
1306 continuation (positive).
1307 sbr Display the 'showbreak' value before applying the
1308 additional indent.
1309 The default value for min is 20 and shift is 0.
1310
Bram Moolenaar071d4272004-06-13 20:20:40 +00001311 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001312'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001313 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001314 {not in Vi} {only for Motif, Athena, GTK, Mac and
1315 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001317 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001318 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001319 buffer Use the directory of the related buffer.
1320 current Use the current directory.
1321 {path} Use the specified directory
1322
1323 *'bufhidden'* *'bh'*
1324'bufhidden' 'bh' string (default: "")
1325 local to buffer
1326 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001327 This option specifies what happens when a buffer is no longer
1328 displayed in a window:
1329 <empty> follow the global 'hidden' option
1330 hide hide the buffer (don't unload it), also when 'hidden'
1331 is not set
1332 unload unload the buffer, also when 'hidden' is set or using
1333 |:hide|
1334 delete delete the buffer from the buffer list, also when
1335 'hidden' is set or using |:hide|, like using
1336 |:bdelete|
1337 wipe wipe out the buffer from the buffer list, also when
1338 'hidden' is set or using |:hide|, like using
1339 |:bwipeout|
1340
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001341 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001342 are lost without a warning. Also, these values may break autocommands
1343 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344 This option is used together with 'buftype' and 'swapfile' to specify
1345 special kinds of buffers. See |special-buffers|.
1346
1347 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1348'buflisted' 'bl' boolean (default: on)
1349 local to buffer
1350 {not in Vi}
1351 When this option is set, the buffer shows up in the buffer list. If
1352 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1353 This option is reset by Vim for buffers that are only used to remember
1354 a file name or marks. Vim sets it when starting to edit a buffer.
1355 But not when moving to a buffer with ":buffer".
1356
1357 *'buftype'* *'bt'* *E382*
1358'buftype' 'bt' string (default: "")
1359 local to buffer
1360 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001361 The value of this option specifies the type of a buffer:
1362 <empty> normal buffer
1363 nofile buffer which is not related to a file and will not be
1364 written
1365 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001366 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001367 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001368 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001370 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001371 help help buffer (you are not supposed to set this
1372 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001373 terminal buffer for a |terminal| (you are not supposed to set
1374 this manually)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001375
1376 This option is used together with 'bufhidden' and 'swapfile' to
1377 specify special kinds of buffers. See |special-buffers|.
1378
1379 Be careful with changing this option, it can have many side effects!
1380
Bram Moolenaar280f1262006-01-30 00:14:18 +00001381 A "quickfix" buffer is only used for the error list and the location
1382 list. This value is set by the |:cwindow| and |:lwindow| commands and
1383 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384
1385 "nofile" and "nowrite" buffers are similar:
1386 both: The buffer is not to be written to disk, ":w" doesn't
1387 work (":w filename" does work though).
1388 both: The buffer is never considered to be |'modified'|.
1389 There is no warning when the changes will be lost, for
1390 example when you quit Vim.
1391 both: A swap file is only created when using too much memory
1392 (when 'swapfile' has been reset there is never a swap
1393 file).
1394 nofile only: The buffer name is fixed, it is not handled like a
1395 file name. It is not modified in response to a |:cd|
1396 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001397 both: When using ":e bufname" and already editing "bufname"
1398 the buffer is made empty and autocommands are
1399 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001400 *E676*
1401 "acwrite" implies that the buffer name is not related to a file, like
1402 "nofile", but it will be written. Thus, in contrast to "nofile" and
1403 "nowrite", ":w" does work and a modified buffer can't be abandoned
1404 without saving. For writing there must be matching |BufWriteCmd|,
1405 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001406
1407 *'casemap'* *'cmp'*
1408'casemap' 'cmp' string (default: "internal,keepascii")
1409 global
1410 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001411 {only available when compiled with the |+multi_byte|
1412 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001413 Specifies details about changing the case of letters. It may contain
1414 these words, separated by a comma:
1415 internal Use internal case mapping functions, the current
1416 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001417 matters when 'encoding' is a Unicode encoding,
1418 "latin1" or "iso-8859-15". When "internal" is
1419 omitted, the towupper() and towlower() system library
1420 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1422 case mapping, the current locale is not effective.
1423 This probably only matters for Turkish.
1424
1425 *'cdpath'* *'cd'* *E344* *E346*
1426'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1427 global
1428 {not in Vi}
1429 {not available when compiled without the
1430 |+file_in_path| feature}
1431 This is a list of directories which will be searched when using the
1432 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001433 for has a relative path, not an absolute part starting with "/", "./"
1434 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435 The 'cdpath' option's value has the same form and semantics as
1436 |'path'|. Also see |file-searching|.
1437 The default value is taken from $CDPATH, with a "," prepended to look
1438 in the current directory first.
1439 If the default value taken from $CDPATH is not what you want, include
1440 a modified version of the following command in your vimrc file to
1441 override it: >
1442 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1443< This option cannot be set from a |modeline| or in the |sandbox|, for
1444 security reasons.
1445 (parts of 'cdpath' can be passed to the shell to expand file names).
1446
1447 *'cedit'*
1448'cedit' string (Vi default: "", Vim default: CTRL-F)
1449 global
1450 {not in Vi}
1451 {not available when compiled without the |+vertsplit|
1452 feature}
1453 The key used in Command-line Mode to open the command-line window.
1454 The default is CTRL-F when 'compatible' is off.
1455 Only non-printable keys are allowed.
1456 The key can be specified as a single character, but it is difficult to
1457 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001458 :exe "set cedit=\<C-Y>"
1459 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001460< |Nvi| also has this option, but it only uses the first character.
1461 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001462 NOTE: This option is set to the Vim default value when 'compatible'
1463 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001464
1465 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1466'charconvert' 'ccv' string (default "")
1467 global
1468 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001469 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470 {not in Vi}
1471 An expression that is used for character encoding conversion. It is
1472 evaluated when a file that is to be read or has been written has a
1473 different encoding from what is desired.
1474 'charconvert' is not used when the internal iconv() function is
1475 supported and is able to do the conversion. Using iconv() is
1476 preferred, because it is much faster.
1477 'charconvert' is not used when reading stdin |--|, because there is no
1478 file to convert from. You will have to save the text in a file first.
1479 The expression must return zero or an empty string for success,
1480 non-zero for failure.
1481 The possible encoding names encountered are in 'encoding'.
1482 Additionally, names given in 'fileencodings' and 'fileencoding' are
1483 used.
1484 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1485 is done internally by Vim, 'charconvert' is not used for this.
1486 'charconvert' is also used to convert the viminfo file, if the 'c'
1487 flag is present in 'viminfo'. Also used for Unicode conversion.
1488 Example: >
1489 set charconvert=CharConvert()
1490 fun CharConvert()
1491 system("recode "
1492 \ . v:charconvert_from . ".." . v:charconvert_to
1493 \ . " <" . v:fname_in . " >" v:fname_out)
1494 return v:shell_error
1495 endfun
1496< The related Vim variables are:
1497 v:charconvert_from name of the current encoding
1498 v:charconvert_to name of the desired encoding
1499 v:fname_in name of the input file
1500 v:fname_out name of the output file
1501 Note that v:fname_in and v:fname_out will never be the same.
1502 Note that v:charconvert_from and v:charconvert_to may be different
1503 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1504 Encryption is not done by Vim when using 'charconvert'. If you want
1505 to encrypt the file after conversion, 'charconvert' should take care
1506 of this.
1507 This option cannot be set from a |modeline| or in the |sandbox|, for
1508 security reasons.
1509
1510 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1511'cindent' 'cin' boolean (default off)
1512 local to buffer
1513 {not in Vi}
1514 {not available when compiled without the |+cindent|
1515 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001516 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001517 that trigger reindenting in insert mode and 'cinoptions' to set your
1518 preferred indent style.
1519 If 'indentexpr' is not empty, it overrules 'cindent'.
1520 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1521 the "=" operator indents using this algorithm rather than calling an
1522 external program.
1523 See |C-indenting|.
1524 When you don't like the way 'cindent' works, try the 'smartindent'
1525 option or 'indentexpr'.
1526 This option is not used when 'paste' is set.
1527 NOTE: This option is reset when 'compatible' is set.
1528
1529 *'cinkeys'* *'cink'*
1530'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1531 local to buffer
1532 {not in Vi}
1533 {not available when compiled without the |+cindent|
1534 feature}
1535 A list of keys that, when typed in Insert mode, cause reindenting of
1536 the current line. Only used if 'cindent' is on and 'indentexpr' is
1537 empty.
1538 For the format of this option see |cinkeys-format|.
1539 See |C-indenting|.
1540
1541 *'cinoptions'* *'cino'*
1542'cinoptions' 'cino' string (default "")
1543 local to buffer
1544 {not in Vi}
1545 {not available when compiled without the |+cindent|
1546 feature}
1547 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1548 program. See |cinoptions-values| for the values of this option, and
1549 |C-indenting| for info on C indenting in general.
1550
1551
1552 *'cinwords'* *'cinw'*
1553'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1554 local to buffer
1555 {not in Vi}
1556 {not available when compiled without both the
1557 |+cindent| and the |+smartindent| features}
1558 These keywords start an extra indent in the next line when
1559 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1560 an appropriate place (inside {}).
1561 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1562 matter, include the keyword both the uppercase and lowercase:
1563 "if,If,IF".
1564
1565 *'clipboard'* *'cb'*
1566'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1567 for X-windows, "" otherwise)
1568 global
1569 {not in Vi}
1570 {only in GUI versions or when the |+xterm_clipboard|
1571 feature is included}
1572 This option is a list of comma separated names.
1573 These names are recognized:
1574
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001575 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576 unnamed When included, Vim will use the clipboard register '*'
1577 for all yank, delete, change and put operations which
1578 would normally go to the unnamed register. When a
1579 register is explicitly specified, it will always be
1580 used regardless of whether "unnamed" is in 'clipboard'
1581 or not. The clipboard register can always be
1582 explicitly accessed using the "* notation. Also see
1583 |gui-clipboard|.
1584
Bram Moolenaar30b65812012-07-12 22:01:11 +02001585 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001586 unnamedplus A variant of the "unnamed" flag which uses the
1587 clipboard register '+' (|quoteplus|) instead of
1588 register '*' for all yank, delete, change and put
1589 operations which would normally go to the unnamed
1590 register. When "unnamed" is also included to the
1591 option, yank operations (but not delete, change or
1592 put) will additionally copy the text into register
1593 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001594 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001595 Availability can be checked with: >
1596 if has('unnamedplus')
1597<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001598 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 autoselect Works like the 'a' flag in 'guioptions': If present,
1600 then whenever Visual mode is started, or the Visual
1601 area extended, Vim tries to become the owner of the
1602 windowing system's global selection or put the
1603 selected text on the clipboard used by the selection
1604 register "*. See |guioptions_a| and |quotestar| for
1605 details. When the GUI is active, the 'a' flag in
1606 'guioptions' is used, when the GUI is not active, this
1607 "autoselect" flag is used.
1608 Also applies to the modeless selection.
1609
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001610 *clipboard-autoselectplus*
1611 autoselectplus Like "autoselect" but using the + register instead of
1612 the * register. Compare to the 'P' flag in
1613 'guioptions'.
1614
1615 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 autoselectml Like "autoselect", but for the modeless selection
1617 only. Compare to the 'A' flag in 'guioptions'.
1618
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001619 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001620 html When the clipboard contains HTML, use this when
1621 pasting. When putting text on the clipboard, mark it
1622 as HTML. This works to copy rendered HTML from
1623 Firefox, paste it as raw HTML in Vim, select the HTML
1624 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001625 You probably want to add this only temporarily,
1626 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001627 Only supported for GTK version 2 and later.
1628 Only available with the |+multi_byte| feature.
1629
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001630 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631 exclude:{pattern}
1632 Defines a pattern that is matched against the name of
1633 the terminal 'term'. If there is a match, no
1634 connection will be made to the X server. This is
1635 useful in this situation:
1636 - Running Vim in a console.
1637 - $DISPLAY is set to start applications on another
1638 display.
1639 - You do not want to connect to the X server in the
1640 console, but do want this in a terminal emulator.
1641 To never connect to the X server use: >
1642 exclude:.*
1643< This has the same effect as using the |-X| argument.
1644 Note that when there is no connection to the X server
1645 the window title won't be restored and the clipboard
1646 cannot be accessed.
1647 The value of 'magic' is ignored, {pattern} is
1648 interpreted as if 'magic' was on.
1649 The rest of the option value will be used for
1650 {pattern}, this must be the last entry.
1651
1652 *'cmdheight'* *'ch'*
1653'cmdheight' 'ch' number (default 1)
1654 global
1655 {not in Vi}
1656 Number of screen lines to use for the command-line. Helps avoiding
1657 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001658 The value of this option is stored with the tab page, so that each tab
1659 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660
1661 *'cmdwinheight'* *'cwh'*
1662'cmdwinheight' 'cwh' number (default 7)
1663 global
1664 {not in Vi}
1665 {not available when compiled without the |+vertsplit|
1666 feature}
1667 Number of screen lines to use for the command-line window. |cmdwin|
1668
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001669 *'colorcolumn'* *'cc'*
1670'colorcolumn' 'cc' string (default "")
1671 local to window
1672 {not in Vi}
1673 {not available when compiled without the |+syntax|
1674 feature}
1675 'colorcolumn' is a comma separated list of screen columns that are
1676 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1677 text. Will make screen redrawing slower.
1678 The screen column can be an absolute number, or a number preceded with
1679 '+' or '-', which is added to or subtracted from 'textwidth'. >
1680
1681 :set cc=+1 " highlight column after 'textwidth'
1682 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1683 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1684<
1685 When 'textwidth' is zero then the items with '-' and '+' are not used.
1686 A maximum of 256 columns are highlighted.
1687
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688 *'columns'* *'co'* *E594*
1689'columns' 'co' number (default 80 or terminal width)
1690 global
1691 {not in Vi}
1692 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001693 initialization and does not have to be set by hand. Also see
1694 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695 When Vim is running in the GUI or in a resizable window, setting this
1696 option will cause the window size to be changed. When you only want
1697 to use the size for the GUI, put the command in your |gvimrc| file.
1698 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001699 number of columns of the display, the display may be messed up. For
1700 the GUI it is always possible and Vim limits the number of columns to
1701 what fits on the screen. You can use this command to get the widest
1702 window possible: >
1703 :set columns=9999
1704< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705
1706 *'comments'* *'com'* *E524* *E525*
1707'comments' 'com' string (default
1708 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1709 local to buffer
1710 {not in Vi}
1711 {not available when compiled without the |+comments|
1712 feature}
1713 A comma separated list of strings that can start a comment line. See
1714 |format-comments|. See |option-backslash| about using backslashes to
1715 insert a space.
1716
1717 *'commentstring'* *'cms'* *E537*
1718'commentstring' 'cms' string (default "/*%s*/")
1719 local to buffer
1720 {not in Vi}
1721 {not available when compiled without the |+folding|
1722 feature}
1723 A template for a comment. The "%s" in the value is replaced with the
1724 comment text. Currently only used to add markers for folding, see
1725 |fold-marker|.
1726
1727 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001728'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001729 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 global
1731 {not in Vi}
1732 This option has the effect of making Vim either more Vi-compatible, or
1733 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001734
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001736 other options are also changed as a side effect.
1737 NOTE: Setting or resetting this option can have a lot of unexpected
1738 effects: Mappings are interpreted in another way, undo behaves
1739 differently, etc. If you set this option in your vimrc file, you
1740 should probably put it at the very start.
1741
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742 By default this option is on and the Vi defaults are used for the
1743 options. This default was chosen for those people who want to use Vim
1744 just like Vi, and don't even (want to) know about the 'compatible'
1745 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001746 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001747 this option is switched off, and all options that have not been
1748 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001749 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001750 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001751 happen for the system-wide vimrc or gvimrc file, nor for a file given
1752 with the |-u| argument). Also see |compatible-default| and
1753 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754 You can also set this option with the "-C" argument, and reset it with
1755 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001756 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757
Bram Moolenaar214641f2017-03-05 17:04:09 +01001758 When this option is set, numerous other options are set to make Vim as
1759 Vi-compatible as possible. When this option is unset, various options
1760 are set to make Vim more useful. The table below lists all the
1761 options affected.
1762 The {?} column indicates when the options are affected:
1763 + Means that the option is set to the value given in {set value} when
1764 'compatible' is set.
1765 & Means that the option is set to the value given in {set value} when
1766 'compatible' is set AND is set to its Vim default value when
1767 'compatible' is unset.
1768 - Means the option is NOT changed when setting 'compatible' but IS
1769 set to its Vim default when 'compatible' is unset.
1770 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771
Bram Moolenaar036986f2017-03-16 17:41:02 +01001772 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001773
1774 'allowrevins' + off no CTRL-_ command
1775 'antialias' + off don't use antialiased fonts
1776 'arabic' + off reset arabic-related options
1777 'arabicshape' + on correct character shapes
1778 'backspace' + "" normal backspace
1779 'backup' + off no backup file
1780 'backupcopy' & Unix: "yes" backup file is a copy
1781 else: "auto" copy or rename backup file
1782 'balloonexpr' + "" text to show in evaluation balloon
1783 'breakindent' + off don't indent when wrapping lines
1784 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1785 'cindent' + off no C code indentation
1786 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1787 'copyindent' + off don't copy indent structure
1788 'cpoptions' & (all flags) Vi-compatible flags
1789 'cscopepathcomp'+ 0 don't show directories in tags list
1790 'cscoperelative'+ off
1791 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001792 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001793 'cscopeverbose' + off see |cscopeverbose|
1794 'delcombine' + off unicode: delete whole char combination
1795 'digraph' + off no digraphs
1796 'esckeys' & off no <Esc>-keys in Insert mode
1797 'expandtab' + off tabs not expanded to spaces
1798 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001800 'formatexpr' + "" use 'formatprg' for auto-formatting
1801 'formatoptions' & "vt" Vi compatible formatting
1802 'gdefault' + off no default 'g' flag for ":s"
1803 'history' & 0 no commandline history
1804 'hkmap' + off no Hebrew keyboard mapping
1805 'hkmapp' + off no phonetic Hebrew keyboard mapping
1806 'hlsearch' + off no highlighting of search matches
1807 'incsearch' + off no incremental searching
1808 'indentexpr' + "" no indenting by expression
1809 'insertmode' + off do not start in Insert mode
1810 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001812 'joinspaces' + on insert 2 spaces after period
1813 'modeline' & off no modelines
1814 'more' & off no pauses in listings
1815 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1816 'numberwidth' & 8 min number of columns for line number
1817 'preserveindent'+ off don't preserve current indent structure
1818 when changing it
1819 'revins' + off no reverse insert
1820 'ruler' + off no ruler
1821 'scrolljump' + 1 no jump scroll
1822 'scrolloff' + 0 no scroll offset
1823 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1824 'shiftround' + off indent not rounded to shiftwidth
1825 'shortmess' & "" no shortening of messages
1826 'showcmd' & off command characters not shown
1827 'showmode' & off current mode not shown
1828 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1829 'smartcase' + off no automatic ignore case switch
1830 'smartindent' + off no smart indentation
1831 'smarttab' + off no smart tab size
1832 'softtabstop' + 0 tabs are always 'tabstop' positions
1833 'startofline' + on goto startofline with some commands
1834 'tagcase' & "followic" 'ignorecase' when searching tags file
1835 'tagrelative' & off tag file names are not relative
1836 'termguicolors' + off don't use highlight-(guifg|guibg)
1837 'textauto' & off no automatic textmode detection
1838 'textwidth' + 0 no automatic line wrap
1839 'tildeop' + off tilde is not an operator
1840 'ttimeout' + off no terminal timeout
1841 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001842 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001843 'virtualedit' + "" cursor can only be placed on characters
1844 'whichwrap' & "" left-right movements don't wrap
1845 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001847 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848
1849 *'complete'* *'cpt'* *E535*
1850'complete' 'cpt' string (default: ".,w,b,u,t,i")
1851 local to buffer
1852 {not in Vi}
1853 This option specifies how keyword completion |ins-completion| works
1854 when CTRL-P or CTRL-N are used. It is also used for whole-line
1855 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1856 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001857 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858 w scan buffers from other windows
1859 b scan other loaded buffers that are in the buffer list
1860 u scan the unloaded buffers that are in the buffer list
1861 U scan the buffers that are not in the buffer list
1862 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001863 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864 k{dict} scan the file {dict}. Several "k" flags can be given,
1865 patterns are valid too. For example: >
1866 :set cpt=k/usr/dict/*,k~/spanish
1867< s scan the files given with the 'thesaurus' option
1868 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1869 are valid too.
1870 i scan current and included files
1871 d scan current and included files for defined name or macro
1872 |i_CTRL-X_CTRL-D|
1873 ] tag completion
1874 t same as "]"
1875
1876 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1877 not executed, this may lead to unexpected completions from some files
1878 (gzipped files for example). Unloaded buffers are not scanned for
1879 whole-line completion.
1880
1881 The default is ".,w,b,u,t,i", which means to scan:
1882 1. the current buffer
1883 2. buffers in other windows
1884 3. other loaded buffers
1885 4. unloaded buffers
1886 5. tags
1887 6. included files
1888
1889 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001890 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1891 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001893 *'completefunc'* *'cfu'*
1894'completefunc' 'cfu' string (default: empty)
1895 local to buffer
1896 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001897 {not available when compiled without the |+eval|
1898 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001899 This option specifies a function to be used for Insert mode completion
1900 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001901 See |complete-functions| for an explanation of how the function is
1902 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001903 This option cannot be set from a |modeline| or in the |sandbox|, for
1904 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001905
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001906 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001907'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001908 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001909 {not available when compiled without the
1910 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001911 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001912 A comma separated list of options for Insert mode completion
1913 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001914
1915 menu Use a popup menu to show the possible completions. The
1916 menu is only shown when there is more than one match and
1917 sufficient colors are available. |ins-completion-menu|
1918
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001919 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001920 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001921 match, e.g., what file it comes from.
1922
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001923 longest Only insert the longest common text of the matches. If
1924 the menu is displayed you can use CTRL-L to add more
1925 characters. Whether case is ignored depends on the kind
1926 of completion. For buffer text the 'ignorecase' option is
1927 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001928
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001929 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001930 completion in the preview window. Only works in
1931 combination with "menu" or "menuone".
1932
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001933 noinsert Do not insert any text for a match until the user selects
1934 a match from the menu. Only works in combination with
1935 "menu" or "menuone". No effect if "longest" is present.
1936
1937 noselect Do not select a match in the menu, force the user to
1938 select one from the menu. Only works in combination with
1939 "menu" or "menuone".
1940
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001941
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001942 *'concealcursor'* *'cocu'*
1943'concealcursor' 'cocu' string (default: "")
1944 local to window
1945 {not in Vi}
1946 {not available when compiled without the |+conceal|
1947 feature}
1948 Sets the modes in which text in the cursor line can also be concealed.
1949 When the current mode is listed then concealing happens just like in
1950 other lines.
1951 n Normal mode
1952 v Visual mode
1953 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001954 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001955
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001956 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001957 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001958 are moving around text is concealed, but when starting to insert text
1959 or selecting a Visual area the concealed text is displayed, so that
1960 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001961 Keep in mind that the cursor position is not always where it's
1962 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001963
1964
1965'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001966 number (default 0)
1967 local to window
1968 {not in Vi}
1969 {not available when compiled without the |+conceal|
1970 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001971 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1972 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001973
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001974 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001975 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001976 1 Each block of concealed text is replaced with one
1977 character. If the syntax item does not have a custom
1978 replacement character defined (see |:syn-cchar|) the
1979 character defined in 'listchars' is used (default is a
1980 space).
1981 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001982 2 Concealed text is completely hidden unless it has a
1983 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001984 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001985 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001986
Bram Moolenaara7781e02010-07-19 20:13:22 +02001987 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001988 edit and copy the text. This can be changed with the 'concealcursor'
1989 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001990
Bram Moolenaar071d4272004-06-13 20:20:40 +00001991 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1992'confirm' 'cf' boolean (default off)
1993 global
1994 {not in Vi}
1995 When 'confirm' is on, certain operations that would normally
1996 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1997 instead raise a |dialog| asking if you wish to save the current
1998 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1999 If 'confirm' is off you can still activate confirmation for one
2000 command only (this is most useful in mappings) with the |:confirm|
2001 command.
2002 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2003
2004 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2005'conskey' 'consk' boolean (default off)
2006 global
2007 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01002008 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009
2010 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2011'copyindent' 'ci' boolean (default off)
2012 local to buffer
2013 {not in Vi}
2014 Copy the structure of the existing lines indent when autoindenting a
2015 new line. Normally the new indent is reconstructed by a series of
2016 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2017 in which case only spaces are used). Enabling this option makes the
2018 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002019 existing line. 'expandtab' has no effect on these characters, a Tab
2020 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002022 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 Also see 'preserveindent'.
2024
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002025 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026'cpoptions' 'cpo' string (Vim default: "aABceFs",
2027 Vi default: all flags)
2028 global
2029 {not in Vi}
2030 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002031 this indicates Vi-compatible behavior. This is used for things where
2032 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 'cpoptions' stands for "compatible-options".
2034 Commas can be added for readability.
2035 To avoid problems with flags that are added in the future, use the
2036 "+=" and "-=" feature of ":set" |add-option-flags|.
2037 NOTE: This option is set to the Vi default value when 'compatible' is
2038 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002039 NOTE: This option is set to the POSIX default value at startup when
2040 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002041 variable exists |posix|. This means Vim tries to behave like the
2042 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043
2044 contains behavior ~
2045 *cpo-a*
2046 a When included, a ":read" command with a file name
2047 argument will set the alternate file name for the
2048 current window.
2049 *cpo-A*
2050 A When included, a ":write" command with a file name
2051 argument will set the alternate file name for the
2052 current window.
2053 *cpo-b*
2054 b "\|" in a ":map" command is recognized as the end of
2055 the map command. The '\' is included in the mapping,
2056 the text after the '|' is interpreted as the next
2057 command. Use a CTRL-V instead of a backslash to
2058 include the '|' in the mapping. Applies to all
2059 mapping, abbreviation, menu and autocmd commands.
2060 See also |map_bar|.
2061 *cpo-B*
2062 B A backslash has no special meaning in mappings,
2063 abbreviations and the "to" part of the menu commands.
2064 Remove this flag to be able to use a backslash like a
2065 CTRL-V. For example, the command ":map X \<Esc>"
2066 results in X being mapped to:
2067 'B' included: "\^[" (^[ is a real <Esc>)
2068 'B' excluded: "<Esc>" (5 characters)
2069 ('<' excluded in both cases)
2070 *cpo-c*
2071 c Searching continues at the end of any match at the
2072 cursor position, but not further than the start of the
2073 next line. When not present searching continues
2074 one character from the cursor position. With 'c'
2075 "abababababab" only gets three matches when repeating
2076 "/abab", without 'c' there are five matches.
2077 *cpo-C*
2078 C Do not concatenate sourced lines that start with a
2079 backslash. See |line-continuation|.
2080 *cpo-d*
2081 d Using "./" in the 'tags' option doesn't mean to use
2082 the tags file relative to the current file, but the
2083 tags file in the current directory.
2084 *cpo-D*
2085 D Can't use CTRL-K to enter a digraph after Normal mode
2086 commands with a character argument, like |r|, |f| and
2087 |t|.
2088 *cpo-e*
2089 e When executing a register with ":@r", always add a
2090 <CR> to the last line, also when the register is not
2091 linewise. If this flag is not present, the register
2092 is not linewise and the last line does not end in a
2093 <CR>, then the last line is put on the command-line
2094 and can be edited before hitting <CR>.
2095 *cpo-E*
2096 E It is an error when using "y", "d", "c", "g~", "gu" or
2097 "gU" on an Empty region. The operators only work when
2098 at least one character is to be operate on. Example:
2099 This makes "y0" fail in the first column.
2100 *cpo-f*
2101 f When included, a ":read" command with a file name
2102 argument will set the file name for the current buffer,
2103 if the current buffer doesn't have a file name yet.
2104 *cpo-F*
2105 F When included, a ":write" command with a file name
2106 argument will set the file name for the current
2107 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002108 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109 *cpo-g*
2110 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002111 *cpo-H*
2112 H When using "I" on a line with only blanks, insert
2113 before the last blank. Without this flag insert after
2114 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115 *cpo-i*
2116 i When included, interrupting the reading of a file will
2117 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002118 *cpo-I*
2119 I When moving the cursor up or down just after inserting
2120 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121 *cpo-j*
2122 j When joining lines, only add two spaces after a '.',
2123 not after '!' or '?'. Also see 'joinspaces'.
2124 *cpo-J*
2125 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002126 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 white space.
2128 *cpo-k*
2129 k Disable the recognition of raw key codes in
2130 mappings, abbreviations, and the "to" part of menu
2131 commands. For example, if <Key> sends ^[OA (where ^[
2132 is <Esc>), the command ":map X ^[OA" results in X
2133 being mapped to:
2134 'k' included: "^[OA" (3 characters)
2135 'k' excluded: "<Key>" (one key code)
2136 Also see the '<' flag below.
2137 *cpo-K*
2138 K Don't wait for a key code to complete when it is
2139 halfway a mapping. This breaks mapping <F1><F1> when
2140 only part of the second <F1> has been read. It
2141 enables cancelling the mapping by typing <F1><Esc>.
2142 *cpo-l*
2143 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002144 literally, only "\]", "\^", "\-" and "\\" are special.
2145 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2147 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002148 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 *cpo-L*
2150 L When the 'list' option is set, 'wrapmargin',
2151 'textwidth', 'softtabstop' and Virtual Replace mode
2152 (see |gR|) count a <Tab> as two characters, instead of
2153 the normal behavior of a <Tab>.
2154 *cpo-m*
2155 m When included, a showmatch will always wait half a
2156 second. When not included, a showmatch will wait half
2157 a second or until a character is typed. |'showmatch'|
2158 *cpo-M*
2159 M When excluded, "%" matching will take backslashes into
2160 account. Thus in "( \( )" and "\( ( \)" the outer
2161 parenthesis match. When included "%" ignores
2162 backslashes, which is Vi compatible.
2163 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002164 n When included, the column used for 'number' and
2165 'relativenumber' will also be used for text of wrapped
2166 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167 *cpo-o*
2168 o Line offset to search command is not remembered for
2169 next search.
2170 *cpo-O*
2171 O Don't complain if a file is being overwritten, even
2172 when it didn't exist when editing it. This is a
2173 protection against a file unexpectedly created by
2174 someone else. Vi didn't complain about this.
2175 *cpo-p*
2176 p Vi compatible Lisp indenting. When not present, a
2177 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002178 *cpo-P*
2179 P When included, a ":write" command that appends to a
2180 file will set the file name for the current buffer, if
2181 the current buffer doesn't have a file name yet and
2182 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002183 *cpo-q*
2184 q When joining multiple lines leave the cursor at the
2185 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186 *cpo-r*
2187 r Redo ("." command) uses "/" to repeat a search
2188 command, instead of the actually used search string.
2189 *cpo-R*
2190 R Remove marks from filtered lines. Without this flag
2191 marks are kept like |:keepmarks| was used.
2192 *cpo-s*
2193 s Set buffer options when entering the buffer for the
2194 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002195 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196 set when the buffer is created.
2197 *cpo-S*
2198 S Set buffer options always when entering a buffer
2199 (except 'readonly', 'fileformat', 'filetype' and
2200 'syntax'). This is the (most) Vi compatible setting.
2201 The options are set to the values in the current
2202 buffer. When you change an option and go to another
2203 buffer, the value is copied. Effectively makes the
2204 buffer options global to all buffers.
2205
2206 's' 'S' copy buffer options
2207 no no when buffer created
2208 yes no when buffer first entered (default)
2209 X yes each time when buffer entered (vi comp.)
2210 *cpo-t*
2211 t Search pattern for the tag command is remembered for
2212 "n" command. Otherwise Vim only puts the pattern in
2213 the history for search pattern, but doesn't change the
2214 last used search pattern.
2215 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002216 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 *cpo-v*
2218 v Backspaced characters remain visible on the screen in
2219 Insert mode. Without this flag the characters are
2220 erased from the screen right away. With this flag the
2221 screen newly typed text overwrites backspaced
2222 characters.
2223 *cpo-w*
2224 w When using "cw" on a blank character, only change one
2225 character and not all blanks until the start of the
2226 next word.
2227 *cpo-W*
2228 W Don't overwrite a readonly file. When omitted, ":w!"
2229 overwrites a readonly file, if possible.
2230 *cpo-x*
2231 x <Esc> on the command-line executes the command-line.
2232 The default in Vim is to abandon the command-line,
2233 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002234 *cpo-X*
2235 X When using a count with "R" the replaced text is
2236 deleted only once. Also when repeating "R" with "."
2237 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002238 *cpo-y*
2239 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002240 *cpo-Z*
2241 Z When using "w!" while the 'readonly' option is set,
2242 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243 *cpo-!*
2244 ! When redoing a filter command, use the last used
2245 external command, whatever it was. Otherwise the last
2246 used -filter- command is used.
2247 *cpo-$*
2248 $ When making a change to one line, don't redisplay the
2249 line, but put a '$' at the end of the changed text.
2250 The changed text will be overwritten when you type the
2251 new text. The line is redisplayed if you type any
2252 command that moves the cursor from the insertion
2253 point.
2254 *cpo-%*
2255 % Vi-compatible matching is done for the "%" command.
2256 Does not recognize "#if", "#endif", etc.
2257 Does not recognize "/*" and "*/".
2258 Parens inside single and double quotes are also
2259 counted, causing a string that contains a paren to
2260 disturb the matching. For example, in a line like
2261 "if (strcmp("foo(", s))" the first paren does not
2262 match the last one. When this flag is not included,
2263 parens inside single and double quotes are treated
2264 specially. When matching a paren outside of quotes,
2265 everything inside quotes is ignored. When matching a
2266 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002267 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002268 This flag is also used for other features, such as
2269 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002270 *cpo--*
2271 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002272 it would go above the first line or below the last
2273 line. Without it the cursor moves to the first or
2274 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002275 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002276 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002277 *cpo-+*
2278 + When included, a ":write file" command will reset the
2279 'modified' flag of the buffer, even though the buffer
2280 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002281 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002282 * Use ":*" in the same way as ":@". When not included,
2283 ":*" is an alias for ":'<,'>", select the Visual area.
2284 *cpo-<*
2285 < Disable the recognition of special key codes in |<>|
2286 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002287 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288 ":map X <Tab>" results in X being mapped to:
2289 '<' included: "<Tab>" (5 characters)
2290 '<' excluded: "^I" (^I is a real <Tab>)
2291 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002292 *cpo->*
2293 > When appending to a register, put a line break before
2294 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002295 *cpo-;*
2296 ; When using |,| or |;| to repeat the last |t| search
2297 and the cursor is right in front of the searched
2298 character, the cursor won't move. When not included,
2299 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002300 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002301
2302 POSIX flags. These are not included in the Vi default value, except
2303 when $VIM_POSIX was set on startup. |posix|
2304
2305 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002306 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002307 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002308 *cpo-&*
2309 & When ":preserve" was used keep the swap file when
2310 exiting normally while this buffer is still loaded.
2311 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002312 *cpo-\*
2313 \ Backslash in a [] range in a search pattern is taken
2314 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002315 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2316 '\' excluded: "/[ \-]" finds <Space> and '-'
2317 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002318 *cpo-/*
2319 / When "%" is used as the replacement string in a |:s|
2320 command, use the previous replacement string. |:s%|
2321 *cpo-{*
2322 { The |{| and |}| commands also stop at a "{" character
2323 at the start of a line.
2324 *cpo-.*
2325 . The ":chdir" and ":cd" commands fail if the current
2326 buffer is modified, unless ! is used. Vim doesn't
2327 need this, since it remembers the full path of an
2328 opened file.
2329 *cpo-bar*
2330 | The value of the $LINES and $COLUMNS environment
2331 variables overrule the terminal size values obtained
2332 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002333
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002335 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002336'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002337 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002338 {not in Vi}
2339 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002340 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002341 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002342 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002343 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002344 blowfish Blowfish method. Medium strong encryption but it has
2345 an implementation flaw. Requires Vim 7.3 or later,
2346 files can NOT be read by Vim 7.2 and older. This adds
2347 a "seed" to the file, every time you write the file
2348 the encrypted bytes will be different.
2349 *blowfish2*
2350 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002351 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002352 and older. This adds a "seed" to the file, every time
2353 you write the file the encrypted bytes will be
2354 different. The whole undo file is encrypted, not just
2355 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002356
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002357 You should use "blowfish2", also to re-encrypt older files.
2358
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002359 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002360 to the detected method of the file being read. Thus if you write it
2361 without changing 'cryptmethod' the same method will be used.
2362 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002363 explicitly write it, you don't get a warning unless there are other
2364 modifications. Also see |:X|.
2365
2366 When setting the global value to an empty string, it will end up with
2367 the value "zip". When setting the local value to an empty string the
2368 buffer will use the global value.
2369
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002370 When a new encryption method is added in a later version of Vim, and
2371 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002372 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002373
2374
Bram Moolenaar071d4272004-06-13 20:20:40 +00002375 *'cscopepathcomp'* *'cspc'*
2376'cscopepathcomp' 'cspc' number (default 0)
2377 global
2378 {not available when compiled without the |+cscope|
2379 feature}
2380 {not in Vi}
2381 Determines how many components of the path to show in a list of tags.
2382 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002383 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384
2385 *'cscopeprg'* *'csprg'*
2386'cscopeprg' 'csprg' string (default "cscope")
2387 global
2388 {not available when compiled without the |+cscope|
2389 feature}
2390 {not in Vi}
2391 Specifies the command to execute cscope. See |cscopeprg|.
2392 This option cannot be set from a |modeline| or in the |sandbox|, for
2393 security reasons.
2394
2395 *'cscopequickfix'* *'csqf'*
2396'cscopequickfix' 'csqf' string (default "")
2397 global
2398 {not available when compiled without the |+cscope|
2399 or |+quickfix| features}
2400 {not in Vi}
2401 Specifies whether to use quickfix window to show cscope results.
2402 See |cscopequickfix|.
2403
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002404 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002405'cscoperelative' 'csre' boolean (default off)
2406 global
2407 {not available when compiled without the |+cscope|
2408 feature}
2409 {not in Vi}
2410 In the absence of a prefix (-P) for cscope. setting this option enables
2411 to use the basename of cscope.out path as the prefix.
2412 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002413 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002414
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2416'cscopetag' 'cst' boolean (default off)
2417 global
2418 {not available when compiled without the |+cscope|
2419 feature}
2420 {not in Vi}
2421 Use cscope for tag commands. See |cscope-options|.
2422 NOTE: This option is reset when 'compatible' is set.
2423
2424 *'cscopetagorder'* *'csto'*
2425'cscopetagorder' 'csto' number (default 0)
2426 global
2427 {not available when compiled without the |+cscope|
2428 feature}
2429 {not in Vi}
2430 Determines the order in which ":cstag" performs a search. See
2431 |cscopetagorder|.
2432 NOTE: This option is set to 0 when 'compatible' is set.
2433
2434 *'cscopeverbose'* *'csverb'*
2435 *'nocscopeverbose'* *'nocsverb'*
2436'cscopeverbose' 'csverb' boolean (default off)
2437 global
2438 {not available when compiled without the |+cscope|
2439 feature}
2440 {not in Vi}
2441 Give messages when adding a cscope database. See |cscopeverbose|.
2442 NOTE: This option is reset when 'compatible' is set.
2443
Bram Moolenaar860cae12010-06-05 23:22:07 +02002444 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2445'cursorbind' 'crb' boolean (default off)
2446 local to window
2447 {not in Vi}
2448 {not available when compiled without the |+cursorbind|
2449 feature}
2450 When this option is set, as the cursor in the current
2451 window moves other cursorbound windows (windows that also have
2452 this option set) move their cursors to the corresponding line and
2453 column. This option is useful for viewing the
2454 differences between two versions of a file (see 'diff'); in diff mode,
2455 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002456 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002457
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002458
2459 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2460'cursorcolumn' 'cuc' boolean (default off)
2461 local to window
2462 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002463 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002464 feature}
2465 Highlight the screen column of the cursor with CursorColumn
2466 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2467 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002468 If you only want the highlighting in the current window you can use
2469 these autocommands: >
2470 au WinLeave * set nocursorline nocursorcolumn
2471 au WinEnter * set cursorline cursorcolumn
2472<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002473
2474 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2475'cursorline' 'cul' boolean (default off)
2476 local to window
2477 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002478 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002479 feature}
2480 Highlight the screen line of the cursor with CursorLine
2481 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2482 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002483 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002484 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002485
2486
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 *'debug'*
2488'debug' string (default "")
2489 global
2490 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002491 These values can be used:
2492 msg Error messages that would otherwise be omitted will be given
2493 anyway.
2494 throw Error messages that would otherwise be omitted will be given
2495 anyway and also throw an exception and set |v:errmsg|.
2496 beep A message will be given when otherwise only a beep would be
2497 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002498 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002499 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2500 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501
2502 *'define'* *'def'*
2503'define' 'def' string (default "^\s*#\s*define")
2504 global or local to buffer |global-local|
2505 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002506 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507 pattern, just like for the "/" command. This option is used for the
2508 commands like "[i" and "[d" |include-search|. The 'isident' option is
2509 used to recognize the defined name after the match:
2510 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2511 See |option-backslash| about inserting backslashes to include a space
2512 or backslash.
2513 The default value is for C programs. For C++ this value would be
2514 useful, to include const type declarations: >
2515 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2516< When using the ":set" command, you need to double the backslashes!
2517
2518 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2519'delcombine' 'deco' boolean (default off)
2520 global
2521 {not in Vi}
2522 {only available when compiled with the |+multi_byte|
2523 feature}
2524 If editing Unicode and this option is set, backspace and Normal mode
2525 "x" delete each combining character on its own. When it is off (the
2526 default) the character along with its combining characters are
2527 deleted.
2528 Note: When 'delcombine' is set "xx" may work different from "2x"!
2529
2530 This is useful for Arabic, Hebrew and many other languages where one
2531 may have combining characters overtop of base characters, and want
2532 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002533 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534
2535 *'dictionary'* *'dict'*
2536'dictionary' 'dict' string (default "")
2537 global or local to buffer |global-local|
2538 {not in Vi}
2539 List of file names, separated by commas, that are used to lookup words
2540 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2541 contain a list of words. This can be one word per line, or several
2542 words per line, separated by non-keyword characters (white space is
2543 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002544 When this option is empty, or an entry "spell" is present, spell
2545 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002546 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 after a comma are ignored, otherwise spaces are included in the file
2548 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002549 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 Where to find a list of words?
2551 - On FreeBSD, there is the file "/usr/share/dict/words".
2552 - In the Simtel archive, look in the "msdos/linguist" directory.
2553 - In "miscfiles" of the GNU collection.
2554 The use of |:set+=| and |:set-=| is preferred when adding or removing
2555 directories from the list. This avoids problems when a future version
2556 uses another default.
2557 Backticks cannot be used in this option for security reasons.
2558
2559 *'diff'* *'nodiff'*
2560'diff' boolean (default off)
2561 local to window
2562 {not in Vi}
2563 {not available when compiled without the |+diff|
2564 feature}
2565 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002566 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567
2568 *'dex'* *'diffexpr'*
2569'diffexpr' 'dex' string (default "")
2570 global
2571 {not in Vi}
2572 {not available when compiled without the |+diff|
2573 feature}
2574 Expression which is evaluated to obtain an ed-style diff file from two
2575 versions of a file. See |diff-diffexpr|.
2576 This option cannot be set from a |modeline| or in the |sandbox|, for
2577 security reasons.
2578
2579 *'dip'* *'diffopt'*
2580'diffopt' 'dip' string (default "filler")
2581 global
2582 {not in Vi}
2583 {not available when compiled without the |+diff|
2584 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002585 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586 All are optional. Items must be separated by a comma.
2587
2588 filler Show filler lines, to keep the text
2589 synchronized with a window that has inserted
2590 lines at the same position. Mostly useful
2591 when windows are side-by-side and 'scrollbind'
2592 is set.
2593
2594 context:{n} Use a context of {n} lines between a change
2595 and a fold that contains unchanged lines.
2596 When omitted a context of six lines is used.
2597 See |fold-diff|.
2598
2599 icase Ignore changes in case of text. "a" and "A"
2600 are considered the same. Adds the "-i" flag
2601 to the "diff" command if 'diffexpr' is empty.
2602
2603 iwhite Ignore changes in amount of white space. Adds
2604 the "-b" flag to the "diff" command if
2605 'diffexpr' is empty. Check the documentation
2606 of the "diff" command for what this does
2607 exactly. It should ignore adding trailing
2608 white space, but not leading white space.
2609
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002610 horizontal Start diff mode with horizontal splits (unless
2611 explicitly specified otherwise).
2612
2613 vertical Start diff mode with vertical splits (unless
2614 explicitly specified otherwise).
2615
2616 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2617 starting diff mode. Without this 2 is used.
2618
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619 Examples: >
2620
2621 :set diffopt=filler,context:4
2622 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002623 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624<
2625 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2626'digraph' 'dg' boolean (default off)
2627 global
2628 {not in Vi}
2629 {not available when compiled without the |+digraphs|
2630 feature}
2631 Enable the entering of digraphs in Insert mode with {char1} <BS>
2632 {char2}. See |digraphs|.
2633 NOTE: This option is reset when 'compatible' is set.
2634
2635 *'directory'* *'dir'*
2636'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002637 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638 for Unix: ".,~/tmp,/var/tmp,/tmp")
2639 global
2640 List of directory names for the swap file, separated with commas.
2641 - The swap file will be created in the first directory where this is
2642 possible.
2643 - Empty means that no swap file will be used (recovery is
2644 impossible!).
2645 - A directory "." means to put the swap file in the same directory as
2646 the edited file. On Unix, a dot is prepended to the file name, so
2647 it doesn't show in a directory listing. On MS-Windows the "hidden"
2648 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002649 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002650 put the swap file relative to where the edited file is. The leading
2651 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002652 - For Unix and Win32, if a directory ends in two path separators "//"
2653 or "\\", the swap file name will be built from the complete path to
2654 the file with all path separators substituted to percent '%' signs.
2655 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002656 On Win32, when a separating comma is following, you must use "//",
2657 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658 - Spaces after the comma are ignored, other spaces are considered part
2659 of the directory name. To have a space at the start of a directory
2660 name, precede it with a backslash.
2661 - To include a comma in a directory name precede it with a backslash.
2662 - A directory name may end in an ':' or '/'.
2663 - Environment variables are expanded |:set_env|.
2664 - Careful with '\' characters, type one before a space, type two to
2665 get one in the option (see |option-backslash|), for example: >
2666 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2667< - For backwards compatibility with Vim version 3.0 a '>' at the start
2668 of the option is removed.
2669 Using "." first in the list is recommended. This means that editing
2670 the same file twice will result in a warning. Using "/tmp" on Unix is
2671 discouraged: When the system crashes you lose the swap file.
2672 "/var/tmp" is often not cleared when rebooting, thus is a better
2673 choice than "/tmp". But it can contain a lot of files, your swap
2674 files get lost in the crowd. That is why a "tmp" directory in your
2675 home directory is tried first.
2676 The use of |:set+=| and |:set-=| is preferred when adding or removing
2677 directories from the list. This avoids problems when a future version
2678 uses another default.
2679 This option cannot be set from a |modeline| or in the |sandbox|, for
2680 security reasons.
2681 {Vi: directory to put temp file in, defaults to "/tmp"}
2682
2683 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002684'display' 'dy' string (default "", set to "truncate" in
2685 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 global
2687 {not in Vi}
2688 Change the way text is displayed. This is comma separated list of
2689 flags:
2690 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002691 in a window will be displayed. "@@@" is put in the
2692 last columns of the last screen line to indicate the
2693 rest of the line is not displayed.
2694 truncate Like "lastline", but "@@@" is displayed in the first
2695 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696 uhex Show unprintable characters hexadecimal as <xx>
2697 instead of using ^C and ~C.
2698
Bram Moolenaard0796902016-09-16 20:02:31 +02002699 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002700 doesn't fit is replaced with "@" lines.
2701
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 *'eadirection'* *'ead'*
2703'eadirection' 'ead' string (default "both")
2704 global
2705 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002706 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707 feature}
2708 Tells when the 'equalalways' option applies:
2709 ver vertically, width of windows is not affected
2710 hor horizontally, height of windows is not affected
2711 both width and height of windows is affected
2712
2713 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2714'edcompatible' 'ed' boolean (default off)
2715 global
2716 Makes the 'g' and 'c' flags of the ":substitute" command to be
2717 toggled each time the flag is given. See |complex-change|. See
2718 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002719 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720
Bram Moolenaar03413f42016-04-12 21:07:15 +02002721 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002722'emoji' 'emo' boolean (default: on)
2723 global
2724 {not in Vi}
2725 {only available when compiled with the |+multi_byte|
2726 feature}
2727 When on all Unicode emoji characters are considered to be full width.
2728
2729
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 *'encoding'* *'enc'* *E543*
2731'encoding' 'enc' string (default: "latin1" or value from $LANG)
2732 global
2733 {only available when compiled with the |+multi_byte|
2734 feature}
2735 {not in Vi}
2736 Sets the character encoding used inside Vim. It applies to text in
2737 the buffers, registers, Strings in expressions, text stored in the
2738 viminfo file, etc. It sets the kind of characters which Vim can work
2739 with. See |encoding-names| for the possible values.
2740
2741 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002742 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002744 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745
Bram Moolenaar865242e2010-07-14 21:12:05 +02002746 This option cannot be set from a |modeline|. It would most likely
2747 corrupt the text.
2748
Bram Moolenaar3df01732017-02-17 22:47:16 +01002749 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2750 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 'encoding', "utf-8" is the natural choice for the environment and
2752 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002753 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 versions, and to avoid changing the encoding of newly created files
2755 without your knowledge (in case 'fileencodings' is empty).
2756
2757 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002758 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 iconv() or as specified with 'charconvert'.
2760
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002761 If you need to know whether 'encoding' is a multi-byte encoding, you
2762 can use: >
2763 if has("multi_byte_encoding")
2764<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 Normally 'encoding' will be equal to your current locale. This will
2766 be the default if Vim recognizes your environment settings. If
2767 'encoding' is not set to the current locale, 'termencoding' must be
2768 set to convert typed and displayed text. See |encoding-table|.
2769
2770 When you set this option, it fires the |EncodingChanged| autocommand
2771 event so that you can set up fonts if necessary.
2772
2773 When the option is set, the value is converted to lowercase. Thus
2774 you can set it with uppercase values too. Underscores are translated
2775 to '-' signs.
2776 When the encoding is recognized, it is changed to the standard name.
2777 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2778 "iso-8859-2" and "utf8" becomes "utf-8".
2779
2780 Note: "latin1" is also used when the encoding could not be detected.
2781 This only works when editing files in the same encoding! When the
2782 actual character set is not latin1, make sure 'fileencoding' and
2783 'fileencodings' are empty. When conversion is needed, switch to using
2784 utf-8.
2785
2786 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2787 You don't notice this while editing, but it does matter for the
2788 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2789 setting 'encoding' to one of these values instead of utf-8 only has
2790 effect for encoding used for files when 'fileencoding' is empty.
2791
Bram Moolenaar661b1822005-07-28 22:36:45 +00002792 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2793 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794
2795 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2796'endofline' 'eol' boolean (default on)
2797 local to buffer
2798 {not in Vi}
2799 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002800 is on, or 'fixeol' option is off, no <EOL> will be written for the
2801 last line in the file. This option is automatically set or reset when
2802 starting to edit a new file, depending on whether file has an <EOL>
2803 for the last line in the file. Normally you don't have to set or
2804 reset this option.
2805 When 'binary' is off and 'fixeol' is on the value is not used when
2806 writing the file. When 'binary' is on or 'fixeol' is off it is used
2807 to remember the presence of a <EOL> for the last line in the file, so
2808 that when you write the file the situation from the original file can
2809 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810
2811 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2812'equalalways' 'ea' boolean (default on)
2813 global
2814 {not in Vi}
2815 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002816 splitting or closing a window. This also happens the moment the
2817 option is switched on. When off, splitting a window will reduce the
2818 size of the current window and leave the other windows the same. When
2819 closing a window the extra lines are given to the window next to it
2820 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821 When mixing vertically and horizontally split windows, a minimal size
2822 is computed and some windows may be larger if there is room. The
2823 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002824 Changing the height and width of a window can be avoided by setting
2825 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002826 If a window size is specified when creating a new window sizes are
2827 currently not equalized (it's complicated, but may be implemented in
2828 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829
2830 *'equalprg'* *'ep'*
2831'equalprg' 'ep' string (default "")
2832 global or local to buffer |global-local|
2833 {not in Vi}
2834 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002835 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002836 or 'indentexpr'. When Vim was compiled without internal formatting,
2837 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002838 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 about including spaces and backslashes.
2840 This option cannot be set from a |modeline| or in the |sandbox|, for
2841 security reasons.
2842
2843 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2844'errorbells' 'eb' boolean (default off)
2845 global
2846 Ring the bell (beep or screen flash) for error messages. This only
2847 makes a difference for error messages, the bell will be used always
2848 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002849 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002850 screen flash or do nothing. See 'belloff' to finetune when to ring the
2851 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852
2853 *'errorfile'* *'ef'*
2854'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2855 others: "errors.err")
2856 global
2857 {not in Vi}
2858 {not available when compiled without the |+quickfix|
2859 feature}
2860 Name of the errorfile for the QuickFix mode (see |:cf|).
2861 When the "-q" command-line argument is used, 'errorfile' is set to the
2862 following argument. See |-q|.
2863 NOT used for the ":make" command. See 'makeef' for that.
2864 Environment variables are expanded |:set_env|.
2865 See |option-backslash| about including spaces and backslashes.
2866 This option cannot be set from a |modeline| or in the |sandbox|, for
2867 security reasons.
2868
2869 *'errorformat'* *'efm'*
2870'errorformat' 'efm' string (default is very long)
2871 global or local to buffer |global-local|
2872 {not in Vi}
2873 {not available when compiled without the |+quickfix|
2874 feature}
2875 Scanf-like description of the format for the lines in the error file
2876 (see |errorformat|).
2877
2878 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2879'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2880 global
2881 {not in Vi}
2882 Function keys that start with an <Esc> are recognized in Insert
2883 mode. When this option is off, the cursor and function keys cannot be
2884 used in Insert mode if they start with an <Esc>. The advantage of
2885 this is that the single <Esc> is recognized immediately, instead of
2886 after one second. Instead of resetting this option, you might want to
2887 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2888 when 'esckeys' is off, you can still map anything, but the cursor keys
2889 won't work by default.
2890 NOTE: This option is set to the Vi default value when 'compatible' is
2891 set and to the Vim default value when 'compatible' is reset.
2892
2893 *'eventignore'* *'ei'*
2894'eventignore' 'ei' string (default "")
2895 global
2896 {not in Vi}
2897 {not available when compiled without the |+autocmd|
2898 feature}
2899 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002900 When set to "all" or when "all" is one of the items, all autocommand
2901 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 Otherwise this is a comma separated list of event names. Example: >
2903 :set ei=WinEnter,WinLeave
2904<
2905 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2906'expandtab' 'et' boolean (default off)
2907 local to buffer
2908 {not in Vi}
2909 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002910 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2912 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002913 This option is reset when the 'paste' option is set and restored when
2914 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915 NOTE: This option is reset when 'compatible' is set.
2916
2917 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2918'exrc' 'ex' boolean (default off)
2919 global
2920 {not in Vi}
2921 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002922 directory.
2923
2924 Setting this option is a potential security leak. E.g., consider
2925 unpacking a package or fetching files from github, a .vimrc in there
2926 might be a trojan horse. BETTER NOT SET THIS OPTION!
2927 Instead, define an autocommand in your .vimrc to set options for a
2928 matching directory.
2929
2930 If you do switch this option on you should also consider setting the
2931 'secure' option (see |initialization|).
2932 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 This option cannot be set from a |modeline| or in the |sandbox|, for
2934 security reasons.
2935
2936 *'fileencoding'* *'fenc'* *E213*
2937'fileencoding' 'fenc' string (default: "")
2938 local to buffer
2939 {only available when compiled with the |+multi_byte|
2940 feature}
2941 {not in Vi}
2942 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002943
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002945 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 When 'fileencoding' is empty, the same value as 'encoding' will be
2947 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002948 No error will be given when the value is set, only when it is used,
2949 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002950 Conversion will also be done when 'encoding' and 'fileencoding' are
2951 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2952 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002954 'encoding' is "utf-8" or another Unicode encoding, conversion
2955 is most likely done in a way that the reverse conversion
2956 results in the same text. When 'encoding' is not "utf-8" some
2957 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002958
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 See 'encoding' for the possible values. Additionally, values may be
2960 specified that can be handled by the converter, see
2961 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002962
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 When reading a file 'fileencoding' will be set from 'fileencodings'.
2964 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002965 'fileencoding', use the |++enc| argument. One exception: when
2966 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002967 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002968
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2970 When the option is set, the value is converted to lowercase. Thus
2971 you can set it with uppercase values too. '_' characters are
2972 replaced with '-'. If a name is recognized from the list for
2973 'encoding', it is replaced by the standard name. For example
2974 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002975
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 When this option is set, after starting to edit a file, the 'modified'
2977 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002978
2979 Keep in mind that changing 'fenc' from a modeline happens
2980 AFTER the text has been read, thus it applies to when the file will be
2981 written. If you do set 'fenc' in a modeline, you might want to set
2982 'nomodified' to avoid not being able to ":q".
2983
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 This option can not be changed when 'modifiable' is off.
2985
2986 *'fe'*
2987 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002988 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 old short name was 'fe', which is no longer used.
2990
2991 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002992'fileencodings' 'fencs' string (default: "ucs-bom",
2993 "ucs-bom,utf-8,default,latin1" when
2994 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 global
2996 {only available when compiled with the |+multi_byte|
2997 feature}
2998 {not in Vi}
2999 This is a list of character encodings considered when starting to edit
3000 an existing file. When a file is read, Vim tries to use the first
3001 mentioned character encoding. If an error is detected, the next one
3002 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003003 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 an empty string, which means the value of 'encoding' is used.
3005 WARNING: Conversion can cause loss of information! When
3006 'encoding' is "utf-8" (or one of the other Unicode variants)
3007 conversion is most likely done in a way that the reverse
3008 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003009 "utf-8" some non-ASCII characters may be lost! You can use
3010 the |++bad| argument to specify what is done with characters
3011 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 For an empty file or a file with only ASCII characters most encodings
3013 will work and the first entry of 'fileencodings' will be used (except
3014 "ucs-bom", which requires the BOM to be present). If you prefer
3015 another encoding use an BufReadPost autocommand event to test if your
3016 preferred encoding is to be used. Example: >
3017 au BufReadPost * if search('\S', 'w') == 0 |
3018 \ set fenc=iso-2022-jp | endif
3019< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3020 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003021 When the |++enc| argument is used then the value of 'fileencodings' is
3022 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003023 Note that 'fileencodings' is not used for a new file, the global value
3024 of 'fileencoding' is used instead. You can set it with: >
3025 :setglobal fenc=iso-8859-2
3026< This means that a non-existing file may get a different encoding than
3027 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 The special value "ucs-bom" can be used to check for a Unicode BOM
3029 (Byte Order Mark) at the start of the file. It must not be preceded
3030 by "utf-8" or another Unicode encoding for this to work properly.
3031 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3032 because Vim cannot detect an error, thus the encoding is always
3033 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003034 The special value "default" can be used for the encoding from the
3035 environment. This is the default value for 'encoding'. It is useful
3036 when 'encoding' is set to "utf-8" and your environment uses a
3037 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003038 When 'encoding' is "utf-8" and a file contains an illegal byte
3039 sequence it won't be recognized as UTF-8. You can use the |8g8|
3040 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 WRONG VALUES: WHAT'S WRONG:
3042 latin1,utf-8 "latin1" will always be used
3043 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3044 file
3045 cp1250,latin1 "cp1250" will always be used
3046 If 'fileencodings' is empty, 'fileencoding' is not modified.
3047 See 'fileencoding' for the possible values.
3048 Setting this option does not have an effect until the next time a file
3049 is read.
3050
3051 *'fileformat'* *'ff'*
3052'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3053 Unix default: "unix",
3054 Macintosh default: "mac")
3055 local to buffer
3056 {not in Vi}
3057 This gives the <EOL> of the current buffer, which is used for
3058 reading/writing the buffer from/to a file:
3059 dos <CR> <NL>
3060 unix <NL>
3061 mac <CR>
3062 When "dos" is used, CTRL-Z at the end of a file is ignored.
3063 See |file-formats| and |file-read|.
3064 For the character encoding of the file see 'fileencoding'.
3065 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003066 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 This option is set automatically when starting to edit a file and
3068 'fileformats' is not empty and 'binary' is off.
3069 When this option is set, after starting to edit a file, the 'modified'
3070 option is set, because the file would be different when written.
3071 This option can not be changed when 'modifiable' is off.
3072 For backwards compatibility: When this option is set to "dos",
3073 'textmode' is set, otherwise 'textmode' is reset.
3074
3075 *'fileformats'* *'ffs'*
3076'fileformats' 'ffs' string (default:
3077 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3078 Vim Unix: "unix,dos",
3079 Vim Mac: "mac,unix,dos",
3080 Vi Cygwin: "unix,dos",
3081 Vi others: "")
3082 global
3083 {not in Vi}
3084 This gives the end-of-line (<EOL>) formats that will be tried when
3085 starting to edit a new buffer and when reading a file into an existing
3086 buffer:
3087 - When empty, the format defined with 'fileformat' will be used
3088 always. It is not set automatically.
3089 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003090 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 'fileformats' name will be used when a file is read into an existing
3092 buffer, no matter what 'fileformat' for that buffer is set to.
3093 - When more than one name is present, separated by commas, automatic
3094 <EOL> detection will be done when reading a file. When starting to
3095 edit a file, a check is done for the <EOL>:
3096 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3097 'fileformat' is set to "dos".
3098 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003099 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003101 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3102 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003103 This means that "mac" is only chosen when:
3104 "unix" is not present or no <NL> is found in the file, and
3105 "dos" is not present or no <CR><NL> is found in the file.
3106 Except: if "unix" was chosen, but there is a <CR> before
3107 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003108 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 4. If 'fileformat' is still not set, the first name from
3110 'fileformats' is used.
3111 When reading a file into an existing buffer, the same is done, but
3112 this happens like 'fileformat' has been set appropriately for that
3113 file only, the option is not changed.
3114 When 'binary' is set, the value of 'fileformats' is not used.
3115
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003116 When Vim starts up with an empty buffer the first item is used. You
3117 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003118
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3120 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3121 done:
3122 - When 'fileformats' is empty, there is no automatic detection. Dos
3123 format will be used.
3124 - When 'fileformats' is set to one or more names, automatic detection
3125 is done. This is based on the first <NL> in the file: If there is a
3126 <CR> in front of it, Dos format is used, otherwise Unix format is
3127 used.
3128 Also see |file-formats|.
3129 For backwards compatibility: When this option is set to an empty
3130 string or one format (no comma is included), 'textauto' is reset,
3131 otherwise 'textauto' is set.
3132 NOTE: This option is set to the Vi default value when 'compatible' is
3133 set and to the Vim default value when 'compatible' is reset.
3134
Bram Moolenaarbf884932013-04-05 22:26:15 +02003135 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3136'fileignorecase' 'fic' boolean (default on for systems where case in file
3137 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003138 global
3139 {not in Vi}
3140 When set case is ignored when using file names and directories.
3141 See 'wildignorecase' for only ignoring case when doing completion.
3142
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 *'filetype'* *'ft'*
3144'filetype' 'ft' string (default: "")
3145 local to buffer
3146 {not in Vi}
3147 {not available when compiled without the |+autocmd|
3148 feature}
3149 When this option is set, the FileType autocommand event is triggered.
3150 All autocommands that match with the value of this option will be
3151 executed. Thus the value of 'filetype' is used in place of the file
3152 name.
3153 Otherwise this option does not always reflect the current file type.
3154 This option is normally set when the file type is detected. To enable
3155 this use the ":filetype on" command. |:filetype|
3156 Setting this option to a different value is most useful in a modeline,
3157 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003158 Example, for in an IDL file:
3159 /* vim: set filetype=idl : */ ~
3160 |FileType| |filetypes|
3161 When a dot appears in the value then this separates two filetype
3162 names. Example:
3163 /* vim: set filetype=c.doxygen : */ ~
3164 This will use the "c" filetype first, then the "doxygen" filetype.
3165 This works both for filetype plugins and for syntax files. More than
3166 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 This option is not copied to another buffer, independent of the 's' or
3168 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003169 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170
3171 *'fillchars'* *'fcs'*
3172'fillchars' 'fcs' string (default "vert:|,fold:-")
3173 global
3174 {not in Vi}
3175 {not available when compiled without the |+windows|
3176 and |+folding| features}
3177 Characters to fill the statuslines and vertical separators.
3178 It is a comma separated list of items:
3179
3180 item default Used for ~
3181 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003182 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 vert:c '|' vertical separators |:vsplit|
3184 fold:c '-' filling 'foldtext'
3185 diff:c '-' deleted lines of the 'diff' option
3186
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003187 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003188 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 otherwise.
3190
3191 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003192 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193< This is similar to the default, except that these characters will also
3194 be used when there is highlighting.
3195
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003196 for "stl" and "stlnc" only single-byte values are supported.
3197
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 The highlighting used for these items:
3199 item highlight group ~
3200 stl:c StatusLine |hl-StatusLine|
3201 stlnc:c StatusLineNC |hl-StatusLineNC|
3202 vert:c VertSplit |hl-VertSplit|
3203 fold:c Folded |hl-Folded|
3204 diff:c DiffDelete |hl-DiffDelete|
3205
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003206 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3207'fixendofline' 'fixeol' boolean (default on)
3208 local to buffer
3209 {not in Vi}
3210 When writing a file and this option is on, <EOL> at the end of file
3211 will be restored if missing. Turn this option off if you want to
3212 preserve the situation from the original file.
3213 When the 'binary' option is set the value of this option doesn't
3214 matter.
3215 See the 'endofline' option.
3216
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3218'fkmap' 'fk' boolean (default off) *E198*
3219 global
3220 {not in Vi}
3221 {only available when compiled with the |+rightleft|
3222 feature}
3223 When on, the keyboard is mapped for the Farsi character set.
3224 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003225 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226
3227 *'foldclose'* *'fcl'*
3228'foldclose' 'fcl' string (default "")
3229 global
3230 {not in Vi}
3231 {not available when compiled without the |+folding|
3232 feature}
3233 When set to "all", a fold is closed when the cursor isn't in it and
3234 its level is higher than 'foldlevel'. Useful if you want folds to
3235 automatically close when moving out of them.
3236
3237 *'foldcolumn'* *'fdc'*
3238'foldcolumn' 'fdc' number (default 0)
3239 local to window
3240 {not in Vi}
3241 {not available when compiled without the |+folding|
3242 feature}
3243 When non-zero, a column with the specified width is shown at the side
3244 of the window which indicates open and closed folds. The maximum
3245 value is 12.
3246 See |folding|.
3247
3248 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3249'foldenable' 'fen' boolean (default on)
3250 local to window
3251 {not in Vi}
3252 {not available when compiled without the |+folding|
3253 feature}
3254 When off, all folds are open. This option can be used to quickly
3255 switch between showing all text unfolded and viewing the text with
3256 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003257 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 'foldenable' is off.
3259 This option is set by commands that create a new fold or close a fold.
3260 See |folding|.
3261
3262 *'foldexpr'* *'fde'*
3263'foldexpr' 'fde' string (default: "0")
3264 local to window
3265 {not in Vi}
3266 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003267 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003269 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003270
Bram Moolenaar30b65812012-07-12 22:01:11 +02003271 The expression will be evaluated in the |sandbox| if set from a
3272 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003273 This option can't be set from a |modeline| when the 'diff' option is
3274 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003275
3276 It is not allowed to change text or jump to another window while
3277 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278
3279 *'foldignore'* *'fdi'*
3280'foldignore' 'fdi' string (default: "#")
3281 local to window
3282 {not in Vi}
3283 {not available when compiled without the |+folding|
3284 feature}
3285 Used only when 'foldmethod' is "indent". Lines starting with
3286 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003287 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 The default "#" works well for C programs. See |fold-indent|.
3289
3290 *'foldlevel'* *'fdl'*
3291'foldlevel' 'fdl' number (default: 0)
3292 local to window
3293 {not in Vi}
3294 {not available when compiled without the |+folding|
3295 feature}
3296 Sets the fold level: Folds with a higher level will be closed.
3297 Setting this option to zero will close all folds. Higher numbers will
3298 close fewer folds.
3299 This option is set by commands like |zm|, |zM| and |zR|.
3300 See |fold-foldlevel|.
3301
3302 *'foldlevelstart'* *'fdls'*
3303'foldlevelstart' 'fdls' number (default: -1)
3304 global
3305 {not in Vi}
3306 {not available when compiled without the |+folding|
3307 feature}
3308 Sets 'foldlevel' when starting to edit another buffer in a window.
3309 Useful to always start editing with all folds closed (value zero),
3310 some folds closed (one) or no folds closed (99).
3311 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003312 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 ignores this option and closes all folds.
3314 It is also done before BufReadPre autocommands, to allow an autocmd to
3315 overrule the 'foldlevel' value for specific files.
3316 When the value is negative, it is not used.
3317
3318 *'foldmarker'* *'fmr'* *E536*
3319'foldmarker' 'fmr' string (default: "{{{,}}}")
3320 local to window
3321 {not in Vi}
3322 {not available when compiled without the |+folding|
3323 feature}
3324 The start and end marker used when 'foldmethod' is "marker". There
3325 must be one comma, which separates the start and end marker. The
3326 marker is a literal string (a regular expression would be too slow).
3327 See |fold-marker|.
3328
3329 *'foldmethod'* *'fdm'*
3330'foldmethod' 'fdm' string (default: "manual")
3331 local to window
3332 {not in Vi}
3333 {not available when compiled without the |+folding|
3334 feature}
3335 The kind of folding used for the current window. Possible values:
3336 |fold-manual| manual Folds are created manually.
3337 |fold-indent| indent Lines with equal indent form a fold.
3338 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3339 |fold-marker| marker Markers are used to specify folds.
3340 |fold-syntax| syntax Syntax highlighting items specify folds.
3341 |fold-diff| diff Fold text that is not changed.
3342
3343 *'foldminlines'* *'fml'*
3344'foldminlines' 'fml' number (default: 1)
3345 local to window
3346 {not in Vi}
3347 {not available when compiled without the |+folding|
3348 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003349 Sets the number of screen lines above which a fold can be displayed
3350 closed. Also for manually closed folds. With the default value of
3351 one a fold can only be closed if it takes up two or more screen lines.
3352 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003353 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 "zc" to close a fold, which is displayed open because it's smaller
3355 than 'foldminlines', a following "zc" may close a containing fold.
3356
3357 *'foldnestmax'* *'fdn'*
3358'foldnestmax' 'fdn' number (default: 20)
3359 local to window
3360 {not in Vi}
3361 {not available when compiled without the |+folding|
3362 feature}
3363 Sets the maximum nesting of folds for the "indent" and "syntax"
3364 methods. This avoids that too many folds will be created. Using more
3365 than 20 doesn't work, because the internal limit is 20.
3366
3367 *'foldopen'* *'fdo'*
3368'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3369 search,tag,undo")
3370 global
3371 {not in Vi}
3372 {not available when compiled without the |+folding|
3373 feature}
3374 Specifies for which type of commands folds will be opened, if the
3375 command moves the cursor into a closed fold. It is a comma separated
3376 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003377 NOTE: When the command is part of a mapping this option is not used.
3378 Add the |zv| command to the mapping to get the same effect.
3379 (rationale: the mapping may want to control opening folds itself)
3380
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 item commands ~
3382 all any
3383 block "(", "{", "[[", "[{", etc.
3384 hor horizontal movements: "l", "w", "fx", etc.
3385 insert any command in Insert mode
3386 jump far jumps: "G", "gg", etc.
3387 mark jumping to a mark: "'m", CTRL-O, etc.
3388 percent "%"
3389 quickfix ":cn", ":crew", ":make", etc.
3390 search search for a pattern: "/", "n", "*", "gd", etc.
3391 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003392 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 tag jumping to a tag: ":ta", CTRL-T, etc.
3394 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 When a movement command is used for an operator (e.g., "dl" or "y%")
3396 this option is not used. This means the operator will include the
3397 whole closed fold.
3398 Note that vertical movements are not here, because it would make it
3399 very difficult to move onto a closed fold.
3400 In insert mode the folds containing the cursor will always be open
3401 when text is inserted.
3402 To close folds you can re-apply 'foldlevel' with the |zx| command or
3403 set the 'foldclose' option to "all".
3404
3405 *'foldtext'* *'fdt'*
3406'foldtext' 'fdt' string (default: "foldtext()")
3407 local to window
3408 {not in Vi}
3409 {not available when compiled without the |+folding|
3410 feature}
3411 An expression which is used to specify the text displayed for a closed
3412 fold. See |fold-foldtext|.
3413
Bram Moolenaar30b65812012-07-12 22:01:11 +02003414 The expression will be evaluated in the |sandbox| if set from a
3415 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003416
3417 It is not allowed to change text or jump to another window while
3418 evaluating 'foldtext' |textlock|.
3419
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003420 *'formatexpr'* *'fex'*
3421'formatexpr' 'fex' string (default "")
3422 local to buffer
3423 {not in Vi}
3424 {not available when compiled without the |+eval|
3425 feature}
3426 Expression which is evaluated to format a range of lines for the |gq|
3427 operator or automatic formatting (see 'formatoptions'). When this
3428 option is empty 'formatprg' is used.
3429
3430 The |v:lnum| variable holds the first line to be formatted.
3431 The |v:count| variable holds the number of lines to be formatted.
3432 The |v:char| variable holds the character that is going to be
3433 inserted if the expression is being evaluated due to
3434 automatic formatting. This can be empty. Don't insert
3435 it yet!
3436
3437 Example: >
3438 :set formatexpr=mylang#Format()
3439< This will invoke the mylang#Format() function in the
3440 autoload/mylang.vim file in 'runtimepath'. |autoload|
3441
3442 The expression is also evaluated when 'textwidth' is set and adding
3443 text beyond that limit. This happens under the same conditions as
3444 when internal formatting is used. Make sure the cursor is kept in the
3445 same spot relative to the text then! The |mode()| function will
3446 return "i" or "R" in this situation.
3447
3448 When the expression evaluates to non-zero Vim will fall back to using
3449 the internal format mechanism.
3450
3451 The expression will be evaluated in the |sandbox| when set from a
3452 modeline, see |sandbox-option|. That stops the option from working,
3453 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003454 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003455
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 *'formatoptions'* *'fo'*
3457'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3458 local to buffer
3459 {not in Vi}
3460 This is a sequence of letters which describes how automatic
3461 formatting is to be done. See |fo-table|. When the 'paste' option is
3462 on, no formatting is done (like 'formatoptions' is empty). Commas can
3463 be inserted for readability.
3464 To avoid problems with flags that are added in the future, use the
3465 "+=" and "-=" feature of ":set" |add-option-flags|.
3466 NOTE: This option is set to the Vi default value when 'compatible' is
3467 set and to the Vim default value when 'compatible' is reset.
3468
Bram Moolenaar86b68352004-12-27 21:59:20 +00003469 *'formatlistpat'* *'flp'*
3470'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3471 local to buffer
3472 {not in Vi}
3473 A pattern that is used to recognize a list header. This is used for
3474 the "n" flag in 'formatoptions'.
3475 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003476 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003477 while still checking more characters. There must be a character
3478 following the pattern, when it matches the whole line it is handled
3479 like there is no match.
3480 The default recognizes a number, followed by an optional punctuation
3481 character and white space.
3482
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 *'formatprg'* *'fp'*
3484'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003485 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 {not in Vi}
3487 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003488 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003490 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003491 If the 'formatexpr' option is not empty it will be used instead.
3492 Otherwise, if 'formatprg' option is an empty string, the internal
3493 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003494 Environment variables are expanded |:set_env|. See |option-backslash|
3495 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003496 This option cannot be set from a |modeline| or in the |sandbox|, for
3497 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498
Bram Moolenaard94464e2015-11-02 15:28:18 +01003499 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003500'fsync' 'fs' boolean (default on)
3501 global
3502 {not in Vi}
3503 When on, the library function fsync() will be called after writing a
3504 file. This will flush a file to disk, ensuring that it is safely
3505 written even on filesystems which do metadata-only journaling. This
3506 will force the harddrive to spin up on Linux systems running in laptop
3507 mode, so it may be undesirable in some situations. Be warned that
3508 turning this off increases the chances of data loss after a crash. On
3509 systems without an fsync() implementation, this variable is always
3510 off.
3511 Also see 'swapsync' for controlling fsync() on swap files.
3512
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3514'gdefault' 'gd' boolean (default off)
3515 global
3516 {not in Vi}
3517 When on, the ":substitute" flag 'g' is default on. This means that
3518 all matches in a line are substituted instead of one. When a 'g' flag
3519 is given to a ":substitute" command, this will toggle the substitution
3520 of all or one match. See |complex-change|.
3521
3522 command 'gdefault' on 'gdefault' off ~
3523 :s/// subst. all subst. one
3524 :s///g subst. one subst. all
3525 :s///gg subst. all subst. one
3526
3527 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003528 DEPRECATED: Setting this option may break plugins that are not aware
3529 of this option. Also, many users get confused that adding the /g flag
3530 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531
3532 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003533'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 global
3535 {not in Vi}
3536 Format to recognize for the ":grep" command output.
3537 This is a scanf-like string that uses the same format as the
3538 'errorformat' option: see |errorformat|.
3539
3540 *'grepprg'* *'gp'*
3541'grepprg' 'gp' string (default "grep -n ",
3542 Unix: "grep -n $* /dev/null",
3543 Win32: "findstr /n" or "grep -n",
3544 VMS: "SEARCH/NUMBERS ")
3545 global or local to buffer |global-local|
3546 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003547 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 and '#' characters, which are expanded like when used in a command-
3549 line. The placeholder "$*" is allowed to specify where the arguments
3550 will be included. Environment variables are expanded |:set_env|. See
3551 |option-backslash| about including spaces and backslashes.
3552 When your "grep" accepts the "-H" argument, use this to make ":grep"
3553 also work well with a single file: >
3554 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003555< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003556 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3557 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003558 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 apply equally to 'grepprg'.
3560 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3561 otherwise it's "grep -n".
3562 This option cannot be set from a |modeline| or in the |sandbox|, for
3563 security reasons.
3564
3565 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3566'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3567 ve:ver35-Cursor,
3568 o:hor50-Cursor,
3569 i-ci:ver25-Cursor/lCursor,
3570 r-cr:hor20-Cursor/lCursor,
3571 sm:block-Cursor
3572 -blinkwait175-blinkoff150-blinkon175",
3573 for MS-DOS and Win32 console:
3574 "n-v-c:block,o:hor50,i-ci:hor15,
3575 r-cr:hor30,sm:block")
3576 global
3577 {not in Vi}
3578 {only available when compiled with GUI enabled, and
3579 for MS-DOS and Win32 console}
3580 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003581 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 the height of the cursor can be changed. This can be done by
3583 specifying a block cursor, or a percentage for a vertical or
3584 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003585 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3586 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003588 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 mode-list and an argument-list:
3590 mode-list:argument-list,mode-list:argument-list,..
3591 The mode-list is a dash separated list of these modes:
3592 n Normal mode
3593 v Visual mode
3594 ve Visual mode with 'selection' "exclusive" (same as 'v',
3595 if not specified)
3596 o Operator-pending mode
3597 i Insert mode
3598 r Replace mode
3599 c Command-line Normal (append) mode
3600 ci Command-line Insert mode
3601 cr Command-line Replace mode
3602 sm showmatch in Insert mode
3603 a all modes
3604 The argument-list is a dash separated list of these arguments:
3605 hor{N} horizontal bar, {N} percent of the character height
3606 ver{N} vertical bar, {N} percent of the character width
3607 block block cursor, fills the whole character
3608 [only one of the above three should be present]
3609 blinkwait{N} *cursor-blinking*
3610 blinkon{N}
3611 blinkoff{N}
3612 blink times for cursor: blinkwait is the delay before
3613 the cursor starts blinking, blinkon is the time that
3614 the cursor is shown and blinkoff is the time that the
3615 cursor is not shown. The times are in msec. When one
3616 of the numbers is zero, there is no blinking. The
3617 default is: "blinkwait700-blinkon400-blinkoff250".
3618 These numbers are used for a missing entry. This
3619 means that blinking is enabled by default. To switch
3620 blinking off you can use "blinkon0". The cursor only
3621 blinks when Vim is waiting for input, not while
3622 executing a command.
3623 To make the cursor blink in an xterm, see
3624 |xterm-blink|.
3625 {group-name}
3626 a highlight group name, that sets the color and font
3627 for the cursor
3628 {group-name}/{group-name}
3629 Two highlight group names, the first is used when
3630 no language mappings are used, the other when they
3631 are. |language-mapping|
3632
3633 Examples of parts:
3634 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3635 block cursor with colors from the "nCursor"
3636 highlight group
3637 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3638 In Insert and Command-line Insert mode, use a
3639 30% vertical bar cursor with colors from the
3640 "iCursor" highlight group. Blink a bit
3641 faster.
3642
3643 The 'a' mode is different. It will set the given argument-list for
3644 all modes. It does not reset anything to defaults. This can be used
3645 to do a common setting for all modes. For example, to switch off
3646 blinking: "a:blinkon0"
3647
3648 Examples of cursor highlighting: >
3649 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3650 :highlight Cursor gui=NONE guifg=bg guibg=fg
3651<
3652 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003653 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654'guifont' 'gfn' string (default "")
3655 global
3656 {not in Vi}
3657 {only available when compiled with GUI enabled}
3658 This is a list of fonts which will be used for the GUI version of Vim.
3659 In its simplest form the value is just one font name. When
3660 the font cannot be found you will get an error message. To try other
3661 font names a list can be specified, font names separated with commas.
3662 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003663
Bram Moolenaar05159a02005-02-26 23:04:13 +00003664 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3665 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003666
Bram Moolenaar3df01732017-02-17 22:47:16 +01003667 Note: As to the GTK GUIs, no error is given against any invalid names,
3668 and the first element of the list is always picked up and made use of.
3669 This is because, instead of identifying a given name with a font, the
3670 GTK GUIs use it to construct a pattern and try to look up a font which
3671 best matches the pattern among available fonts, and this way, the
3672 matching never fails. An invalid name doesn't matter because a number
3673 of font properties other than name will do to get the matching done.
3674
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 Spaces after a comma are ignored. To include a comma in a font name
3676 precede it with a backslash. Setting an option requires an extra
3677 backslash before a space and a backslash. See also
3678 |option-backslash|. For example: >
3679 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003680< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003682
3683 If none of the fonts can be loaded, Vim will keep the current setting.
3684 If an empty font list is given, Vim will try using other resource
3685 settings (for X, it will use the Vim.font resource), and finally it
3686 will try some builtin default which should always be there ("7x13" in
3687 the case of X). The font names given should be "normal" fonts. Vim
3688 will try to find the related bold and italic fonts.
3689
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003690 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003691 :set guifont=*
3692< will bring up a font requester, where you can pick the font you want.
3693
3694 The font name depends on the GUI used. See |setting-guifont| for a
3695 way to set 'guifont' for various systems.
3696
Bram Moolenaar3df01732017-02-17 22:47:16 +01003697 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003699< That's all. XLFDs are not used. For Chinese this is reported to work
3700 well: >
3701 if has("gui_gtk2")
3702 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3703 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3704 endif
3705<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003706 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3707
Bram Moolenaar05159a02005-02-26 23:04:13 +00003708 For Mac OSX you can use something like this: >
3709 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003710< Also see 'macatsui', it can help fix display problems.
3711 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003713 width). An exception is GTK: all fonts are accepted, but mono-spaced
3714 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003715
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 To preview a font on X11, you might be able to use the "xfontsel"
3717 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003718
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 For the Win32 GUI *E244* *E245*
3720 - takes these options in the font name:
3721 hXX - height is XX (points, can be floating-point)
3722 wXX - width is XX (points, can be floating-point)
3723 b - bold
3724 i - italic
3725 u - underline
3726 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003727 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3729 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3730 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003731 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003732 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003733 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003734 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003735 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736
3737 Use a ':' to separate the options.
3738 - A '_' can be used in the place of a space, so you don't need to use
3739 backslashes to escape the spaces.
3740 - Examples: >
3741 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3742 :set guifont=Andale_Mono:h7.5:w4.5
3743< See also |font-sizes|.
3744
3745 *'guifontset'* *'gfs'*
3746 *E250* *E252* *E234* *E597* *E598*
3747'guifontset' 'gfs' string (default "")
3748 global
3749 {not in Vi}
3750 {only available when compiled with GUI enabled and
3751 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003752 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 When not empty, specifies two (or more) fonts to be used. The first
3754 one for normal English, the second one for your special language. See
3755 |xfontset|.
3756 Setting this option also means that all font names will be handled as
3757 a fontset name. Also the ones used for the "font" argument of the
3758 |:highlight| command.
3759 The fonts must match with the current locale. If fonts for the
3760 character sets that the current locale uses are not included, setting
3761 'guifontset' will fail.
3762 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3763 the comma-separated names are alternative names, one of which will be
3764 used. In 'guifontset' the whole string is one fontset name,
3765 including the commas. It is not possible to specify alternative
3766 fontset names.
3767 This example works on many X11 systems: >
3768 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3769<
3770 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3771'guifontwide' 'gfw' string (default "")
3772 global
3773 {not in Vi}
3774 {only available when compiled with GUI enabled}
3775 When not empty, specifies a comma-separated list of fonts to be used
3776 for double-width characters. The first font that can be loaded is
3777 used.
3778 Note: The size of these fonts must be exactly twice as wide as the one
3779 specified with 'guifont' and the same height.
3780
Bram Moolenaar3df01732017-02-17 22:47:16 +01003781 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782
3783 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3784 'guifontset' is empty or invalid.
3785 When 'guifont' is set and a valid font is found in it and
3786 'guifontwide' is empty Vim will attempt to find a matching
3787 double-width font and set 'guifontwide' to it.
3788
Bram Moolenaar3df01732017-02-17 22:47:16 +01003789 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790
3791 If set and valid, 'guifontwide' is always used for double width
3792 characters, even if 'encoding' is not set to "utf-8".
3793 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003794 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 font for characters not available in 'guifont'. Thus you do not need
3796 to set 'guifontwide' at all unless you want to override the choice
3797 made by Pango/Xft.
3798
Bram Moolenaar0f272122013-01-23 18:37:40 +01003799 Windows +multibyte only: *guifontwide_win_mbyte*
3800
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003801 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003802
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 *'guiheadroom'* *'ghr'*
3804'guiheadroom' 'ghr' number (default 50)
3805 global
3806 {not in Vi} {only for GTK and X11 GUI}
3807 The number of pixels subtracted from the screen height when fitting
3808 the GUI window on the screen. Set this before the GUI is started,
3809 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003810 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 lines will be left for window decorations and other items on the
3812 screen. Set it to a negative value to allow windows taller than the
3813 screen.
3814
3815 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003816'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3817 removed in |defaults.vim|),
3818 "aegimrLtT" (GTK, Motif and Athena),
3819 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 global
3821 {not in Vi}
3822 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003823 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 sequence of letters which describes what components and options of the
3825 GUI should be used.
3826 To avoid problems with flags that are added in the future, use the
3827 "+=" and "-=" feature of ":set" |add-option-flags|.
3828
3829 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003830 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831 'a' Autoselect: If present, then whenever VISUAL mode is started,
3832 or the Visual area extended, Vim tries to become the owner of
3833 the windowing system's global selection. This means that the
3834 Visually highlighted text is available for pasting into other
3835 applications as well as into Vim itself. When the Visual mode
3836 ends, possibly due to an operation on the text, or when an
3837 application wants to paste the selection, the highlighted text
3838 is automatically yanked into the "* selection register.
3839 Thus the selection is still available for pasting into other
3840 applications after the VISUAL mode has ended.
3841 If not present, then Vim won't become the owner of the
3842 windowing system's global selection unless explicitly told to
3843 by a yank or delete operation for the "* register.
3844 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003845 *'go-P'*
3846 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003847 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003848 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003849 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 applies to the modeless selection.
3851
3852 'guioptions' autoselect Visual autoselect modeless ~
3853 "" - -
3854 "a" yes yes
3855 "A" - yes
3856 "aA" yes yes
3857
Bram Moolenaar02467872007-05-06 13:22:01 +00003858 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 'c' Use console dialogs instead of popup dialogs for simple
3860 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003861 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003862 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003863 'guitablabel' can be used to change the text in the labels.
3864 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003865 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003866 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003867 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868 'f' Foreground: Don't use fork() to detach the GUI from the shell
3869 where it was started. Use this for programs that wait for the
3870 editor to finish (e.g., an e-mail program). Alternatively you
3871 can use "gvim -f" or ":gui -f" to start the GUI in the
3872 foreground. |gui-fork|
3873 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003874 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003875 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3877 corner of the window. It's black&white on non-GTK, because of
3878 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003879 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003881 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003882 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003884 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 file is sourced the system menu has already been loaded; the
3886 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003887 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 'g' Grey menu items: Make menu items that are not active grey. If
3889 'g' is not included inactive menu items are not shown at all.
3890 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003891 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003892 't' Include tearoff menu items. Currently only works for Win32,
3893 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003894 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003895 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003896 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003897 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003899 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 'R' Right-hand scrollbar is present when there is a vertically
3901 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003902 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003904 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 'L' Left-hand scrollbar is present when there is a vertically
3906 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003907 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3909 the longest visible line, or on the cursor line if the 'h'
3910 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003911 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 'h' Limit horizontal scrollbar size to the length of the cursor
3913 line. Reduces computations. |gui-horiz-scroll|
3914
3915 And yes, you may even have scrollbars on the left AND the right if
3916 you really want to :-). See |gui-scrollbars| for more information.
3917
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003918 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 'v' Use a vertical button layout for dialogs. When not included,
3920 a horizontal layout is preferred, but when it doesn't fit a
3921 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003922 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 'p' Use Pointer callbacks for X11 GUI. This is required for some
3924 window managers. If the cursor is not blinking or hollow at
3925 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003926 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003928 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003929 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930
Bram Moolenaar02467872007-05-06 13:22:01 +00003931
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 *'guipty'* *'noguipty'*
3933'guipty' boolean (default on)
3934 global
3935 {not in Vi}
3936 {only available when compiled with GUI enabled}
3937 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3938 I/O to/from shell commands. See |gui-pty|.
3939
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003940 *'guitablabel'* *'gtl'*
3941'guitablabel' 'gtl' string (default empty)
3942 global
3943 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003944 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003945 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003946 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003947 pages line. When empty and when the result is empty Vim will use a
3948 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003949
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003950 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003951 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003952 The expression will be evaluated in the |sandbox| when set from a
3953 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003954
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003955 Only used when the GUI tab pages line is displayed. 'e' must be
3956 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3957 used.
3958
Bram Moolenaar57657d82006-04-21 22:12:41 +00003959 *'guitabtooltip'* *'gtt'*
3960'guitabtooltip' 'gtt' string (default empty)
3961 global
3962 {not in Vi}
3963 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003964 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003965 When nonempty describes the text to use in a tooltip for the GUI tab
3966 pages line. When empty Vim will use a default tooltip.
3967 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003968 You can include a line break. Simplest method is to use |:let|: >
3969 :let &guitabtooltip = "line one\nline two"
3970<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003971
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 *'helpfile'* *'hf'*
3973'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3974 (others) "$VIMRUNTIME/doc/help.txt")
3975 global
3976 {not in Vi}
3977 Name of the main help file. All distributed help files should be
3978 placed together in one directory. Additionally, all "doc" directories
3979 in 'runtimepath' will be used.
3980 Environment variables are expanded |:set_env|. For example:
3981 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003982 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983 spaces and backslashes.
3984 This option cannot be set from a |modeline| or in the |sandbox|, for
3985 security reasons.
3986
3987 *'helpheight'* *'hh'*
3988'helpheight' 'hh' number (default 20)
3989 global
3990 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003991 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 feature}
3993 Minimal initial height of the help window when it is opened with the
3994 ":help" command. The initial height of the help window is half of the
3995 current window, or (when the 'ea' option is on) the same as other
3996 windows. When the height is less than 'helpheight', the height is
3997 set to 'helpheight'. Set to zero to disable.
3998
3999 *'helplang'* *'hlg'*
4000'helplang' 'hlg' string (default: messages language or empty)
4001 global
4002 {only available when compiled with the |+multi_lang|
4003 feature}
4004 {not in Vi}
4005 Comma separated list of languages. Vim will use the first language
4006 for which the desired help can be found. The English help will always
4007 be used as a last resort. You can add "en" to prefer English over
4008 another language, but that will only find tags that exist in that
4009 language and not in the English help.
4010 Example: >
4011 :set helplang=de,it
4012< This will first search German, then Italian and finally English help
4013 files.
4014 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4015 try to find the tag in the current language before using this option.
4016 See |help-translated|.
4017
4018 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4019'hidden' 'hid' boolean (default off)
4020 global
4021 {not in Vi}
4022 When off a buffer is unloaded when it is |abandon|ed. When on a
4023 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4024 displayed in another window, it does not become hidden, of course.
4025 The commands that move through the buffer list sometimes make a buffer
4026 hidden although the 'hidden' option is off: When the buffer is
4027 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004028 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004029 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 This option is set for one command with ":hide {command}" |:hide|.
4031 WARNING: It's easy to forget that you have changes in hidden buffers.
4032 Think twice when using ":q!" or ":qa!".
4033
4034 *'highlight'* *'hl'*
4035'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004036 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4037 d:Directory,e:ErrorMsg,i:IncSearch,
4038 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4039 N:CursorLineNr,r:Question,s:StatusLine,
4040 S:StatusLineNC,c:VertSplit,t:Title,
4041 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
4042 F:FoldColumn,A:DiffAdd,C:DiffChange,
4043 D:DiffDelete,T:DiffText,>:SignColumn,
4044 B:SpellBad,P:SpellCap,R:SpellRare,
4045 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004046 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4047 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004048 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004049 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050 global
4051 {not in Vi}
4052 This option can be used to set highlighting mode for various
4053 occasions. It is a comma separated list of character pairs. The
4054 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004055 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004057 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4058 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059 characters from 'showbreak'
4060 |hl-Directory| d directories in CTRL-D listing and other special
4061 things in listings
4062 |hl-ErrorMsg| e error messages
4063 h (obsolete, ignored)
4064 |hl-IncSearch| i 'incsearch' highlighting
4065 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4066 |hl-MoreMsg| m |more-prompt|
4067 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004068 |hl-LineNr| n line number for ":number" and ":#" commands, and
4069 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004070 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4071 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072 |hl-Question| r |hit-enter| prompt and yes/no questions
4073 |hl-StatusLine| s status line of current window |status-line|
4074 |hl-StatusLineNC| S status lines of not-current windows
4075 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4076 |hl-VertSplit| c column used to separate vertically split windows
4077 |hl-Visual| v Visual mode
4078 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4079 Selection" Only X11 Gui's |gui-x11| and
4080 |xterm-clipboard|.
4081 |hl-WarningMsg| w warning messages
4082 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4083 |hl-Folded| f line used for closed folds
4084 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004085 |hl-DiffAdd| A added line in diff mode
4086 |hl-DiffChange| C changed line in diff mode
4087 |hl-DiffDelete| D deleted line in diff mode
4088 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004090 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004091 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004092 |hl-SpellRare| R rare word |spell|
4093 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004094 |hl-Conceal| - the placeholders used for concealed characters
4095 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004096 |hl-Pmenu| + popup menu normal line
4097 |hl-PmenuSel| = popup menu normal line
4098 |hl-PmenuSbar| x popup menu scrollbar
4099 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100
4101 The display modes are:
4102 r reverse (termcap entry "mr" and "me")
4103 i italic (termcap entry "ZH" and "ZR")
4104 b bold (termcap entry "md" and "me")
4105 s standout (termcap entry "so" and "se")
4106 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004107 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004108 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 n no highlighting
4110 - no highlighting
4111 : use a highlight group
4112 The default is used for occasions that are not included.
4113 If you want to change what the display modes do, see |dos-colors|
4114 for an example.
4115 When using the ':' display mode, this must be followed by the name of
4116 a highlight group. A highlight group can be used to define any type
4117 of highlighting, including using color. See |:highlight| on how to
4118 define one. The default uses a different group for each occasion.
4119 See |highlight-default| for the default highlight groups.
4120
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004122'history' 'hi' number (Vim default: 50, Vi default: 0,
4123 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 global
4125 {not in Vi}
4126 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004127 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004129 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 NOTE: This option is set to the Vi default value when 'compatible' is
4131 set and to the Vim default value when 'compatible' is reset.
4132
4133 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4134'hkmap' 'hk' boolean (default off)
4135 global
4136 {not in Vi}
4137 {only available when compiled with the |+rightleft|
4138 feature}
4139 When on, the keyboard is mapped for the Hebrew character set.
4140 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4141 toggle this option. See |rileft.txt|.
4142 NOTE: This option is reset when 'compatible' is set.
4143
4144 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4145'hkmapp' 'hkp' boolean (default off)
4146 global
4147 {not in Vi}
4148 {only available when compiled with the |+rightleft|
4149 feature}
4150 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4151 This is useful if you have a non-Hebrew keyboard.
4152 See |rileft.txt|.
4153 NOTE: This option is reset when 'compatible' is set.
4154
Bram Moolenaar036986f2017-03-16 17:41:02 +01004155 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4156'hlsearch' 'hls' boolean (default off)
4157 global
4158 {not in Vi}
4159 {not available when compiled without the
4160 |+extra_search| feature}
4161 When there is a previous search pattern, highlight all its matches.
4162 The type of highlighting used can be set with the 'l' occasion in the
4163 'highlight' option. This uses the "Search" highlight group by
4164 default. Note that only the matching text is highlighted, any offsets
4165 are not applied.
4166 See also: 'incsearch' and |:match|.
4167 When you get bored looking at the highlighted matches, you can turn it
4168 off with |:nohlsearch|. This does not change the option value, as
4169 soon as you use a search command, the highlighting comes back.
4170 'redrawtime' specifies the maximum time spent on finding matches.
4171 When the search pattern can match an end-of-line, Vim will try to
4172 highlight all of the matched text. However, this depends on where the
4173 search starts. This will be the first line in the window or the first
4174 line below a closed fold. A match in a previous line which is not
4175 drawn may not continue in a newly drawn line.
4176 You can specify whether the highlight status is restored on startup
4177 with the 'h' flag in 'viminfo' |viminfo-h|.
4178 NOTE: This option is reset when 'compatible' is set.
4179
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 *'icon'* *'noicon'*
4181'icon' boolean (default off, on when title can be restored)
4182 global
4183 {not in Vi}
4184 {not available when compiled without the |+title|
4185 feature}
4186 When on, the icon text of the window will be set to the value of
4187 'iconstring' (if it is not empty), or to the name of the file
4188 currently being edited. Only the last part of the name is used.
4189 Overridden by the 'iconstring' option.
4190 Only works if the terminal supports setting window icons (currently
4191 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4192 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4193 builtin termcap).
4194 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004195 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004197 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198
4199 *'iconstring'*
4200'iconstring' string (default "")
4201 global
4202 {not in Vi}
4203 {not available when compiled without the |+title|
4204 feature}
4205 When this option is not empty, it will be used for the icon text of
4206 the window. This happens only when the 'icon' option is on.
4207 Only works if the terminal supports setting window icon text
4208 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4209 Does not work for MS Windows.
4210 When Vim was compiled with HAVE_X11 defined, the original icon will be
4211 restored if possible |X11|.
4212 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004213 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214 'titlestring' for example settings.
4215 {not available when compiled without the |+statusline| feature}
4216
4217 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4218'ignorecase' 'ic' boolean (default off)
4219 global
4220 Ignore case in search patterns. Also used when searching in the tags
4221 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004222 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 Can be overruled by using "\c" or "\C" in the pattern, see
4224 |/ignorecase|.
4225
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004226 *'imactivatefunc'* *'imaf'*
4227'imactivatefunc' 'imaf' string (default "")
4228 global
4229 {not in Vi}
4230 {only available when compiled with |+xim| and
4231 |+GUI_GTK|}
4232 This option specifies a function that will be called to
4233 activate/inactivate Input Method.
4234
4235 Example: >
4236 function ImActivateFunc(active)
4237 if a:active
4238 ... do something
4239 else
4240 ... do something
4241 endif
4242 " return value is not used
4243 endfunction
4244 set imactivatefunc=ImActivateFunc
4245<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246 *'imactivatekey'* *'imak'*
4247'imactivatekey' 'imak' string (default "")
4248 global
4249 {not in Vi}
4250 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004251 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252 Specifies the key that your Input Method in X-Windows uses for
4253 activation. When this is specified correctly, vim can fully control
4254 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4255 You can't use this option to change the activation key, the option
4256 tells Vim what the key is.
4257 Format:
4258 [MODIFIER_FLAG-]KEY_STRING
4259
4260 These characters can be used for MODIFIER_FLAG (case is ignored):
4261 S Shift key
4262 L Lock key
4263 C Control key
4264 1 Mod1 key
4265 2 Mod2 key
4266 3 Mod3 key
4267 4 Mod4 key
4268 5 Mod5 key
4269 Combinations are allowed, for example "S-C-space" or "SC-space" are
4270 both shift+ctrl+space.
4271 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4272
4273 Example: >
4274 :set imactivatekey=S-space
4275< "S-space" means shift+space. This is the activation key for kinput2 +
4276 canna (Japanese), and ami (Korean).
4277
4278 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4279'imcmdline' 'imc' boolean (default off)
4280 global
4281 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004282 {only available when compiled with the |+xim|,
4283 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 When set the Input Method is always on when starting to edit a command
4285 line, unless entering a search pattern (see 'imsearch' for that).
4286 Setting this option is useful when your input method allows entering
4287 English characters directly, e.g., when it's used to type accented
4288 characters with dead keys.
4289
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004290 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4292 global
4293 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004294 {only available when compiled with the |+xim|,
4295 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 When set the Input Method is never used. This is useful to disable
4297 the IM when it doesn't work properly.
4298 Currently this option is on by default for SGI/IRIX machines. This
4299 may change in later releases.
4300
4301 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004302'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 local to buffer
4304 {not in Vi}
4305 Specifies whether :lmap or an Input Method (IM) is to be used in
4306 Insert mode. Valid values:
4307 0 :lmap is off and IM is off
4308 1 :lmap is ON and IM is off
4309 2 :lmap is off and IM is ON
4310 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4311 or |global-ime|.
4312 To always reset the option to zero when leaving Insert mode with <Esc>
4313 this can be used: >
4314 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4315< This makes :lmap and IM turn off automatically when leaving Insert
4316 mode.
4317 Note that this option changes when using CTRL-^ in Insert mode
4318 |i_CTRL-^|.
4319 The value is set to 1 when setting 'keymap' to a valid keymap name.
4320 It is also used for the argument of commands like "r" and "f".
4321 The value 0 may not work correctly with Athena and Motif with some XIM
4322 methods. Use 'imdisable' to disable XIM then.
4323
4324 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004325'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 local to buffer
4327 {not in Vi}
4328 Specifies whether :lmap or an Input Method (IM) is to be used when
4329 entering a search pattern. Valid values:
4330 -1 the value of 'iminsert' is used, makes it look like
4331 'iminsert' is also used when typing a search pattern
4332 0 :lmap is off and IM is off
4333 1 :lmap is ON and IM is off
4334 2 :lmap is off and IM is ON
4335 Note that this option changes when using CTRL-^ in Command-line mode
4336 |c_CTRL-^|.
4337 The value is set to 1 when it is not -1 and setting the 'keymap'
4338 option to a valid keymap name.
4339 The value 0 may not work correctly with Athena and Motif with some XIM
4340 methods. Use 'imdisable' to disable XIM then.
4341
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004342 *'imstatusfunc'* *'imsf'*
4343'imstatusfunc' 'imsf' string (default "")
4344 global
4345 {not in Vi}
4346 {only available when compiled with |+xim| and
4347 |+GUI_GTK|}
4348 This option specifies a function that is called to obtain the status
4349 of Input Method. It must return a positive number when IME is active.
4350
4351 Example: >
4352 function ImStatusFunc()
4353 let is_active = ...do something
4354 return is_active ? 1 : 0
4355 endfunction
4356 set imstatusfunc=ImStatusFunc
4357<
4358 NOTE: This function is invoked very often. Keep it fast.
4359
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004360 *'imstyle'* *'imst'*
4361'imstyle' 'imst' number (default 1)
4362 global
4363 {not in Vi}
4364 {only available when compiled with |+xim| and
4365 |+GUI_GTK|}
4366 This option specifies the input style of Input Method.
4367 Set to zero if you want to use on-the-spot style.
4368 Set to one if you want to use over-the-spot style.
4369 See: |xim-input-style|
4370
4371 For a long time on-the-spot sytle had been used in GTK version of vim,
4372 however, it is known that it causes troubles when using mappings,
4373 |single-repeat|, etc. Therefore over-the-spot style becomes the
4374 default now. This should work fine for most people, however if you
4375 have any problem with it, try using on-the-spot style.
4376
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 *'include'* *'inc'*
4378'include' 'inc' string (default "^\s*#\s*include")
4379 global or local to buffer |global-local|
4380 {not in Vi}
4381 {not available when compiled without the
4382 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004383 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 pattern, just like for the "/" command (See |pattern|). The default
4385 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004386 "]I", "[d", etc.
4387 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004388 comes after the matched pattern. But if "\zs" appears in the pattern
4389 then the text matched from "\zs" to the end, or until "\ze" if it
4390 appears, is used as the file name. Use this to include characters
4391 that are not in 'isfname', such as a space. You can then use
4392 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004393 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394
4395 *'includeexpr'* *'inex'*
4396'includeexpr' 'inex' string (default "")
4397 local to buffer
4398 {not in Vi}
4399 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004400 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004402 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403 :set includeexpr=substitute(v:fname,'\\.','/','g')
4404< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004405
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004407 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 Also used for |<cfile>|.
4409
Bram Moolenaar30b65812012-07-12 22:01:11 +02004410 The expression will be evaluated in the |sandbox| when set from a
4411 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004412
4413 It is not allowed to change text or jump to another window while
4414 evaluating 'includeexpr' |textlock|.
4415
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004417'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4418 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 global
4420 {not in Vi}
4421 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004422 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004423 While typing a search command, show where the pattern, as it was typed
4424 so far, matches. The matched string is highlighted. If the pattern
4425 is invalid or not found, nothing is shown. The screen will be updated
4426 often, this is only useful on fast terminals.
4427 Note that the match will be shown, but the cursor will return to its
4428 original position when no match is found and when pressing <Esc>. You
4429 still need to finish the search command with <Enter> to move the
4430 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004431 You can use the CTRL-G and CTRL-T keys to move to the next and
4432 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004433 When compiled with the |+reltime| feature Vim only searches for about
4434 half a second. With a complicated pattern and/or a lot of text the
4435 match may not be found. This is to avoid that Vim hangs while you
4436 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004437 The highlighting can be set with the 'i' flag in 'highlight'.
4438 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004439 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004440 to the command line. If 'ignorecase' and 'smartcase' are set and the
4441 command line has no uppercase characters, the added character is
4442 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004443 CTRL-R CTRL-W can be used to add the word at the end of the current
4444 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445 NOTE: This option is reset when 'compatible' is set.
4446
4447 *'indentexpr'* *'inde'*
4448'indentexpr' 'inde' string (default "")
4449 local to buffer
4450 {not in Vi}
4451 {not available when compiled without the |+cindent|
4452 or |+eval| features}
4453 Expression which is evaluated to obtain the proper indent for a line.
4454 It is used when a new line is created, for the |=| operator and
4455 in Insert mode as specified with the 'indentkeys' option.
4456 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004457 'smartindent' indenting. When 'lisp' is set, this option is
4458 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459 When 'paste' is set this option is not used for indenting.
4460 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004461 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462 when the expression is evaluated (but it may be moved around).
4463 The expression must return the number of spaces worth of indent. It
4464 can return "-1" to keep the current indent (this means 'autoindent' is
4465 used for the indent).
4466 Functions useful for computing the indent are |indent()|, |cindent()|
4467 and |lispindent()|.
4468 The evaluation of the expression must not have side effects! It must
4469 not change the text, jump to another window, etc. Afterwards the
4470 cursor position is always restored, thus the cursor may be moved.
4471 Normally this option would be set to call a function: >
4472 :set indentexpr=GetMyIndent()
4473< Error messages will be suppressed, unless the 'debug' option contains
4474 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004475 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004476 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477
Bram Moolenaar30b65812012-07-12 22:01:11 +02004478 The expression will be evaluated in the |sandbox| when set from a
4479 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004480
4481 It is not allowed to change text or jump to another window while
4482 evaluating 'indentexpr' |textlock|.
4483
4484
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 *'indentkeys'* *'indk'*
4486'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4487 local to buffer
4488 {not in Vi}
4489 {not available when compiled without the |+cindent|
4490 feature}
4491 A list of keys that, when typed in Insert mode, cause reindenting of
4492 the current line. Only happens if 'indentexpr' isn't empty.
4493 The format is identical to 'cinkeys', see |indentkeys-format|.
4494 See |C-indenting| and |indent-expression|.
4495
4496 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4497'infercase' 'inf' boolean (default off)
4498 local to buffer
4499 {not in Vi}
4500 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004501 'ignorecase' is also on, the case of the match is adjusted depending
4502 on the typed text. If the typed text contains a lowercase letter
4503 where the match has an upper case letter, the completed part is made
4504 lowercase. If the typed text has no lowercase letters and the match
4505 has a lowercase letter where the typed text has an uppercase letter,
4506 and there is a letter before it, the completed part is made uppercase.
4507 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508
4509 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4510'insertmode' 'im' boolean (default off)
4511 global
4512 {not in Vi}
4513 Makes Vim work in a way that Insert mode is the default mode. Useful
4514 if you want to use Vim as a modeless editor. Used for |evim|.
4515 These Insert mode commands will be useful:
4516 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004517 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 this is a mapping, it is executed as if 'insertmode' was off.
4519 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004521 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4522 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523
4524 These items change when 'insertmode' is set:
4525 - when starting to edit of a file, Vim goes to Insert mode.
4526 - <Esc> in Insert mode is a no-op and beeps.
4527 - <Esc> in Normal mode makes Vim go to Insert mode.
4528 - CTRL-L in Insert mode is a command, it is not inserted.
4529 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4530 However, when <Esc> is used inside a mapping, it behaves like
4531 'insertmode' was not set. This was done to be able to use the same
4532 mappings with 'insertmode' set or not set.
4533 When executing commands with |:normal| 'insertmode' is not used.
4534
4535 NOTE: This option is reset when 'compatible' is set.
4536
4537 *'isfname'* *'isf'*
4538'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4539 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4540 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4541 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4542 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4543 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4544 global
4545 {not in Vi}
4546 The characters specified by this option are included in file names and
4547 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004548 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 Multi-byte characters 256 and above are always included, only the
4550 characters up to 255 are specified with this option.
4551 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004552 Think twice before adding white space to this option. Although a
4553 space may appear inside a file name, the effect will be that Vim
4554 doesn't know where a file name starts or ends when doing completion.
4555 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556
4557 Note that on systems using a backslash as path separator, Vim tries to
4558 do its best to make it work as you would expect. That is a bit
4559 tricky, since Vi originally used the backslash to escape special
4560 characters. Vim will not remove a backslash in front of a normal file
4561 name character on these systems, but it will on Unix and alikes. The
4562 '&' and '^' are not included by default, because these are special for
4563 cmd.exe.
4564
4565 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004566 Each part can be a single character number or a range. A range is two
4567 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568 decimal number between 0 and 255 or the ASCII character itself (does
4569 not work for digits). Example:
4570 "_,-,128-140,#-43" (include '_' and '-' and the range
4571 128 to 140 and '#' to 43)
4572 If a part starts with '^', the following character number or range
4573 will be excluded from the option. The option is interpreted from left
4574 to right. Put the excluded character after the range where it is
4575 included. To include '^' itself use it as the last character of the
4576 option or the end of a range. Example:
4577 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4578 If the character is '@', all characters where isalpha() returns TRUE
4579 are included. Normally these are the characters a to z and A to Z,
4580 plus accented characters. To include '@' itself use "@-@". Examples:
4581 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004582 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 "a-z,A-Z,@-@" All letters plus the '@' character.
4584 A comma can be included by using it where a character number is
4585 expected. Example:
4586 "48-57,,,_" Digits, comma and underscore.
4587 A comma can be excluded by prepending a '^'. Example:
4588 " -~,^,,9" All characters from space to '~', excluding
4589 comma, plus <Tab>.
4590 See |option-backslash| about including spaces and backslashes.
4591
4592 *'isident'* *'isi'*
4593'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4594 "@,48-57,_,128-167,224-235"
4595 otherwise: "@,48-57,_,192-255")
4596 global
4597 {not in Vi}
4598 The characters given by this option are included in identifiers.
4599 Identifiers are used in recognizing environment variables and after a
4600 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004601 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 option.
4603 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004604 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4606
4607 *'iskeyword'* *'isk'*
4608'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4609 "@,48-57,_,128-167,224-235"
4610 otherwise: "@,48-57,_,192-255"
4611 Vi default: "@,48-57,_")
4612 local to buffer
4613 {not in Vi}
4614 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004615 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 'isfname' for a description of the format of this option. For C
4617 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4618 For a help file it is set to all non-blank printable characters except
4619 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4620 command).
4621 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004622 This option also influences syntax highlighting, unless the syntax
4623 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 NOTE: This option is set to the Vi default value when 'compatible' is
4625 set and to the Vim default value when 'compatible' is reset.
4626
4627 *'isprint'* *'isp'*
4628'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4629 "@,~-255"; otherwise: "@,161-255")
4630 global
4631 {not in Vi}
4632 The characters given by this option are displayed directly on the
4633 screen. It is also used for "\p" in a |pattern|. The characters from
4634 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4635 even when they are not included in 'isprint' or excluded. See
4636 'isfname' for a description of the format of this option.
4637
4638 Non-printable characters are displayed with two characters:
4639 0 - 31 "^@" - "^_"
4640 32 - 126 always single characters
4641 127 "^?"
4642 128 - 159 "~@" - "~_"
4643 160 - 254 "| " - "|~"
4644 255 "~?"
4645 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4646 displayed as <xx>, with the hexadecimal value of the byte.
4647 When 'display' contains "uhex" all unprintable characters are
4648 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004649 The SpecialKey highlighting will be used for unprintable characters.
4650 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651
4652 Multi-byte characters 256 and above are always included, only the
4653 characters up to 255 are specified with this option. When a character
4654 is printable but it is not available in the current font, a
4655 replacement character will be shown.
4656 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4657 There is no option to specify these characters.
4658
4659 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4660'joinspaces' 'js' boolean (default on)
4661 global
4662 {not in Vi}
4663 Insert two spaces after a '.', '?' and '!' with a join command.
4664 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4665 Otherwise only one space is inserted.
4666 NOTE: This option is set when 'compatible' is set.
4667
4668 *'key'*
4669'key' string (default "")
4670 local to buffer
4671 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004672 {only available when compiled with the |+cryptv|
4673 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004674 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004675 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 Careful: Do not set the key value by hand, someone might see the typed
4677 key. Use the |:X| command. But you can make 'key' empty: >
4678 :set key=
4679< It is not possible to get the value of this option with ":set key" or
4680 "echo &key". This is to avoid showing it to someone who shouldn't
4681 know. It also means you cannot see it yourself once you have set it,
4682 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004683 You can use "&key" in an expression to detect whether encryption is
4684 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685
4686 *'keymap'* *'kmp'* *E544*
4687'keymap' 'kmp' string (default "")
4688 local to buffer
4689 {not in Vi}
4690 {only available when compiled with the |+keymap|
4691 feature}
4692 Name of a keyboard mapping. See |mbyte-keymap|.
4693 Setting this option to a valid keymap name has the side effect of
4694 setting 'iminsert' to one, so that the keymap becomes effective.
4695 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004696 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697
4698 *'keymodel'* *'km'*
4699'keymodel' 'km' string (default "")
4700 global
4701 {not in Vi}
4702 List of comma separated words, which enable special things that keys
4703 can do. These values can be used:
4704 startsel Using a shifted special key starts selection (either
4705 Select mode or Visual mode, depending on "key" being
4706 present in 'selectmode').
4707 stopsel Using a not-shifted special key stops selection.
4708 Special keys in this context are the cursor keys, <End>, <Home>,
4709 <PageUp> and <PageDown>.
4710 The 'keymodel' option is set by the |:behave| command.
4711
4712 *'keywordprg'* *'kp'*
4713'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004714 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 global or local to buffer |global-local|
4716 {not in Vi}
4717 Program to use for the |K| command. Environment variables are
4718 expanded |:set_env|. ":help" may be used to access the Vim internal
4719 help. (Note that previously setting the global option to the empty
4720 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004721 When the first character is ":", the command is invoked as a Vim
4722 Ex command prefixed with [count].
4723 When "man", "man -s" or an Ex command is used, Vim will automatically
4724 translate a count for the "K" command and pass it as the first
4725 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726 See |option-backslash| about including spaces and backslashes.
4727 Example: >
4728 :set keywordprg=man\ -s
4729< This option cannot be set from a |modeline| or in the |sandbox|, for
4730 security reasons.
4731
4732 *'langmap'* *'lmap'* *E357* *E358*
4733'langmap' 'lmap' string (default "")
4734 global
4735 {not in Vi}
4736 {only available when compiled with the |+langmap|
4737 feature}
4738 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004739 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004740 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 care of translating these special characters to the original meaning
4742 of the key. This means you don't have to change the keyboard mode to
4743 be able to execute Normal mode commands.
4744 This is the opposite of the 'keymap' option, where characters are
4745 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004746 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004747 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004748 This option cannot be set from a |modeline| or in the |sandbox|, for
4749 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004751 Example (for Greek, in UTF-8): *greek* >
4752 :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 +00004753< Example (exchanges meaning of z and y for commands): >
4754 :set langmap=zy,yz,ZY,YZ
4755<
4756 The 'langmap' option is a list of parts, separated with commas. Each
4757 part can be in one of two forms:
4758 1. A list of pairs. Each pair is a "from" character immediately
4759 followed by the "to" character. Examples: "aA", "aAbBcC".
4760 2. A list of "from" characters, a semi-colon and a list of "to"
4761 characters. Example: "abc;ABC"
4762 Example: "aA,fgh;FGH,cCdDeE"
4763 Special characters need to be preceded with a backslash. These are
4764 ";", ',' and backslash itself.
4765
4766 This will allow you to activate vim actions without having to switch
4767 back and forth between the languages. Your language characters will
4768 be understood as normal vim English characters (according to the
4769 langmap mappings) in the following cases:
4770 o Normal/Visual mode (commands, buffer/register names, user mappings)
4771 o Insert/Replace Mode: Register names after CTRL-R
4772 o Insert/Replace Mode: Mappings
4773 Characters entered in Command-line mode will NOT be affected by
4774 this option. Note that this option can be changed at any time
4775 allowing to switch between mappings for different languages/encodings.
4776 Use a mapping to avoid having to type it each time!
4777
4778 *'langmenu'* *'lm'*
4779'langmenu' 'lm' string (default "")
4780 global
4781 {not in Vi}
4782 {only available when compiled with the |+menu| and
4783 |+multi_lang| features}
4784 Language to use for menu translation. Tells which file is loaded
4785 from the "lang" directory in 'runtimepath': >
4786 "lang/menu_" . &langmenu . ".vim"
4787< (without the spaces). For example, to always use the Dutch menus, no
4788 matter what $LANG is set to: >
4789 :set langmenu=nl_NL.ISO_8859-1
4790< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004791 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 If your $LANG is set to a non-English language but you do want to use
4793 the English menus: >
4794 :set langmenu=none
4795< This option must be set before loading menus, switching on filetype
4796 detection or syntax highlighting. Once the menus are defined setting
4797 this option has no effect. But you could do this: >
4798 :source $VIMRUNTIME/delmenu.vim
4799 :set langmenu=de_DE.ISO_8859-1
4800 :source $VIMRUNTIME/menu.vim
4801< Warning: This deletes all menus that you defined yourself!
4802
Bram Moolenaard94464e2015-11-02 15:28:18 +01004803 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004804'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004805 global
4806 {not in Vi}
4807 {only available when compiled with the |+langmap|
4808 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004809 This is just like 'langremap' but with the value inverted. It only
4810 exists for backwards compatibility. When setting 'langremap' then
4811 'langnoremap' is set to the inverted value, and the other way around.
4812
4813 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4814'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4815 global
4816 {not in Vi}
4817 {only available when compiled with the |+langmap|
4818 feature}
4819 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004820 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004821 'langmap' disables some of your mappings, try resetting this option.
4822 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004823 that works for you to avoid mappings to break.
4824
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825 *'laststatus'* *'ls'*
4826'laststatus' 'ls' number (default 1)
4827 global
4828 {not in Vi}
4829 The value of this option influences when the last window will have a
4830 status line:
4831 0: never
4832 1: only if there are at least two windows
4833 2: always
4834 The screen looks nicer with a status line if you have several
4835 windows, but it takes another screen line. |status-line|
4836
4837 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4838'lazyredraw' 'lz' boolean (default off)
4839 global
4840 {not in Vi}
4841 When this option is set, the screen will not be redrawn while
4842 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004843 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 update use |:redraw|.
4845
4846 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4847'linebreak' 'lbr' boolean (default off)
4848 local to window
4849 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004850 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004852 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 than at the last character that fits on the screen. Unlike
4854 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004855 it only affects the way the file is displayed, not its contents.
4856 If 'breakindent' is set, line is visually indented. Then, the value
4857 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004858 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 Note that <Tab> characters after an <EOL> are mostly not displayed
4860 with the right amount of white space.
4861
4862 *'lines'* *E593*
4863'lines' number (default 24 or terminal height)
4864 global
4865 Number of lines of the Vim window.
4866 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004867 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868 When Vim is running in the GUI or in a resizable window, setting this
4869 option will cause the window size to be changed. When you only want
4870 to use the size for the GUI, put the command in your |gvimrc| file.
4871 Vim limits the number of lines to what fits on the screen. You can
4872 use this command to get the tallest window possible: >
4873 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004874< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004875 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876 When you set this option and Vim is unable to change the physical
4877 number of lines of the display, the display may be messed up.
4878
4879 *'linespace'* *'lsp'*
4880'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4881 global
4882 {not in Vi}
4883 {only in the GUI}
4884 Number of pixel lines inserted between characters. Useful if the font
4885 uses the full character cell height, making lines touch each other.
4886 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004887 With some fonts there can be too much room between lines (to have
4888 space for ascents and descents). Then it makes sense to set
4889 'linespace' to a negative value. This may cause display problems
4890 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891
4892 *'lisp'* *'nolisp'*
4893'lisp' boolean (default off)
4894 local to buffer
4895 {not available when compiled without the |+lispindent|
4896 feature}
4897 Lisp mode: When <Enter> is typed in insert mode set the indent for
4898 the next line to Lisp standards (well, sort of). Also happens with
4899 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4900 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4901 better. Also see 'lispwords'.
4902 The '-' character is included in keyword characters. Redefines the
4903 "=" operator to use this same indentation algorithm rather than
4904 calling an external program if 'equalprg' is empty.
4905 This option is not used when 'paste' is set.
4906 {Vi: Does it a little bit differently}
4907
4908 *'lispwords'* *'lw'*
4909'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004910 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911 {not in Vi}
4912 {not available when compiled without the |+lispindent|
4913 feature}
4914 Comma separated list of words that influence the Lisp indenting.
4915 |'lisp'|
4916
4917 *'list'* *'nolist'*
4918'list' boolean (default off)
4919 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004920 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4921 line. Useful to see the difference between tabs and spaces and for
4922 trailing blanks. Further changed by the 'listchars' option.
4923
4924 The cursor is displayed at the start of the space a Tab character
4925 occupies, not at the end as usual in Normal mode. To get this cursor
4926 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004927 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004928<
4929 Note that list mode will also affect formatting (set with 'textwidth'
4930 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 changing the way tabs are displayed.
4932
4933 *'listchars'* *'lcs'*
4934'listchars' 'lcs' string (default "eol:$")
4935 global
4936 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004937 Strings to use in 'list' mode and for the |:list| command. It is a
4938 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004939 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 eol:c Character to show at the end of each line. When
4941 omitted, there is no extra character at the end of the
4942 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004943 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004944 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004946 fill the space that the tab normally occupies.
4947 "tab:>-" will show a tab that takes four spaces as
4948 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004949 *lcs-space*
4950 space:c Character to show for a space. When omitted, spaces
4951 are left blank.
4952 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004953 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004954 trailing spaces are blank. Overrides the "space"
4955 setting for trailing spaces.
4956 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 extends:c Character to show in the last column, when 'wrap' is
4958 off and the line continues beyond the right of the
4959 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004960 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961 precedes:c Character to show in the first column, when 'wrap'
4962 is off and there is text preceding the character
4963 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004964 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004965 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004966 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004967 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004968 nbsp:c Character to show for a non-breakable space character
4969 (0xA0 (160 decimal) and U+202F). Left blank when
4970 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004971
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004972 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004974 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975
4976 Examples: >
4977 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004978 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 :set lcs=extends:>,precedes:<
4980< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004981 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004982 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983
4984 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4985'loadplugins' 'lpl' boolean (default on)
4986 global
4987 {not in Vi}
4988 When on the plugin scripts are loaded when starting up |load-plugins|.
4989 This option can be reset in your |vimrc| file to disable the loading
4990 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004991 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4992 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993
Bram Moolenaard94464e2015-11-02 15:28:18 +01004994 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004995'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004996 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004997 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01004998 {only available when compiled with the |+lua/dyn|
4999 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005000 Specifies the name of the Lua shared library. The default is
5001 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005002 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005003 This option cannot be set from a |modeline| or in the |sandbox|, for
5004 security reasons.
5005
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005006 *'macatsui'* *'nomacatsui'*
5007'macatsui' boolean (default on)
5008 global
5009 {only available in Mac GUI version}
5010 This is a workaround for when drawing doesn't work properly. When set
5011 and compiled with multi-byte support ATSUI text drawing is used. When
5012 not set ATSUI text drawing is not used. Switch this option off when
5013 you experience drawing problems. In a future version the problems may
5014 be solved and this option becomes obsolete. Therefore use this method
5015 to unset it: >
5016 if exists('&macatsui')
5017 set nomacatsui
5018 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00005019< Another option to check if you have drawing problems is
5020 'termencoding'.
5021
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022 *'magic'* *'nomagic'*
5023'magic' boolean (default on)
5024 global
5025 Changes the special characters that can be used in search patterns.
5026 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005027 WARNING: Switching this option off most likely breaks plugins! That
5028 is because many patterns assume it's on and will fail when it's off.
5029 Only switch it off when working with old Vi scripts. In any other
5030 situation write patterns that work when 'magic' is on. Include "\M"
5031 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005032
5033 *'makeef'* *'mef'*
5034'makeef' 'mef' string (default: "")
5035 global
5036 {not in Vi}
5037 {not available when compiled without the |+quickfix|
5038 feature}
5039 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5040 and the |:grep| command.
5041 When it is empty, an internally generated temp file will be used.
5042 When "##" is included, it is replaced by a number to make the name
5043 unique. This makes sure that the ":make" command doesn't overwrite an
5044 existing file.
5045 NOT used for the ":cf" command. See 'errorfile' for that.
5046 Environment variables are expanded |:set_env|.
5047 See |option-backslash| about including spaces and backslashes.
5048 This option cannot be set from a |modeline| or in the |sandbox|, for
5049 security reasons.
5050
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005051 *'makeencoding'* *'menc'*
5052'makeencoding' 'menc' string (default "")
5053 global or local to buffer |global-local|
5054 {only available when compiled with the |+multi_byte|
5055 feature}
5056 {not in Vi}
5057 Encoding used for reading the output of external commands. When empty,
5058 encoding is not converted.
5059 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5060 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5061 and `:laddfile`.
5062
5063 This would be mostly useful when you use MS-Windows and set 'encoding'
5064 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5065 'makeencoding' to "char" has the same effect as setting to the system
5066 locale encoding. Example: >
5067 :set encoding=utf-8
5068 :set makeencoding=char " system locale is used
5069<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070 *'makeprg'* *'mp'*
5071'makeprg' 'mp' string (default "make", VMS: "MMS")
5072 global or local to buffer |global-local|
5073 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005074 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01005075 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5076 which are expanded to the current and alternate file name. Use |::S|
5077 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005078 Environment variables are expanded |:set_env|. See |option-backslash|
5079 about including spaces and backslashes.
5080 Note that a '|' must be escaped twice: once for ":set" and once for
5081 the interpretation of a command. When you use a filter called
5082 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005083 :set makeprg=gmake\ \\\|\ myfilter
5084< The placeholder "$*" can be given (even multiple times) to specify
5085 where the arguments will be included, for example: >
5086 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5087< This option cannot be set from a |modeline| or in the |sandbox|, for
5088 security reasons.
5089
5090 *'matchpairs'* *'mps'*
5091'matchpairs' 'mps' string (default "(:),{:},[:]")
5092 local to buffer
5093 {not in Vi}
5094 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005095 other.
5096 Only character pairs are allowed that are different, thus you cannot
5097 jump between two double quotes.
5098 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005099 The pairs must be separated by a comma. Example for including '<' and
5100 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 :set mps+=<:>
5102
5103< A more exotic example, to jump between the '=' and ';' in an
5104 assignment, useful for languages like C and Java: >
5105 :au FileType c,cpp,java set mps+==:;
5106
5107< For a more advanced way of using "%", see the matchit.vim plugin in
5108 the $VIMRUNTIME/macros directory. |add-local-help|
5109
5110 *'matchtime'* *'mat'*
5111'matchtime' 'mat' number (default 5)
5112 global
5113 {not in Vi}{in Nvi}
5114 Tenths of a second to show the matching paren, when 'showmatch' is
5115 set. Note that this is not in milliseconds, like other options that
5116 set a time. This is to be compatible with Nvi.
5117
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005118 *'maxcombine'* *'mco'*
5119'maxcombine' 'mco' number (default 2)
5120 global
5121 {not in Vi}
5122 {only available when compiled with the |+multi_byte|
5123 feature}
5124 The maximum number of combining characters supported for displaying.
5125 Only used when 'encoding' is "utf-8".
5126 The default is OK for most languages. Hebrew may require 4.
5127 Maximum value is 6.
5128 Even when this option is set to 2 you can still edit text with more
5129 combining characters, you just can't see them. Use |g8| or |ga|.
5130 See |mbyte-combining|.
5131
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132 *'maxfuncdepth'* *'mfd'*
5133'maxfuncdepth' 'mfd' number (default 100)
5134 global
5135 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005136 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005137 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 Maximum depth of function calls for user functions. This normally
5139 catches endless recursion. When using a recursive function with
5140 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5141 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005142 Increasing this limit above 200 also changes the maximum for Ex
5143 command resursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144 See also |:function|.
5145
5146 *'maxmapdepth'* *'mmd'* *E223*
5147'maxmapdepth' 'mmd' number (default 1000)
5148 global
5149 {not in Vi}
5150 Maximum number of times a mapping is done without resulting in a
5151 character to be used. This normally catches endless mappings, like
5152 ":map x y" with ":map y x". It still does not catch ":map g wg",
5153 because the 'w' is used before the next mapping is done. See also
5154 |key-mapping|.
5155
5156 *'maxmem'* *'mm'*
5157'maxmem' 'mm' number (default between 256 to 5120 (system
5158 dependent) or half the amount of memory
5159 available)
5160 global
5161 {not in Vi}
5162 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5163 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005164 other memory to be freed. The maximum usable value is about 2000000.
5165 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005166
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005167 *'maxmempattern'* *'mmp'*
5168'maxmempattern' 'mmp' number (default 1000)
5169 global
5170 {not in Vi}
5171 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005172 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005173 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005174 When Vim runs into the limit it gives an error message and mostly
5175 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005176 Running into the limit often means that the pattern is very
5177 inefficient or too complex. This may already happen with the pattern
5178 "\(.\)*" on a very long line. ".*" works much better.
5179 Vim may run out of memory before hitting the 'maxmempattern' limit.
5180
Bram Moolenaar071d4272004-06-13 20:20:40 +00005181 *'maxmemtot'* *'mmt'*
5182'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5183 dependent) or half the amount of memory
5184 available)
5185 global
5186 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005187 Maximum amount of memory in Kbyte to use for all buffers together.
5188 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005189 without a limit.
5190 On 64 bit machines higher values might work. But hey, do you really
5191 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005192 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005193 need the memory to store undo info.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005194 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005195
5196 *'menuitems'* *'mis'*
5197'menuitems' 'mis' number (default 25)
5198 global
5199 {not in Vi}
5200 {not available when compiled without the |+menu|
5201 feature}
5202 Maximum number of items to use in a menu. Used for menus that are
5203 generated from a list of items, e.g., the Buffers menu. Changing this
5204 option has no direct effect, the menu must be refreshed first.
5205
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005206 *'mkspellmem'* *'msm'*
5207'mkspellmem' 'msm' string (default "460000,2000,500")
5208 global
5209 {not in Vi}
5210 {not available when compiled without the |+syntax|
5211 feature}
5212 Parameters for |:mkspell|. This tunes when to start compressing the
5213 word tree. Compression can be slow when there are many words, but
5214 it's needed to avoid running out of memory. The amount of memory used
5215 per word depends very much on how similar the words are, that's why
5216 this tuning is complicated.
5217
5218 There are three numbers, separated by commas:
5219 {start},{inc},{added}
5220
5221 For most languages the uncompressed word tree fits in memory. {start}
5222 gives the amount of memory in Kbyte that can be used before any
5223 compression is done. It should be a bit smaller than the amount of
5224 memory that is available to Vim.
5225
5226 When going over the {start} limit the {inc} number specifies the
5227 amount of memory in Kbyte that can be allocated before another
5228 compression is done. A low number means compression is done after
5229 less words are added, which is slow. A high number means more memory
5230 will be allocated.
5231
5232 After doing compression, {added} times 1024 words can be added before
5233 the {inc} limit is ignored and compression is done when any extra
5234 amount of memory is needed. A low number means there is a smaller
5235 chance of hitting the {inc} limit, less memory is used but it's
5236 slower.
5237
5238 The languages for which these numbers are important are Italian and
5239 Hungarian. The default works for when you have about 512 Mbyte. If
5240 you have 1 Gbyte you could use: >
5241 :set mkspellmem=900000,3000,800
5242< If you have less than 512 Mbyte |:mkspell| may fail for some
5243 languages, no matter what you set 'mkspellmem' to.
5244
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005246'modeline' 'ml' boolean (Vim default: on (off for root),
5247 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248 local to buffer
5249 *'modelines'* *'mls'*
5250'modelines' 'mls' number (default 5)
5251 global
5252 {not in Vi}
5253 If 'modeline' is on 'modelines' gives the number of lines that is
5254 checked for set commands. If 'modeline' is off or 'modelines' is zero
5255 no lines are checked. See |modeline|.
5256 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5257 set and to the Vim default value when 'compatible' is reset.
5258
5259 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5260'modifiable' 'ma' boolean (default on)
5261 local to buffer
5262 {not in Vi} *E21*
5263 When off the buffer contents cannot be changed. The 'fileformat' and
5264 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005265 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266
5267 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5268'modified' 'mod' boolean (default off)
5269 local to buffer
5270 {not in Vi}
5271 When on, the buffer is considered to be modified. This option is set
5272 when:
5273 1. A change was made to the text since it was last written. Using the
5274 |undo| command to go back to the original text will reset the
5275 option. But undoing changes that were made before writing the
5276 buffer will set the option again, since the text is different from
5277 when it was written.
5278 2. 'fileformat' or 'fileencoding' is different from its original
5279 value. The original value is set when the buffer is read or
5280 written. A ":set nomodified" command also resets the original
5281 values to the current values and the 'modified' option will be
5282 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005283 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005284 This option is not set when a change is made to the buffer as the
5285 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5286 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5287 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5289 will be ignored.
5290
5291 *'more'* *'nomore'*
5292'more' boolean (Vim default: on, Vi default: off)
5293 global
5294 {not in Vi}
5295 When on, listings pause when the whole screen is filled. You will get
5296 the |more-prompt|. When this option is off there are no pauses, the
5297 listing continues until finished.
5298 NOTE: This option is set to the Vi default value when 'compatible' is
5299 set and to the Vim default value when 'compatible' is reset.
5300
5301 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005302'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5303 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005304 global
5305 {not in Vi}
5306 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005307 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5308 sysmouse and Linux console with gpm). For using the mouse in the
5309 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 The mouse can be enabled for different modes:
5311 n Normal mode
5312 v Visual mode
5313 i Insert mode
5314 c Command-line mode
5315 h all previous modes when editing a help file
5316 a all previous modes
5317 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318 Normally you would enable the mouse in all four modes with: >
5319 :set mouse=a
5320< When the mouse is not enabled, the GUI will still use the mouse for
5321 modeless selection. This doesn't move the text cursor.
5322
5323 See |mouse-using|. Also see |'clipboard'|.
5324
5325 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005326 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327 the mouse buttons can still be used by keeping the shift key pressed.
5328 Also see the 'clipboard' option.
5329
5330 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5331'mousefocus' 'mousef' boolean (default off)
5332 global
5333 {not in Vi}
5334 {only works in the GUI}
5335 The window that the mouse pointer is on is automatically activated.
5336 When changing the window layout or window focus in another way, the
5337 mouse pointer is moved to the window with keyboard focus. Off is the
5338 default because it makes using the pull down menus a little goofy, as
5339 a pointer transit may activate a window unintentionally.
5340
5341 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5342'mousehide' 'mh' boolean (default on)
5343 global
5344 {not in Vi}
5345 {only works in the GUI}
5346 When on, the mouse pointer is hidden when characters are typed.
5347 The mouse pointer is restored when the mouse is moved.
5348
5349 *'mousemodel'* *'mousem'*
5350'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5351 global
5352 {not in Vi}
5353 Sets the model to use for the mouse. The name mostly specifies what
5354 the right mouse button is used for:
5355 extend Right mouse button extends a selection. This works
5356 like in an xterm.
5357 popup Right mouse button pops up a menu. The shifted left
5358 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005359 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360 popup_setpos Like "popup", but the cursor will be moved to the
5361 position where the mouse was clicked, and thus the
5362 selected operation will act upon the clicked object.
5363 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005364 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005365 course, that right clicking outside a selection will
5366 end Visual mode.
5367 Overview of what button does what for each model:
5368 mouse extend popup(_setpos) ~
5369 left click place cursor place cursor
5370 left drag start selection start selection
5371 shift-left search word extend selection
5372 right click extend selection popup menu (place cursor)
5373 right drag extend selection -
5374 middle click paste paste
5375
5376 In the "popup" model the right mouse button produces a pop-up menu.
5377 You need to define this first, see |popup-menu|.
5378
5379 Note that you can further refine the meaning of buttons with mappings.
5380 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5381 selection (because that's handled in the GUI code directly).
5382
5383 The 'mousemodel' option is set by the |:behave| command.
5384
5385 *'mouseshape'* *'mouses'* *E547*
5386'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005387 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 global
5389 {not in Vi}
5390 {only available when compiled with the |+mouseshape|
5391 feature}
5392 This option tells Vim what the mouse pointer should look like in
5393 different modes. The option is a comma separated list of parts, much
5394 like used for 'guicursor'. Each part consist of a mode/location-list
5395 and an argument-list:
5396 mode-list:shape,mode-list:shape,..
5397 The mode-list is a dash separated list of these modes/locations:
5398 In a normal window: ~
5399 n Normal mode
5400 v Visual mode
5401 ve Visual mode with 'selection' "exclusive" (same as 'v',
5402 if not specified)
5403 o Operator-pending mode
5404 i Insert mode
5405 r Replace mode
5406
5407 Others: ~
5408 c appending to the command-line
5409 ci inserting in the command-line
5410 cr replacing in the command-line
5411 m at the 'Hit ENTER' or 'More' prompts
5412 ml idem, but cursor in the last line
5413 e any mode, pointer below last window
5414 s any mode, pointer on a status line
5415 sd any mode, while dragging a status line
5416 vs any mode, pointer on a vertical separator line
5417 vd any mode, while dragging a vertical separator line
5418 a everywhere
5419
5420 The shape is one of the following:
5421 avail name looks like ~
5422 w x arrow Normal mouse pointer
5423 w x blank no pointer at all (use with care!)
5424 w x beam I-beam
5425 w x updown up-down sizing arrows
5426 w x leftright left-right sizing arrows
5427 w x busy The system's usual busy pointer
5428 w x no The system's usual 'no input' pointer
5429 x udsizing indicates up-down resizing
5430 x lrsizing indicates left-right resizing
5431 x crosshair like a big thin +
5432 x hand1 black hand
5433 x hand2 white hand
5434 x pencil what you write with
5435 x question big ?
5436 x rightup-arrow arrow pointing right-up
5437 w x up-arrow arrow pointing up
5438 x <number> any X11 pointer number (see X11/cursorfont.h)
5439
5440 The "avail" column contains a 'w' if the shape is available for Win32,
5441 x for X11.
5442 Any modes not specified or shapes not available use the normal mouse
5443 pointer.
5444
5445 Example: >
5446 :set mouseshape=s:udsizing,m:no
5447< will make the mouse turn to a sizing arrow over the status lines and
5448 indicate no input when the hit-enter prompt is displayed (since
5449 clicking the mouse has no effect in this state.)
5450
5451 *'mousetime'* *'mouset'*
5452'mousetime' 'mouset' number (default 500)
5453 global
5454 {not in Vi}
5455 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5456 time in msec between two mouse clicks for the second click to be
5457 recognized as a multi click.
5458
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005459 *'mzquantum'* *'mzq'*
5460'mzquantum' 'mzq' number (default 100)
5461 global
5462 {not in Vi}
5463 {not available when compiled without the |+mzscheme|
5464 feature}
5465 The number of milliseconds between polls for MzScheme threads.
5466 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005467 NOTE: This option is set to the Vim default value when 'compatible'
5468 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005469
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005471'nrformats' 'nf' string (default "bin,octal,hex",
5472 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005473 local to buffer
5474 {not in Vi}
5475 This defines what bases Vim will consider for numbers when using the
5476 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5477 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005478 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005480 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005481 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005483 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484 considered to be hexadecimal. Example: Using CTRL-X on
5485 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005486 bin If included, numbers starting with "0b" or "0B" will be
5487 considered to be binary. Example: Using CTRL-X on
5488 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489 Numbers which simply begin with a digit in the range 1-9 are always
5490 considered decimal. This also happens for numbers that are not
5491 recognized as octal or hex.
5492
5493 *'number'* *'nu'* *'nonumber'* *'nonu'*
5494'number' 'nu' boolean (default off)
5495 local to window
5496 Print the line number in front of each line. When the 'n' option is
5497 excluded from 'cpoptions' a wrapped line will not use the column of
5498 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005499 The 'numberwidth' option can be used to set the room used for the line
5500 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005501 When a long, wrapped line doesn't start with the first character, '-'
5502 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005503 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5504 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005505 *number_relativenumber*
5506 The 'relativenumber' option changes the displayed number to be
5507 relative to the cursor. Together with 'number' there are these
5508 four combinations (cursor in line 3):
5509
Bram Moolenaar3848e002016-03-19 18:42:29 +01005510 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005511 'nornu' 'nornu' 'rnu' 'rnu'
5512
5513 |apple | 1 apple | 2 apple | 2 apple
5514 |pear | 2 pear | 1 pear | 1 pear
5515 |nobody | 3 nobody | 0 nobody |3 nobody
5516 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005517
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005518 *'numberwidth'* *'nuw'*
5519'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5520 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005521 {not in Vi}
5522 {only available when compiled with the |+linebreak|
5523 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005524 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005525 when the 'number' or 'relativenumber' option is set or printing lines
5526 with a line number. Since one space is always between the number and
5527 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005528 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005529 fit the highest line number in the buffer respectively the number of
5530 rows in the window, depending on whether 'number' or 'relativenumber'
5531 is set. Thus with the Vim default of 4 there is room for a line number
5532 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005533 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005534 NOTE: This option is set to the Vi default value when 'compatible' is
5535 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005536
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005537 *'omnifunc'* *'ofu'*
5538'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005539 local to buffer
5540 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005541 {not available when compiled without the |+eval|
5542 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005543 This option specifies a function to be used for Insert mode omni
5544 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005545 See |complete-functions| for an explanation of how the function is
5546 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005547 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005548 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005549 This option cannot be set from a |modeline| or in the |sandbox|, for
5550 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005551
5552
Bram Moolenaar02467872007-05-06 13:22:01 +00005553 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005554'opendevice' 'odev' boolean (default off)
5555 global
5556 {not in Vi}
5557 {only for MS-DOS, MS-Windows and OS/2}
5558 Enable reading and writing from devices. This may get Vim stuck on a
5559 device that can be opened but doesn't actually do the I/O. Therefore
5560 it is off by default.
5561 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5562 result in editing a device.
5563
5564
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005565 *'operatorfunc'* *'opfunc'*
5566'operatorfunc' 'opfunc' string (default: empty)
5567 global
5568 {not in Vi}
5569 This option specifies a function to be called by the |g@| operator.
5570 See |:map-operator| for more info and an example.
5571
5572 This option cannot be set from a |modeline| or in the |sandbox|, for
5573 security reasons.
5574
5575
Bram Moolenaar251e1912011-06-19 05:09:16 +02005576 *'osfiletype'* *'oft'*
5577'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578 local to buffer
5579 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005580 This option was supported on RISC OS, which has been removed.
5581
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005583 *'packpath'* *'pp'*
5584'packpath' 'pp' string (default: see 'runtimepath')
5585 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005586 Directories used to find packages. See |packages|.
5587
5588
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005590'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 global
5592 Specifies the nroff macros that separate paragraphs. These are pairs
5593 of two letters (see |object-motions|).
5594
5595 *'paste'* *'nopaste'*
5596'paste' boolean (default off)
5597 global
5598 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005599 Put Vim in Paste mode. This is useful if you want to cut or copy
5600 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601 unexpected effects.
5602 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005603 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604 knows about pasting and will mostly do the right thing without 'paste'
5605 being set. The same is true for a terminal where Vim handles the
5606 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005607 This option is reset when starting the GUI. Thus if you set it in
5608 your .vimrc it will work in a terminal, but not in the GUI. Setting
5609 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5610 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005611 When the 'paste' option is switched on (also when it was already on):
5612 - mapping in Insert mode and Command-line mode is disabled
5613 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005615 - 'expandtab' is reset
5616 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 - 'revins' is reset
5618 - 'ruler' is reset
5619 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005620 - 'smartindent' is reset
5621 - 'smarttab' is reset
5622 - 'softtabstop' is set to 0
5623 - 'textwidth' is set to 0
5624 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005627 - 'indentexpr'
5628 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 NOTE: When you start editing another file while the 'paste' option is
5630 on, settings from the modelines or autocommands may change the
5631 settings again, causing trouble when pasting text. You might want to
5632 set the 'paste' option again.
5633 When the 'paste' option is reset the mentioned options are restored to
5634 the value before the moment 'paste' was switched from off to on.
5635 Resetting 'paste' before ever setting it does not have any effect.
5636 Since mapping doesn't work while 'paste' is active, you need to use
5637 the 'pastetoggle' option to toggle the 'paste' option with some key.
5638
5639 *'pastetoggle'* *'pt'*
5640'pastetoggle' 'pt' string (default "")
5641 global
5642 {not in Vi}
5643 When non-empty, specifies the key sequence that toggles the 'paste'
5644 option. This is like specifying a mapping: >
5645 :map {keys} :set invpaste<CR>
5646< Where {keys} is the value of 'pastetoggle'.
5647 The difference is that it will work even when 'paste' is set.
5648 'pastetoggle' works in Insert mode and Normal mode, but not in
5649 Command-line mode.
5650 Mappings are checked first, thus overrule 'pastetoggle'. However,
5651 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5652 this: >
5653 :map <F10> :set paste<CR>
5654 :map <F11> :set nopaste<CR>
5655 :imap <F10> <C-O>:set paste<CR>
5656 :imap <F11> <nop>
5657 :set pastetoggle=<F11>
5658< This will make <F10> start paste mode and <F11> stop paste mode.
5659 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5660 mode everything is inserted literally, except the 'pastetoggle' key
5661 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005662 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663
5664 *'pex'* *'patchexpr'*
5665'patchexpr' 'pex' string (default "")
5666 global
5667 {not in Vi}
5668 {not available when compiled without the |+diff|
5669 feature}
5670 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005671 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672
Bram Moolenaardbc28022014-07-26 13:40:44 +02005673 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674'patchmode' 'pm' string (default "")
5675 global
5676 {not in Vi}
5677 When non-empty the oldest version of a file is kept. This can be used
5678 to keep the original version of a file if you are changing files in a
5679 source distribution. Only the first time that a file is written a
5680 copy of the original file will be kept. The name of the copy is the
5681 name of the original file with the string in the 'patchmode' option
5682 appended. This option should start with a dot. Use a string like
5683 ".org". 'backupdir' must not be empty for this to work (Detail: The
5684 backup file is renamed to the patchmode file after the new file has
5685 been successfully written, that's why it must be possible to write a
5686 backup file). If there was no file to be backed up, an empty file is
5687 created.
5688 When the 'backupskip' pattern matches, a patchmode file is not made.
5689 Using 'patchmode' for compressed files appends the extension at the
5690 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5691 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005692 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005694 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695'path' 'pa' string (default on Unix: ".,/usr/include,,"
5696 on OS/2: ".,/emx/include,,"
5697 other systems: ".,,")
5698 global or local to buffer |global-local|
5699 {not in Vi}
5700 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005701 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5702 provided that the file being searched for has a relative path (not
5703 starting with "/", "./" or "../"). The directories in the 'path'
5704 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705 - Use commas to separate directory names: >
5706 :set path=.,/usr/local/include,/usr/include
5707< - Spaces can also be used to separate directory names (for backwards
5708 compatibility with version 3.0). To have a space in a directory
5709 name, precede it with an extra backslash, and escape the space: >
5710 :set path=.,/dir/with\\\ space
5711< - To include a comma in a directory name precede it with an extra
5712 backslash: >
5713 :set path=.,/dir/with\\,comma
5714< - To search relative to the directory of the current file, use: >
5715 :set path=.
5716< - To search in the current directory use an empty string between two
5717 commas: >
5718 :set path=,,
5719< - A directory name may end in a ':' or '/'.
5720 - Environment variables are expanded |:set_env|.
5721 - When using |netrw.vim| URLs can be used. For example, adding
5722 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005723 - Search upwards and downwards in a directory tree using "*", "**" and
5724 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725 {not available when compiled without the |+path_extra| feature}
5726 - Careful with '\' characters, type two to get one in the option: >
5727 :set path=.,c:\\include
5728< Or just use '/' instead: >
5729 :set path=.,c:/include
5730< Don't forget "." or files won't even be found in the same directory as
5731 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005732 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733 it is something like 256 or 1024 characters.
5734 You can check if all the include files are found, using the value of
5735 'path', see |:checkpath|.
5736 The use of |:set+=| and |:set-=| is preferred when adding or removing
5737 directories from the list. This avoids problems when a future version
5738 uses another default. To remove the current directory use: >
5739 :set path-=
5740< To add the current directory use: >
5741 :set path+=
5742< To use an environment variable, you probably need to replace the
5743 separator. Here is an example to append $INCL, in which directory
5744 names are separated with a semi-colon: >
5745 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5746< Replace the ';' with a ':' or whatever separator is used. Note that
5747 this doesn't work when $INCL contains a comma or white space.
5748
5749 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5750'preserveindent' 'pi' boolean (default off)
5751 local to buffer
5752 {not in Vi}
5753 When changing the indent of the current line, preserve as much of the
5754 indent structure as possible. Normally the indent is replaced by a
5755 series of tabs followed by spaces as required (unless |'expandtab'| is
5756 enabled, in which case only spaces are used). Enabling this option
5757 means the indent will preserve as many existing characters as possible
5758 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005759 'expandtab' does not apply to the preserved white space, a Tab remains
5760 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761 NOTE: When using ">>" multiple times the resulting indent is a mix of
5762 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005763 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 Also see 'copyindent'.
5765 Use |:retab| to clean up white space.
5766
5767 *'previewheight'* *'pvh'*
5768'previewheight' 'pvh' number (default 12)
5769 global
5770 {not in Vi}
5771 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005772 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 Default height for a preview window. Used for |:ptag| and associated
5774 commands. Used for |CTRL-W_}| when no count is given.
5775
5776 *'previewwindow'* *'nopreviewwindow'*
5777 *'pvw'* *'nopvw'* *E590*
5778'previewwindow' 'pvw' boolean (default off)
5779 local to window
5780 {not in Vi}
5781 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005782 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005783 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784 set. It's normally not set directly, but by using one of the commands
5785 |:ptag|, |:pedit|, etc.
5786
5787 *'printdevice'* *'pdev'*
5788'printdevice' 'pdev' string (default empty)
5789 global
5790 {not in Vi}
5791 {only available when compiled with the |+printer|
5792 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005793 The name of the printer to be used for |:hardcopy|.
5794 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005795 This option cannot be set from a |modeline| or in the |sandbox|, for
5796 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005797
Bram Moolenaar8299df92004-07-10 09:47:34 +00005798 *'printencoding'* *'penc'*
5799'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005800 global
5801 {not in Vi}
5802 {only available when compiled with the |+printer|
5803 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005804 Sets the character encoding used when printing.
5805 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005806
5807 *'printexpr'* *'pexpr'*
5808'printexpr' 'pexpr' String (default: see below)
5809 global
5810 {not in Vi}
5811 {only available when compiled with the |+printer|
5812 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005813 Expression used to print the PostScript produced with |:hardcopy|.
5814 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005815 This option cannot be set from a |modeline| or in the |sandbox|, for
5816 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817
Bram Moolenaar8299df92004-07-10 09:47:34 +00005818 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819'printfont' 'pfn' string (default "courier")
5820 global
5821 {not in Vi}
5822 {only available when compiled with the |+printer|
5823 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005824 The name of the font that will be used for |:hardcopy|.
5825 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826
5827 *'printheader'* *'pheader'*
5828'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5829 global
5830 {not in Vi}
5831 {only available when compiled with the |+printer|
5832 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005833 The format of the header produced in |:hardcopy| output.
5834 See |pheader-option|.
5835
5836 *'printmbcharset'* *'pmbcs'*
5837'printmbcharset' 'pmbcs' string (default "")
5838 global
5839 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005840 {only available when compiled with the |+printer|,
5841 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005842 The CJK character set to be used for CJK output from |:hardcopy|.
5843 See |pmbcs-option|.
5844
5845 *'printmbfont'* *'pmbfn'*
5846'printmbfont' 'pmbfn' string (default "")
5847 global
5848 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005849 {only available when compiled with the |+printer|,
5850 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005851 List of font names to be used for CJK output from |:hardcopy|.
5852 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853
5854 *'printoptions'* *'popt'*
5855'printoptions' 'popt' string (default "")
5856 global
5857 {not in Vi}
5858 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005859 List of items that control the format of the output of |:hardcopy|.
5860 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005862 *'prompt'* *'noprompt'*
5863'prompt' boolean (default on)
5864 global
5865 When on a ":" prompt is used in Ex mode.
5866
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005867 *'pumheight'* *'ph'*
5868'pumheight' 'ph' number (default 0)
5869 global
5870 {not available when compiled without the
5871 |+insert_expand| feature}
5872 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005873 Determines the maximum number of items to show in the popup menu for
5874 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005875 |ins-completion-menu|.
5876
Bram Moolenaard94464e2015-11-02 15:28:18 +01005877 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005878'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005879 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005880 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005881 {only available when compiled with the |+python/dyn|
5882 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005883 Specifies the name of the Python 2.x shared library. The default is
5884 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005885 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005886 This option cannot be set from a |modeline| or in the |sandbox|, for
5887 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005888
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005889 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005890'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005891 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005892 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005893 {only available when compiled with the |+python3/dyn|
5894 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005895 Specifies the name of the Python 3 shared library. The default is
5896 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005897 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005898 This option cannot be set from a |modeline| or in the |sandbox|, for
5899 security reasons.
5900
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005901 *'pyxversion'* *'pyx'*
5902'pyxversion' 'pyx' number (default depends on the build)
5903 global
5904 {not in Vi}
5905 {only available when compiled with the |+python| or
5906 the |+python3| feature}
5907 Specifies the python version used for pyx* functions and commands
5908 |python_x|. The default value is as follows:
5909
5910 Compiled with Default ~
5911 |+python| and |+python3| 0
5912 only |+python| 2
5913 only |+python3| 3
5914
5915 Available values are 0, 2 and 3.
5916 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5917 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5918 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5919 to 2 if Python 2 is available.
5920 See also: |has-pythonx|
5921
5922 If Vim is compiled with only |+python| or |+python3| setting
5923 'pyxversion' has no effect. The pyx* functions and commands are
5924 always the same as the compiled version.
5925
5926 This option cannot be set from a |modeline| or in the |sandbox|, for
5927 security reasons.
5928
Bram Moolenaar677ee682005-01-27 14:41:15 +00005929 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005930'quoteescape' 'qe' string (default "\")
5931 local to buffer
5932 {not in Vi}
5933 The characters that are used to escape quotes in a string. Used for
5934 objects like a', a" and a` |a'|.
5935 When one of the characters in this option is found inside a string,
5936 the following character will be skipped. The default value makes the
5937 text "foo\"bar\\" considered to be one string.
5938
Bram Moolenaar071d4272004-06-13 20:20:40 +00005939 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5940'readonly' 'ro' boolean (default off)
5941 local to buffer
5942 If on, writes fail unless you use a '!'. Protects you from
5943 accidentally overwriting a file. Default on when Vim is started
5944 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005945 When using ":w!" the 'readonly' option is reset for the current
5946 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005948 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005949 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005951 *'redrawtime'* *'rdt'*
5952'redrawtime' 'rdt' number (default 2000)
5953 global
5954 {not in Vi}
5955 {only available when compiled with the |+reltime|
5956 feature}
5957 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005958 searching for patterns for 'hlsearch', |:match| highlighting an syntax
5959 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005960 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005961 matches will be highlighted.
5962 For syntax highlighting the time applies per window. When over the
5963 limit syntax highlighting is disabled until |CTRL-L| is used.
5964 This is used to avoid that Vim hangs when using a very complicated
5965 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005966
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005967 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005968'regexpengine' 're' number (default 0)
5969 global
5970 {not in Vi}
5971 This selects the default regexp engine. |two-engines|
5972 The possible values are:
5973 0 automatic selection
5974 1 old engine
5975 2 NFA engine
5976 Note that when using the NFA engine and the pattern contains something
5977 that is not supported the pattern will not match. This is only useful
5978 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005979 Using automatic selection enables Vim to switch the engine, if the
5980 default engine becomes too costly. E.g., when the NFA engine uses too
5981 many states. This should prevent Vim from hanging on a combination of
5982 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005983
Bram Moolenaar64486672010-05-16 15:46:46 +02005984 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5985'relativenumber' 'rnu' boolean (default off)
5986 local to window
5987 {not in Vi}
5988 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005989 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005990 precede some vertical motion commands (e.g. j k + -) with, without
5991 having to calculate it yourself. Especially useful in combination with
5992 other commands (e.g. y d c < > gq gw =).
5993 When the 'n' option is excluded from 'cpoptions' a wrapped
5994 line will not use the column of line numbers (this is the default when
5995 'compatible' isn't set).
5996 The 'numberwidth' option can be used to set the room used for the line
5997 number.
5998 When a long, wrapped line doesn't start with the first character, '-'
5999 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006000 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6001 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006002
6003 The number in front of the cursor line also depends on the value of
6004 'number', see |number_relativenumber| for all combinations of the two
6005 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006006
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007 *'remap'* *'noremap'*
6008'remap' boolean (default on)
6009 global
6010 Allows for mappings to work recursively. If you do not want this for
6011 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006012 NOTE: To avoid portability problems with Vim scripts, always keep
6013 this option at the default "on". Only switch it off when working with
6014 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006016 *'renderoptions'* *'rop'*
6017'renderoptions' 'rop' string (default: empty)
6018 global
6019 {not in Vi}
6020 {only available when compiled with GUI and DIRECTX on
6021 MS-Windows}
6022 Select a text renderer and set its options. The options depend on the
6023 renderer.
6024
6025 Syntax: >
6026 set rop=type:{renderer}(,{name}:{value})*
6027<
6028 Currently, only one optional renderer is available.
6029
6030 render behavior ~
6031 directx Vim will draw text using DirectX (DirectWrite). It makes
6032 drawn glyphs more beautiful than default GDI.
6033 It requires 'encoding' is "utf-8", and only works on
6034 MS-Windows Vista or newer version.
6035
6036 Options:
6037 name meaning type value ~
6038 gamma gamma float 1.0 - 2.2 (maybe)
6039 contrast enhancedContrast float (unknown)
6040 level clearTypeLevel float (unknown)
6041 geom pixelGeometry int 0 - 2 (see below)
6042 renmode renderingMode int 0 - 6 (see below)
6043 taamode textAntialiasMode int 0 - 3 (see below)
6044
6045 See this URL for detail:
6046 http://msdn.microsoft.com/en-us/library/dd368190.aspx
6047
6048 For geom: structure of a device pixel.
6049 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6050 1 - DWRITE_PIXEL_GEOMETRY_RGB
6051 2 - DWRITE_PIXEL_GEOMETRY_BGR
6052
6053 See this URL for detail:
6054 http://msdn.microsoft.com/en-us/library/dd368114.aspx
6055
6056 For renmode: method of rendering glyphs.
6057 0 - DWRITE_RENDERING_MODE_DEFAULT
6058 1 - DWRITE_RENDERING_MODE_ALIASED
6059 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6060 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6061 4 - DWRITE_RENDERING_MODE_NATURAL
6062 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6063 6 - DWRITE_RENDERING_MODE_OUTLINE
6064
6065 See this URL for detail:
6066 http://msdn.microsoft.com/en-us/library/dd368118.aspx
6067
6068 For taamode: antialiasing mode used for drawing text.
6069 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6070 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6071 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6072 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6073
6074 See this URL for detail:
6075 http://msdn.microsoft.com/en-us/library/dd368170.aspx
6076
6077 Example: >
6078 set encoding=utf-8
6079 set gfn=Ricty_Diminished:h12:cSHIFTJIS
6080 set rop=type:directx
6081<
6082 If select a raster font (Courier, Terminal or FixedSys) to
6083 'guifont', it fallbacks to be drawn by GDI automatically.
6084
6085 Other render types are currently not supported.
6086
Bram Moolenaar071d4272004-06-13 20:20:40 +00006087 *'report'*
6088'report' number (default 2)
6089 global
6090 Threshold for reporting number of lines changed. When the number of
6091 changed lines is more than 'report' a message will be given for most
6092 ":" commands. If you want it always, set 'report' to 0.
6093 For the ":substitute" command the number of substitutions is used
6094 instead of the number of lines.
6095
6096 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6097'restorescreen' 'rs' boolean (default on)
6098 global
6099 {not in Vi} {only in Windows 95/NT console version}
6100 When set, the screen contents is restored when exiting Vim. This also
6101 happens when executing external commands.
6102
6103 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6104 options in your .vimrc. To disable restoring:
6105 set t_ti= t_te=
6106 To enable restoring (for an xterm):
6107 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6108 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6109
6110 *'revins'* *'ri'* *'norevins'* *'nori'*
6111'revins' 'ri' boolean (default off)
6112 global
6113 {not in Vi}
6114 {only available when compiled with the |+rightleft|
6115 feature}
6116 Inserting characters in Insert mode will work backwards. See "typing
6117 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6118 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006119 NOTE: This option is reset when 'compatible' is set.
6120 This option is reset when 'paste' is set and restored when 'paste' is
6121 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122
6123 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6124'rightleft' 'rl' boolean (default off)
6125 local to window
6126 {not in Vi}
6127 {only available when compiled with the |+rightleft|
6128 feature}
6129 When on, display orientation becomes right-to-left, i.e., characters
6130 that are stored in the file appear from the right to the left.
6131 Using this option, it is possible to edit files for languages that
6132 are written from the right to the left such as Hebrew and Arabic.
6133 This option is per window, so it is possible to edit mixed files
6134 simultaneously, or to view the same file in both ways (this is
6135 useful whenever you have a mixed text file with both right-to-left
6136 and left-to-right strings so that both sets are displayed properly
6137 in different windows). Also see |rileft.txt|.
6138
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006139 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006140'rightleftcmd' 'rlc' string (default "search")
6141 local to window
6142 {not in Vi}
6143 {only available when compiled with the |+rightleft|
6144 feature}
6145 Each word in this option enables the command line editing to work in
6146 right-to-left mode for a group of commands:
6147
6148 search "/" and "?" commands
6149
6150 This is useful for languages such as Hebrew, Arabic and Farsi.
6151 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6152
Bram Moolenaard94464e2015-11-02 15:28:18 +01006153 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006154'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006155 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006156 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006157 {only available when compiled with the |+ruby/dyn|
6158 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006159 Specifies the name of the Ruby shared library. The default is
6160 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006161 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006162 This option cannot be set from a |modeline| or in the |sandbox|, for
6163 security reasons.
6164
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006166'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 global
6168 {not in Vi}
6169 {not available when compiled without the
6170 |+cmdline_info| feature}
6171 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006172 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006173 text in the file is shown on the far right:
6174 Top first line is visible
6175 Bot last line is visible
6176 All first and last line are visible
6177 45% relative position in the file
6178 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006179 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006180 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006181 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182 this option takes precedence over 'ruler' and 'rulerformat'
6183 If the number of characters displayed is different from the number of
6184 bytes in the text (e.g., for a TAB or a multi-byte character), both
6185 the text column (byte number) and the screen column are shown,
6186 separated with a dash.
6187 For an empty line "0-1" is shown.
6188 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006189 This option is reset when 'paste' is set and restored when 'paste' is
6190 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191 If you don't want to see the ruler all the time but want to know where
6192 you are, use "g CTRL-G" |g_CTRL-G|.
6193 NOTE: This option is reset when 'compatible' is set.
6194
6195 *'rulerformat'* *'ruf'*
6196'rulerformat' 'ruf' string (default empty)
6197 global
6198 {not in Vi}
6199 {not available when compiled without the |+statusline|
6200 feature}
6201 When this option is not empty, it determines the content of the ruler
6202 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006203 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204 The default ruler width is 17 characters. To make the ruler 15
6205 characters wide, put "%15(" at the start and "%)" at the end.
6206 Example: >
6207 :set rulerformat=%15(%c%V\ %p%%%)
6208<
6209 *'runtimepath'* *'rtp'* *vimfiles*
6210'runtimepath' 'rtp' string (default:
6211 Unix: "$HOME/.vim,
6212 $VIM/vimfiles,
6213 $VIMRUNTIME,
6214 $VIM/vimfiles/after,
6215 $HOME/.vim/after"
6216 Amiga: "home:vimfiles,
6217 $VIM/vimfiles,
6218 $VIMRUNTIME,
6219 $VIM/vimfiles/after,
6220 home:vimfiles/after"
6221 PC, OS/2: "$HOME/vimfiles,
6222 $VIM/vimfiles,
6223 $VIMRUNTIME,
6224 $VIM/vimfiles/after,
6225 $HOME/vimfiles/after"
6226 Macintosh: "$VIM:vimfiles,
6227 $VIMRUNTIME,
6228 $VIM:vimfiles:after"
6229 RISC-OS: "Choices:vimfiles,
6230 $VIMRUNTIME,
6231 Choices:vimfiles/after"
6232 VMS: "sys$login:vimfiles,
6233 $VIM/vimfiles,
6234 $VIMRUNTIME,
6235 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006236 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237 global
6238 {not in Vi}
6239 This is a list of directories which will be searched for runtime
6240 files:
6241 filetype.vim filetypes by file name |new-filetype|
6242 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006243 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244 colors/ color scheme files |:colorscheme|
6245 compiler/ compiler files |:compiler|
6246 doc/ documentation |write-local-help|
6247 ftplugin/ filetype plugins |write-filetype-plugin|
6248 indent/ indent scripts |indent-expression|
6249 keymap/ key mapping files |mbyte-keymap|
6250 lang/ menu translations |:menutrans|
6251 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006252 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 plugin/ plugin scripts |write-plugin|
6254 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006255 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 syntax/ syntax files |mysyntaxfile|
6257 tutor/ files for vimtutor |tutor|
6258
6259 And any other file searched for with the |:runtime| command.
6260
6261 The defaults for most systems are setup to search five locations:
6262 1. In your home directory, for your personal preferences.
6263 2. In a system-wide Vim directory, for preferences from the system
6264 administrator.
6265 3. In $VIMRUNTIME, for files distributed with Vim.
6266 *after-directory*
6267 4. In the "after" directory in the system-wide Vim directory. This is
6268 for the system administrator to overrule or add to the distributed
6269 defaults (rarely needed)
6270 5. In the "after" directory in your home directory. This is for
6271 personal preferences to overrule or add to the distributed defaults
6272 or system-wide settings (rarely needed).
6273
Bram Moolenaard0796902016-09-16 20:02:31 +02006274 More entries are added when using |packages|. If it gets very long
6275 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6276 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006277
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6279 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006280 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281 wildcards.
6282 See |:runtime|.
6283 Example: >
6284 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6285< This will use the directory "~/vimruntime" first (containing your
6286 personal Vim runtime files), then "/mygroup/vim" (shared between a
6287 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6288 files).
6289 You probably should always include $VIMRUNTIME somewhere, to use the
6290 distributed runtime files. You can put a directory before $VIMRUNTIME
6291 to find files which replace a distributed runtime files. You can put
6292 a directory after $VIMRUNTIME to find files which add to distributed
6293 runtime files.
6294 This option cannot be set from a |modeline| or in the |sandbox|, for
6295 security reasons.
6296
6297 *'scroll'* *'scr'*
6298'scroll' 'scr' number (default: half the window height)
6299 local to window
6300 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6301 set to half the number of lines in the window when the window size
6302 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006303 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6305 the number of screen lines instead of file lines, makes a difference
6306 when lines wrap}
6307
6308 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6309'scrollbind' 'scb' boolean (default off)
6310 local to window
6311 {not in Vi}
6312 {not available when compiled without the |+scrollbind|
6313 feature}
6314 See also |scroll-binding|. When this option is set, the current
6315 window scrolls as other scrollbind windows (windows that also have
6316 this option set) scroll. This option is useful for viewing the
6317 differences between two versions of a file, see 'diff'.
6318 See |'scrollopt'| for options that determine how this option should be
6319 interpreted.
6320 This option is mostly reset when splitting a window to edit another
6321 file. This means that ":split | edit file" results in two windows
6322 with scroll-binding, but ":split file" does not.
6323
6324 *'scrolljump'* *'sj'*
6325'scrolljump' 'sj' number (default 1)
6326 global
6327 {not in Vi}
6328 Minimal number of lines to scroll when the cursor gets off the
6329 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6330 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006331 When set to a negative number from -1 to -100 this is used as the
6332 percentage of the window height. Thus -50 scrolls half the window
6333 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006334 NOTE: This option is set to 1 when 'compatible' is set.
6335
6336 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006337'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338 global
6339 {not in Vi}
6340 Minimal number of screen lines to keep above and below the cursor.
6341 This will make some context visible around where you are working. If
6342 you set it to a very large value (999) the cursor line will always be
6343 in the middle of the window (except at the start or end of the file or
6344 when long lines wrap).
6345 For scrolling horizontally see 'sidescrolloff'.
6346 NOTE: This option is set to 0 when 'compatible' is set.
6347
6348 *'scrollopt'* *'sbo'*
6349'scrollopt' 'sbo' string (default "ver,jump")
6350 global
6351 {not available when compiled without the |+scrollbind|
6352 feature}
6353 {not in Vi}
6354 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006355 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6356 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 The following words are available:
6358 ver Bind vertical scrolling for 'scrollbind' windows
6359 hor Bind horizontal scrolling for 'scrollbind' windows
6360 jump Applies to the offset between two windows for vertical
6361 scrolling. This offset is the difference in the first
6362 displayed line of the bound windows. When moving
6363 around in a window, another 'scrollbind' window may
6364 reach a position before the start or after the end of
6365 the buffer. The offset is not changed though, when
6366 moving back the 'scrollbind' window will try to scroll
6367 to the desired position when possible.
6368 When now making that window the current one, two
6369 things can be done with the relative offset:
6370 1. When "jump" is not included, the relative offset is
6371 adjusted for the scroll position in the new current
6372 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006373 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 2. When "jump" is included, the other windows are
6375 scrolled to keep the same relative offset. When
6376 going back to the other window, it still uses the
6377 same relative offset.
6378 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006379 When 'diff' mode is active there always is vertical scroll binding,
6380 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381
6382 *'sections'* *'sect'*
6383'sections' 'sect' string (default "SHNHH HUnhsh")
6384 global
6385 Specifies the nroff macros that separate sections. These are pairs of
6386 two letters (See |object-motions|). The default makes a section start
6387 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6388
6389 *'secure'* *'nosecure'* *E523*
6390'secure' boolean (default off)
6391 global
6392 {not in Vi}
6393 When on, ":autocmd", shell and write commands are not allowed in
6394 ".vimrc" and ".exrc" in the current directory and map commands are
6395 displayed. Switch it off only if you know that you will not run into
6396 problems, or when the 'exrc' option is off. On Unix this option is
6397 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006398 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 'secure' at the end of your ~/.vimrc then.
6400 This option cannot be set from a |modeline| or in the |sandbox|, for
6401 security reasons.
6402
6403 *'selection'* *'sel'*
6404'selection' 'sel' string (default "inclusive")
6405 global
6406 {not in Vi}
6407 This option defines the behavior of the selection. It is only used
6408 in Visual and Select mode.
6409 Possible values:
6410 value past line inclusive ~
6411 old no yes
6412 inclusive yes yes
6413 exclusive yes no
6414 "past line" means that the cursor is allowed to be positioned one
6415 character past the line.
6416 "inclusive" means that the last character of the selection is included
6417 in an operation. For example, when "x" is used to delete the
6418 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006419 When "old" is used and 'virtualedit' allows the cursor to move past
6420 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006421 Note that when "exclusive" is used and selecting from the end
6422 backwards, you cannot include the last character of a line, when
6423 starting in Normal mode and 'virtualedit' empty.
6424
6425 The 'selection' option is set by the |:behave| command.
6426
6427 *'selectmode'* *'slm'*
6428'selectmode' 'slm' string (default "")
6429 global
6430 {not in Vi}
6431 This is a comma separated list of words, which specifies when to start
6432 Select mode instead of Visual mode, when a selection is started.
6433 Possible values:
6434 mouse when using the mouse
6435 key when using shifted special keys
6436 cmd when using "v", "V" or CTRL-V
6437 See |Select-mode|.
6438 The 'selectmode' option is set by the |:behave| command.
6439
6440 *'sessionoptions'* *'ssop'*
6441'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006442 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443 global
6444 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006445 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006446 feature}
6447 Changes the effect of the |:mksession| command. It is a comma
6448 separated list of words. Each word enables saving and restoring
6449 something:
6450 word save and restore ~
6451 blank empty windows
6452 buffers hidden and unloaded buffers, not just those in windows
6453 curdir the current directory
6454 folds manually created folds, opened/closed folds and local
6455 fold options
6456 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006457 and contain at least one lowercase letter. Only
6458 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 help the help window
6460 localoptions options and mappings local to a window or buffer (not
6461 global values for local options)
6462 options all options and mappings (also global values for local
6463 options)
6464 resize size of the Vim window: 'lines' and 'columns'
6465 sesdir the directory in which the session file is located
6466 will become the current directory (useful with
6467 projects accessed over a network from different
6468 systems)
6469 slash backslashes in file names replaced with forward
6470 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006471 tabpages all tab pages; without this only the current tab page
6472 is restored, so that you can make a session for each
6473 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474 unix with Unix end-of-line format (single <NL>), even when
6475 on Windows or DOS
6476 winpos position of the whole Vim window
6477 winsize window sizes
6478
6479 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006480 When neither "curdir" nor "sesdir" is included, file names are stored
6481 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006482 "slash" and "unix" are useful on Windows when sharing session files
6483 with Unix. The Unix version of Vim cannot source dos format scripts,
6484 but the Windows version of Vim can source unix format scripts.
6485
6486 *'shell'* *'sh'* *E91*
6487'shell' 'sh' string (default $SHELL or "sh",
6488 MS-DOS and Win32: "command.com" or
6489 "cmd.exe", OS/2: "cmd")
6490 global
6491 Name of the shell to use for ! and :! commands. When changing the
6492 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6493 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006494 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 See |option-backslash| about including spaces and backslashes.
6496 Environment variables are expanded |:set_env|.
6497 If the name of the shell contains a space, you might need to enclose
6498 it in quotes. Example: >
6499 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6500< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006501 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 "-f" is not inside the quotes, because it is not part of the command
6503 name. And Vim automagically recognizes the backslashes that are path
6504 separators.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505 Under MS-Windows, when the executable ends in ".com" it must be
6506 included. Thus setting the shell to "command.com" or "4dos.com"
6507 works, but "command" and "4dos" do not work for all commands (e.g.,
6508 filtering).
6509 For unknown reasons, when using "4dos.com" the current directory is
6510 changed to "C:\". To avoid this set 'shell' like this: >
6511 :set shell=command.com\ /c\ 4dos
6512< This option cannot be set from a |modeline| or in the |sandbox|, for
6513 security reasons.
6514
6515 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006516'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006517 MS-DOS and Win32, when 'shell' does not
6518 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 global
6520 {not in Vi}
6521 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6522 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6523 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006524 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006525 On Unix it can have more than one flag. Each white space separated
6526 part is passed as an argument to the shell command.
6527 See |option-backslash| about including spaces and backslashes.
6528 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 This option cannot be set from a |modeline| or in the |sandbox|, for
6530 security reasons.
6531
6532 *'shellpipe'* *'sp'*
6533'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6534 global
6535 {not in Vi}
6536 {not available when compiled without the |+quickfix|
6537 feature}
6538 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006539 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 including spaces and backslashes.
6541 The name of the temporary file can be represented by "%s" if necessary
6542 (the file name is appended automatically if no %s appears in the value
6543 of this option).
6544 For the Amiga and MS-DOS the default is ">". The output is directly
6545 saved in a file and not echoed to the screen.
6546 For Unix the default it "| tee". The stdout of the compiler is saved
6547 in a file and echoed to the screen. If the 'shell' option is "csh" or
6548 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006549 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6550 default becomes "2>&1| tee". This means that stderr is also included.
6551 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6552 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 The initialization of this option is done after reading the ".vimrc"
6554 and the other initializations, so that when the 'shell' option is set
6555 there, the 'shellpipe' option changes automatically, unless it was
6556 explicitly set before.
6557 When 'shellpipe' is set to an empty string, no redirection of the
6558 ":make" output will be done. This is useful if you use a 'makeprg'
6559 that writes to 'makeef' by itself. If you want no piping, but do
6560 want to include the 'makeef', set 'shellpipe' to a single space.
6561 Don't forget to precede the space with a backslash: ":set sp=\ ".
6562 In the future pipes may be used for filtering and this option will
6563 become obsolete (at least for Unix).
6564 This option cannot be set from a |modeline| or in the |sandbox|, for
6565 security reasons.
6566
6567 *'shellquote'* *'shq'*
6568'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6569 contains "sh" somewhere: "\"")
6570 global
6571 {not in Vi}
6572 Quoting character(s), put around the command passed to the shell, for
6573 the "!" and ":!" commands. The redirection is kept outside of the
6574 quoting. See 'shellxquote' to include the redirection. It's
6575 probably not useful to set both options.
6576 This is an empty string by default. Only known to be useful for
6577 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6578 or bash, where it should be "\"". The default is adjusted according
6579 the value of 'shell', to reduce the need to set this option by the
6580 user. See |dos-shell|.
6581 This option cannot be set from a |modeline| or in the |sandbox|, for
6582 security reasons.
6583
6584 *'shellredir'* *'srr'*
6585'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6586 global
6587 {not in Vi}
6588 String to be used to put the output of a filter command in a temporary
6589 file. See also |:!|. See |option-backslash| about including spaces
6590 and backslashes.
6591 The name of the temporary file can be represented by "%s" if necessary
6592 (the file name is appended automatically if no %s appears in the value
6593 of this option).
6594 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6595 or "zsh" during initializations, the default becomes ">&". If the
6596 'shell' option is "sh", "ksh" or "bash" the default becomes
6597 ">%s 2>&1". This means that stderr is also included.
6598 For Win32, the Unix checks are done and additionally "cmd" is checked
6599 for, which makes the default ">%s 2>&1". Also, the same names with
6600 ".exe" appended are checked for.
6601 The initialization of this option is done after reading the ".vimrc"
6602 and the other initializations, so that when the 'shell' option is set
6603 there, the 'shellredir' option changes automatically unless it was
6604 explicitly set before.
6605 In the future pipes may be used for filtering and this option will
6606 become obsolete (at least for Unix).
6607 This option cannot be set from a |modeline| or in the |sandbox|, for
6608 security reasons.
6609
6610 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6611'shellslash' 'ssl' boolean (default off)
6612 global
6613 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6614 When set, a forward slash is used when expanding file names. This is
6615 useful when a Unix-like shell is used instead of command.com or
6616 cmd.exe. Backward slashes can still be typed, but they are changed to
6617 forward slashes by Vim.
6618 Note that setting or resetting this option has no effect for some
6619 existing file names, thus this option needs to be set before opening
6620 any file for best results. This might change in the future.
6621 'shellslash' only works when a backslash can be used as a path
6622 separator. To test if this is so use: >
6623 if exists('+shellslash')
6624<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006625 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6626'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6627 global
6628 {not in Vi}
6629 When on, use temp files for shell commands. When off use a pipe.
6630 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006631 Currently a pipe is only supported on Unix and MS-Windows 2K and
6632 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006633 :if has("filterpipe")
6634< The advantage of using a pipe is that nobody can read the temp file
6635 and the 'shell' command does not need to support redirection.
6636 The advantage of using a temp file is that the file type and encoding
6637 can be detected.
6638 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6639 |FilterWritePost| autocommands event are not triggered when
6640 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006641 The `system()` function does not respect this option and always uses
6642 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006643 NOTE: This option is set to the Vim default value when 'compatible'
6644 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006645
Bram Moolenaar071d4272004-06-13 20:20:40 +00006646 *'shelltype'* *'st'*
6647'shelltype' 'st' number (default 0)
6648 global
6649 {not in Vi} {only for the Amiga}
6650 On the Amiga this option influences the way how the commands work
6651 which use a shell.
6652 0 and 1: always use the shell
6653 2 and 3: use the shell only to filter lines
6654 4 and 5: use shell only for ':sh' command
6655 When not using the shell, the command is executed directly.
6656
6657 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6658 1 and 3: use "shell cmd" to start external commands
6659
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006660 *'shellxescape'* *'sxe'*
6661'shellxescape' 'sxe' string (default: "";
6662 for MS-DOS and MS-Windows: "\"&|<>()@^")
6663 global
6664 {not in Vi}
6665 When 'shellxquote' is set to "(" then the characters listed in this
6666 option will be escaped with a '^' character. This makes it possible
6667 to execute most external commands with cmd.exe.
6668
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 *'shellxquote'* *'sxq'*
6670'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006671 for Win32, when 'shell' is cmd.exe: "("
6672 for Win32, when 'shell' contains "sh"
6673 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 for Unix, when using system(): "\"")
6675 global
6676 {not in Vi}
6677 Quoting character(s), put around the command passed to the shell, for
6678 the "!" and ":!" commands. Includes the redirection. See
6679 'shellquote' to exclude the redirection. It's probably not useful
6680 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006681 When the value is '(' then ')' is appended. When the value is '"('
6682 then ')"' is appended.
6683 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006684 This is an empty string by default on most systems, but is known to be
6685 useful for on Win32 version, either for cmd.exe which automatically
6686 strips off the first and last quote on a command, or 3rd-party shells
6687 such as the MKS Korn Shell or bash, where it should be "\"". The
6688 default is adjusted according the value of 'shell', to reduce the need
6689 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 This option cannot be set from a |modeline| or in the |sandbox|, for
6691 security reasons.
6692
6693 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6694'shiftround' 'sr' boolean (default off)
6695 global
6696 {not in Vi}
6697 Round indent to multiple of 'shiftwidth'. Applies to > and <
6698 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6699 a multiple of 'shiftwidth' (this is Vi compatible).
6700 NOTE: This option is reset when 'compatible' is set.
6701
6702 *'shiftwidth'* *'sw'*
6703'shiftwidth' 'sw' number (default 8)
6704 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006705 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006707 When zero the 'ts' value will be used. Use the |shiftwidth()|
6708 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709
6710 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006711'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6712 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 global
6714 {not in Vi}
6715 This option helps to avoid all the |hit-enter| prompts caused by file
6716 messages, for example with CTRL-G, and to avoid some other messages.
6717 It is a list of flags:
6718 flag meaning when present ~
6719 f use "(3 of 5)" instead of "(file 3 of 5)"
6720 i use "[noeol]" instead of "[Incomplete last line]"
6721 l use "999L, 888C" instead of "999 lines, 888 characters"
6722 m use "[+]" instead of "[Modified]"
6723 n use "[New]" instead of "[New File]"
6724 r use "[RO]" instead of "[readonly]"
6725 w use "[w]" instead of "written" for file write message
6726 and "[a]" instead of "appended" for ':w >> file' command
6727 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6728 "[unix format]" and "[mac]" instead of "[mac format]".
6729 a all of the above abbreviations
6730
6731 o overwrite message for writing a file with subsequent message
6732 for reading a file (useful for ":wn" or when 'autowrite' on)
6733 O message for reading a file overwrites any previous message.
6734 Also for quickfix message (e.g., ":cn").
6735 s don't give "search hit BOTTOM, continuing at TOP" or "search
6736 hit TOP, continuing at BOTTOM" messages
6737 t truncate file message at the start if it is too long to fit
6738 on the command-line, "<" will appear in the left most column.
6739 Ignored in Ex mode.
6740 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006741 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 Ignored in Ex mode.
6743 W don't give "written" or "[w]" when writing a file
6744 A don't give the "ATTENTION" message when an existing swap file
6745 is found.
6746 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006747 c don't give |ins-completion-menu| messages. For example,
6748 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6749 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006750 q use "recording" instead of "recording @a"
6751 F don't give the file info when editing a file, like `:silent`
6752 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753
6754 This gives you the opportunity to avoid that a change between buffers
6755 requires you to hit <Enter>, but still gives as useful a message as
6756 possible for the space available. To get the whole message that you
6757 would have got with 'shm' empty, use ":file!"
6758 Useful values:
6759 shm= No abbreviation of message.
6760 shm=a Abbreviation, but no loss of information.
6761 shm=at Abbreviation, and truncate message when necessary.
6762
6763 NOTE: This option is set to the Vi default value when 'compatible' is
6764 set and to the Vim default value when 'compatible' is reset.
6765
6766 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6767'shortname' 'sn' boolean (default off)
6768 local to buffer
6769 {not in Vi, not in MS-DOS versions}
6770 Filenames are assumed to be 8 characters plus one extension of 3
6771 characters. Multiple dots in file names are not allowed. When this
6772 option is on, dots in file names are replaced with underscores when
6773 adding an extension (".~" or ".swp"). This option is not available
6774 for MS-DOS, because then it would always be on. This option is useful
6775 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6776 or crossdos. When running the Win32 GUI version under Win32s, this
6777 option is always on by default.
6778
6779 *'showbreak'* *'sbr'* *E595*
6780'showbreak' 'sbr' string (default "")
6781 global
6782 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006783 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 feature}
6785 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006786 values are "> " or "+++ ": >
6787 :set showbreak=>\
6788< Note the backslash to escape the trailing space. It's easier like
6789 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006790 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006791< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792 comma (in a future version the comma might be used to separate the
6793 part that is shown at the end and at the start of a line).
6794 The characters are highlighted according to the '@' flag in
6795 'highlight'.
6796 Note that tabs after the showbreak will be displayed differently.
6797 If you want the 'showbreak' to appear in between line numbers, add the
6798 "n" flag to 'cpoptions'.
6799
6800 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006801'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6802 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803 global
6804 {not in Vi}
6805 {not available when compiled without the
6806 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006807 Show (partial) command in the last line of the screen. Set this
6808 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 In Visual mode the size of the selected area is shown:
6810 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006811 If the number of bytes is different it is also displayed: "2-6"
6812 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006814 - When selecting a block, the size in screen characters:
6815 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816 NOTE: This option is set to the Vi default value when 'compatible' is
6817 set and to the Vim default value when 'compatible' is reset.
6818
6819 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6820'showfulltag' 'sft' boolean (default off)
6821 global
6822 {not in Vi}
6823 When completing a word in insert mode (see |ins-completion|) from the
6824 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006825 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826 matched a C function, you can see a template for what arguments are
6827 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006828 Note that this doesn't work well together with having "longest" in
6829 'completeopt', because the completion from the search pattern may not
6830 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831
6832 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6833'showmatch' 'sm' boolean (default off)
6834 global
6835 When a bracket is inserted, briefly jump to the matching one. The
6836 jump is only done if the match can be seen on the screen. The time to
6837 show the match can be set with 'matchtime'.
6838 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006839 seen or not).
6840 This option is reset when 'paste' is set and restored when 'paste' is
6841 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842 When the 'm' flag is not included in 'cpoptions', typing a character
6843 will immediately move the cursor back to where it belongs.
6844 See the "sm" field in 'guicursor' for setting the cursor shape and
6845 blinking when showing the match.
6846 The 'matchpairs' option can be used to specify the characters to show
6847 matches for. 'rightleft' and 'revins' are used to look for opposite
6848 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006849 Also see the matchparen plugin for highlighting the match when moving
6850 around |pi_paren.txt|.
6851 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852
6853 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6854'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6855 global
6856 If in Insert, Replace or Visual mode put a message on the last line.
6857 Use the 'M' flag in 'highlight' to set the type of highlighting for
6858 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006859 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 doesn't mean XIM is really active, especially when 'imactivatekey' is
6861 not set.
6862 NOTE: This option is set to the Vi default value when 'compatible' is
6863 set and to the Vim default value when 'compatible' is reset.
6864
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006865 *'showtabline'* *'stal'*
6866'showtabline' 'stal' number (default 1)
6867 global
6868 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006869 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006870 feature}
6871 The value of this option specifies when the line with tab page labels
6872 will be displayed:
6873 0: never
6874 1: only if there are at least two tab pages
6875 2: always
6876 This is both for the GUI and non-GUI implementation of the tab pages
6877 line.
6878 See |tab-page| for more information about tab pages.
6879
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 *'sidescroll'* *'ss'*
6881'sidescroll' 'ss' number (default 0)
6882 global
6883 {not in Vi}
6884 The minimal number of columns to scroll horizontally. Used only when
6885 the 'wrap' option is off and the cursor is moved off of the screen.
6886 When it is zero the cursor will be put in the middle of the screen.
6887 When using a slow terminal set it to a large number or 0. When using
6888 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6889 commands.
6890
6891 *'sidescrolloff'* *'siso'*
6892'sidescrolloff' 'siso' number (default 0)
6893 global
6894 {not in Vi}
6895 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006896 right of the cursor if 'nowrap' is set. Setting this option to a
6897 value greater than 0 while having |'sidescroll'| also at a non-zero
6898 value makes some context visible in the line you are scrolling in
6899 horizontally (except at beginning of the line). Setting this option
6900 to a large value (like 999) has the effect of keeping the cursor
6901 horizontally centered in the window, as long as one does not come too
6902 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 NOTE: This option is set to 0 when 'compatible' is set.
6904
6905 Example: Try this together with 'sidescroll' and 'listchars' as
6906 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006907 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908
6909 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6910 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006911<
6912 *'signcolumn'* *'scl'*
6913'signcolumn' 'scl' string (default "auto")
6914 local to window
6915 {not in Vi}
6916 {not available when compiled without the |+signs|
6917 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006918 Whether or not to draw the signcolumn. Valid values are:
6919 "auto" only when there is a sign to display
6920 "no" never
6921 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00006922
6923
6924 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6925'smartcase' 'scs' boolean (default off)
6926 global
6927 {not in Vi}
6928 Override the 'ignorecase' option if the search pattern contains upper
6929 case characters. Only used when the search pattern is typed and
6930 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006931 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6933 recalling the search pattern from history and hitting <Enter>.
6934 NOTE: This option is reset when 'compatible' is set.
6935
6936 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6937'smartindent' 'si' boolean (default off)
6938 local to buffer
6939 {not in Vi}
6940 {not available when compiled without the
6941 |+smartindent| feature}
6942 Do smart autoindenting when starting a new line. Works for C-like
6943 programs, but can also be used for other languages. 'cindent' does
6944 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006945 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006946 setting 'si' has no effect. 'indentexpr' is a more advanced
6947 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948 Normally 'autoindent' should also be on when using 'smartindent'.
6949 An indent is automatically inserted:
6950 - After a line ending in '{'.
6951 - After a line starting with a keyword from 'cinwords'.
6952 - Before a line starting with '}' (only with the "O" command).
6953 When typing '}' as the first character in a new line, that line is
6954 given the same indent as the matching '{'.
6955 When typing '#' as the first character in a new line, the indent for
6956 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006957 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006958 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6959 When using the ">>" command, lines starting with '#' are not shifted
6960 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006961 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006962 This option is reset when 'paste' is set and restored when 'paste' is
6963 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964
6965 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6966'smarttab' 'sta' boolean (default off)
6967 global
6968 {not in Vi}
6969 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006970 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6971 <BS> will delete a 'shiftwidth' worth of space at the start of the
6972 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006973 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006974 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6975 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006976 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006977 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006978 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006979 This option is reset when 'paste' is set and restored when 'paste' is
6980 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 NOTE: This option is reset when 'compatible' is set.
6982
6983 *'softtabstop'* *'sts'*
6984'softtabstop' 'sts' number (default 0)
6985 local to buffer
6986 {not in Vi}
6987 Number of spaces that a <Tab> counts for while performing editing
6988 operations, like inserting a <Tab> or using <BS>. It "feels" like
6989 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6990 used. This is useful to keep the 'ts' setting at its standard value
6991 of 8, while being able to edit like it is set to 'sts'. However,
6992 commands like "x" still work on the actual characters.
6993 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006994 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006995 'softtabstop' is set to 0 when the 'paste' option is set and restored
6996 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6998 spaces is minimized by using <Tab>s.
6999 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7000 set.
7001 NOTE: This option is set to 0 when 'compatible' is set.
7002
Bram Moolenaar217ad922005-03-20 22:37:15 +00007003 *'spell'* *'nospell'*
7004'spell' boolean (default off)
7005 local to window
7006 {not in Vi}
7007 {not available when compiled without the |+syntax|
7008 feature}
7009 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007010 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007011
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007012 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007013'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007014 local to buffer
7015 {not in Vi}
7016 {not available when compiled without the |+syntax|
7017 feature}
7018 Pattern to locate the end of a sentence. The following word will be
7019 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007020 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007021 When this check is not wanted make this option empty.
7022 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007023 Be careful with special characters, see |option-backslash| about
7024 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007025 To set this option automatically depending on the language, see
7026 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007027
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007028 *'spellfile'* *'spf'*
7029'spellfile' 'spf' string (default empty)
7030 local to buffer
7031 {not in Vi}
7032 {not available when compiled without the |+syntax|
7033 feature}
7034 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007035 commands. It must end in ".{encoding}.add". You need to include the
7036 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007037 *E765*
7038 It may also be a comma separated list of names. A count before the
7039 |zg| and |zw| commands can be used to access each. This allows using
7040 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007041 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007042 you: Using the first directory in 'runtimepath' that is writable. If
7043 there is no "spell" directory yet it will be created. For the file
7044 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007045 ignoring the region.
7046 The resulting ".spl" file will be used for spell checking, it does not
7047 have to appear in 'spelllang'.
7048 Normally one file is used for all regions, but you can add the region
7049 name if you want to. However, it will then only be used when
7050 'spellfile' is set to it, for entries in 'spelllang' only files
7051 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007052 This option cannot be set from a |modeline| or in the |sandbox|, for
7053 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007054
Bram Moolenaar217ad922005-03-20 22:37:15 +00007055 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007056'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007057 local to buffer
7058 {not in Vi}
7059 {not available when compiled without the |+syntax|
7060 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007061 A comma separated list of word list names. When the 'spell' option is
7062 on spellchecking will be done for these languages. Example: >
7063 set spelllang=en_us,nl,medical
7064< This means US English, Dutch and medical words are recognized. Words
7065 that are not recognized will be highlighted.
7066 The word list name must not include a comma or dot. Using a dash is
7067 recommended to separate the two letter language name from a
7068 specification. Thus "en-rare" is used for rare English words.
7069 A region name must come last and have the form "_xx", where "xx" is
7070 the two-letter, lower case region name. You can use more than one
7071 region by listing them: "en_us,en_ca" supports both US and Canadian
7072 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007073 Britain. (Note: currently en_au and en_nz dictionaries are older than
7074 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007075 If the name "cjk" is included East Asian characters are excluded from
7076 spell checking. This is useful when editing text that also has Asian
7077 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007078 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007079 As a special case the name of a .spl file can be given as-is. The
7080 first "_xx" in the name is removed and used as the region name
7081 (_xx is an underscore, two letters and followed by a non-letter).
7082 This is mainly for testing purposes. You must make sure the correct
7083 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007084 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007085 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7086 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007087 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007088
Bram Moolenaar98692072006-02-04 00:57:42 +00007089 If the |spellfile.vim| plugin is active and you use a language name
7090 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7091 will ask you if you want to download the file.
7092
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007093 After this option has been set successfully, Vim will source the files
7094 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007095 up to the first comma, dot or underscore.
7096 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007097
7098
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007099 *'spellsuggest'* *'sps'*
7100'spellsuggest' 'sps' string (default "best")
7101 global
7102 {not in Vi}
7103 {not available when compiled without the |+syntax|
7104 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007105 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007106 the |spellsuggest()| function. This is a comma-separated list of
7107 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007108
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007109 best Internal method that works best for English. Finds
7110 changes like "fast" and uses a bit of sound-a-like
7111 scoring to improve the ordering.
7112
7113 double Internal method that uses two methods and mixes the
7114 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007115 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007116 word. That only works when the language specifies
7117 sound folding. Can be slow and doesn't always give
7118 better results.
7119
7120 fast Internal method that only checks for simple changes:
7121 character inserts/deletes/swaps. Works well for
7122 simple typing mistakes.
7123
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007124 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007125 Not used for |spellsuggest()|. The number of
7126 suggestions is never more than the value of 'lines'
7127 minus two.
7128
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007129 file:{filename} Read file {filename}, which must have two columns,
7130 separated by a slash. The first column contains the
7131 bad word, the second column the suggested good word.
7132 Example:
7133 theribal/terrible ~
7134 Use this for common mistakes that do not appear at the
7135 top of the suggestion list with the internal methods.
7136 Lines without a slash are ignored, use this for
7137 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007138 The word in the second column must be correct,
7139 otherwise it will not be used. Add the word to an
7140 ".add" file if it is currently flagged as a spelling
7141 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007142 The file is used for all languages.
7143
7144 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7145 trouble with spaces. |v:val| holds the badly spelled
7146 word. The expression must evaluate to a List of
7147 Lists, each with a suggestion and a score.
7148 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007149 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007150 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007151 internal methods use. A lower score is better.
7152 This may invoke |spellsuggest()| if you temporarily
7153 set 'spellsuggest' to exclude the "expr:" part.
7154 Errors are silently ignored, unless you set the
7155 'verbose' option to a non-zero value.
7156
7157 Only one of "best", "double" or "fast" may be used. The others may
7158 appear several times in any order. Example: >
7159 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7160<
7161 This option cannot be set from a |modeline| or in the |sandbox|, for
7162 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007163
7164
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7166'splitbelow' 'sb' boolean (default off)
7167 global
7168 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007169 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007170 feature}
7171 When on, splitting a window will put the new window below the current
7172 one. |:split|
7173
7174 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7175'splitright' 'spr' boolean (default off)
7176 global
7177 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007178 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 feature}
7180 When on, splitting a window will put the new window right of the
7181 current one. |:vsplit|
7182
7183 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7184'startofline' 'sol' boolean (default on)
7185 global
7186 {not in Vi}
7187 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007188 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007189 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007190 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191 with a linewise operator, with "%" with a count and to buffer changing
7192 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7193 only has a line number, e.g., ":25" or ":+".
7194 In case of buffer changing commands the cursor is placed at the column
7195 where it was the last time the buffer was edited.
7196 NOTE: This option is set when 'compatible' is set.
7197
Bram Moolenaar00654022011-02-25 14:42:19 +01007198 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007199'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007200 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201 {not in Vi}
7202 {not available when compiled without the |+statusline|
7203 feature}
7204 When nonempty, this option determines the content of the status line.
7205 Also see |status-line|.
7206
7207 The option consists of printf style '%' items interspersed with
7208 normal text. Each status line item is of the form:
7209 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007210 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007211 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212
Bram Moolenaar238a5642006-02-21 22:12:05 +00007213 When the option starts with "%!" then it is used as an expression,
7214 evaluated and the result is used as the option value. Example: >
7215 :set statusline=%!MyStatusLine()
7216< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007217 Note that the "%!" expression is evaluated in the context of the
7218 current window and buffer, while %{} items are evaluated in the
7219 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007220
7221 When there is error while evaluating the option then it will be made
7222 empty to avoid further errors. Otherwise screen updating would loop.
7223
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224 Note that the only effect of 'ruler' when this option is set (and
7225 'laststatus' is 2) is controlling the output of |CTRL-G|.
7226
7227 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007228 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007229 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007230 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 minwid Minimum width of the item, padding as set by '-' & '0'.
7232 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007233 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234 on the left for text items. Numeric items will be
7235 shifted down to maxwid-2 digits followed by '>'number
7236 where number is the amount of missing digits, much like
7237 an exponential notation.
7238 item A one letter code as described below.
7239
7240 Following is a description of the possible statusline items. The
7241 second character in "item" is the type:
7242 N for number
7243 S for string
7244 F for flags as described below
7245 - not applicable
7246
7247 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007248 f S Path to the file in the buffer, as typed or relative to current
7249 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007250 F S Full path to the file in the buffer.
7251 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007252 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007254 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007256 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007257 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007258 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007260 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007261 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
7262 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007263 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007264 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7265 being used: "<keymap>"
7266 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007267 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 B N As above, in hexadecimal.
7269 o N Byte number in file of byte under cursor, first byte is 1.
7270 Mnemonic: Offset from start of file (with one added)
7271 {not available when compiled without |+byte_offset| feature}
7272 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007273 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274 l N Line number.
7275 L N Number of lines in buffer.
7276 c N Column number.
7277 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007278 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 p N Percentage through file in lines as in |CTRL-G|.
7280 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007281 percentage described for 'ruler'. Always 3 in length, unless
7282 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007283 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007285 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00007286 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287 ( - Start of item group. Can be used for setting the width and
7288 alignment of a section. Must be followed by %) somewhere.
7289 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007290 T N For 'tabline': start of tab page N label. Use %T after the last
7291 label. This information is used for mouse clicks.
7292 X N For 'tabline': start of close tab N label. Use %X after the
7293 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7294 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007295 < - Where to truncate line if too long. Default is at the start.
7296 No width fields allowed.
7297 = - Separation point between left and right aligned items.
7298 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007299 # - Set highlight group. The name must follow and then a # again.
7300 Thus use %#HLname# for highlight group HLname. The same
7301 highlighting is used, also for the statusline of non-current
7302 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007303 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007304 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007305 The difference between User{N} and StatusLine will be applied
7306 to StatusLineNC for the statusline of non-current windows.
7307 The number N must be between 1 and 9. See |hl-User1..9|
7308
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007309 When displaying a flag, Vim removes the leading comma, if any, when
7310 that flag comes right after plaintext. This will make a nice display
7311 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312
Bram Moolenaar582fd852005-03-28 20:58:01 +00007313 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007314 not set) and a minwid is not set for the group, the whole group will
7315 become empty. This will make a group like the following disappear
7316 completely from the statusline when none of the flags are set. >
7317 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007318< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319 Beware that an expression is evaluated each and every time the status
7320 line is displayed. The current buffer and current window will be set
7321 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007322 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007323 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007324 real current buffer.
7325
Bram Moolenaar30b65812012-07-12 22:01:11 +02007326 The 'statusline' option will be evaluated in the |sandbox| if set from
7327 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007328
7329 It is not allowed to change text or jump to another window while
7330 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007331
7332 If the statusline is not updated when you want it (e.g., after setting
7333 a variable that's used in an expression), you can force an update by
7334 setting an option without changing its value. Example: >
7335 :let &ro = &ro
7336
7337< A result of all digits is regarded a number for display purposes.
7338 Otherwise the result is taken as flag text and applied to the rules
7339 described above.
7340
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007341 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007343 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344
7345 Examples:
7346 Emulate standard status line with 'ruler' set >
7347 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7348< Similar, but add ASCII value of char under the cursor (like "ga") >
7349 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7350< Display byte count and byte value, modified flag in red. >
7351 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7352 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7353< Display a ,GZ flag if a compressed file is loaded >
7354 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7355< In the |:autocmd|'s: >
7356 :let b:gzflag = 1
7357< And: >
7358 :unlet b:gzflag
7359< And define this function: >
7360 :function VarExists(var, val)
7361 : if exists(a:var) | return a:val | else | return '' | endif
7362 :endfunction
7363<
7364 *'suffixes'* *'su'*
7365'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7366 global
7367 {not in Vi}
7368 Files with these suffixes get a lower priority when multiple files
7369 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007370 suffixes. Spaces after the comma are ignored. A dot is also seen as
7371 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372 separator, precede it with a backslash (see |option-backslash| about
7373 including spaces and backslashes).
7374 See 'wildignore' for completely ignoring files.
7375 The use of |:set+=| and |:set-=| is preferred when adding or removing
7376 suffixes from the list. This avoids problems when a future version
7377 uses another default.
7378
7379 *'suffixesadd'* *'sua'*
7380'suffixesadd' 'sua' string (default "")
7381 local to buffer
7382 {not in Vi}
7383 {not available when compiled without the
7384 |+file_in_path| feature}
7385 Comma separated list of suffixes, which are used when searching for a
7386 file for the "gf", "[I", etc. commands. Example: >
7387 :set suffixesadd=.java
7388<
7389 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7390'swapfile' 'swf' boolean (default on)
7391 local to buffer
7392 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007393 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394 swapfile is not wanted for a specific buffer. For example, with
7395 confidential information that even root must not be able to access.
7396 Careful: All text will be in memory:
7397 - Don't use this for big files.
7398 - Recovery will be impossible!
7399 A swapfile will only be present when |'updatecount'| is non-zero and
7400 'swapfile' is set.
7401 When 'swapfile' is reset, the swap file for the current buffer is
7402 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7403 non-zero, a swap file is immediately created.
7404 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007405 If you want to open a new buffer without creating a swap file for it,
7406 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007407
7408 This option is used together with 'bufhidden' and 'buftype' to
7409 specify special kinds of buffers. See |special-buffers|.
7410
7411 *'swapsync'* *'sws'*
7412'swapsync' 'sws' string (default "fsync")
7413 global
7414 {not in Vi}
7415 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007416 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417 When this option is empty parts of the swap file may be in memory and
7418 not written to disk. When the system crashes you may lose more work.
7419 On Unix the system does a sync now and then without Vim asking for it,
7420 so the disadvantage of setting this option off is small. On some
7421 systems the swap file will not be written at all. For a unix system
7422 setting it to "sync" will use the sync() call instead of the default
7423 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007424 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007425
7426 *'switchbuf'* *'swb'*
7427'switchbuf' 'swb' string (default "")
7428 global
7429 {not in Vi}
7430 This option controls the behavior when switching between buffers.
7431 Possible values (comma separated list):
7432 useopen If included, jump to the first open window that
7433 contains the specified buffer (if there is one).
7434 Otherwise: Do not examine other windows.
7435 This setting is checked with |quickfix| commands, when
7436 jumping to errors (":cc", ":cn", "cp", etc.). It is
7437 also used in all buffer related split commands, for
7438 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007439 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007440 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007441 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007442 a buffer for a |quickfix| command that display errors.
7443 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007444 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007445 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007446 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007448 *'synmaxcol'* *'smc'*
7449'synmaxcol' 'smc' number (default 3000)
7450 local to buffer
7451 {not in Vi}
7452 {not available when compiled without the |+syntax|
7453 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007454 Maximum column in which to search for syntax items. In long lines the
7455 text after this column is not highlighted and following lines may not
7456 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007457 This helps to avoid very slow redrawing for an XML file that is one
7458 long line.
7459 Set to zero to remove the limit.
7460
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461 *'syntax'* *'syn'*
7462'syntax' 'syn' string (default empty)
7463 local to buffer
7464 {not in Vi}
7465 {not available when compiled without the |+syntax|
7466 feature}
7467 When this option is set, the syntax with this name is loaded, unless
7468 syntax highlighting has been switched off with ":syntax off".
7469 Otherwise this option does not always reflect the current syntax (the
7470 b:current_syntax variable does).
7471 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007472 not automatically recognized. Example, in an IDL file:
7473 /* vim: set syntax=idl : */ ~
7474 When a dot appears in the value then this separates two filetype
7475 names. Example:
7476 /* vim: set syntax=c.doxygen : */ ~
7477 This will use the "c" syntax first, then the "doxygen" syntax.
7478 Note that the second one must be prepared to be loaded as an addition,
7479 otherwise it will be skipped. More than one dot may appear.
7480 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 :set syntax=OFF
7482< To switch syntax highlighting on according to the current value of the
7483 'filetype' option: >
7484 :set syntax=ON
7485< What actually happens when setting the 'syntax' option is that the
7486 Syntax autocommand event is triggered with the value as argument.
7487 This option is not copied to another buffer, independent of the 's' or
7488 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007489 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007491 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007492'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007493 global
7494 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007495 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007496 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007497 When nonempty, this option determines the content of the tab pages
7498 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007499 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007500
7501 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007502 option and only when there is no GUI tab line. When 'e' is in
7503 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007504 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007505
7506 The value is evaluated like with 'statusline'. You can use
7507 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007508 the text to be displayed. Use "%1T" for the first label, "%2T" for
7509 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007510
7511 Keep in mind that only one of the tab pages is the current one, others
7512 are invisible and you can't jump to their windows.
7513
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007514
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007515 *'tabpagemax'* *'tpm'*
7516'tabpagemax' 'tpm' number (default 10)
7517 global
7518 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007519 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007520 feature}
7521 Maximum number of tab pages to be opened by the |-p| command line
7522 argument or the ":tab all" command. |tabpage|
7523
7524
7525 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526'tabstop' 'ts' number (default 8)
7527 local to buffer
7528 Number of spaces that a <Tab> in the file counts for. Also see
7529 |:retab| command, and 'softtabstop' option.
7530
7531 Note: Setting 'tabstop' to any other value than 8 can make your file
7532 appear wrong in many places (e.g., when printing it).
7533
7534 There are four main ways to use tabs in Vim:
7535 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7536 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007537 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538 behave like a tab appears every 4 (or 3) characters.
7539 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7540 'expandtab'. This way you will always insert spaces. The
7541 formatting will never be messed up when 'tabstop' is changed.
7542 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007543 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 works when using Vim to edit the file.
7545 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7546 'noexpandtab'. This should then work (for initial indents only)
7547 for any tabstop setting that people use. It might be nice to have
7548 tabs after the first non-blank inserted as spaces if you do this
7549 though. Otherwise aligned comments will be wrong when 'tabstop' is
7550 changed.
7551
7552 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7553'tagbsearch' 'tbs' boolean (default on)
7554 global
7555 {not in Vi}
7556 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007557 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 searching makes searching for a tag a LOT faster, but a linear search
7559 will find more tags if the tags file wasn't properly sorted.
7560 Vim normally assumes that your tags files are sorted, or indicate that
7561 they are not sorted. Only when this is not the case does the
7562 'tagbsearch' option need to be switched off.
7563
7564 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007565 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 certain files, or retry all files with a linear search. When
7567 'tagbsearch' is off, only a linear search is done.
7568
7569 Linear searching is done anyway, for one file, when Vim finds a line
7570 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007571 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007572< [The whitespace before and after the '0' must be a single <Tab>]
7573
7574 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007575 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007576 instead of a normal tag name, a retry is done with a linear search.
7577 Tags in unsorted tags files, and matches with different case will only
7578 be found in the retry.
7579
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007580 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007581 linear search can be avoided when case is ignored. Use a value of '2'
7582 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7583 sorted with the -f switch to "sort" in most unices, as in the command:
7584 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7585 (at least 5.5) the --sort=foldcase switch can be used for this as
7586 well. Note that case must be folded to uppercase for this to work.
7587
7588 By default, tag searches are case-sensitive. Case is ignored when
7589 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7590 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007591 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7592 'tagcase' is "smart", and the pattern contains only lowercase
7593 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594
7595 When 'tagbsearch' is off, tags searching is slower when a full match
7596 exists, but faster when no full match exists. Tags in unsorted tags
7597 files may only be found with 'tagbsearch' off.
7598 When the tags file is not sorted, or sorted in a wrong way (not on
7599 ASCII byte value), 'tagbsearch' should be off, or the line given above
7600 must be included in the tags file.
7601 This option doesn't affect commands that find all matching tags (e.g.,
7602 command-line completion and ":help").
7603 {Vi: always uses binary search in some versions}
7604
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007605 *'tagcase'* *'tc'*
7606'tagcase' 'tc' string (default "followic")
7607 global or local to buffer |global-local|
7608 {not in Vi}
7609 This option specifies how case is handled when searching the tags
7610 file:
7611 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007612 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007613 ignore Ignore case
7614 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007615 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007616 NOTE: This option is set to the Vi default value when 'compatible' is
7617 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007618
Bram Moolenaar071d4272004-06-13 20:20:40 +00007619 *'taglength'* *'tl'*
7620'taglength' 'tl' number (default 0)
7621 global
7622 If non-zero, tags are significant up to this number of characters.
7623
7624 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7625'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7626 global
7627 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007628 If on and using a tags file in another directory, file names in that
7629 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007630 NOTE: This option is set to the Vi default value when 'compatible' is
7631 set and to the Vim default value when 'compatible' is reset.
7632
7633 *'tags'* *'tag'* *E433*
7634'tags' 'tag' string (default "./tags,tags", when compiled with
7635 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7636 global or local to buffer |global-local|
7637 Filenames for the tag command, separated by spaces or commas. To
7638 include a space or comma in a file name, precede it with a backslash
7639 (see |option-backslash| about including spaces and backslashes).
7640 When a file name starts with "./", the '.' is replaced with the path
7641 of the current file. But only when the 'd' flag is not included in
7642 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7643 |tags-option|.
7644 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007645 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7646 find all files named "tags" below "/lib". The filename itself cannot
7647 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7648 files called "tags?". {not available when compiled without the
7649 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007650 The |tagfiles()| function can be used to get a list of the file names
7651 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7653 files are also supported. They are automatically recognized. The
7654 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7655 differences are ignored (MS-Windows). |emacs-tags|
7656 The use of |:set+=| and |:set-=| is preferred when adding or removing
7657 file names from the list. This avoids problems when a future version
7658 uses another default.
7659 {Vi: default is "tags /usr/lib/tags"}
7660
7661 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7662'tagstack' 'tgst' boolean (default on)
7663 global
7664 {not in all versions of Vi}
7665 When on, the |tagstack| is used normally. When off, a ":tag" or
7666 ":tselect" command with an argument will not push the tag onto the
7667 tagstack. A following ":tag" without an argument, a ":pop" command or
7668 any other command that uses the tagstack will use the unmodified
7669 tagstack, but does change the pointer to the active entry.
7670 Resetting this option is useful when using a ":tag" command in a
7671 mapping which should not change the tagstack.
7672
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007673 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007674'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007675 global
7676 {not in Vi}
7677 {only available when compiled with the |+tcl/dyn|
7678 feature}
7679 Specifies the name of the Tcl shared library. The default is
7680 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007681 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007682 This option cannot be set from a |modeline| or in the |sandbox|, for
7683 security reasons.
7684
Bram Moolenaar071d4272004-06-13 20:20:40 +00007685 *'term'* *E529* *E530* *E531*
7686'term' string (default is $TERM, if that fails:
7687 in the GUI: "builtin_gui"
7688 on Amiga: "amiga"
7689 on BeOS: "beos-ansi"
7690 on Mac: "mac-ansi"
7691 on MiNT: "vt52"
7692 on MS-DOS: "pcterm"
7693 on OS/2: "os2ansi"
7694 on Unix: "ansi"
7695 on VMS: "ansi"
7696 on Win 32: "win32")
7697 global
7698 Name of the terminal. Used for choosing the terminal control
7699 characters. Environment variables are expanded |:set_env|.
7700 For example: >
7701 :set term=$TERM
7702< See |termcap|.
7703
7704 *'termbidi'* *'tbidi'*
7705 *'notermbidi'* *'notbidi'*
7706'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7707 global
7708 {not in Vi}
7709 {only available when compiled with the |+arabic|
7710 feature}
7711 The terminal is in charge of Bi-directionality of text (as specified
7712 by Unicode). The terminal is also expected to do the required shaping
7713 that some languages (such as Arabic) require.
7714 Setting this option implies that 'rightleft' will not be set when
7715 'arabic' is set and the value of 'arabicshape' will be ignored.
7716 Note that setting 'termbidi' has the immediate effect that
7717 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7718 This option is reset when the GUI is started.
7719 For further details see |arabic.txt|.
7720
7721 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007722'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723 Macintosh GUI: "macroman")
7724 global
7725 {only available when compiled with the |+multi_byte|
7726 feature}
7727 {not in Vi}
7728 Encoding used for the terminal. This specifies what character
7729 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007730 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007731 display). Except for the Mac when 'macatsui' is off, then
7732 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007734 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007735 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7736 Any attempts to set a different value will be rejected, and an error
7737 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007738 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739 because the Win32 system always passes Unicode characters.
7740 When empty, the same encoding is used as for the 'encoding' option.
7741 This is the normal value.
7742 Not all combinations for 'termencoding' and 'encoding' are valid. See
7743 |encoding-table|.
7744 The value for this option must be supported by internal conversions or
7745 iconv(). When this is not possible no conversion will be done and you
7746 will probably experience problems with non-ASCII characters.
7747 Example: You are working with the locale set to euc-jp (Japanese) and
7748 want to edit a UTF-8 file: >
7749 :let &termencoding = &encoding
7750 :set encoding=utf-8
7751< You need to do this when your system has no locale support for UTF-8.
7752
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007753 *'termguicolors'* *'tgc'*
7754'termguicolors' 'tgc' boolean (default off)
7755 global
7756 {not in Vi}
7757 {not available when compiled without the
7758 |+termguicolors| feature}
7759 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
7760 the terminal (thus using 24-bit color). Requires a ISO-8613-3
7761 compatible terminal.
7762 If setting this option does not work (produces a colorless UI)
7763 reading |xterm-true-color| might help.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007764 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007765 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007766
Bram Moolenaar74675a62017-07-15 13:53:23 +02007767 *'termkey'* *'tk'*
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007768'termkey' 'tk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007769 local to window
7770 {not in Vi}
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007771 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007772 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007773 The <> notation can be used, e.g.: >
7774 :set termkey=<C-L>
7775< The string must be one key stroke but can be multiple bytes.
7776 When not set CTRL-W is used, so that CTRL-W : gets you to the command
7777 line. If 'termkey' is set to CTRL-L then CTRL-L : gets you to the
7778 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007779
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007780 *'termsize'* *'tms'*
Bram Moolenaar74675a62017-07-15 13:53:23 +02007781'termsize' 'tms' string (default "")
7782 local to window
7783 {not in Vi}
7784 Size of the |terminal| window. Format: {rows}x{columns}.
7785 - When empty the terminal gets the size from the window.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007786 - When set (e.g., "24x80") the terminal size is not adjusted to the
7787 window size. If the window is smaller only the top-left part is
7788 displayed.
7789 When rows is zero then use the height of the window.
7790 When columns is zero then use the width of the window.
7791 For example: "30x0" uses 30 rows with the current window width.
7792 Using "0x0" is the same as empty.
7793 Note that the command running in the terminal window may still change
7794 the size of the terminal. In that case the Vim window will be
7795 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007796
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797 *'terse'* *'noterse'*
7798'terse' boolean (default off)
7799 global
7800 When set: Add 's' flag to 'shortmess' option (this makes the message
7801 for a search that hits the start or end of the file not being
7802 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7803 shortens a lot of messages}
7804
7805 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7806'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7807 global
7808 {not in Vi}
7809 This option is obsolete. Use 'fileformats'.
7810 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7811 set to the default value for the current system. When 'textauto' is
7812 reset, 'fileformats' is made empty.
7813 NOTE: This option is set to the Vi default value when 'compatible' is
7814 set and to the Vim default value when 'compatible' is reset.
7815
7816 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7817'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7818 others: default off)
7819 local to buffer
7820 {not in Vi}
7821 This option is obsolete. Use 'fileformat'.
7822 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7823 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7824 "unix".
7825
7826 *'textwidth'* *'tw'*
7827'textwidth' 'tw' number (default 0)
7828 local to buffer
7829 {not in Vi}
7830 Maximum width of text that is being inserted. A longer line will be
7831 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007832 this.
7833 'textwidth' is set to 0 when the 'paste' option is set and restored
7834 when 'paste' is reset.
7835 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007836 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007837 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007838 NOTE: This option is set to 0 when 'compatible' is set.
7839
7840 *'thesaurus'* *'tsr'*
7841'thesaurus' 'tsr' string (default "")
7842 global or local to buffer |global-local|
7843 {not in Vi}
7844 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007845 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007846 the file should contain words with similar meaning, separated by
7847 non-keyword characters (white space is preferred). Maximum line
7848 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007849 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar38a55632016-02-15 22:07:32 +01007850 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007851 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007852 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007853 after a comma are ignored, otherwise spaces are included in the file
7854 name. See |option-backslash| about using backslashes.
7855 The use of |:set+=| and |:set-=| is preferred when adding or removing
7856 directories from the list. This avoids problems when a future version
7857 uses another default.
7858 Backticks cannot be used in this option for security reasons.
7859
7860 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7861'tildeop' 'top' boolean (default off)
7862 global
7863 {not in Vi}
7864 When on: The tilde command "~" behaves like an operator.
7865 NOTE: This option is reset when 'compatible' is set.
7866
7867 *'timeout'* *'to'* *'notimeout'* *'noto'*
7868'timeout' 'to' boolean (default on)
7869 global
7870 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007871'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 global
7873 {not in Vi}
7874 These two options together determine the behavior when part of a
7875 mapped key sequence or keyboard code has been received:
7876
7877 'timeout' 'ttimeout' action ~
7878 off off do not time out
7879 on on or off time out on :mappings and key codes
7880 off on time out on key codes
7881
7882 If both options are off, Vim will wait until either the complete
7883 mapping or key sequence has been received, or it is clear that there
7884 is no mapping or key sequence for the received characters. For
7885 example: if you have mapped "vl" and Vim has received 'v', the next
7886 character is needed to see if the 'v' is followed by an 'l'.
7887 When one of the options is on, Vim will wait for about 1 second for
7888 the next character to arrive. After that the already received
7889 characters are interpreted as single characters. The waiting time can
7890 be changed with the 'timeoutlen' option.
7891 On slow terminals or very busy systems timing out may cause
7892 malfunctioning cursor keys. If both options are off, Vim waits
7893 forever after an entered <Esc> if there are key codes that start
7894 with <Esc>. You will have to type <Esc> twice. If you do not have
7895 problems with key codes, but would like to have :mapped key
7896 sequences not timing out in 1 second, set the 'ttimeout' option and
7897 reset the 'timeout' option.
7898
7899 NOTE: 'ttimeout' is reset when 'compatible' is set.
7900
7901 *'timeoutlen'* *'tm'*
7902'timeoutlen' 'tm' number (default 1000)
7903 global
7904 {not in all versions of Vi}
7905 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007906'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907 global
7908 {not in Vi}
7909 The time in milliseconds that is waited for a key code or mapped key
7910 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7911 when part of a command has been typed.
7912 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7913 different timeout value for key codes is desired set 'ttimeoutlen' to
7914 a non-negative number.
7915
7916 ttimeoutlen mapping delay key code delay ~
7917 < 0 'timeoutlen' 'timeoutlen'
7918 >= 0 'timeoutlen' 'ttimeoutlen'
7919
7920 The timeout only happens when the 'timeout' and 'ttimeout' options
7921 tell so. A useful setting would be >
7922 :set timeout timeoutlen=3000 ttimeoutlen=100
7923< (time out on mapping after three seconds, time out on key codes after
7924 a tenth of a second).
7925
7926 *'title'* *'notitle'*
7927'title' boolean (default off, on when title can be restored)
7928 global
7929 {not in Vi}
7930 {not available when compiled without the |+title|
7931 feature}
7932 When on, the title of the window will be set to the value of
7933 'titlestring' (if it is not empty), or to:
7934 filename [+=-] (path) - VIM
7935 Where:
7936 filename the name of the file being edited
7937 - indicates the file cannot be modified, 'ma' off
7938 + indicates the file was modified
7939 = indicates the file is read-only
7940 =+ indicates the file is read-only and modified
7941 (path) is the path of the file being edited
7942 - VIM the server name |v:servername| or "VIM"
7943 Only works if the terminal supports setting window titles
7944 (currently Amiga console, Win32 console, all GUI versions and
7945 terminals with a non- empty 't_ts' option - these are Unix xterm and
7946 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7947 *X11*
7948 When Vim was compiled with HAVE_X11 defined, the original title will
7949 be restored if possible. The output of ":version" will include "+X11"
7950 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7951 works for the icon name |'icon'|.
7952 But: When Vim was started with the |-X| argument, restoring the title
7953 will not work (except in the GUI).
7954 If the title cannot be restored, it is set to the value of 'titleold'.
7955 You might want to restore the title outside of Vim then.
7956 When using an xterm from a remote machine you can use this command:
7957 rsh machine_name xterm -display $DISPLAY &
7958 then the WINDOWID environment variable should be inherited and the
7959 title of the window should change back to what it should be after
7960 exiting Vim.
7961
7962 *'titlelen'*
7963'titlelen' number (default 85)
7964 global
7965 {not in Vi}
7966 {not available when compiled without the |+title|
7967 feature}
7968 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007969 title. When the title is longer, only the end of the path name is
7970 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971 Using a percentage makes this adapt to the width of the window. But
7972 it won't work perfectly, because the actual number of characters
7973 available also depends on the font used and other things in the title
7974 bar. When 'titlelen' is zero the full path is used. Otherwise,
7975 values from 1 to 30000 percent can be used.
7976 'titlelen' is also used for the 'titlestring' option.
7977
7978 *'titleold'*
7979'titleold' string (default "Thanks for flying Vim")
7980 global
7981 {not in Vi}
7982 {only available when compiled with the |+title|
7983 feature}
7984 This option will be used for the window title when exiting Vim if the
7985 original title cannot be restored. Only happens if 'title' is on or
7986 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007987 This option cannot be set from a |modeline| or in the |sandbox|, for
7988 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007989 *'titlestring'*
7990'titlestring' string (default "")
7991 global
7992 {not in Vi}
7993 {not available when compiled without the |+title|
7994 feature}
7995 When this option is not empty, it will be used for the title of the
7996 window. This happens only when the 'title' option is on.
7997 Only works if the terminal supports setting window titles (currently
7998 Amiga console, Win32 console, all GUI versions and terminals with a
7999 non-empty 't_ts' option).
8000 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008001 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008002 When this option contains printf-style '%' items, they will be
8003 expanded according to the rules used for 'statusline'.
8004 Example: >
8005 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8006 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8007< The value of 'titlelen' is used to align items in the middle or right
8008 of the available space.
8009 Some people prefer to have the file name first: >
8010 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8011< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008012 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 separating space only when needed.
8014 NOTE: Use of special characters in 'titlestring' may cause the display
8015 to be garbled (e.g., when it contains a CR or NL character).
8016 {not available when compiled without the |+statusline| feature}
8017
8018 *'toolbar'* *'tb'*
8019'toolbar' 'tb' string (default "icons,tooltips")
8020 global
8021 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8022 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008023 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 possible values are:
8025 icons Toolbar buttons are shown with icons.
8026 text Toolbar buttons shown with text.
8027 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008028 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008029 tooltips Tooltips are active for toolbar buttons.
8030 Tooltips refer to the popup help text which appears after the mouse
8031 cursor is placed over a toolbar button for a brief moment.
8032
8033 If you want the toolbar to be shown with icons as well as text, do the
8034 following: >
8035 :set tb=icons,text
8036< Motif and Athena cannot display icons and text at the same time. They
8037 will show icons if both are requested.
8038
8039 If none of the strings specified in 'toolbar' are valid or if
8040 'toolbar' is empty, this option is ignored. If you want to disable
8041 the toolbar, you need to set the 'guioptions' option. For example: >
8042 :set guioptions-=T
8043< Also see |gui-toolbar|.
8044
8045 *'toolbariconsize'* *'tbis'*
8046'toolbariconsize' 'tbis' string (default "small")
8047 global
8048 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008049 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008050 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008051 tiny Use tiny icons.
8052 small Use small icons (default).
8053 medium Use medium-sized icons.
8054 large Use large icons.
8055 huge Use even larger icons.
8056 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008057 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008058 the current theme. Common dimensions are giant=48x48, huge=32x32,
8059 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060
8061 If 'toolbariconsize' is empty, the global default size as determined
8062 by user preferences or the current theme is used.
8063
8064 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8065'ttybuiltin' 'tbi' boolean (default on)
8066 global
8067 {not in Vi}
8068 When on, the builtin termcaps are searched before the external ones.
8069 When off the builtin termcaps are searched after the external ones.
8070 When this option is changed, you should set the 'term' option next for
8071 the change to take effect, for example: >
8072 :set notbi term=$TERM
8073< See also |termcap|.
8074 Rationale: The default for this option is "on", because the builtin
8075 termcap entries are generally better (many systems contain faulty
8076 xterm entries...).
8077
8078 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8079'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8080 sun-cmd, screen, rxvt, dtterm or
8081 iris-ansi; also on when running Vim in
8082 a DOS console)
8083 global
8084 {not in Vi}
8085 Indicates a fast terminal connection. More characters will be sent to
8086 the screen for redrawing, instead of using insert/delete line
8087 commands. Improves smoothness of redrawing when there are multiple
8088 windows and the terminal does not support a scrolling region.
8089 Also enables the extra writing of characters at the end of each screen
8090 line for lines that wrap. This helps when using copy/paste with the
8091 mouse in an xterm and other terminals.
8092
8093 *'ttymouse'* *'ttym'*
8094'ttymouse' 'ttym' string (default depends on 'term')
8095 global
8096 {not in Vi}
8097 {only in Unix and VMS, doesn't work in the GUI; not
8098 available when compiled without |+mouse|}
8099 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008100 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008101 *xterm-mouse*
8102 xterm xterm-like mouse handling. The mouse generates
8103 "<Esc>[Mscr", where "scr" is three bytes:
8104 "s" = button state
8105 "c" = column plus 33
8106 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008107 This only works up to 223 columns! See "dec",
8108 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008109 xterm2 Works like "xterm", but with the xterm reporting the
8110 mouse position while the mouse is dragged. This works
8111 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008112 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113 work. See below for how Vim detects this
8114 automatically.
8115 *netterm-mouse*
8116 netterm NetTerm mouse handling. The mouse generates
8117 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8118 for the row and column.
8119 *dec-mouse*
8120 dec DEC terminal mouse handling. The mouse generates a
8121 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008122 This is also available for an Xterm, if it was
8123 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008124 *jsbterm-mouse*
8125 jsbterm JSB term mouse handling.
8126 *pterm-mouse*
8127 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008128 *urxvt-mouse*
8129 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008130 The mouse works only if the terminal supports this
8131 encoding style, but it does not have 223 columns limit
8132 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008133 *sgr-mouse*
8134 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008135 mouse reporting. The mouse works even in columns
8136 beyond 223. This option is backward compatible with
8137 "xterm2" because it can also decode "xterm2" style
8138 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008139
8140 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008141 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8142 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008143 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8144 recognized, if enabled at compile time. DEC terminal mouse codes
8145 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008146 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8147 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008148 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008149 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8150 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8151 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008152 Additionally, if vim is compiled with the |+termresponse| feature and
8153 |t_RV| is set to the escape sequence to request the xterm version
8154 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02008156 from 95 to 276. The "sgr" value will be set if the xterm version is
8157 277 or highter.
8158 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8159 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008160 :set t_RV=
8161<
8162 *'ttyscroll'* *'tsl'*
8163'ttyscroll' 'tsl' number (default 999)
8164 global
8165 Maximum number of lines to scroll the screen. If there are more lines
8166 to scroll the window is redrawn. For terminals where scrolling is
8167 very slow and redrawing is not slow this can be set to a small number,
8168 e.g., 3, to speed up displaying.
8169
8170 *'ttytype'* *'tty'*
8171'ttytype' 'tty' string (default from $TERM)
8172 global
8173 Alias for 'term', see above.
8174
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008175 *'undodir'* *'udir'*
8176'undodir' 'udir' string (default ".")
8177 global
8178 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008179 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008180 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008181 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008182 "." means using the directory of the file. The undo file name for
8183 "file.txt" is ".file.txt.un~".
8184 For other directories the file name is the full path of the edited
8185 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008186 When writing: The first directory that exists is used. "." always
8187 works, no directories after "." will be used for writing.
8188 When reading all entries are tried to find an undo file. The first
8189 undo file that exists is used. When it cannot be read an error is
8190 given, no further entry is used.
8191 See |undo-persistence|.
8192
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008193 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008194'undofile' 'udf' boolean (default off)
8195 local to buffer
8196 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008197 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008198 When on, Vim automatically saves undo history to an undo file when
8199 writing a buffer to a file, and restores undo history from the same
8200 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008201 The directory where the undo file is stored is specified by 'undodir'.
8202 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008203 The undo file is not read when 'undoreload' causes the buffer from
8204 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008205 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008206 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008207
Bram Moolenaar071d4272004-06-13 20:20:40 +00008208 *'undolevels'* *'ul'*
8209'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8210 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008211 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008212 {not in Vi}
8213 Maximum number of changes that can be undone. Since undo information
8214 is kept in memory, higher numbers will cause more memory to be used
8215 (nevertheless, a single change can use an unlimited amount of memory).
8216 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8217 itself: >
8218 set ul=0
8219< But you can also get Vi compatibility by including the 'u' flag in
8220 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008221 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008222 Set to -1 for no undo at all. You might want to do this only for the
8223 current buffer: >
8224 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008225< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008226
8227 The local value is set to -123456 when the global value is to be used.
8228
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008229 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008230
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008231 *'undoreload'* *'ur'*
8232'undoreload' 'ur' number (default 10000)
8233 global
8234 {not in Vi}
8235 Save the whole buffer for undo when reloading it. This applies to the
8236 ":e!" command and reloading for when the buffer changed outside of
8237 Vim. |FileChangedShell|
8238 The save only happens when this options is negative or when the number
8239 of lines is smaller than the value of this option.
8240 Set this option to zero to disable undo for a reload.
8241
8242 When saving undo for a reload, any undo file is not read.
8243
8244 Note that this causes the whole buffer to be stored in memory. Set
8245 this option to a lower value if you run out of memory.
8246
Bram Moolenaar071d4272004-06-13 20:20:40 +00008247 *'updatecount'* *'uc'*
8248'updatecount' 'uc' number (default: 200)
8249 global
8250 {not in Vi}
8251 After typing this many characters the swap file will be written to
8252 disk. When zero, no swap file will be created at all (see chapter on
8253 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8254 Vim with the "-n" option, see |startup|. When editing in readonly
8255 mode this option will be initialized to 10000.
8256 The swapfile can be disabled per buffer with |'swapfile'|.
8257 When 'updatecount' is set from zero to non-zero, swap files are
8258 created for all buffers that have 'swapfile' set. When 'updatecount'
8259 is set to zero, existing swap files are not deleted.
8260 Also see |'swapsync'|.
8261 This option has no meaning in buffers where |'buftype'| is "nofile"
8262 or "nowrite".
8263
8264 *'updatetime'* *'ut'*
8265'updatetime' 'ut' number (default 4000)
8266 global
8267 {not in Vi}
8268 If this many milliseconds nothing is typed the swap file will be
8269 written to disk (see |crash-recovery|). Also used for the
8270 |CursorHold| autocommand event.
8271
8272 *'verbose'* *'vbs'*
8273'verbose' 'vbs' number (default 0)
8274 global
8275 {not in Vi, although some versions have a boolean
8276 verbose option}
8277 When bigger than zero, Vim will give messages about what it is doing.
8278 Currently, these messages are given:
8279 >= 1 When the viminfo file is read or written.
8280 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008281 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008282 >= 8 Files for which a group of autocommands is executed.
8283 >= 9 Every executed autocommand.
8284 >= 12 Every executed function.
8285 >= 13 When an exception is thrown, caught, finished, or discarded.
8286 >= 14 Anything pending in a ":finally" clause.
8287 >= 15 Every executed Ex command (truncated at 200 characters).
8288
8289 This option can also be set with the "-V" argument. See |-V|.
8290 This option is also set by the |:verbose| command.
8291
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008292 When the 'verbosefile' option is set then the verbose messages are not
8293 displayed.
8294
8295 *'verbosefile'* *'vfile'*
8296'verbosefile' 'vfile' string (default empty)
8297 global
8298 {not in Vi}
8299 When not empty all messages are written in a file with this name.
8300 When the file exists messages are appended.
8301 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008302 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008303 Setting 'verbosefile' to a new value is like making it empty first.
8304 The difference with |:redir| is that verbose messages are not
8305 displayed when 'verbosefile' is set.
8306
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307 *'viewdir'* *'vdir'*
8308'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8309 "$VIM/vimfiles/view",
8310 for Unix: "~/.vim/view",
8311 for Macintosh: "$VIM:vimfiles:view"
8312 for VMS: "sys$login:vimfiles/view"
8313 for RiscOS: "Choices:vimfiles/view")
8314 global
8315 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008316 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008317 feature}
8318 Name of the directory where to store files for |:mkview|.
8319 This option cannot be set from a |modeline| or in the |sandbox|, for
8320 security reasons.
8321
8322 *'viewoptions'* *'vop'*
8323'viewoptions' 'vop' string (default: "folds,options,cursor")
8324 global
8325 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008326 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008327 feature}
8328 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008329 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008330 word save and restore ~
8331 cursor cursor position in file and in window
8332 folds manually created folds, opened/closed folds and local
8333 fold options
8334 options options and mappings local to a window or buffer (not
8335 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008336 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337 slash backslashes in file names replaced with forward
8338 slashes
8339 unix with Unix end-of-line format (single <NL>), even when
8340 on Windows or DOS
8341
8342 "slash" and "unix" are useful on Windows when sharing view files
8343 with Unix. The Unix version of Vim cannot source dos format scripts,
8344 but the Windows version of Vim can source unix format scripts.
8345
8346 *'viminfo'* *'vi'* *E526* *E527* *E528*
8347'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008348 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8349 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8350 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351 global
8352 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008353 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 feature}
8355 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008356 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8357 "NONE".
8358 The string should be a comma separated list of parameters, each
8359 consisting of a single character identifying the particular parameter,
8360 followed by a number or string which specifies the value of that
8361 parameter. If a particular character is left out, then the default
8362 value is used for that parameter. The following is a list of the
8363 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008364 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008365 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008366 ! When included, save and restore global variables that start
8367 with an uppercase letter, and don't contain a lowercase
8368 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008369 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008370 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008371 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 " Maximum number of lines saved for each register. Old name of
8373 the '<' item, with the disadvantage that you need to put a
8374 backslash before the ", otherwise it will be recognized as the
8375 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008376 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008377 % When included, save and restore the buffer list. If Vim is
8378 started with a file name argument, the buffer list is not
8379 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008380 buffer list is restored from the viminfo file. Quickfix
8381 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8382 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008383 When followed by a number, the number specifies the maximum
8384 number of buffers that are stored. Without a number all
8385 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008386 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008387 ' Maximum number of previously edited files for which the marks
8388 are remembered. This parameter must always be included when
8389 'viminfo' is non-empty.
8390 Including this item also means that the |jumplist| and the
8391 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008392 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008393 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008394 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008395 patterns are also saved. When not included, the value of
8396 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008397 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008398 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008399 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008400 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008401 < Maximum number of lines saved for each register. If zero then
8402 registers are not saved. When not included, all lines are
8403 saved. '"' is the old name for this item.
8404 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008405 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008406 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008407 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008408 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008409 c When included, convert the text in the viminfo file from the
8410 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008411 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008412 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 f Whether file marks need to be stored. If zero, file marks ('0
8414 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008415 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008417 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008418 h Disable the effect of 'hlsearch' when loading the viminfo
8419 file. When not included, it depends on whether ":nohlsearch"
8420 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008421 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008423 the 'n'. Must be at the end of the option! If the
8424 'viminfofile' option is set, that file name overrides the one
8425 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008426 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008427 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428 r Removable media. The argument is a string (up to the next
8429 ','). This parameter can be given several times. Each
8430 specifies the start of a path for which no marks will be
8431 stored. This is to avoid removable media. For MS-DOS you
8432 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8433 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8434 ignored. Maximum length of each 'r' argument is 50
8435 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008436 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008437 s Maximum size of an item in Kbyte. If zero then registers are
8438 not saved. Currently only applies to registers. The default
8439 "s10" will exclude registers with more than 10 Kbyte of text.
8440 Also see the '<' item above: line count limit.
8441
8442 Example: >
8443 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8444<
8445 '50 Marks will be remembered for the last 50 files you
8446 edited.
8447 <1000 Contents of registers (up to 1000 lines each) will be
8448 remembered.
8449 s100 Registers with more than 100 Kbyte text are skipped.
8450 :0 Command-line history will not be saved.
8451 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8452 no / Since '/' is not specified, the default will be used,
8453 that is, save all of the search history, and also the
8454 previous search and substitute patterns.
8455 no % The buffer list will not be saved nor read back.
8456 no h 'hlsearch' highlighting will be restored.
8457
8458 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8459 load the contents of the file, this is not done automatically.
8460
8461 This option cannot be set from a |modeline| or in the |sandbox|, for
8462 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008463 NOTE: This option is set to the Vim default value when 'compatible'
8464 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008465
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008466 *'viminfofile'* *'vif'*
8467'viminfofile' 'vif' string (default: "")
8468 global
8469 {not in Vi}
8470 {not available when compiled without the |+viminfo|
8471 feature}
8472 When non-empty, overrides the file name used for viminfo.
8473 When equal to "NONE" no viminfo file will be read or written.
8474 This option can be set with the |-i| command line flag. The |--clean|
8475 command line flag sets it to "NONE".
8476
Bram Moolenaar071d4272004-06-13 20:20:40 +00008477 *'virtualedit'* *'ve'*
8478'virtualedit' 've' string (default "")
8479 global
8480 {not in Vi}
8481 {not available when compiled without the
8482 |+virtualedit| feature}
8483 A comma separated list of these words:
8484 block Allow virtual editing in Visual block mode.
8485 insert Allow virtual editing in Insert mode.
8486 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008487 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008488
Bram Moolenaar071d4272004-06-13 20:20:40 +00008489 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008490 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008491 of the line. Useful for selecting a rectangle in Visual mode and
8492 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008493 "onemore" is not the same, it will only allow moving the cursor just
8494 after the last character of the line. This makes some commands more
8495 consistent. Previously the cursor was always past the end of the line
8496 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008497 break some plugins or Vim scripts. For example because |l| can move
8498 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008499 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008500 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008501 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008502 It doesn't make sense to combine "all" with "onemore", but you will
8503 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008504 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008505
8506 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8507'visualbell' 'vb' boolean (default off)
8508 global
8509 {not in Vi}
Bram Moolenaar74675a62017-07-15 13:53:23 +02008510 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008511 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008512 use: >
8513 :set vb t_vb=
8514< If you want a short flash, you can use this on many terminals: >
8515 :set vb t_vb=[?5h$<100>[?5l
8516< Here $<100> specifies the time, you can use a smaller or bigger value
8517 to get a shorter or longer flash.
8518
8519 Note: Vim will limit the bell to once per half a second. This avoids
8520 having to wait for the flashing to finish when there are lots of
8521 bells, e.g. on key repeat. This also happens without 'visualbell'
8522 set.
8523
Bram Moolenaar071d4272004-06-13 20:20:40 +00008524 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8525 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8526 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008527
8528 Note: When the GUI starts, 't_vb' is reset to its default value. You
8529 might want to set it again in your |gvimrc|.
8530
Bram Moolenaar071d4272004-06-13 20:20:40 +00008531 Does not work on the Amiga, you always get a screen flash.
8532 Also see 'errorbells'.
8533
8534 *'warn'* *'nowarn'*
8535'warn' boolean (default on)
8536 global
8537 Give a warning message when a shell command is used while the buffer
8538 has been changed.
8539
8540 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8541'weirdinvert' 'wiv' boolean (default off)
8542 global
8543 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008544 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 It is provided for backwards compatibility with version 4.x.
8546 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8547 vice versa. Has no effect when the GUI is running.
8548
8549 *'whichwrap'* *'ww'*
8550'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8551 global
8552 {not in Vi}
8553 Allow specified keys that move the cursor left/right to move to the
8554 previous/next line when the cursor is on the first/last character in
8555 the line. Concatenate characters to allow this for these keys:
8556 char key mode ~
8557 b <BS> Normal and Visual
8558 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008559 h "h" Normal and Visual (not recommended)
8560 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008561 < <Left> Normal and Visual
8562 > <Right> Normal and Visual
8563 ~ "~" Normal
8564 [ <Left> Insert and Replace
8565 ] <Right> Insert and Replace
8566 For example: >
8567 :set ww=<,>,[,]
8568< allows wrap only when cursor keys are used.
8569 When the movement keys are used in combination with a delete or change
8570 operator, the <EOL> also counts for a character. This makes "3h"
8571 different from "3dh" when the cursor crosses the end of a line. This
8572 is also true for "x" and "X", because they do the same as "dl" and
8573 "dh". If you use this, you may also want to use the mapping
8574 ":map <BS> X" to make backspace delete the character in front of the
8575 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008576 When 'l' is included and it is used after an operator at the end of a
8577 line then it will not move to the next line. This makes "dl", "cl",
8578 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579 NOTE: This option is set to the Vi default value when 'compatible' is
8580 set and to the Vim default value when 'compatible' is reset.
8581
8582 *'wildchar'* *'wc'*
8583'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8584 global
8585 {not in Vi}
8586 Character you have to type to start wildcard expansion in the
8587 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008588 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589 The character is not recognized when used inside a macro. See
8590 'wildcharm' for that.
8591 Although 'wc' is a number option, you can set it to a special key: >
8592 :set wc=<Esc>
8593< NOTE: This option is set to the Vi default value when 'compatible' is
8594 set and to the Vim default value when 'compatible' is reset.
8595
8596 *'wildcharm'* *'wcm'*
8597'wildcharm' 'wcm' number (default: none (0))
8598 global
8599 {not in Vi}
8600 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008601 recognized when used inside a macro. You can find "spare" command-line
8602 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008603 you'll never actually type 'wildcharm', just use it in mappings that
8604 automatically invoke completion mode, e.g.: >
8605 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008606 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008607< Then after typing :ss you can use CTRL-P & CTRL-N.
8608
8609 *'wildignore'* *'wig'*
8610'wildignore' 'wig' string (default "")
8611 global
8612 {not in Vi}
8613 {not available when compiled without the |+wildignore|
8614 feature}
8615 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008616 patterns is ignored when expanding |wildcards|, completing file or
8617 directory names, and influences the result of |expand()|, |glob()| and
8618 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8620 Also see 'suffixes'.
8621 Example: >
8622 :set wildignore=*.o,*.obj
8623< The use of |:set+=| and |:set-=| is preferred when adding or removing
8624 a pattern from the list. This avoids problems when a future version
8625 uses another default.
8626
Bram Moolenaar94950a92010-12-02 16:01:29 +01008627
Bram Moolenaar81af9252010-12-10 20:35:50 +01008628 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008629'wildignorecase' 'wic' boolean (default off)
8630 global
8631 {not in Vi}
8632 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008633 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008634 Does not apply when the shell is used to expand wildcards, which
8635 happens when there are special characters.
8636
8637
Bram Moolenaar071d4272004-06-13 20:20:40 +00008638 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008639'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008640 global
8641 {not in Vi}
8642 {not available if compiled without the |+wildmenu|
8643 feature}
8644 When 'wildmenu' is on, command-line completion operates in an enhanced
8645 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8646 the possible matches are shown just above the command line, with the
8647 first match highlighted (overwriting the status line, if there is
8648 one). Keys that show the previous/next match, such as <Tab> or
8649 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8650 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8651 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008652 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 If there are more matches than can fit in the line, a ">" is shown on
8654 the right and/or a "<" is shown on the left. The status line scrolls
8655 as needed.
8656 The "wildmenu" mode is abandoned when a key is hit that is not used
8657 for selecting a completion.
8658 While the "wildmenu" is active the following keys have special
8659 meanings:
8660
8661 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8662 <Down> - in filename/menu name completion: move into a
8663 subdirectory or submenu.
8664 <CR> - in menu completion, when the cursor is just after a
8665 dot: move into a submenu.
8666 <Up> - in filename/menu name completion: move up into
8667 parent directory or parent menu.
8668
8669 This makes the menus accessible from the console |console-menus|.
8670
8671 If you prefer the <Left> and <Right> keys to move the cursor instead
8672 of selecting a different match, use this: >
8673 :cnoremap <Left> <Space><BS><Left>
8674 :cnoremap <Right> <Space><BS><Right>
8675<
8676 The "WildMenu" highlighting is used for displaying the current match
8677 |hl-WildMenu|.
8678
8679 *'wildmode'* *'wim'*
8680'wildmode' 'wim' string (Vim default: "full")
8681 global
8682 {not in Vi}
8683 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008684 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008685 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008686 first part specifies the behavior for the first use of 'wildchar',
8687 The second part for the second use, etc.
8688 These are the possible values for each part:
8689 "" Complete only the first match.
8690 "full" Complete the next full match. After the last match,
8691 the original string is used and then the first match
8692 again.
8693 "longest" Complete till longest common string. If this doesn't
8694 result in a longer string, use the next part.
8695 "longest:full" Like "longest", but also start 'wildmenu' if it is
8696 enabled.
8697 "list" When more than one match, list all matches.
8698 "list:full" When more than one match, list all matches and
8699 complete first match.
8700 "list:longest" When more than one match, list all matches and
8701 complete till longest common string.
8702 When there is only a single match, it is fully completed in all cases.
8703
8704 Examples: >
8705 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008706< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008707 :set wildmode=longest,full
8708< Complete longest common string, then each full match >
8709 :set wildmode=list:full
8710< List all matches and complete each full match >
8711 :set wildmode=list,full
8712< List all matches without completing, then each full match >
8713 :set wildmode=longest,list
8714< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008715 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008716
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008717 *'wildoptions'* *'wop'*
8718'wildoptions' 'wop' string (default "")
8719 global
8720 {not in Vi}
8721 {not available when compiled without the |+wildignore|
8722 feature}
8723 A list of words that change how command line completion is done.
8724 Currently only one word is allowed:
8725 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008726 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008727 is displayed per line. Often used tag kinds are:
8728 d #define
8729 f function
8730 Also see |cmdline-completion|.
8731
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 *'winaltkeys'* *'wak'*
8733'winaltkeys' 'wak' string (default "menu")
8734 global
8735 {not in Vi}
8736 {only used in Win32, Motif, GTK and Photon GUI}
8737 Some GUI versions allow the access to menu entries by using the ALT
8738 key in combination with a character that appears underlined in the
8739 menu. This conflicts with the use of the ALT key for mappings and
8740 entering special characters. This option tells what to do:
8741 no Don't use ALT keys for menus. ALT key combinations can be
8742 mapped, but there is no automatic handling. This can then be
8743 done with the |:simalt| command.
8744 yes ALT key handling is done by the windowing system. ALT key
8745 combinations cannot be mapped.
8746 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008747 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008748 keys can be mapped.
8749 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8750 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008751 This option is not used for <F10>; on Win32 and with GTK <F10> will
8752 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008753
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008754 *'window'* *'wi'*
8755'window' 'wi' number (default screen height - 1)
8756 global
8757 Window height. Do not confuse this with the height of the Vim window,
8758 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008759 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8760 value is smaller than 'lines' minus one. The screen will scroll
8761 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008762 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8763 in a much smarter way, taking care of wrapping lines.
8764 When resizing the Vim window, the value is smaller than 1 or more than
8765 or equal to 'lines' it will be set to 'lines' minus 1.
8766 {Vi also uses the option to specify the number of displayed lines}
8767
Bram Moolenaar071d4272004-06-13 20:20:40 +00008768 *'winheight'* *'wh'* *E591*
8769'winheight' 'wh' number (default 1)
8770 global
8771 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008772 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008773 feature}
8774 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008775 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008776 focus goes to a window that is smaller, its size is increased, at the
8777 cost of the height of other windows.
8778 Set 'winheight' to a small number for normal editing.
8779 Set it to 999 to make the current window fill most of the screen.
8780 Other windows will be only 'winminheight' high. This has the drawback
8781 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8782 to create only two windows, set the option after startup is done,
8783 using the |VimEnter| event: >
8784 au VimEnter * set winheight=999
8785< Minimum value is 1.
8786 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008787 height of the current window.
8788 'winheight' applies to the current window. Use 'winminheight' to set
8789 the minimal height for other windows.
8790
8791 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8792'winfixheight' 'wfh' boolean (default off)
8793 local to window
8794 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008795 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008796 feature}
8797 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008798 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8799 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 The height may be changed anyway when running out of room.
8801
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008802 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8803'winfixwidth' 'wfw' boolean (default off)
8804 local to window
8805 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008806 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008807 feature}
8808 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008809 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008810 The width may be changed anyway when running out of room.
8811
Bram Moolenaar071d4272004-06-13 20:20:40 +00008812 *'winminheight'* *'wmh'*
8813'winminheight' 'wmh' number (default 1)
8814 global
8815 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008816 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008817 feature}
8818 The minimal height of a window, when it's not the current window.
8819 This is a hard minimum, windows will never become smaller.
8820 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8821 status bar) if necessary. They will return to at least one line when
8822 they become active (since the cursor has to have somewhere to go.)
8823 Use 'winheight' to set the minimal height of the current window.
8824 This option is only checked when making a window smaller. Don't use a
8825 large number, it will cause errors when opening more than a few
8826 windows. A value of 0 to 3 is reasonable.
8827
8828 *'winminwidth'* *'wmw'*
8829'winminwidth' 'wmw' number (default 1)
8830 global
8831 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008832 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008833 feature}
8834 The minimal width of a window, when it's not the current window.
8835 This is a hard minimum, windows will never become smaller.
8836 When set to zero, windows may be "squashed" to zero columns (i.e. just
8837 a vertical separator) if necessary. They will return to at least one
8838 line when they become active (since the cursor has to have somewhere
8839 to go.)
8840 Use 'winwidth' to set the minimal width of the current window.
8841 This option is only checked when making a window smaller. Don't use a
8842 large number, it will cause errors when opening more than a few
8843 windows. A value of 0 to 12 is reasonable.
8844
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008845 *'winptydll'*
8846'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8847 global
8848 {not in Vi}
8849 {only available when compiled with the |terminal|
8850 feature on MS-Windows}
8851 Specifies the name of the winpty shared library, used for the
8852 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008853 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008854 a fallback.
8855 Environment variables are expanded |:set_env|.
8856 This option cannot be set from a |modeline| or in the |sandbox|, for
8857 security reasons.
8858
Bram Moolenaar071d4272004-06-13 20:20:40 +00008859 *'winwidth'* *'wiw'* *E592*
8860'winwidth' 'wiw' number (default 20)
8861 global
8862 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008863 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008864 feature}
8865 Minimal number of columns for the current window. This is not a hard
8866 minimum, Vim will use fewer columns if there is not enough room. If
8867 the current window is smaller, its size is increased, at the cost of
8868 the width of other windows. Set it to 999 to make the current window
8869 always fill the screen. Set it to a small number for normal editing.
8870 The width is not adjusted after one of the commands to change the
8871 width of the current window.
8872 'winwidth' applies to the current window. Use 'winminwidth' to set
8873 the minimal width for other windows.
8874
8875 *'wrap'* *'nowrap'*
8876'wrap' boolean (default on)
8877 local to window
8878 {not in Vi}
8879 This option changes how text is displayed. It doesn't change the text
8880 in the buffer, see 'textwidth' for that.
8881 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008882 displaying continues on the next line. When off lines will not wrap
8883 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008884 moved to a part that is not shown, the screen will scroll
8885 horizontally.
8886 The line will be broken in the middle of a word if necessary. See
8887 'linebreak' to get the break at a word boundary.
8888 To make scrolling horizontally a bit more useful, try this: >
8889 :set sidescroll=5
8890 :set listchars+=precedes:<,extends:>
8891< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008892 This option can't be set from a |modeline| when the 'diff' option is
8893 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008894
8895 *'wrapmargin'* *'wm'*
8896'wrapmargin' 'wm' number (default 0)
8897 local to buffer
8898 Number of characters from the right window border where wrapping
8899 starts. When typing text beyond this limit, an <EOL> will be inserted
8900 and inserting continues on the next line.
8901 Options that add a margin, such as 'number' and 'foldcolumn', cause
8902 the text width to be further reduced. This is Vi compatible.
8903 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008904 This option is set to 0 when 'paste' is set and restored when 'paste'
8905 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008906 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8907 and less usefully}
8908
8909 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8910'wrapscan' 'ws' boolean (default on) *E384* *E385*
8911 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008912 Searches wrap around the end of the file. Also applies to |]s| and
8913 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008914
8915 *'write'* *'nowrite'*
8916'write' boolean (default on)
8917 global
8918 {not in Vi}
8919 Allows writing files. When not set, writing a file is not allowed.
8920 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008921 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008922 argument. Filtering text is still possible, even though this requires
8923 writing a temporary file.
8924
8925 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8926'writeany' 'wa' boolean (default off)
8927 global
8928 Allows writing to any file with no need for "!" override.
8929
8930 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8931'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8932 otherwise)
8933 global
8934 {not in Vi}
8935 Make a backup before overwriting a file. The backup is removed after
8936 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008937 also on.
8938 WARNING: Switching this option off means that when Vim fails to write
8939 your buffer correctly and then, for whatever reason, Vim exits, you
8940 lose both the original file and what you were writing. Only reset
8941 this option if your file system is almost full and it makes the write
8942 fail (and make sure not to exit Vim until the write was successful).
8943 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008944 When the 'backupskip' pattern matches, a backup is not made anyway.
8945 NOTE: This option is set to the default value when 'compatible' is
8946 set.
8947
8948 *'writedelay'* *'wd'*
8949'writedelay' 'wd' number (default 0)
8950 global
8951 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008952 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008953 screen. When non-zero, characters are sent to the terminal one by
8954 one. For MS-DOS pcterm this does not work. For debugging purposes.
8955
8956 vim:tw=78:ts=8:ft=help:norl: