blob: 16aa422151954210fa8b45b30d4d82c0211183bd [file] [log] [blame]
Bram Moolenaarb1c91982018-05-17 17:04:55 +02001*options.txt* For Vim version 8.1. Last change: 2018 May 15
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 Moolenaar22f1d0e2018-02-27 14:53:30 +010053:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020054 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).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100405 {not available when compiled without the |+eval|
406 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407
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.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200426If $HOMEDRIVE is not set then $USERPROFILE is used.
427
428This expanded value is not exported to the environment, this matters when
429running an external command: >
430 :echo system('set | findstr ^HOME=')
431and >
432 :echo luaeval('os.getenv("HOME")')
433should echo nothing (an empty string) despite exists('$HOME') being true.
434When setting $HOME to a non-empty string it will be exported to the
435subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200436
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437
438Note the maximum length of an expanded option is limited. How much depends on
439the system, mostly it is something like 256 or 1024 characters.
440
441 *:fix* *:fixdel*
442:fix[del] Set the value of 't_kD':
443 't_kb' is 't_kD' becomes ~
444 CTRL-? CTRL-H
445 not CTRL-? CTRL-?
446
447 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
448
449 If your delete key terminal code is wrong, but the
450 code for backspace is alright, you can put this in
451 your .vimrc: >
452 :fixdel
453< This works no matter what the actual code for
454 backspace is.
455
456 If the backspace key terminal code is wrong you can
457 use this: >
458 :if &term == "termname"
459 : set t_kb=^V<BS>
460 : fixdel
461 :endif
462< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000463 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000464 with your terminal name.
465
466 If your <Delete> key sends a strange key sequence (not
467 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
468 :if &term == "termname"
469 : set t_kD=^V<Delete>
470 :endif
471< Where "^V" is CTRL-V and "<Delete>" is the delete key
472 (don't type eight characters!). Replace "termname"
473 with your terminal name.
474
475 *Linux-backspace*
476 Note about Linux: By default the backspace key
477 produces CTRL-?, which is wrong. You can fix it by
478 putting this line in your rc.local: >
479 echo "keycode 14 = BackSpace" | loadkeys
480<
481 *NetBSD-backspace*
482 Note about NetBSD: If your backspace doesn't produce
483 the right code, try this: >
484 xmodmap -e "keycode 22 = BackSpace"
485< If this works, add this in your .Xmodmap file: >
486 keysym 22 = BackSpace
487< You need to restart for this to take effect.
488
489==============================================================================
4902. Automatically setting options *auto-setting*
491
492Besides changing options with the ":set" command, there are three alternatives
493to set options automatically for one or more files:
494
4951. When starting Vim initializations are read from various places. See
496 |initialization|. Most of them are performed for all editing sessions,
497 and some of them depend on the directory where Vim is started.
498 You can create an initialization file with |:mkvimrc|, |:mkview| and
499 |:mksession|.
5002. If you start editing a new file, the automatic commands are executed.
501 This can be used to set options for files matching a particular pattern and
502 many other things. See |autocommand|.
5033. If you start editing a new file, and the 'modeline' option is on, a
504 number of lines at the beginning and end of the file are checked for
505 modelines. This is explained here.
506
507 *modeline* *vim:* *vi:* *ex:* *E520*
508There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200509 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200511[text] any text or empty
512{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200513{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200514[white] optional white space
515{options} a list of option settings, separated with white space
516 or ':', where each part between ':' is the argument
517 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000518
Bram Moolenaar14b69452013-06-29 23:05:20 +0200519Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000520 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200521 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000522
523The second form (this is compatible with some versions of Vi):
524
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200525 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200527[text] any text or empty
528{white} at least one blank character (<Space> or <Tab>)
529{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
530[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200531se[t] the string "set " or "se " (note the space); When
532 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200533{options} a list of options, separated with white space, which
534 is the argument for a ":set" command
535: a colon
536[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
Bram Moolenaar14b69452013-06-29 23:05:20 +0200538Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000539 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200540 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200542The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
543chance that a normal word like "lex:" is caught. There is one exception:
544"vi:" and "vim:" can also be at the start of the line (for compatibility with
545version 3.0). Using "ex:" at the start of the line will be ignored (this
546could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
548 *modeline-local*
549The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000550buffer and window that contain the file. Although it's possible to set global
551options from a modeline, this is unusual. If you have two windows open and
552the files in it set the same global option to a different value, the result
553depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000555When editing a file that was already loaded, only the window-local options
556from the modeline are used. Thus if you manually changed a buffer-local
557option after opening the file, it won't be changed if you edit the same buffer
558in another window. But window-local options will be set.
559
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560 *modeline-version*
561If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200562number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563 vim{vers}: version {vers} or later
564 vim<{vers}: version before {vers}
565 vim={vers}: version {vers}
566 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100567{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
568For example, to use a modeline only for Vim 7.0:
569 /* vim700: set foldmethod=marker */ ~
570To use a modeline for Vim after version 7.2:
571 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572There can be no blanks between "vim" and the ":".
573
574
575The number of lines that are checked can be set with the 'modelines' option.
576If 'modeline' is off or 'modelines' is 0 no lines are checked.
577
578Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000579like:
580 /* vi:ts=4: */ ~
581will give an error message for the trailing "*/". This line is OK:
582 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583
584If an error is detected the rest of the line is skipped.
585
586If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000587backslash in front of the ':' will be removed. Example:
588 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589This sets the 'dir' option to "c:\tmp". Only a single backslash before the
590':' is removed. Thus to include "\:" you have to specify "\\:".
591
592No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000593might create a Trojan horse text file with modelines). And not all options
594can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000595|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000596causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
597are wrapped unexpectedly. So disable modelines before editing untrusted text.
598The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000599
600Hint: If you would like to do something else than setting an option, you could
601define an autocommand that checks the file for a specific string. For
602example: >
603 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
604And define a function SetVar() that does something with the line containing
605"VAR".
606
607==============================================================================
6083. Options summary *option-summary*
609
610In the list below all the options are mentioned with their full name and with
611an abbreviation if there is one. Both forms may be used.
612
613In this document when a boolean option is "set" that means that ":set option"
614is entered. When an option is "reset", ":set nooption" is used.
615
616For some options there are two default values: The "Vim default", which is
617used when 'compatible' is not set, and the "Vi default", which is used when
618'compatible' is set.
619
620Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000621are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622different value in each window. For example the 'list' option can be set in
623one window and reset in another for the same text, giving both types of view
624at the same time. There are a few options that are specific to a certain
625file. These can have a different value for each file or buffer. For example
626the 'textwidth' option can be 78 for a normal text file and 0 for a C
627program.
628
629 global one option for all buffers and windows
630 local to window each window has its own copy of this option
631 local to buffer each buffer has its own copy of this option
632
633When creating a new window the option values from the currently active window
634are used as a default value for the window-specific options. For the
635buffer-specific options this depends on the 's' and 'S' flags in the
636'cpoptions' option. If 's' is included (which is the default) the values for
637buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000638first entered. If 'S' is present the options are copied each time the buffer
639is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640present, the options are copied from the currently active buffer when the
641buffer is created.
642
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000643Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000645Not all options are supported in all versions. This depends on the supported
646features and sometimes on the system. A remark about this is in curly braces
647below. When an option is not supported it may still be set without getting an
648error, this is called a hidden option. You can't get the value of a hidden
649option though, it is not stored.
650
651To test if option "foo" can be used with ":set" use something like this: >
652 if exists('&foo')
653This also returns true for a hidden option. To test if option "foo" is really
654supported use something like this: >
655 if exists('+foo')
656<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000657 *E355*
658A jump table for the options with a short description can be found at |Q_op|.
659
660 *'aleph'* *'al'* *aleph* *Aleph*
661'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
662 global
663 {not in Vi}
664 {only available when compiled with the |+rightleft|
665 feature}
666 The ASCII code for the first letter of the Hebrew alphabet. The
667 routine that maps the keyboard in Hebrew mode, both in Insert mode
668 (when hkmap is set) and on the command-line (when hitting CTRL-_)
669 outputs the Hebrew characters in the range [aleph..aleph+26].
670 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
671 See |rileft.txt|.
672
673 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
674'allowrevins' 'ari' boolean (default off)
675 global
676 {not in Vi}
677 {only available when compiled with the |+rightleft|
678 feature}
679 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
680 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
681 into reverse Insert mode, and don't know how to get out. See
682 'revins'.
683 NOTE: This option is reset when 'compatible' is set.
684
685 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
686'altkeymap' 'akm' boolean (default off)
687 global
688 {not in Vi}
689 {only available when compiled with the |+farsi|
690 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000691 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692 the keyboard map between Farsi and English, when 'allowrevins' set.
693
Bram Moolenaar582fd852005-03-28 20:58:01 +0000694 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 is useful to start the Vim in native mode i.e. English (left-to-right
696 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000697 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698
699 *'ambiwidth'* *'ambw'*
700'ambiwidth' 'ambw' string (default: "single")
701 global
702 {not in Vi}
703 {only available when compiled with the |+multi_byte|
704 feature}
705 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
706 Tells Vim what to do with characters with East Asian Width Class
707 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
708 letters, Cyrillic letters).
709
710 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000711 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712 expected by most users.
713 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200714 *E834* *E835*
715 The value "double" cannot be used if 'listchars' or 'fillchars'
716 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717
718 There are a number of CJK fonts for which the width of glyphs for
719 those characters are solely based on how many octets they take in
720 legacy/traditional CJK encodings. In those encodings, Euro,
721 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000722 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000724 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725 Vim is running inside a terminal (emulators) that uses a CJK font
726 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
727 this option should be set to "double" to match the width perceived
728 by Vim with the width of glyphs in the font. Perhaps it also has
729 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
730 when the system locale is set to one of CJK locales. See Unicode
731 Standard Annex #11 (http://www.unicode.org/reports/tr11).
732
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100733 Vim may set this option automatically at startup time when Vim is
734 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200735 escape sequence to request cursor position report. The response can
736 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100737
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
739'antialias' 'anti' boolean (default: off)
740 global
741 {not in Vi}
742 {only available when compiled with GUI enabled
743 on Mac OS X}
744 This option only has an effect in the GUI version of Vim on Mac OS X
745 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
746 which can be easier to read at certain sizes on certain displays.
747 Setting this option can sometimes cause problems if 'guifont' is set
748 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100749 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750
751 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
752'autochdir' 'acd' boolean (default off)
753 global
754 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200755 {only available when compiled with it, use
756 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000757 When on, Vim will change the current working directory whenever you
758 open a file, switch buffers, delete a buffer or open/close a window.
759 It will change to the directory containing the file which was opened
760 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000761 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762
763 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
764'arabic' 'arab' boolean (default off)
765 local to window
766 {not in Vi}
767 {only available when compiled with the |+arabic|
768 feature}
769 This option can be set to start editing Arabic text.
770 Setting this option will:
771 - Set the 'rightleft' option, unless 'termbidi' is set.
772 - Set the 'arabicshape' option, unless 'termbidi' is set.
773 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
774 between typing English and Arabic key mapping.
775 - Set the 'delcombine' option
776 Note that 'encoding' must be "utf-8" for working with Arabic text.
777
778 Resetting this option will:
779 - Reset the 'rightleft' option.
780 - Disable the use of 'keymap' (without changing its value).
781 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200782 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100783 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 Also see |arabic.txt|.
785
786 *'arabicshape'* *'arshape'*
787 *'noarabicshape'* *'noarshape'*
788'arabicshape' 'arshape' boolean (default on)
789 global
790 {not in Vi}
791 {only available when compiled with the |+arabic|
792 feature}
793 When on and 'termbidi' is off, the required visual character
794 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200795 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796 one which encompasses:
797 a) the changing/morphing of characters based on their location
798 within a word (initial, medial, final and stand-alone).
799 b) the enabling of the ability to compose characters
800 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100801 When disabled the display shows each character's true stand-alone
802 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 Arabic is a complex language which requires other settings, for
804 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100805 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806
807 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
808'autoindent' 'ai' boolean (default off)
809 local to buffer
810 Copy indent from current line when starting a new line (typing <CR>
811 in Insert mode or when using the "o" or "O" command). If you do not
812 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000813 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
814 to another line has the same effect, unless the 'I' flag is included
815 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000816 When autoindent is on, formatting (with the "gq" command or when you
817 reach 'textwidth' in Insert mode) uses the indentation of the first
818 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819 When 'smartindent' or 'cindent' is on the indent is changed in
820 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200821 The 'autoindent' option is reset when the 'paste' option is set and
822 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823 {small difference from Vi: After the indent is deleted when typing
824 <Esc> or <CR>, the cursor position when moving up or down is after the
825 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
826
827 *'autoread'* *'ar'* *'noautoread'* *'noar'*
828'autoread' 'ar' boolean (default off)
829 global or local to buffer |global-local|
830 {not in Vi}
831 When a file has been detected to have been changed outside of Vim and
832 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200833 When the file has been deleted this is not done, so you have the text
834 from before it was deleted. When it appears again then it is read.
835 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 If this option has a local value, use this command to switch back to
837 using the global value: >
838 :set autoread<
839<
840 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
841'autowrite' 'aw' boolean (default off)
842 global
843 Write the contents of the file, if it has been modified, on each
844 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000845 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
847 Note that for some commands the 'autowrite' option is not used, see
848 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200849 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200850 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851
852 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
853'autowriteall' 'awa' boolean (default off)
854 global
855 {not in Vi}
856 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
857 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
858 Setting this option also implies that Vim behaves like 'autowrite' has
859 been set.
860
861 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200862'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 global
864 {not in Vi}
865 When set to "dark", Vim will try to use colors that look good on a
866 dark background. When set to "light", Vim will try to use colors that
867 look good on a light background. Any other value is illegal.
868 Vim tries to set the default value according to the terminal used.
869 This will not always be correct.
870 Setting this option does not change the background color, it tells Vim
871 what the background color looks like. For changing the background
872 color, see |:hi-normal|.
873
874 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000875 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000876 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100877 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878 setting 'background' will cause the color scheme to be reloaded. If
879 the color scheme adjusts to the value of 'background' this will work.
880 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100881 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882
883 When setting 'background' to the default value with: >
884 :set background&
885< Vim will guess the value. In the GUI this should work correctly,
886 in other cases Vim might not be able to guess the right value.
887
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200888 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200889 color from the terminal. If the returned RGB value is dark/light and
890 'background' is not dark/light, 'background' will be set and the
891 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200892 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100893 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200894
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 When starting the GUI, the default value for 'background' will be
896 "light". When the value is not set in the .gvimrc, and Vim detects
897 that the background is actually quite dark, 'background' is set to
898 "dark". But this happens only AFTER the .gvimrc file has been read
899 (because the window needs to be opened to find the actual background
900 color). To get around this, force the GUI window to be opened by
901 putting a ":gui" command in the .gvimrc file, before where the value
902 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200903
904 For MS-DOS, Windows and OS/2 the default is "dark".
905 For other systems "dark" is used when 'term' is "linux",
906 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
907 background. Otherwise the default is "light".
908
Bram Moolenaarc572da52017-08-27 16:52:01 +0200909 The |:terminal| command and the |term_start()| function use the
910 'background' value to decide whether the terminal window will start
911 with a white or black background.
912
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913 Normally this option would be set in the .vimrc file. Possibly
914 depending on the terminal name. Example: >
915 :if &term == "pcterm"
916 : set background=dark
917 :endif
918< When this option is set, the default settings for the highlight groups
919 will change. To use other settings, place ":highlight" commands AFTER
920 the setting of the 'background' option.
921 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
922 to select the colors for syntax highlighting. After changing this
923 option, you must load syntax.vim again to see the result. This can be
924 done with ":syntax on".
925
926 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200927'backspace' 'bs' string (default "", set to "indent,eol,start"
928 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929 global
930 {not in Vi}
931 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
932 mode. This is a list of items, separated by commas. Each item allows
933 a way to backspace over something:
934 value effect ~
935 indent allow backspacing over autoindent
936 eol allow backspacing over line breaks (join lines)
937 start allow backspacing over the start of insert; CTRL-W and CTRL-U
938 stop once at the start of insert.
939
940 When the value is empty, Vi compatible backspacing is used.
941
942 For backwards compatibility with version 5.4 and earlier:
943 value effect ~
944 0 same as ":set backspace=" (Vi compatible)
945 1 same as ":set backspace=indent,eol"
946 2 same as ":set backspace=indent,eol,start"
947
948 See |:fixdel| if your <BS> or <Del> key does not do what you want.
949 NOTE: This option is set to "" when 'compatible' is set.
950
951 *'backup'* *'bk'* *'nobackup'* *'nobk'*
952'backup' 'bk' boolean (default off)
953 global
954 {not in Vi}
955 Make a backup before overwriting a file. Leave it around after the
956 file has been successfully written. If you do not want to keep the
957 backup file, but you do want a backup while the file is being
958 written, reset this option and set the 'writebackup' option (this is
959 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000960 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000961 |backup-table| for more explanations.
962 When the 'backupskip' pattern matches, a backup is not made anyway.
963 When 'patchmode' is set, the backup may be renamed to become the
964 oldest version of a file.
965 NOTE: This option is reset when 'compatible' is set.
966
967 *'backupcopy'* *'bkc'*
968'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200969 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 {not in Vi}
971 When writing a file and a backup is made, this option tells how it's
972 done. This is a comma separated list of words.
973
974 The main values are:
975 "yes" make a copy of the file and overwrite the original one
976 "no" rename the file and write a new one
977 "auto" one of the previous, what works best
978
979 Extra values that can be combined with the ones above are:
980 "breaksymlink" always break symlinks when writing
981 "breakhardlink" always break hardlinks when writing
982
983 Making a copy and overwriting the original file:
984 - Takes extra time to copy the file.
985 + When the file has special attributes, is a (hard/symbolic) link or
986 has a resource fork, all this is preserved.
987 - When the file is a link the backup will have the name of the link,
988 not of the real file.
989
990 Renaming the file and writing a new one:
991 + It's fast.
992 - Sometimes not all attributes of the file can be copied to the new
993 file.
994 - When the file is a link the new file will not be a link.
995
996 The "auto" value is the middle way: When Vim sees that renaming file
997 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000998 the file is not a link) that is used. When problems are expected, a
999 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000
1001 The "breaksymlink" and "breakhardlink" values can be used in
1002 combination with any of "yes", "no" and "auto". When included, they
1003 force Vim to always break either symbolic or hard links by doing
1004 exactly what the "no" option does, renaming the original file to
1005 become the backup and writing a new file in its place. This can be
1006 useful for example in source trees where all the files are symbolic or
1007 hard links and any changes should stay in the local source tree, not
1008 be propagated back to the original source.
1009 *crontab*
1010 One situation where "no" and "auto" will cause problems: A program
1011 that opens a file, invokes Vim to edit that file, and then tests if
1012 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001013 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001014 example.
1015
1016 When a copy is made, the original file is truncated and then filled
1017 with the new text. This means that protection bits, owner and
1018 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001019 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001020 group of the backup is set to the group of the original file. If this
1021 fails, the protection bits for the group are made the same as for
1022 others.
1023
1024 When the file is renamed this is the other way around: The backup has
1025 the same attributes of the original file, and the newly written file
1026 is owned by the current user. When the file was a (hard/symbolic)
1027 link, the new file will not! That's why the "auto" value doesn't
1028 rename when the file is a link. The owner and group of the newly
1029 written file will be set to the same ones as the original file, but
1030 the system may refuse to do this. In that case the "auto" value will
1031 again not rename the file.
1032
Bram Moolenaar036986f2017-03-16 17:41:02 +01001033 NOTE: This option is set to the Vi default value when 'compatible' is
1034 set and to the Vim default value when 'compatible' is reset.
1035
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036 *'backupdir'* *'bdir'*
1037'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001038 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001039 for Unix: ".,~/tmp,~/")
1040 global
1041 {not in Vi}
1042 List of directories for the backup file, separated with commas.
1043 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001044 where this is possible. The directory must exist, Vim will not
1045 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001046 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 impossible!). Writing may fail because of this.
1048 - A directory "." means to put the backup file in the same directory
1049 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001050 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051 put the backup file relative to where the edited file is. The
1052 leading "." is replaced with the path name of the edited file.
1053 ("." inside a directory name has no special meaning).
1054 - Spaces after the comma are ignored, other spaces are considered part
1055 of the directory name. To have a space at the start of a directory
1056 name, precede it with a backslash.
1057 - To include a comma in a directory name precede it with a backslash.
1058 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001059 - For Unix and Win32, if a directory ends in two path separators "//",
1060 the swap file name will be built from the complete path to the file
1061 with all path separators changed to percent '%' signs. This will
1062 ensure file name uniqueness in the backup directory.
1063 On Win32, it is also possible to end with "\\". However, When a
1064 separating comma is following, you must use "//", since "\\" will
1065 include the comma in the file name. Therefore it is recommended to
1066 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 - Environment variables are expanded |:set_env|.
1068 - Careful with '\' characters, type one before a space, type two to
1069 get one in the option (see |option-backslash|), for example: >
1070 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1071< - For backwards compatibility with Vim version 3.0 a '>' at the start
1072 of the option is removed.
1073 See also 'backup' and 'writebackup' options.
1074 If you want to hide your backup files on Unix, consider this value: >
1075 :set backupdir=./.backup,~/.backup,.,/tmp
1076< You must create a ".backup" directory in each directory and in your
1077 home directory for this to work properly.
1078 The use of |:set+=| and |:set-=| is preferred when adding or removing
1079 directories from the list. This avoids problems when a future version
1080 uses another default.
1081 This option cannot be set from a |modeline| or in the |sandbox|, for
1082 security reasons.
1083
1084 *'backupext'* *'bex'* *E589*
1085'backupext' 'bex' string (default "~", for VMS: "_")
1086 global
1087 {not in Vi}
1088 String which is appended to a file name to make the name of the
1089 backup file. The default is quite unusual, because this avoids
1090 accidentally overwriting existing files with a backup file. You might
1091 prefer using ".bak", but make sure that you don't have files with
1092 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001093 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001095 If you like to keep a lot of backups, you could use a BufWritePre
1096 autocommand to change 'backupext' just before writing the file to
1097 include a timestamp. >
1098 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1099< Use 'backupdir' to put the backup in a different directory.
1100
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001102'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1103 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1104 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105 global
1106 {not in Vi}
1107 {not available when compiled without the |+wildignore|
1108 feature}
1109 A list of file patterns. When one of the patterns matches with the
1110 name of the file which is written, no backup file is created. Both
1111 the specified file name and the full path name of the file are used.
1112 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1113 Watch out for special characters, see |option-backslash|.
1114 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001115 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001116
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001117 WARNING: Not having a backup file means that when Vim fails to write
1118 your buffer correctly and then, for whatever reason, Vim exits, you
1119 lose both the original file and what you were writing. Only disable
1120 backups if you don't care about losing the file.
1121
Bram Moolenaar02467872007-05-06 13:22:01 +00001122 Note that environment variables are not expanded. If you want to use
1123 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001124 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001125
1126< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001127 backup would be made by renaming the original file crontab won't see
1128 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129
1130 *'balloondelay'* *'bdlay'*
1131'balloondelay' 'bdlay' number (default: 600)
1132 global
1133 {not in Vi}
1134 {only available when compiled with the |+balloon_eval|
1135 feature}
1136 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1137
1138 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1139'ballooneval' 'beval' boolean (default off)
1140 global
1141 {not in Vi}
1142 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001143 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001144 Switch on the |balloon-eval| functionality for the GUI.
1145
1146 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1147 *'nobevalterm'*
1148'balloonevalterm' 'bevalterm' boolean (default off)
1149 global
1150 {not in Vi}
1151 {only available when compiled with the
1152 |+balloon_eval_term| feature}
1153 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001155 *'balloonexpr'* *'bexpr'*
1156'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001157 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001158 {not in Vi}
1159 {only available when compiled with the |+balloon_eval|
1160 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001161 Expression for text to show in evaluation balloon. It is only used
1162 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001163
1164 v:beval_bufnr number of the buffer in which balloon is going to show
1165 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001166 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001167 v:beval_lnum line number
1168 v:beval_col column number (byte index)
1169 v:beval_text word under or after the mouse pointer
1170
1171 The evaluation of the expression must not have side effects!
1172 Example: >
1173 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001174 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001175 \', column ' . v:beval_col .
1176 \ ' of file ' . bufname(v:beval_bufnr) .
1177 \ ' on word "' . v:beval_text . '"'
1178 endfunction
1179 set bexpr=MyBalloonExpr()
1180 set ballooneval
1181<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001182 Also see |balloon_show()|, can be used if the content of the balloon
1183 is to be fetched asynchronously.
1184
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001185 NOTE: The balloon is displayed only if the cursor is on a text
1186 character. If the result of evaluating 'balloonexpr' is not empty,
1187 Vim does not try to send a message to an external debugger (Netbeans
1188 or Sun Workshop).
1189
Bram Moolenaar30b65812012-07-12 22:01:11 +02001190 The expression will be evaluated in the |sandbox| when set from a
1191 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001192
1193 It is not allowed to change text or jump to another window while
1194 evaluating 'balloonexpr' |textlock|.
1195
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001196 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001197 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001198< When they are supported "\n" characters will start a new line. If the
1199 expression evaluates to a |List| this is equal to using each List item
1200 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001201 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001202
Bram Moolenaar165bc692015-07-21 17:53:25 +02001203 *'belloff'* *'bo'*
1204'belloff' 'bo' string (default "")
1205 global
1206 {not in Vi}
1207 Specifies for which events the bell will not be rung. It is a comma
1208 separated list of items. For each item that is present, the bell
1209 will be silenced. This is most useful to specify specific events in
1210 insert mode to be silenced.
1211
1212 item meaning when present ~
1213 all All events.
1214 backspace When hitting <BS> or <Del> and deleting results in an
1215 error.
1216 cursor Fail to move around using the cursor keys or
1217 <PageUp>/<PageDown> in |Insert-mode|.
1218 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1219 |i_CTRL-X_CTRL-T|.
1220 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1221 |i_CTRL-E|.
1222 ctrlg Unknown Char after <C-G> in Insert mode.
1223 error Other Error occurred (e.g. try to join last line)
1224 (mostly used in |Normal-mode| or |Cmdline-mode|).
1225 esc hitting <Esc> in |Normal-mode|.
1226 ex In |Visual-mode|, hitting |Q| results in an error.
1227 hangul Error occurred when using hangul input.
1228 insertmode Pressing <Esc> in 'insertmode'.
1229 lang Calling the beep module for Lua/Mzscheme/TCL.
1230 mess No output available for |g<|.
1231 showmatch Error occurred for 'showmatch' function.
1232 operator Empty region error |cpo-E|.
1233 register Unknown register after <C-R> in |Insert-mode|.
1234 shell Bell from shell output |:!|.
1235 spell Error happened on spell suggest.
1236 wildmode More matches in |cmdline-completion| available
1237 (depends on the 'wildmode' setting).
1238
Bram Moolenaar036986f2017-03-16 17:41:02 +01001239 This is most useful to fine tune when in Insert mode the bell should
1240 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001241 indicate that an error occurred. It can be silenced by adding the
1242 "error" keyword.
1243
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1245'binary' 'bin' boolean (default off)
1246 local to buffer
1247 {not in Vi}
1248 This option should be set before editing a binary file. You can also
1249 use the |-b| Vim argument. When this option is switched on a few
1250 options will be changed (also when it already was on):
1251 'textwidth' will be set to 0
1252 'wrapmargin' will be set to 0
1253 'modeline' will be off
1254 'expandtab' will be off
1255 Also, 'fileformat' and 'fileformats' options will not be used, the
1256 file is read and written like 'fileformat' was "unix" (a single <NL>
1257 separates lines).
1258 The 'fileencoding' and 'fileencodings' options will not be used, the
1259 file is read without conversion.
1260 NOTE: When you start editing a(nother) file while the 'bin' option is
1261 on, settings from autocommands may change the settings again (e.g.,
1262 'textwidth'), causing trouble when editing. You might want to set
1263 'bin' again when the file has been loaded.
1264 The previous values of these options are remembered and restored when
1265 'bin' is switched from on to off. Each buffer has its own set of
1266 saved option values.
1267 To edit a file with 'binary' set you can use the |++bin| argument.
1268 This avoids you have to do ":set bin", which would have effect for all
1269 files you edit.
1270 When writing a file the <EOL> for the last line is only written if
1271 there was one in the original file (normally Vim appends an <EOL> to
1272 the last line if there is none; this would make the file longer). See
1273 the 'endofline' option.
1274
1275 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1276'bioskey' 'biosk' boolean (default on)
1277 global
1278 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001279 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280
1281 *'bomb'* *'nobomb'*
1282'bomb' boolean (default off)
1283 local to buffer
1284 {not in Vi}
1285 {only available when compiled with the |+multi_byte|
1286 feature}
1287 When writing a file and the following conditions are met, a BOM (Byte
1288 Order Mark) is prepended to the file:
1289 - this option is on
1290 - the 'binary' option is off
1291 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1292 endian variants.
1293 Some applications use the BOM to recognize the encoding of the file.
1294 Often used for UCS-2 files on MS-Windows. For other applications it
1295 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001296 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001297 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1298 check for the presence of the BOM is done and 'bomb' set accordingly.
1299 Unless 'binary' is set, it is removed from the first line, so that you
1300 don't see it when editing. When you don't change the options, the BOM
1301 will be restored when writing the file.
1302
1303 *'breakat'* *'brk'*
1304'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1305 global
1306 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001307 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 feature}
1309 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001310 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1311 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001313 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001314'breakindent' 'bri' boolean (default off)
1315 local to window
1316 {not in Vi}
1317 {not available when compiled without the |+linebreak|
1318 feature}
1319 Every wrapped line will continue visually indented (same amount of
1320 space as the beginning of that line), thus preserving horizontal blocks
1321 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001322 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001323
1324 *'breakindentopt'* *'briopt'*
1325'breakindentopt' 'briopt' string (default empty)
1326 local to window
1327 {not in Vi}
1328 {not available when compiled without the |+linebreak|
1329 feature}
1330 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001331 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001332 min:{n} Minimum text width that will be kept after
1333 applying 'breakindent', even if the resulting
1334 text should normally be narrower. This prevents
1335 text indented almost to the right window border
1336 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001337 shift:{n} After applying 'breakindent', the wrapped line's
1338 beginning will be shifted by the given number of
1339 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001340 indentation (negative) or emphasizing the line
1341 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001342 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001343 additional indent.
1344 The default value for min is 20 and shift is 0.
1345
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001347'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001349 {not in Vi} {only for Motif, Athena, GTK, Mac and
1350 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001351 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001352 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001353 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 buffer Use the directory of the related buffer.
1355 current Use the current directory.
1356 {path} Use the specified directory
1357
1358 *'bufhidden'* *'bh'*
1359'bufhidden' 'bh' string (default: "")
1360 local to buffer
1361 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362 This option specifies what happens when a buffer is no longer
1363 displayed in a window:
1364 <empty> follow the global 'hidden' option
1365 hide hide the buffer (don't unload it), also when 'hidden'
1366 is not set
1367 unload unload the buffer, also when 'hidden' is set or using
1368 |:hide|
1369 delete delete the buffer from the buffer list, also when
1370 'hidden' is set or using |:hide|, like using
1371 |:bdelete|
1372 wipe wipe out the buffer from the buffer list, also when
1373 'hidden' is set or using |:hide|, like using
1374 |:bwipeout|
1375
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001376 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001377 are lost without a warning. Also, these values may break autocommands
1378 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379 This option is used together with 'buftype' and 'swapfile' to specify
1380 special kinds of buffers. See |special-buffers|.
1381
1382 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1383'buflisted' 'bl' boolean (default: on)
1384 local to buffer
1385 {not in Vi}
1386 When this option is set, the buffer shows up in the buffer list. If
1387 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1388 This option is reset by Vim for buffers that are only used to remember
1389 a file name or marks. Vim sets it when starting to edit a buffer.
1390 But not when moving to a buffer with ":buffer".
1391
1392 *'buftype'* *'bt'* *E382*
1393'buftype' 'bt' string (default: "")
1394 local to buffer
1395 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396 The value of this option specifies the type of a buffer:
1397 <empty> normal buffer
1398 nofile buffer which is not related to a file and will not be
1399 written
1400 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001401 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001402 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001404 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405 help help buffer (you are not supposed to set this
1406 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001407 terminal buffer for a |terminal| (you are not supposed to set
1408 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001409 prompt buffer where only the last line can be edited, meant
1410 to be used by a plugin, see |prompt-buffer|
1411 {only when compiled with the |+channel| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412
1413 This option is used together with 'bufhidden' and 'swapfile' to
1414 specify special kinds of buffers. See |special-buffers|.
1415
1416 Be careful with changing this option, it can have many side effects!
1417
Bram Moolenaar280f1262006-01-30 00:14:18 +00001418 A "quickfix" buffer is only used for the error list and the location
1419 list. This value is set by the |:cwindow| and |:lwindow| commands and
1420 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421
1422 "nofile" and "nowrite" buffers are similar:
1423 both: The buffer is not to be written to disk, ":w" doesn't
1424 work (":w filename" does work though).
1425 both: The buffer is never considered to be |'modified'|.
1426 There is no warning when the changes will be lost, for
1427 example when you quit Vim.
1428 both: A swap file is only created when using too much memory
1429 (when 'swapfile' has been reset there is never a swap
1430 file).
1431 nofile only: The buffer name is fixed, it is not handled like a
1432 file name. It is not modified in response to a |:cd|
1433 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001434 both: When using ":e bufname" and already editing "bufname"
1435 the buffer is made empty and autocommands are
1436 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001437 *E676*
1438 "acwrite" implies that the buffer name is not related to a file, like
1439 "nofile", but it will be written. Thus, in contrast to "nofile" and
1440 "nowrite", ":w" does work and a modified buffer can't be abandoned
1441 without saving. For writing there must be matching |BufWriteCmd|,
1442 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443
1444 *'casemap'* *'cmp'*
1445'casemap' 'cmp' string (default: "internal,keepascii")
1446 global
1447 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001448 {only available when compiled with the |+multi_byte|
1449 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450 Specifies details about changing the case of letters. It may contain
1451 these words, separated by a comma:
1452 internal Use internal case mapping functions, the current
1453 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001454 matters when 'encoding' is a Unicode encoding,
1455 "latin1" or "iso-8859-15". When "internal" is
1456 omitted, the towupper() and towlower() system library
1457 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1459 case mapping, the current locale is not effective.
1460 This probably only matters for Turkish.
1461
1462 *'cdpath'* *'cd'* *E344* *E346*
1463'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1464 global
1465 {not in Vi}
1466 {not available when compiled without the
1467 |+file_in_path| feature}
1468 This is a list of directories which will be searched when using the
1469 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001470 for has a relative path, not an absolute part starting with "/", "./"
1471 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472 The 'cdpath' option's value has the same form and semantics as
1473 |'path'|. Also see |file-searching|.
1474 The default value is taken from $CDPATH, with a "," prepended to look
1475 in the current directory first.
1476 If the default value taken from $CDPATH is not what you want, include
1477 a modified version of the following command in your vimrc file to
1478 override it: >
1479 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1480< This option cannot be set from a |modeline| or in the |sandbox|, for
1481 security reasons.
1482 (parts of 'cdpath' can be passed to the shell to expand file names).
1483
1484 *'cedit'*
1485'cedit' string (Vi default: "", Vim default: CTRL-F)
1486 global
1487 {not in Vi}
1488 {not available when compiled without the |+vertsplit|
1489 feature}
1490 The key used in Command-line Mode to open the command-line window.
1491 The default is CTRL-F when 'compatible' is off.
1492 Only non-printable keys are allowed.
1493 The key can be specified as a single character, but it is difficult to
1494 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001495 :exe "set cedit=\<C-Y>"
1496 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001497< |Nvi| also has this option, but it only uses the first character.
1498 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001499 NOTE: This option is set to the Vim default value when 'compatible'
1500 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501
1502 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1503'charconvert' 'ccv' string (default "")
1504 global
1505 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001506 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 {not in Vi}
1508 An expression that is used for character encoding conversion. It is
1509 evaluated when a file that is to be read or has been written has a
1510 different encoding from what is desired.
1511 'charconvert' is not used when the internal iconv() function is
1512 supported and is able to do the conversion. Using iconv() is
1513 preferred, because it is much faster.
1514 'charconvert' is not used when reading stdin |--|, because there is no
1515 file to convert from. You will have to save the text in a file first.
1516 The expression must return zero or an empty string for success,
1517 non-zero for failure.
1518 The possible encoding names encountered are in 'encoding'.
1519 Additionally, names given in 'fileencodings' and 'fileencoding' are
1520 used.
1521 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1522 is done internally by Vim, 'charconvert' is not used for this.
1523 'charconvert' is also used to convert the viminfo file, if the 'c'
1524 flag is present in 'viminfo'. Also used for Unicode conversion.
1525 Example: >
1526 set charconvert=CharConvert()
1527 fun CharConvert()
1528 system("recode "
1529 \ . v:charconvert_from . ".." . v:charconvert_to
1530 \ . " <" . v:fname_in . " >" v:fname_out)
1531 return v:shell_error
1532 endfun
1533< The related Vim variables are:
1534 v:charconvert_from name of the current encoding
1535 v:charconvert_to name of the desired encoding
1536 v:fname_in name of the input file
1537 v:fname_out name of the output file
1538 Note that v:fname_in and v:fname_out will never be the same.
1539 Note that v:charconvert_from and v:charconvert_to may be different
1540 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1541 Encryption is not done by Vim when using 'charconvert'. If you want
1542 to encrypt the file after conversion, 'charconvert' should take care
1543 of this.
1544 This option cannot be set from a |modeline| or in the |sandbox|, for
1545 security reasons.
1546
1547 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1548'cindent' 'cin' boolean (default off)
1549 local to buffer
1550 {not in Vi}
1551 {not available when compiled without the |+cindent|
1552 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001553 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 that trigger reindenting in insert mode and 'cinoptions' to set your
1555 preferred indent style.
1556 If 'indentexpr' is not empty, it overrules 'cindent'.
1557 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1558 the "=" operator indents using this algorithm rather than calling an
1559 external program.
1560 See |C-indenting|.
1561 When you don't like the way 'cindent' works, try the 'smartindent'
1562 option or 'indentexpr'.
1563 This option is not used when 'paste' is set.
1564 NOTE: This option is reset when 'compatible' is set.
1565
1566 *'cinkeys'* *'cink'*
1567'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1568 local to buffer
1569 {not in Vi}
1570 {not available when compiled without the |+cindent|
1571 feature}
1572 A list of keys that, when typed in Insert mode, cause reindenting of
1573 the current line. Only used if 'cindent' is on and 'indentexpr' is
1574 empty.
1575 For the format of this option see |cinkeys-format|.
1576 See |C-indenting|.
1577
1578 *'cinoptions'* *'cino'*
1579'cinoptions' 'cino' string (default "")
1580 local to buffer
1581 {not in Vi}
1582 {not available when compiled without the |+cindent|
1583 feature}
1584 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1585 program. See |cinoptions-values| for the values of this option, and
1586 |C-indenting| for info on C indenting in general.
1587
1588
1589 *'cinwords'* *'cinw'*
1590'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1591 local to buffer
1592 {not in Vi}
1593 {not available when compiled without both the
1594 |+cindent| and the |+smartindent| features}
1595 These keywords start an extra indent in the next line when
1596 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1597 an appropriate place (inside {}).
1598 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1599 matter, include the keyword both the uppercase and lowercase:
1600 "if,If,IF".
1601
1602 *'clipboard'* *'cb'*
1603'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1604 for X-windows, "" otherwise)
1605 global
1606 {not in Vi}
1607 {only in GUI versions or when the |+xterm_clipboard|
1608 feature is included}
1609 This option is a list of comma separated names.
1610 These names are recognized:
1611
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001612 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 unnamed When included, Vim will use the clipboard register '*'
1614 for all yank, delete, change and put operations which
1615 would normally go to the unnamed register. When a
1616 register is explicitly specified, it will always be
1617 used regardless of whether "unnamed" is in 'clipboard'
1618 or not. The clipboard register can always be
1619 explicitly accessed using the "* notation. Also see
1620 |gui-clipboard|.
1621
Bram Moolenaar30b65812012-07-12 22:01:11 +02001622 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001623 unnamedplus A variant of the "unnamed" flag which uses the
1624 clipboard register '+' (|quoteplus|) instead of
1625 register '*' for all yank, delete, change and put
1626 operations which would normally go to the unnamed
1627 register. When "unnamed" is also included to the
1628 option, yank operations (but not delete, change or
1629 put) will additionally copy the text into register
1630 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001631 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001632 Availability can be checked with: >
1633 if has('unnamedplus')
1634<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001635 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 autoselect Works like the 'a' flag in 'guioptions': If present,
1637 then whenever Visual mode is started, or the Visual
1638 area extended, Vim tries to become the owner of the
1639 windowing system's global selection or put the
1640 selected text on the clipboard used by the selection
1641 register "*. See |guioptions_a| and |quotestar| for
1642 details. When the GUI is active, the 'a' flag in
1643 'guioptions' is used, when the GUI is not active, this
1644 "autoselect" flag is used.
1645 Also applies to the modeless selection.
1646
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001647 *clipboard-autoselectplus*
1648 autoselectplus Like "autoselect" but using the + register instead of
1649 the * register. Compare to the 'P' flag in
1650 'guioptions'.
1651
1652 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653 autoselectml Like "autoselect", but for the modeless selection
1654 only. Compare to the 'A' flag in 'guioptions'.
1655
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001656 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001657 html When the clipboard contains HTML, use this when
1658 pasting. When putting text on the clipboard, mark it
1659 as HTML. This works to copy rendered HTML from
1660 Firefox, paste it as raw HTML in Vim, select the HTML
1661 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001662 You probably want to add this only temporarily,
1663 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001664 Only supported for GTK version 2 and later.
1665 Only available with the |+multi_byte| feature.
1666
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001667 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 exclude:{pattern}
1669 Defines a pattern that is matched against the name of
1670 the terminal 'term'. If there is a match, no
1671 connection will be made to the X server. This is
1672 useful in this situation:
1673 - Running Vim in a console.
1674 - $DISPLAY is set to start applications on another
1675 display.
1676 - You do not want to connect to the X server in the
1677 console, but do want this in a terminal emulator.
1678 To never connect to the X server use: >
1679 exclude:.*
1680< This has the same effect as using the |-X| argument.
1681 Note that when there is no connection to the X server
1682 the window title won't be restored and the clipboard
1683 cannot be accessed.
1684 The value of 'magic' is ignored, {pattern} is
1685 interpreted as if 'magic' was on.
1686 The rest of the option value will be used for
1687 {pattern}, this must be the last entry.
1688
1689 *'cmdheight'* *'ch'*
1690'cmdheight' 'ch' number (default 1)
1691 global
1692 {not in Vi}
1693 Number of screen lines to use for the command-line. Helps avoiding
1694 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001695 The value of this option is stored with the tab page, so that each tab
1696 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697
1698 *'cmdwinheight'* *'cwh'*
1699'cmdwinheight' 'cwh' number (default 7)
1700 global
1701 {not in Vi}
1702 {not available when compiled without the |+vertsplit|
1703 feature}
1704 Number of screen lines to use for the command-line window. |cmdwin|
1705
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001706 *'colorcolumn'* *'cc'*
1707'colorcolumn' 'cc' string (default "")
1708 local to window
1709 {not in Vi}
1710 {not available when compiled without the |+syntax|
1711 feature}
1712 'colorcolumn' is a comma separated list of screen columns that are
1713 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1714 text. Will make screen redrawing slower.
1715 The screen column can be an absolute number, or a number preceded with
1716 '+' or '-', which is added to or subtracted from 'textwidth'. >
1717
1718 :set cc=+1 " highlight column after 'textwidth'
1719 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1720 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1721<
1722 When 'textwidth' is zero then the items with '-' and '+' are not used.
1723 A maximum of 256 columns are highlighted.
1724
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725 *'columns'* *'co'* *E594*
1726'columns' 'co' number (default 80 or terminal width)
1727 global
1728 {not in Vi}
1729 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001730 initialization and does not have to be set by hand. Also see
1731 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 When Vim is running in the GUI or in a resizable window, setting this
1733 option will cause the window size to be changed. When you only want
1734 to use the size for the GUI, put the command in your |gvimrc| file.
1735 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001736 number of columns of the display, the display may be messed up. For
1737 the GUI it is always possible and Vim limits the number of columns to
1738 what fits on the screen. You can use this command to get the widest
1739 window possible: >
1740 :set columns=9999
1741< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742
1743 *'comments'* *'com'* *E524* *E525*
1744'comments' 'com' string (default
1745 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1746 local to buffer
1747 {not in Vi}
1748 {not available when compiled without the |+comments|
1749 feature}
1750 A comma separated list of strings that can start a comment line. See
1751 |format-comments|. See |option-backslash| about using backslashes to
1752 insert a space.
1753
1754 *'commentstring'* *'cms'* *E537*
1755'commentstring' 'cms' string (default "/*%s*/")
1756 local to buffer
1757 {not in Vi}
1758 {not available when compiled without the |+folding|
1759 feature}
1760 A template for a comment. The "%s" in the value is replaced with the
1761 comment text. Currently only used to add markers for folding, see
1762 |fold-marker|.
1763
1764 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001765'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001766 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767 global
1768 {not in Vi}
1769 This option has the effect of making Vim either more Vi-compatible, or
1770 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001771
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001773 other options are also changed as a side effect.
1774 NOTE: Setting or resetting this option can have a lot of unexpected
1775 effects: Mappings are interpreted in another way, undo behaves
1776 differently, etc. If you set this option in your vimrc file, you
1777 should probably put it at the very start.
1778
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 By default this option is on and the Vi defaults are used for the
1780 options. This default was chosen for those people who want to use Vim
1781 just like Vi, and don't even (want to) know about the 'compatible'
1782 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001783 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001784 this option is switched off, and all options that have not been
1785 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001786 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001787 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001788 happen for the system-wide vimrc or gvimrc file, nor for a file given
1789 with the |-u| argument). Also see |compatible-default| and
1790 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 You can also set this option with the "-C" argument, and reset it with
1792 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001793 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794
Bram Moolenaar214641f2017-03-05 17:04:09 +01001795 When this option is set, numerous other options are set to make Vim as
1796 Vi-compatible as possible. When this option is unset, various options
1797 are set to make Vim more useful. The table below lists all the
1798 options affected.
1799 The {?} column indicates when the options are affected:
1800 + Means that the option is set to the value given in {set value} when
1801 'compatible' is set.
1802 & Means that the option is set to the value given in {set value} when
1803 'compatible' is set AND is set to its Vim default value when
1804 'compatible' is unset.
1805 - Means the option is NOT changed when setting 'compatible' but IS
1806 set to its Vim default when 'compatible' is unset.
1807 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808
Bram Moolenaar036986f2017-03-16 17:41:02 +01001809 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001810
1811 'allowrevins' + off no CTRL-_ command
1812 'antialias' + off don't use antialiased fonts
1813 'arabic' + off reset arabic-related options
1814 'arabicshape' + on correct character shapes
1815 'backspace' + "" normal backspace
1816 'backup' + off no backup file
1817 'backupcopy' & Unix: "yes" backup file is a copy
1818 else: "auto" copy or rename backup file
1819 'balloonexpr' + "" text to show in evaluation balloon
1820 'breakindent' + off don't indent when wrapping lines
1821 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1822 'cindent' + off no C code indentation
1823 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1824 'copyindent' + off don't copy indent structure
1825 'cpoptions' & (all flags) Vi-compatible flags
1826 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001827 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001828 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001829 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001830 'cscopeverbose' + off see |cscopeverbose|
1831 'delcombine' + off unicode: delete whole char combination
1832 'digraph' + off no digraphs
1833 'esckeys' & off no <Esc>-keys in Insert mode
1834 'expandtab' + off tabs not expanded to spaces
1835 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001837 'formatexpr' + "" use 'formatprg' for auto-formatting
1838 'formatoptions' & "vt" Vi compatible formatting
1839 'gdefault' + off no default 'g' flag for ":s"
1840 'history' & 0 no commandline history
1841 'hkmap' + off no Hebrew keyboard mapping
1842 'hkmapp' + off no phonetic Hebrew keyboard mapping
1843 'hlsearch' + off no highlighting of search matches
1844 'incsearch' + off no incremental searching
1845 'indentexpr' + "" no indenting by expression
1846 'insertmode' + off do not start in Insert mode
1847 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001849 'joinspaces' + on insert 2 spaces after period
1850 'modeline' & off no modelines
1851 'more' & off no pauses in listings
1852 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1853 'numberwidth' & 8 min number of columns for line number
1854 'preserveindent'+ off don't preserve current indent structure
1855 when changing it
1856 'revins' + off no reverse insert
1857 'ruler' + off no ruler
1858 'scrolljump' + 1 no jump scroll
1859 'scrolloff' + 0 no scroll offset
1860 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1861 'shiftround' + off indent not rounded to shiftwidth
1862 'shortmess' & "" no shortening of messages
1863 'showcmd' & off command characters not shown
1864 'showmode' & off current mode not shown
1865 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1866 'smartcase' + off no automatic ignore case switch
1867 'smartindent' + off no smart indentation
1868 'smarttab' + off no smart tab size
1869 'softtabstop' + 0 tabs are always 'tabstop' positions
1870 'startofline' + on goto startofline with some commands
1871 'tagcase' & "followic" 'ignorecase' when searching tags file
1872 'tagrelative' & off tag file names are not relative
1873 'termguicolors' + off don't use highlight-(guifg|guibg)
1874 'textauto' & off no automatic textmode detection
1875 'textwidth' + 0 no automatic line wrap
1876 'tildeop' + off tilde is not an operator
1877 'ttimeout' + off no terminal timeout
1878 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001879 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001880 'virtualedit' + "" cursor can only be placed on characters
1881 'whichwrap' & "" left-right movements don't wrap
1882 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001884 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885
1886 *'complete'* *'cpt'* *E535*
1887'complete' 'cpt' string (default: ".,w,b,u,t,i")
1888 local to buffer
1889 {not in Vi}
1890 This option specifies how keyword completion |ins-completion| works
1891 when CTRL-P or CTRL-N are used. It is also used for whole-line
1892 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1893 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001894 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001895 w scan buffers from other windows
1896 b scan other loaded buffers that are in the buffer list
1897 u scan the unloaded buffers that are in the buffer list
1898 U scan the buffers that are not in the buffer list
1899 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001900 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901 k{dict} scan the file {dict}. Several "k" flags can be given,
1902 patterns are valid too. For example: >
1903 :set cpt=k/usr/dict/*,k~/spanish
1904< s scan the files given with the 'thesaurus' option
1905 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1906 are valid too.
1907 i scan current and included files
1908 d scan current and included files for defined name or macro
1909 |i_CTRL-X_CTRL-D|
1910 ] tag completion
1911 t same as "]"
1912
1913 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1914 not executed, this may lead to unexpected completions from some files
1915 (gzipped files for example). Unloaded buffers are not scanned for
1916 whole-line completion.
1917
1918 The default is ".,w,b,u,t,i", which means to scan:
1919 1. the current buffer
1920 2. buffers in other windows
1921 3. other loaded buffers
1922 4. unloaded buffers
1923 5. tags
1924 6. included files
1925
1926 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001927 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1928 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001930 *'completefunc'* *'cfu'*
1931'completefunc' 'cfu' string (default: empty)
1932 local to buffer
1933 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001934 {not available when compiled without the |+eval|
1935 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001936 This option specifies a function to be used for Insert mode completion
1937 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001938 See |complete-functions| for an explanation of how the function is
1939 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001940 This option cannot be set from a |modeline| or in the |sandbox|, for
1941 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001942
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001943 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001944'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001945 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001946 {not available when compiled without the
1947 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001948 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001949 A comma separated list of options for Insert mode completion
1950 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001951
1952 menu Use a popup menu to show the possible completions. The
1953 menu is only shown when there is more than one match and
1954 sufficient colors are available. |ins-completion-menu|
1955
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001956 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001957 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001958 match, e.g., what file it comes from.
1959
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001960 longest Only insert the longest common text of the matches. If
1961 the menu is displayed you can use CTRL-L to add more
1962 characters. Whether case is ignored depends on the kind
1963 of completion. For buffer text the 'ignorecase' option is
1964 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001965
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001966 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001967 completion in the preview window. Only works in
1968 combination with "menu" or "menuone".
1969
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001970 noinsert Do not insert any text for a match until the user selects
1971 a match from the menu. Only works in combination with
1972 "menu" or "menuone". No effect if "longest" is present.
1973
1974 noselect Do not select a match in the menu, force the user to
1975 select one from the menu. Only works in combination with
1976 "menu" or "menuone".
1977
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001978
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001979 *'concealcursor'* *'cocu'*
1980'concealcursor' 'cocu' string (default: "")
1981 local to window
1982 {not in Vi}
1983 {not available when compiled without the |+conceal|
1984 feature}
1985 Sets the modes in which text in the cursor line can also be concealed.
1986 When the current mode is listed then concealing happens just like in
1987 other lines.
1988 n Normal mode
1989 v Visual mode
1990 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001991 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001992
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001993 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001994 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001995 are moving around text is concealed, but when starting to insert text
1996 or selecting a Visual area the concealed text is displayed, so that
1997 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001998 Keep in mind that the cursor position is not always where it's
1999 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002000
2001
2002'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02002003 number (default 0)
2004 local to window
2005 {not in Vi}
2006 {not available when compiled without the |+conceal|
2007 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002008 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2009 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002010
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002011 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002012 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002013 1 Each block of concealed text is replaced with one
2014 character. If the syntax item does not have a custom
2015 replacement character defined (see |:syn-cchar|) the
2016 character defined in 'listchars' is used (default is a
2017 space).
2018 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002019 2 Concealed text is completely hidden unless it has a
2020 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002021 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002022 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002023
Bram Moolenaara7781e02010-07-19 20:13:22 +02002024 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002025 edit and copy the text. This can be changed with the 'concealcursor'
2026 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002027
Bram Moolenaar071d4272004-06-13 20:20:40 +00002028 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2029'confirm' 'cf' boolean (default off)
2030 global
2031 {not in Vi}
2032 When 'confirm' is on, certain operations that would normally
2033 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2034 instead raise a |dialog| asking if you wish to save the current
2035 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2036 If 'confirm' is off you can still activate confirmation for one
2037 command only (this is most useful in mappings) with the |:confirm|
2038 command.
2039 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2040
2041 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2042'conskey' 'consk' boolean (default off)
2043 global
2044 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01002045 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046
2047 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2048'copyindent' 'ci' boolean (default off)
2049 local to buffer
2050 {not in Vi}
2051 Copy the structure of the existing lines indent when autoindenting a
2052 new line. Normally the new indent is reconstructed by a series of
2053 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2054 in which case only spaces are used). Enabling this option makes the
2055 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002056 existing line. 'expandtab' has no effect on these characters, a Tab
2057 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002059 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 Also see 'preserveindent'.
2061
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002062 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063'cpoptions' 'cpo' string (Vim default: "aABceFs",
2064 Vi default: all flags)
2065 global
2066 {not in Vi}
2067 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002068 this indicates Vi-compatible behavior. This is used for things where
2069 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002070 'cpoptions' stands for "compatible-options".
2071 Commas can be added for readability.
2072 To avoid problems with flags that are added in the future, use the
2073 "+=" and "-=" feature of ":set" |add-option-flags|.
2074 NOTE: This option is set to the Vi default value when 'compatible' is
2075 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002076 NOTE: This option is set to the POSIX default value at startup when
2077 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002078 variable exists |posix|. This means Vim tries to behave like the
2079 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080
2081 contains behavior ~
2082 *cpo-a*
2083 a When included, a ":read" command with a file name
2084 argument will set the alternate file name for the
2085 current window.
2086 *cpo-A*
2087 A When included, a ":write" command with a file name
2088 argument will set the alternate file name for the
2089 current window.
2090 *cpo-b*
2091 b "\|" in a ":map" command is recognized as the end of
2092 the map command. The '\' is included in the mapping,
2093 the text after the '|' is interpreted as the next
2094 command. Use a CTRL-V instead of a backslash to
2095 include the '|' in the mapping. Applies to all
2096 mapping, abbreviation, menu and autocmd commands.
2097 See also |map_bar|.
2098 *cpo-B*
2099 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002100 abbreviations, user commands and the "to" part of the
2101 menu commands. Remove this flag to be able to use a
2102 backslash like a CTRL-V. For example, the command
2103 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 'B' included: "\^[" (^[ is a real <Esc>)
2105 'B' excluded: "<Esc>" (5 characters)
2106 ('<' excluded in both cases)
2107 *cpo-c*
2108 c Searching continues at the end of any match at the
2109 cursor position, but not further than the start of the
2110 next line. When not present searching continues
2111 one character from the cursor position. With 'c'
2112 "abababababab" only gets three matches when repeating
2113 "/abab", without 'c' there are five matches.
2114 *cpo-C*
2115 C Do not concatenate sourced lines that start with a
2116 backslash. See |line-continuation|.
2117 *cpo-d*
2118 d Using "./" in the 'tags' option doesn't mean to use
2119 the tags file relative to the current file, but the
2120 tags file in the current directory.
2121 *cpo-D*
2122 D Can't use CTRL-K to enter a digraph after Normal mode
2123 commands with a character argument, like |r|, |f| and
2124 |t|.
2125 *cpo-e*
2126 e When executing a register with ":@r", always add a
2127 <CR> to the last line, also when the register is not
2128 linewise. If this flag is not present, the register
2129 is not linewise and the last line does not end in a
2130 <CR>, then the last line is put on the command-line
2131 and can be edited before hitting <CR>.
2132 *cpo-E*
2133 E It is an error when using "y", "d", "c", "g~", "gu" or
2134 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002135 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 This makes "y0" fail in the first column.
2137 *cpo-f*
2138 f When included, a ":read" command with a file name
2139 argument will set the file name for the current buffer,
2140 if the current buffer doesn't have a file name yet.
2141 *cpo-F*
2142 F When included, a ":write" command with a file name
2143 argument will set the file name for the current
2144 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002145 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 *cpo-g*
2147 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002148 *cpo-H*
2149 H When using "I" on a line with only blanks, insert
2150 before the last blank. Without this flag insert after
2151 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152 *cpo-i*
2153 i When included, interrupting the reading of a file will
2154 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002155 *cpo-I*
2156 I When moving the cursor up or down just after inserting
2157 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 *cpo-j*
2159 j When joining lines, only add two spaces after a '.',
2160 not after '!' or '?'. Also see 'joinspaces'.
2161 *cpo-J*
2162 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002163 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 white space.
2165 *cpo-k*
2166 k Disable the recognition of raw key codes in
2167 mappings, abbreviations, and the "to" part of menu
2168 commands. For example, if <Key> sends ^[OA (where ^[
2169 is <Esc>), the command ":map X ^[OA" results in X
2170 being mapped to:
2171 'k' included: "^[OA" (3 characters)
2172 'k' excluded: "<Key>" (one key code)
2173 Also see the '<' flag below.
2174 *cpo-K*
2175 K Don't wait for a key code to complete when it is
2176 halfway a mapping. This breaks mapping <F1><F1> when
2177 only part of the second <F1> has been read. It
2178 enables cancelling the mapping by typing <F1><Esc>.
2179 *cpo-l*
2180 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002181 literally, only "\]", "\^", "\-" and "\\" are special.
2182 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2184 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002185 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186 *cpo-L*
2187 L When the 'list' option is set, 'wrapmargin',
2188 'textwidth', 'softtabstop' and Virtual Replace mode
2189 (see |gR|) count a <Tab> as two characters, instead of
2190 the normal behavior of a <Tab>.
2191 *cpo-m*
2192 m When included, a showmatch will always wait half a
2193 second. When not included, a showmatch will wait half
2194 a second or until a character is typed. |'showmatch'|
2195 *cpo-M*
2196 M When excluded, "%" matching will take backslashes into
2197 account. Thus in "( \( )" and "\( ( \)" the outer
2198 parenthesis match. When included "%" ignores
2199 backslashes, which is Vi compatible.
2200 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002201 n When included, the column used for 'number' and
2202 'relativenumber' will also be used for text of wrapped
2203 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002204 *cpo-o*
2205 o Line offset to search command is not remembered for
2206 next search.
2207 *cpo-O*
2208 O Don't complain if a file is being overwritten, even
2209 when it didn't exist when editing it. This is a
2210 protection against a file unexpectedly created by
2211 someone else. Vi didn't complain about this.
2212 *cpo-p*
2213 p Vi compatible Lisp indenting. When not present, a
2214 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002215 *cpo-P*
2216 P When included, a ":write" command that appends to a
2217 file will set the file name for the current buffer, if
2218 the current buffer doesn't have a file name yet and
2219 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002220 *cpo-q*
2221 q When joining multiple lines leave the cursor at the
2222 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223 *cpo-r*
2224 r Redo ("." command) uses "/" to repeat a search
2225 command, instead of the actually used search string.
2226 *cpo-R*
2227 R Remove marks from filtered lines. Without this flag
2228 marks are kept like |:keepmarks| was used.
2229 *cpo-s*
2230 s Set buffer options when entering the buffer for the
2231 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002232 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233 set when the buffer is created.
2234 *cpo-S*
2235 S Set buffer options always when entering a buffer
2236 (except 'readonly', 'fileformat', 'filetype' and
2237 'syntax'). This is the (most) Vi compatible setting.
2238 The options are set to the values in the current
2239 buffer. When you change an option and go to another
2240 buffer, the value is copied. Effectively makes the
2241 buffer options global to all buffers.
2242
2243 's' 'S' copy buffer options
2244 no no when buffer created
2245 yes no when buffer first entered (default)
2246 X yes each time when buffer entered (vi comp.)
2247 *cpo-t*
2248 t Search pattern for the tag command is remembered for
2249 "n" command. Otherwise Vim only puts the pattern in
2250 the history for search pattern, but doesn't change the
2251 last used search pattern.
2252 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002253 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254 *cpo-v*
2255 v Backspaced characters remain visible on the screen in
2256 Insert mode. Without this flag the characters are
2257 erased from the screen right away. With this flag the
2258 screen newly typed text overwrites backspaced
2259 characters.
2260 *cpo-w*
2261 w When using "cw" on a blank character, only change one
2262 character and not all blanks until the start of the
2263 next word.
2264 *cpo-W*
2265 W Don't overwrite a readonly file. When omitted, ":w!"
2266 overwrites a readonly file, if possible.
2267 *cpo-x*
2268 x <Esc> on the command-line executes the command-line.
2269 The default in Vim is to abandon the command-line,
2270 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002271 *cpo-X*
2272 X When using a count with "R" the replaced text is
2273 deleted only once. Also when repeating "R" with "."
2274 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 *cpo-y*
2276 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002277 *cpo-Z*
2278 Z When using "w!" while the 'readonly' option is set,
2279 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280 *cpo-!*
2281 ! When redoing a filter command, use the last used
2282 external command, whatever it was. Otherwise the last
2283 used -filter- command is used.
2284 *cpo-$*
2285 $ When making a change to one line, don't redisplay the
2286 line, but put a '$' at the end of the changed text.
2287 The changed text will be overwritten when you type the
2288 new text. The line is redisplayed if you type any
2289 command that moves the cursor from the insertion
2290 point.
2291 *cpo-%*
2292 % Vi-compatible matching is done for the "%" command.
2293 Does not recognize "#if", "#endif", etc.
2294 Does not recognize "/*" and "*/".
2295 Parens inside single and double quotes are also
2296 counted, causing a string that contains a paren to
2297 disturb the matching. For example, in a line like
2298 "if (strcmp("foo(", s))" the first paren does not
2299 match the last one. When this flag is not included,
2300 parens inside single and double quotes are treated
2301 specially. When matching a paren outside of quotes,
2302 everything inside quotes is ignored. When matching a
2303 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002304 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002305 This flag is also used for other features, such as
2306 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002307 *cpo--*
2308 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002309 it would go above the first line or below the last
2310 line. Without it the cursor moves to the first or
2311 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002312 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002313 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002314 *cpo-+*
2315 + When included, a ":write file" command will reset the
2316 'modified' flag of the buffer, even though the buffer
2317 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002318 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002319 * Use ":*" in the same way as ":@". When not included,
2320 ":*" is an alias for ":'<,'>", select the Visual area.
2321 *cpo-<*
2322 < Disable the recognition of special key codes in |<>|
2323 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002324 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325 ":map X <Tab>" results in X being mapped to:
2326 '<' included: "<Tab>" (5 characters)
2327 '<' excluded: "^I" (^I is a real <Tab>)
2328 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002329 *cpo->*
2330 > When appending to a register, put a line break before
2331 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002332 *cpo-;*
2333 ; When using |,| or |;| to repeat the last |t| search
2334 and the cursor is right in front of the searched
2335 character, the cursor won't move. When not included,
2336 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002337 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002338
2339 POSIX flags. These are not included in the Vi default value, except
2340 when $VIM_POSIX was set on startup. |posix|
2341
2342 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002343 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002344 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002345 *cpo-&*
2346 & When ":preserve" was used keep the swap file when
2347 exiting normally while this buffer is still loaded.
2348 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002349 *cpo-\*
2350 \ Backslash in a [] range in a search pattern is taken
2351 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002352 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2353 '\' excluded: "/[ \-]" finds <Space> and '-'
2354 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002355 *cpo-/*
2356 / When "%" is used as the replacement string in a |:s|
2357 command, use the previous replacement string. |:s%|
2358 *cpo-{*
2359 { The |{| and |}| commands also stop at a "{" character
2360 at the start of a line.
2361 *cpo-.*
2362 . The ":chdir" and ":cd" commands fail if the current
2363 buffer is modified, unless ! is used. Vim doesn't
2364 need this, since it remembers the full path of an
2365 opened file.
2366 *cpo-bar*
2367 | The value of the $LINES and $COLUMNS environment
2368 variables overrule the terminal size values obtained
2369 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002370
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002372 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002373'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002374 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002375 {not in Vi}
2376 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002377 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002378 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002379 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002380 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002381 blowfish Blowfish method. Medium strong encryption but it has
2382 an implementation flaw. Requires Vim 7.3 or later,
2383 files can NOT be read by Vim 7.2 and older. This adds
2384 a "seed" to the file, every time you write the file
2385 the encrypted bytes will be different.
2386 *blowfish2*
2387 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002388 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002389 and older. This adds a "seed" to the file, every time
2390 you write the file the encrypted bytes will be
2391 different. The whole undo file is encrypted, not just
2392 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002393
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002394 You should use "blowfish2", also to re-encrypt older files.
2395
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002396 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002397 to the detected method of the file being read. Thus if you write it
2398 without changing 'cryptmethod' the same method will be used.
2399 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002400 explicitly write it, you don't get a warning unless there are other
2401 modifications. Also see |:X|.
2402
2403 When setting the global value to an empty string, it will end up with
2404 the value "zip". When setting the local value to an empty string the
2405 buffer will use the global value.
2406
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002407 When a new encryption method is added in a later version of Vim, and
2408 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002409 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002410
2411
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412 *'cscopepathcomp'* *'cspc'*
2413'cscopepathcomp' 'cspc' number (default 0)
2414 global
2415 {not available when compiled without the |+cscope|
2416 feature}
2417 {not in Vi}
2418 Determines how many components of the path to show in a list of tags.
2419 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002420 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002421
2422 *'cscopeprg'* *'csprg'*
2423'cscopeprg' 'csprg' string (default "cscope")
2424 global
2425 {not available when compiled without the |+cscope|
2426 feature}
2427 {not in Vi}
2428 Specifies the command to execute cscope. See |cscopeprg|.
2429 This option cannot be set from a |modeline| or in the |sandbox|, for
2430 security reasons.
2431
2432 *'cscopequickfix'* *'csqf'*
2433'cscopequickfix' 'csqf' string (default "")
2434 global
2435 {not available when compiled without the |+cscope|
2436 or |+quickfix| features}
2437 {not in Vi}
2438 Specifies whether to use quickfix window to show cscope results.
2439 See |cscopequickfix|.
2440
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002441 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002442'cscoperelative' 'csre' boolean (default off)
2443 global
2444 {not available when compiled without the |+cscope|
2445 feature}
2446 {not in Vi}
2447 In the absence of a prefix (-P) for cscope. setting this option enables
2448 to use the basename of cscope.out path as the prefix.
2449 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002450 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002451
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2453'cscopetag' 'cst' boolean (default off)
2454 global
2455 {not available when compiled without the |+cscope|
2456 feature}
2457 {not in Vi}
2458 Use cscope for tag commands. See |cscope-options|.
2459 NOTE: This option is reset when 'compatible' is set.
2460
2461 *'cscopetagorder'* *'csto'*
2462'cscopetagorder' 'csto' number (default 0)
2463 global
2464 {not available when compiled without the |+cscope|
2465 feature}
2466 {not in Vi}
2467 Determines the order in which ":cstag" performs a search. See
2468 |cscopetagorder|.
2469 NOTE: This option is set to 0 when 'compatible' is set.
2470
2471 *'cscopeverbose'* *'csverb'*
2472 *'nocscopeverbose'* *'nocsverb'*
2473'cscopeverbose' 'csverb' boolean (default off)
2474 global
2475 {not available when compiled without the |+cscope|
2476 feature}
2477 {not in Vi}
2478 Give messages when adding a cscope database. See |cscopeverbose|.
2479 NOTE: This option is reset when 'compatible' is set.
2480
Bram Moolenaar860cae12010-06-05 23:22:07 +02002481 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2482'cursorbind' 'crb' boolean (default off)
2483 local to window
2484 {not in Vi}
Bram Moolenaar860cae12010-06-05 23:22:07 +02002485 When this option is set, as the cursor in the current
2486 window moves other cursorbound windows (windows that also have
2487 this option set) move their cursors to the corresponding line and
2488 column. This option is useful for viewing the
2489 differences between two versions of a file (see 'diff'); in diff mode,
2490 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002491 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002492
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002493
2494 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2495'cursorcolumn' 'cuc' boolean (default off)
2496 local to window
2497 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002498 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002499 feature}
2500 Highlight the screen column of the cursor with CursorColumn
2501 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2502 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002503 If you only want the highlighting in the current window you can use
2504 these autocommands: >
2505 au WinLeave * set nocursorline nocursorcolumn
2506 au WinEnter * set cursorline cursorcolumn
2507<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002508
2509 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2510'cursorline' 'cul' boolean (default off)
2511 local to window
2512 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002513 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002514 feature}
2515 Highlight the screen line of the cursor with CursorLine
2516 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2517 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002518 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002519 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002520
2521
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 *'debug'*
2523'debug' string (default "")
2524 global
2525 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002526 These values can be used:
2527 msg Error messages that would otherwise be omitted will be given
2528 anyway.
2529 throw Error messages that would otherwise be omitted will be given
2530 anyway and also throw an exception and set |v:errmsg|.
2531 beep A message will be given when otherwise only a beep would be
2532 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002533 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002534 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2535 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002536
2537 *'define'* *'def'*
2538'define' 'def' string (default "^\s*#\s*define")
2539 global or local to buffer |global-local|
2540 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002541 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 pattern, just like for the "/" command. This option is used for the
2543 commands like "[i" and "[d" |include-search|. The 'isident' option is
2544 used to recognize the defined name after the match:
2545 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2546 See |option-backslash| about inserting backslashes to include a space
2547 or backslash.
2548 The default value is for C programs. For C++ this value would be
2549 useful, to include const type declarations: >
2550 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2551< When using the ":set" command, you need to double the backslashes!
2552
2553 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2554'delcombine' 'deco' boolean (default off)
2555 global
2556 {not in Vi}
2557 {only available when compiled with the |+multi_byte|
2558 feature}
2559 If editing Unicode and this option is set, backspace and Normal mode
2560 "x" delete each combining character on its own. When it is off (the
2561 default) the character along with its combining characters are
2562 deleted.
2563 Note: When 'delcombine' is set "xx" may work different from "2x"!
2564
2565 This is useful for Arabic, Hebrew and many other languages where one
2566 may have combining characters overtop of base characters, and want
2567 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002568 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569
2570 *'dictionary'* *'dict'*
2571'dictionary' 'dict' string (default "")
2572 global or local to buffer |global-local|
2573 {not in Vi}
2574 List of file names, separated by commas, that are used to lookup words
2575 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2576 contain a list of words. This can be one word per line, or several
2577 words per line, separated by non-keyword characters (white space is
2578 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002579
2580 When this option is empty or an entry "spell" is present, and spell
2581 checking is enabled, words in the word lists for the currently active
2582 'spelllang' are used. See |spell|.
2583
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002584 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585 after a comma are ignored, otherwise spaces are included in the file
2586 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002587 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 Where to find a list of words?
2589 - On FreeBSD, there is the file "/usr/share/dict/words".
2590 - In the Simtel archive, look in the "msdos/linguist" directory.
2591 - In "miscfiles" of the GNU collection.
2592 The use of |:set+=| and |:set-=| is preferred when adding or removing
2593 directories from the list. This avoids problems when a future version
2594 uses another default.
2595 Backticks cannot be used in this option for security reasons.
2596
2597 *'diff'* *'nodiff'*
2598'diff' boolean (default off)
2599 local to window
2600 {not in Vi}
2601 {not available when compiled without the |+diff|
2602 feature}
2603 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002604 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605
2606 *'dex'* *'diffexpr'*
2607'diffexpr' 'dex' string (default "")
2608 global
2609 {not in Vi}
2610 {not available when compiled without the |+diff|
2611 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002612 Expression which is evaluated to obtain a diff file (either ed-style
2613 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 This option cannot be set from a |modeline| or in the |sandbox|, for
2615 security reasons.
2616
2617 *'dip'* *'diffopt'*
2618'diffopt' 'dip' string (default "filler")
2619 global
2620 {not in Vi}
2621 {not available when compiled without the |+diff|
2622 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002623 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 All are optional. Items must be separated by a comma.
2625
2626 filler Show filler lines, to keep the text
2627 synchronized with a window that has inserted
2628 lines at the same position. Mostly useful
2629 when windows are side-by-side and 'scrollbind'
2630 is set.
2631
2632 context:{n} Use a context of {n} lines between a change
2633 and a fold that contains unchanged lines.
2634 When omitted a context of six lines is used.
2635 See |fold-diff|.
2636
2637 icase Ignore changes in case of text. "a" and "A"
2638 are considered the same. Adds the "-i" flag
2639 to the "diff" command if 'diffexpr' is empty.
2640
2641 iwhite Ignore changes in amount of white space. Adds
2642 the "-b" flag to the "diff" command if
2643 'diffexpr' is empty. Check the documentation
2644 of the "diff" command for what this does
2645 exactly. It should ignore adding trailing
2646 white space, but not leading white space.
2647
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002648 horizontal Start diff mode with horizontal splits (unless
2649 explicitly specified otherwise).
2650
2651 vertical Start diff mode with vertical splits (unless
2652 explicitly specified otherwise).
2653
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002654 hiddenoff Do not use diff mode for a buffer when it
2655 becomes hidden.
2656
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002657 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2658 starting diff mode. Without this 2 is used.
2659
Bram Moolenaare828b762018-09-10 17:51:58 +02002660 internal Use the internal diff library. This is
2661 ignored when 'diffexpr' is set. *E960*
2662 When running out of memory when writing a
2663 buffer this item will be ignored for diffs
2664 involving that buffer. Set the 'verbose'
2665 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002666
Bram Moolenaare828b762018-09-10 17:51:58 +02002667 indent-heuristic
2668 Use the indent heuristic for the internal
2669 diff library.
2670
2671 algorithm:{text} Use the specified diff algorithm with the
2672 internal diff engine. Currently supported
2673 algorithms are:
2674 myers the default algorithm
2675 minimal spend extra time to generate the
2676 smallest possible diff
2677 patience patience diff algorithm
2678 histogram histogram diff algorithm
2679
2680 Examples: >
2681 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002683 :set diffopt=internal,filler,foldcolumn:3
2684 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685<
2686 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2687'digraph' 'dg' boolean (default off)
2688 global
2689 {not in Vi}
2690 {not available when compiled without the |+digraphs|
2691 feature}
2692 Enable the entering of digraphs in Insert mode with {char1} <BS>
2693 {char2}. See |digraphs|.
2694 NOTE: This option is reset when 'compatible' is set.
2695
2696 *'directory'* *'dir'*
2697'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002698 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002699 for Unix: ".,~/tmp,/var/tmp,/tmp")
2700 global
2701 List of directory names for the swap file, separated with commas.
2702 - The swap file will be created in the first directory where this is
2703 possible.
2704 - Empty means that no swap file will be used (recovery is
2705 impossible!).
2706 - A directory "." means to put the swap file in the same directory as
2707 the edited file. On Unix, a dot is prepended to the file name, so
2708 it doesn't show in a directory listing. On MS-Windows the "hidden"
2709 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002710 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 put the swap file relative to where the edited file is. The leading
2712 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002713 - For Unix and Win32, if a directory ends in two path separators "//",
2714 the swap file name will be built from the complete path to the file
2715 with all path separators substituted to percent '%' signs. This will
2716 ensure file name uniqueness in the preserve directory.
2717 On Win32, it is also possible to end with "\\". However, When a
2718 separating comma is following, you must use "//", since "\\" will
2719 include the comma in the file name. Therefore it is recommended to
2720 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721 - Spaces after the comma are ignored, other spaces are considered part
2722 of the directory name. To have a space at the start of a directory
2723 name, precede it with a backslash.
2724 - To include a comma in a directory name precede it with a backslash.
2725 - A directory name may end in an ':' or '/'.
2726 - Environment variables are expanded |:set_env|.
2727 - Careful with '\' characters, type one before a space, type two to
2728 get one in the option (see |option-backslash|), for example: >
2729 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2730< - For backwards compatibility with Vim version 3.0 a '>' at the start
2731 of the option is removed.
2732 Using "." first in the list is recommended. This means that editing
2733 the same file twice will result in a warning. Using "/tmp" on Unix is
2734 discouraged: When the system crashes you lose the swap file.
2735 "/var/tmp" is often not cleared when rebooting, thus is a better
2736 choice than "/tmp". But it can contain a lot of files, your swap
2737 files get lost in the crowd. That is why a "tmp" directory in your
2738 home directory is tried first.
2739 The use of |:set+=| and |:set-=| is preferred when adding or removing
2740 directories from the list. This avoids problems when a future version
2741 uses another default.
2742 This option cannot be set from a |modeline| or in the |sandbox|, for
2743 security reasons.
2744 {Vi: directory to put temp file in, defaults to "/tmp"}
2745
2746 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002747'display' 'dy' string (default "", set to "truncate" in
2748 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 global
2750 {not in Vi}
2751 Change the way text is displayed. This is comma separated list of
2752 flags:
2753 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002754 in a window will be displayed. "@@@" is put in the
2755 last columns of the last screen line to indicate the
2756 rest of the line is not displayed.
2757 truncate Like "lastline", but "@@@" is displayed in the first
2758 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 uhex Show unprintable characters hexadecimal as <xx>
2760 instead of using ^C and ~C.
2761
Bram Moolenaard0796902016-09-16 20:02:31 +02002762 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002763 doesn't fit is replaced with "@" lines.
2764
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 *'eadirection'* *'ead'*
2766'eadirection' 'ead' string (default "both")
2767 global
2768 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002769 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 feature}
2771 Tells when the 'equalalways' option applies:
2772 ver vertically, width of windows is not affected
2773 hor horizontally, height of windows is not affected
2774 both width and height of windows is affected
2775
2776 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2777'edcompatible' 'ed' boolean (default off)
2778 global
2779 Makes the 'g' and 'c' flags of the ":substitute" command to be
2780 toggled each time the flag is given. See |complex-change|. See
2781 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002782 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783
Bram Moolenaar03413f42016-04-12 21:07:15 +02002784 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002785'emoji' 'emo' boolean (default: on)
2786 global
2787 {not in Vi}
2788 {only available when compiled with the |+multi_byte|
2789 feature}
2790 When on all Unicode emoji characters are considered to be full width.
2791
2792
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793 *'encoding'* *'enc'* *E543*
2794'encoding' 'enc' string (default: "latin1" or value from $LANG)
2795 global
2796 {only available when compiled with the |+multi_byte|
2797 feature}
2798 {not in Vi}
2799 Sets the character encoding used inside Vim. It applies to text in
2800 the buffers, registers, Strings in expressions, text stored in the
2801 viminfo file, etc. It sets the kind of characters which Vim can work
2802 with. See |encoding-names| for the possible values.
2803
2804 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002805 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002807 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808
Bram Moolenaar865242e2010-07-14 21:12:05 +02002809 This option cannot be set from a |modeline|. It would most likely
2810 corrupt the text.
2811
Bram Moolenaar3df01732017-02-17 22:47:16 +01002812 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2813 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814 'encoding', "utf-8" is the natural choice for the environment and
2815 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002816 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 versions, and to avoid changing the encoding of newly created files
2818 without your knowledge (in case 'fileencodings' is empty).
2819
2820 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002821 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 iconv() or as specified with 'charconvert'.
2823
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002824 If you need to know whether 'encoding' is a multi-byte encoding, you
2825 can use: >
2826 if has("multi_byte_encoding")
2827<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 Normally 'encoding' will be equal to your current locale. This will
2829 be the default if Vim recognizes your environment settings. If
2830 'encoding' is not set to the current locale, 'termencoding' must be
2831 set to convert typed and displayed text. See |encoding-table|.
2832
2833 When you set this option, it fires the |EncodingChanged| autocommand
2834 event so that you can set up fonts if necessary.
2835
2836 When the option is set, the value is converted to lowercase. Thus
2837 you can set it with uppercase values too. Underscores are translated
2838 to '-' signs.
2839 When the encoding is recognized, it is changed to the standard name.
2840 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2841 "iso-8859-2" and "utf8" becomes "utf-8".
2842
2843 Note: "latin1" is also used when the encoding could not be detected.
2844 This only works when editing files in the same encoding! When the
2845 actual character set is not latin1, make sure 'fileencoding' and
2846 'fileencodings' are empty. When conversion is needed, switch to using
2847 utf-8.
2848
2849 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2850 You don't notice this while editing, but it does matter for the
2851 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2852 setting 'encoding' to one of these values instead of utf-8 only has
2853 effect for encoding used for files when 'fileencoding' is empty.
2854
Bram Moolenaar661b1822005-07-28 22:36:45 +00002855 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2856 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857
2858 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2859'endofline' 'eol' boolean (default on)
2860 local to buffer
2861 {not in Vi}
2862 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002863 is on, or 'fixeol' option is off, no <EOL> will be written for the
2864 last line in the file. This option is automatically set or reset when
2865 starting to edit a new file, depending on whether file has an <EOL>
2866 for the last line in the file. Normally you don't have to set or
2867 reset this option.
2868 When 'binary' is off and 'fixeol' is on the value is not used when
2869 writing the file. When 'binary' is on or 'fixeol' is off it is used
2870 to remember the presence of a <EOL> for the last line in the file, so
2871 that when you write the file the situation from the original file can
2872 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873
2874 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2875'equalalways' 'ea' boolean (default on)
2876 global
2877 {not in Vi}
2878 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002879 splitting or closing a window. This also happens the moment the
2880 option is switched on. When off, splitting a window will reduce the
2881 size of the current window and leave the other windows the same. When
2882 closing a window the extra lines are given to the window next to it
2883 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884 When mixing vertically and horizontally split windows, a minimal size
2885 is computed and some windows may be larger if there is room. The
2886 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002887 Changing the height and width of a window can be avoided by setting
2888 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002889 If a window size is specified when creating a new window sizes are
2890 currently not equalized (it's complicated, but may be implemented in
2891 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892
2893 *'equalprg'* *'ep'*
2894'equalprg' 'ep' string (default "")
2895 global or local to buffer |global-local|
2896 {not in Vi}
2897 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002898 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002899 or 'indentexpr'. When Vim was compiled without internal formatting,
2900 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002901 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 about including spaces and backslashes.
2903 This option cannot be set from a |modeline| or in the |sandbox|, for
2904 security reasons.
2905
2906 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2907'errorbells' 'eb' boolean (default off)
2908 global
2909 Ring the bell (beep or screen flash) for error messages. This only
2910 makes a difference for error messages, the bell will be used always
2911 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002912 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002913 screen flash or do nothing. See 'belloff' to finetune when to ring the
2914 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915
2916 *'errorfile'* *'ef'*
2917'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2918 others: "errors.err")
2919 global
2920 {not in Vi}
2921 {not available when compiled without the |+quickfix|
2922 feature}
2923 Name of the errorfile for the QuickFix mode (see |:cf|).
2924 When the "-q" command-line argument is used, 'errorfile' is set to the
2925 following argument. See |-q|.
2926 NOT used for the ":make" command. See 'makeef' for that.
2927 Environment variables are expanded |:set_env|.
2928 See |option-backslash| about including spaces and backslashes.
2929 This option cannot be set from a |modeline| or in the |sandbox|, for
2930 security reasons.
2931
2932 *'errorformat'* *'efm'*
2933'errorformat' 'efm' string (default is very long)
2934 global or local to buffer |global-local|
2935 {not in Vi}
2936 {not available when compiled without the |+quickfix|
2937 feature}
2938 Scanf-like description of the format for the lines in the error file
2939 (see |errorformat|).
2940
2941 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2942'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2943 global
2944 {not in Vi}
2945 Function keys that start with an <Esc> are recognized in Insert
2946 mode. When this option is off, the cursor and function keys cannot be
2947 used in Insert mode if they start with an <Esc>. The advantage of
2948 this is that the single <Esc> is recognized immediately, instead of
2949 after one second. Instead of resetting this option, you might want to
2950 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2951 when 'esckeys' is off, you can still map anything, but the cursor keys
2952 won't work by default.
2953 NOTE: This option is set to the Vi default value when 'compatible' is
2954 set and to the Vim default value when 'compatible' is reset.
2955
2956 *'eventignore'* *'ei'*
2957'eventignore' 'ei' string (default "")
2958 global
2959 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002961 When set to "all" or when "all" is one of the items, all autocommand
2962 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 Otherwise this is a comma separated list of event names. Example: >
2964 :set ei=WinEnter,WinLeave
2965<
2966 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2967'expandtab' 'et' boolean (default off)
2968 local to buffer
2969 {not in Vi}
2970 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002971 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2973 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002974 This option is reset when the 'paste' option is set and restored when
2975 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 NOTE: This option is reset when 'compatible' is set.
2977
2978 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2979'exrc' 'ex' boolean (default off)
2980 global
2981 {not in Vi}
2982 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002983 directory.
2984
2985 Setting this option is a potential security leak. E.g., consider
2986 unpacking a package or fetching files from github, a .vimrc in there
2987 might be a trojan horse. BETTER NOT SET THIS OPTION!
2988 Instead, define an autocommand in your .vimrc to set options for a
2989 matching directory.
2990
2991 If you do switch this option on you should also consider setting the
2992 'secure' option (see |initialization|).
2993 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 This option cannot be set from a |modeline| or in the |sandbox|, for
2995 security reasons.
2996
2997 *'fileencoding'* *'fenc'* *E213*
2998'fileencoding' 'fenc' string (default: "")
2999 local to buffer
3000 {only available when compiled with the |+multi_byte|
3001 feature}
3002 {not in Vi}
3003 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003004
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003006 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 When 'fileencoding' is empty, the same value as 'encoding' will be
3008 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003009 No error will be given when the value is set, only when it is used,
3010 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003011 Conversion will also be done when 'encoding' and 'fileencoding' are
3012 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3013 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003015 'encoding' is "utf-8" or another Unicode encoding, conversion
3016 is most likely done in a way that the reverse conversion
3017 results in the same text. When 'encoding' is not "utf-8" some
3018 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003019
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 See 'encoding' for the possible values. Additionally, values may be
3021 specified that can be handled by the converter, see
3022 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003023
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 When reading a file 'fileencoding' will be set from 'fileencodings'.
3025 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003026 'fileencoding', use the |++enc| argument. One exception: when
3027 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003028 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003029
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3031 When the option is set, the value is converted to lowercase. Thus
3032 you can set it with uppercase values too. '_' characters are
3033 replaced with '-'. If a name is recognized from the list for
3034 'encoding', it is replaced by the standard name. For example
3035 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003036
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 When this option is set, after starting to edit a file, the 'modified'
3038 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003039
3040 Keep in mind that changing 'fenc' from a modeline happens
3041 AFTER the text has been read, thus it applies to when the file will be
3042 written. If you do set 'fenc' in a modeline, you might want to set
3043 'nomodified' to avoid not being able to ":q".
3044
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 This option can not be changed when 'modifiable' is off.
3046
3047 *'fe'*
3048 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003049 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050 old short name was 'fe', which is no longer used.
3051
3052 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003053'fileencodings' 'fencs' string (default: "ucs-bom",
3054 "ucs-bom,utf-8,default,latin1" when
3055 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 global
3057 {only available when compiled with the |+multi_byte|
3058 feature}
3059 {not in Vi}
3060 This is a list of character encodings considered when starting to edit
3061 an existing file. When a file is read, Vim tries to use the first
3062 mentioned character encoding. If an error is detected, the next one
3063 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003064 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003065 an empty string, which means the value of 'encoding' is used.
3066 WARNING: Conversion can cause loss of information! When
3067 'encoding' is "utf-8" (or one of the other Unicode variants)
3068 conversion is most likely done in a way that the reverse
3069 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003070 "utf-8" some non-ASCII characters may be lost! You can use
3071 the |++bad| argument to specify what is done with characters
3072 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 For an empty file or a file with only ASCII characters most encodings
3074 will work and the first entry of 'fileencodings' will be used (except
3075 "ucs-bom", which requires the BOM to be present). If you prefer
3076 another encoding use an BufReadPost autocommand event to test if your
3077 preferred encoding is to be used. Example: >
3078 au BufReadPost * if search('\S', 'w') == 0 |
3079 \ set fenc=iso-2022-jp | endif
3080< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3081 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003082 When the |++enc| argument is used then the value of 'fileencodings' is
3083 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003084 Note that 'fileencodings' is not used for a new file, the global value
3085 of 'fileencoding' is used instead. You can set it with: >
3086 :setglobal fenc=iso-8859-2
3087< This means that a non-existing file may get a different encoding than
3088 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 The special value "ucs-bom" can be used to check for a Unicode BOM
3090 (Byte Order Mark) at the start of the file. It must not be preceded
3091 by "utf-8" or another Unicode encoding for this to work properly.
3092 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3093 because Vim cannot detect an error, thus the encoding is always
3094 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003095 The special value "default" can be used for the encoding from the
3096 environment. This is the default value for 'encoding'. It is useful
3097 when 'encoding' is set to "utf-8" and your environment uses a
3098 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003099 When 'encoding' is "utf-8" and a file contains an illegal byte
3100 sequence it won't be recognized as UTF-8. You can use the |8g8|
3101 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 WRONG VALUES: WHAT'S WRONG:
3103 latin1,utf-8 "latin1" will always be used
3104 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3105 file
3106 cp1250,latin1 "cp1250" will always be used
3107 If 'fileencodings' is empty, 'fileencoding' is not modified.
3108 See 'fileencoding' for the possible values.
3109 Setting this option does not have an effect until the next time a file
3110 is read.
3111
3112 *'fileformat'* *'ff'*
3113'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3114 Unix default: "unix",
3115 Macintosh default: "mac")
3116 local to buffer
3117 {not in Vi}
3118 This gives the <EOL> of the current buffer, which is used for
3119 reading/writing the buffer from/to a file:
3120 dos <CR> <NL>
3121 unix <NL>
3122 mac <CR>
3123 When "dos" is used, CTRL-Z at the end of a file is ignored.
3124 See |file-formats| and |file-read|.
3125 For the character encoding of the file see 'fileencoding'.
3126 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003127 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 This option is set automatically when starting to edit a file and
3129 'fileformats' is not empty and 'binary' is off.
3130 When this option is set, after starting to edit a file, the 'modified'
3131 option is set, because the file would be different when written.
3132 This option can not be changed when 'modifiable' is off.
3133 For backwards compatibility: When this option is set to "dos",
3134 'textmode' is set, otherwise 'textmode' is reset.
3135
3136 *'fileformats'* *'ffs'*
3137'fileformats' 'ffs' string (default:
3138 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3139 Vim Unix: "unix,dos",
3140 Vim Mac: "mac,unix,dos",
3141 Vi Cygwin: "unix,dos",
3142 Vi others: "")
3143 global
3144 {not in Vi}
3145 This gives the end-of-line (<EOL>) formats that will be tried when
3146 starting to edit a new buffer and when reading a file into an existing
3147 buffer:
3148 - When empty, the format defined with 'fileformat' will be used
3149 always. It is not set automatically.
3150 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003151 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 'fileformats' name will be used when a file is read into an existing
3153 buffer, no matter what 'fileformat' for that buffer is set to.
3154 - When more than one name is present, separated by commas, automatic
3155 <EOL> detection will be done when reading a file. When starting to
3156 edit a file, a check is done for the <EOL>:
3157 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3158 'fileformat' is set to "dos".
3159 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003160 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003162 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3163 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003164 This means that "mac" is only chosen when:
3165 "unix" is not present or no <NL> is found in the file, and
3166 "dos" is not present or no <CR><NL> is found in the file.
3167 Except: if "unix" was chosen, but there is a <CR> before
3168 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003169 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 4. If 'fileformat' is still not set, the first name from
3171 'fileformats' is used.
3172 When reading a file into an existing buffer, the same is done, but
3173 this happens like 'fileformat' has been set appropriately for that
3174 file only, the option is not changed.
3175 When 'binary' is set, the value of 'fileformats' is not used.
3176
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003177 When Vim starts up with an empty buffer the first item is used. You
3178 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003179
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3181 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3182 done:
3183 - When 'fileformats' is empty, there is no automatic detection. Dos
3184 format will be used.
3185 - When 'fileformats' is set to one or more names, automatic detection
3186 is done. This is based on the first <NL> in the file: If there is a
3187 <CR> in front of it, Dos format is used, otherwise Unix format is
3188 used.
3189 Also see |file-formats|.
3190 For backwards compatibility: When this option is set to an empty
3191 string or one format (no comma is included), 'textauto' is reset,
3192 otherwise 'textauto' is set.
3193 NOTE: This option is set to the Vi default value when 'compatible' is
3194 set and to the Vim default value when 'compatible' is reset.
3195
Bram Moolenaarbf884932013-04-05 22:26:15 +02003196 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3197'fileignorecase' 'fic' boolean (default on for systems where case in file
3198 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003199 global
3200 {not in Vi}
3201 When set case is ignored when using file names and directories.
3202 See 'wildignorecase' for only ignoring case when doing completion.
3203
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 *'filetype'* *'ft'*
3205'filetype' 'ft' string (default: "")
3206 local to buffer
3207 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 When this option is set, the FileType autocommand event is triggered.
3209 All autocommands that match with the value of this option will be
3210 executed. Thus the value of 'filetype' is used in place of the file
3211 name.
3212 Otherwise this option does not always reflect the current file type.
3213 This option is normally set when the file type is detected. To enable
3214 this use the ":filetype on" command. |:filetype|
3215 Setting this option to a different value is most useful in a modeline,
3216 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003217 Example, for in an IDL file:
3218 /* vim: set filetype=idl : */ ~
3219 |FileType| |filetypes|
3220 When a dot appears in the value then this separates two filetype
3221 names. Example:
3222 /* vim: set filetype=c.doxygen : */ ~
3223 This will use the "c" filetype first, then the "doxygen" filetype.
3224 This works both for filetype plugins and for syntax files. More than
3225 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226 This option is not copied to another buffer, independent of the 's' or
3227 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003228 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229
3230 *'fillchars'* *'fcs'*
3231'fillchars' 'fcs' string (default "vert:|,fold:-")
3232 global
3233 {not in Vi}
3234 {not available when compiled without the |+windows|
3235 and |+folding| features}
3236 Characters to fill the statuslines and vertical separators.
3237 It is a comma separated list of items:
3238
3239 item default Used for ~
3240 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003241 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 vert:c '|' vertical separators |:vsplit|
3243 fold:c '-' filling 'foldtext'
3244 diff:c '-' deleted lines of the 'diff' option
3245
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003246 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003247 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 otherwise.
3249
3250 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003251 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252< This is similar to the default, except that these characters will also
3253 be used when there is highlighting.
3254
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003255 for "stl" and "stlnc" only single-byte values are supported.
3256
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 The highlighting used for these items:
3258 item highlight group ~
3259 stl:c StatusLine |hl-StatusLine|
3260 stlnc:c StatusLineNC |hl-StatusLineNC|
3261 vert:c VertSplit |hl-VertSplit|
3262 fold:c Folded |hl-Folded|
3263 diff:c DiffDelete |hl-DiffDelete|
3264
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003265 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3266'fixendofline' 'fixeol' boolean (default on)
3267 local to buffer
3268 {not in Vi}
3269 When writing a file and this option is on, <EOL> at the end of file
3270 will be restored if missing. Turn this option off if you want to
3271 preserve the situation from the original file.
3272 When the 'binary' option is set the value of this option doesn't
3273 matter.
3274 See the 'endofline' option.
3275
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3277'fkmap' 'fk' boolean (default off) *E198*
3278 global
3279 {not in Vi}
3280 {only available when compiled with the |+rightleft|
3281 feature}
3282 When on, the keyboard is mapped for the Farsi character set.
3283 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003284 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285
3286 *'foldclose'* *'fcl'*
3287'foldclose' 'fcl' string (default "")
3288 global
3289 {not in Vi}
3290 {not available when compiled without the |+folding|
3291 feature}
3292 When set to "all", a fold is closed when the cursor isn't in it and
3293 its level is higher than 'foldlevel'. Useful if you want folds to
3294 automatically close when moving out of them.
3295
3296 *'foldcolumn'* *'fdc'*
3297'foldcolumn' 'fdc' number (default 0)
3298 local to window
3299 {not in Vi}
3300 {not available when compiled without the |+folding|
3301 feature}
3302 When non-zero, a column with the specified width is shown at the side
3303 of the window which indicates open and closed folds. The maximum
3304 value is 12.
3305 See |folding|.
3306
3307 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3308'foldenable' 'fen' boolean (default on)
3309 local to window
3310 {not in Vi}
3311 {not available when compiled without the |+folding|
3312 feature}
3313 When off, all folds are open. This option can be used to quickly
3314 switch between showing all text unfolded and viewing the text with
3315 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003316 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 'foldenable' is off.
3318 This option is set by commands that create a new fold or close a fold.
3319 See |folding|.
3320
3321 *'foldexpr'* *'fde'*
3322'foldexpr' 'fde' string (default: "0")
3323 local to window
3324 {not in Vi}
3325 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003326 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003328 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003329
Bram Moolenaar30b65812012-07-12 22:01:11 +02003330 The expression will be evaluated in the |sandbox| if set from a
3331 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003332 This option can't be set from a |modeline| when the 'diff' option is
3333 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003334
3335 It is not allowed to change text or jump to another window while
3336 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337
3338 *'foldignore'* *'fdi'*
3339'foldignore' 'fdi' string (default: "#")
3340 local to window
3341 {not in Vi}
3342 {not available when compiled without the |+folding|
3343 feature}
3344 Used only when 'foldmethod' is "indent". Lines starting with
3345 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003346 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 The default "#" works well for C programs. See |fold-indent|.
3348
3349 *'foldlevel'* *'fdl'*
3350'foldlevel' 'fdl' number (default: 0)
3351 local to window
3352 {not in Vi}
3353 {not available when compiled without the |+folding|
3354 feature}
3355 Sets the fold level: Folds with a higher level will be closed.
3356 Setting this option to zero will close all folds. Higher numbers will
3357 close fewer folds.
3358 This option is set by commands like |zm|, |zM| and |zR|.
3359 See |fold-foldlevel|.
3360
3361 *'foldlevelstart'* *'fdls'*
3362'foldlevelstart' 'fdls' number (default: -1)
3363 global
3364 {not in Vi}
3365 {not available when compiled without the |+folding|
3366 feature}
3367 Sets 'foldlevel' when starting to edit another buffer in a window.
3368 Useful to always start editing with all folds closed (value zero),
3369 some folds closed (one) or no folds closed (99).
3370 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003371 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372 ignores this option and closes all folds.
3373 It is also done before BufReadPre autocommands, to allow an autocmd to
3374 overrule the 'foldlevel' value for specific files.
3375 When the value is negative, it is not used.
3376
3377 *'foldmarker'* *'fmr'* *E536*
3378'foldmarker' 'fmr' string (default: "{{{,}}}")
3379 local to window
3380 {not in Vi}
3381 {not available when compiled without the |+folding|
3382 feature}
3383 The start and end marker used when 'foldmethod' is "marker". There
3384 must be one comma, which separates the start and end marker. The
3385 marker is a literal string (a regular expression would be too slow).
3386 See |fold-marker|.
3387
3388 *'foldmethod'* *'fdm'*
3389'foldmethod' 'fdm' string (default: "manual")
3390 local to window
3391 {not in Vi}
3392 {not available when compiled without the |+folding|
3393 feature}
3394 The kind of folding used for the current window. Possible values:
3395 |fold-manual| manual Folds are created manually.
3396 |fold-indent| indent Lines with equal indent form a fold.
3397 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3398 |fold-marker| marker Markers are used to specify folds.
3399 |fold-syntax| syntax Syntax highlighting items specify folds.
3400 |fold-diff| diff Fold text that is not changed.
3401
3402 *'foldminlines'* *'fml'*
3403'foldminlines' 'fml' number (default: 1)
3404 local to window
3405 {not in Vi}
3406 {not available when compiled without the |+folding|
3407 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003408 Sets the number of screen lines above which a fold can be displayed
3409 closed. Also for manually closed folds. With the default value of
3410 one a fold can only be closed if it takes up two or more screen lines.
3411 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003412 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413 "zc" to close a fold, which is displayed open because it's smaller
3414 than 'foldminlines', a following "zc" may close a containing fold.
3415
3416 *'foldnestmax'* *'fdn'*
3417'foldnestmax' 'fdn' number (default: 20)
3418 local to window
3419 {not in Vi}
3420 {not available when compiled without the |+folding|
3421 feature}
3422 Sets the maximum nesting of folds for the "indent" and "syntax"
3423 methods. This avoids that too many folds will be created. Using more
3424 than 20 doesn't work, because the internal limit is 20.
3425
3426 *'foldopen'* *'fdo'*
3427'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3428 search,tag,undo")
3429 global
3430 {not in Vi}
3431 {not available when compiled without the |+folding|
3432 feature}
3433 Specifies for which type of commands folds will be opened, if the
3434 command moves the cursor into a closed fold. It is a comma separated
3435 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003436 NOTE: When the command is part of a mapping this option is not used.
3437 Add the |zv| command to the mapping to get the same effect.
3438 (rationale: the mapping may want to control opening folds itself)
3439
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 item commands ~
3441 all any
3442 block "(", "{", "[[", "[{", etc.
3443 hor horizontal movements: "l", "w", "fx", etc.
3444 insert any command in Insert mode
3445 jump far jumps: "G", "gg", etc.
3446 mark jumping to a mark: "'m", CTRL-O, etc.
3447 percent "%"
3448 quickfix ":cn", ":crew", ":make", etc.
3449 search search for a pattern: "/", "n", "*", "gd", etc.
3450 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003451 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 tag jumping to a tag: ":ta", CTRL-T, etc.
3453 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454 When a movement command is used for an operator (e.g., "dl" or "y%")
3455 this option is not used. This means the operator will include the
3456 whole closed fold.
3457 Note that vertical movements are not here, because it would make it
3458 very difficult to move onto a closed fold.
3459 In insert mode the folds containing the cursor will always be open
3460 when text is inserted.
3461 To close folds you can re-apply 'foldlevel' with the |zx| command or
3462 set the 'foldclose' option to "all".
3463
3464 *'foldtext'* *'fdt'*
3465'foldtext' 'fdt' string (default: "foldtext()")
3466 local to window
3467 {not in Vi}
3468 {not available when compiled without the |+folding|
3469 feature}
3470 An expression which is used to specify the text displayed for a closed
3471 fold. See |fold-foldtext|.
3472
Bram Moolenaar30b65812012-07-12 22:01:11 +02003473 The expression will be evaluated in the |sandbox| if set from a
3474 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003475
3476 It is not allowed to change text or jump to another window while
3477 evaluating 'foldtext' |textlock|.
3478
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003479 *'formatexpr'* *'fex'*
3480'formatexpr' 'fex' string (default "")
3481 local to buffer
3482 {not in Vi}
3483 {not available when compiled without the |+eval|
3484 feature}
3485 Expression which is evaluated to format a range of lines for the |gq|
3486 operator or automatic formatting (see 'formatoptions'). When this
3487 option is empty 'formatprg' is used.
3488
3489 The |v:lnum| variable holds the first line to be formatted.
3490 The |v:count| variable holds the number of lines to be formatted.
3491 The |v:char| variable holds the character that is going to be
3492 inserted if the expression is being evaluated due to
3493 automatic formatting. This can be empty. Don't insert
3494 it yet!
3495
3496 Example: >
3497 :set formatexpr=mylang#Format()
3498< This will invoke the mylang#Format() function in the
3499 autoload/mylang.vim file in 'runtimepath'. |autoload|
3500
3501 The expression is also evaluated when 'textwidth' is set and adding
3502 text beyond that limit. This happens under the same conditions as
3503 when internal formatting is used. Make sure the cursor is kept in the
3504 same spot relative to the text then! The |mode()| function will
3505 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003506
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003507 When the expression evaluates to non-zero Vim will fall back to using
3508 the internal format mechanism.
3509
3510 The expression will be evaluated in the |sandbox| when set from a
3511 modeline, see |sandbox-option|. That stops the option from working,
3512 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003513 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003514
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 *'formatoptions'* *'fo'*
3516'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3517 local to buffer
3518 {not in Vi}
3519 This is a sequence of letters which describes how automatic
3520 formatting is to be done. See |fo-table|. When the 'paste' option is
3521 on, no formatting is done (like 'formatoptions' is empty). Commas can
3522 be inserted for readability.
3523 To avoid problems with flags that are added in the future, use the
3524 "+=" and "-=" feature of ":set" |add-option-flags|.
3525 NOTE: This option is set to the Vi default value when 'compatible' is
3526 set and to the Vim default value when 'compatible' is reset.
3527
Bram Moolenaar86b68352004-12-27 21:59:20 +00003528 *'formatlistpat'* *'flp'*
3529'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3530 local to buffer
3531 {not in Vi}
3532 A pattern that is used to recognize a list header. This is used for
3533 the "n" flag in 'formatoptions'.
3534 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003535 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003536 while still checking more characters. There must be a character
3537 following the pattern, when it matches the whole line it is handled
3538 like there is no match.
3539 The default recognizes a number, followed by an optional punctuation
3540 character and white space.
3541
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 *'formatprg'* *'fp'*
3543'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003544 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 {not in Vi}
3546 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003547 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003549 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003550 If the 'formatexpr' option is not empty it will be used instead.
3551 Otherwise, if 'formatprg' option is an empty string, the internal
3552 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003553 Environment variables are expanded |:set_env|. See |option-backslash|
3554 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003555 This option cannot be set from a |modeline| or in the |sandbox|, for
3556 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557
Bram Moolenaard94464e2015-11-02 15:28:18 +01003558 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003559'fsync' 'fs' boolean (default on)
3560 global
3561 {not in Vi}
3562 When on, the library function fsync() will be called after writing a
3563 file. This will flush a file to disk, ensuring that it is safely
3564 written even on filesystems which do metadata-only journaling. This
3565 will force the harddrive to spin up on Linux systems running in laptop
3566 mode, so it may be undesirable in some situations. Be warned that
3567 turning this off increases the chances of data loss after a crash. On
3568 systems without an fsync() implementation, this variable is always
3569 off.
3570 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003571 'fsync' also applies to |writefile()|, unless a flag is used to
3572 overrule it.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003573
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3575'gdefault' 'gd' boolean (default off)
3576 global
3577 {not in Vi}
3578 When on, the ":substitute" flag 'g' is default on. This means that
3579 all matches in a line are substituted instead of one. When a 'g' flag
3580 is given to a ":substitute" command, this will toggle the substitution
3581 of all or one match. See |complex-change|.
3582
3583 command 'gdefault' on 'gdefault' off ~
3584 :s/// subst. all subst. one
3585 :s///g subst. one subst. all
3586 :s///gg subst. all subst. one
3587
3588 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003589 DEPRECATED: Setting this option may break plugins that are not aware
3590 of this option. Also, many users get confused that adding the /g flag
3591 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592
3593 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003594'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 global
3596 {not in Vi}
3597 Format to recognize for the ":grep" command output.
3598 This is a scanf-like string that uses the same format as the
3599 'errorformat' option: see |errorformat|.
3600
3601 *'grepprg'* *'gp'*
3602'grepprg' 'gp' string (default "grep -n ",
3603 Unix: "grep -n $* /dev/null",
3604 Win32: "findstr /n" or "grep -n",
3605 VMS: "SEARCH/NUMBERS ")
3606 global or local to buffer |global-local|
3607 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003608 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609 and '#' characters, which are expanded like when used in a command-
3610 line. The placeholder "$*" is allowed to specify where the arguments
3611 will be included. Environment variables are expanded |:set_env|. See
3612 |option-backslash| about including spaces and backslashes.
3613 When your "grep" accepts the "-H" argument, use this to make ":grep"
3614 also work well with a single file: >
3615 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003616< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003617 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3618 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003619 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620 apply equally to 'grepprg'.
3621 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3622 otherwise it's "grep -n".
3623 This option cannot be set from a |modeline| or in the |sandbox|, for
3624 security reasons.
3625
3626 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3627'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3628 ve:ver35-Cursor,
3629 o:hor50-Cursor,
3630 i-ci:ver25-Cursor/lCursor,
3631 r-cr:hor20-Cursor/lCursor,
3632 sm:block-Cursor
3633 -blinkwait175-blinkoff150-blinkon175",
3634 for MS-DOS and Win32 console:
3635 "n-v-c:block,o:hor50,i-ci:hor15,
3636 r-cr:hor30,sm:block")
3637 global
3638 {not in Vi}
3639 {only available when compiled with GUI enabled, and
3640 for MS-DOS and Win32 console}
3641 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003642 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643 the height of the cursor can be changed. This can be done by
3644 specifying a block cursor, or a percentage for a vertical or
3645 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003646 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3647 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003649 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 mode-list and an argument-list:
3651 mode-list:argument-list,mode-list:argument-list,..
3652 The mode-list is a dash separated list of these modes:
3653 n Normal mode
3654 v Visual mode
3655 ve Visual mode with 'selection' "exclusive" (same as 'v',
3656 if not specified)
3657 o Operator-pending mode
3658 i Insert mode
3659 r Replace mode
3660 c Command-line Normal (append) mode
3661 ci Command-line Insert mode
3662 cr Command-line Replace mode
3663 sm showmatch in Insert mode
3664 a all modes
3665 The argument-list is a dash separated list of these arguments:
3666 hor{N} horizontal bar, {N} percent of the character height
3667 ver{N} vertical bar, {N} percent of the character width
3668 block block cursor, fills the whole character
3669 [only one of the above three should be present]
3670 blinkwait{N} *cursor-blinking*
3671 blinkon{N}
3672 blinkoff{N}
3673 blink times for cursor: blinkwait is the delay before
3674 the cursor starts blinking, blinkon is the time that
3675 the cursor is shown and blinkoff is the time that the
3676 cursor is not shown. The times are in msec. When one
3677 of the numbers is zero, there is no blinking. The
3678 default is: "blinkwait700-blinkon400-blinkoff250".
3679 These numbers are used for a missing entry. This
3680 means that blinking is enabled by default. To switch
3681 blinking off you can use "blinkon0". The cursor only
3682 blinks when Vim is waiting for input, not while
3683 executing a command.
3684 To make the cursor blink in an xterm, see
3685 |xterm-blink|.
3686 {group-name}
3687 a highlight group name, that sets the color and font
3688 for the cursor
3689 {group-name}/{group-name}
3690 Two highlight group names, the first is used when
3691 no language mappings are used, the other when they
3692 are. |language-mapping|
3693
3694 Examples of parts:
3695 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3696 block cursor with colors from the "nCursor"
3697 highlight group
3698 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3699 In Insert and Command-line Insert mode, use a
3700 30% vertical bar cursor with colors from the
3701 "iCursor" highlight group. Blink a bit
3702 faster.
3703
3704 The 'a' mode is different. It will set the given argument-list for
3705 all modes. It does not reset anything to defaults. This can be used
3706 to do a common setting for all modes. For example, to switch off
3707 blinking: "a:blinkon0"
3708
3709 Examples of cursor highlighting: >
3710 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3711 :highlight Cursor gui=NONE guifg=bg guibg=fg
3712<
3713 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003714 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715'guifont' 'gfn' string (default "")
3716 global
3717 {not in Vi}
3718 {only available when compiled with GUI enabled}
3719 This is a list of fonts which will be used for the GUI version of Vim.
3720 In its simplest form the value is just one font name. When
3721 the font cannot be found you will get an error message. To try other
3722 font names a list can be specified, font names separated with commas.
3723 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003724
Bram Moolenaar05159a02005-02-26 23:04:13 +00003725 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3726 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003727
Bram Moolenaar3df01732017-02-17 22:47:16 +01003728 Note: As to the GTK GUIs, no error is given against any invalid names,
3729 and the first element of the list is always picked up and made use of.
3730 This is because, instead of identifying a given name with a font, the
3731 GTK GUIs use it to construct a pattern and try to look up a font which
3732 best matches the pattern among available fonts, and this way, the
3733 matching never fails. An invalid name doesn't matter because a number
3734 of font properties other than name will do to get the matching done.
3735
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736 Spaces after a comma are ignored. To include a comma in a font name
3737 precede it with a backslash. Setting an option requires an extra
3738 backslash before a space and a backslash. See also
3739 |option-backslash|. For example: >
3740 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003741< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003743
3744 If none of the fonts can be loaded, Vim will keep the current setting.
3745 If an empty font list is given, Vim will try using other resource
3746 settings (for X, it will use the Vim.font resource), and finally it
3747 will try some builtin default which should always be there ("7x13" in
3748 the case of X). The font names given should be "normal" fonts. Vim
3749 will try to find the related bold and italic fonts.
3750
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003751 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003752 :set guifont=*
3753< will bring up a font requester, where you can pick the font you want.
3754
3755 The font name depends on the GUI used. See |setting-guifont| for a
3756 way to set 'guifont' for various systems.
3757
Bram Moolenaar3df01732017-02-17 22:47:16 +01003758 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003760< That's all. XLFDs are not used. For Chinese this is reported to work
3761 well: >
3762 if has("gui_gtk2")
3763 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3764 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3765 endif
3766<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003767 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3768
Bram Moolenaar05159a02005-02-26 23:04:13 +00003769 For Mac OSX you can use something like this: >
3770 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003771< Also see 'macatsui', it can help fix display problems.
3772 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003774 width). An exception is GTK: all fonts are accepted, but mono-spaced
3775 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003776
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 To preview a font on X11, you might be able to use the "xfontsel"
3778 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003779
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 For the Win32 GUI *E244* *E245*
3781 - takes these options in the font name:
3782 hXX - height is XX (points, can be floating-point)
3783 wXX - width is XX (points, can be floating-point)
3784 b - bold
3785 i - italic
3786 u - underline
3787 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003788 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3790 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3791 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003792 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003793 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003794 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003795 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003796 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797
3798 Use a ':' to separate the options.
3799 - A '_' can be used in the place of a space, so you don't need to use
3800 backslashes to escape the spaces.
3801 - Examples: >
3802 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3803 :set guifont=Andale_Mono:h7.5:w4.5
3804< See also |font-sizes|.
3805
3806 *'guifontset'* *'gfs'*
3807 *E250* *E252* *E234* *E597* *E598*
3808'guifontset' 'gfs' string (default "")
3809 global
3810 {not in Vi}
3811 {only available when compiled with GUI enabled and
3812 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003813 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 When not empty, specifies two (or more) fonts to be used. The first
3815 one for normal English, the second one for your special language. See
3816 |xfontset|.
3817 Setting this option also means that all font names will be handled as
3818 a fontset name. Also the ones used for the "font" argument of the
3819 |:highlight| command.
3820 The fonts must match with the current locale. If fonts for the
3821 character sets that the current locale uses are not included, setting
3822 'guifontset' will fail.
3823 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3824 the comma-separated names are alternative names, one of which will be
3825 used. In 'guifontset' the whole string is one fontset name,
3826 including the commas. It is not possible to specify alternative
3827 fontset names.
3828 This example works on many X11 systems: >
3829 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3830<
3831 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3832'guifontwide' 'gfw' string (default "")
3833 global
3834 {not in Vi}
3835 {only available when compiled with GUI enabled}
3836 When not empty, specifies a comma-separated list of fonts to be used
3837 for double-width characters. The first font that can be loaded is
3838 used.
3839 Note: The size of these fonts must be exactly twice as wide as the one
3840 specified with 'guifont' and the same height.
3841
Bram Moolenaar3df01732017-02-17 22:47:16 +01003842 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843
3844 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3845 'guifontset' is empty or invalid.
3846 When 'guifont' is set and a valid font is found in it and
3847 'guifontwide' is empty Vim will attempt to find a matching
3848 double-width font and set 'guifontwide' to it.
3849
Bram Moolenaar3df01732017-02-17 22:47:16 +01003850 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851
3852 If set and valid, 'guifontwide' is always used for double width
3853 characters, even if 'encoding' is not set to "utf-8".
3854 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003855 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003856 font for characters not available in 'guifont'. Thus you do not need
3857 to set 'guifontwide' at all unless you want to override the choice
3858 made by Pango/Xft.
3859
Bram Moolenaar0f272122013-01-23 18:37:40 +01003860 Windows +multibyte only: *guifontwide_win_mbyte*
3861
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003862 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003863
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864 *'guiheadroom'* *'ghr'*
3865'guiheadroom' 'ghr' number (default 50)
3866 global
3867 {not in Vi} {only for GTK and X11 GUI}
3868 The number of pixels subtracted from the screen height when fitting
3869 the GUI window on the screen. Set this before the GUI is started,
3870 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003871 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 lines will be left for window decorations and other items on the
3873 screen. Set it to a negative value to allow windows taller than the
3874 screen.
3875
3876 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003877'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3878 removed in |defaults.vim|),
3879 "aegimrLtT" (GTK, Motif and Athena),
3880 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 global
3882 {not in Vi}
3883 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003884 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 sequence of letters which describes what components and options of the
3886 GUI should be used.
3887 To avoid problems with flags that are added in the future, use the
3888 "+=" and "-=" feature of ":set" |add-option-flags|.
3889
Bram Moolenaar13568252018-03-16 20:46:58 +01003890 Valid characters are as follows:
3891 *'go-!'*
3892 '!' External commands are executed in a terminal window. Without
3893 this flag the MS-Windows GUI will open a console window to
3894 execute the command. The Unix GUI will simulate a dumb
3895 terminal to list the command output.
3896 The terminal window will be positioned at the bottom, and grow
3897 upwards as needed.
Bram Moolenaar02467872007-05-06 13:22:01 +00003898 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 'a' Autoselect: If present, then whenever VISUAL mode is started,
3900 or the Visual area extended, Vim tries to become the owner of
3901 the windowing system's global selection. This means that the
3902 Visually highlighted text is available for pasting into other
3903 applications as well as into Vim itself. When the Visual mode
3904 ends, possibly due to an operation on the text, or when an
3905 application wants to paste the selection, the highlighted text
3906 is automatically yanked into the "* selection register.
3907 Thus the selection is still available for pasting into other
3908 applications after the VISUAL mode has ended.
3909 If not present, then Vim won't become the owner of the
3910 windowing system's global selection unless explicitly told to
3911 by a yank or delete operation for the "* register.
3912 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003913 *'go-P'*
3914 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003915 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003916 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003917 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 applies to the modeless selection.
3919
3920 'guioptions' autoselect Visual autoselect modeless ~
3921 "" - -
3922 "a" yes yes
3923 "A" - yes
3924 "aA" yes yes
3925
Bram Moolenaar02467872007-05-06 13:22:01 +00003926 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 'c' Use console dialogs instead of popup dialogs for simple
3928 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003929 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003930 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003931 'guitablabel' can be used to change the text in the labels.
3932 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003933 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003934 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003935 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 'f' Foreground: Don't use fork() to detach the GUI from the shell
3937 where it was started. Use this for programs that wait for the
3938 editor to finish (e.g., an e-mail program). Alternatively you
3939 can use "gvim -f" or ":gui -f" to start the GUI in the
3940 foreground. |gui-fork|
3941 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003942 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003943 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3945 corner of the window. It's black&white on non-GTK, because of
3946 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003947 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003949 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003950 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003952 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003954 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003955 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 'g' Grey menu items: Make menu items that are not active grey. If
3957 'g' is not included inactive menu items are not shown at all.
3958 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003959 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 't' Include tearoff menu items. Currently only works for Win32,
3961 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003962 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003963 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003964 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003965 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003967 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968 'R' Right-hand scrollbar is present when there is a vertically
3969 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003970 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003972 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 'L' Left-hand scrollbar is present when there is a vertically
3974 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003975 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3977 the longest visible line, or on the cursor line if the 'h'
3978 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003979 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 'h' Limit horizontal scrollbar size to the length of the cursor
3981 line. Reduces computations. |gui-horiz-scroll|
3982
3983 And yes, you may even have scrollbars on the left AND the right if
3984 you really want to :-). See |gui-scrollbars| for more information.
3985
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003986 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 'v' Use a vertical button layout for dialogs. When not included,
3988 a horizontal layout is preferred, but when it doesn't fit a
3989 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003990 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 'p' Use Pointer callbacks for X11 GUI. This is required for some
3992 window managers. If the cursor is not blinking or hollow at
3993 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003994 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003996 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003997 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003998 *'go-k'*
3999 'k' Keep the GUI window size when adding/removing a scrollbar, or
4000 toolbar, tabline, etc. Instead, the behavior is similar to
4001 when the window is maximized and will adjust 'lines' and
4002 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004003 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004004 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004005
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 *'guipty'* *'noguipty'*
4007'guipty' boolean (default on)
4008 global
4009 {not in Vi}
4010 {only available when compiled with GUI enabled}
4011 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4012 I/O to/from shell commands. See |gui-pty|.
4013
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004014 *'guitablabel'* *'gtl'*
4015'guitablabel' 'gtl' string (default empty)
4016 global
4017 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004018 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02004019 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004020 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004021 pages line. When empty and when the result is empty Vim will use a
4022 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004023
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004024 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004025 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004026 The expression will be evaluated in the |sandbox| when set from a
4027 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004028
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004029 Only used when the GUI tab pages line is displayed. 'e' must be
4030 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4031 used.
4032
Bram Moolenaar57657d82006-04-21 22:12:41 +00004033 *'guitabtooltip'* *'gtt'*
4034'guitabtooltip' 'gtt' string (default empty)
4035 global
4036 {not in Vi}
4037 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02004038 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004039 When nonempty describes the text to use in a tooltip for the GUI tab
4040 pages line. When empty Vim will use a default tooltip.
4041 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004042 You can include a line break. Simplest method is to use |:let|: >
4043 :let &guitabtooltip = "line one\nline two"
4044<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004045
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 *'helpfile'* *'hf'*
4047'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
4048 (others) "$VIMRUNTIME/doc/help.txt")
4049 global
4050 {not in Vi}
4051 Name of the main help file. All distributed help files should be
4052 placed together in one directory. Additionally, all "doc" directories
4053 in 'runtimepath' will be used.
4054 Environment variables are expanded |:set_env|. For example:
4055 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004056 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 spaces and backslashes.
4058 This option cannot be set from a |modeline| or in the |sandbox|, for
4059 security reasons.
4060
4061 *'helpheight'* *'hh'*
4062'helpheight' 'hh' number (default 20)
4063 global
4064 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004065 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 feature}
4067 Minimal initial height of the help window when it is opened with the
4068 ":help" command. The initial height of the help window is half of the
4069 current window, or (when the 'ea' option is on) the same as other
4070 windows. When the height is less than 'helpheight', the height is
4071 set to 'helpheight'. Set to zero to disable.
4072
4073 *'helplang'* *'hlg'*
4074'helplang' 'hlg' string (default: messages language or empty)
4075 global
4076 {only available when compiled with the |+multi_lang|
4077 feature}
4078 {not in Vi}
4079 Comma separated list of languages. Vim will use the first language
4080 for which the desired help can be found. The English help will always
4081 be used as a last resort. You can add "en" to prefer English over
4082 another language, but that will only find tags that exist in that
4083 language and not in the English help.
4084 Example: >
4085 :set helplang=de,it
4086< This will first search German, then Italian and finally English help
4087 files.
4088 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4089 try to find the tag in the current language before using this option.
4090 See |help-translated|.
4091
4092 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4093'hidden' 'hid' boolean (default off)
4094 global
4095 {not in Vi}
4096 When off a buffer is unloaded when it is |abandon|ed. When on a
4097 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4098 displayed in another window, it does not become hidden, of course.
4099 The commands that move through the buffer list sometimes make a buffer
4100 hidden although the 'hidden' option is off: When the buffer is
4101 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004102 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004103 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 This option is set for one command with ":hide {command}" |:hide|.
4105 WARNING: It's easy to forget that you have changes in hidden buffers.
4106 Think twice when using ":q!" or ":qa!".
4107
4108 *'highlight'* *'hl'*
4109'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004110 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4111 d:Directory,e:ErrorMsg,i:IncSearch,
4112 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4113 N:CursorLineNr,r:Question,s:StatusLine,
4114 S:StatusLineNC,c:VertSplit,t:Title,
4115 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
4116 F:FoldColumn,A:DiffAdd,C:DiffChange,
4117 D:DiffDelete,T:DiffText,>:SignColumn,
4118 B:SpellBad,P:SpellCap,R:SpellRare,
4119 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004120 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4121 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004122 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004123 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 global
4125 {not in Vi}
4126 This option can be used to set highlighting mode for various
4127 occasions. It is a comma separated list of character pairs. The
4128 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004129 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004131 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4132 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 characters from 'showbreak'
4134 |hl-Directory| d directories in CTRL-D listing and other special
4135 things in listings
4136 |hl-ErrorMsg| e error messages
4137 h (obsolete, ignored)
4138 |hl-IncSearch| i 'incsearch' highlighting
4139 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4140 |hl-MoreMsg| m |more-prompt|
4141 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004142 |hl-LineNr| n line number for ":number" and ":#" commands, and
4143 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004144 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4145 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 |hl-Question| r |hit-enter| prompt and yes/no questions
4147 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004148 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4150 |hl-VertSplit| c column used to separate vertically split windows
4151 |hl-Visual| v Visual mode
4152 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4153 Selection" Only X11 Gui's |gui-x11| and
4154 |xterm-clipboard|.
4155 |hl-WarningMsg| w warning messages
4156 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4157 |hl-Folded| f line used for closed folds
4158 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004159 |hl-DiffAdd| A added line in diff mode
4160 |hl-DiffChange| C changed line in diff mode
4161 |hl-DiffDelete| D deleted line in diff mode
4162 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004164 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004165 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004166 |hl-SpellRare| R rare word |spell|
4167 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004168 |hl-Conceal| - the placeholders used for concealed characters
4169 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004170 |hl-Pmenu| + popup menu normal line
4171 |hl-PmenuSel| = popup menu normal line
4172 |hl-PmenuSbar| x popup menu scrollbar
4173 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174
4175 The display modes are:
4176 r reverse (termcap entry "mr" and "me")
4177 i italic (termcap entry "ZH" and "ZR")
4178 b bold (termcap entry "md" and "me")
4179 s standout (termcap entry "so" and "se")
4180 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004181 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004182 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 n no highlighting
4184 - no highlighting
4185 : use a highlight group
4186 The default is used for occasions that are not included.
4187 If you want to change what the display modes do, see |dos-colors|
4188 for an example.
4189 When using the ':' display mode, this must be followed by the name of
4190 a highlight group. A highlight group can be used to define any type
4191 of highlighting, including using color. See |:highlight| on how to
4192 define one. The default uses a different group for each occasion.
4193 See |highlight-default| for the default highlight groups.
4194
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004196'history' 'hi' number (Vim default: 50, Vi default: 0,
4197 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 global
4199 {not in Vi}
4200 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004201 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004203 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 NOTE: This option is set to the Vi default value when 'compatible' is
4205 set and to the Vim default value when 'compatible' is reset.
4206
4207 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4208'hkmap' 'hk' boolean (default off)
4209 global
4210 {not in Vi}
4211 {only available when compiled with the |+rightleft|
4212 feature}
4213 When on, the keyboard is mapped for the Hebrew character set.
4214 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4215 toggle this option. See |rileft.txt|.
4216 NOTE: This option is reset when 'compatible' is set.
4217
4218 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4219'hkmapp' 'hkp' boolean (default off)
4220 global
4221 {not in Vi}
4222 {only available when compiled with the |+rightleft|
4223 feature}
4224 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4225 This is useful if you have a non-Hebrew keyboard.
4226 See |rileft.txt|.
4227 NOTE: This option is reset when 'compatible' is set.
4228
Bram Moolenaar036986f2017-03-16 17:41:02 +01004229 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4230'hlsearch' 'hls' boolean (default off)
4231 global
4232 {not in Vi}
4233 {not available when compiled without the
4234 |+extra_search| feature}
4235 When there is a previous search pattern, highlight all its matches.
4236 The type of highlighting used can be set with the 'l' occasion in the
4237 'highlight' option. This uses the "Search" highlight group by
4238 default. Note that only the matching text is highlighted, any offsets
4239 are not applied.
4240 See also: 'incsearch' and |:match|.
4241 When you get bored looking at the highlighted matches, you can turn it
4242 off with |:nohlsearch|. This does not change the option value, as
4243 soon as you use a search command, the highlighting comes back.
4244 'redrawtime' specifies the maximum time spent on finding matches.
4245 When the search pattern can match an end-of-line, Vim will try to
4246 highlight all of the matched text. However, this depends on where the
4247 search starts. This will be the first line in the window or the first
4248 line below a closed fold. A match in a previous line which is not
4249 drawn may not continue in a newly drawn line.
4250 You can specify whether the highlight status is restored on startup
4251 with the 'h' flag in 'viminfo' |viminfo-h|.
4252 NOTE: This option is reset when 'compatible' is set.
4253
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 *'icon'* *'noicon'*
4255'icon' boolean (default off, on when title can be restored)
4256 global
4257 {not in Vi}
4258 {not available when compiled without the |+title|
4259 feature}
4260 When on, the icon text of the window will be set to the value of
4261 'iconstring' (if it is not empty), or to the name of the file
4262 currently being edited. Only the last part of the name is used.
4263 Overridden by the 'iconstring' option.
4264 Only works if the terminal supports setting window icons (currently
4265 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4266 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4267 builtin termcap).
4268 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004269 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004271 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004272
4273 *'iconstring'*
4274'iconstring' string (default "")
4275 global
4276 {not in Vi}
4277 {not available when compiled without the |+title|
4278 feature}
4279 When this option is not empty, it will be used for the icon text of
4280 the window. This happens only when the 'icon' option is on.
4281 Only works if the terminal supports setting window icon text
4282 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4283 Does not work for MS Windows.
4284 When Vim was compiled with HAVE_X11 defined, the original icon will be
4285 restored if possible |X11|.
4286 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004287 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 'titlestring' for example settings.
4289 {not available when compiled without the |+statusline| feature}
4290
4291 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4292'ignorecase' 'ic' boolean (default off)
4293 global
4294 Ignore case in search patterns. Also used when searching in the tags
4295 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004296 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297 Can be overruled by using "\c" or "\C" in the pattern, see
4298 |/ignorecase|.
4299
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004300 *'imactivatefunc'* *'imaf'*
4301'imactivatefunc' 'imaf' string (default "")
4302 global
4303 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004304 {only available when compiled with the |+multi_byte|
4305 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004306 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004307 activate or deactivate the Input Method.
4308 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004309
4310 Example: >
4311 function ImActivateFunc(active)
4312 if a:active
4313 ... do something
4314 else
4315 ... do something
4316 endif
4317 " return value is not used
4318 endfunction
4319 set imactivatefunc=ImActivateFunc
4320<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 *'imactivatekey'* *'imak'*
4322'imactivatekey' 'imak' string (default "")
4323 global
4324 {not in Vi}
4325 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004326 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 Specifies the key that your Input Method in X-Windows uses for
4328 activation. When this is specified correctly, vim can fully control
4329 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4330 You can't use this option to change the activation key, the option
4331 tells Vim what the key is.
4332 Format:
4333 [MODIFIER_FLAG-]KEY_STRING
4334
4335 These characters can be used for MODIFIER_FLAG (case is ignored):
4336 S Shift key
4337 L Lock key
4338 C Control key
4339 1 Mod1 key
4340 2 Mod2 key
4341 3 Mod3 key
4342 4 Mod4 key
4343 5 Mod5 key
4344 Combinations are allowed, for example "S-C-space" or "SC-space" are
4345 both shift+ctrl+space.
4346 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4347
4348 Example: >
4349 :set imactivatekey=S-space
4350< "S-space" means shift+space. This is the activation key for kinput2 +
4351 canna (Japanese), and ami (Korean).
4352
4353 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4354'imcmdline' 'imc' boolean (default off)
4355 global
4356 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004357 {only available when compiled with the |+multi_byte|
4358 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359 When set the Input Method is always on when starting to edit a command
4360 line, unless entering a search pattern (see 'imsearch' for that).
4361 Setting this option is useful when your input method allows entering
4362 English characters directly, e.g., when it's used to type accented
4363 characters with dead keys.
4364
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004365 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4367 global
4368 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004369 {only available when compiled with the |+multi_byte|
4370 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371 When set the Input Method is never used. This is useful to disable
4372 the IM when it doesn't work properly.
4373 Currently this option is on by default for SGI/IRIX machines. This
4374 may change in later releases.
4375
4376 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004377'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378 local to buffer
4379 {not in Vi}
4380 Specifies whether :lmap or an Input Method (IM) is to be used in
4381 Insert mode. Valid values:
4382 0 :lmap is off and IM is off
4383 1 :lmap is ON and IM is off
4384 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385 To always reset the option to zero when leaving Insert mode with <Esc>
4386 this can be used: >
4387 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4388< This makes :lmap and IM turn off automatically when leaving Insert
4389 mode.
4390 Note that this option changes when using CTRL-^ in Insert mode
4391 |i_CTRL-^|.
4392 The value is set to 1 when setting 'keymap' to a valid keymap name.
4393 It is also used for the argument of commands like "r" and "f".
4394 The value 0 may not work correctly with Athena and Motif with some XIM
4395 methods. Use 'imdisable' to disable XIM then.
4396
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004397 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004398 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004399 |+multi_byte_ime| or |global-ime|.
4400
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004402'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403 local to buffer
4404 {not in Vi}
4405 Specifies whether :lmap or an Input Method (IM) is to be used when
4406 entering a search pattern. Valid values:
4407 -1 the value of 'iminsert' is used, makes it look like
4408 'iminsert' is also used when typing a search pattern
4409 0 :lmap is off and IM is off
4410 1 :lmap is ON and IM is off
4411 2 :lmap is off and IM is ON
4412 Note that this option changes when using CTRL-^ in Command-line mode
4413 |c_CTRL-^|.
4414 The value is set to 1 when it is not -1 and setting the 'keymap'
4415 option to a valid keymap name.
4416 The value 0 may not work correctly with Athena and Motif with some XIM
4417 methods. Use 'imdisable' to disable XIM then.
4418
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004419 *'imstatusfunc'* *'imsf'*
4420'imstatusfunc' 'imsf' string (default "")
4421 global
4422 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004423 {only available when compiled with the |+multi_byte|
4424 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004425 This option specifies a function that is called to obtain the status
4426 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004427 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004428
4429 Example: >
4430 function ImStatusFunc()
4431 let is_active = ...do something
4432 return is_active ? 1 : 0
4433 endfunction
4434 set imstatusfunc=ImStatusFunc
4435<
4436 NOTE: This function is invoked very often. Keep it fast.
4437
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004438 *'imstyle'* *'imst'*
4439'imstyle' 'imst' number (default 1)
4440 global
4441 {not in Vi}
4442 {only available when compiled with |+xim| and
4443 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004444 This option specifies the input style of Input Method:
4445 0 use on-the-spot style
4446 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004447 See: |xim-input-style|
4448
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004449 For a long time on-the-spot style had been used in the GTK version of
4450 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004451 |single-repeat|, etc. Therefore over-the-spot style becomes the
4452 default now. This should work fine for most people, however if you
4453 have any problem with it, try using on-the-spot style.
4454
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 *'include'* *'inc'*
4456'include' 'inc' string (default "^\s*#\s*include")
4457 global or local to buffer |global-local|
4458 {not in Vi}
4459 {not available when compiled without the
4460 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004461 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462 pattern, just like for the "/" command (See |pattern|). The default
4463 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004464 "]I", "[d", etc.
4465 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004466 comes after the matched pattern. But if "\zs" appears in the pattern
4467 then the text matched from "\zs" to the end, or until "\ze" if it
4468 appears, is used as the file name. Use this to include characters
4469 that are not in 'isfname', such as a space. You can then use
4470 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004471 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472
4473 *'includeexpr'* *'inex'*
4474'includeexpr' 'inex' string (default "")
4475 local to buffer
4476 {not in Vi}
4477 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004478 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004480 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481 :set includeexpr=substitute(v:fname,'\\.','/','g')
4482< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004483
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004485 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 Also used for |<cfile>|.
4487
Bram Moolenaar30b65812012-07-12 22:01:11 +02004488 The expression will be evaluated in the |sandbox| when set from a
4489 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004490
4491 It is not allowed to change text or jump to another window while
4492 evaluating 'includeexpr' |textlock|.
4493
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004495'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4496 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 global
4498 {not in Vi}
4499 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004500 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004501 While typing a search command, show where the pattern, as it was typed
4502 so far, matches. The matched string is highlighted. If the pattern
4503 is invalid or not found, nothing is shown. The screen will be updated
4504 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004505 Also applies to the pattern in commands: >
4506 :global
4507 :lvimgrep
4508 :lvimgrepadd
4509 :smagic
4510 :snomagic
4511 :sort
4512 :substitute
4513 :vglobal
4514 :vimgrep
4515 :vimgrepadd
4516< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004517 original position when no match is found and when pressing <Esc>. You
4518 still need to finish the search command with <Enter> to move the
4519 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004520 You can use the CTRL-G and CTRL-T keys to move to the next and
4521 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004522 When compiled with the |+reltime| feature Vim only searches for about
4523 half a second. With a complicated pattern and/or a lot of text the
4524 match may not be found. This is to avoid that Vim hangs while you
4525 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004526 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004527 When 'hlsearch' is on, all matched strings are highlighted too while
4528 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004529 If you don't want to turn 'hlsearch' on, but want to highlight all
4530 matches while searching, you can turn on and off 'hlsearch' with
4531 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004532 augroup vimrc-incsearch-highlight
4533 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004534 autocmd CmdlineEnter /,\? :set hlsearch
4535 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004536 augroup END
4537<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004538 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004539 to the command line. If 'ignorecase' and 'smartcase' are set and the
4540 command line has no uppercase characters, the added character is
4541 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004542 CTRL-R CTRL-W can be used to add the word at the end of the current
4543 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 NOTE: This option is reset when 'compatible' is set.
4545
4546 *'indentexpr'* *'inde'*
4547'indentexpr' 'inde' string (default "")
4548 local to buffer
4549 {not in Vi}
4550 {not available when compiled without the |+cindent|
4551 or |+eval| features}
4552 Expression which is evaluated to obtain the proper indent for a line.
4553 It is used when a new line is created, for the |=| operator and
4554 in Insert mode as specified with the 'indentkeys' option.
4555 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004556 'smartindent' indenting. When 'lisp' is set, this option is
4557 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 When 'paste' is set this option is not used for indenting.
4559 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004560 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 when the expression is evaluated (but it may be moved around).
4562 The expression must return the number of spaces worth of indent. It
4563 can return "-1" to keep the current indent (this means 'autoindent' is
4564 used for the indent).
4565 Functions useful for computing the indent are |indent()|, |cindent()|
4566 and |lispindent()|.
4567 The evaluation of the expression must not have side effects! It must
4568 not change the text, jump to another window, etc. Afterwards the
4569 cursor position is always restored, thus the cursor may be moved.
4570 Normally this option would be set to call a function: >
4571 :set indentexpr=GetMyIndent()
4572< Error messages will be suppressed, unless the 'debug' option contains
4573 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004574 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004575 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576
Bram Moolenaar30b65812012-07-12 22:01:11 +02004577 The expression will be evaluated in the |sandbox| when set from a
4578 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004579
4580 It is not allowed to change text or jump to another window while
4581 evaluating 'indentexpr' |textlock|.
4582
4583
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 *'indentkeys'* *'indk'*
4585'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4586 local to buffer
4587 {not in Vi}
4588 {not available when compiled without the |+cindent|
4589 feature}
4590 A list of keys that, when typed in Insert mode, cause reindenting of
4591 the current line. Only happens if 'indentexpr' isn't empty.
4592 The format is identical to 'cinkeys', see |indentkeys-format|.
4593 See |C-indenting| and |indent-expression|.
4594
4595 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4596'infercase' 'inf' boolean (default off)
4597 local to buffer
4598 {not in Vi}
4599 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004600 'ignorecase' is also on, the case of the match is adjusted depending
4601 on the typed text. If the typed text contains a lowercase letter
4602 where the match has an upper case letter, the completed part is made
4603 lowercase. If the typed text has no lowercase letters and the match
4604 has a lowercase letter where the typed text has an uppercase letter,
4605 and there is a letter before it, the completed part is made uppercase.
4606 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607
4608 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4609'insertmode' 'im' boolean (default off)
4610 global
4611 {not in Vi}
4612 Makes Vim work in a way that Insert mode is the default mode. Useful
4613 if you want to use Vim as a modeless editor. Used for |evim|.
4614 These Insert mode commands will be useful:
4615 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004616 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 this is a mapping, it is executed as if 'insertmode' was off.
4618 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004620 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4621 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622
4623 These items change when 'insertmode' is set:
4624 - when starting to edit of a file, Vim goes to Insert mode.
4625 - <Esc> in Insert mode is a no-op and beeps.
4626 - <Esc> in Normal mode makes Vim go to Insert mode.
4627 - CTRL-L in Insert mode is a command, it is not inserted.
4628 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4629 However, when <Esc> is used inside a mapping, it behaves like
4630 'insertmode' was not set. This was done to be able to use the same
4631 mappings with 'insertmode' set or not set.
4632 When executing commands with |:normal| 'insertmode' is not used.
4633
4634 NOTE: This option is reset when 'compatible' is set.
4635
4636 *'isfname'* *'isf'*
4637'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4638 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4639 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4640 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4641 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4642 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4643 global
4644 {not in Vi}
4645 The characters specified by this option are included in file names and
4646 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004647 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 Multi-byte characters 256 and above are always included, only the
4649 characters up to 255 are specified with this option.
4650 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004651 Think twice before adding white space to this option. Although a
4652 space may appear inside a file name, the effect will be that Vim
4653 doesn't know where a file name starts or ends when doing completion.
4654 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655
4656 Note that on systems using a backslash as path separator, Vim tries to
4657 do its best to make it work as you would expect. That is a bit
4658 tricky, since Vi originally used the backslash to escape special
4659 characters. Vim will not remove a backslash in front of a normal file
4660 name character on these systems, but it will on Unix and alikes. The
4661 '&' and '^' are not included by default, because these are special for
4662 cmd.exe.
4663
4664 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004665 Each part can be a single character number or a range. A range is two
4666 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667 decimal number between 0 and 255 or the ASCII character itself (does
4668 not work for digits). Example:
4669 "_,-,128-140,#-43" (include '_' and '-' and the range
4670 128 to 140 and '#' to 43)
4671 If a part starts with '^', the following character number or range
4672 will be excluded from the option. The option is interpreted from left
4673 to right. Put the excluded character after the range where it is
4674 included. To include '^' itself use it as the last character of the
4675 option or the end of a range. Example:
4676 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4677 If the character is '@', all characters where isalpha() returns TRUE
4678 are included. Normally these are the characters a to z and A to Z,
4679 plus accented characters. To include '@' itself use "@-@". Examples:
4680 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004681 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 "a-z,A-Z,@-@" All letters plus the '@' character.
4683 A comma can be included by using it where a character number is
4684 expected. Example:
4685 "48-57,,,_" Digits, comma and underscore.
4686 A comma can be excluded by prepending a '^'. Example:
4687 " -~,^,,9" All characters from space to '~', excluding
4688 comma, plus <Tab>.
4689 See |option-backslash| about including spaces and backslashes.
4690
4691 *'isident'* *'isi'*
4692'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4693 "@,48-57,_,128-167,224-235"
4694 otherwise: "@,48-57,_,192-255")
4695 global
4696 {not in Vi}
4697 The characters given by this option are included in identifiers.
4698 Identifiers are used in recognizing environment variables and after a
4699 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004700 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 option.
4702 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004703 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4705
4706 *'iskeyword'* *'isk'*
4707'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4708 "@,48-57,_,128-167,224-235"
4709 otherwise: "@,48-57,_,192-255"
4710 Vi default: "@,48-57,_")
4711 local to buffer
4712 {not in Vi}
4713 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004714 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 'isfname' for a description of the format of this option. For C
4716 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4717 For a help file it is set to all non-blank printable characters except
4718 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4719 command).
4720 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004721 This option also influences syntax highlighting, unless the syntax
4722 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 NOTE: This option is set to the Vi default value when 'compatible' is
4724 set and to the Vim default value when 'compatible' is reset.
4725
4726 *'isprint'* *'isp'*
4727'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4728 "@,~-255"; otherwise: "@,161-255")
4729 global
4730 {not in Vi}
4731 The characters given by this option are displayed directly on the
4732 screen. It is also used for "\p" in a |pattern|. The characters from
4733 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4734 even when they are not included in 'isprint' or excluded. See
4735 'isfname' for a description of the format of this option.
4736
4737 Non-printable characters are displayed with two characters:
4738 0 - 31 "^@" - "^_"
4739 32 - 126 always single characters
4740 127 "^?"
4741 128 - 159 "~@" - "~_"
4742 160 - 254 "| " - "|~"
4743 255 "~?"
4744 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4745 displayed as <xx>, with the hexadecimal value of the byte.
4746 When 'display' contains "uhex" all unprintable characters are
4747 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004748 The SpecialKey highlighting will be used for unprintable characters.
4749 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750
4751 Multi-byte characters 256 and above are always included, only the
4752 characters up to 255 are specified with this option. When a character
4753 is printable but it is not available in the current font, a
4754 replacement character will be shown.
4755 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4756 There is no option to specify these characters.
4757
4758 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4759'joinspaces' 'js' boolean (default on)
4760 global
4761 {not in Vi}
4762 Insert two spaces after a '.', '?' and '!' with a join command.
4763 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4764 Otherwise only one space is inserted.
4765 NOTE: This option is set when 'compatible' is set.
4766
4767 *'key'*
4768'key' string (default "")
4769 local to buffer
4770 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004771 {only available when compiled with the |+cryptv|
4772 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004774 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 Careful: Do not set the key value by hand, someone might see the typed
4776 key. Use the |:X| command. But you can make 'key' empty: >
4777 :set key=
4778< It is not possible to get the value of this option with ":set key" or
4779 "echo &key". This is to avoid showing it to someone who shouldn't
4780 know. It also means you cannot see it yourself once you have set it,
4781 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004782 You can use "&key" in an expression to detect whether encryption is
4783 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784
4785 *'keymap'* *'kmp'* *E544*
4786'keymap' 'kmp' string (default "")
4787 local to buffer
4788 {not in Vi}
4789 {only available when compiled with the |+keymap|
4790 feature}
4791 Name of a keyboard mapping. See |mbyte-keymap|.
4792 Setting this option to a valid keymap name has the side effect of
4793 setting 'iminsert' to one, so that the keymap becomes effective.
4794 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004795 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796
4797 *'keymodel'* *'km'*
4798'keymodel' 'km' string (default "")
4799 global
4800 {not in Vi}
4801 List of comma separated words, which enable special things that keys
4802 can do. These values can be used:
4803 startsel Using a shifted special key starts selection (either
4804 Select mode or Visual mode, depending on "key" being
4805 present in 'selectmode').
4806 stopsel Using a not-shifted special key stops selection.
4807 Special keys in this context are the cursor keys, <End>, <Home>,
4808 <PageUp> and <PageDown>.
4809 The 'keymodel' option is set by the |:behave| command.
4810
4811 *'keywordprg'* *'kp'*
4812'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004813 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814 global or local to buffer |global-local|
4815 {not in Vi}
4816 Program to use for the |K| command. Environment variables are
4817 expanded |:set_env|. ":help" may be used to access the Vim internal
4818 help. (Note that previously setting the global option to the empty
4819 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004820 When the first character is ":", the command is invoked as a Vim
4821 Ex command prefixed with [count].
4822 When "man", "man -s" or an Ex command is used, Vim will automatically
4823 translate a count for the "K" command and pass it as the first
4824 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825 See |option-backslash| about including spaces and backslashes.
4826 Example: >
4827 :set keywordprg=man\ -s
4828< This option cannot be set from a |modeline| or in the |sandbox|, for
4829 security reasons.
4830
4831 *'langmap'* *'lmap'* *E357* *E358*
4832'langmap' 'lmap' string (default "")
4833 global
4834 {not in Vi}
4835 {only available when compiled with the |+langmap|
4836 feature}
4837 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004838 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004839 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 care of translating these special characters to the original meaning
4841 of the key. This means you don't have to change the keyboard mode to
4842 be able to execute Normal mode commands.
4843 This is the opposite of the 'keymap' option, where characters are
4844 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004845 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004846 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004847 This option cannot be set from a |modeline| or in the |sandbox|, for
4848 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004850 Example (for Greek, in UTF-8): *greek* >
4851 :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 +00004852< Example (exchanges meaning of z and y for commands): >
4853 :set langmap=zy,yz,ZY,YZ
4854<
4855 The 'langmap' option is a list of parts, separated with commas. Each
4856 part can be in one of two forms:
4857 1. A list of pairs. Each pair is a "from" character immediately
4858 followed by the "to" character. Examples: "aA", "aAbBcC".
4859 2. A list of "from" characters, a semi-colon and a list of "to"
4860 characters. Example: "abc;ABC"
4861 Example: "aA,fgh;FGH,cCdDeE"
4862 Special characters need to be preceded with a backslash. These are
4863 ";", ',' and backslash itself.
4864
4865 This will allow you to activate vim actions without having to switch
4866 back and forth between the languages. Your language characters will
4867 be understood as normal vim English characters (according to the
4868 langmap mappings) in the following cases:
4869 o Normal/Visual mode (commands, buffer/register names, user mappings)
4870 o Insert/Replace Mode: Register names after CTRL-R
4871 o Insert/Replace Mode: Mappings
4872 Characters entered in Command-line mode will NOT be affected by
4873 this option. Note that this option can be changed at any time
4874 allowing to switch between mappings for different languages/encodings.
4875 Use a mapping to avoid having to type it each time!
4876
4877 *'langmenu'* *'lm'*
4878'langmenu' 'lm' string (default "")
4879 global
4880 {not in Vi}
4881 {only available when compiled with the |+menu| and
4882 |+multi_lang| features}
4883 Language to use for menu translation. Tells which file is loaded
4884 from the "lang" directory in 'runtimepath': >
4885 "lang/menu_" . &langmenu . ".vim"
4886< (without the spaces). For example, to always use the Dutch menus, no
4887 matter what $LANG is set to: >
4888 :set langmenu=nl_NL.ISO_8859-1
4889< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004890 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 If your $LANG is set to a non-English language but you do want to use
4892 the English menus: >
4893 :set langmenu=none
4894< This option must be set before loading menus, switching on filetype
4895 detection or syntax highlighting. Once the menus are defined setting
4896 this option has no effect. But you could do this: >
4897 :source $VIMRUNTIME/delmenu.vim
4898 :set langmenu=de_DE.ISO_8859-1
4899 :source $VIMRUNTIME/menu.vim
4900< Warning: This deletes all menus that you defined yourself!
4901
Bram Moolenaard94464e2015-11-02 15:28:18 +01004902 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004903'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004904 global
4905 {not in Vi}
4906 {only available when compiled with the |+langmap|
4907 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004908 This is just like 'langremap' but with the value inverted. It only
4909 exists for backwards compatibility. When setting 'langremap' then
4910 'langnoremap' is set to the inverted value, and the other way around.
4911
4912 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4913'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4914 global
4915 {not in Vi}
4916 {only available when compiled with the |+langmap|
4917 feature}
4918 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004919 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004920 'langmap' disables some of your mappings, try resetting this option.
4921 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004922 that works for you to avoid mappings to break.
4923
Bram Moolenaar071d4272004-06-13 20:20:40 +00004924 *'laststatus'* *'ls'*
4925'laststatus' 'ls' number (default 1)
4926 global
4927 {not in Vi}
4928 The value of this option influences when the last window will have a
4929 status line:
4930 0: never
4931 1: only if there are at least two windows
4932 2: always
4933 The screen looks nicer with a status line if you have several
4934 windows, but it takes another screen line. |status-line|
4935
4936 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4937'lazyredraw' 'lz' boolean (default off)
4938 global
4939 {not in Vi}
4940 When this option is set, the screen will not be redrawn while
4941 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004942 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943 update use |:redraw|.
4944
4945 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4946'linebreak' 'lbr' boolean (default off)
4947 local to window
4948 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004949 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004951 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004952 than at the last character that fits on the screen. Unlike
4953 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004954 it only affects the way the file is displayed, not its contents.
4955 If 'breakindent' is set, line is visually indented. Then, the value
4956 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004957 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 Note that <Tab> characters after an <EOL> are mostly not displayed
4959 with the right amount of white space.
4960
4961 *'lines'* *E593*
4962'lines' number (default 24 or terminal height)
4963 global
4964 Number of lines of the Vim window.
4965 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004966 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 When Vim is running in the GUI or in a resizable window, setting this
4968 option will cause the window size to be changed. When you only want
4969 to use the size for the GUI, put the command in your |gvimrc| file.
4970 Vim limits the number of lines to what fits on the screen. You can
4971 use this command to get the tallest window possible: >
4972 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004973< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004974 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 When you set this option and Vim is unable to change the physical
4976 number of lines of the display, the display may be messed up.
4977
4978 *'linespace'* *'lsp'*
4979'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4980 global
4981 {not in Vi}
4982 {only in the GUI}
4983 Number of pixel lines inserted between characters. Useful if the font
4984 uses the full character cell height, making lines touch each other.
4985 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004986 With some fonts there can be too much room between lines (to have
4987 space for ascents and descents). Then it makes sense to set
4988 'linespace' to a negative value. This may cause display problems
4989 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990
4991 *'lisp'* *'nolisp'*
4992'lisp' boolean (default off)
4993 local to buffer
4994 {not available when compiled without the |+lispindent|
4995 feature}
4996 Lisp mode: When <Enter> is typed in insert mode set the indent for
4997 the next line to Lisp standards (well, sort of). Also happens with
4998 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4999 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5000 better. Also see 'lispwords'.
5001 The '-' character is included in keyword characters. Redefines the
5002 "=" operator to use this same indentation algorithm rather than
5003 calling an external program if 'equalprg' is empty.
5004 This option is not used when 'paste' is set.
5005 {Vi: Does it a little bit differently}
5006
5007 *'lispwords'* *'lw'*
5008'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005009 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005010 {not in Vi}
5011 {not available when compiled without the |+lispindent|
5012 feature}
5013 Comma separated list of words that influence the Lisp indenting.
5014 |'lisp'|
5015
5016 *'list'* *'nolist'*
5017'list' boolean (default off)
5018 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005019 List mode: Show tabs as CTRL-I is displayed, display $ after end of
5020 line. Useful to see the difference between tabs and spaces and for
5021 trailing blanks. Further changed by the 'listchars' option.
5022
5023 The cursor is displayed at the start of the space a Tab character
5024 occupies, not at the end as usual in Normal mode. To get this cursor
5025 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005026 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005027<
5028 Note that list mode will also affect formatting (set with 'textwidth'
5029 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005030 changing the way tabs are displayed.
5031
5032 *'listchars'* *'lcs'*
5033'listchars' 'lcs' string (default "eol:$")
5034 global
5035 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005036 Strings to use in 'list' mode and for the |:list| command. It is a
5037 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005038 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 eol:c Character to show at the end of each line. When
5040 omitted, there is no extra character at the end of the
5041 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005042 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00005043 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00005045 fill the space that the tab normally occupies.
5046 "tab:>-" will show a tab that takes four spaces as
5047 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005048 *lcs-space*
5049 space:c Character to show for a space. When omitted, spaces
5050 are left blank.
5051 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005052 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02005053 trailing spaces are blank. Overrides the "space"
5054 setting for trailing spaces.
5055 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 extends:c Character to show in the last column, when 'wrap' is
5057 off and the line continues beyond the right of the
5058 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005059 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 precedes:c Character to show in the first column, when 'wrap'
5061 is off and there is text preceding the character
5062 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005063 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005064 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005065 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005066 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005067 nbsp:c Character to show for a non-breakable space character
5068 (0xA0 (160 decimal) and U+202F). Left blank when
5069 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005071 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005073 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074
5075 Examples: >
5076 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005077 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005078 :set lcs=extends:>,precedes:<
5079< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02005080 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005081 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082
5083 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5084'loadplugins' 'lpl' boolean (default on)
5085 global
5086 {not in Vi}
5087 When on the plugin scripts are loaded when starting up |load-plugins|.
5088 This option can be reset in your |vimrc| file to disable the loading
5089 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005090 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5091 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092
Bram Moolenaard94464e2015-11-02 15:28:18 +01005093 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005094'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005095 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005096 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005097 {only available when compiled with the |+lua/dyn|
5098 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005099 Specifies the name of the Lua shared library. The default is
5100 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005101 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005102 This option cannot be set from a |modeline| or in the |sandbox|, for
5103 security reasons.
5104
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005105 *'macatsui'* *'nomacatsui'*
5106'macatsui' boolean (default on)
5107 global
5108 {only available in Mac GUI version}
5109 This is a workaround for when drawing doesn't work properly. When set
5110 and compiled with multi-byte support ATSUI text drawing is used. When
5111 not set ATSUI text drawing is not used. Switch this option off when
5112 you experience drawing problems. In a future version the problems may
5113 be solved and this option becomes obsolete. Therefore use this method
5114 to unset it: >
5115 if exists('&macatsui')
5116 set nomacatsui
5117 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00005118< Another option to check if you have drawing problems is
5119 'termencoding'.
5120
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121 *'magic'* *'nomagic'*
5122'magic' boolean (default on)
5123 global
5124 Changes the special characters that can be used in search patterns.
5125 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005126 WARNING: Switching this option off most likely breaks plugins! That
5127 is because many patterns assume it's on and will fail when it's off.
5128 Only switch it off when working with old Vi scripts. In any other
5129 situation write patterns that work when 'magic' is on. Include "\M"
5130 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005131
5132 *'makeef'* *'mef'*
5133'makeef' 'mef' string (default: "")
5134 global
5135 {not in Vi}
5136 {not available when compiled without the |+quickfix|
5137 feature}
5138 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5139 and the |:grep| command.
5140 When it is empty, an internally generated temp file will be used.
5141 When "##" is included, it is replaced by a number to make the name
5142 unique. This makes sure that the ":make" command doesn't overwrite an
5143 existing file.
5144 NOT used for the ":cf" command. See 'errorfile' for that.
5145 Environment variables are expanded |:set_env|.
5146 See |option-backslash| about including spaces and backslashes.
5147 This option cannot be set from a |modeline| or in the |sandbox|, for
5148 security reasons.
5149
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005150 *'makeencoding'* *'menc'*
5151'makeencoding' 'menc' string (default "")
5152 global or local to buffer |global-local|
5153 {only available when compiled with the |+multi_byte|
5154 feature}
5155 {not in Vi}
5156 Encoding used for reading the output of external commands. When empty,
5157 encoding is not converted.
5158 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5159 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5160 and `:laddfile`.
5161
5162 This would be mostly useful when you use MS-Windows and set 'encoding'
5163 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5164 'makeencoding' to "char" has the same effect as setting to the system
5165 locale encoding. Example: >
5166 :set encoding=utf-8
5167 :set makeencoding=char " system locale is used
5168<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 *'makeprg'* *'mp'*
5170'makeprg' 'mp' string (default "make", VMS: "MMS")
5171 global or local to buffer |global-local|
5172 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005173 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005174 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5175 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005176 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005177 Environment variables are expanded |:set_env|. See |option-backslash|
5178 about including spaces and backslashes.
5179 Note that a '|' must be escaped twice: once for ":set" and once for
5180 the interpretation of a command. When you use a filter called
5181 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 :set makeprg=gmake\ \\\|\ myfilter
5183< The placeholder "$*" can be given (even multiple times) to specify
5184 where the arguments will be included, for example: >
5185 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5186< This option cannot be set from a |modeline| or in the |sandbox|, for
5187 security reasons.
5188
5189 *'matchpairs'* *'mps'*
5190'matchpairs' 'mps' string (default "(:),{:},[:]")
5191 local to buffer
5192 {not in Vi}
5193 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005194 other.
5195 Only character pairs are allowed that are different, thus you cannot
5196 jump between two double quotes.
5197 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005198 The pairs must be separated by a comma. Example for including '<' and
5199 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 :set mps+=<:>
5201
5202< A more exotic example, to jump between the '=' and ';' in an
5203 assignment, useful for languages like C and Java: >
5204 :au FileType c,cpp,java set mps+==:;
5205
5206< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005207 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208
5209 *'matchtime'* *'mat'*
5210'matchtime' 'mat' number (default 5)
5211 global
5212 {not in Vi}{in Nvi}
5213 Tenths of a second to show the matching paren, when 'showmatch' is
5214 set. Note that this is not in milliseconds, like other options that
5215 set a time. This is to be compatible with Nvi.
5216
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005217 *'maxcombine'* *'mco'*
5218'maxcombine' 'mco' number (default 2)
5219 global
5220 {not in Vi}
5221 {only available when compiled with the |+multi_byte|
5222 feature}
5223 The maximum number of combining characters supported for displaying.
5224 Only used when 'encoding' is "utf-8".
5225 The default is OK for most languages. Hebrew may require 4.
5226 Maximum value is 6.
5227 Even when this option is set to 2 you can still edit text with more
5228 combining characters, you just can't see them. Use |g8| or |ga|.
5229 See |mbyte-combining|.
5230
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 *'maxfuncdepth'* *'mfd'*
5232'maxfuncdepth' 'mfd' number (default 100)
5233 global
5234 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005235 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005236 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 Maximum depth of function calls for user functions. This normally
5238 catches endless recursion. When using a recursive function with
5239 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5240 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005241 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005242 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243 See also |:function|.
5244
5245 *'maxmapdepth'* *'mmd'* *E223*
5246'maxmapdepth' 'mmd' number (default 1000)
5247 global
5248 {not in Vi}
5249 Maximum number of times a mapping is done without resulting in a
5250 character to be used. This normally catches endless mappings, like
5251 ":map x y" with ":map y x". It still does not catch ":map g wg",
5252 because the 'w' is used before the next mapping is done. See also
5253 |key-mapping|.
5254
5255 *'maxmem'* *'mm'*
5256'maxmem' 'mm' number (default between 256 to 5120 (system
5257 dependent) or half the amount of memory
5258 available)
5259 global
5260 {not in Vi}
5261 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5262 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005263 other memory to be freed.
5264 The maximum usable value is about 2000000. Use this to work without a
5265 limit.
5266 The value is ignored when 'swapfile' is off.
5267 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005269 *'maxmempattern'* *'mmp'*
5270'maxmempattern' 'mmp' number (default 1000)
5271 global
5272 {not in Vi}
5273 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005274 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005275 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005276 When Vim runs into the limit it gives an error message and mostly
5277 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005278 Running into the limit often means that the pattern is very
5279 inefficient or too complex. This may already happen with the pattern
5280 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005281 Might also happen on redraw, when syntax rules try to match a complex
5282 text structure.
5283 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5284 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005285
Bram Moolenaar071d4272004-06-13 20:20:40 +00005286 *'maxmemtot'* *'mmt'*
5287'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5288 dependent) or half the amount of memory
5289 available)
5290 global
5291 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005292 Maximum amount of memory in Kbyte to use for all buffers together.
5293 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005294 without a limit.
5295 On 64 bit machines higher values might work. But hey, do you really
5296 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005297 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005298 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005299 Buffers with 'swapfile' off still count to the total amount of memory
5300 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005301 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005302
5303 *'menuitems'* *'mis'*
5304'menuitems' 'mis' number (default 25)
5305 global
5306 {not in Vi}
5307 {not available when compiled without the |+menu|
5308 feature}
5309 Maximum number of items to use in a menu. Used for menus that are
5310 generated from a list of items, e.g., the Buffers menu. Changing this
5311 option has no direct effect, the menu must be refreshed first.
5312
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005313 *'mkspellmem'* *'msm'*
5314'mkspellmem' 'msm' string (default "460000,2000,500")
5315 global
5316 {not in Vi}
5317 {not available when compiled without the |+syntax|
5318 feature}
5319 Parameters for |:mkspell|. This tunes when to start compressing the
5320 word tree. Compression can be slow when there are many words, but
5321 it's needed to avoid running out of memory. The amount of memory used
5322 per word depends very much on how similar the words are, that's why
5323 this tuning is complicated.
5324
5325 There are three numbers, separated by commas:
5326 {start},{inc},{added}
5327
5328 For most languages the uncompressed word tree fits in memory. {start}
5329 gives the amount of memory in Kbyte that can be used before any
5330 compression is done. It should be a bit smaller than the amount of
5331 memory that is available to Vim.
5332
5333 When going over the {start} limit the {inc} number specifies the
5334 amount of memory in Kbyte that can be allocated before another
5335 compression is done. A low number means compression is done after
5336 less words are added, which is slow. A high number means more memory
5337 will be allocated.
5338
5339 After doing compression, {added} times 1024 words can be added before
5340 the {inc} limit is ignored and compression is done when any extra
5341 amount of memory is needed. A low number means there is a smaller
5342 chance of hitting the {inc} limit, less memory is used but it's
5343 slower.
5344
5345 The languages for which these numbers are important are Italian and
5346 Hungarian. The default works for when you have about 512 Mbyte. If
5347 you have 1 Gbyte you could use: >
5348 :set mkspellmem=900000,3000,800
5349< If you have less than 512 Mbyte |:mkspell| may fail for some
5350 languages, no matter what you set 'mkspellmem' to.
5351
Bram Moolenaar071d4272004-06-13 20:20:40 +00005352 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005353'modeline' 'ml' boolean (Vim default: on (off for root),
5354 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 local to buffer
5356 *'modelines'* *'mls'*
5357'modelines' 'mls' number (default 5)
5358 global
5359 {not in Vi}
5360 If 'modeline' is on 'modelines' gives the number of lines that is
5361 checked for set commands. If 'modeline' is off or 'modelines' is zero
5362 no lines are checked. See |modeline|.
5363 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5364 set and to the Vim default value when 'compatible' is reset.
5365
5366 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5367'modifiable' 'ma' boolean (default on)
5368 local to buffer
5369 {not in Vi} *E21*
5370 When off the buffer contents cannot be changed. The 'fileformat' and
5371 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005372 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373
5374 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5375'modified' 'mod' boolean (default off)
5376 local to buffer
5377 {not in Vi}
5378 When on, the buffer is considered to be modified. This option is set
5379 when:
5380 1. A change was made to the text since it was last written. Using the
5381 |undo| command to go back to the original text will reset the
5382 option. But undoing changes that were made before writing the
5383 buffer will set the option again, since the text is different from
5384 when it was written.
5385 2. 'fileformat' or 'fileencoding' is different from its original
5386 value. The original value is set when the buffer is read or
5387 written. A ":set nomodified" command also resets the original
5388 values to the current values and the 'modified' option will be
5389 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005390 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005391 This option is not set when a change is made to the buffer as the
5392 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5393 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5394 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5396 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005397 Note that the text may actually be the same, e.g. 'modified' is set
5398 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399
5400 *'more'* *'nomore'*
5401'more' boolean (Vim default: on, Vi default: off)
5402 global
5403 {not in Vi}
5404 When on, listings pause when the whole screen is filled. You will get
5405 the |more-prompt|. When this option is off there are no pauses, the
5406 listing continues until finished.
5407 NOTE: This option is set to the Vi default value when 'compatible' is
5408 set and to the Vim default value when 'compatible' is reset.
5409
5410 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005411'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5412 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413 global
5414 {not in Vi}
5415 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005416 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5417 sysmouse and Linux console with gpm). For using the mouse in the
5418 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005420 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421 v Visual mode
5422 i Insert mode
5423 c Command-line mode
5424 h all previous modes when editing a help file
5425 a all previous modes
5426 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427 Normally you would enable the mouse in all four modes with: >
5428 :set mouse=a
5429< When the mouse is not enabled, the GUI will still use the mouse for
5430 modeless selection. This doesn't move the text cursor.
5431
5432 See |mouse-using|. Also see |'clipboard'|.
5433
5434 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005435 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 the mouse buttons can still be used by keeping the shift key pressed.
5437 Also see the 'clipboard' option.
5438
5439 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5440'mousefocus' 'mousef' boolean (default off)
5441 global
5442 {not in Vi}
5443 {only works in the GUI}
5444 The window that the mouse pointer is on is automatically activated.
5445 When changing the window layout or window focus in another way, the
5446 mouse pointer is moved to the window with keyboard focus. Off is the
5447 default because it makes using the pull down menus a little goofy, as
5448 a pointer transit may activate a window unintentionally.
5449
5450 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5451'mousehide' 'mh' boolean (default on)
5452 global
5453 {not in Vi}
5454 {only works in the GUI}
5455 When on, the mouse pointer is hidden when characters are typed.
5456 The mouse pointer is restored when the mouse is moved.
5457
5458 *'mousemodel'* *'mousem'*
5459'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5460 global
5461 {not in Vi}
5462 Sets the model to use for the mouse. The name mostly specifies what
5463 the right mouse button is used for:
5464 extend Right mouse button extends a selection. This works
5465 like in an xterm.
5466 popup Right mouse button pops up a menu. The shifted left
5467 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005468 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 popup_setpos Like "popup", but the cursor will be moved to the
5470 position where the mouse was clicked, and thus the
5471 selected operation will act upon the clicked object.
5472 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005473 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474 course, that right clicking outside a selection will
5475 end Visual mode.
5476 Overview of what button does what for each model:
5477 mouse extend popup(_setpos) ~
5478 left click place cursor place cursor
5479 left drag start selection start selection
5480 shift-left search word extend selection
5481 right click extend selection popup menu (place cursor)
5482 right drag extend selection -
5483 middle click paste paste
5484
5485 In the "popup" model the right mouse button produces a pop-up menu.
5486 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005487 In a terminal the popup menu works if Vim is compiled with the
5488 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489
5490 Note that you can further refine the meaning of buttons with mappings.
5491 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5492 selection (because that's handled in the GUI code directly).
5493
5494 The 'mousemodel' option is set by the |:behave| command.
5495
5496 *'mouseshape'* *'mouses'* *E547*
5497'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005498 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 global
5500 {not in Vi}
5501 {only available when compiled with the |+mouseshape|
5502 feature}
5503 This option tells Vim what the mouse pointer should look like in
5504 different modes. The option is a comma separated list of parts, much
5505 like used for 'guicursor'. Each part consist of a mode/location-list
5506 and an argument-list:
5507 mode-list:shape,mode-list:shape,..
5508 The mode-list is a dash separated list of these modes/locations:
5509 In a normal window: ~
5510 n Normal mode
5511 v Visual mode
5512 ve Visual mode with 'selection' "exclusive" (same as 'v',
5513 if not specified)
5514 o Operator-pending mode
5515 i Insert mode
5516 r Replace mode
5517
5518 Others: ~
5519 c appending to the command-line
5520 ci inserting in the command-line
5521 cr replacing in the command-line
5522 m at the 'Hit ENTER' or 'More' prompts
5523 ml idem, but cursor in the last line
5524 e any mode, pointer below last window
5525 s any mode, pointer on a status line
5526 sd any mode, while dragging a status line
5527 vs any mode, pointer on a vertical separator line
5528 vd any mode, while dragging a vertical separator line
5529 a everywhere
5530
5531 The shape is one of the following:
5532 avail name looks like ~
5533 w x arrow Normal mouse pointer
5534 w x blank no pointer at all (use with care!)
5535 w x beam I-beam
5536 w x updown up-down sizing arrows
5537 w x leftright left-right sizing arrows
5538 w x busy The system's usual busy pointer
5539 w x no The system's usual 'no input' pointer
5540 x udsizing indicates up-down resizing
5541 x lrsizing indicates left-right resizing
5542 x crosshair like a big thin +
5543 x hand1 black hand
5544 x hand2 white hand
5545 x pencil what you write with
5546 x question big ?
5547 x rightup-arrow arrow pointing right-up
5548 w x up-arrow arrow pointing up
5549 x <number> any X11 pointer number (see X11/cursorfont.h)
5550
5551 The "avail" column contains a 'w' if the shape is available for Win32,
5552 x for X11.
5553 Any modes not specified or shapes not available use the normal mouse
5554 pointer.
5555
5556 Example: >
5557 :set mouseshape=s:udsizing,m:no
5558< will make the mouse turn to a sizing arrow over the status lines and
5559 indicate no input when the hit-enter prompt is displayed (since
5560 clicking the mouse has no effect in this state.)
5561
5562 *'mousetime'* *'mouset'*
5563'mousetime' 'mouset' number (default 500)
5564 global
5565 {not in Vi}
5566 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5567 time in msec between two mouse clicks for the second click to be
5568 recognized as a multi click.
5569
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005570 *'mzschemedll'*
5571'mzschemedll' string (default depends on the build)
5572 global
5573 {not in Vi}
5574 {only available when compiled with the |+mzscheme/dyn|
5575 feature}
5576 Specifies the name of the MzScheme shared library. The default is
5577 DYNAMIC_MZSCH_DLL which was specified at compile time.
5578 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005579 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005580 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005581 This option cannot be set from a |modeline| or in the |sandbox|, for
5582 security reasons.
5583
5584 *'mzschemegcdll'*
5585'mzschemegcdll' string (default depends on the build)
5586 global
5587 {not in Vi}
5588 {only available when compiled with the |+mzscheme/dyn|
5589 feature}
5590 Specifies the name of the MzScheme GC shared library. The default is
5591 DYNAMIC_MZGC_DLL which was specified at compile time.
5592 The value can be equal to 'mzschemedll' if it includes the GC code.
5593 Environment variables are expanded |:set_env|.
5594 This option cannot be set from a |modeline| or in the |sandbox|, for
5595 security reasons.
5596
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005597 *'mzquantum'* *'mzq'*
5598'mzquantum' 'mzq' number (default 100)
5599 global
5600 {not in Vi}
5601 {not available when compiled without the |+mzscheme|
5602 feature}
5603 The number of milliseconds between polls for MzScheme threads.
5604 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005605 NOTE: This option is set to the Vim default value when 'compatible'
5606 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005607
Bram Moolenaar071d4272004-06-13 20:20:40 +00005608 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005609'nrformats' 'nf' string (default "bin,octal,hex",
5610 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005611 local to buffer
5612 {not in Vi}
5613 This defines what bases Vim will consider for numbers when using the
5614 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5615 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005616 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005618 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005619 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005621 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622 considered to be hexadecimal. Example: Using CTRL-X on
5623 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005624 bin If included, numbers starting with "0b" or "0B" will be
5625 considered to be binary. Example: Using CTRL-X on
5626 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 Numbers which simply begin with a digit in the range 1-9 are always
5628 considered decimal. This also happens for numbers that are not
5629 recognized as octal or hex.
5630
5631 *'number'* *'nu'* *'nonumber'* *'nonu'*
5632'number' 'nu' boolean (default off)
5633 local to window
5634 Print the line number in front of each line. When the 'n' option is
5635 excluded from 'cpoptions' a wrapped line will not use the column of
5636 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005637 The 'numberwidth' option can be used to set the room used for the line
5638 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005639 When a long, wrapped line doesn't start with the first character, '-'
5640 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005641 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5642 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005643 *number_relativenumber*
5644 The 'relativenumber' option changes the displayed number to be
5645 relative to the cursor. Together with 'number' there are these
5646 four combinations (cursor in line 3):
5647
Bram Moolenaar3848e002016-03-19 18:42:29 +01005648 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005649 'nornu' 'nornu' 'rnu' 'rnu'
5650
5651 |apple | 1 apple | 2 apple | 2 apple
5652 |pear | 2 pear | 1 pear | 1 pear
5653 |nobody | 3 nobody | 0 nobody |3 nobody
5654 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005656 *'numberwidth'* *'nuw'*
5657'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5658 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005659 {not in Vi}
5660 {only available when compiled with the |+linebreak|
5661 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005662 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005663 when the 'number' or 'relativenumber' option is set or printing lines
5664 with a line number. Since one space is always between the number and
5665 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005666 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005667 fit the highest line number in the buffer respectively the number of
5668 rows in the window, depending on whether 'number' or 'relativenumber'
5669 is set. Thus with the Vim default of 4 there is room for a line number
5670 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005671 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005672 NOTE: This option is set to the Vi default value when 'compatible' is
5673 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005674
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005675 *'omnifunc'* *'ofu'*
5676'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005677 local to buffer
5678 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005679 {not available when compiled without the |+eval|
5680 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005681 This option specifies a function to be used for Insert mode omni
5682 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005683 See |complete-functions| for an explanation of how the function is
5684 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005685 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005686 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005687 This option cannot be set from a |modeline| or in the |sandbox|, for
5688 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005689
5690
Bram Moolenaar02467872007-05-06 13:22:01 +00005691 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005692'opendevice' 'odev' boolean (default off)
5693 global
5694 {not in Vi}
5695 {only for MS-DOS, MS-Windows and OS/2}
5696 Enable reading and writing from devices. This may get Vim stuck on a
5697 device that can be opened but doesn't actually do the I/O. Therefore
5698 it is off by default.
5699 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5700 result in editing a device.
5701
5702
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005703 *'operatorfunc'* *'opfunc'*
5704'operatorfunc' 'opfunc' string (default: empty)
5705 global
5706 {not in Vi}
5707 This option specifies a function to be called by the |g@| operator.
5708 See |:map-operator| for more info and an example.
5709
5710 This option cannot be set from a |modeline| or in the |sandbox|, for
5711 security reasons.
5712
5713
Bram Moolenaar251e1912011-06-19 05:09:16 +02005714 *'osfiletype'* *'oft'*
5715'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 local to buffer
5717 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005718 This option was supported on RISC OS, which has been removed.
5719
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005721 *'packpath'* *'pp'*
5722'packpath' 'pp' string (default: see 'runtimepath')
5723 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005724 Directories used to find packages. See |packages|.
5725
5726
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005728'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 global
5730 Specifies the nroff macros that separate paragraphs. These are pairs
5731 of two letters (see |object-motions|).
5732
5733 *'paste'* *'nopaste'*
5734'paste' boolean (default off)
5735 global
5736 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005737 Put Vim in Paste mode. This is useful if you want to cut or copy
5738 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739 unexpected effects.
5740 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005741 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742 knows about pasting and will mostly do the right thing without 'paste'
5743 being set. The same is true for a terminal where Vim handles the
5744 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005745 This option is reset when starting the GUI. Thus if you set it in
5746 your .vimrc it will work in a terminal, but not in the GUI. Setting
5747 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5748 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 When the 'paste' option is switched on (also when it was already on):
5750 - mapping in Insert mode and Command-line mode is disabled
5751 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005753 - 'expandtab' is reset
5754 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755 - 'revins' is reset
5756 - 'ruler' is reset
5757 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005758 - 'smartindent' is reset
5759 - 'smarttab' is reset
5760 - 'softtabstop' is set to 0
5761 - 'textwidth' is set to 0
5762 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005765 - 'indentexpr'
5766 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 NOTE: When you start editing another file while the 'paste' option is
5768 on, settings from the modelines or autocommands may change the
5769 settings again, causing trouble when pasting text. You might want to
5770 set the 'paste' option again.
5771 When the 'paste' option is reset the mentioned options are restored to
5772 the value before the moment 'paste' was switched from off to on.
5773 Resetting 'paste' before ever setting it does not have any effect.
5774 Since mapping doesn't work while 'paste' is active, you need to use
5775 the 'pastetoggle' option to toggle the 'paste' option with some key.
5776
5777 *'pastetoggle'* *'pt'*
5778'pastetoggle' 'pt' string (default "")
5779 global
5780 {not in Vi}
5781 When non-empty, specifies the key sequence that toggles the 'paste'
5782 option. This is like specifying a mapping: >
5783 :map {keys} :set invpaste<CR>
5784< Where {keys} is the value of 'pastetoggle'.
5785 The difference is that it will work even when 'paste' is set.
5786 'pastetoggle' works in Insert mode and Normal mode, but not in
5787 Command-line mode.
5788 Mappings are checked first, thus overrule 'pastetoggle'. However,
5789 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5790 this: >
5791 :map <F10> :set paste<CR>
5792 :map <F11> :set nopaste<CR>
5793 :imap <F10> <C-O>:set paste<CR>
5794 :imap <F11> <nop>
5795 :set pastetoggle=<F11>
5796< This will make <F10> start paste mode and <F11> stop paste mode.
5797 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5798 mode everything is inserted literally, except the 'pastetoggle' key
5799 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005800 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005801
5802 *'pex'* *'patchexpr'*
5803'patchexpr' 'pex' string (default "")
5804 global
5805 {not in Vi}
5806 {not available when compiled without the |+diff|
5807 feature}
5808 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005809 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005810
Bram Moolenaardbc28022014-07-26 13:40:44 +02005811 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005812'patchmode' 'pm' string (default "")
5813 global
5814 {not in Vi}
5815 When non-empty the oldest version of a file is kept. This can be used
5816 to keep the original version of a file if you are changing files in a
5817 source distribution. Only the first time that a file is written a
5818 copy of the original file will be kept. The name of the copy is the
5819 name of the original file with the string in the 'patchmode' option
5820 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005821 ".orig" or ".org". 'backupdir' must not be empty for this to work
5822 (Detail: The backup file is renamed to the patchmode file after the
5823 new file has been successfully written, that's why it must be possible
5824 to write a backup file). If there was no file to be backed up, an
5825 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826 When the 'backupskip' pattern matches, a patchmode file is not made.
5827 Using 'patchmode' for compressed files appends the extension at the
5828 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5829 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005830 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005832 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833'path' 'pa' string (default on Unix: ".,/usr/include,,"
5834 on OS/2: ".,/emx/include,,"
5835 other systems: ".,,")
5836 global or local to buffer |global-local|
5837 {not in Vi}
5838 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005839 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5840 provided that the file being searched for has a relative path (not
5841 starting with "/", "./" or "../"). The directories in the 'path'
5842 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843 - Use commas to separate directory names: >
5844 :set path=.,/usr/local/include,/usr/include
5845< - Spaces can also be used to separate directory names (for backwards
5846 compatibility with version 3.0). To have a space in a directory
5847 name, precede it with an extra backslash, and escape the space: >
5848 :set path=.,/dir/with\\\ space
5849< - To include a comma in a directory name precede it with an extra
5850 backslash: >
5851 :set path=.,/dir/with\\,comma
5852< - To search relative to the directory of the current file, use: >
5853 :set path=.
5854< - To search in the current directory use an empty string between two
5855 commas: >
5856 :set path=,,
5857< - A directory name may end in a ':' or '/'.
5858 - Environment variables are expanded |:set_env|.
5859 - When using |netrw.vim| URLs can be used. For example, adding
5860 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005861 - Search upwards and downwards in a directory tree using "*", "**" and
5862 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 {not available when compiled without the |+path_extra| feature}
5864 - Careful with '\' characters, type two to get one in the option: >
5865 :set path=.,c:\\include
5866< Or just use '/' instead: >
5867 :set path=.,c:/include
5868< Don't forget "." or files won't even be found in the same directory as
5869 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005870 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871 it is something like 256 or 1024 characters.
5872 You can check if all the include files are found, using the value of
5873 'path', see |:checkpath|.
5874 The use of |:set+=| and |:set-=| is preferred when adding or removing
5875 directories from the list. This avoids problems when a future version
5876 uses another default. To remove the current directory use: >
5877 :set path-=
5878< To add the current directory use: >
5879 :set path+=
5880< To use an environment variable, you probably need to replace the
5881 separator. Here is an example to append $INCL, in which directory
5882 names are separated with a semi-colon: >
5883 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5884< Replace the ';' with a ':' or whatever separator is used. Note that
5885 this doesn't work when $INCL contains a comma or white space.
5886
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005887 *'perldll'*
5888'perldll' string (default depends on the build)
5889 global
5890 {not in Vi}
5891 {only available when compiled with the |+perl/dyn|
5892 feature}
5893 Specifies the name of the Perl shared library. The default is
5894 DYNAMIC_PERL_DLL, which was specified at compile time.
5895 Environment variables are expanded |:set_env|.
5896 This option cannot be set from a |modeline| or in the |sandbox|, for
5897 security reasons.
5898
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5900'preserveindent' 'pi' boolean (default off)
5901 local to buffer
5902 {not in Vi}
5903 When changing the indent of the current line, preserve as much of the
5904 indent structure as possible. Normally the indent is replaced by a
5905 series of tabs followed by spaces as required (unless |'expandtab'| is
5906 enabled, in which case only spaces are used). Enabling this option
5907 means the indent will preserve as many existing characters as possible
5908 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005909 'expandtab' does not apply to the preserved white space, a Tab remains
5910 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005911 NOTE: When using ">>" multiple times the resulting indent is a mix of
5912 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005913 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914 Also see 'copyindent'.
5915 Use |:retab| to clean up white space.
5916
5917 *'previewheight'* *'pvh'*
5918'previewheight' 'pvh' number (default 12)
5919 global
5920 {not in Vi}
5921 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005922 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005923 Default height for a preview window. Used for |:ptag| and associated
5924 commands. Used for |CTRL-W_}| when no count is given.
5925
5926 *'previewwindow'* *'nopreviewwindow'*
5927 *'pvw'* *'nopvw'* *E590*
5928'previewwindow' 'pvw' boolean (default off)
5929 local to window
5930 {not in Vi}
5931 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005932 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005933 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 set. It's normally not set directly, but by using one of the commands
5935 |:ptag|, |:pedit|, etc.
5936
5937 *'printdevice'* *'pdev'*
5938'printdevice' 'pdev' string (default empty)
5939 global
5940 {not in Vi}
5941 {only available when compiled with the |+printer|
5942 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005943 The name of the printer to be used for |:hardcopy|.
5944 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005945 This option cannot be set from a |modeline| or in the |sandbox|, for
5946 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947
Bram Moolenaar8299df92004-07-10 09:47:34 +00005948 *'printencoding'* *'penc'*
5949'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 global
5951 {not in Vi}
5952 {only available when compiled with the |+printer|
5953 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005954 Sets the character encoding used when printing.
5955 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005956
5957 *'printexpr'* *'pexpr'*
5958'printexpr' 'pexpr' String (default: see below)
5959 global
5960 {not in Vi}
5961 {only available when compiled with the |+printer|
5962 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005963 Expression used to print the PostScript produced with |:hardcopy|.
5964 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005965 This option cannot be set from a |modeline| or in the |sandbox|, for
5966 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967
Bram Moolenaar8299df92004-07-10 09:47:34 +00005968 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005969'printfont' 'pfn' string (default "courier")
5970 global
5971 {not in Vi}
5972 {only available when compiled with the |+printer|
5973 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005974 The name of the font that will be used for |:hardcopy|.
5975 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976
5977 *'printheader'* *'pheader'*
5978'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5979 global
5980 {not in Vi}
5981 {only available when compiled with the |+printer|
5982 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005983 The format of the header produced in |:hardcopy| output.
5984 See |pheader-option|.
5985
5986 *'printmbcharset'* *'pmbcs'*
5987'printmbcharset' 'pmbcs' string (default "")
5988 global
5989 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005990 {only available when compiled with the |+printer|,
5991 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005992 The CJK character set to be used for CJK output from |:hardcopy|.
5993 See |pmbcs-option|.
5994
5995 *'printmbfont'* *'pmbfn'*
5996'printmbfont' 'pmbfn' string (default "")
5997 global
5998 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005999 {only available when compiled with the |+printer|,
6000 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006001 List of font names to be used for CJK output from |:hardcopy|.
6002 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006003
6004 *'printoptions'* *'popt'*
6005'printoptions' 'popt' string (default "")
6006 global
6007 {not in Vi}
6008 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006009 List of items that control the format of the output of |:hardcopy|.
6010 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006012 *'prompt'* *'noprompt'*
6013'prompt' boolean (default on)
6014 global
6015 When on a ":" prompt is used in Ex mode.
6016
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006017 *'pumheight'* *'ph'*
6018'pumheight' 'ph' number (default 0)
6019 global
6020 {not available when compiled without the
6021 |+insert_expand| feature}
6022 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006023 Determines the maximum number of items to show in the popup menu for
6024 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006025 |ins-completion-menu|.
6026
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006027 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006028'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006029 global
6030 {not available when compiled without the
6031 |+insert_expand| feature}
6032 {not in Vi}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006033 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006034 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006035
Bram Moolenaard94464e2015-11-02 15:28:18 +01006036 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006037'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006038 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006039 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006040 {only available when compiled with the |+python/dyn|
6041 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006042 Specifies the name of the Python 2.x shared library. The default is
6043 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006044 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006045 This option cannot be set from a |modeline| or in the |sandbox|, for
6046 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006047
Bram Moolenaar94073162018-01-31 21:49:05 +01006048 *'pythonhome'*
6049'pythonhome' string (default "")
6050 global
6051 {not in Vi}
6052 {only available when compiled with the |+python/dyn|
6053 feature}
6054 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6055 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6056 which was specified at compile time, will be used for the Python 2.x
6057 home directory.
6058 Environment variables are expanded |:set_env|.
6059 This option cannot be set from a |modeline| or in the |sandbox|, for
6060 security reasons.
6061
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006062 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006063'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006064 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006065 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006066 {only available when compiled with the |+python3/dyn|
6067 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006068 Specifies the name of the Python 3 shared library. The default is
6069 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006070 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006071 This option cannot be set from a |modeline| or in the |sandbox|, for
6072 security reasons.
6073
Bram Moolenaar94073162018-01-31 21:49:05 +01006074 *'pythonthreehome'*
6075'pythonthreehome' string (default "")
6076 global
6077 {not in Vi}
6078 {only available when compiled with the |+python3/dyn|
6079 feature}
6080 Specifies the name of the Python 3 home directory. When
6081 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6082 PYTHON3_HOME, which was specified at compile time, will be used for
6083 the Python 3 home directory.
6084 Environment variables are expanded |:set_env|.
6085 This option cannot be set from a |modeline| or in the |sandbox|, for
6086 security reasons.
6087
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006088 *'pyxversion'* *'pyx'*
6089'pyxversion' 'pyx' number (default depends on the build)
6090 global
6091 {not in Vi}
6092 {only available when compiled with the |+python| or
6093 the |+python3| feature}
6094 Specifies the python version used for pyx* functions and commands
6095 |python_x|. The default value is as follows:
6096
6097 Compiled with Default ~
6098 |+python| and |+python3| 0
6099 only |+python| 2
6100 only |+python3| 3
6101
6102 Available values are 0, 2 and 3.
6103 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6104 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6105 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6106 to 2 if Python 2 is available.
6107 See also: |has-pythonx|
6108
6109 If Vim is compiled with only |+python| or |+python3| setting
6110 'pyxversion' has no effect. The pyx* functions and commands are
6111 always the same as the compiled version.
6112
6113 This option cannot be set from a |modeline| or in the |sandbox|, for
6114 security reasons.
6115
Bram Moolenaar677ee682005-01-27 14:41:15 +00006116 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006117'quoteescape' 'qe' string (default "\")
6118 local to buffer
6119 {not in Vi}
6120 The characters that are used to escape quotes in a string. Used for
6121 objects like a', a" and a` |a'|.
6122 When one of the characters in this option is found inside a string,
6123 the following character will be skipped. The default value makes the
6124 text "foo\"bar\\" considered to be one string.
6125
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6127'readonly' 'ro' boolean (default off)
6128 local to buffer
6129 If on, writes fail unless you use a '!'. Protects you from
6130 accidentally overwriting a file. Default on when Vim is started
6131 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006132 When using ":w!" the 'readonly' option is reset for the current
6133 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006135 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006136 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006137
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006138 *'redrawtime'* *'rdt'*
6139'redrawtime' 'rdt' number (default 2000)
6140 global
6141 {not in Vi}
6142 {only available when compiled with the |+reltime|
6143 feature}
6144 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006145 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006146 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006147 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006148 matches will be highlighted.
6149 For syntax highlighting the time applies per window. When over the
6150 limit syntax highlighting is disabled until |CTRL-L| is used.
6151 This is used to avoid that Vim hangs when using a very complicated
6152 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006153
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006154 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006155'regexpengine' 're' number (default 0)
6156 global
6157 {not in Vi}
6158 This selects the default regexp engine. |two-engines|
6159 The possible values are:
6160 0 automatic selection
6161 1 old engine
6162 2 NFA engine
6163 Note that when using the NFA engine and the pattern contains something
6164 that is not supported the pattern will not match. This is only useful
6165 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006166 Using automatic selection enables Vim to switch the engine, if the
6167 default engine becomes too costly. E.g., when the NFA engine uses too
6168 many states. This should prevent Vim from hanging on a combination of
6169 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006170
Bram Moolenaar64486672010-05-16 15:46:46 +02006171 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6172'relativenumber' 'rnu' boolean (default off)
6173 local to window
6174 {not in Vi}
6175 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006176 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006177 precede some vertical motion commands (e.g. j k + -) with, without
6178 having to calculate it yourself. Especially useful in combination with
6179 other commands (e.g. y d c < > gq gw =).
6180 When the 'n' option is excluded from 'cpoptions' a wrapped
6181 line will not use the column of line numbers (this is the default when
6182 'compatible' isn't set).
6183 The 'numberwidth' option can be used to set the room used for the line
6184 number.
6185 When a long, wrapped line doesn't start with the first character, '-'
6186 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006187 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6188 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006189
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006190 The number in front of the cursor line also depends on the value of
6191 'number', see |number_relativenumber| for all combinations of the two
6192 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006193
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194 *'remap'* *'noremap'*
6195'remap' boolean (default on)
6196 global
6197 Allows for mappings to work recursively. If you do not want this for
6198 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006199 NOTE: To avoid portability problems with Vim scripts, always keep
6200 this option at the default "on". Only switch it off when working with
6201 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006203 *'renderoptions'* *'rop'*
6204'renderoptions' 'rop' string (default: empty)
6205 global
6206 {not in Vi}
6207 {only available when compiled with GUI and DIRECTX on
6208 MS-Windows}
6209 Select a text renderer and set its options. The options depend on the
6210 renderer.
6211
6212 Syntax: >
6213 set rop=type:{renderer}(,{name}:{value})*
6214<
6215 Currently, only one optional renderer is available.
6216
6217 render behavior ~
6218 directx Vim will draw text using DirectX (DirectWrite). It makes
6219 drawn glyphs more beautiful than default GDI.
6220 It requires 'encoding' is "utf-8", and only works on
6221 MS-Windows Vista or newer version.
6222
6223 Options:
6224 name meaning type value ~
6225 gamma gamma float 1.0 - 2.2 (maybe)
6226 contrast enhancedContrast float (unknown)
6227 level clearTypeLevel float (unknown)
6228 geom pixelGeometry int 0 - 2 (see below)
6229 renmode renderingMode int 0 - 6 (see below)
6230 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006231 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006232
Bram Moolenaar92467d32017-12-05 13:22:16 +01006233 See this URL for detail (except for scrlines):
6234 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006235
6236 For geom: structure of a device pixel.
6237 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6238 1 - DWRITE_PIXEL_GEOMETRY_RGB
6239 2 - DWRITE_PIXEL_GEOMETRY_BGR
6240
6241 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006242 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006243
6244 For renmode: method of rendering glyphs.
6245 0 - DWRITE_RENDERING_MODE_DEFAULT
6246 1 - DWRITE_RENDERING_MODE_ALIASED
6247 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6248 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6249 4 - DWRITE_RENDERING_MODE_NATURAL
6250 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6251 6 - DWRITE_RENDERING_MODE_OUTLINE
6252
6253 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006254 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006255
6256 For taamode: antialiasing mode used for drawing text.
6257 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6258 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6259 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6260 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6261
6262 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006263 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6264
Bram Moolenaara338adc2018-01-31 20:51:47 +01006265 For scrlines:
6266 This was used for optimizing scrolling behavior, however this
6267 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006268
6269 Example: >
6270 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006271 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006272 set rop=type:directx
6273<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006274 If select a raster font (Courier, Terminal or FixedSys which
6275 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006276 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006277
6278 NOTE: It is known that some fonts and options combination
6279 causes trouble on drawing glyphs.
6280
Bram Moolenaar92467d32017-12-05 13:22:16 +01006281 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006282 special made fonts (True-Type fonts which includes only
6283 bitmap glyphs).
6284 - 'taamode:3' will not work with some vector fonts.
6285
6286 NOTE: With this option, you can display colored emoji
6287 (emoticon) in Windows 8.1 or later. To display colored emoji,
6288 there are some conditions which you should notice.
6289
6290 - If your font includes non-colored emoji already, it will
6291 be used.
6292 - If your font doesn't have emoji, the system chooses an
6293 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6294 will be used.
6295 - When this alternative font didn't have fixed width glyph,
6296 emoji might be rendered beyond the bounding box of drawing
6297 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006298
6299 Other render types are currently not supported.
6300
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 *'report'*
6302'report' number (default 2)
6303 global
6304 Threshold for reporting number of lines changed. When the number of
6305 changed lines is more than 'report' a message will be given for most
6306 ":" commands. If you want it always, set 'report' to 0.
6307 For the ":substitute" command the number of substitutions is used
6308 instead of the number of lines.
6309
6310 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6311'restorescreen' 'rs' boolean (default on)
6312 global
6313 {not in Vi} {only in Windows 95/NT console version}
6314 When set, the screen contents is restored when exiting Vim. This also
6315 happens when executing external commands.
6316
6317 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6318 options in your .vimrc. To disable restoring:
6319 set t_ti= t_te=
6320 To enable restoring (for an xterm):
6321 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6322 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6323
6324 *'revins'* *'ri'* *'norevins'* *'nori'*
6325'revins' 'ri' boolean (default off)
6326 global
6327 {not in Vi}
6328 {only available when compiled with the |+rightleft|
6329 feature}
6330 Inserting characters in Insert mode will work backwards. See "typing
6331 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6332 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006333 NOTE: This option is reset when 'compatible' is set.
6334 This option is reset when 'paste' is set and restored when 'paste' is
6335 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336
6337 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6338'rightleft' 'rl' boolean (default off)
6339 local to window
6340 {not in Vi}
6341 {only available when compiled with the |+rightleft|
6342 feature}
6343 When on, display orientation becomes right-to-left, i.e., characters
6344 that are stored in the file appear from the right to the left.
6345 Using this option, it is possible to edit files for languages that
6346 are written from the right to the left such as Hebrew and Arabic.
6347 This option is per window, so it is possible to edit mixed files
6348 simultaneously, or to view the same file in both ways (this is
6349 useful whenever you have a mixed text file with both right-to-left
6350 and left-to-right strings so that both sets are displayed properly
6351 in different windows). Also see |rileft.txt|.
6352
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006353 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354'rightleftcmd' 'rlc' string (default "search")
6355 local to window
6356 {not in Vi}
6357 {only available when compiled with the |+rightleft|
6358 feature}
6359 Each word in this option enables the command line editing to work in
6360 right-to-left mode for a group of commands:
6361
6362 search "/" and "?" commands
6363
6364 This is useful for languages such as Hebrew, Arabic and Farsi.
6365 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6366
Bram Moolenaard94464e2015-11-02 15:28:18 +01006367 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006368'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006369 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006370 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006371 {only available when compiled with the |+ruby/dyn|
6372 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006373 Specifies the name of the Ruby shared library. The default is
6374 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006375 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006376 This option cannot be set from a |modeline| or in the |sandbox|, for
6377 security reasons.
6378
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006380'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 global
6382 {not in Vi}
6383 {not available when compiled without the
6384 |+cmdline_info| feature}
6385 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006386 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 text in the file is shown on the far right:
6388 Top first line is visible
6389 Bot last line is visible
6390 All first and last line are visible
6391 45% relative position in the file
6392 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006393 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006394 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006395 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396 this option takes precedence over 'ruler' and 'rulerformat'
6397 If the number of characters displayed is different from the number of
6398 bytes in the text (e.g., for a TAB or a multi-byte character), both
6399 the text column (byte number) and the screen column are shown,
6400 separated with a dash.
6401 For an empty line "0-1" is shown.
6402 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006403 This option is reset when 'paste' is set and restored when 'paste' is
6404 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405 If you don't want to see the ruler all the time but want to know where
6406 you are, use "g CTRL-G" |g_CTRL-G|.
6407 NOTE: This option is reset when 'compatible' is set.
6408
6409 *'rulerformat'* *'ruf'*
6410'rulerformat' 'ruf' string (default empty)
6411 global
6412 {not in Vi}
6413 {not available when compiled without the |+statusline|
6414 feature}
6415 When this option is not empty, it determines the content of the ruler
6416 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006417 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 The default ruler width is 17 characters. To make the ruler 15
6419 characters wide, put "%15(" at the start and "%)" at the end.
6420 Example: >
6421 :set rulerformat=%15(%c%V\ %p%%%)
6422<
6423 *'runtimepath'* *'rtp'* *vimfiles*
6424'runtimepath' 'rtp' string (default:
6425 Unix: "$HOME/.vim,
6426 $VIM/vimfiles,
6427 $VIMRUNTIME,
6428 $VIM/vimfiles/after,
6429 $HOME/.vim/after"
6430 Amiga: "home:vimfiles,
6431 $VIM/vimfiles,
6432 $VIMRUNTIME,
6433 $VIM/vimfiles/after,
6434 home:vimfiles/after"
6435 PC, OS/2: "$HOME/vimfiles,
6436 $VIM/vimfiles,
6437 $VIMRUNTIME,
6438 $VIM/vimfiles/after,
6439 $HOME/vimfiles/after"
6440 Macintosh: "$VIM:vimfiles,
6441 $VIMRUNTIME,
6442 $VIM:vimfiles:after"
6443 RISC-OS: "Choices:vimfiles,
6444 $VIMRUNTIME,
6445 Choices:vimfiles/after"
6446 VMS: "sys$login:vimfiles,
6447 $VIM/vimfiles,
6448 $VIMRUNTIME,
6449 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006450 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 global
6452 {not in Vi}
6453 This is a list of directories which will be searched for runtime
6454 files:
6455 filetype.vim filetypes by file name |new-filetype|
6456 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006457 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 colors/ color scheme files |:colorscheme|
6459 compiler/ compiler files |:compiler|
6460 doc/ documentation |write-local-help|
6461 ftplugin/ filetype plugins |write-filetype-plugin|
6462 indent/ indent scripts |indent-expression|
6463 keymap/ key mapping files |mbyte-keymap|
6464 lang/ menu translations |:menutrans|
6465 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006466 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 plugin/ plugin scripts |write-plugin|
6468 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006469 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 syntax/ syntax files |mysyntaxfile|
6471 tutor/ files for vimtutor |tutor|
6472
6473 And any other file searched for with the |:runtime| command.
6474
6475 The defaults for most systems are setup to search five locations:
6476 1. In your home directory, for your personal preferences.
6477 2. In a system-wide Vim directory, for preferences from the system
6478 administrator.
6479 3. In $VIMRUNTIME, for files distributed with Vim.
6480 *after-directory*
6481 4. In the "after" directory in the system-wide Vim directory. This is
6482 for the system administrator to overrule or add to the distributed
6483 defaults (rarely needed)
6484 5. In the "after" directory in your home directory. This is for
6485 personal preferences to overrule or add to the distributed defaults
6486 or system-wide settings (rarely needed).
6487
Bram Moolenaard0796902016-09-16 20:02:31 +02006488 More entries are added when using |packages|. If it gets very long
6489 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6490 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006491
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6493 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006494 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 wildcards.
6496 See |:runtime|.
6497 Example: >
6498 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6499< This will use the directory "~/vimruntime" first (containing your
6500 personal Vim runtime files), then "/mygroup/vim" (shared between a
6501 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6502 files).
6503 You probably should always include $VIMRUNTIME somewhere, to use the
6504 distributed runtime files. You can put a directory before $VIMRUNTIME
6505 to find files which replace a distributed runtime files. You can put
6506 a directory after $VIMRUNTIME to find files which add to distributed
6507 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006508 When Vim is started with |--clean| the home directory entries are not
6509 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 This option cannot be set from a |modeline| or in the |sandbox|, for
6511 security reasons.
6512
6513 *'scroll'* *'scr'*
6514'scroll' 'scr' number (default: half the window height)
6515 local to window
6516 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6517 set to half the number of lines in the window when the window size
6518 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006519 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6521 the number of screen lines instead of file lines, makes a difference
6522 when lines wrap}
6523
6524 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6525'scrollbind' 'scb' boolean (default off)
6526 local to window
6527 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528 See also |scroll-binding|. When this option is set, the current
6529 window scrolls as other scrollbind windows (windows that also have
6530 this option set) scroll. This option is useful for viewing the
6531 differences between two versions of a file, see 'diff'.
6532 See |'scrollopt'| for options that determine how this option should be
6533 interpreted.
6534 This option is mostly reset when splitting a window to edit another
6535 file. This means that ":split | edit file" results in two windows
6536 with scroll-binding, but ":split file" does not.
6537
6538 *'scrolljump'* *'sj'*
6539'scrolljump' 'sj' number (default 1)
6540 global
6541 {not in Vi}
6542 Minimal number of lines to scroll when the cursor gets off the
6543 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6544 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006545 When set to a negative number from -1 to -100 this is used as the
6546 percentage of the window height. Thus -50 scrolls half the window
6547 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 NOTE: This option is set to 1 when 'compatible' is set.
6549
6550 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006551'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006552 global
6553 {not in Vi}
6554 Minimal number of screen lines to keep above and below the cursor.
6555 This will make some context visible around where you are working. If
6556 you set it to a very large value (999) the cursor line will always be
6557 in the middle of the window (except at the start or end of the file or
6558 when long lines wrap).
6559 For scrolling horizontally see 'sidescrolloff'.
6560 NOTE: This option is set to 0 when 'compatible' is set.
6561
6562 *'scrollopt'* *'sbo'*
6563'scrollopt' 'sbo' string (default "ver,jump")
6564 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 {not in Vi}
6566 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006567 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6568 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569 The following words are available:
6570 ver Bind vertical scrolling for 'scrollbind' windows
6571 hor Bind horizontal scrolling for 'scrollbind' windows
6572 jump Applies to the offset between two windows for vertical
6573 scrolling. This offset is the difference in the first
6574 displayed line of the bound windows. When moving
6575 around in a window, another 'scrollbind' window may
6576 reach a position before the start or after the end of
6577 the buffer. The offset is not changed though, when
6578 moving back the 'scrollbind' window will try to scroll
6579 to the desired position when possible.
6580 When now making that window the current one, two
6581 things can be done with the relative offset:
6582 1. When "jump" is not included, the relative offset is
6583 adjusted for the scroll position in the new current
6584 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006585 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 2. When "jump" is included, the other windows are
6587 scrolled to keep the same relative offset. When
6588 going back to the other window, it still uses the
6589 same relative offset.
6590 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006591 When 'diff' mode is active there always is vertical scroll binding,
6592 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006593
6594 *'sections'* *'sect'*
6595'sections' 'sect' string (default "SHNHH HUnhsh")
6596 global
6597 Specifies the nroff macros that separate sections. These are pairs of
6598 two letters (See |object-motions|). The default makes a section start
6599 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6600
6601 *'secure'* *'nosecure'* *E523*
6602'secure' boolean (default off)
6603 global
6604 {not in Vi}
6605 When on, ":autocmd", shell and write commands are not allowed in
6606 ".vimrc" and ".exrc" in the current directory and map commands are
6607 displayed. Switch it off only if you know that you will not run into
6608 problems, or when the 'exrc' option is off. On Unix this option is
6609 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006610 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611 'secure' at the end of your ~/.vimrc then.
6612 This option cannot be set from a |modeline| or in the |sandbox|, for
6613 security reasons.
6614
6615 *'selection'* *'sel'*
6616'selection' 'sel' string (default "inclusive")
6617 global
6618 {not in Vi}
6619 This option defines the behavior of the selection. It is only used
6620 in Visual and Select mode.
6621 Possible values:
6622 value past line inclusive ~
6623 old no yes
6624 inclusive yes yes
6625 exclusive yes no
6626 "past line" means that the cursor is allowed to be positioned one
6627 character past the line.
6628 "inclusive" means that the last character of the selection is included
6629 in an operation. For example, when "x" is used to delete the
6630 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006631 When "old" is used and 'virtualedit' allows the cursor to move past
6632 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633 Note that when "exclusive" is used and selecting from the end
6634 backwards, you cannot include the last character of a line, when
6635 starting in Normal mode and 'virtualedit' empty.
6636
6637 The 'selection' option is set by the |:behave| command.
6638
6639 *'selectmode'* *'slm'*
6640'selectmode' 'slm' string (default "")
6641 global
6642 {not in Vi}
6643 This is a comma separated list of words, which specifies when to start
6644 Select mode instead of Visual mode, when a selection is started.
6645 Possible values:
6646 mouse when using the mouse
6647 key when using shifted special keys
6648 cmd when using "v", "V" or CTRL-V
6649 See |Select-mode|.
6650 The 'selectmode' option is set by the |:behave| command.
6651
6652 *'sessionoptions'* *'ssop'*
6653'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006654 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 global
6656 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006657 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 feature}
6659 Changes the effect of the |:mksession| command. It is a comma
6660 separated list of words. Each word enables saving and restoring
6661 something:
6662 word save and restore ~
6663 blank empty windows
6664 buffers hidden and unloaded buffers, not just those in windows
6665 curdir the current directory
6666 folds manually created folds, opened/closed folds and local
6667 fold options
6668 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006669 and contain at least one lowercase letter. Only
6670 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 help the help window
6672 localoptions options and mappings local to a window or buffer (not
6673 global values for local options)
6674 options all options and mappings (also global values for local
6675 options)
6676 resize size of the Vim window: 'lines' and 'columns'
6677 sesdir the directory in which the session file is located
6678 will become the current directory (useful with
6679 projects accessed over a network from different
6680 systems)
6681 slash backslashes in file names replaced with forward
6682 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006683 tabpages all tab pages; without this only the current tab page
6684 is restored, so that you can make a session for each
6685 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006686 terminal include terminal windows where the command can be
6687 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 unix with Unix end-of-line format (single <NL>), even when
6689 on Windows or DOS
6690 winpos position of the whole Vim window
6691 winsize window sizes
6692
6693 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006694 When neither "curdir" nor "sesdir" is included, file names are stored
6695 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 "slash" and "unix" are useful on Windows when sharing session files
6697 with Unix. The Unix version of Vim cannot source dos format scripts,
6698 but the Windows version of Vim can source unix format scripts.
6699
6700 *'shell'* *'sh'* *E91*
6701'shell' 'sh' string (default $SHELL or "sh",
6702 MS-DOS and Win32: "command.com" or
6703 "cmd.exe", OS/2: "cmd")
6704 global
6705 Name of the shell to use for ! and :! commands. When changing the
6706 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6707 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006708 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 See |option-backslash| about including spaces and backslashes.
6710 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006711
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006713 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6715< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006716 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006718 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006720 Example with escaped space (Vim will do this when initializing the
6721 option from $SHELL): >
6722 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006723< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006724 backslashes are consumed by `:set`.
6725
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726 Under MS-Windows, when the executable ends in ".com" it must be
6727 included. Thus setting the shell to "command.com" or "4dos.com"
6728 works, but "command" and "4dos" do not work for all commands (e.g.,
6729 filtering).
6730 For unknown reasons, when using "4dos.com" the current directory is
6731 changed to "C:\". To avoid this set 'shell' like this: >
6732 :set shell=command.com\ /c\ 4dos
6733< This option cannot be set from a |modeline| or in the |sandbox|, for
6734 security reasons.
6735
6736 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006737'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006738 MS-DOS and Win32, when 'shell' does not
6739 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 global
6741 {not in Vi}
6742 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6743 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6744 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006745 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006746 On Unix it can have more than one flag. Each white space separated
6747 part is passed as an argument to the shell command.
6748 See |option-backslash| about including spaces and backslashes.
6749 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 This option cannot be set from a |modeline| or in the |sandbox|, for
6751 security reasons.
6752
6753 *'shellpipe'* *'sp'*
6754'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6755 global
6756 {not in Vi}
6757 {not available when compiled without the |+quickfix|
6758 feature}
6759 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006760 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 including spaces and backslashes.
6762 The name of the temporary file can be represented by "%s" if necessary
6763 (the file name is appended automatically if no %s appears in the value
6764 of this option).
6765 For the Amiga and MS-DOS the default is ">". The output is directly
6766 saved in a file and not echoed to the screen.
6767 For Unix the default it "| tee". The stdout of the compiler is saved
6768 in a file and echoed to the screen. If the 'shell' option is "csh" or
6769 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006770 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6771 default becomes "2>&1| tee". This means that stderr is also included.
6772 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6773 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006774 The initialization of this option is done after reading the ".vimrc"
6775 and the other initializations, so that when the 'shell' option is set
6776 there, the 'shellpipe' option changes automatically, unless it was
6777 explicitly set before.
6778 When 'shellpipe' is set to an empty string, no redirection of the
6779 ":make" output will be done. This is useful if you use a 'makeprg'
6780 that writes to 'makeef' by itself. If you want no piping, but do
6781 want to include the 'makeef', set 'shellpipe' to a single space.
6782 Don't forget to precede the space with a backslash: ":set sp=\ ".
6783 In the future pipes may be used for filtering and this option will
6784 become obsolete (at least for Unix).
6785 This option cannot be set from a |modeline| or in the |sandbox|, for
6786 security reasons.
6787
6788 *'shellquote'* *'shq'*
6789'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6790 contains "sh" somewhere: "\"")
6791 global
6792 {not in Vi}
6793 Quoting character(s), put around the command passed to the shell, for
6794 the "!" and ":!" commands. The redirection is kept outside of the
6795 quoting. See 'shellxquote' to include the redirection. It's
6796 probably not useful to set both options.
6797 This is an empty string by default. Only known to be useful for
6798 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6799 or bash, where it should be "\"". The default is adjusted according
6800 the value of 'shell', to reduce the need to set this option by the
6801 user. See |dos-shell|.
6802 This option cannot be set from a |modeline| or in the |sandbox|, for
6803 security reasons.
6804
6805 *'shellredir'* *'srr'*
6806'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6807 global
6808 {not in Vi}
6809 String to be used to put the output of a filter command in a temporary
6810 file. See also |:!|. See |option-backslash| about including spaces
6811 and backslashes.
6812 The name of the temporary file can be represented by "%s" if necessary
6813 (the file name is appended automatically if no %s appears in the value
6814 of this option).
6815 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6816 or "zsh" during initializations, the default becomes ">&". If the
6817 'shell' option is "sh", "ksh" or "bash" the default becomes
6818 ">%s 2>&1". This means that stderr is also included.
6819 For Win32, the Unix checks are done and additionally "cmd" is checked
6820 for, which makes the default ">%s 2>&1". Also, the same names with
6821 ".exe" appended are checked for.
6822 The initialization of this option is done after reading the ".vimrc"
6823 and the other initializations, so that when the 'shell' option is set
6824 there, the 'shellredir' option changes automatically unless it was
6825 explicitly set before.
6826 In the future pipes may be used for filtering and this option will
6827 become obsolete (at least for Unix).
6828 This option cannot be set from a |modeline| or in the |sandbox|, for
6829 security reasons.
6830
6831 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6832'shellslash' 'ssl' boolean (default off)
6833 global
6834 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6835 When set, a forward slash is used when expanding file names. This is
6836 useful when a Unix-like shell is used instead of command.com or
6837 cmd.exe. Backward slashes can still be typed, but they are changed to
6838 forward slashes by Vim.
6839 Note that setting or resetting this option has no effect for some
6840 existing file names, thus this option needs to be set before opening
6841 any file for best results. This might change in the future.
6842 'shellslash' only works when a backslash can be used as a path
6843 separator. To test if this is so use: >
6844 if exists('+shellslash')
6845<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006846 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6847'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6848 global
6849 {not in Vi}
6850 When on, use temp files for shell commands. When off use a pipe.
6851 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006852 Currently a pipe is only supported on Unix and MS-Windows 2K and
6853 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006854 :if has("filterpipe")
6855< The advantage of using a pipe is that nobody can read the temp file
6856 and the 'shell' command does not need to support redirection.
6857 The advantage of using a temp file is that the file type and encoding
6858 can be detected.
6859 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6860 |FilterWritePost| autocommands event are not triggered when
6861 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006862 The `system()` function does not respect this option and always uses
6863 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006864 NOTE: This option is set to the Vim default value when 'compatible'
6865 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006866
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 *'shelltype'* *'st'*
6868'shelltype' 'st' number (default 0)
6869 global
6870 {not in Vi} {only for the Amiga}
6871 On the Amiga this option influences the way how the commands work
6872 which use a shell.
6873 0 and 1: always use the shell
6874 2 and 3: use the shell only to filter lines
6875 4 and 5: use shell only for ':sh' command
6876 When not using the shell, the command is executed directly.
6877
6878 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6879 1 and 3: use "shell cmd" to start external commands
6880
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006881 *'shellxescape'* *'sxe'*
6882'shellxescape' 'sxe' string (default: "";
6883 for MS-DOS and MS-Windows: "\"&|<>()@^")
6884 global
6885 {not in Vi}
6886 When 'shellxquote' is set to "(" then the characters listed in this
6887 option will be escaped with a '^' character. This makes it possible
6888 to execute most external commands with cmd.exe.
6889
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890 *'shellxquote'* *'sxq'*
6891'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006892 for Win32, when 'shell' is cmd.exe: "("
6893 for Win32, when 'shell' contains "sh"
6894 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 for Unix, when using system(): "\"")
6896 global
6897 {not in Vi}
6898 Quoting character(s), put around the command passed to the shell, for
6899 the "!" and ":!" commands. Includes the redirection. See
6900 'shellquote' to exclude the redirection. It's probably not useful
6901 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006902 When the value is '(' then ')' is appended. When the value is '"('
6903 then ')"' is appended.
6904 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006905 This is an empty string by default on most systems, but is known to be
6906 useful for on Win32 version, either for cmd.exe which automatically
6907 strips off the first and last quote on a command, or 3rd-party shells
6908 such as the MKS Korn Shell or bash, where it should be "\"". The
6909 default is adjusted according the value of 'shell', to reduce the need
6910 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 This option cannot be set from a |modeline| or in the |sandbox|, for
6912 security reasons.
6913
6914 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6915'shiftround' 'sr' boolean (default off)
6916 global
6917 {not in Vi}
6918 Round indent to multiple of 'shiftwidth'. Applies to > and <
6919 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6920 a multiple of 'shiftwidth' (this is Vi compatible).
6921 NOTE: This option is reset when 'compatible' is set.
6922
6923 *'shiftwidth'* *'sw'*
6924'shiftwidth' 'sw' number (default 8)
6925 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006926 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006928 When zero the 'ts' value will be used. Use the |shiftwidth()|
6929 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930
6931 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006932'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6933 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934 global
6935 {not in Vi}
6936 This option helps to avoid all the |hit-enter| prompts caused by file
6937 messages, for example with CTRL-G, and to avoid some other messages.
6938 It is a list of flags:
6939 flag meaning when present ~
6940 f use "(3 of 5)" instead of "(file 3 of 5)"
6941 i use "[noeol]" instead of "[Incomplete last line]"
6942 l use "999L, 888C" instead of "999 lines, 888 characters"
6943 m use "[+]" instead of "[Modified]"
6944 n use "[New]" instead of "[New File]"
6945 r use "[RO]" instead of "[readonly]"
6946 w use "[w]" instead of "written" for file write message
6947 and "[a]" instead of "appended" for ':w >> file' command
6948 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6949 "[unix format]" and "[mac]" instead of "[mac format]".
6950 a all of the above abbreviations
6951
6952 o overwrite message for writing a file with subsequent message
6953 for reading a file (useful for ":wn" or when 'autowrite' on)
6954 O message for reading a file overwrites any previous message.
6955 Also for quickfix message (e.g., ":cn").
6956 s don't give "search hit BOTTOM, continuing at TOP" or "search
6957 hit TOP, continuing at BOTTOM" messages
6958 t truncate file message at the start if it is too long to fit
6959 on the command-line, "<" will appear in the left most column.
6960 Ignored in Ex mode.
6961 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006962 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006963 Ignored in Ex mode.
6964 W don't give "written" or "[w]" when writing a file
6965 A don't give the "ATTENTION" message when an existing swap file
6966 is found.
6967 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006968 c don't give |ins-completion-menu| messages. For example,
6969 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6970 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006971 q use "recording" instead of "recording @a"
6972 F don't give the file info when editing a file, like `:silent`
6973 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974
6975 This gives you the opportunity to avoid that a change between buffers
6976 requires you to hit <Enter>, but still gives as useful a message as
6977 possible for the space available. To get the whole message that you
6978 would have got with 'shm' empty, use ":file!"
6979 Useful values:
6980 shm= No abbreviation of message.
6981 shm=a Abbreviation, but no loss of information.
6982 shm=at Abbreviation, and truncate message when necessary.
6983
6984 NOTE: This option is set to the Vi default value when 'compatible' is
6985 set and to the Vim default value when 'compatible' is reset.
6986
6987 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6988'shortname' 'sn' boolean (default off)
6989 local to buffer
6990 {not in Vi, not in MS-DOS versions}
6991 Filenames are assumed to be 8 characters plus one extension of 3
6992 characters. Multiple dots in file names are not allowed. When this
6993 option is on, dots in file names are replaced with underscores when
6994 adding an extension (".~" or ".swp"). This option is not available
6995 for MS-DOS, because then it would always be on. This option is useful
6996 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6997 or crossdos. When running the Win32 GUI version under Win32s, this
6998 option is always on by default.
6999
7000 *'showbreak'* *'sbr'* *E595*
7001'showbreak' 'sbr' string (default "")
7002 global
7003 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007004 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005 feature}
7006 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007007 values are "> " or "+++ ": >
7008 :set showbreak=>\
7009< Note the backslash to escape the trailing space. It's easier like
7010 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007011 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007012< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 comma (in a future version the comma might be used to separate the
7014 part that is shown at the end and at the start of a line).
7015 The characters are highlighted according to the '@' flag in
7016 'highlight'.
7017 Note that tabs after the showbreak will be displayed differently.
7018 If you want the 'showbreak' to appear in between line numbers, add the
7019 "n" flag to 'cpoptions'.
7020
7021 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007022'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7023 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 global
7025 {not in Vi}
7026 {not available when compiled without the
7027 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007028 Show (partial) command in the last line of the screen. Set this
7029 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 In Visual mode the size of the selected area is shown:
7031 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007032 If the number of bytes is different it is also displayed: "2-6"
7033 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007035 - When selecting a block, the size in screen characters:
7036 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007037 NOTE: This option is set to the Vi default value when 'compatible' is
7038 set and to the Vim default value when 'compatible' is reset.
7039
7040 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7041'showfulltag' 'sft' boolean (default off)
7042 global
7043 {not in Vi}
7044 When completing a word in insert mode (see |ins-completion|) from the
7045 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007046 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047 matched a C function, you can see a template for what arguments are
7048 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007049 Note that this doesn't work well together with having "longest" in
7050 'completeopt', because the completion from the search pattern may not
7051 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052
7053 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7054'showmatch' 'sm' boolean (default off)
7055 global
7056 When a bracket is inserted, briefly jump to the matching one. The
7057 jump is only done if the match can be seen on the screen. The time to
7058 show the match can be set with 'matchtime'.
7059 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007060 seen or not).
7061 This option is reset when 'paste' is set and restored when 'paste' is
7062 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 When the 'm' flag is not included in 'cpoptions', typing a character
7064 will immediately move the cursor back to where it belongs.
7065 See the "sm" field in 'guicursor' for setting the cursor shape and
7066 blinking when showing the match.
7067 The 'matchpairs' option can be used to specify the characters to show
7068 matches for. 'rightleft' and 'revins' are used to look for opposite
7069 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007070 Also see the matchparen plugin for highlighting the match when moving
7071 around |pi_paren.txt|.
7072 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007073
7074 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7075'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7076 global
7077 If in Insert, Replace or Visual mode put a message on the last line.
7078 Use the 'M' flag in 'highlight' to set the type of highlighting for
7079 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007080 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081 doesn't mean XIM is really active, especially when 'imactivatekey' is
7082 not set.
7083 NOTE: This option is set to the Vi default value when 'compatible' is
7084 set and to the Vim default value when 'compatible' is reset.
7085
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007086 *'showtabline'* *'stal'*
7087'showtabline' 'stal' number (default 1)
7088 global
7089 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007090 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007091 feature}
7092 The value of this option specifies when the line with tab page labels
7093 will be displayed:
7094 0: never
7095 1: only if there are at least two tab pages
7096 2: always
7097 This is both for the GUI and non-GUI implementation of the tab pages
7098 line.
7099 See |tab-page| for more information about tab pages.
7100
Bram Moolenaar071d4272004-06-13 20:20:40 +00007101 *'sidescroll'* *'ss'*
7102'sidescroll' 'ss' number (default 0)
7103 global
7104 {not in Vi}
7105 The minimal number of columns to scroll horizontally. Used only when
7106 the 'wrap' option is off and the cursor is moved off of the screen.
7107 When it is zero the cursor will be put in the middle of the screen.
7108 When using a slow terminal set it to a large number or 0. When using
7109 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7110 commands.
7111
7112 *'sidescrolloff'* *'siso'*
7113'sidescrolloff' 'siso' number (default 0)
7114 global
7115 {not in Vi}
7116 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007117 right of the cursor if 'nowrap' is set. Setting this option to a
7118 value greater than 0 while having |'sidescroll'| also at a non-zero
7119 value makes some context visible in the line you are scrolling in
7120 horizontally (except at beginning of the line). Setting this option
7121 to a large value (like 999) has the effect of keeping the cursor
7122 horizontally centered in the window, as long as one does not come too
7123 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 NOTE: This option is set to 0 when 'compatible' is set.
7125
7126 Example: Try this together with 'sidescroll' and 'listchars' as
7127 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007128 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129
7130 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7131 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007132<
7133 *'signcolumn'* *'scl'*
7134'signcolumn' 'scl' string (default "auto")
7135 local to window
7136 {not in Vi}
7137 {not available when compiled without the |+signs|
7138 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007139 Whether or not to draw the signcolumn. Valid values are:
7140 "auto" only when there is a sign to display
7141 "no" never
7142 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143
7144
7145 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7146'smartcase' 'scs' boolean (default off)
7147 global
7148 {not in Vi}
7149 Override the 'ignorecase' option if the search pattern contains upper
7150 case characters. Only used when the search pattern is typed and
7151 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007152 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7154 recalling the search pattern from history and hitting <Enter>.
7155 NOTE: This option is reset when 'compatible' is set.
7156
7157 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7158'smartindent' 'si' boolean (default off)
7159 local to buffer
7160 {not in Vi}
7161 {not available when compiled without the
7162 |+smartindent| feature}
7163 Do smart autoindenting when starting a new line. Works for C-like
7164 programs, but can also be used for other languages. 'cindent' does
7165 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007166 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007167 setting 'si' has no effect. 'indentexpr' is a more advanced
7168 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 Normally 'autoindent' should also be on when using 'smartindent'.
7170 An indent is automatically inserted:
7171 - After a line ending in '{'.
7172 - After a line starting with a keyword from 'cinwords'.
7173 - Before a line starting with '}' (only with the "O" command).
7174 When typing '}' as the first character in a new line, that line is
7175 given the same indent as the matching '{'.
7176 When typing '#' as the first character in a new line, the indent for
7177 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007178 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7180 When using the ">>" command, lines starting with '#' are not shifted
7181 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007182 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007183 This option is reset when 'paste' is set and restored when 'paste' is
7184 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185
7186 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7187'smarttab' 'sta' boolean (default off)
7188 global
7189 {not in Vi}
7190 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007191 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7192 <BS> will delete a 'shiftwidth' worth of space at the start of the
7193 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007194 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007195 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7196 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007197 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007199 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007200 This option is reset when 'paste' is set and restored when 'paste' is
7201 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 NOTE: This option is reset when 'compatible' is set.
7203
7204 *'softtabstop'* *'sts'*
7205'softtabstop' 'sts' number (default 0)
7206 local to buffer
7207 {not in Vi}
7208 Number of spaces that a <Tab> counts for while performing editing
7209 operations, like inserting a <Tab> or using <BS>. It "feels" like
7210 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7211 used. This is useful to keep the 'ts' setting at its standard value
7212 of 8, while being able to edit like it is set to 'sts'. However,
7213 commands like "x" still work on the actual characters.
7214 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007215 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007216 'softtabstop' is set to 0 when the 'paste' option is set and restored
7217 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007218 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7219 spaces is minimized by using <Tab>s.
7220 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7221 set.
7222 NOTE: This option is set to 0 when 'compatible' is set.
7223
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007224 If Vim is compiled with the |+vartabs| feature then the value of
7225 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7226 anything other than an empty string.
7227
Bram Moolenaar217ad922005-03-20 22:37:15 +00007228 *'spell'* *'nospell'*
7229'spell' boolean (default off)
7230 local to window
7231 {not in Vi}
7232 {not available when compiled without the |+syntax|
7233 feature}
7234 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007235 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007236
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007237 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007238'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007239 local to buffer
7240 {not in Vi}
7241 {not available when compiled without the |+syntax|
7242 feature}
7243 Pattern to locate the end of a sentence. The following word will be
7244 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007245 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007246 When this check is not wanted make this option empty.
7247 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007248 Be careful with special characters, see |option-backslash| about
7249 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007250 To set this option automatically depending on the language, see
7251 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007252
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007253 *'spellfile'* *'spf'*
7254'spellfile' 'spf' string (default empty)
7255 local to buffer
7256 {not in Vi}
7257 {not available when compiled without the |+syntax|
7258 feature}
7259 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007260 commands. It must end in ".{encoding}.add". You need to include the
7261 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007262 *E765*
7263 It may also be a comma separated list of names. A count before the
7264 |zg| and |zw| commands can be used to access each. This allows using
7265 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007266 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007267 you: Using the first directory in 'runtimepath' that is writable. If
7268 there is no "spell" directory yet it will be created. For the file
7269 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007270 ignoring the region.
7271 The resulting ".spl" file will be used for spell checking, it does not
7272 have to appear in 'spelllang'.
7273 Normally one file is used for all regions, but you can add the region
7274 name if you want to. However, it will then only be used when
7275 'spellfile' is set to it, for entries in 'spelllang' only files
7276 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007277 This option cannot be set from a |modeline| or in the |sandbox|, for
7278 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007279
Bram Moolenaar217ad922005-03-20 22:37:15 +00007280 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007281'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007282 local to buffer
7283 {not in Vi}
7284 {not available when compiled without the |+syntax|
7285 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007286 A comma separated list of word list names. When the 'spell' option is
7287 on spellchecking will be done for these languages. Example: >
7288 set spelllang=en_us,nl,medical
7289< This means US English, Dutch and medical words are recognized. Words
7290 that are not recognized will be highlighted.
7291 The word list name must not include a comma or dot. Using a dash is
7292 recommended to separate the two letter language name from a
7293 specification. Thus "en-rare" is used for rare English words.
7294 A region name must come last and have the form "_xx", where "xx" is
7295 the two-letter, lower case region name. You can use more than one
7296 region by listing them: "en_us,en_ca" supports both US and Canadian
7297 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007298 Britain. (Note: currently en_au and en_nz dictionaries are older than
7299 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007300 If the name "cjk" is included East Asian characters are excluded from
7301 spell checking. This is useful when editing text that also has Asian
7302 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007303 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007304 As a special case the name of a .spl file can be given as-is. The
7305 first "_xx" in the name is removed and used as the region name
7306 (_xx is an underscore, two letters and followed by a non-letter).
7307 This is mainly for testing purposes. You must make sure the correct
7308 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007309 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007310 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7311 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007312 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007313
Bram Moolenaar98692072006-02-04 00:57:42 +00007314 If the |spellfile.vim| plugin is active and you use a language name
7315 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7316 will ask you if you want to download the file.
7317
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007318 After this option has been set successfully, Vim will source the files
7319 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007320 up to the first comma, dot or underscore.
7321 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007322
7323
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007324 *'spellsuggest'* *'sps'*
7325'spellsuggest' 'sps' string (default "best")
7326 global
7327 {not in Vi}
7328 {not available when compiled without the |+syntax|
7329 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007330 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007331 the |spellsuggest()| function. This is a comma-separated list of
7332 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007333
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007334 best Internal method that works best for English. Finds
7335 changes like "fast" and uses a bit of sound-a-like
7336 scoring to improve the ordering.
7337
7338 double Internal method that uses two methods and mixes the
7339 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007340 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007341 word. That only works when the language specifies
7342 sound folding. Can be slow and doesn't always give
7343 better results.
7344
7345 fast Internal method that only checks for simple changes:
7346 character inserts/deletes/swaps. Works well for
7347 simple typing mistakes.
7348
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007349 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007350 Not used for |spellsuggest()|. The number of
7351 suggestions is never more than the value of 'lines'
7352 minus two.
7353
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007354 file:{filename} Read file {filename}, which must have two columns,
7355 separated by a slash. The first column contains the
7356 bad word, the second column the suggested good word.
7357 Example:
7358 theribal/terrible ~
7359 Use this for common mistakes that do not appear at the
7360 top of the suggestion list with the internal methods.
7361 Lines without a slash are ignored, use this for
7362 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007363 The word in the second column must be correct,
7364 otherwise it will not be used. Add the word to an
7365 ".add" file if it is currently flagged as a spelling
7366 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007367 The file is used for all languages.
7368
7369 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7370 trouble with spaces. |v:val| holds the badly spelled
7371 word. The expression must evaluate to a List of
7372 Lists, each with a suggestion and a score.
7373 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007374 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007375 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007376 internal methods use. A lower score is better.
7377 This may invoke |spellsuggest()| if you temporarily
7378 set 'spellsuggest' to exclude the "expr:" part.
7379 Errors are silently ignored, unless you set the
7380 'verbose' option to a non-zero value.
7381
7382 Only one of "best", "double" or "fast" may be used. The others may
7383 appear several times in any order. Example: >
7384 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7385<
7386 This option cannot be set from a |modeline| or in the |sandbox|, for
7387 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007388
7389
Bram Moolenaar071d4272004-06-13 20:20:40 +00007390 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7391'splitbelow' 'sb' boolean (default off)
7392 global
7393 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007394 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395 feature}
7396 When on, splitting a window will put the new window below the current
7397 one. |:split|
7398
7399 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7400'splitright' 'spr' boolean (default off)
7401 global
7402 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007403 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007404 feature}
7405 When on, splitting a window will put the new window right of the
7406 current one. |:vsplit|
7407
7408 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7409'startofline' 'sol' boolean (default on)
7410 global
7411 {not in Vi}
7412 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007413 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007414 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007415 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 with a linewise operator, with "%" with a count and to buffer changing
7417 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7418 only has a line number, e.g., ":25" or ":+".
7419 In case of buffer changing commands the cursor is placed at the column
7420 where it was the last time the buffer was edited.
7421 NOTE: This option is set when 'compatible' is set.
7422
Bram Moolenaar00654022011-02-25 14:42:19 +01007423 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007425 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007426 {not in Vi}
7427 {not available when compiled without the |+statusline|
7428 feature}
7429 When nonempty, this option determines the content of the status line.
7430 Also see |status-line|.
7431
7432 The option consists of printf style '%' items interspersed with
7433 normal text. Each status line item is of the form:
7434 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007435 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007436 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007437
Bram Moolenaar238a5642006-02-21 22:12:05 +00007438 When the option starts with "%!" then it is used as an expression,
7439 evaluated and the result is used as the option value. Example: >
7440 :set statusline=%!MyStatusLine()
7441< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007442 Note that the "%!" expression is evaluated in the context of the
7443 current window and buffer, while %{} items are evaluated in the
7444 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007445
7446 When there is error while evaluating the option then it will be made
7447 empty to avoid further errors. Otherwise screen updating would loop.
7448
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 Note that the only effect of 'ruler' when this option is set (and
7450 'laststatus' is 2) is controlling the output of |CTRL-G|.
7451
7452 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007453 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007455 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007456 minwid Minimum width of the item, padding as set by '-' & '0'.
7457 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007458 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459 on the left for text items. Numeric items will be
7460 shifted down to maxwid-2 digits followed by '>'number
7461 where number is the amount of missing digits, much like
7462 an exponential notation.
7463 item A one letter code as described below.
7464
7465 Following is a description of the possible statusline items. The
7466 second character in "item" is the type:
7467 N for number
7468 S for string
7469 F for flags as described below
7470 - not applicable
7471
7472 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007473 f S Path to the file in the buffer, as typed or relative to current
7474 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007475 F S Full path to the file in the buffer.
7476 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007477 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007479 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007480 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007481 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007483 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007485 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007487 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7489 being used: "<keymap>"
7490 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007491 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492 B N As above, in hexadecimal.
7493 o N Byte number in file of byte under cursor, first byte is 1.
7494 Mnemonic: Offset from start of file (with one added)
7495 {not available when compiled without |+byte_offset| feature}
7496 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007497 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498 l N Line number.
7499 L N Number of lines in buffer.
7500 c N Column number.
7501 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007502 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503 p N Percentage through file in lines as in |CTRL-G|.
7504 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007505 percentage described for 'ruler'. Always 3 in length, unless
7506 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007507 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007509 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007510 Note that there is no '%' before the closing '}'. The
7511 expression cannot contain a '}' character, call a function to
7512 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 ( - Start of item group. Can be used for setting the width and
7514 alignment of a section. Must be followed by %) somewhere.
7515 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007516 T N For 'tabline': start of tab page N label. Use %T after the last
7517 label. This information is used for mouse clicks.
7518 X N For 'tabline': start of close tab N label. Use %X after the
7519 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7520 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007521 < - Where to truncate line if too long. Default is at the start.
7522 No width fields allowed.
7523 = - Separation point between left and right aligned items.
7524 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007525 # - Set highlight group. The name must follow and then a # again.
7526 Thus use %#HLname# for highlight group HLname. The same
7527 highlighting is used, also for the statusline of non-current
7528 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007530 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 The difference between User{N} and StatusLine will be applied
7532 to StatusLineNC for the statusline of non-current windows.
7533 The number N must be between 1 and 9. See |hl-User1..9|
7534
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007535 When displaying a flag, Vim removes the leading comma, if any, when
7536 that flag comes right after plaintext. This will make a nice display
7537 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538
Bram Moolenaar582fd852005-03-28 20:58:01 +00007539 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007540 not set) and a minwid is not set for the group, the whole group will
7541 become empty. This will make a group like the following disappear
7542 completely from the statusline when none of the flags are set. >
7543 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007544< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 Beware that an expression is evaluated each and every time the status
7546 line is displayed. The current buffer and current window will be set
7547 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007548 currently being drawn. The expression will evaluate in this context.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007549 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007550 real current buffer.
7551
Bram Moolenaar30b65812012-07-12 22:01:11 +02007552 The 'statusline' option will be evaluated in the |sandbox| if set from
7553 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007554
7555 It is not allowed to change text or jump to another window while
7556 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557
7558 If the statusline is not updated when you want it (e.g., after setting
7559 a variable that's used in an expression), you can force an update by
7560 setting an option without changing its value. Example: >
7561 :let &ro = &ro
7562
7563< A result of all digits is regarded a number for display purposes.
7564 Otherwise the result is taken as flag text and applied to the rules
7565 described above.
7566
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007567 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007569 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007570
7571 Examples:
7572 Emulate standard status line with 'ruler' set >
7573 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7574< Similar, but add ASCII value of char under the cursor (like "ga") >
7575 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7576< Display byte count and byte value, modified flag in red. >
7577 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7578 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7579< Display a ,GZ flag if a compressed file is loaded >
7580 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7581< In the |:autocmd|'s: >
7582 :let b:gzflag = 1
7583< And: >
7584 :unlet b:gzflag
7585< And define this function: >
7586 :function VarExists(var, val)
7587 : if exists(a:var) | return a:val | else | return '' | endif
7588 :endfunction
7589<
7590 *'suffixes'* *'su'*
7591'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7592 global
7593 {not in Vi}
7594 Files with these suffixes get a lower priority when multiple files
7595 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007596 suffixes. Spaces after the comma are ignored. A dot is also seen as
7597 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598 separator, precede it with a backslash (see |option-backslash| about
7599 including spaces and backslashes).
7600 See 'wildignore' for completely ignoring files.
7601 The use of |:set+=| and |:set-=| is preferred when adding or removing
7602 suffixes from the list. This avoids problems when a future version
7603 uses another default.
7604
7605 *'suffixesadd'* *'sua'*
7606'suffixesadd' 'sua' string (default "")
7607 local to buffer
7608 {not in Vi}
7609 {not available when compiled without the
7610 |+file_in_path| feature}
7611 Comma separated list of suffixes, which are used when searching for a
7612 file for the "gf", "[I", etc. commands. Example: >
7613 :set suffixesadd=.java
7614<
7615 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7616'swapfile' 'swf' boolean (default on)
7617 local to buffer
7618 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007619 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 swapfile is not wanted for a specific buffer. For example, with
7621 confidential information that even root must not be able to access.
7622 Careful: All text will be in memory:
7623 - Don't use this for big files.
7624 - Recovery will be impossible!
7625 A swapfile will only be present when |'updatecount'| is non-zero and
7626 'swapfile' is set.
7627 When 'swapfile' is reset, the swap file for the current buffer is
7628 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7629 non-zero, a swap file is immediately created.
7630 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007631 If you want to open a new buffer without creating a swap file for it,
7632 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007633 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634
7635 This option is used together with 'bufhidden' and 'buftype' to
7636 specify special kinds of buffers. See |special-buffers|.
7637
7638 *'swapsync'* *'sws'*
7639'swapsync' 'sws' string (default "fsync")
7640 global
7641 {not in Vi}
7642 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007643 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 When this option is empty parts of the swap file may be in memory and
7645 not written to disk. When the system crashes you may lose more work.
7646 On Unix the system does a sync now and then without Vim asking for it,
7647 so the disadvantage of setting this option off is small. On some
7648 systems the swap file will not be written at all. For a unix system
7649 setting it to "sync" will use the sync() call instead of the default
7650 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007651 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652
7653 *'switchbuf'* *'swb'*
7654'switchbuf' 'swb' string (default "")
7655 global
7656 {not in Vi}
7657 This option controls the behavior when switching between buffers.
7658 Possible values (comma separated list):
7659 useopen If included, jump to the first open window that
7660 contains the specified buffer (if there is one).
7661 Otherwise: Do not examine other windows.
7662 This setting is checked with |quickfix| commands, when
7663 jumping to errors (":cc", ":cn", "cp", etc.). It is
7664 also used in all buffer related split commands, for
7665 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007666 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007667 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007669 a buffer for a |quickfix| command that display errors.
7670 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007671 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007672 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007673 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007674
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007675 *'synmaxcol'* *'smc'*
7676'synmaxcol' 'smc' number (default 3000)
7677 local to buffer
7678 {not in Vi}
7679 {not available when compiled without the |+syntax|
7680 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007681 Maximum column in which to search for syntax items. In long lines the
7682 text after this column is not highlighted and following lines may not
7683 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007684 This helps to avoid very slow redrawing for an XML file that is one
7685 long line.
7686 Set to zero to remove the limit.
7687
Bram Moolenaar071d4272004-06-13 20:20:40 +00007688 *'syntax'* *'syn'*
7689'syntax' 'syn' string (default empty)
7690 local to buffer
7691 {not in Vi}
7692 {not available when compiled without the |+syntax|
7693 feature}
7694 When this option is set, the syntax with this name is loaded, unless
7695 syntax highlighting has been switched off with ":syntax off".
7696 Otherwise this option does not always reflect the current syntax (the
7697 b:current_syntax variable does).
7698 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007699 not automatically recognized. Example, in an IDL file:
7700 /* vim: set syntax=idl : */ ~
7701 When a dot appears in the value then this separates two filetype
7702 names. Example:
7703 /* vim: set syntax=c.doxygen : */ ~
7704 This will use the "c" syntax first, then the "doxygen" syntax.
7705 Note that the second one must be prepared to be loaded as an addition,
7706 otherwise it will be skipped. More than one dot may appear.
7707 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007708 :set syntax=OFF
7709< To switch syntax highlighting on according to the current value of the
7710 'filetype' option: >
7711 :set syntax=ON
7712< What actually happens when setting the 'syntax' option is that the
7713 Syntax autocommand event is triggered with the value as argument.
7714 This option is not copied to another buffer, independent of the 's' or
7715 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007716 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007717
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007718 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007719'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007720 global
7721 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007722 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007723 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007724 When nonempty, this option determines the content of the tab pages
7725 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007726 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007727
7728 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007729 option and only when there is no GUI tab line. When 'e' is in
7730 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007731 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007732
7733 The value is evaluated like with 'statusline'. You can use
7734 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007735 the text to be displayed. Use "%1T" for the first label, "%2T" for
7736 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007737
7738 Keep in mind that only one of the tab pages is the current one, others
7739 are invisible and you can't jump to their windows.
7740
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007741
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007742 *'tabpagemax'* *'tpm'*
7743'tabpagemax' 'tpm' number (default 10)
7744 global
7745 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007746 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007747 feature}
7748 Maximum number of tab pages to be opened by the |-p| command line
7749 argument or the ":tab all" command. |tabpage|
7750
7751
7752 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753'tabstop' 'ts' number (default 8)
7754 local to buffer
7755 Number of spaces that a <Tab> in the file counts for. Also see
7756 |:retab| command, and 'softtabstop' option.
7757
7758 Note: Setting 'tabstop' to any other value than 8 can make your file
7759 appear wrong in many places (e.g., when printing it).
7760
7761 There are four main ways to use tabs in Vim:
7762 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7763 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007764 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765 behave like a tab appears every 4 (or 3) characters.
7766 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7767 'expandtab'. This way you will always insert spaces. The
7768 formatting will never be messed up when 'tabstop' is changed.
7769 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007770 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007771 works when using Vim to edit the file.
7772 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7773 'noexpandtab'. This should then work (for initial indents only)
7774 for any tabstop setting that people use. It might be nice to have
7775 tabs after the first non-blank inserted as spaces if you do this
7776 though. Otherwise aligned comments will be wrong when 'tabstop' is
7777 changed.
7778
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007779 If Vim is compiled with the |+vartabs| feature then the value of
7780 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7781 than an empty string.
7782
Bram Moolenaar071d4272004-06-13 20:20:40 +00007783 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7784'tagbsearch' 'tbs' boolean (default on)
7785 global
7786 {not in Vi}
7787 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007788 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789 searching makes searching for a tag a LOT faster, but a linear search
7790 will find more tags if the tags file wasn't properly sorted.
7791 Vim normally assumes that your tags files are sorted, or indicate that
7792 they are not sorted. Only when this is not the case does the
7793 'tagbsearch' option need to be switched off.
7794
7795 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007796 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797 certain files, or retry all files with a linear search. When
7798 'tagbsearch' is off, only a linear search is done.
7799
7800 Linear searching is done anyway, for one file, when Vim finds a line
7801 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007802 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007803< [The whitespace before and after the '0' must be a single <Tab>]
7804
7805 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007806 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 instead of a normal tag name, a retry is done with a linear search.
7808 Tags in unsorted tags files, and matches with different case will only
7809 be found in the retry.
7810
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007811 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007812 linear search can be avoided when case is ignored. Use a value of '2'
7813 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7814 sorted with the -f switch to "sort" in most unices, as in the command:
7815 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7816 (at least 5.5) the --sort=foldcase switch can be used for this as
7817 well. Note that case must be folded to uppercase for this to work.
7818
7819 By default, tag searches are case-sensitive. Case is ignored when
7820 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7821 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007822 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7823 'tagcase' is "smart", and the pattern contains only lowercase
7824 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007825
7826 When 'tagbsearch' is off, tags searching is slower when a full match
7827 exists, but faster when no full match exists. Tags in unsorted tags
7828 files may only be found with 'tagbsearch' off.
7829 When the tags file is not sorted, or sorted in a wrong way (not on
7830 ASCII byte value), 'tagbsearch' should be off, or the line given above
7831 must be included in the tags file.
7832 This option doesn't affect commands that find all matching tags (e.g.,
7833 command-line completion and ":help").
7834 {Vi: always uses binary search in some versions}
7835
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007836 *'tagcase'* *'tc'*
7837'tagcase' 'tc' string (default "followic")
7838 global or local to buffer |global-local|
7839 {not in Vi}
7840 This option specifies how case is handled when searching the tags
7841 file:
7842 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007843 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007844 ignore Ignore case
7845 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007846 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007847 NOTE: This option is set to the Vi default value when 'compatible' is
7848 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007849
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850 *'taglength'* *'tl'*
7851'taglength' 'tl' number (default 0)
7852 global
7853 If non-zero, tags are significant up to this number of characters.
7854
7855 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7856'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7857 global
7858 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007859 If on and using a tags file in another directory, file names in that
7860 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007861 NOTE: This option is set to the Vi default value when 'compatible' is
7862 set and to the Vim default value when 'compatible' is reset.
7863
7864 *'tags'* *'tag'* *E433*
7865'tags' 'tag' string (default "./tags,tags", when compiled with
7866 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7867 global or local to buffer |global-local|
7868 Filenames for the tag command, separated by spaces or commas. To
7869 include a space or comma in a file name, precede it with a backslash
7870 (see |option-backslash| about including spaces and backslashes).
7871 When a file name starts with "./", the '.' is replaced with the path
7872 of the current file. But only when the 'd' flag is not included in
7873 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7874 |tags-option|.
7875 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007876 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7877 find all files named "tags" below "/lib". The filename itself cannot
7878 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7879 files called "tags?". {not available when compiled without the
7880 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007881 The |tagfiles()| function can be used to get a list of the file names
7882 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7884 files are also supported. They are automatically recognized. The
7885 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7886 differences are ignored (MS-Windows). |emacs-tags|
7887 The use of |:set+=| and |:set-=| is preferred when adding or removing
7888 file names from the list. This avoids problems when a future version
7889 uses another default.
7890 {Vi: default is "tags /usr/lib/tags"}
7891
7892 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7893'tagstack' 'tgst' boolean (default on)
7894 global
7895 {not in all versions of Vi}
7896 When on, the |tagstack| is used normally. When off, a ":tag" or
7897 ":tselect" command with an argument will not push the tag onto the
7898 tagstack. A following ":tag" without an argument, a ":pop" command or
7899 any other command that uses the tagstack will use the unmodified
7900 tagstack, but does change the pointer to the active entry.
7901 Resetting this option is useful when using a ":tag" command in a
7902 mapping which should not change the tagstack.
7903
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007904 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007905'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007906 global
7907 {not in Vi}
7908 {only available when compiled with the |+tcl/dyn|
7909 feature}
7910 Specifies the name of the Tcl shared library. The default is
7911 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007912 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007913 This option cannot be set from a |modeline| or in the |sandbox|, for
7914 security reasons.
7915
Bram Moolenaar071d4272004-06-13 20:20:40 +00007916 *'term'* *E529* *E530* *E531*
7917'term' string (default is $TERM, if that fails:
7918 in the GUI: "builtin_gui"
7919 on Amiga: "amiga"
7920 on BeOS: "beos-ansi"
7921 on Mac: "mac-ansi"
7922 on MiNT: "vt52"
7923 on MS-DOS: "pcterm"
7924 on OS/2: "os2ansi"
7925 on Unix: "ansi"
7926 on VMS: "ansi"
7927 on Win 32: "win32")
7928 global
7929 Name of the terminal. Used for choosing the terminal control
7930 characters. Environment variables are expanded |:set_env|.
7931 For example: >
7932 :set term=$TERM
7933< See |termcap|.
7934
7935 *'termbidi'* *'tbidi'*
7936 *'notermbidi'* *'notbidi'*
7937'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7938 global
7939 {not in Vi}
7940 {only available when compiled with the |+arabic|
7941 feature}
7942 The terminal is in charge of Bi-directionality of text (as specified
7943 by Unicode). The terminal is also expected to do the required shaping
7944 that some languages (such as Arabic) require.
7945 Setting this option implies that 'rightleft' will not be set when
7946 'arabic' is set and the value of 'arabicshape' will be ignored.
7947 Note that setting 'termbidi' has the immediate effect that
7948 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7949 This option is reset when the GUI is started.
7950 For further details see |arabic.txt|.
7951
7952 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007953'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 Macintosh GUI: "macroman")
7955 global
7956 {only available when compiled with the |+multi_byte|
7957 feature}
7958 {not in Vi}
7959 Encoding used for the terminal. This specifies what character
7960 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007961 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007962 display). Except for the Mac when 'macatsui' is off, then
7963 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007965 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007966 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7967 Any attempts to set a different value will be rejected, and an error
7968 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007969 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007970 because the Win32 system always passes Unicode characters.
7971 When empty, the same encoding is used as for the 'encoding' option.
7972 This is the normal value.
7973 Not all combinations for 'termencoding' and 'encoding' are valid. See
7974 |encoding-table|.
7975 The value for this option must be supported by internal conversions or
7976 iconv(). When this is not possible no conversion will be done and you
7977 will probably experience problems with non-ASCII characters.
7978 Example: You are working with the locale set to euc-jp (Japanese) and
7979 want to edit a UTF-8 file: >
7980 :let &termencoding = &encoding
7981 :set encoding=utf-8
7982< You need to do this when your system has no locale support for UTF-8.
7983
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007984 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007985'termguicolors' 'tgc' boolean (default off)
7986 global
7987 {not in Vi}
7988 {not available when compiled without the
7989 |+termguicolors| feature}
7990 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007991 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007992
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007993 Requires a ISO-8613-3 compatible terminal. If setting this option
7994 does not work (produces a colorless UI) reading |xterm-true-color|
7995 might help.
7996
7997 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7998 is required. Use this check to find out: >
7999 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008000< This requires Vim to be built with the |+vtp| feature.
8001
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008002 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008003 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008004
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008005 *'termwinscroll'* *'twsl'*
8006'termwinscroll' 'twsl' number (default 10000)
8007 local to buffer
Bram Moolenaar8c041b62018-04-14 18:14:06 +02008008 {not in Vi}
8009 {not available when compiled without the
8010 |+terminal| feature}
8011 Number of scrollback lines to keep. When going over this limit the
8012 first 10% of the scrollback lines are deleted. This is just to reduce
8013 the memory usage. See |Terminal-Normal|.
8014
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008015 *'termwinkey'* *'twk'*
8016'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008017 local to window
8018 {not in Vi}
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008019 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008020 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008021 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008022 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008023< The string must be one key stroke but can be multiple bytes.
8024 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008025 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008026 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008027
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008028 *'termwinsize'* *'tws'*
8029'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008030 local to window
8031 {not in Vi}
Bram Moolenaar498c2562018-04-15 23:45:15 +02008032 Size of the |terminal| window. Format: {rows}x{columns} or
8033 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008034 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008035 - When set with a "x" (e.g., "24x80") the terminal size is not
8036 adjusted to the window size. If the window is smaller only the
8037 top-left part is displayed.
8038 - When set with a "*" (e.g., "10*50") the terminal size follows the
8039 window size, but will not be smaller than the specified rows and/or
8040 columns.
8041 - When rows is zero then use the height of the window.
8042 - When columns is zero then use the width of the window.
8043 - Using "0x0" or "0*0" is the same as empty.
8044
8045 Examples:
8046 "30x0" uses 30 rows and the current window width.
8047 "20*0" uses at least 20 rows and the current window width.
8048 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008049 Note that the command running in the terminal window may still change
8050 the size of the terminal. In that case the Vim window will be
8051 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008052
Bram Moolenaar071d4272004-06-13 20:20:40 +00008053 *'terse'* *'noterse'*
8054'terse' boolean (default off)
8055 global
8056 When set: Add 's' flag to 'shortmess' option (this makes the message
8057 for a search that hits the start or end of the file not being
8058 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8059 shortens a lot of messages}
8060
8061 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8062'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8063 global
8064 {not in Vi}
8065 This option is obsolete. Use 'fileformats'.
8066 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8067 set to the default value for the current system. When 'textauto' is
8068 reset, 'fileformats' is made empty.
8069 NOTE: This option is set to the Vi default value when 'compatible' is
8070 set and to the Vim default value when 'compatible' is reset.
8071
8072 *'textmode'* *'tx'* *'notextmode'* *'notx'*
8073'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
8074 others: default off)
8075 local to buffer
8076 {not in Vi}
8077 This option is obsolete. Use 'fileformat'.
8078 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8079 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8080 "unix".
8081
8082 *'textwidth'* *'tw'*
8083'textwidth' 'tw' number (default 0)
8084 local to buffer
8085 {not in Vi}
8086 Maximum width of text that is being inserted. A longer line will be
8087 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008088 this.
8089 'textwidth' is set to 0 when the 'paste' option is set and restored
8090 when 'paste' is reset.
8091 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008092 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008093 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008094 NOTE: This option is set to 0 when 'compatible' is set.
8095
8096 *'thesaurus'* *'tsr'*
8097'thesaurus' 'tsr' string (default "")
8098 global or local to buffer |global-local|
8099 {not in Vi}
8100 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008101 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00008102 the file should contain words with similar meaning, separated by
8103 non-keyword characters (white space is preferred). Maximum line
8104 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02008105 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008106 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02008107 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008108 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008109 after a comma are ignored, otherwise spaces are included in the file
8110 name. See |option-backslash| about using backslashes.
8111 The use of |:set+=| and |:set-=| is preferred when adding or removing
8112 directories from the list. This avoids problems when a future version
8113 uses another default.
8114 Backticks cannot be used in this option for security reasons.
8115
8116 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8117'tildeop' 'top' boolean (default off)
8118 global
8119 {not in Vi}
8120 When on: The tilde command "~" behaves like an operator.
8121 NOTE: This option is reset when 'compatible' is set.
8122
8123 *'timeout'* *'to'* *'notimeout'* *'noto'*
8124'timeout' 'to' boolean (default on)
8125 global
8126 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008127'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 global
8129 {not in Vi}
8130 These two options together determine the behavior when part of a
8131 mapped key sequence or keyboard code has been received:
8132
8133 'timeout' 'ttimeout' action ~
8134 off off do not time out
8135 on on or off time out on :mappings and key codes
8136 off on time out on key codes
8137
8138 If both options are off, Vim will wait until either the complete
8139 mapping or key sequence has been received, or it is clear that there
8140 is no mapping or key sequence for the received characters. For
8141 example: if you have mapped "vl" and Vim has received 'v', the next
8142 character is needed to see if the 'v' is followed by an 'l'.
8143 When one of the options is on, Vim will wait for about 1 second for
8144 the next character to arrive. After that the already received
8145 characters are interpreted as single characters. The waiting time can
8146 be changed with the 'timeoutlen' option.
8147 On slow terminals or very busy systems timing out may cause
8148 malfunctioning cursor keys. If both options are off, Vim waits
8149 forever after an entered <Esc> if there are key codes that start
8150 with <Esc>. You will have to type <Esc> twice. If you do not have
8151 problems with key codes, but would like to have :mapped key
8152 sequences not timing out in 1 second, set the 'ttimeout' option and
8153 reset the 'timeout' option.
8154
8155 NOTE: 'ttimeout' is reset when 'compatible' is set.
8156
8157 *'timeoutlen'* *'tm'*
8158'timeoutlen' 'tm' number (default 1000)
8159 global
8160 {not in all versions of Vi}
8161 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008162'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 global
8164 {not in Vi}
8165 The time in milliseconds that is waited for a key code or mapped key
8166 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8167 when part of a command has been typed.
8168 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8169 different timeout value for key codes is desired set 'ttimeoutlen' to
8170 a non-negative number.
8171
8172 ttimeoutlen mapping delay key code delay ~
8173 < 0 'timeoutlen' 'timeoutlen'
8174 >= 0 'timeoutlen' 'ttimeoutlen'
8175
8176 The timeout only happens when the 'timeout' and 'ttimeout' options
8177 tell so. A useful setting would be >
8178 :set timeout timeoutlen=3000 ttimeoutlen=100
8179< (time out on mapping after three seconds, time out on key codes after
8180 a tenth of a second).
8181
8182 *'title'* *'notitle'*
8183'title' boolean (default off, on when title can be restored)
8184 global
8185 {not in Vi}
8186 {not available when compiled without the |+title|
8187 feature}
8188 When on, the title of the window will be set to the value of
8189 'titlestring' (if it is not empty), or to:
8190 filename [+=-] (path) - VIM
8191 Where:
8192 filename the name of the file being edited
8193 - indicates the file cannot be modified, 'ma' off
8194 + indicates the file was modified
8195 = indicates the file is read-only
8196 =+ indicates the file is read-only and modified
8197 (path) is the path of the file being edited
8198 - VIM the server name |v:servername| or "VIM"
8199 Only works if the terminal supports setting window titles
8200 (currently Amiga console, Win32 console, all GUI versions and
8201 terminals with a non- empty 't_ts' option - these are Unix xterm and
8202 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8203 *X11*
8204 When Vim was compiled with HAVE_X11 defined, the original title will
8205 be restored if possible. The output of ":version" will include "+X11"
8206 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8207 works for the icon name |'icon'|.
8208 But: When Vim was started with the |-X| argument, restoring the title
8209 will not work (except in the GUI).
8210 If the title cannot be restored, it is set to the value of 'titleold'.
8211 You might want to restore the title outside of Vim then.
8212 When using an xterm from a remote machine you can use this command:
8213 rsh machine_name xterm -display $DISPLAY &
8214 then the WINDOWID environment variable should be inherited and the
8215 title of the window should change back to what it should be after
8216 exiting Vim.
8217
8218 *'titlelen'*
8219'titlelen' number (default 85)
8220 global
8221 {not in Vi}
8222 {not available when compiled without the |+title|
8223 feature}
8224 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008225 title. When the title is longer, only the end of the path name is
8226 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227 Using a percentage makes this adapt to the width of the window. But
8228 it won't work perfectly, because the actual number of characters
8229 available also depends on the font used and other things in the title
8230 bar. When 'titlelen' is zero the full path is used. Otherwise,
8231 values from 1 to 30000 percent can be used.
8232 'titlelen' is also used for the 'titlestring' option.
8233
8234 *'titleold'*
8235'titleold' string (default "Thanks for flying Vim")
8236 global
8237 {not in Vi}
8238 {only available when compiled with the |+title|
8239 feature}
8240 This option will be used for the window title when exiting Vim if the
8241 original title cannot be restored. Only happens if 'title' is on or
8242 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008243 This option cannot be set from a |modeline| or in the |sandbox|, for
8244 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008245 *'titlestring'*
8246'titlestring' string (default "")
8247 global
8248 {not in Vi}
8249 {not available when compiled without the |+title|
8250 feature}
8251 When this option is not empty, it will be used for the title of the
8252 window. This happens only when the 'title' option is on.
8253 Only works if the terminal supports setting window titles (currently
8254 Amiga console, Win32 console, all GUI versions and terminals with a
8255 non-empty 't_ts' option).
8256 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008257 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008258 When this option contains printf-style '%' items, they will be
8259 expanded according to the rules used for 'statusline'.
8260 Example: >
8261 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8262 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8263< The value of 'titlelen' is used to align items in the middle or right
8264 of the available space.
8265 Some people prefer to have the file name first: >
8266 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8267< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008268 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008269 separating space only when needed.
8270 NOTE: Use of special characters in 'titlestring' may cause the display
8271 to be garbled (e.g., when it contains a CR or NL character).
8272 {not available when compiled without the |+statusline| feature}
8273
8274 *'toolbar'* *'tb'*
8275'toolbar' 'tb' string (default "icons,tooltips")
8276 global
8277 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8278 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008279 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008280 possible values are:
8281 icons Toolbar buttons are shown with icons.
8282 text Toolbar buttons shown with text.
8283 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008284 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008285 tooltips Tooltips are active for toolbar buttons.
8286 Tooltips refer to the popup help text which appears after the mouse
8287 cursor is placed over a toolbar button for a brief moment.
8288
8289 If you want the toolbar to be shown with icons as well as text, do the
8290 following: >
8291 :set tb=icons,text
8292< Motif and Athena cannot display icons and text at the same time. They
8293 will show icons if both are requested.
8294
8295 If none of the strings specified in 'toolbar' are valid or if
8296 'toolbar' is empty, this option is ignored. If you want to disable
8297 the toolbar, you need to set the 'guioptions' option. For example: >
8298 :set guioptions-=T
8299< Also see |gui-toolbar|.
8300
8301 *'toolbariconsize'* *'tbis'*
8302'toolbariconsize' 'tbis' string (default "small")
8303 global
8304 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008305 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008307 tiny Use tiny icons.
8308 small Use small icons (default).
8309 medium Use medium-sized icons.
8310 large Use large icons.
8311 huge Use even larger icons.
8312 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008314 the current theme. Common dimensions are giant=48x48, huge=32x32,
8315 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316
8317 If 'toolbariconsize' is empty, the global default size as determined
8318 by user preferences or the current theme is used.
8319
8320 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8321'ttybuiltin' 'tbi' boolean (default on)
8322 global
8323 {not in Vi}
8324 When on, the builtin termcaps are searched before the external ones.
8325 When off the builtin termcaps are searched after the external ones.
8326 When this option is changed, you should set the 'term' option next for
8327 the change to take effect, for example: >
8328 :set notbi term=$TERM
8329< See also |termcap|.
8330 Rationale: The default for this option is "on", because the builtin
8331 termcap entries are generally better (many systems contain faulty
8332 xterm entries...).
8333
8334 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8335'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8336 sun-cmd, screen, rxvt, dtterm or
8337 iris-ansi; also on when running Vim in
8338 a DOS console)
8339 global
8340 {not in Vi}
8341 Indicates a fast terminal connection. More characters will be sent to
8342 the screen for redrawing, instead of using insert/delete line
8343 commands. Improves smoothness of redrawing when there are multiple
8344 windows and the terminal does not support a scrolling region.
8345 Also enables the extra writing of characters at the end of each screen
8346 line for lines that wrap. This helps when using copy/paste with the
8347 mouse in an xterm and other terminals.
8348
8349 *'ttymouse'* *'ttym'*
8350'ttymouse' 'ttym' string (default depends on 'term')
8351 global
8352 {not in Vi}
8353 {only in Unix and VMS, doesn't work in the GUI; not
8354 available when compiled without |+mouse|}
8355 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008356 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357 *xterm-mouse*
8358 xterm xterm-like mouse handling. The mouse generates
8359 "<Esc>[Mscr", where "scr" is three bytes:
8360 "s" = button state
8361 "c" = column plus 33
8362 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008363 This only works up to 223 columns! See "dec",
8364 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365 xterm2 Works like "xterm", but with the xterm reporting the
8366 mouse position while the mouse is dragged. This works
8367 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008368 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369 work. See below for how Vim detects this
8370 automatically.
8371 *netterm-mouse*
8372 netterm NetTerm mouse handling. The mouse generates
8373 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8374 for the row and column.
8375 *dec-mouse*
8376 dec DEC terminal mouse handling. The mouse generates a
8377 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008378 This is also available for an Xterm, if it was
8379 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380 *jsbterm-mouse*
8381 jsbterm JSB term mouse handling.
8382 *pterm-mouse*
8383 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008384 *urxvt-mouse*
8385 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008386 The mouse works only if the terminal supports this
8387 encoding style, but it does not have 223 columns limit
8388 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008389 *sgr-mouse*
8390 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008391 mouse reporting. The mouse works even in columns
8392 beyond 223. This option is backward compatible with
8393 "xterm2" because it can also decode "xterm2" style
8394 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008395
8396 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008397 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8398 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008399 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8400 recognized, if enabled at compile time. DEC terminal mouse codes
8401 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008402 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8403 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008404 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008405 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8406 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8407 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008408 Additionally, if vim is compiled with the |+termresponse| feature and
8409 |t_RV| is set to the escape sequence to request the xterm version
8410 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02008412 from 95 to 276. The "sgr" value will be set if the xterm version is
Bram Moolenaar2f058492017-11-30 20:27:52 +01008413 277 or higher and when Vim detects Mac Terminal.app or iTerm2.
Bram Moolenaare968e362014-05-13 20:23:24 +02008414 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8415 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 :set t_RV=
8417<
8418 *'ttyscroll'* *'tsl'*
8419'ttyscroll' 'tsl' number (default 999)
8420 global
8421 Maximum number of lines to scroll the screen. If there are more lines
8422 to scroll the window is redrawn. For terminals where scrolling is
8423 very slow and redrawing is not slow this can be set to a small number,
8424 e.g., 3, to speed up displaying.
8425
8426 *'ttytype'* *'tty'*
8427'ttytype' 'tty' string (default from $TERM)
8428 global
8429 Alias for 'term', see above.
8430
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008431 *'undodir'* *'udir'*
8432'undodir' 'udir' string (default ".")
8433 global
8434 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008435 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008436 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008437 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008438 "." means using the directory of the file. The undo file name for
8439 "file.txt" is ".file.txt.un~".
8440 For other directories the file name is the full path of the edited
8441 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008442 When writing: The first directory that exists is used. "." always
8443 works, no directories after "." will be used for writing.
8444 When reading all entries are tried to find an undo file. The first
8445 undo file that exists is used. When it cannot be read an error is
8446 given, no further entry is used.
8447 See |undo-persistence|.
8448
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008449 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008450'undofile' 'udf' boolean (default off)
8451 local to buffer
8452 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008453 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008454 When on, Vim automatically saves undo history to an undo file when
8455 writing a buffer to a file, and restores undo history from the same
8456 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008457 The directory where the undo file is stored is specified by 'undodir'.
8458 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008459 The undo file is not read when 'undoreload' causes the buffer from
8460 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008461 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008462 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008463
Bram Moolenaar071d4272004-06-13 20:20:40 +00008464 *'undolevels'* *'ul'*
8465'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8466 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008467 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008468 {not in Vi}
8469 Maximum number of changes that can be undone. Since undo information
8470 is kept in memory, higher numbers will cause more memory to be used
8471 (nevertheless, a single change can use an unlimited amount of memory).
8472 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8473 itself: >
8474 set ul=0
8475< But you can also get Vi compatibility by including the 'u' flag in
8476 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008477 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008478 Set to -1 for no undo at all. You might want to do this only for the
8479 current buffer: >
8480 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008481< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008482
8483 The local value is set to -123456 when the global value is to be used.
8484
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008485 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008486
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008487 *'undoreload'* *'ur'*
8488'undoreload' 'ur' number (default 10000)
8489 global
8490 {not in Vi}
8491 Save the whole buffer for undo when reloading it. This applies to the
8492 ":e!" command and reloading for when the buffer changed outside of
8493 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008494 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008495 of lines is smaller than the value of this option.
8496 Set this option to zero to disable undo for a reload.
8497
8498 When saving undo for a reload, any undo file is not read.
8499
8500 Note that this causes the whole buffer to be stored in memory. Set
8501 this option to a lower value if you run out of memory.
8502
Bram Moolenaar071d4272004-06-13 20:20:40 +00008503 *'updatecount'* *'uc'*
8504'updatecount' 'uc' number (default: 200)
8505 global
8506 {not in Vi}
8507 After typing this many characters the swap file will be written to
8508 disk. When zero, no swap file will be created at all (see chapter on
8509 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8510 Vim with the "-n" option, see |startup|. When editing in readonly
8511 mode this option will be initialized to 10000.
8512 The swapfile can be disabled per buffer with |'swapfile'|.
8513 When 'updatecount' is set from zero to non-zero, swap files are
8514 created for all buffers that have 'swapfile' set. When 'updatecount'
8515 is set to zero, existing swap files are not deleted.
8516 Also see |'swapsync'|.
8517 This option has no meaning in buffers where |'buftype'| is "nofile"
8518 or "nowrite".
8519
8520 *'updatetime'* *'ut'*
8521'updatetime' 'ut' number (default 4000)
8522 global
8523 {not in Vi}
8524 If this many milliseconds nothing is typed the swap file will be
8525 written to disk (see |crash-recovery|). Also used for the
8526 |CursorHold| autocommand event.
8527
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008528 *'varsofttabstop'* *'vsts'*
8529'varsofttabstop' 'vsts' string (default "")
8530 local to buffer
8531 {only available when compiled with the |+vartabs|
8532 feature}
8533 {not in Vi}
8534 A list of the number of spaces that a <Tab> counts for while editing,
8535 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8536 width <Tab>s are being inserted, while in fact a mixture of spaces
8537 and <Tab>s is used. Tab widths are separated with commas, with the
8538 final value applying to all subsequent tabs.
8539
8540 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008541 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008542 to use the following: >
8543 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008544< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8545 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008546
8547 Note that the value of |'softtabstop'| will be ignored while
8548 'varsofttabstop' is set.
8549
8550 *'vartabstop'* *'vts'*
8551'vartabstop' 'vts' string (default "")
8552 local to buffer
8553 {only available when compiled with the |+vartabs|
8554 feature}
8555 {not in Vi}
8556 A list of the number of spaces that a <Tab> in the file counts for,
8557 separated by commas. Each value corresponds to one tab, with the
8558 final value applying to all subsequent tabs. For example: >
8559 :set vartabstop=4,20,10,8
8560< This will make the first tab 4 spaces wide, the second 20 spaces,
8561 the third 10 spaces, and all following tabs 8 spaces.
8562
8563 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8564 is set.
8565
Bram Moolenaar071d4272004-06-13 20:20:40 +00008566 *'verbose'* *'vbs'*
8567'verbose' 'vbs' number (default 0)
8568 global
8569 {not in Vi, although some versions have a boolean
8570 verbose option}
8571 When bigger than zero, Vim will give messages about what it is doing.
8572 Currently, these messages are given:
8573 >= 1 When the viminfo file is read or written.
8574 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008575 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008576 >= 8 Files for which a group of autocommands is executed.
8577 >= 9 Every executed autocommand.
8578 >= 12 Every executed function.
8579 >= 13 When an exception is thrown, caught, finished, or discarded.
8580 >= 14 Anything pending in a ":finally" clause.
8581 >= 15 Every executed Ex command (truncated at 200 characters).
8582
8583 This option can also be set with the "-V" argument. See |-V|.
8584 This option is also set by the |:verbose| command.
8585
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008586 When the 'verbosefile' option is set then the verbose messages are not
8587 displayed.
8588
8589 *'verbosefile'* *'vfile'*
8590'verbosefile' 'vfile' string (default empty)
8591 global
8592 {not in Vi}
8593 When not empty all messages are written in a file with this name.
8594 When the file exists messages are appended.
8595 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008596 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008597 Setting 'verbosefile' to a new value is like making it empty first.
8598 The difference with |:redir| is that verbose messages are not
8599 displayed when 'verbosefile' is set.
8600
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 *'viewdir'* *'vdir'*
8602'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8603 "$VIM/vimfiles/view",
8604 for Unix: "~/.vim/view",
8605 for Macintosh: "$VIM:vimfiles:view"
8606 for VMS: "sys$login:vimfiles/view"
8607 for RiscOS: "Choices:vimfiles/view")
8608 global
8609 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008610 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008611 feature}
8612 Name of the directory where to store files for |:mkview|.
8613 This option cannot be set from a |modeline| or in the |sandbox|, for
8614 security reasons.
8615
8616 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008617'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008618 global
8619 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008620 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008621 feature}
8622 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008623 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008624 word save and restore ~
8625 cursor cursor position in file and in window
8626 folds manually created folds, opened/closed folds and local
8627 fold options
8628 options options and mappings local to a window or buffer (not
8629 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008630 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008631 slash backslashes in file names replaced with forward
8632 slashes
8633 unix with Unix end-of-line format (single <NL>), even when
8634 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008635 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008636
8637 "slash" and "unix" are useful on Windows when sharing view files
8638 with Unix. The Unix version of Vim cannot source dos format scripts,
8639 but the Windows version of Vim can source unix format scripts.
8640
8641 *'viminfo'* *'vi'* *E526* *E527* *E528*
8642'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008643 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8644 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8645 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008646 global
8647 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008648 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008649 feature}
8650 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008651 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8652 "NONE".
8653 The string should be a comma separated list of parameters, each
8654 consisting of a single character identifying the particular parameter,
8655 followed by a number or string which specifies the value of that
8656 parameter. If a particular character is left out, then the default
8657 value is used for that parameter. The following is a list of the
8658 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008659 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008660 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 ! When included, save and restore global variables that start
8662 with an uppercase letter, and don't contain a lowercase
8663 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008664 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008665 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008666 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008667 " Maximum number of lines saved for each register. Old name of
8668 the '<' item, with the disadvantage that you need to put a
8669 backslash before the ", otherwise it will be recognized as the
8670 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008671 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008672 % When included, save and restore the buffer list. If Vim is
8673 started with a file name argument, the buffer list is not
8674 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008675 buffer list is restored from the viminfo file. Quickfix
8676 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8677 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008678 When followed by a number, the number specifies the maximum
8679 number of buffers that are stored. Without a number all
8680 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008681 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008682 ' Maximum number of previously edited files for which the marks
8683 are remembered. This parameter must always be included when
8684 'viminfo' is non-empty.
8685 Including this item also means that the |jumplist| and the
8686 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008687 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008688 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008689 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008690 patterns are also saved. When not included, the value of
8691 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008692 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008693 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008694 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008695 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 < Maximum number of lines saved for each register. If zero then
8697 registers are not saved. When not included, all lines are
8698 saved. '"' is the old name for this item.
8699 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008700 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008701 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008702 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008703 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008704 c When included, convert the text in the viminfo file from the
8705 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008706 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008707 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008708 f Whether file marks need to be stored. If zero, file marks ('0
8709 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008710 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008711 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008712 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713 h Disable the effect of 'hlsearch' when loading the viminfo
8714 file. When not included, it depends on whether ":nohlsearch"
8715 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008716 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008717 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008718 the 'n'. Must be at the end of the option! If the
8719 'viminfofile' option is set, that file name overrides the one
8720 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008721 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008722 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008723 r Removable media. The argument is a string (up to the next
8724 ','). This parameter can be given several times. Each
8725 specifies the start of a path for which no marks will be
8726 stored. This is to avoid removable media. For MS-DOS you
8727 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8728 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8729 ignored. Maximum length of each 'r' argument is 50
8730 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008731 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 s Maximum size of an item in Kbyte. If zero then registers are
8733 not saved. Currently only applies to registers. The default
8734 "s10" will exclude registers with more than 10 Kbyte of text.
8735 Also see the '<' item above: line count limit.
8736
8737 Example: >
8738 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8739<
8740 '50 Marks will be remembered for the last 50 files you
8741 edited.
8742 <1000 Contents of registers (up to 1000 lines each) will be
8743 remembered.
8744 s100 Registers with more than 100 Kbyte text are skipped.
8745 :0 Command-line history will not be saved.
8746 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8747 no / Since '/' is not specified, the default will be used,
8748 that is, save all of the search history, and also the
8749 previous search and substitute patterns.
8750 no % The buffer list will not be saved nor read back.
8751 no h 'hlsearch' highlighting will be restored.
8752
8753 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8754 load the contents of the file, this is not done automatically.
8755
8756 This option cannot be set from a |modeline| or in the |sandbox|, for
8757 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008758 NOTE: This option is set to the Vim default value when 'compatible'
8759 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008761 *'viminfofile'* *'vif'*
8762'viminfofile' 'vif' string (default: "")
8763 global
8764 {not in Vi}
8765 {not available when compiled without the |+viminfo|
8766 feature}
8767 When non-empty, overrides the file name used for viminfo.
8768 When equal to "NONE" no viminfo file will be read or written.
8769 This option can be set with the |-i| command line flag. The |--clean|
8770 command line flag sets it to "NONE".
8771
Bram Moolenaar071d4272004-06-13 20:20:40 +00008772 *'virtualedit'* *'ve'*
8773'virtualedit' 've' string (default "")
8774 global
8775 {not in Vi}
8776 {not available when compiled without the
8777 |+virtualedit| feature}
8778 A comma separated list of these words:
8779 block Allow virtual editing in Visual block mode.
8780 insert Allow virtual editing in Insert mode.
8781 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008782 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008783
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008785 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 of the line. Useful for selecting a rectangle in Visual mode and
8787 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008788 "onemore" is not the same, it will only allow moving the cursor just
8789 after the last character of the line. This makes some commands more
8790 consistent. Previously the cursor was always past the end of the line
8791 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008792 break some plugins or Vim scripts. For example because |l| can move
8793 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008794 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008795 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008796 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008797 It doesn't make sense to combine "all" with "onemore", but you will
8798 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008799 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800
8801 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8802'visualbell' 'vb' boolean (default off)
8803 global
8804 {not in Vi}
Bram Moolenaar74675a62017-07-15 13:53:23 +02008805 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008806 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008807 use: >
8808 :set vb t_vb=
8809< If you want a short flash, you can use this on many terminals: >
8810 :set vb t_vb=[?5h$<100>[?5l
8811< Here $<100> specifies the time, you can use a smaller or bigger value
8812 to get a shorter or longer flash.
8813
8814 Note: Vim will limit the bell to once per half a second. This avoids
8815 having to wait for the flashing to finish when there are lots of
8816 bells, e.g. on key repeat. This also happens without 'visualbell'
8817 set.
8818
Bram Moolenaar071d4272004-06-13 20:20:40 +00008819 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8820 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8821 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008822
8823 Note: When the GUI starts, 't_vb' is reset to its default value. You
8824 might want to set it again in your |gvimrc|.
8825
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 Does not work on the Amiga, you always get a screen flash.
8827 Also see 'errorbells'.
8828
8829 *'warn'* *'nowarn'*
8830'warn' boolean (default on)
8831 global
8832 Give a warning message when a shell command is used while the buffer
8833 has been changed.
8834
8835 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8836'weirdinvert' 'wiv' boolean (default off)
8837 global
8838 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008839 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008840 It is provided for backwards compatibility with version 4.x.
8841 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8842 vice versa. Has no effect when the GUI is running.
8843
8844 *'whichwrap'* *'ww'*
8845'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8846 global
8847 {not in Vi}
8848 Allow specified keys that move the cursor left/right to move to the
8849 previous/next line when the cursor is on the first/last character in
8850 the line. Concatenate characters to allow this for these keys:
8851 char key mode ~
8852 b <BS> Normal and Visual
8853 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008854 h "h" Normal and Visual (not recommended)
8855 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008856 < <Left> Normal and Visual
8857 > <Right> Normal and Visual
8858 ~ "~" Normal
8859 [ <Left> Insert and Replace
8860 ] <Right> Insert and Replace
8861 For example: >
8862 :set ww=<,>,[,]
8863< allows wrap only when cursor keys are used.
8864 When the movement keys are used in combination with a delete or change
8865 operator, the <EOL> also counts for a character. This makes "3h"
8866 different from "3dh" when the cursor crosses the end of a line. This
8867 is also true for "x" and "X", because they do the same as "dl" and
8868 "dh". If you use this, you may also want to use the mapping
8869 ":map <BS> X" to make backspace delete the character in front of the
8870 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008871 When 'l' is included and it is used after an operator at the end of a
8872 line then it will not move to the next line. This makes "dl", "cl",
8873 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008874 NOTE: This option is set to the Vi default value when 'compatible' is
8875 set and to the Vim default value when 'compatible' is reset.
8876
8877 *'wildchar'* *'wc'*
8878'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8879 global
8880 {not in Vi}
8881 Character you have to type to start wildcard expansion in the
8882 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008883 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008884 The character is not recognized when used inside a macro. See
8885 'wildcharm' for that.
8886 Although 'wc' is a number option, you can set it to a special key: >
8887 :set wc=<Esc>
8888< NOTE: This option is set to the Vi default value when 'compatible' is
8889 set and to the Vim default value when 'compatible' is reset.
8890
8891 *'wildcharm'* *'wcm'*
8892'wildcharm' 'wcm' number (default: none (0))
8893 global
8894 {not in Vi}
8895 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008896 recognized when used inside a macro. You can find "spare" command-line
8897 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008898 you'll never actually type 'wildcharm', just use it in mappings that
8899 automatically invoke completion mode, e.g.: >
8900 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008901 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008902< Then after typing :ss you can use CTRL-P & CTRL-N.
8903
8904 *'wildignore'* *'wig'*
8905'wildignore' 'wig' string (default "")
8906 global
8907 {not in Vi}
8908 {not available when compiled without the |+wildignore|
8909 feature}
8910 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008911 patterns is ignored when expanding |wildcards|, completing file or
8912 directory names, and influences the result of |expand()|, |glob()| and
8913 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008914 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8915 Also see 'suffixes'.
8916 Example: >
8917 :set wildignore=*.o,*.obj
8918< The use of |:set+=| and |:set-=| is preferred when adding or removing
8919 a pattern from the list. This avoids problems when a future version
8920 uses another default.
8921
Bram Moolenaar94950a92010-12-02 16:01:29 +01008922
Bram Moolenaar81af9252010-12-10 20:35:50 +01008923 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008924'wildignorecase' 'wic' boolean (default off)
8925 global
8926 {not in Vi}
8927 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008928 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008929 Does not apply when the shell is used to expand wildcards, which
8930 happens when there are special characters.
8931
8932
Bram Moolenaar071d4272004-06-13 20:20:40 +00008933 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008934'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008935 global
8936 {not in Vi}
8937 {not available if compiled without the |+wildmenu|
8938 feature}
8939 When 'wildmenu' is on, command-line completion operates in an enhanced
8940 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8941 the possible matches are shown just above the command line, with the
8942 first match highlighted (overwriting the status line, if there is
8943 one). Keys that show the previous/next match, such as <Tab> or
8944 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8945 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8946 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008947 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008948 If there are more matches than can fit in the line, a ">" is shown on
8949 the right and/or a "<" is shown on the left. The status line scrolls
8950 as needed.
8951 The "wildmenu" mode is abandoned when a key is hit that is not used
8952 for selecting a completion.
8953 While the "wildmenu" is active the following keys have special
8954 meanings:
8955
8956 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8957 <Down> - in filename/menu name completion: move into a
8958 subdirectory or submenu.
8959 <CR> - in menu completion, when the cursor is just after a
8960 dot: move into a submenu.
8961 <Up> - in filename/menu name completion: move up into
8962 parent directory or parent menu.
8963
8964 This makes the menus accessible from the console |console-menus|.
8965
8966 If you prefer the <Left> and <Right> keys to move the cursor instead
8967 of selecting a different match, use this: >
8968 :cnoremap <Left> <Space><BS><Left>
8969 :cnoremap <Right> <Space><BS><Right>
8970<
8971 The "WildMenu" highlighting is used for displaying the current match
8972 |hl-WildMenu|.
8973
8974 *'wildmode'* *'wim'*
8975'wildmode' 'wim' string (Vim default: "full")
8976 global
8977 {not in Vi}
8978 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008979 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008980 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008981 first part specifies the behavior for the first use of 'wildchar',
8982 The second part for the second use, etc.
8983 These are the possible values for each part:
8984 "" Complete only the first match.
8985 "full" Complete the next full match. After the last match,
8986 the original string is used and then the first match
8987 again.
8988 "longest" Complete till longest common string. If this doesn't
8989 result in a longer string, use the next part.
8990 "longest:full" Like "longest", but also start 'wildmenu' if it is
8991 enabled.
8992 "list" When more than one match, list all matches.
8993 "list:full" When more than one match, list all matches and
8994 complete first match.
8995 "list:longest" When more than one match, list all matches and
8996 complete till longest common string.
8997 When there is only a single match, it is fully completed in all cases.
8998
8999 Examples: >
9000 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009001< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009002 :set wildmode=longest,full
9003< Complete longest common string, then each full match >
9004 :set wildmode=list:full
9005< List all matches and complete each full match >
9006 :set wildmode=list,full
9007< List all matches without completing, then each full match >
9008 :set wildmode=longest,list
9009< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009010 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009011
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009012 *'wildoptions'* *'wop'*
9013'wildoptions' 'wop' string (default "")
9014 global
9015 {not in Vi}
9016 {not available when compiled without the |+wildignore|
9017 feature}
9018 A list of words that change how command line completion is done.
9019 Currently only one word is allowed:
9020 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009021 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009022 is displayed per line. Often used tag kinds are:
9023 d #define
9024 f function
9025 Also see |cmdline-completion|.
9026
Bram Moolenaar071d4272004-06-13 20:20:40 +00009027 *'winaltkeys'* *'wak'*
9028'winaltkeys' 'wak' string (default "menu")
9029 global
9030 {not in Vi}
9031 {only used in Win32, Motif, GTK and Photon GUI}
9032 Some GUI versions allow the access to menu entries by using the ALT
9033 key in combination with a character that appears underlined in the
9034 menu. This conflicts with the use of the ALT key for mappings and
9035 entering special characters. This option tells what to do:
9036 no Don't use ALT keys for menus. ALT key combinations can be
9037 mapped, but there is no automatic handling. This can then be
9038 done with the |:simalt| command.
9039 yes ALT key handling is done by the windowing system. ALT key
9040 combinations cannot be mapped.
9041 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009042 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009043 keys can be mapped.
9044 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9045 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009046 This option is not used for <F10>; on Win32 and with GTK <F10> will
9047 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009049 *'window'* *'wi'*
9050'window' 'wi' number (default screen height - 1)
9051 global
9052 Window height. Do not confuse this with the height of the Vim window,
9053 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00009054 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
9055 value is smaller than 'lines' minus one. The screen will scroll
9056 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009057 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9058 in a much smarter way, taking care of wrapping lines.
9059 When resizing the Vim window, the value is smaller than 1 or more than
9060 or equal to 'lines' it will be set to 'lines' minus 1.
9061 {Vi also uses the option to specify the number of displayed lines}
9062
Bram Moolenaar071d4272004-06-13 20:20:40 +00009063 *'winheight'* *'wh'* *E591*
9064'winheight' 'wh' number (default 1)
9065 global
9066 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009067 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009068 feature}
9069 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009070 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009071 focus goes to a window that is smaller, its size is increased, at the
9072 cost of the height of other windows.
9073 Set 'winheight' to a small number for normal editing.
9074 Set it to 999 to make the current window fill most of the screen.
9075 Other windows will be only 'winminheight' high. This has the drawback
9076 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9077 to create only two windows, set the option after startup is done,
9078 using the |VimEnter| event: >
9079 au VimEnter * set winheight=999
9080< Minimum value is 1.
9081 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009082 height of the current window.
9083 'winheight' applies to the current window. Use 'winminheight' to set
9084 the minimal height for other windows.
9085
9086 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9087'winfixheight' 'wfh' boolean (default off)
9088 local to window
9089 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009090 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009091 feature}
9092 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009093 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9094 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009095 The height may be changed anyway when running out of room.
9096
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009097 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9098'winfixwidth' 'wfw' boolean (default off)
9099 local to window
9100 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009101 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009102 feature}
9103 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009104 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009105 The width may be changed anyway when running out of room.
9106
Bram Moolenaar071d4272004-06-13 20:20:40 +00009107 *'winminheight'* *'wmh'*
9108'winminheight' 'wmh' number (default 1)
9109 global
9110 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009111 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009112 feature}
9113 The minimal height of a window, when it's not the current window.
9114 This is a hard minimum, windows will never become smaller.
9115 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9116 status bar) if necessary. They will return to at least one line when
9117 they become active (since the cursor has to have somewhere to go.)
9118 Use 'winheight' to set the minimal height of the current window.
9119 This option is only checked when making a window smaller. Don't use a
9120 large number, it will cause errors when opening more than a few
9121 windows. A value of 0 to 3 is reasonable.
9122
9123 *'winminwidth'* *'wmw'*
9124'winminwidth' 'wmw' number (default 1)
9125 global
9126 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009127 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009128 feature}
9129 The minimal width of a window, when it's not the current window.
9130 This is a hard minimum, windows will never become smaller.
9131 When set to zero, windows may be "squashed" to zero columns (i.e. just
9132 a vertical separator) if necessary. They will return to at least one
9133 line when they become active (since the cursor has to have somewhere
9134 to go.)
9135 Use 'winwidth' to set the minimal width of the current window.
9136 This option is only checked when making a window smaller. Don't use a
9137 large number, it will cause errors when opening more than a few
9138 windows. A value of 0 to 12 is reasonable.
9139
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009140 *'winptydll'*
9141'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9142 global
9143 {not in Vi}
9144 {only available when compiled with the |terminal|
9145 feature on MS-Windows}
9146 Specifies the name of the winpty shared library, used for the
9147 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009148 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009149 a fallback.
9150 Environment variables are expanded |:set_env|.
9151 This option cannot be set from a |modeline| or in the |sandbox|, for
9152 security reasons.
9153
Bram Moolenaar071d4272004-06-13 20:20:40 +00009154 *'winwidth'* *'wiw'* *E592*
9155'winwidth' 'wiw' number (default 20)
9156 global
9157 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009158 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009159 feature}
9160 Minimal number of columns for the current window. This is not a hard
9161 minimum, Vim will use fewer columns if there is not enough room. If
9162 the current window is smaller, its size is increased, at the cost of
9163 the width of other windows. Set it to 999 to make the current window
9164 always fill the screen. Set it to a small number for normal editing.
9165 The width is not adjusted after one of the commands to change the
9166 width of the current window.
9167 'winwidth' applies to the current window. Use 'winminwidth' to set
9168 the minimal width for other windows.
9169
9170 *'wrap'* *'nowrap'*
9171'wrap' boolean (default on)
9172 local to window
9173 {not in Vi}
9174 This option changes how text is displayed. It doesn't change the text
9175 in the buffer, see 'textwidth' for that.
9176 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009177 displaying continues on the next line. When off lines will not wrap
9178 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009179 moved to a part that is not shown, the screen will scroll
9180 horizontally.
9181 The line will be broken in the middle of a word if necessary. See
9182 'linebreak' to get the break at a word boundary.
9183 To make scrolling horizontally a bit more useful, try this: >
9184 :set sidescroll=5
9185 :set listchars+=precedes:<,extends:>
9186< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009187 This option can't be set from a |modeline| when the 'diff' option is
9188 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009189
9190 *'wrapmargin'* *'wm'*
9191'wrapmargin' 'wm' number (default 0)
9192 local to buffer
9193 Number of characters from the right window border where wrapping
9194 starts. When typing text beyond this limit, an <EOL> will be inserted
9195 and inserting continues on the next line.
9196 Options that add a margin, such as 'number' and 'foldcolumn', cause
9197 the text width to be further reduced. This is Vi compatible.
9198 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009199 This option is set to 0 when 'paste' is set and restored when 'paste'
9200 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009201 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
9202 and less usefully}
9203
9204 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9205'wrapscan' 'ws' boolean (default on) *E384* *E385*
9206 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009207 Searches wrap around the end of the file. Also applies to |]s| and
9208 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009209
9210 *'write'* *'nowrite'*
9211'write' boolean (default on)
9212 global
9213 {not in Vi}
9214 Allows writing files. When not set, writing a file is not allowed.
9215 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009216 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009217 argument. Filtering text is still possible, even though this requires
9218 writing a temporary file.
9219
9220 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9221'writeany' 'wa' boolean (default off)
9222 global
9223 Allows writing to any file with no need for "!" override.
9224
9225 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9226'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9227 otherwise)
9228 global
9229 {not in Vi}
9230 Make a backup before overwriting a file. The backup is removed after
9231 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009232 also on.
9233 WARNING: Switching this option off means that when Vim fails to write
9234 your buffer correctly and then, for whatever reason, Vim exits, you
9235 lose both the original file and what you were writing. Only reset
9236 this option if your file system is almost full and it makes the write
9237 fail (and make sure not to exit Vim until the write was successful).
9238 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009239 When the 'backupskip' pattern matches, a backup is not made anyway.
9240 NOTE: This option is set to the default value when 'compatible' is
9241 set.
9242
9243 *'writedelay'* *'wd'*
9244'writedelay' 'wd' number (default 0)
9245 global
9246 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009247 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009248 screen. When non-zero, characters are sent to the terminal one by
9249 one. For MS-DOS pcterm this does not work. For debugging purposes.
9250
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009251 vim:tw=78:ts=8:noet:ft=help:norl: