blob: 008926f63e12dc1f3b262de28c525fda838ebe87 [file] [log] [blame]
Bram Moolenaarc8c88492018-12-27 23:59:26 +01001*options.txt* For Vim version 8.1. Last change: 2018 Dec 27
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
Bram 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 Moolenaar95bafa22018-10-02 13:26:25 +0200123< shiftwidth=4 ~
124 Last set from modeline line 1 ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000127This 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:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200135 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136 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 "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001060 the backup file name will be built from the complete path to the
1061 file with all path separators changed to percent '%' signs. This
1062 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001063 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
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001641 register "*. See |'go-a'| and |quotestar| for details.
1642 When the GUI is active, the 'a' flag in 'guioptions'
1643 is used, when the GUI is not active, this "autoselect"
1644 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645 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
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002002 *'conceallevel'* *'cole'*
2003'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002004 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 Moolenaara86187b2018-12-16 18:20:00 +01002373'cryptmethod' 'cm' string (default "blowfish2")
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
Bram Moolenaara86187b2018-12-16 18:20:00 +01002404 the value "blowfish2". When setting the local value to an empty
2405 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002406
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'*
Bram Moolenaarc93262b2018-09-10 21:15:40 +02002618'diffopt' 'dip' string (default "internal,filler")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619 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
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002637 iblank Ignore changes where lines are all blank. Adds
2638 the "-B" flag to the "diff" command if
2639 'diffexpr' is empty. Check the documentation
2640 of the "diff" command for what this does
2641 exactly.
2642 NOTE: the diff windows will get out of sync,
2643 because no differences between blank lines are
2644 taken into account.
2645
Bram Moolenaar071d4272004-06-13 20:20:40 +00002646 icase Ignore changes in case of text. "a" and "A"
2647 are considered the same. Adds the "-i" flag
2648 to the "diff" command if 'diffexpr' is empty.
2649
2650 iwhite Ignore changes in amount of white space. Adds
2651 the "-b" flag to the "diff" command if
2652 'diffexpr' is empty. Check the documentation
2653 of the "diff" command for what this does
2654 exactly. It should ignore adding trailing
2655 white space, but not leading white space.
2656
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002657 iwhiteall Ignore all white space changes. Adds
2658 the "-w" flag to the "diff" command if
2659 'diffexpr' is empty. Check the documentation
2660 of the "diff" command for what this does
2661 exactly.
2662
2663 iwhiteeol Ignore white space changes at end of line.
2664 Adds the "-Z" flag to the "diff" command if
2665 'diffexpr' is empty. Check the documentation
2666 of the "diff" command for what this does
2667 exactly.
2668
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002669 horizontal Start diff mode with horizontal splits (unless
2670 explicitly specified otherwise).
2671
2672 vertical Start diff mode with vertical splits (unless
2673 explicitly specified otherwise).
2674
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002675 hiddenoff Do not use diff mode for a buffer when it
2676 becomes hidden.
2677
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002678 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2679 starting diff mode. Without this 2 is used.
2680
Bram Moolenaare828b762018-09-10 17:51:58 +02002681 internal Use the internal diff library. This is
2682 ignored when 'diffexpr' is set. *E960*
2683 When running out of memory when writing a
2684 buffer this item will be ignored for diffs
2685 involving that buffer. Set the 'verbose'
2686 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687
Bram Moolenaare828b762018-09-10 17:51:58 +02002688 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002689 Use the indent heuristic for the internal
2690 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002691
2692 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002693 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002694 algorithms are:
2695 myers the default algorithm
2696 minimal spend extra time to generate the
2697 smallest possible diff
2698 patience patience diff algorithm
2699 histogram histogram diff algorithm
2700
2701 Examples: >
2702 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002704 :set diffopt=internal,filler,foldcolumn:3
2705 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706<
2707 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2708'digraph' 'dg' boolean (default off)
2709 global
2710 {not in Vi}
2711 {not available when compiled without the |+digraphs|
2712 feature}
2713 Enable the entering of digraphs in Insert mode with {char1} <BS>
2714 {char2}. See |digraphs|.
2715 NOTE: This option is reset when 'compatible' is set.
2716
2717 *'directory'* *'dir'*
2718'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002719 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720 for Unix: ".,~/tmp,/var/tmp,/tmp")
2721 global
2722 List of directory names for the swap file, separated with commas.
2723 - The swap file will be created in the first directory where this is
2724 possible.
2725 - Empty means that no swap file will be used (recovery is
2726 impossible!).
2727 - A directory "." means to put the swap file in the same directory as
2728 the edited file. On Unix, a dot is prepended to the file name, so
2729 it doesn't show in a directory listing. On MS-Windows the "hidden"
2730 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002731 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732 put the swap file relative to where the edited file is. The leading
2733 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002734 - For Unix and Win32, if a directory ends in two path separators "//",
2735 the swap file name will be built from the complete path to the file
2736 with all path separators substituted to percent '%' signs. This will
2737 ensure file name uniqueness in the preserve directory.
2738 On Win32, it is also possible to end with "\\". However, When a
2739 separating comma is following, you must use "//", since "\\" will
2740 include the comma in the file name. Therefore it is recommended to
2741 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 - Spaces after the comma are ignored, other spaces are considered part
2743 of the directory name. To have a space at the start of a directory
2744 name, precede it with a backslash.
2745 - To include a comma in a directory name precede it with a backslash.
2746 - A directory name may end in an ':' or '/'.
2747 - Environment variables are expanded |:set_env|.
2748 - Careful with '\' characters, type one before a space, type two to
2749 get one in the option (see |option-backslash|), for example: >
2750 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2751< - For backwards compatibility with Vim version 3.0 a '>' at the start
2752 of the option is removed.
2753 Using "." first in the list is recommended. This means that editing
2754 the same file twice will result in a warning. Using "/tmp" on Unix is
2755 discouraged: When the system crashes you lose the swap file.
2756 "/var/tmp" is often not cleared when rebooting, thus is a better
2757 choice than "/tmp". But it can contain a lot of files, your swap
2758 files get lost in the crowd. That is why a "tmp" directory in your
2759 home directory is tried first.
2760 The use of |:set+=| and |:set-=| is preferred when adding or removing
2761 directories from the list. This avoids problems when a future version
2762 uses another default.
2763 This option cannot be set from a |modeline| or in the |sandbox|, for
2764 security reasons.
2765 {Vi: directory to put temp file in, defaults to "/tmp"}
2766
2767 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002768'display' 'dy' string (default "", set to "truncate" in
2769 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 global
2771 {not in Vi}
2772 Change the way text is displayed. This is comma separated list of
2773 flags:
2774 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002775 in a window will be displayed. "@@@" is put in the
2776 last columns of the last screen line to indicate the
2777 rest of the line is not displayed.
2778 truncate Like "lastline", but "@@@" is displayed in the first
2779 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 uhex Show unprintable characters hexadecimal as <xx>
2781 instead of using ^C and ~C.
2782
Bram Moolenaard0796902016-09-16 20:02:31 +02002783 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002784 doesn't fit is replaced with "@" lines.
2785
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 *'eadirection'* *'ead'*
2787'eadirection' 'ead' string (default "both")
2788 global
2789 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002790 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791 feature}
2792 Tells when the 'equalalways' option applies:
2793 ver vertically, width of windows is not affected
2794 hor horizontally, height of windows is not affected
2795 both width and height of windows is affected
2796
2797 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2798'edcompatible' 'ed' boolean (default off)
2799 global
2800 Makes the 'g' and 'c' flags of the ":substitute" command to be
2801 toggled each time the flag is given. See |complex-change|. See
2802 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002803 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804
Bram Moolenaar03413f42016-04-12 21:07:15 +02002805 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002806'emoji' 'emo' boolean (default: on)
2807 global
2808 {not in Vi}
2809 {only available when compiled with the |+multi_byte|
2810 feature}
2811 When on all Unicode emoji characters are considered to be full width.
2812
2813
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814 *'encoding'* *'enc'* *E543*
2815'encoding' 'enc' string (default: "latin1" or value from $LANG)
2816 global
2817 {only available when compiled with the |+multi_byte|
2818 feature}
2819 {not in Vi}
2820 Sets the character encoding used inside Vim. It applies to text in
2821 the buffers, registers, Strings in expressions, text stored in the
2822 viminfo file, etc. It sets the kind of characters which Vim can work
2823 with. See |encoding-names| for the possible values.
2824
2825 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002826 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002828 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829
Bram Moolenaar865242e2010-07-14 21:12:05 +02002830 This option cannot be set from a |modeline|. It would most likely
2831 corrupt the text.
2832
Bram Moolenaar3df01732017-02-17 22:47:16 +01002833 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2834 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002835 'encoding', "utf-8" is the natural choice for the environment and
2836 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002837 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838 versions, and to avoid changing the encoding of newly created files
2839 without your knowledge (in case 'fileencodings' is empty).
2840
2841 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002842 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843 iconv() or as specified with 'charconvert'.
2844
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002845 If you need to know whether 'encoding' is a multi-byte encoding, you
2846 can use: >
2847 if has("multi_byte_encoding")
2848<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849 Normally 'encoding' will be equal to your current locale. This will
2850 be the default if Vim recognizes your environment settings. If
2851 'encoding' is not set to the current locale, 'termencoding' must be
2852 set to convert typed and displayed text. See |encoding-table|.
2853
2854 When you set this option, it fires the |EncodingChanged| autocommand
2855 event so that you can set up fonts if necessary.
2856
2857 When the option is set, the value is converted to lowercase. Thus
2858 you can set it with uppercase values too. Underscores are translated
2859 to '-' signs.
2860 When the encoding is recognized, it is changed to the standard name.
2861 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2862 "iso-8859-2" and "utf8" becomes "utf-8".
2863
2864 Note: "latin1" is also used when the encoding could not be detected.
2865 This only works when editing files in the same encoding! When the
2866 actual character set is not latin1, make sure 'fileencoding' and
2867 'fileencodings' are empty. When conversion is needed, switch to using
2868 utf-8.
2869
2870 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2871 You don't notice this while editing, but it does matter for the
2872 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2873 setting 'encoding' to one of these values instead of utf-8 only has
2874 effect for encoding used for files when 'fileencoding' is empty.
2875
Bram Moolenaar661b1822005-07-28 22:36:45 +00002876 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2877 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878
2879 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2880'endofline' 'eol' boolean (default on)
2881 local to buffer
2882 {not in Vi}
2883 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002884 is on, or 'fixeol' option is off, no <EOL> will be written for the
2885 last line in the file. This option is automatically set or reset when
2886 starting to edit a new file, depending on whether file has an <EOL>
2887 for the last line in the file. Normally you don't have to set or
2888 reset this option.
2889 When 'binary' is off and 'fixeol' is on the value is not used when
2890 writing the file. When 'binary' is on or 'fixeol' is off it is used
2891 to remember the presence of a <EOL> for the last line in the file, so
2892 that when you write the file the situation from the original file can
2893 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894
2895 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2896'equalalways' 'ea' boolean (default on)
2897 global
2898 {not in Vi}
2899 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002900 splitting or closing a window. This also happens the moment the
2901 option is switched on. When off, splitting a window will reduce the
2902 size of the current window and leave the other windows the same. When
2903 closing a window the extra lines are given to the window next to it
2904 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 When mixing vertically and horizontally split windows, a minimal size
2906 is computed and some windows may be larger if there is room. The
2907 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002908 Changing the height and width of a window can be avoided by setting
2909 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002910 If a window size is specified when creating a new window sizes are
2911 currently not equalized (it's complicated, but may be implemented in
2912 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913
2914 *'equalprg'* *'ep'*
2915'equalprg' 'ep' string (default "")
2916 global or local to buffer |global-local|
2917 {not in Vi}
2918 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002919 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002920 or 'indentexpr'. When Vim was compiled without internal formatting,
2921 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002922 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 about including spaces and backslashes.
2924 This option cannot be set from a |modeline| or in the |sandbox|, for
2925 security reasons.
2926
2927 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2928'errorbells' 'eb' boolean (default off)
2929 global
2930 Ring the bell (beep or screen flash) for error messages. This only
2931 makes a difference for error messages, the bell will be used always
2932 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002933 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002934 screen flash or do nothing. See 'belloff' to finetune when to ring the
2935 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936
2937 *'errorfile'* *'ef'*
2938'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2939 others: "errors.err")
2940 global
2941 {not in Vi}
2942 {not available when compiled without the |+quickfix|
2943 feature}
2944 Name of the errorfile for the QuickFix mode (see |:cf|).
2945 When the "-q" command-line argument is used, 'errorfile' is set to the
2946 following argument. See |-q|.
2947 NOT used for the ":make" command. See 'makeef' for that.
2948 Environment variables are expanded |:set_env|.
2949 See |option-backslash| about including spaces and backslashes.
2950 This option cannot be set from a |modeline| or in the |sandbox|, for
2951 security reasons.
2952
2953 *'errorformat'* *'efm'*
2954'errorformat' 'efm' string (default is very long)
2955 global or local to buffer |global-local|
2956 {not in Vi}
2957 {not available when compiled without the |+quickfix|
2958 feature}
2959 Scanf-like description of the format for the lines in the error file
2960 (see |errorformat|).
2961
2962 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2963'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2964 global
2965 {not in Vi}
2966 Function keys that start with an <Esc> are recognized in Insert
2967 mode. When this option is off, the cursor and function keys cannot be
2968 used in Insert mode if they start with an <Esc>. The advantage of
2969 this is that the single <Esc> is recognized immediately, instead of
2970 after one second. Instead of resetting this option, you might want to
2971 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2972 when 'esckeys' is off, you can still map anything, but the cursor keys
2973 won't work by default.
2974 NOTE: This option is set to the Vi default value when 'compatible' is
2975 set and to the Vim default value when 'compatible' is reset.
2976
2977 *'eventignore'* *'ei'*
2978'eventignore' 'ei' string (default "")
2979 global
2980 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002982 When set to "all" or when "all" is one of the items, all autocommand
2983 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 Otherwise this is a comma separated list of event names. Example: >
2985 :set ei=WinEnter,WinLeave
2986<
2987 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2988'expandtab' 'et' boolean (default off)
2989 local to buffer
2990 {not in Vi}
2991 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002992 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2994 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002995 This option is reset when the 'paste' option is set and restored when
2996 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997 NOTE: This option is reset when 'compatible' is set.
2998
2999 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3000'exrc' 'ex' boolean (default off)
3001 global
3002 {not in Vi}
3003 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003004 directory.
3005
3006 Setting this option is a potential security leak. E.g., consider
3007 unpacking a package or fetching files from github, a .vimrc in there
3008 might be a trojan horse. BETTER NOT SET THIS OPTION!
3009 Instead, define an autocommand in your .vimrc to set options for a
3010 matching directory.
3011
3012 If you do switch this option on you should also consider setting the
3013 'secure' option (see |initialization|).
3014 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 This option cannot be set from a |modeline| or in the |sandbox|, for
3016 security reasons.
3017
3018 *'fileencoding'* *'fenc'* *E213*
3019'fileencoding' 'fenc' string (default: "")
3020 local to buffer
3021 {only available when compiled with the |+multi_byte|
3022 feature}
3023 {not in Vi}
3024 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003025
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003027 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 When 'fileencoding' is empty, the same value as 'encoding' will be
3029 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003030 No error will be given when the value is set, only when it is used,
3031 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003032 Conversion will also be done when 'encoding' and 'fileencoding' are
3033 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3034 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003036 'encoding' is "utf-8" or another Unicode encoding, conversion
3037 is most likely done in a way that the reverse conversion
3038 results in the same text. When 'encoding' is not "utf-8" some
3039 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003040
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 See 'encoding' for the possible values. Additionally, values may be
3042 specified that can be handled by the converter, see
3043 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003044
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 When reading a file 'fileencoding' will be set from 'fileencodings'.
3046 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003047 'fileencoding', use the |++enc| argument. One exception: when
3048 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003049 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003050
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3052 When the option is set, the value is converted to lowercase. Thus
3053 you can set it with uppercase values too. '_' characters are
3054 replaced with '-'. If a name is recognized from the list for
3055 'encoding', it is replaced by the standard name. For example
3056 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003057
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058 When this option is set, after starting to edit a file, the 'modified'
3059 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003060
3061 Keep in mind that changing 'fenc' from a modeline happens
3062 AFTER the text has been read, thus it applies to when the file will be
3063 written. If you do set 'fenc' in a modeline, you might want to set
3064 'nomodified' to avoid not being able to ":q".
3065
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 This option can not be changed when 'modifiable' is off.
3067
3068 *'fe'*
3069 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003070 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 old short name was 'fe', which is no longer used.
3072
3073 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003074'fileencodings' 'fencs' string (default: "ucs-bom",
3075 "ucs-bom,utf-8,default,latin1" when
3076 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077 global
3078 {only available when compiled with the |+multi_byte|
3079 feature}
3080 {not in Vi}
3081 This is a list of character encodings considered when starting to edit
3082 an existing file. When a file is read, Vim tries to use the first
3083 mentioned character encoding. If an error is detected, the next one
3084 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003085 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 an empty string, which means the value of 'encoding' is used.
3087 WARNING: Conversion can cause loss of information! When
3088 'encoding' is "utf-8" (or one of the other Unicode variants)
3089 conversion is most likely done in a way that the reverse
3090 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003091 "utf-8" some non-ASCII characters may be lost! You can use
3092 the |++bad| argument to specify what is done with characters
3093 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 For an empty file or a file with only ASCII characters most encodings
3095 will work and the first entry of 'fileencodings' will be used (except
3096 "ucs-bom", which requires the BOM to be present). If you prefer
3097 another encoding use an BufReadPost autocommand event to test if your
3098 preferred encoding is to be used. Example: >
3099 au BufReadPost * if search('\S', 'w') == 0 |
3100 \ set fenc=iso-2022-jp | endif
3101< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3102 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003103 When the |++enc| argument is used then the value of 'fileencodings' is
3104 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003105 Note that 'fileencodings' is not used for a new file, the global value
3106 of 'fileencoding' is used instead. You can set it with: >
3107 :setglobal fenc=iso-8859-2
3108< This means that a non-existing file may get a different encoding than
3109 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 The special value "ucs-bom" can be used to check for a Unicode BOM
3111 (Byte Order Mark) at the start of the file. It must not be preceded
3112 by "utf-8" or another Unicode encoding for this to work properly.
3113 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3114 because Vim cannot detect an error, thus the encoding is always
3115 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003116 The special value "default" can be used for the encoding from the
3117 environment. This is the default value for 'encoding'. It is useful
3118 when 'encoding' is set to "utf-8" and your environment uses a
3119 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003120 When 'encoding' is "utf-8" and a file contains an illegal byte
3121 sequence it won't be recognized as UTF-8. You can use the |8g8|
3122 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 WRONG VALUES: WHAT'S WRONG:
3124 latin1,utf-8 "latin1" will always be used
3125 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3126 file
3127 cp1250,latin1 "cp1250" will always be used
3128 If 'fileencodings' is empty, 'fileencoding' is not modified.
3129 See 'fileencoding' for the possible values.
3130 Setting this option does not have an effect until the next time a file
3131 is read.
3132
3133 *'fileformat'* *'ff'*
3134'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3135 Unix default: "unix",
3136 Macintosh default: "mac")
3137 local to buffer
3138 {not in Vi}
3139 This gives the <EOL> of the current buffer, which is used for
3140 reading/writing the buffer from/to a file:
3141 dos <CR> <NL>
3142 unix <NL>
3143 mac <CR>
3144 When "dos" is used, CTRL-Z at the end of a file is ignored.
3145 See |file-formats| and |file-read|.
3146 For the character encoding of the file see 'fileencoding'.
3147 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003148 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149 This option is set automatically when starting to edit a file and
3150 'fileformats' is not empty and 'binary' is off.
3151 When this option is set, after starting to edit a file, the 'modified'
3152 option is set, because the file would be different when written.
3153 This option can not be changed when 'modifiable' is off.
3154 For backwards compatibility: When this option is set to "dos",
3155 'textmode' is set, otherwise 'textmode' is reset.
3156
3157 *'fileformats'* *'ffs'*
3158'fileformats' 'ffs' string (default:
3159 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3160 Vim Unix: "unix,dos",
3161 Vim Mac: "mac,unix,dos",
3162 Vi Cygwin: "unix,dos",
3163 Vi others: "")
3164 global
3165 {not in Vi}
3166 This gives the end-of-line (<EOL>) formats that will be tried when
3167 starting to edit a new buffer and when reading a file into an existing
3168 buffer:
3169 - When empty, the format defined with 'fileformat' will be used
3170 always. It is not set automatically.
3171 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003172 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 'fileformats' name will be used when a file is read into an existing
3174 buffer, no matter what 'fileformat' for that buffer is set to.
3175 - When more than one name is present, separated by commas, automatic
3176 <EOL> detection will be done when reading a file. When starting to
3177 edit a file, a check is done for the <EOL>:
3178 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3179 'fileformat' is set to "dos".
3180 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003181 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003183 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3184 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003185 This means that "mac" is only chosen when:
3186 "unix" is not present or no <NL> is found in the file, and
3187 "dos" is not present or no <CR><NL> is found in the file.
3188 Except: if "unix" was chosen, but there is a <CR> before
3189 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003190 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 4. If 'fileformat' is still not set, the first name from
3192 'fileformats' is used.
3193 When reading a file into an existing buffer, the same is done, but
3194 this happens like 'fileformat' has been set appropriately for that
3195 file only, the option is not changed.
3196 When 'binary' is set, the value of 'fileformats' is not used.
3197
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003198 When Vim starts up with an empty buffer the first item is used. You
3199 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003200
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3202 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3203 done:
3204 - When 'fileformats' is empty, there is no automatic detection. Dos
3205 format will be used.
3206 - When 'fileformats' is set to one or more names, automatic detection
3207 is done. This is based on the first <NL> in the file: If there is a
3208 <CR> in front of it, Dos format is used, otherwise Unix format is
3209 used.
3210 Also see |file-formats|.
3211 For backwards compatibility: When this option is set to an empty
3212 string or one format (no comma is included), 'textauto' is reset,
3213 otherwise 'textauto' is set.
3214 NOTE: This option is set to the Vi default value when 'compatible' is
3215 set and to the Vim default value when 'compatible' is reset.
3216
Bram Moolenaarbf884932013-04-05 22:26:15 +02003217 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3218'fileignorecase' 'fic' boolean (default on for systems where case in file
3219 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003220 global
3221 {not in Vi}
3222 When set case is ignored when using file names and directories.
3223 See 'wildignorecase' for only ignoring case when doing completion.
3224
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 *'filetype'* *'ft'*
3226'filetype' 'ft' string (default: "")
3227 local to buffer
3228 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 When this option is set, the FileType autocommand event is triggered.
3230 All autocommands that match with the value of this option will be
3231 executed. Thus the value of 'filetype' is used in place of the file
3232 name.
3233 Otherwise this option does not always reflect the current file type.
3234 This option is normally set when the file type is detected. To enable
3235 this use the ":filetype on" command. |:filetype|
3236 Setting this option to a different value is most useful in a modeline,
3237 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003238 Example, for in an IDL file:
3239 /* vim: set filetype=idl : */ ~
3240 |FileType| |filetypes|
3241 When a dot appears in the value then this separates two filetype
3242 names. Example:
3243 /* vim: set filetype=c.doxygen : */ ~
3244 This will use the "c" filetype first, then the "doxygen" filetype.
3245 This works both for filetype plugins and for syntax files. More than
3246 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 This option is not copied to another buffer, independent of the 's' or
3248 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003249 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250
3251 *'fillchars'* *'fcs'*
3252'fillchars' 'fcs' string (default "vert:|,fold:-")
3253 global
3254 {not in Vi}
3255 {not available when compiled without the |+windows|
3256 and |+folding| features}
3257 Characters to fill the statuslines and vertical separators.
3258 It is a comma separated list of items:
3259
3260 item default Used for ~
3261 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003262 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 vert:c '|' vertical separators |:vsplit|
3264 fold:c '-' filling 'foldtext'
3265 diff:c '-' deleted lines of the 'diff' option
3266
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003267 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003268 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 otherwise.
3270
3271 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003272 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273< This is similar to the default, except that these characters will also
3274 be used when there is highlighting.
3275
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003276 for "stl" and "stlnc" only single-byte values are supported.
3277
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 The highlighting used for these items:
3279 item highlight group ~
3280 stl:c StatusLine |hl-StatusLine|
3281 stlnc:c StatusLineNC |hl-StatusLineNC|
3282 vert:c VertSplit |hl-VertSplit|
3283 fold:c Folded |hl-Folded|
3284 diff:c DiffDelete |hl-DiffDelete|
3285
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003286 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3287'fixendofline' 'fixeol' boolean (default on)
3288 local to buffer
3289 {not in Vi}
3290 When writing a file and this option is on, <EOL> at the end of file
3291 will be restored if missing. Turn this option off if you want to
3292 preserve the situation from the original file.
3293 When the 'binary' option is set the value of this option doesn't
3294 matter.
3295 See the 'endofline' option.
3296
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3298'fkmap' 'fk' boolean (default off) *E198*
3299 global
3300 {not in Vi}
3301 {only available when compiled with the |+rightleft|
3302 feature}
3303 When on, the keyboard is mapped for the Farsi character set.
3304 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003305 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306
3307 *'foldclose'* *'fcl'*
3308'foldclose' 'fcl' string (default "")
3309 global
3310 {not in Vi}
3311 {not available when compiled without the |+folding|
3312 feature}
3313 When set to "all", a fold is closed when the cursor isn't in it and
3314 its level is higher than 'foldlevel'. Useful if you want folds to
3315 automatically close when moving out of them.
3316
3317 *'foldcolumn'* *'fdc'*
3318'foldcolumn' 'fdc' number (default 0)
3319 local to window
3320 {not in Vi}
3321 {not available when compiled without the |+folding|
3322 feature}
3323 When non-zero, a column with the specified width is shown at the side
3324 of the window which indicates open and closed folds. The maximum
3325 value is 12.
3326 See |folding|.
3327
3328 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3329'foldenable' 'fen' boolean (default on)
3330 local to window
3331 {not in Vi}
3332 {not available when compiled without the |+folding|
3333 feature}
3334 When off, all folds are open. This option can be used to quickly
3335 switch between showing all text unfolded and viewing the text with
3336 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003337 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 'foldenable' is off.
3339 This option is set by commands that create a new fold or close a fold.
3340 See |folding|.
3341
3342 *'foldexpr'* *'fde'*
3343'foldexpr' 'fde' string (default: "0")
3344 local to window
3345 {not in Vi}
3346 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003347 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003349 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003350
Bram Moolenaar30b65812012-07-12 22:01:11 +02003351 The expression will be evaluated in the |sandbox| if set from a
3352 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003353 This option can't be set from a |modeline| when the 'diff' option is
3354 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003355
3356 It is not allowed to change text or jump to another window while
3357 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358
3359 *'foldignore'* *'fdi'*
3360'foldignore' 'fdi' string (default: "#")
3361 local to window
3362 {not in Vi}
3363 {not available when compiled without the |+folding|
3364 feature}
3365 Used only when 'foldmethod' is "indent". Lines starting with
3366 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003367 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368 The default "#" works well for C programs. See |fold-indent|.
3369
3370 *'foldlevel'* *'fdl'*
3371'foldlevel' 'fdl' number (default: 0)
3372 local to window
3373 {not in Vi}
3374 {not available when compiled without the |+folding|
3375 feature}
3376 Sets the fold level: Folds with a higher level will be closed.
3377 Setting this option to zero will close all folds. Higher numbers will
3378 close fewer folds.
3379 This option is set by commands like |zm|, |zM| and |zR|.
3380 See |fold-foldlevel|.
3381
3382 *'foldlevelstart'* *'fdls'*
3383'foldlevelstart' 'fdls' number (default: -1)
3384 global
3385 {not in Vi}
3386 {not available when compiled without the |+folding|
3387 feature}
3388 Sets 'foldlevel' when starting to edit another buffer in a window.
3389 Useful to always start editing with all folds closed (value zero),
3390 some folds closed (one) or no folds closed (99).
3391 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003392 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 ignores this option and closes all folds.
3394 It is also done before BufReadPre autocommands, to allow an autocmd to
3395 overrule the 'foldlevel' value for specific files.
3396 When the value is negative, it is not used.
3397
3398 *'foldmarker'* *'fmr'* *E536*
3399'foldmarker' 'fmr' string (default: "{{{,}}}")
3400 local to window
3401 {not in Vi}
3402 {not available when compiled without the |+folding|
3403 feature}
3404 The start and end marker used when 'foldmethod' is "marker". There
3405 must be one comma, which separates the start and end marker. The
3406 marker is a literal string (a regular expression would be too slow).
3407 See |fold-marker|.
3408
3409 *'foldmethod'* *'fdm'*
3410'foldmethod' 'fdm' string (default: "manual")
3411 local to window
3412 {not in Vi}
3413 {not available when compiled without the |+folding|
3414 feature}
3415 The kind of folding used for the current window. Possible values:
3416 |fold-manual| manual Folds are created manually.
3417 |fold-indent| indent Lines with equal indent form a fold.
3418 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3419 |fold-marker| marker Markers are used to specify folds.
3420 |fold-syntax| syntax Syntax highlighting items specify folds.
3421 |fold-diff| diff Fold text that is not changed.
3422
3423 *'foldminlines'* *'fml'*
3424'foldminlines' 'fml' number (default: 1)
3425 local to window
3426 {not in Vi}
3427 {not available when compiled without the |+folding|
3428 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003429 Sets the number of screen lines above which a fold can be displayed
3430 closed. Also for manually closed folds. With the default value of
3431 one a fold can only be closed if it takes up two or more screen lines.
3432 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003433 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 "zc" to close a fold, which is displayed open because it's smaller
3435 than 'foldminlines', a following "zc" may close a containing fold.
3436
3437 *'foldnestmax'* *'fdn'*
3438'foldnestmax' 'fdn' number (default: 20)
3439 local to window
3440 {not in Vi}
3441 {not available when compiled without the |+folding|
3442 feature}
3443 Sets the maximum nesting of folds for the "indent" and "syntax"
3444 methods. This avoids that too many folds will be created. Using more
3445 than 20 doesn't work, because the internal limit is 20.
3446
3447 *'foldopen'* *'fdo'*
3448'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3449 search,tag,undo")
3450 global
3451 {not in Vi}
3452 {not available when compiled without the |+folding|
3453 feature}
3454 Specifies for which type of commands folds will be opened, if the
3455 command moves the cursor into a closed fold. It is a comma separated
3456 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003457 NOTE: When the command is part of a mapping this option is not used.
3458 Add the |zv| command to the mapping to get the same effect.
3459 (rationale: the mapping may want to control opening folds itself)
3460
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 item commands ~
3462 all any
3463 block "(", "{", "[[", "[{", etc.
3464 hor horizontal movements: "l", "w", "fx", etc.
3465 insert any command in Insert mode
3466 jump far jumps: "G", "gg", etc.
3467 mark jumping to a mark: "'m", CTRL-O, etc.
3468 percent "%"
3469 quickfix ":cn", ":crew", ":make", etc.
3470 search search for a pattern: "/", "n", "*", "gd", etc.
3471 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003472 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 tag jumping to a tag: ":ta", CTRL-T, etc.
3474 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475 When a movement command is used for an operator (e.g., "dl" or "y%")
3476 this option is not used. This means the operator will include the
3477 whole closed fold.
3478 Note that vertical movements are not here, because it would make it
3479 very difficult to move onto a closed fold.
3480 In insert mode the folds containing the cursor will always be open
3481 when text is inserted.
3482 To close folds you can re-apply 'foldlevel' with the |zx| command or
3483 set the 'foldclose' option to "all".
3484
3485 *'foldtext'* *'fdt'*
3486'foldtext' 'fdt' string (default: "foldtext()")
3487 local to window
3488 {not in Vi}
3489 {not available when compiled without the |+folding|
3490 feature}
3491 An expression which is used to specify the text displayed for a closed
3492 fold. See |fold-foldtext|.
3493
Bram Moolenaar30b65812012-07-12 22:01:11 +02003494 The expression will be evaluated in the |sandbox| if set from a
3495 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003496
3497 It is not allowed to change text or jump to another window while
3498 evaluating 'foldtext' |textlock|.
3499
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003500 *'formatexpr'* *'fex'*
3501'formatexpr' 'fex' string (default "")
3502 local to buffer
3503 {not in Vi}
3504 {not available when compiled without the |+eval|
3505 feature}
3506 Expression which is evaluated to format a range of lines for the |gq|
3507 operator or automatic formatting (see 'formatoptions'). When this
3508 option is empty 'formatprg' is used.
3509
3510 The |v:lnum| variable holds the first line to be formatted.
3511 The |v:count| variable holds the number of lines to be formatted.
3512 The |v:char| variable holds the character that is going to be
3513 inserted if the expression is being evaluated due to
3514 automatic formatting. This can be empty. Don't insert
3515 it yet!
3516
3517 Example: >
3518 :set formatexpr=mylang#Format()
3519< This will invoke the mylang#Format() function in the
3520 autoload/mylang.vim file in 'runtimepath'. |autoload|
3521
3522 The expression is also evaluated when 'textwidth' is set and adding
3523 text beyond that limit. This happens under the same conditions as
3524 when internal formatting is used. Make sure the cursor is kept in the
3525 same spot relative to the text then! The |mode()| function will
3526 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003527
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003528 When the expression evaluates to non-zero Vim will fall back to using
3529 the internal format mechanism.
3530
3531 The expression will be evaluated in the |sandbox| when set from a
3532 modeline, see |sandbox-option|. That stops the option from working,
3533 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003534 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003535
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 *'formatoptions'* *'fo'*
3537'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3538 local to buffer
3539 {not in Vi}
3540 This is a sequence of letters which describes how automatic
3541 formatting is to be done. See |fo-table|. When the 'paste' option is
3542 on, no formatting is done (like 'formatoptions' is empty). Commas can
3543 be inserted for readability.
3544 To avoid problems with flags that are added in the future, use the
3545 "+=" and "-=" feature of ":set" |add-option-flags|.
3546 NOTE: This option is set to the Vi default value when 'compatible' is
3547 set and to the Vim default value when 'compatible' is reset.
3548
Bram Moolenaar86b68352004-12-27 21:59:20 +00003549 *'formatlistpat'* *'flp'*
3550'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3551 local to buffer
3552 {not in Vi}
3553 A pattern that is used to recognize a list header. This is used for
3554 the "n" flag in 'formatoptions'.
3555 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003556 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003557 while still checking more characters. There must be a character
3558 following the pattern, when it matches the whole line it is handled
3559 like there is no match.
3560 The default recognizes a number, followed by an optional punctuation
3561 character and white space.
3562
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563 *'formatprg'* *'fp'*
3564'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003565 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 {not in Vi}
3567 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003568 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003570 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003571 If the 'formatexpr' option is not empty it will be used instead.
3572 Otherwise, if 'formatprg' option is an empty string, the internal
3573 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003574 Environment variables are expanded |:set_env|. See |option-backslash|
3575 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003576 This option cannot be set from a |modeline| or in the |sandbox|, for
3577 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578
Bram Moolenaard94464e2015-11-02 15:28:18 +01003579 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003580'fsync' 'fs' boolean (default on)
3581 global
3582 {not in Vi}
3583 When on, the library function fsync() will be called after writing a
3584 file. This will flush a file to disk, ensuring that it is safely
3585 written even on filesystems which do metadata-only journaling. This
3586 will force the harddrive to spin up on Linux systems running in laptop
3587 mode, so it may be undesirable in some situations. Be warned that
3588 turning this off increases the chances of data loss after a crash. On
3589 systems without an fsync() implementation, this variable is always
3590 off.
3591 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003592 'fsync' also applies to |writefile()|, unless a flag is used to
3593 overrule it.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003594
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3596'gdefault' 'gd' boolean (default off)
3597 global
3598 {not in Vi}
3599 When on, the ":substitute" flag 'g' is default on. This means that
3600 all matches in a line are substituted instead of one. When a 'g' flag
3601 is given to a ":substitute" command, this will toggle the substitution
3602 of all or one match. See |complex-change|.
3603
3604 command 'gdefault' on 'gdefault' off ~
3605 :s/// subst. all subst. one
3606 :s///g subst. one subst. all
3607 :s///gg subst. all subst. one
3608
3609 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003610 DEPRECATED: Setting this option may break plugins that are not aware
3611 of this option. Also, many users get confused that adding the /g flag
3612 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613
3614 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003615'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 global
3617 {not in Vi}
3618 Format to recognize for the ":grep" command output.
3619 This is a scanf-like string that uses the same format as the
3620 'errorformat' option: see |errorformat|.
3621
3622 *'grepprg'* *'gp'*
3623'grepprg' 'gp' string (default "grep -n ",
3624 Unix: "grep -n $* /dev/null",
3625 Win32: "findstr /n" or "grep -n",
3626 VMS: "SEARCH/NUMBERS ")
3627 global or local to buffer |global-local|
3628 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003629 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630 and '#' characters, which are expanded like when used in a command-
3631 line. The placeholder "$*" is allowed to specify where the arguments
3632 will be included. Environment variables are expanded |:set_env|. See
3633 |option-backslash| about including spaces and backslashes.
3634 When your "grep" accepts the "-H" argument, use this to make ":grep"
3635 also work well with a single file: >
3636 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003637< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003638 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3639 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003640 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 apply equally to 'grepprg'.
3642 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3643 otherwise it's "grep -n".
3644 This option cannot be set from a |modeline| or in the |sandbox|, for
3645 security reasons.
3646
3647 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3648'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3649 ve:ver35-Cursor,
3650 o:hor50-Cursor,
3651 i-ci:ver25-Cursor/lCursor,
3652 r-cr:hor20-Cursor/lCursor,
3653 sm:block-Cursor
3654 -blinkwait175-blinkoff150-blinkon175",
3655 for MS-DOS and Win32 console:
3656 "n-v-c:block,o:hor50,i-ci:hor15,
3657 r-cr:hor30,sm:block")
3658 global
3659 {not in Vi}
3660 {only available when compiled with GUI enabled, and
3661 for MS-DOS and Win32 console}
3662 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003663 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 the height of the cursor can be changed. This can be done by
3665 specifying a block cursor, or a percentage for a vertical or
3666 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003667 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3668 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003670 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 mode-list and an argument-list:
3672 mode-list:argument-list,mode-list:argument-list,..
3673 The mode-list is a dash separated list of these modes:
3674 n Normal mode
3675 v Visual mode
3676 ve Visual mode with 'selection' "exclusive" (same as 'v',
3677 if not specified)
3678 o Operator-pending mode
3679 i Insert mode
3680 r Replace mode
3681 c Command-line Normal (append) mode
3682 ci Command-line Insert mode
3683 cr Command-line Replace mode
3684 sm showmatch in Insert mode
3685 a all modes
3686 The argument-list is a dash separated list of these arguments:
3687 hor{N} horizontal bar, {N} percent of the character height
3688 ver{N} vertical bar, {N} percent of the character width
3689 block block cursor, fills the whole character
3690 [only one of the above three should be present]
3691 blinkwait{N} *cursor-blinking*
3692 blinkon{N}
3693 blinkoff{N}
3694 blink times for cursor: blinkwait is the delay before
3695 the cursor starts blinking, blinkon is the time that
3696 the cursor is shown and blinkoff is the time that the
3697 cursor is not shown. The times are in msec. When one
3698 of the numbers is zero, there is no blinking. The
3699 default is: "blinkwait700-blinkon400-blinkoff250".
3700 These numbers are used for a missing entry. This
3701 means that blinking is enabled by default. To switch
3702 blinking off you can use "blinkon0". The cursor only
3703 blinks when Vim is waiting for input, not while
3704 executing a command.
3705 To make the cursor blink in an xterm, see
3706 |xterm-blink|.
3707 {group-name}
3708 a highlight group name, that sets the color and font
3709 for the cursor
3710 {group-name}/{group-name}
3711 Two highlight group names, the first is used when
3712 no language mappings are used, the other when they
3713 are. |language-mapping|
3714
3715 Examples of parts:
3716 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3717 block cursor with colors from the "nCursor"
3718 highlight group
3719 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3720 In Insert and Command-line Insert mode, use a
3721 30% vertical bar cursor with colors from the
3722 "iCursor" highlight group. Blink a bit
3723 faster.
3724
3725 The 'a' mode is different. It will set the given argument-list for
3726 all modes. It does not reset anything to defaults. This can be used
3727 to do a common setting for all modes. For example, to switch off
3728 blinking: "a:blinkon0"
3729
3730 Examples of cursor highlighting: >
3731 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3732 :highlight Cursor gui=NONE guifg=bg guibg=fg
3733<
3734 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003735 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736'guifont' 'gfn' string (default "")
3737 global
3738 {not in Vi}
3739 {only available when compiled with GUI enabled}
3740 This is a list of fonts which will be used for the GUI version of Vim.
3741 In its simplest form the value is just one font name. When
3742 the font cannot be found you will get an error message. To try other
3743 font names a list can be specified, font names separated with commas.
3744 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003745
Bram Moolenaar05159a02005-02-26 23:04:13 +00003746 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3747 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003748
Bram Moolenaar3df01732017-02-17 22:47:16 +01003749 Note: As to the GTK GUIs, no error is given against any invalid names,
3750 and the first element of the list is always picked up and made use of.
3751 This is because, instead of identifying a given name with a font, the
3752 GTK GUIs use it to construct a pattern and try to look up a font which
3753 best matches the pattern among available fonts, and this way, the
3754 matching never fails. An invalid name doesn't matter because a number
3755 of font properties other than name will do to get the matching done.
3756
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 Spaces after a comma are ignored. To include a comma in a font name
3758 precede it with a backslash. Setting an option requires an extra
3759 backslash before a space and a backslash. See also
3760 |option-backslash|. For example: >
3761 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003762< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003764
3765 If none of the fonts can be loaded, Vim will keep the current setting.
3766 If an empty font list is given, Vim will try using other resource
3767 settings (for X, it will use the Vim.font resource), and finally it
3768 will try some builtin default which should always be there ("7x13" in
3769 the case of X). The font names given should be "normal" fonts. Vim
3770 will try to find the related bold and italic fonts.
3771
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003772 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003773 :set guifont=*
3774< will bring up a font requester, where you can pick the font you want.
3775
3776 The font name depends on the GUI used. See |setting-guifont| for a
3777 way to set 'guifont' for various systems.
3778
Bram Moolenaar3df01732017-02-17 22:47:16 +01003779 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003781< That's all. XLFDs are not used. For Chinese this is reported to work
3782 well: >
3783 if has("gui_gtk2")
3784 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3785 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3786 endif
3787<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003788 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3789
Bram Moolenaar05159a02005-02-26 23:04:13 +00003790 For Mac OSX you can use something like this: >
3791 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003792< Also see 'macatsui', it can help fix display problems.
3793 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003795 width). An exception is GTK: all fonts are accepted, but mono-spaced
3796 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003797
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 To preview a font on X11, you might be able to use the "xfontsel"
3799 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003800
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801 For the Win32 GUI *E244* *E245*
3802 - takes these options in the font name:
3803 hXX - height is XX (points, can be floating-point)
3804 wXX - width is XX (points, can be floating-point)
3805 b - bold
3806 i - italic
3807 u - underline
3808 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003809 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3811 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3812 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003813 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003814 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003815 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003816 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003817 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818
3819 Use a ':' to separate the options.
3820 - A '_' can be used in the place of a space, so you don't need to use
3821 backslashes to escape the spaces.
3822 - Examples: >
3823 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3824 :set guifont=Andale_Mono:h7.5:w4.5
3825< See also |font-sizes|.
3826
3827 *'guifontset'* *'gfs'*
3828 *E250* *E252* *E234* *E597* *E598*
3829'guifontset' 'gfs' string (default "")
3830 global
3831 {not in Vi}
3832 {only available when compiled with GUI enabled and
3833 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003834 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 When not empty, specifies two (or more) fonts to be used. The first
3836 one for normal English, the second one for your special language. See
3837 |xfontset|.
3838 Setting this option also means that all font names will be handled as
3839 a fontset name. Also the ones used for the "font" argument of the
3840 |:highlight| command.
3841 The fonts must match with the current locale. If fonts for the
3842 character sets that the current locale uses are not included, setting
3843 'guifontset' will fail.
3844 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3845 the comma-separated names are alternative names, one of which will be
3846 used. In 'guifontset' the whole string is one fontset name,
3847 including the commas. It is not possible to specify alternative
3848 fontset names.
3849 This example works on many X11 systems: >
3850 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3851<
3852 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3853'guifontwide' 'gfw' string (default "")
3854 global
3855 {not in Vi}
3856 {only available when compiled with GUI enabled}
3857 When not empty, specifies a comma-separated list of fonts to be used
3858 for double-width characters. The first font that can be loaded is
3859 used.
3860 Note: The size of these fonts must be exactly twice as wide as the one
3861 specified with 'guifont' and the same height.
3862
Bram Moolenaar3df01732017-02-17 22:47:16 +01003863 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864
3865 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3866 'guifontset' is empty or invalid.
3867 When 'guifont' is set and a valid font is found in it and
3868 'guifontwide' is empty Vim will attempt to find a matching
3869 double-width font and set 'guifontwide' to it.
3870
Bram Moolenaar3df01732017-02-17 22:47:16 +01003871 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872
3873 If set and valid, 'guifontwide' is always used for double width
3874 characters, even if 'encoding' is not set to "utf-8".
3875 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003876 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 font for characters not available in 'guifont'. Thus you do not need
3878 to set 'guifontwide' at all unless you want to override the choice
3879 made by Pango/Xft.
3880
Bram Moolenaar0f272122013-01-23 18:37:40 +01003881 Windows +multibyte only: *guifontwide_win_mbyte*
3882
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003883 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003884
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 *'guiheadroom'* *'ghr'*
3886'guiheadroom' 'ghr' number (default 50)
3887 global
3888 {not in Vi} {only for GTK and X11 GUI}
3889 The number of pixels subtracted from the screen height when fitting
3890 the GUI window on the screen. Set this before the GUI is started,
3891 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003892 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 lines will be left for window decorations and other items on the
3894 screen. Set it to a negative value to allow windows taller than the
3895 screen.
3896
3897 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003898'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3899 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003900 "aegimrLtT" (GTK, Motif and Athena),
3901 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 global
3903 {not in Vi}
3904 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003905 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 sequence of letters which describes what components and options of the
3907 GUI should be used.
3908 To avoid problems with flags that are added in the future, use the
3909 "+=" and "-=" feature of ":set" |add-option-flags|.
3910
Bram Moolenaar13568252018-03-16 20:46:58 +01003911 Valid characters are as follows:
3912 *'go-!'*
3913 '!' External commands are executed in a terminal window. Without
3914 this flag the MS-Windows GUI will open a console window to
3915 execute the command. The Unix GUI will simulate a dumb
3916 terminal to list the command output.
3917 The terminal window will be positioned at the bottom, and grow
3918 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003919 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920 'a' Autoselect: If present, then whenever VISUAL mode is started,
3921 or the Visual area extended, Vim tries to become the owner of
3922 the windowing system's global selection. This means that the
3923 Visually highlighted text is available for pasting into other
3924 applications as well as into Vim itself. When the Visual mode
3925 ends, possibly due to an operation on the text, or when an
3926 application wants to paste the selection, the highlighted text
3927 is automatically yanked into the "* selection register.
3928 Thus the selection is still available for pasting into other
3929 applications after the VISUAL mode has ended.
3930 If not present, then Vim won't become the owner of the
3931 windowing system's global selection unless explicitly told to
3932 by a yank or delete operation for the "* register.
3933 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003934 *'go-P'*
3935 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003936 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003937 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003938 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 applies to the modeless selection.
3940
3941 'guioptions' autoselect Visual autoselect modeless ~
3942 "" - -
3943 "a" yes yes
3944 "A" - yes
3945 "aA" yes yes
3946
Bram Moolenaar02467872007-05-06 13:22:01 +00003947 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 'c' Use console dialogs instead of popup dialogs for simple
3949 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003950 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003951 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003952 'guitablabel' can be used to change the text in the labels.
3953 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003954 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003955 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003956 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 'f' Foreground: Don't use fork() to detach the GUI from the shell
3958 where it was started. Use this for programs that wait for the
3959 editor to finish (e.g., an e-mail program). Alternatively you
3960 can use "gvim -f" or ":gui -f" to start the GUI in the
3961 foreground. |gui-fork|
3962 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003963 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003964 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3966 corner of the window. It's black&white on non-GTK, because of
3967 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003968 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003970 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003971 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003973 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003975 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003976 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 'g' Grey menu items: Make menu items that are not active grey. If
3978 'g' is not included inactive menu items are not shown at all.
3979 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003980 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 't' Include tearoff menu items. Currently only works for Win32,
3982 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003983 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003984 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003985 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003986 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003988 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 'R' Right-hand scrollbar is present when there is a vertically
3990 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003991 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003993 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994 'L' Left-hand scrollbar is present when there is a vertically
3995 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003996 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3998 the longest visible line, or on the cursor line if the 'h'
3999 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004000 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 'h' Limit horizontal scrollbar size to the length of the cursor
4002 line. Reduces computations. |gui-horiz-scroll|
4003
4004 And yes, you may even have scrollbars on the left AND the right if
4005 you really want to :-). See |gui-scrollbars| for more information.
4006
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004007 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 'v' Use a vertical button layout for dialogs. When not included,
4009 a horizontal layout is preferred, but when it doesn't fit a
4010 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004011 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 'p' Use Pointer callbacks for X11 GUI. This is required for some
4013 window managers. If the cursor is not blinking or hollow at
4014 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004015 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004017 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004018 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004019 *'go-k'*
4020 'k' Keep the GUI window size when adding/removing a scrollbar, or
4021 toolbar, tabline, etc. Instead, the behavior is similar to
4022 when the window is maximized and will adjust 'lines' and
4023 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004024 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004025 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004026
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 *'guipty'* *'noguipty'*
4028'guipty' boolean (default on)
4029 global
4030 {not in Vi}
4031 {only available when compiled with GUI enabled}
4032 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4033 I/O to/from shell commands. See |gui-pty|.
4034
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004035 *'guitablabel'* *'gtl'*
4036'guitablabel' 'gtl' string (default empty)
4037 global
4038 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004039 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02004040 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004041 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004042 pages line. When empty and when the result is empty Vim will use a
4043 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004044
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004045 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004046 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004047 The expression will be evaluated in the |sandbox| when set from a
4048 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004049
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004050 Only used when the GUI tab pages line is displayed. 'e' must be
4051 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4052 used.
4053
Bram Moolenaar57657d82006-04-21 22:12:41 +00004054 *'guitabtooltip'* *'gtt'*
4055'guitabtooltip' 'gtt' string (default empty)
4056 global
4057 {not in Vi}
4058 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02004059 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004060 When nonempty describes the text to use in a tooltip for the GUI tab
4061 pages line. When empty Vim will use a default tooltip.
4062 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004063 You can include a line break. Simplest method is to use |:let|: >
4064 :let &guitabtooltip = "line one\nline two"
4065<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004066
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 *'helpfile'* *'hf'*
4068'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
4069 (others) "$VIMRUNTIME/doc/help.txt")
4070 global
4071 {not in Vi}
4072 Name of the main help file. All distributed help files should be
4073 placed together in one directory. Additionally, all "doc" directories
4074 in 'runtimepath' will be used.
4075 Environment variables are expanded |:set_env|. For example:
4076 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004077 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 spaces and backslashes.
4079 This option cannot be set from a |modeline| or in the |sandbox|, for
4080 security reasons.
4081
4082 *'helpheight'* *'hh'*
4083'helpheight' 'hh' number (default 20)
4084 global
4085 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004086 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004087 feature}
4088 Minimal initial height of the help window when it is opened with the
4089 ":help" command. The initial height of the help window is half of the
4090 current window, or (when the 'ea' option is on) the same as other
4091 windows. When the height is less than 'helpheight', the height is
4092 set to 'helpheight'. Set to zero to disable.
4093
4094 *'helplang'* *'hlg'*
4095'helplang' 'hlg' string (default: messages language or empty)
4096 global
4097 {only available when compiled with the |+multi_lang|
4098 feature}
4099 {not in Vi}
4100 Comma separated list of languages. Vim will use the first language
4101 for which the desired help can be found. The English help will always
4102 be used as a last resort. You can add "en" to prefer English over
4103 another language, but that will only find tags that exist in that
4104 language and not in the English help.
4105 Example: >
4106 :set helplang=de,it
4107< This will first search German, then Italian and finally English help
4108 files.
4109 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4110 try to find the tag in the current language before using this option.
4111 See |help-translated|.
4112
4113 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4114'hidden' 'hid' boolean (default off)
4115 global
4116 {not in Vi}
4117 When off a buffer is unloaded when it is |abandon|ed. When on a
4118 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4119 displayed in another window, it does not become hidden, of course.
4120 The commands that move through the buffer list sometimes make a buffer
4121 hidden although the 'hidden' option is off: When the buffer is
4122 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004123 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004124 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125 This option is set for one command with ":hide {command}" |:hide|.
4126 WARNING: It's easy to forget that you have changes in hidden buffers.
4127 Think twice when using ":q!" or ":qa!".
4128
4129 *'highlight'* *'hl'*
4130'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004131 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4132 d:Directory,e:ErrorMsg,i:IncSearch,
4133 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4134 N:CursorLineNr,r:Question,s:StatusLine,
4135 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004136 v:Visual,V:VisualNOS,w:WarningMsg,
4137 W:WildMenu,f:Folded,F:FoldColumn,
4138 A:DiffAdd,C:DiffChange,D:DiffDelete,
4139 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004140 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004141 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004142 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4143 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004144 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004145 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 global
4147 {not in Vi}
4148 This option can be used to set highlighting mode for various
4149 occasions. It is a comma separated list of character pairs. The
4150 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004151 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004153 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4154 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 characters from 'showbreak'
4156 |hl-Directory| d directories in CTRL-D listing and other special
4157 things in listings
4158 |hl-ErrorMsg| e error messages
4159 h (obsolete, ignored)
4160 |hl-IncSearch| i 'incsearch' highlighting
4161 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4162 |hl-MoreMsg| m |more-prompt|
4163 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004164 |hl-LineNr| n line number for ":number" and ":#" commands, and
4165 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004166 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4167 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168 |hl-Question| r |hit-enter| prompt and yes/no questions
4169 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004170 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4172 |hl-VertSplit| c column used to separate vertically split windows
4173 |hl-Visual| v Visual mode
4174 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4175 Selection" Only X11 Gui's |gui-x11| and
4176 |xterm-clipboard|.
4177 |hl-WarningMsg| w warning messages
4178 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4179 |hl-Folded| f line used for closed folds
4180 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004181 |hl-DiffAdd| A added line in diff mode
4182 |hl-DiffChange| C changed line in diff mode
4183 |hl-DiffDelete| D deleted line in diff mode
4184 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004186 |hl-Conceal| - the placeholders used for concealed characters
4187 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004188 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004189 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004190 |hl-SpellRare| R rare word |spell|
4191 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004192 |hl-Pmenu| + popup menu normal line
4193 |hl-PmenuSel| = popup menu selected line
4194 |hl-PmenuSbar| x popup menu scrollbar
4195 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196
4197 The display modes are:
4198 r reverse (termcap entry "mr" and "me")
4199 i italic (termcap entry "ZH" and "ZR")
4200 b bold (termcap entry "md" and "me")
4201 s standout (termcap entry "so" and "se")
4202 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004203 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004204 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 n no highlighting
4206 - no highlighting
4207 : use a highlight group
4208 The default is used for occasions that are not included.
4209 If you want to change what the display modes do, see |dos-colors|
4210 for an example.
4211 When using the ':' display mode, this must be followed by the name of
4212 a highlight group. A highlight group can be used to define any type
4213 of highlighting, including using color. See |:highlight| on how to
4214 define one. The default uses a different group for each occasion.
4215 See |highlight-default| for the default highlight groups.
4216
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004218'history' 'hi' number (Vim default: 50, Vi default: 0,
4219 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 global
4221 {not in Vi}
4222 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004223 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004225 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226 NOTE: This option is set to the Vi default value when 'compatible' is
4227 set and to the Vim default value when 'compatible' is reset.
4228
4229 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4230'hkmap' 'hk' boolean (default off)
4231 global
4232 {not in Vi}
4233 {only available when compiled with the |+rightleft|
4234 feature}
4235 When on, the keyboard is mapped for the Hebrew character set.
4236 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4237 toggle this option. See |rileft.txt|.
4238 NOTE: This option is reset when 'compatible' is set.
4239
4240 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4241'hkmapp' 'hkp' boolean (default off)
4242 global
4243 {not in Vi}
4244 {only available when compiled with the |+rightleft|
4245 feature}
4246 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4247 This is useful if you have a non-Hebrew keyboard.
4248 See |rileft.txt|.
4249 NOTE: This option is reset when 'compatible' is set.
4250
Bram Moolenaar036986f2017-03-16 17:41:02 +01004251 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4252'hlsearch' 'hls' boolean (default off)
4253 global
4254 {not in Vi}
4255 {not available when compiled without the
4256 |+extra_search| feature}
4257 When there is a previous search pattern, highlight all its matches.
4258 The type of highlighting used can be set with the 'l' occasion in the
4259 'highlight' option. This uses the "Search" highlight group by
4260 default. Note that only the matching text is highlighted, any offsets
4261 are not applied.
4262 See also: 'incsearch' and |:match|.
4263 When you get bored looking at the highlighted matches, you can turn it
4264 off with |:nohlsearch|. This does not change the option value, as
4265 soon as you use a search command, the highlighting comes back.
4266 'redrawtime' specifies the maximum time spent on finding matches.
4267 When the search pattern can match an end-of-line, Vim will try to
4268 highlight all of the matched text. However, this depends on where the
4269 search starts. This will be the first line in the window or the first
4270 line below a closed fold. A match in a previous line which is not
4271 drawn may not continue in a newly drawn line.
4272 You can specify whether the highlight status is restored on startup
4273 with the 'h' flag in 'viminfo' |viminfo-h|.
4274 NOTE: This option is reset when 'compatible' is set.
4275
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 *'icon'* *'noicon'*
4277'icon' boolean (default off, on when title can be restored)
4278 global
4279 {not in Vi}
4280 {not available when compiled without the |+title|
4281 feature}
4282 When on, the icon text of the window will be set to the value of
4283 'iconstring' (if it is not empty), or to the name of the file
4284 currently being edited. Only the last part of the name is used.
4285 Overridden by the 'iconstring' option.
4286 Only works if the terminal supports setting window icons (currently
4287 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4288 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4289 builtin termcap).
4290 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004291 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004293 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294
4295 *'iconstring'*
4296'iconstring' string (default "")
4297 global
4298 {not in Vi}
4299 {not available when compiled without the |+title|
4300 feature}
4301 When this option is not empty, it will be used for the icon text of
4302 the window. This happens only when the 'icon' option is on.
4303 Only works if the terminal supports setting window icon text
4304 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4305 Does not work for MS Windows.
4306 When Vim was compiled with HAVE_X11 defined, the original icon will be
4307 restored if possible |X11|.
4308 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004309 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310 'titlestring' for example settings.
4311 {not available when compiled without the |+statusline| feature}
4312
4313 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4314'ignorecase' 'ic' boolean (default off)
4315 global
4316 Ignore case in search patterns. Also used when searching in the tags
4317 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004318 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 Can be overruled by using "\c" or "\C" in the pattern, see
4320 |/ignorecase|.
4321
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004322 *'imactivatefunc'* *'imaf'*
4323'imactivatefunc' 'imaf' string (default "")
4324 global
4325 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004326 {only available when compiled with the |+multi_byte|
4327 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004328 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004329 activate or deactivate the Input Method.
4330 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004331
4332 Example: >
4333 function ImActivateFunc(active)
4334 if a:active
4335 ... do something
4336 else
4337 ... do something
4338 endif
4339 " return value is not used
4340 endfunction
4341 set imactivatefunc=ImActivateFunc
4342<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 *'imactivatekey'* *'imak'*
4344'imactivatekey' 'imak' string (default "")
4345 global
4346 {not in Vi}
4347 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004348 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 Specifies the key that your Input Method in X-Windows uses for
4350 activation. When this is specified correctly, vim can fully control
4351 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4352 You can't use this option to change the activation key, the option
4353 tells Vim what the key is.
4354 Format:
4355 [MODIFIER_FLAG-]KEY_STRING
4356
4357 These characters can be used for MODIFIER_FLAG (case is ignored):
4358 S Shift key
4359 L Lock key
4360 C Control key
4361 1 Mod1 key
4362 2 Mod2 key
4363 3 Mod3 key
4364 4 Mod4 key
4365 5 Mod5 key
4366 Combinations are allowed, for example "S-C-space" or "SC-space" are
4367 both shift+ctrl+space.
4368 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4369
4370 Example: >
4371 :set imactivatekey=S-space
4372< "S-space" means shift+space. This is the activation key for kinput2 +
4373 canna (Japanese), and ami (Korean).
4374
4375 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4376'imcmdline' 'imc' boolean (default off)
4377 global
4378 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004379 {only available when compiled with the |+multi_byte|
4380 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 When set the Input Method is always on when starting to edit a command
4382 line, unless entering a search pattern (see 'imsearch' for that).
4383 Setting this option is useful when your input method allows entering
4384 English characters directly, e.g., when it's used to type accented
4385 characters with dead keys.
4386
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004387 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4389 global
4390 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004391 {only available when compiled with the |+multi_byte|
4392 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 When set the Input Method is never used. This is useful to disable
4394 the IM when it doesn't work properly.
4395 Currently this option is on by default for SGI/IRIX machines. This
4396 may change in later releases.
4397
4398 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004399'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 local to buffer
4401 {not in Vi}
4402 Specifies whether :lmap or an Input Method (IM) is to be used in
4403 Insert mode. Valid values:
4404 0 :lmap is off and IM is off
4405 1 :lmap is ON and IM is off
4406 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 To always reset the option to zero when leaving Insert mode with <Esc>
4408 this can be used: >
4409 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4410< This makes :lmap and IM turn off automatically when leaving Insert
4411 mode.
4412 Note that this option changes when using CTRL-^ in Insert mode
4413 |i_CTRL-^|.
4414 The value is set to 1 when setting 'keymap' to a valid keymap name.
4415 It is also used for the argument of commands like "r" and "f".
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 Moolenaar6315a9a2017-11-25 15:20:02 +01004419 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004420 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004421 |+multi_byte_ime| or |global-ime|.
4422
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004424'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 local to buffer
4426 {not in Vi}
4427 Specifies whether :lmap or an Input Method (IM) is to be used when
4428 entering a search pattern. Valid values:
4429 -1 the value of 'iminsert' is used, makes it look like
4430 'iminsert' is also used when typing a search pattern
4431 0 :lmap is off and IM is off
4432 1 :lmap is ON and IM is off
4433 2 :lmap is off and IM is ON
4434 Note that this option changes when using CTRL-^ in Command-line mode
4435 |c_CTRL-^|.
4436 The value is set to 1 when it is not -1 and setting the 'keymap'
4437 option to a valid keymap name.
4438 The value 0 may not work correctly with Athena and Motif with some XIM
4439 methods. Use 'imdisable' to disable XIM then.
4440
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004441 *'imstatusfunc'* *'imsf'*
4442'imstatusfunc' 'imsf' string (default "")
4443 global
4444 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004445 {only available when compiled with the |+multi_byte|
4446 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004447 This option specifies a function that is called to obtain the status
4448 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004449 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004450
4451 Example: >
4452 function ImStatusFunc()
4453 let is_active = ...do something
4454 return is_active ? 1 : 0
4455 endfunction
4456 set imstatusfunc=ImStatusFunc
4457<
4458 NOTE: This function is invoked very often. Keep it fast.
4459
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004460 *'imstyle'* *'imst'*
4461'imstyle' 'imst' number (default 1)
4462 global
4463 {not in Vi}
4464 {only available when compiled with |+xim| and
4465 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004466 This option specifies the input style of Input Method:
4467 0 use on-the-spot style
4468 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004469 See: |xim-input-style|
4470
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004471 For a long time on-the-spot style had been used in the GTK version of
4472 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004473 |single-repeat|, etc. Therefore over-the-spot style becomes the
4474 default now. This should work fine for most people, however if you
4475 have any problem with it, try using on-the-spot style.
4476
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 *'include'* *'inc'*
4478'include' 'inc' string (default "^\s*#\s*include")
4479 global or local to buffer |global-local|
4480 {not in Vi}
4481 {not available when compiled without the
4482 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004483 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 pattern, just like for the "/" command (See |pattern|). The default
4485 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004486 "]I", "[d", etc.
4487 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004488 comes after the matched pattern. But if "\zs" appears in the pattern
4489 then the text matched from "\zs" to the end, or until "\ze" if it
4490 appears, is used as the file name. Use this to include characters
4491 that are not in 'isfname', such as a space. You can then use
4492 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004493 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494
4495 *'includeexpr'* *'inex'*
4496'includeexpr' 'inex' string (default "")
4497 local to buffer
4498 {not in Vi}
4499 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004500 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004502 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 :set includeexpr=substitute(v:fname,'\\.','/','g')
4504< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004505
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004507 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 Also used for |<cfile>|.
4509
Bram Moolenaar30b65812012-07-12 22:01:11 +02004510 The expression will be evaluated in the |sandbox| when set from a
4511 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004512
4513 It is not allowed to change text or jump to another window while
4514 evaluating 'includeexpr' |textlock|.
4515
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004517'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4518 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519 global
4520 {not in Vi}
4521 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004522 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004523 While typing a search command, show where the pattern, as it was typed
4524 so far, matches. The matched string is highlighted. If the pattern
4525 is invalid or not found, nothing is shown. The screen will be updated
4526 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004527 Also applies to the pattern in commands: >
4528 :global
4529 :lvimgrep
4530 :lvimgrepadd
4531 :smagic
4532 :snomagic
4533 :sort
4534 :substitute
4535 :vglobal
4536 :vimgrep
4537 :vimgrepadd
4538< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004539 original position when no match is found and when pressing <Esc>. You
4540 still need to finish the search command with <Enter> to move the
4541 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004542 You can use the CTRL-G and CTRL-T keys to move to the next and
4543 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004544 When compiled with the |+reltime| feature Vim only searches for about
4545 half a second. With a complicated pattern and/or a lot of text the
4546 match may not be found. This is to avoid that Vim hangs while you
4547 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004548 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004549 When 'hlsearch' is on, all matched strings are highlighted too while
4550 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004551 If you don't want to turn 'hlsearch' on, but want to highlight all
4552 matches while searching, you can turn on and off 'hlsearch' with
4553 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004554 augroup vimrc-incsearch-highlight
4555 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004556 autocmd CmdlineEnter /,\? :set hlsearch
4557 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004558 augroup END
4559<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004560 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004561 to the command line. If 'ignorecase' and 'smartcase' are set and the
4562 command line has no uppercase characters, the added character is
4563 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004564 CTRL-R CTRL-W can be used to add the word at the end of the current
4565 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566 NOTE: This option is reset when 'compatible' is set.
4567
4568 *'indentexpr'* *'inde'*
4569'indentexpr' 'inde' string (default "")
4570 local to buffer
4571 {not in Vi}
4572 {not available when compiled without the |+cindent|
4573 or |+eval| features}
4574 Expression which is evaluated to obtain the proper indent for a line.
4575 It is used when a new line is created, for the |=| operator and
4576 in Insert mode as specified with the 'indentkeys' option.
4577 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004578 'smartindent' indenting. When 'lisp' is set, this option is
4579 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 When 'paste' is set this option is not used for indenting.
4581 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004582 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 when the expression is evaluated (but it may be moved around).
4584 The expression must return the number of spaces worth of indent. It
4585 can return "-1" to keep the current indent (this means 'autoindent' is
4586 used for the indent).
4587 Functions useful for computing the indent are |indent()|, |cindent()|
4588 and |lispindent()|.
4589 The evaluation of the expression must not have side effects! It must
4590 not change the text, jump to another window, etc. Afterwards the
4591 cursor position is always restored, thus the cursor may be moved.
4592 Normally this option would be set to call a function: >
4593 :set indentexpr=GetMyIndent()
4594< Error messages will be suppressed, unless the 'debug' option contains
4595 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004596 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004597 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598
Bram Moolenaar30b65812012-07-12 22:01:11 +02004599 The expression will be evaluated in the |sandbox| when set from a
4600 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004601
4602 It is not allowed to change text or jump to another window while
4603 evaluating 'indentexpr' |textlock|.
4604
4605
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 *'indentkeys'* *'indk'*
4607'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4608 local to buffer
4609 {not in Vi}
4610 {not available when compiled without the |+cindent|
4611 feature}
4612 A list of keys that, when typed in Insert mode, cause reindenting of
4613 the current line. Only happens if 'indentexpr' isn't empty.
4614 The format is identical to 'cinkeys', see |indentkeys-format|.
4615 See |C-indenting| and |indent-expression|.
4616
4617 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4618'infercase' 'inf' boolean (default off)
4619 local to buffer
4620 {not in Vi}
4621 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004622 'ignorecase' is also on, the case of the match is adjusted depending
4623 on the typed text. If the typed text contains a lowercase letter
4624 where the match has an upper case letter, the completed part is made
4625 lowercase. If the typed text has no lowercase letters and the match
4626 has a lowercase letter where the typed text has an uppercase letter,
4627 and there is a letter before it, the completed part is made uppercase.
4628 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629
4630 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4631'insertmode' 'im' boolean (default off)
4632 global
4633 {not in Vi}
4634 Makes Vim work in a way that Insert mode is the default mode. Useful
4635 if you want to use Vim as a modeless editor. Used for |evim|.
4636 These Insert mode commands will be useful:
4637 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004638 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639 this is a mapping, it is executed as if 'insertmode' was off.
4640 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004642 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4643 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644
4645 These items change when 'insertmode' is set:
4646 - when starting to edit of a file, Vim goes to Insert mode.
4647 - <Esc> in Insert mode is a no-op and beeps.
4648 - <Esc> in Normal mode makes Vim go to Insert mode.
4649 - CTRL-L in Insert mode is a command, it is not inserted.
4650 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4651 However, when <Esc> is used inside a mapping, it behaves like
4652 'insertmode' was not set. This was done to be able to use the same
4653 mappings with 'insertmode' set or not set.
4654 When executing commands with |:normal| 'insertmode' is not used.
4655
4656 NOTE: This option is reset when 'compatible' is set.
4657
4658 *'isfname'* *'isf'*
4659'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4660 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4661 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4662 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4663 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4664 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4665 global
4666 {not in Vi}
4667 The characters specified by this option are included in file names and
4668 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004669 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 Multi-byte characters 256 and above are always included, only the
4671 characters up to 255 are specified with this option.
4672 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004673 Think twice before adding white space to this option. Although a
4674 space may appear inside a file name, the effect will be that Vim
4675 doesn't know where a file name starts or ends when doing completion.
4676 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677
4678 Note that on systems using a backslash as path separator, Vim tries to
4679 do its best to make it work as you would expect. That is a bit
4680 tricky, since Vi originally used the backslash to escape special
4681 characters. Vim will not remove a backslash in front of a normal file
4682 name character on these systems, but it will on Unix and alikes. The
4683 '&' and '^' are not included by default, because these are special for
4684 cmd.exe.
4685
4686 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004687 Each part can be a single character number or a range. A range is two
4688 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 decimal number between 0 and 255 or the ASCII character itself (does
4690 not work for digits). Example:
4691 "_,-,128-140,#-43" (include '_' and '-' and the range
4692 128 to 140 and '#' to 43)
4693 If a part starts with '^', the following character number or range
4694 will be excluded from the option. The option is interpreted from left
4695 to right. Put the excluded character after the range where it is
4696 included. To include '^' itself use it as the last character of the
4697 option or the end of a range. Example:
4698 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4699 If the character is '@', all characters where isalpha() returns TRUE
4700 are included. Normally these are the characters a to z and A to Z,
4701 plus accented characters. To include '@' itself use "@-@". Examples:
4702 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004703 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 "a-z,A-Z,@-@" All letters plus the '@' character.
4705 A comma can be included by using it where a character number is
4706 expected. Example:
4707 "48-57,,,_" Digits, comma and underscore.
4708 A comma can be excluded by prepending a '^'. Example:
4709 " -~,^,,9" All characters from space to '~', excluding
4710 comma, plus <Tab>.
4711 See |option-backslash| about including spaces and backslashes.
4712
4713 *'isident'* *'isi'*
4714'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4715 "@,48-57,_,128-167,224-235"
4716 otherwise: "@,48-57,_,192-255")
4717 global
4718 {not in Vi}
4719 The characters given by this option are included in identifiers.
4720 Identifiers are used in recognizing environment variables and after a
4721 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004722 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004723 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004725 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4727
4728 *'iskeyword'* *'isk'*
4729'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4730 "@,48-57,_,128-167,224-235"
4731 otherwise: "@,48-57,_,192-255"
4732 Vi default: "@,48-57,_")
4733 local to buffer
4734 {not in Vi}
4735 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004736 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004737 'isfname' for a description of the format of this option. For '@'
4738 characters above 255 check the "word" character class.
4739 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740 For a help file it is set to all non-blank printable characters except
4741 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4742 command).
4743 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004744 This option also influences syntax highlighting, unless the syntax
4745 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746 NOTE: This option is set to the Vi default value when 'compatible' is
4747 set and to the Vim default value when 'compatible' is reset.
4748
4749 *'isprint'* *'isp'*
4750'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4751 "@,~-255"; otherwise: "@,161-255")
4752 global
4753 {not in Vi}
4754 The characters given by this option are displayed directly on the
4755 screen. It is also used for "\p" in a |pattern|. The characters from
4756 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4757 even when they are not included in 'isprint' or excluded. See
4758 'isfname' for a description of the format of this option.
4759
4760 Non-printable characters are displayed with two characters:
4761 0 - 31 "^@" - "^_"
4762 32 - 126 always single characters
4763 127 "^?"
4764 128 - 159 "~@" - "~_"
4765 160 - 254 "| " - "|~"
4766 255 "~?"
4767 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4768 displayed as <xx>, with the hexadecimal value of the byte.
4769 When 'display' contains "uhex" all unprintable characters are
4770 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004771 The SpecialKey highlighting will be used for unprintable characters.
4772 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773
4774 Multi-byte characters 256 and above are always included, only the
4775 characters up to 255 are specified with this option. When a character
4776 is printable but it is not available in the current font, a
4777 replacement character will be shown.
4778 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4779 There is no option to specify these characters.
4780
4781 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4782'joinspaces' 'js' boolean (default on)
4783 global
4784 {not in Vi}
4785 Insert two spaces after a '.', '?' and '!' with a join command.
4786 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4787 Otherwise only one space is inserted.
4788 NOTE: This option is set when 'compatible' is set.
4789
4790 *'key'*
4791'key' string (default "")
4792 local to buffer
4793 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004794 {only available when compiled with the |+cryptv|
4795 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004797 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 Careful: Do not set the key value by hand, someone might see the typed
4799 key. Use the |:X| command. But you can make 'key' empty: >
4800 :set key=
4801< It is not possible to get the value of this option with ":set key" or
4802 "echo &key". This is to avoid showing it to someone who shouldn't
4803 know. It also means you cannot see it yourself once you have set it,
4804 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004805 You can use "&key" in an expression to detect whether encryption is
4806 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004807
4808 *'keymap'* *'kmp'* *E544*
4809'keymap' 'kmp' string (default "")
4810 local to buffer
4811 {not in Vi}
4812 {only available when compiled with the |+keymap|
4813 feature}
4814 Name of a keyboard mapping. See |mbyte-keymap|.
4815 Setting this option to a valid keymap name has the side effect of
4816 setting 'iminsert' to one, so that the keymap becomes effective.
4817 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004818 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819
4820 *'keymodel'* *'km'*
4821'keymodel' 'km' string (default "")
4822 global
4823 {not in Vi}
4824 List of comma separated words, which enable special things that keys
4825 can do. These values can be used:
4826 startsel Using a shifted special key starts selection (either
4827 Select mode or Visual mode, depending on "key" being
4828 present in 'selectmode').
4829 stopsel Using a not-shifted special key stops selection.
4830 Special keys in this context are the cursor keys, <End>, <Home>,
4831 <PageUp> and <PageDown>.
4832 The 'keymodel' option is set by the |:behave| command.
4833
4834 *'keywordprg'* *'kp'*
4835'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004836 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 global or local to buffer |global-local|
4838 {not in Vi}
4839 Program to use for the |K| command. Environment variables are
4840 expanded |:set_env|. ":help" may be used to access the Vim internal
4841 help. (Note that previously setting the global option to the empty
4842 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004843 When the first character is ":", the command is invoked as a Vim
4844 Ex command prefixed with [count].
4845 When "man", "man -s" or an Ex command is used, Vim will automatically
4846 translate a count for the "K" command and pass it as the first
4847 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848 See |option-backslash| about including spaces and backslashes.
4849 Example: >
4850 :set keywordprg=man\ -s
4851< This option cannot be set from a |modeline| or in the |sandbox|, for
4852 security reasons.
4853
4854 *'langmap'* *'lmap'* *E357* *E358*
4855'langmap' 'lmap' string (default "")
4856 global
4857 {not in Vi}
4858 {only available when compiled with the |+langmap|
4859 feature}
4860 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004861 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004862 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 care of translating these special characters to the original meaning
4864 of the key. This means you don't have to change the keyboard mode to
4865 be able to execute Normal mode commands.
4866 This is the opposite of the 'keymap' option, where characters are
4867 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004868 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004869 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004870 This option cannot be set from a |modeline| or in the |sandbox|, for
4871 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004873 Example (for Greek, in UTF-8): *greek* >
4874 :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 +00004875< Example (exchanges meaning of z and y for commands): >
4876 :set langmap=zy,yz,ZY,YZ
4877<
4878 The 'langmap' option is a list of parts, separated with commas. Each
4879 part can be in one of two forms:
4880 1. A list of pairs. Each pair is a "from" character immediately
4881 followed by the "to" character. Examples: "aA", "aAbBcC".
4882 2. A list of "from" characters, a semi-colon and a list of "to"
4883 characters. Example: "abc;ABC"
4884 Example: "aA,fgh;FGH,cCdDeE"
4885 Special characters need to be preceded with a backslash. These are
4886 ";", ',' and backslash itself.
4887
4888 This will allow you to activate vim actions without having to switch
4889 back and forth between the languages. Your language characters will
4890 be understood as normal vim English characters (according to the
4891 langmap mappings) in the following cases:
4892 o Normal/Visual mode (commands, buffer/register names, user mappings)
4893 o Insert/Replace Mode: Register names after CTRL-R
4894 o Insert/Replace Mode: Mappings
4895 Characters entered in Command-line mode will NOT be affected by
4896 this option. Note that this option can be changed at any time
4897 allowing to switch between mappings for different languages/encodings.
4898 Use a mapping to avoid having to type it each time!
4899
4900 *'langmenu'* *'lm'*
4901'langmenu' 'lm' string (default "")
4902 global
4903 {not in Vi}
4904 {only available when compiled with the |+menu| and
4905 |+multi_lang| features}
4906 Language to use for menu translation. Tells which file is loaded
4907 from the "lang" directory in 'runtimepath': >
4908 "lang/menu_" . &langmenu . ".vim"
4909< (without the spaces). For example, to always use the Dutch menus, no
4910 matter what $LANG is set to: >
4911 :set langmenu=nl_NL.ISO_8859-1
4912< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004913 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914 If your $LANG is set to a non-English language but you do want to use
4915 the English menus: >
4916 :set langmenu=none
4917< This option must be set before loading menus, switching on filetype
4918 detection or syntax highlighting. Once the menus are defined setting
4919 this option has no effect. But you could do this: >
4920 :source $VIMRUNTIME/delmenu.vim
4921 :set langmenu=de_DE.ISO_8859-1
4922 :source $VIMRUNTIME/menu.vim
4923< Warning: This deletes all menus that you defined yourself!
4924
Bram Moolenaard94464e2015-11-02 15:28:18 +01004925 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004926'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004927 global
4928 {not in Vi}
4929 {only available when compiled with the |+langmap|
4930 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004931 This is just like 'langremap' but with the value inverted. It only
4932 exists for backwards compatibility. When setting 'langremap' then
4933 'langnoremap' is set to the inverted value, and the other way around.
4934
4935 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4936'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4937 global
4938 {not in Vi}
4939 {only available when compiled with the |+langmap|
4940 feature}
4941 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004942 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004943 'langmap' disables some of your mappings, try resetting this option.
4944 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004945 that works for you to avoid mappings to break.
4946
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947 *'laststatus'* *'ls'*
4948'laststatus' 'ls' number (default 1)
4949 global
4950 {not in Vi}
4951 The value of this option influences when the last window will have a
4952 status line:
4953 0: never
4954 1: only if there are at least two windows
4955 2: always
4956 The screen looks nicer with a status line if you have several
4957 windows, but it takes another screen line. |status-line|
4958
4959 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4960'lazyredraw' 'lz' boolean (default off)
4961 global
4962 {not in Vi}
4963 When this option is set, the screen will not be redrawn while
4964 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004965 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 update use |:redraw|.
4967
4968 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4969'linebreak' 'lbr' boolean (default off)
4970 local to window
4971 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004972 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004974 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 than at the last character that fits on the screen. Unlike
4976 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004977 it only affects the way the file is displayed, not its contents.
4978 If 'breakindent' is set, line is visually indented. Then, the value
4979 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004980 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 Note that <Tab> characters after an <EOL> are mostly not displayed
4982 with the right amount of white space.
4983
4984 *'lines'* *E593*
4985'lines' number (default 24 or terminal height)
4986 global
4987 Number of lines of the Vim window.
4988 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004989 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 When Vim is running in the GUI or in a resizable window, setting this
4991 option will cause the window size to be changed. When you only want
4992 to use the size for the GUI, put the command in your |gvimrc| file.
4993 Vim limits the number of lines to what fits on the screen. You can
4994 use this command to get the tallest window possible: >
4995 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004996< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004997 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 When you set this option and Vim is unable to change the physical
4999 number of lines of the display, the display may be messed up.
5000
5001 *'linespace'* *'lsp'*
5002'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5003 global
5004 {not in Vi}
5005 {only in the GUI}
5006 Number of pixel lines inserted between characters. Useful if the font
5007 uses the full character cell height, making lines touch each other.
5008 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005009 With some fonts there can be too much room between lines (to have
5010 space for ascents and descents). Then it makes sense to set
5011 'linespace' to a negative value. This may cause display problems
5012 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013
5014 *'lisp'* *'nolisp'*
5015'lisp' boolean (default off)
5016 local to buffer
5017 {not available when compiled without the |+lispindent|
5018 feature}
5019 Lisp mode: When <Enter> is typed in insert mode set the indent for
5020 the next line to Lisp standards (well, sort of). Also happens with
5021 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5022 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5023 better. Also see 'lispwords'.
5024 The '-' character is included in keyword characters. Redefines the
5025 "=" operator to use this same indentation algorithm rather than
5026 calling an external program if 'equalprg' is empty.
5027 This option is not used when 'paste' is set.
5028 {Vi: Does it a little bit differently}
5029
5030 *'lispwords'* *'lw'*
5031'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005032 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 {not in Vi}
5034 {not available when compiled without the |+lispindent|
5035 feature}
5036 Comma separated list of words that influence the Lisp indenting.
5037 |'lisp'|
5038
5039 *'list'* *'nolist'*
5040'list' boolean (default off)
5041 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005042 List mode: Show tabs as CTRL-I is displayed, display $ after end of
5043 line. Useful to see the difference between tabs and spaces and for
5044 trailing blanks. Further changed by the 'listchars' option.
5045
5046 The cursor is displayed at the start of the space a Tab character
5047 occupies, not at the end as usual in Normal mode. To get this cursor
5048 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005049 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005050<
5051 Note that list mode will also affect formatting (set with 'textwidth'
5052 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053 changing the way tabs are displayed.
5054
5055 *'listchars'* *'lcs'*
5056'listchars' 'lcs' string (default "eol:$")
5057 global
5058 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005059 Strings to use in 'list' mode and for the |:list| command. It is a
5060 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005061 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 eol:c Character to show at the end of each line. When
5063 omitted, there is no extra character at the end of the
5064 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005065 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00005066 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00005068 fill the space that the tab normally occupies.
5069 "tab:>-" will show a tab that takes four spaces as
5070 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005071 *lcs-space*
5072 space:c Character to show for a space. When omitted, spaces
5073 are left blank.
5074 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005075 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02005076 trailing spaces are blank. Overrides the "space"
5077 setting for trailing spaces.
5078 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 extends:c Character to show in the last column, when 'wrap' is
5080 off and the line continues beyond the right of the
5081 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005082 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005083 precedes:c Character to show in the first column, when 'wrap'
5084 is off and there is text preceding the character
5085 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005086 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005087 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005088 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005089 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005090 nbsp:c Character to show for a non-breakable space character
5091 (0xA0 (160 decimal) and U+202F). Left blank when
5092 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005094 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005096 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097
5098 Examples: >
5099 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005100 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 :set lcs=extends:>,precedes:<
5102< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02005103 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005104 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105
5106 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5107'loadplugins' 'lpl' boolean (default on)
5108 global
5109 {not in Vi}
5110 When on the plugin scripts are loaded when starting up |load-plugins|.
5111 This option can be reset in your |vimrc| file to disable the loading
5112 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005113 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5114 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115
Bram Moolenaard94464e2015-11-02 15:28:18 +01005116 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005117'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005118 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005119 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005120 {only available when compiled with the |+lua/dyn|
5121 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005122 Specifies the name of the Lua shared library. The default is
5123 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005124 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005125 This option cannot be set from a |modeline| or in the |sandbox|, for
5126 security reasons.
5127
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005128 *'macatsui'* *'nomacatsui'*
5129'macatsui' boolean (default on)
5130 global
5131 {only available in Mac GUI version}
5132 This is a workaround for when drawing doesn't work properly. When set
5133 and compiled with multi-byte support ATSUI text drawing is used. When
5134 not set ATSUI text drawing is not used. Switch this option off when
5135 you experience drawing problems. In a future version the problems may
5136 be solved and this option becomes obsolete. Therefore use this method
5137 to unset it: >
5138 if exists('&macatsui')
5139 set nomacatsui
5140 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00005141< Another option to check if you have drawing problems is
5142 'termencoding'.
5143
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144 *'magic'* *'nomagic'*
5145'magic' boolean (default on)
5146 global
5147 Changes the special characters that can be used in search patterns.
5148 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005149 WARNING: Switching this option off most likely breaks plugins! That
5150 is because many patterns assume it's on and will fail when it's off.
5151 Only switch it off when working with old Vi scripts. In any other
5152 situation write patterns that work when 'magic' is on. Include "\M"
5153 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154
5155 *'makeef'* *'mef'*
5156'makeef' 'mef' string (default: "")
5157 global
5158 {not in Vi}
5159 {not available when compiled without the |+quickfix|
5160 feature}
5161 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5162 and the |:grep| command.
5163 When it is empty, an internally generated temp file will be used.
5164 When "##" is included, it is replaced by a number to make the name
5165 unique. This makes sure that the ":make" command doesn't overwrite an
5166 existing file.
5167 NOT used for the ":cf" command. See 'errorfile' for that.
5168 Environment variables are expanded |:set_env|.
5169 See |option-backslash| about including spaces and backslashes.
5170 This option cannot be set from a |modeline| or in the |sandbox|, for
5171 security reasons.
5172
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005173 *'makeencoding'* *'menc'*
5174'makeencoding' 'menc' string (default "")
5175 global or local to buffer |global-local|
5176 {only available when compiled with the |+multi_byte|
5177 feature}
5178 {not in Vi}
5179 Encoding used for reading the output of external commands. When empty,
5180 encoding is not converted.
5181 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5182 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5183 and `:laddfile`.
5184
5185 This would be mostly useful when you use MS-Windows and set 'encoding'
5186 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5187 'makeencoding' to "char" has the same effect as setting to the system
5188 locale encoding. Example: >
5189 :set encoding=utf-8
5190 :set makeencoding=char " system locale is used
5191<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 *'makeprg'* *'mp'*
5193'makeprg' 'mp' string (default "make", VMS: "MMS")
5194 global or local to buffer |global-local|
5195 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005196 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005197 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5198 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005199 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005200 Environment variables are expanded |:set_env|. See |option-backslash|
5201 about including spaces and backslashes.
5202 Note that a '|' must be escaped twice: once for ":set" and once for
5203 the interpretation of a command. When you use a filter called
5204 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205 :set makeprg=gmake\ \\\|\ myfilter
5206< The placeholder "$*" can be given (even multiple times) to specify
5207 where the arguments will be included, for example: >
5208 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5209< This option cannot be set from a |modeline| or in the |sandbox|, for
5210 security reasons.
5211
5212 *'matchpairs'* *'mps'*
5213'matchpairs' 'mps' string (default "(:),{:},[:]")
5214 local to buffer
5215 {not in Vi}
5216 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005217 other.
5218 Only character pairs are allowed that are different, thus you cannot
5219 jump between two double quotes.
5220 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005221 The pairs must be separated by a comma. Example for including '<' and
5222 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 :set mps+=<:>
5224
5225< A more exotic example, to jump between the '=' and ';' in an
5226 assignment, useful for languages like C and Java: >
5227 :au FileType c,cpp,java set mps+==:;
5228
5229< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005230 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231
5232 *'matchtime'* *'mat'*
5233'matchtime' 'mat' number (default 5)
5234 global
5235 {not in Vi}{in Nvi}
5236 Tenths of a second to show the matching paren, when 'showmatch' is
5237 set. Note that this is not in milliseconds, like other options that
5238 set a time. This is to be compatible with Nvi.
5239
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005240 *'maxcombine'* *'mco'*
5241'maxcombine' 'mco' number (default 2)
5242 global
5243 {not in Vi}
5244 {only available when compiled with the |+multi_byte|
5245 feature}
5246 The maximum number of combining characters supported for displaying.
5247 Only used when 'encoding' is "utf-8".
5248 The default is OK for most languages. Hebrew may require 4.
5249 Maximum value is 6.
5250 Even when this option is set to 2 you can still edit text with more
5251 combining characters, you just can't see them. Use |g8| or |ga|.
5252 See |mbyte-combining|.
5253
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 *'maxfuncdepth'* *'mfd'*
5255'maxfuncdepth' 'mfd' number (default 100)
5256 global
5257 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005258 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005259 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 Maximum depth of function calls for user functions. This normally
5261 catches endless recursion. When using a recursive function with
5262 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5263 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005264 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005265 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266 See also |:function|.
5267
5268 *'maxmapdepth'* *'mmd'* *E223*
5269'maxmapdepth' 'mmd' number (default 1000)
5270 global
5271 {not in Vi}
5272 Maximum number of times a mapping is done without resulting in a
5273 character to be used. This normally catches endless mappings, like
5274 ":map x y" with ":map y x". It still does not catch ":map g wg",
5275 because the 'w' is used before the next mapping is done. See also
5276 |key-mapping|.
5277
5278 *'maxmem'* *'mm'*
5279'maxmem' 'mm' number (default between 256 to 5120 (system
5280 dependent) or half the amount of memory
5281 available)
5282 global
5283 {not in Vi}
5284 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5285 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005286 other memory to be freed.
5287 The maximum usable value is about 2000000. Use this to work without a
5288 limit.
5289 The value is ignored when 'swapfile' is off.
5290 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005292 *'maxmempattern'* *'mmp'*
5293'maxmempattern' 'mmp' number (default 1000)
5294 global
5295 {not in Vi}
5296 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005297 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005298 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005299 When Vim runs into the limit it gives an error message and mostly
5300 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005301 Running into the limit often means that the pattern is very
5302 inefficient or too complex. This may already happen with the pattern
5303 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005304 Might also happen on redraw, when syntax rules try to match a complex
5305 text structure.
5306 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5307 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005308
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 *'maxmemtot'* *'mmt'*
5310'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5311 dependent) or half the amount of memory
5312 available)
5313 global
5314 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005315 Maximum amount of memory in Kbyte to use for all buffers together.
5316 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005317 without a limit.
5318 On 64 bit machines higher values might work. But hey, do you really
5319 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005320 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005321 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005322 Buffers with 'swapfile' off still count to the total amount of memory
5323 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005324 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325
5326 *'menuitems'* *'mis'*
5327'menuitems' 'mis' number (default 25)
5328 global
5329 {not in Vi}
5330 {not available when compiled without the |+menu|
5331 feature}
5332 Maximum number of items to use in a menu. Used for menus that are
5333 generated from a list of items, e.g., the Buffers menu. Changing this
5334 option has no direct effect, the menu must be refreshed first.
5335
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005336 *'mkspellmem'* *'msm'*
5337'mkspellmem' 'msm' string (default "460000,2000,500")
5338 global
5339 {not in Vi}
5340 {not available when compiled without the |+syntax|
5341 feature}
5342 Parameters for |:mkspell|. This tunes when to start compressing the
5343 word tree. Compression can be slow when there are many words, but
5344 it's needed to avoid running out of memory. The amount of memory used
5345 per word depends very much on how similar the words are, that's why
5346 this tuning is complicated.
5347
5348 There are three numbers, separated by commas:
5349 {start},{inc},{added}
5350
5351 For most languages the uncompressed word tree fits in memory. {start}
5352 gives the amount of memory in Kbyte that can be used before any
5353 compression is done. It should be a bit smaller than the amount of
5354 memory that is available to Vim.
5355
5356 When going over the {start} limit the {inc} number specifies the
5357 amount of memory in Kbyte that can be allocated before another
5358 compression is done. A low number means compression is done after
5359 less words are added, which is slow. A high number means more memory
5360 will be allocated.
5361
5362 After doing compression, {added} times 1024 words can be added before
5363 the {inc} limit is ignored and compression is done when any extra
5364 amount of memory is needed. A low number means there is a smaller
5365 chance of hitting the {inc} limit, less memory is used but it's
5366 slower.
5367
5368 The languages for which these numbers are important are Italian and
5369 Hungarian. The default works for when you have about 512 Mbyte. If
5370 you have 1 Gbyte you could use: >
5371 :set mkspellmem=900000,3000,800
5372< If you have less than 512 Mbyte |:mkspell| may fail for some
5373 languages, no matter what you set 'mkspellmem' to.
5374
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005376'modeline' 'ml' boolean (Vim default: on (off for root),
5377 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 local to buffer
5379 *'modelines'* *'mls'*
5380'modelines' 'mls' number (default 5)
5381 global
5382 {not in Vi}
5383 If 'modeline' is on 'modelines' gives the number of lines that is
5384 checked for set commands. If 'modeline' is off or 'modelines' is zero
5385 no lines are checked. See |modeline|.
5386 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5387 set and to the Vim default value when 'compatible' is reset.
5388
5389 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5390'modifiable' 'ma' boolean (default on)
5391 local to buffer
5392 {not in Vi} *E21*
5393 When off the buffer contents cannot be changed. The 'fileformat' and
5394 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005395 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396
5397 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5398'modified' 'mod' boolean (default off)
5399 local to buffer
5400 {not in Vi}
5401 When on, the buffer is considered to be modified. This option is set
5402 when:
5403 1. A change was made to the text since it was last written. Using the
5404 |undo| command to go back to the original text will reset the
5405 option. But undoing changes that were made before writing the
5406 buffer will set the option again, since the text is different from
5407 when it was written.
5408 2. 'fileformat' or 'fileencoding' is different from its original
5409 value. The original value is set when the buffer is read or
5410 written. A ":set nomodified" command also resets the original
5411 values to the current values and the 'modified' option will be
5412 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005413 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005414 This option is not set when a change is made to the buffer as the
5415 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5416 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5417 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5419 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005420 Note that the text may actually be the same, e.g. 'modified' is set
5421 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422
5423 *'more'* *'nomore'*
5424'more' boolean (Vim default: on, Vi default: off)
5425 global
5426 {not in Vi}
5427 When on, listings pause when the whole screen is filled. You will get
5428 the |more-prompt|. When this option is off there are no pauses, the
5429 listing continues until finished.
5430 NOTE: This option is set to the Vi default value when 'compatible' is
5431 set and to the Vim default value when 'compatible' is reset.
5432
5433 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005434'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5435 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 global
5437 {not in Vi}
5438 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005439 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5440 sysmouse and Linux console with gpm). For using the mouse in the
5441 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005443 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 v Visual mode
5445 i Insert mode
5446 c Command-line mode
5447 h all previous modes when editing a help file
5448 a all previous modes
5449 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005450 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451 :set mouse=a
5452< When the mouse is not enabled, the GUI will still use the mouse for
5453 modeless selection. This doesn't move the text cursor.
5454
5455 See |mouse-using|. Also see |'clipboard'|.
5456
5457 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005458 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459 the mouse buttons can still be used by keeping the shift key pressed.
5460 Also see the 'clipboard' option.
5461
5462 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5463'mousefocus' 'mousef' boolean (default off)
5464 global
5465 {not in Vi}
5466 {only works in the GUI}
5467 The window that the mouse pointer is on is automatically activated.
5468 When changing the window layout or window focus in another way, the
5469 mouse pointer is moved to the window with keyboard focus. Off is the
5470 default because it makes using the pull down menus a little goofy, as
5471 a pointer transit may activate a window unintentionally.
5472
5473 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5474'mousehide' 'mh' boolean (default on)
5475 global
5476 {not in Vi}
5477 {only works in the GUI}
5478 When on, the mouse pointer is hidden when characters are typed.
5479 The mouse pointer is restored when the mouse is moved.
5480
5481 *'mousemodel'* *'mousem'*
5482'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5483 global
5484 {not in Vi}
5485 Sets the model to use for the mouse. The name mostly specifies what
5486 the right mouse button is used for:
5487 extend Right mouse button extends a selection. This works
5488 like in an xterm.
5489 popup Right mouse button pops up a menu. The shifted left
5490 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005491 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492 popup_setpos Like "popup", but the cursor will be moved to the
5493 position where the mouse was clicked, and thus the
5494 selected operation will act upon the clicked object.
5495 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005496 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005497 course, that right clicking outside a selection will
5498 end Visual mode.
5499 Overview of what button does what for each model:
5500 mouse extend popup(_setpos) ~
5501 left click place cursor place cursor
5502 left drag start selection start selection
5503 shift-left search word extend selection
5504 right click extend selection popup menu (place cursor)
5505 right drag extend selection -
5506 middle click paste paste
5507
5508 In the "popup" model the right mouse button produces a pop-up menu.
5509 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005510 In a terminal the popup menu works if Vim is compiled with the
5511 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512
5513 Note that you can further refine the meaning of buttons with mappings.
5514 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5515 selection (because that's handled in the GUI code directly).
5516
5517 The 'mousemodel' option is set by the |:behave| command.
5518
5519 *'mouseshape'* *'mouses'* *E547*
5520'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005521 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522 global
5523 {not in Vi}
5524 {only available when compiled with the |+mouseshape|
5525 feature}
5526 This option tells Vim what the mouse pointer should look like in
5527 different modes. The option is a comma separated list of parts, much
5528 like used for 'guicursor'. Each part consist of a mode/location-list
5529 and an argument-list:
5530 mode-list:shape,mode-list:shape,..
5531 The mode-list is a dash separated list of these modes/locations:
5532 In a normal window: ~
5533 n Normal mode
5534 v Visual mode
5535 ve Visual mode with 'selection' "exclusive" (same as 'v',
5536 if not specified)
5537 o Operator-pending mode
5538 i Insert mode
5539 r Replace mode
5540
5541 Others: ~
5542 c appending to the command-line
5543 ci inserting in the command-line
5544 cr replacing in the command-line
5545 m at the 'Hit ENTER' or 'More' prompts
5546 ml idem, but cursor in the last line
5547 e any mode, pointer below last window
5548 s any mode, pointer on a status line
5549 sd any mode, while dragging a status line
5550 vs any mode, pointer on a vertical separator line
5551 vd any mode, while dragging a vertical separator line
5552 a everywhere
5553
5554 The shape is one of the following:
5555 avail name looks like ~
5556 w x arrow Normal mouse pointer
5557 w x blank no pointer at all (use with care!)
5558 w x beam I-beam
5559 w x updown up-down sizing arrows
5560 w x leftright left-right sizing arrows
5561 w x busy The system's usual busy pointer
5562 w x no The system's usual 'no input' pointer
5563 x udsizing indicates up-down resizing
5564 x lrsizing indicates left-right resizing
5565 x crosshair like a big thin +
5566 x hand1 black hand
5567 x hand2 white hand
5568 x pencil what you write with
5569 x question big ?
5570 x rightup-arrow arrow pointing right-up
5571 w x up-arrow arrow pointing up
5572 x <number> any X11 pointer number (see X11/cursorfont.h)
5573
5574 The "avail" column contains a 'w' if the shape is available for Win32,
5575 x for X11.
5576 Any modes not specified or shapes not available use the normal mouse
5577 pointer.
5578
5579 Example: >
5580 :set mouseshape=s:udsizing,m:no
5581< will make the mouse turn to a sizing arrow over the status lines and
5582 indicate no input when the hit-enter prompt is displayed (since
5583 clicking the mouse has no effect in this state.)
5584
5585 *'mousetime'* *'mouset'*
5586'mousetime' 'mouset' number (default 500)
5587 global
5588 {not in Vi}
5589 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5590 time in msec between two mouse clicks for the second click to be
5591 recognized as a multi click.
5592
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005593 *'mzschemedll'*
5594'mzschemedll' string (default depends on the build)
5595 global
5596 {not in Vi}
5597 {only available when compiled with the |+mzscheme/dyn|
5598 feature}
5599 Specifies the name of the MzScheme shared library. The default is
5600 DYNAMIC_MZSCH_DLL which was specified at compile time.
5601 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005602 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005603 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005604 This option cannot be set from a |modeline| or in the |sandbox|, for
5605 security reasons.
5606
5607 *'mzschemegcdll'*
5608'mzschemegcdll' string (default depends on the build)
5609 global
5610 {not in Vi}
5611 {only available when compiled with the |+mzscheme/dyn|
5612 feature}
5613 Specifies the name of the MzScheme GC shared library. The default is
5614 DYNAMIC_MZGC_DLL which was specified at compile time.
5615 The value can be equal to 'mzschemedll' if it includes the GC code.
5616 Environment variables are expanded |:set_env|.
5617 This option cannot be set from a |modeline| or in the |sandbox|, for
5618 security reasons.
5619
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005620 *'mzquantum'* *'mzq'*
5621'mzquantum' 'mzq' number (default 100)
5622 global
5623 {not in Vi}
5624 {not available when compiled without the |+mzscheme|
5625 feature}
5626 The number of milliseconds between polls for MzScheme threads.
5627 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005628 NOTE: This option is set to the Vim default value when 'compatible'
5629 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005630
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005632'nrformats' 'nf' string (default "bin,octal,hex",
5633 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634 local to buffer
5635 {not in Vi}
5636 This defines what bases Vim will consider for numbers when using the
5637 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5638 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005639 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005640 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005641 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005642 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005644 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005645 considered to be hexadecimal. Example: Using CTRL-X on
5646 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005647 bin If included, numbers starting with "0b" or "0B" will be
5648 considered to be binary. Example: Using CTRL-X on
5649 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650 Numbers which simply begin with a digit in the range 1-9 are always
5651 considered decimal. This also happens for numbers that are not
5652 recognized as octal or hex.
5653
5654 *'number'* *'nu'* *'nonumber'* *'nonu'*
5655'number' 'nu' boolean (default off)
5656 local to window
5657 Print the line number in front of each line. When the 'n' option is
5658 excluded from 'cpoptions' a wrapped line will not use the column of
5659 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005660 The 'numberwidth' option can be used to set the room used for the line
5661 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662 When a long, wrapped line doesn't start with the first character, '-'
5663 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005664 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5665 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005666 *number_relativenumber*
5667 The 'relativenumber' option changes the displayed number to be
5668 relative to the cursor. Together with 'number' there are these
5669 four combinations (cursor in line 3):
5670
Bram Moolenaar3848e002016-03-19 18:42:29 +01005671 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005672 'nornu' 'nornu' 'rnu' 'rnu'
5673
5674 |apple | 1 apple | 2 apple | 2 apple
5675 |pear | 2 pear | 1 pear | 1 pear
5676 |nobody | 3 nobody | 0 nobody |3 nobody
5677 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005679 *'numberwidth'* *'nuw'*
5680'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5681 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005682 {not in Vi}
5683 {only available when compiled with the |+linebreak|
5684 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005685 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005686 when the 'number' or 'relativenumber' option is set or printing lines
5687 with a line number. Since one space is always between the number and
5688 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005689 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005690 fit the highest line number in the buffer respectively the number of
5691 rows in the window, depending on whether 'number' or 'relativenumber'
5692 is set. Thus with the Vim default of 4 there is room for a line number
5693 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005694 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005695 NOTE: This option is set to the Vi default value when 'compatible' is
5696 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005697
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005698 *'omnifunc'* *'ofu'*
5699'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005700 local to buffer
5701 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005702 {not available when compiled without the |+eval|
5703 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005704 This option specifies a function to be used for Insert mode omni
5705 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005706 See |complete-functions| for an explanation of how the function is
5707 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005708 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005709 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005710 This option cannot be set from a |modeline| or in the |sandbox|, for
5711 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005712
5713
Bram Moolenaar02467872007-05-06 13:22:01 +00005714 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005715'opendevice' 'odev' boolean (default off)
5716 global
5717 {not in Vi}
5718 {only for MS-DOS, MS-Windows and OS/2}
5719 Enable reading and writing from devices. This may get Vim stuck on a
5720 device that can be opened but doesn't actually do the I/O. Therefore
5721 it is off by default.
5722 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5723 result in editing a device.
5724
5725
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005726 *'operatorfunc'* *'opfunc'*
5727'operatorfunc' 'opfunc' string (default: empty)
5728 global
5729 {not in Vi}
5730 This option specifies a function to be called by the |g@| operator.
5731 See |:map-operator| for more info and an example.
5732
5733 This option cannot be set from a |modeline| or in the |sandbox|, for
5734 security reasons.
5735
5736
Bram Moolenaar251e1912011-06-19 05:09:16 +02005737 *'osfiletype'* *'oft'*
5738'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739 local to buffer
5740 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005741 This option was supported on RISC OS, which has been removed.
5742
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005744 *'packpath'* *'pp'*
5745'packpath' 'pp' string (default: see 'runtimepath')
5746 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005747 Directories used to find packages. See |packages|.
5748
5749
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005751'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752 global
5753 Specifies the nroff macros that separate paragraphs. These are pairs
5754 of two letters (see |object-motions|).
5755
5756 *'paste'* *'nopaste'*
5757'paste' boolean (default off)
5758 global
5759 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005760 Put Vim in Paste mode. This is useful if you want to cut or copy
5761 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762 unexpected effects.
5763 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005764 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005765 knows about pasting and will mostly do the right thing without 'paste'
5766 being set. The same is true for a terminal where Vim handles the
5767 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005768 This option is reset when starting the GUI. Thus if you set it in
5769 your .vimrc it will work in a terminal, but not in the GUI. Setting
5770 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5771 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772 When the 'paste' option is switched on (also when it was already on):
5773 - mapping in Insert mode and Command-line mode is disabled
5774 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005776 - 'expandtab' is reset
5777 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 - 'revins' is reset
5779 - 'ruler' is reset
5780 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005781 - 'smartindent' is reset
5782 - 'smarttab' is reset
5783 - 'softtabstop' is set to 0
5784 - 'textwidth' is set to 0
5785 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005786 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005787 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005788 - 'indentexpr'
5789 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790 NOTE: When you start editing another file while the 'paste' option is
5791 on, settings from the modelines or autocommands may change the
5792 settings again, causing trouble when pasting text. You might want to
5793 set the 'paste' option again.
5794 When the 'paste' option is reset the mentioned options are restored to
5795 the value before the moment 'paste' was switched from off to on.
5796 Resetting 'paste' before ever setting it does not have any effect.
5797 Since mapping doesn't work while 'paste' is active, you need to use
5798 the 'pastetoggle' option to toggle the 'paste' option with some key.
5799
5800 *'pastetoggle'* *'pt'*
5801'pastetoggle' 'pt' string (default "")
5802 global
5803 {not in Vi}
5804 When non-empty, specifies the key sequence that toggles the 'paste'
5805 option. This is like specifying a mapping: >
5806 :map {keys} :set invpaste<CR>
5807< Where {keys} is the value of 'pastetoggle'.
5808 The difference is that it will work even when 'paste' is set.
5809 'pastetoggle' works in Insert mode and Normal mode, but not in
5810 Command-line mode.
5811 Mappings are checked first, thus overrule 'pastetoggle'. However,
5812 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5813 this: >
5814 :map <F10> :set paste<CR>
5815 :map <F11> :set nopaste<CR>
5816 :imap <F10> <C-O>:set paste<CR>
5817 :imap <F11> <nop>
5818 :set pastetoggle=<F11>
5819< This will make <F10> start paste mode and <F11> stop paste mode.
5820 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5821 mode everything is inserted literally, except the 'pastetoggle' key
5822 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005823 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824
5825 *'pex'* *'patchexpr'*
5826'patchexpr' 'pex' string (default "")
5827 global
5828 {not in Vi}
5829 {not available when compiled without the |+diff|
5830 feature}
5831 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005832 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833
Bram Moolenaardbc28022014-07-26 13:40:44 +02005834 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835'patchmode' 'pm' string (default "")
5836 global
5837 {not in Vi}
5838 When non-empty the oldest version of a file is kept. This can be used
5839 to keep the original version of a file if you are changing files in a
5840 source distribution. Only the first time that a file is written a
5841 copy of the original file will be kept. The name of the copy is the
5842 name of the original file with the string in the 'patchmode' option
5843 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005844 ".orig" or ".org". 'backupdir' must not be empty for this to work
5845 (Detail: The backup file is renamed to the patchmode file after the
5846 new file has been successfully written, that's why it must be possible
5847 to write a backup file). If there was no file to be backed up, an
5848 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849 When the 'backupskip' pattern matches, a patchmode file is not made.
5850 Using 'patchmode' for compressed files appends the extension at the
5851 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5852 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005853 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005854
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005855 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856'path' 'pa' string (default on Unix: ".,/usr/include,,"
5857 on OS/2: ".,/emx/include,,"
5858 other systems: ".,,")
5859 global or local to buffer |global-local|
5860 {not in Vi}
5861 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005862 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5863 provided that the file being searched for has a relative path (not
5864 starting with "/", "./" or "../"). The directories in the 'path'
5865 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866 - Use commas to separate directory names: >
5867 :set path=.,/usr/local/include,/usr/include
5868< - Spaces can also be used to separate directory names (for backwards
5869 compatibility with version 3.0). To have a space in a directory
5870 name, precede it with an extra backslash, and escape the space: >
5871 :set path=.,/dir/with\\\ space
5872< - To include a comma in a directory name precede it with an extra
5873 backslash: >
5874 :set path=.,/dir/with\\,comma
5875< - To search relative to the directory of the current file, use: >
5876 :set path=.
5877< - To search in the current directory use an empty string between two
5878 commas: >
5879 :set path=,,
5880< - A directory name may end in a ':' or '/'.
5881 - Environment variables are expanded |:set_env|.
5882 - When using |netrw.vim| URLs can be used. For example, adding
5883 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005884 - Search upwards and downwards in a directory tree using "*", "**" and
5885 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 {not available when compiled without the |+path_extra| feature}
5887 - Careful with '\' characters, type two to get one in the option: >
5888 :set path=.,c:\\include
5889< Or just use '/' instead: >
5890 :set path=.,c:/include
5891< Don't forget "." or files won't even be found in the same directory as
5892 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005893 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894 it is something like 256 or 1024 characters.
5895 You can check if all the include files are found, using the value of
5896 'path', see |:checkpath|.
5897 The use of |:set+=| and |:set-=| is preferred when adding or removing
5898 directories from the list. This avoids problems when a future version
5899 uses another default. To remove the current directory use: >
5900 :set path-=
5901< To add the current directory use: >
5902 :set path+=
5903< To use an environment variable, you probably need to replace the
5904 separator. Here is an example to append $INCL, in which directory
5905 names are separated with a semi-colon: >
5906 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5907< Replace the ';' with a ':' or whatever separator is used. Note that
5908 this doesn't work when $INCL contains a comma or white space.
5909
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005910 *'perldll'*
5911'perldll' string (default depends on the build)
5912 global
5913 {not in Vi}
5914 {only available when compiled with the |+perl/dyn|
5915 feature}
5916 Specifies the name of the Perl shared library. The default is
5917 DYNAMIC_PERL_DLL, which was specified at compile time.
5918 Environment variables are expanded |:set_env|.
5919 This option cannot be set from a |modeline| or in the |sandbox|, for
5920 security reasons.
5921
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5923'preserveindent' 'pi' boolean (default off)
5924 local to buffer
5925 {not in Vi}
5926 When changing the indent of the current line, preserve as much of the
5927 indent structure as possible. Normally the indent is replaced by a
5928 series of tabs followed by spaces as required (unless |'expandtab'| is
5929 enabled, in which case only spaces are used). Enabling this option
5930 means the indent will preserve as many existing characters as possible
5931 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005932 'expandtab' does not apply to the preserved white space, a Tab remains
5933 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 NOTE: When using ">>" multiple times the resulting indent is a mix of
5935 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005936 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005937 Also see 'copyindent'.
5938 Use |:retab| to clean up white space.
5939
5940 *'previewheight'* *'pvh'*
5941'previewheight' 'pvh' number (default 12)
5942 global
5943 {not in Vi}
5944 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005945 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005946 Default height for a preview window. Used for |:ptag| and associated
5947 commands. Used for |CTRL-W_}| when no count is given.
5948
5949 *'previewwindow'* *'nopreviewwindow'*
5950 *'pvw'* *'nopvw'* *E590*
5951'previewwindow' 'pvw' boolean (default off)
5952 local to window
5953 {not in Vi}
5954 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005955 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005956 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 set. It's normally not set directly, but by using one of the commands
5958 |:ptag|, |:pedit|, etc.
5959
5960 *'printdevice'* *'pdev'*
5961'printdevice' 'pdev' string (default empty)
5962 global
5963 {not in Vi}
5964 {only available when compiled with the |+printer|
5965 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005966 The name of the printer to be used for |:hardcopy|.
5967 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005968 This option cannot be set from a |modeline| or in the |sandbox|, for
5969 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005970
Bram Moolenaar8299df92004-07-10 09:47:34 +00005971 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005972'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005973 global
5974 {not in Vi}
5975 {only available when compiled with the |+printer|
5976 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005977 Sets the character encoding used when printing.
5978 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005979
5980 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005981'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005982 global
5983 {not in Vi}
5984 {only available when compiled with the |+printer|
5985 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005986 Expression used to print the PostScript produced with |:hardcopy|.
5987 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005988 This option cannot be set from a |modeline| or in the |sandbox|, for
5989 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005990
Bram Moolenaar8299df92004-07-10 09:47:34 +00005991 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005992'printfont' 'pfn' string (default "courier")
5993 global
5994 {not in Vi}
5995 {only available when compiled with the |+printer|
5996 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005997 The name of the font that will be used for |:hardcopy|.
5998 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999
6000 *'printheader'* *'pheader'*
6001'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6002 global
6003 {not in Vi}
6004 {only available when compiled with the |+printer|
6005 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006006 The format of the header produced in |:hardcopy| output.
6007 See |pheader-option|.
6008
6009 *'printmbcharset'* *'pmbcs'*
6010'printmbcharset' 'pmbcs' string (default "")
6011 global
6012 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006013 {only available when compiled with the |+printer|,
6014 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006015 The CJK character set to be used for CJK output from |:hardcopy|.
6016 See |pmbcs-option|.
6017
6018 *'printmbfont'* *'pmbfn'*
6019'printmbfont' 'pmbfn' string (default "")
6020 global
6021 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006022 {only available when compiled with the |+printer|,
6023 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006024 List of font names to be used for CJK output from |:hardcopy|.
6025 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006026
6027 *'printoptions'* *'popt'*
6028'printoptions' 'popt' string (default "")
6029 global
6030 {not in Vi}
6031 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006032 List of items that control the format of the output of |:hardcopy|.
6033 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006034
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006035 *'prompt'* *'noprompt'*
6036'prompt' boolean (default on)
6037 global
6038 When on a ":" prompt is used in Ex mode.
6039
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006040 *'pumheight'* *'ph'*
6041'pumheight' 'ph' number (default 0)
6042 global
6043 {not available when compiled without the
6044 |+insert_expand| feature}
6045 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006046 Determines the maximum number of items to show in the popup menu for
6047 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006048 |ins-completion-menu|.
6049
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006050 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006051'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006052 global
6053 {not available when compiled without the
6054 |+insert_expand| feature}
6055 {not in Vi}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006056 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006057 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006058
Bram Moolenaard94464e2015-11-02 15:28:18 +01006059 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006060'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006061 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006062 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006063 {only available when compiled with the |+python/dyn|
6064 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006065 Specifies the name of the Python 2.x shared library. The default is
6066 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006067 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006068 This option cannot be set from a |modeline| or in the |sandbox|, for
6069 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006070
Bram Moolenaar94073162018-01-31 21:49:05 +01006071 *'pythonhome'*
6072'pythonhome' string (default "")
6073 global
6074 {not in Vi}
6075 {only available when compiled with the |+python/dyn|
6076 feature}
6077 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6078 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6079 which was specified at compile time, will be used for the Python 2.x
6080 home directory.
6081 Environment variables are expanded |:set_env|.
6082 This option cannot be set from a |modeline| or in the |sandbox|, for
6083 security reasons.
6084
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006085 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006086'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006087 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006088 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006089 {only available when compiled with the |+python3/dyn|
6090 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006091 Specifies the name of the Python 3 shared library. The default is
6092 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006093 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006094 This option cannot be set from a |modeline| or in the |sandbox|, for
6095 security reasons.
6096
Bram Moolenaar94073162018-01-31 21:49:05 +01006097 *'pythonthreehome'*
6098'pythonthreehome' string (default "")
6099 global
6100 {not in Vi}
6101 {only available when compiled with the |+python3/dyn|
6102 feature}
6103 Specifies the name of the Python 3 home directory. When
6104 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6105 PYTHON3_HOME, which was specified at compile time, will be used for
6106 the Python 3 home directory.
6107 Environment variables are expanded |:set_env|.
6108 This option cannot be set from a |modeline| or in the |sandbox|, for
6109 security reasons.
6110
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006111 *'pyxversion'* *'pyx'*
6112'pyxversion' 'pyx' number (default depends on the build)
6113 global
6114 {not in Vi}
6115 {only available when compiled with the |+python| or
6116 the |+python3| feature}
6117 Specifies the python version used for pyx* functions and commands
6118 |python_x|. The default value is as follows:
6119
6120 Compiled with Default ~
6121 |+python| and |+python3| 0
6122 only |+python| 2
6123 only |+python3| 3
6124
6125 Available values are 0, 2 and 3.
6126 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6127 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6128 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6129 to 2 if Python 2 is available.
6130 See also: |has-pythonx|
6131
6132 If Vim is compiled with only |+python| or |+python3| setting
6133 'pyxversion' has no effect. The pyx* functions and commands are
6134 always the same as the compiled version.
6135
6136 This option cannot be set from a |modeline| or in the |sandbox|, for
6137 security reasons.
6138
Bram Moolenaar677ee682005-01-27 14:41:15 +00006139 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006140'quoteescape' 'qe' string (default "\")
6141 local to buffer
6142 {not in Vi}
6143 The characters that are used to escape quotes in a string. Used for
6144 objects like a', a" and a` |a'|.
6145 When one of the characters in this option is found inside a string,
6146 the following character will be skipped. The default value makes the
6147 text "foo\"bar\\" considered to be one string.
6148
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6150'readonly' 'ro' boolean (default off)
6151 local to buffer
6152 If on, writes fail unless you use a '!'. Protects you from
6153 accidentally overwriting a file. Default on when Vim is started
6154 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006155 When using ":w!" the 'readonly' option is reset for the current
6156 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006157 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006158 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006159 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006160
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006161 *'redrawtime'* *'rdt'*
6162'redrawtime' 'rdt' number (default 2000)
6163 global
6164 {not in Vi}
6165 {only available when compiled with the |+reltime|
6166 feature}
6167 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006168 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006169 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006170 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006171 matches will be highlighted.
6172 For syntax highlighting the time applies per window. When over the
6173 limit syntax highlighting is disabled until |CTRL-L| is used.
6174 This is used to avoid that Vim hangs when using a very complicated
6175 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006176
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006177 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006178'regexpengine' 're' number (default 0)
6179 global
6180 {not in Vi}
6181 This selects the default regexp engine. |two-engines|
6182 The possible values are:
6183 0 automatic selection
6184 1 old engine
6185 2 NFA engine
6186 Note that when using the NFA engine and the pattern contains something
6187 that is not supported the pattern will not match. This is only useful
6188 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006189 Using automatic selection enables Vim to switch the engine, if the
6190 default engine becomes too costly. E.g., when the NFA engine uses too
6191 many states. This should prevent Vim from hanging on a combination of
6192 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006193
Bram Moolenaar64486672010-05-16 15:46:46 +02006194 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6195'relativenumber' 'rnu' boolean (default off)
6196 local to window
6197 {not in Vi}
6198 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006199 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006200 precede some vertical motion commands (e.g. j k + -) with, without
6201 having to calculate it yourself. Especially useful in combination with
6202 other commands (e.g. y d c < > gq gw =).
6203 When the 'n' option is excluded from 'cpoptions' a wrapped
6204 line will not use the column of line numbers (this is the default when
6205 'compatible' isn't set).
6206 The 'numberwidth' option can be used to set the room used for the line
6207 number.
6208 When a long, wrapped line doesn't start with the first character, '-'
6209 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006210 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6211 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006212
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006213 The number in front of the cursor line also depends on the value of
6214 'number', see |number_relativenumber| for all combinations of the two
6215 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006216
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 *'remap'* *'noremap'*
6218'remap' boolean (default on)
6219 global
6220 Allows for mappings to work recursively. If you do not want this for
6221 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006222 NOTE: To avoid portability problems with Vim scripts, always keep
6223 this option at the default "on". Only switch it off when working with
6224 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006226 *'renderoptions'* *'rop'*
6227'renderoptions' 'rop' string (default: empty)
6228 global
6229 {not in Vi}
6230 {only available when compiled with GUI and DIRECTX on
6231 MS-Windows}
6232 Select a text renderer and set its options. The options depend on the
6233 renderer.
6234
6235 Syntax: >
6236 set rop=type:{renderer}(,{name}:{value})*
6237<
6238 Currently, only one optional renderer is available.
6239
6240 render behavior ~
6241 directx Vim will draw text using DirectX (DirectWrite). It makes
6242 drawn glyphs more beautiful than default GDI.
6243 It requires 'encoding' is "utf-8", and only works on
6244 MS-Windows Vista or newer version.
6245
6246 Options:
6247 name meaning type value ~
6248 gamma gamma float 1.0 - 2.2 (maybe)
6249 contrast enhancedContrast float (unknown)
6250 level clearTypeLevel float (unknown)
6251 geom pixelGeometry int 0 - 2 (see below)
6252 renmode renderingMode int 0 - 6 (see below)
6253 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006254 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006255
Bram Moolenaar92467d32017-12-05 13:22:16 +01006256 See this URL for detail (except for scrlines):
6257 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006258
6259 For geom: structure of a device pixel.
6260 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6261 1 - DWRITE_PIXEL_GEOMETRY_RGB
6262 2 - DWRITE_PIXEL_GEOMETRY_BGR
6263
6264 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006265 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006266
6267 For renmode: method of rendering glyphs.
6268 0 - DWRITE_RENDERING_MODE_DEFAULT
6269 1 - DWRITE_RENDERING_MODE_ALIASED
6270 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6271 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6272 4 - DWRITE_RENDERING_MODE_NATURAL
6273 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6274 6 - DWRITE_RENDERING_MODE_OUTLINE
6275
6276 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006277 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006278
6279 For taamode: antialiasing mode used for drawing text.
6280 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6281 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6282 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6283 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6284
6285 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006286 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6287
Bram Moolenaara338adc2018-01-31 20:51:47 +01006288 For scrlines:
6289 This was used for optimizing scrolling behavior, however this
6290 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006291
6292 Example: >
6293 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006294 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006295 set rop=type:directx
6296<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006297 If select a raster font (Courier, Terminal or FixedSys which
6298 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006299 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006300
6301 NOTE: It is known that some fonts and options combination
6302 causes trouble on drawing glyphs.
6303
Bram Moolenaar92467d32017-12-05 13:22:16 +01006304 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006305 special made fonts (True-Type fonts which includes only
6306 bitmap glyphs).
6307 - 'taamode:3' will not work with some vector fonts.
6308
6309 NOTE: With this option, you can display colored emoji
6310 (emoticon) in Windows 8.1 or later. To display colored emoji,
6311 there are some conditions which you should notice.
6312
6313 - If your font includes non-colored emoji already, it will
6314 be used.
6315 - If your font doesn't have emoji, the system chooses an
6316 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6317 will be used.
6318 - When this alternative font didn't have fixed width glyph,
6319 emoji might be rendered beyond the bounding box of drawing
6320 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006321
6322 Other render types are currently not supported.
6323
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 *'report'*
6325'report' number (default 2)
6326 global
6327 Threshold for reporting number of lines changed. When the number of
6328 changed lines is more than 'report' a message will be given for most
6329 ":" commands. If you want it always, set 'report' to 0.
6330 For the ":substitute" command the number of substitutions is used
6331 instead of the number of lines.
6332
6333 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6334'restorescreen' 'rs' boolean (default on)
6335 global
6336 {not in Vi} {only in Windows 95/NT console version}
6337 When set, the screen contents is restored when exiting Vim. This also
6338 happens when executing external commands.
6339
6340 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6341 options in your .vimrc. To disable restoring:
6342 set t_ti= t_te=
6343 To enable restoring (for an xterm):
6344 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6345 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6346
6347 *'revins'* *'ri'* *'norevins'* *'nori'*
6348'revins' 'ri' boolean (default off)
6349 global
6350 {not in Vi}
6351 {only available when compiled with the |+rightleft|
6352 feature}
6353 Inserting characters in Insert mode will work backwards. See "typing
6354 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6355 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006356 NOTE: This option is reset when 'compatible' is set.
6357 This option is reset when 'paste' is set and restored when 'paste' is
6358 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359
6360 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6361'rightleft' 'rl' boolean (default off)
6362 local to window
6363 {not in Vi}
6364 {only available when compiled with the |+rightleft|
6365 feature}
6366 When on, display orientation becomes right-to-left, i.e., characters
6367 that are stored in the file appear from the right to the left.
6368 Using this option, it is possible to edit files for languages that
6369 are written from the right to the left such as Hebrew and Arabic.
6370 This option is per window, so it is possible to edit mixed files
6371 simultaneously, or to view the same file in both ways (this is
6372 useful whenever you have a mixed text file with both right-to-left
6373 and left-to-right strings so that both sets are displayed properly
6374 in different windows). Also see |rileft.txt|.
6375
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006376 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006377'rightleftcmd' 'rlc' string (default "search")
6378 local to window
6379 {not in Vi}
6380 {only available when compiled with the |+rightleft|
6381 feature}
6382 Each word in this option enables the command line editing to work in
6383 right-to-left mode for a group of commands:
6384
6385 search "/" and "?" commands
6386
6387 This is useful for languages such as Hebrew, Arabic and Farsi.
6388 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6389
Bram Moolenaard94464e2015-11-02 15:28:18 +01006390 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006391'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006392 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006393 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006394 {only available when compiled with the |+ruby/dyn|
6395 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006396 Specifies the name of the Ruby shared library. The default is
6397 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006398 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006399 This option cannot be set from a |modeline| or in the |sandbox|, for
6400 security reasons.
6401
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006403'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404 global
6405 {not in Vi}
6406 {not available when compiled without the
6407 |+cmdline_info| feature}
6408 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006409 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 text in the file is shown on the far right:
6411 Top first line is visible
6412 Bot last line is visible
6413 All first and last line are visible
6414 45% relative position in the file
6415 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006416 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006417 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006418 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419 this option takes precedence over 'ruler' and 'rulerformat'
6420 If the number of characters displayed is different from the number of
6421 bytes in the text (e.g., for a TAB or a multi-byte character), both
6422 the text column (byte number) and the screen column are shown,
6423 separated with a dash.
6424 For an empty line "0-1" is shown.
6425 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006426 This option is reset when 'paste' is set and restored when 'paste' is
6427 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006428 If you don't want to see the ruler all the time but want to know where
6429 you are, use "g CTRL-G" |g_CTRL-G|.
6430 NOTE: This option is reset when 'compatible' is set.
6431
6432 *'rulerformat'* *'ruf'*
6433'rulerformat' 'ruf' string (default empty)
6434 global
6435 {not in Vi}
6436 {not available when compiled without the |+statusline|
6437 feature}
6438 When this option is not empty, it determines the content of the ruler
6439 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006440 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441 The default ruler width is 17 characters. To make the ruler 15
6442 characters wide, put "%15(" at the start and "%)" at the end.
6443 Example: >
6444 :set rulerformat=%15(%c%V\ %p%%%)
6445<
6446 *'runtimepath'* *'rtp'* *vimfiles*
6447'runtimepath' 'rtp' string (default:
6448 Unix: "$HOME/.vim,
6449 $VIM/vimfiles,
6450 $VIMRUNTIME,
6451 $VIM/vimfiles/after,
6452 $HOME/.vim/after"
6453 Amiga: "home:vimfiles,
6454 $VIM/vimfiles,
6455 $VIMRUNTIME,
6456 $VIM/vimfiles/after,
6457 home:vimfiles/after"
6458 PC, OS/2: "$HOME/vimfiles,
6459 $VIM/vimfiles,
6460 $VIMRUNTIME,
6461 $VIM/vimfiles/after,
6462 $HOME/vimfiles/after"
6463 Macintosh: "$VIM:vimfiles,
6464 $VIMRUNTIME,
6465 $VIM:vimfiles:after"
6466 RISC-OS: "Choices:vimfiles,
6467 $VIMRUNTIME,
6468 Choices:vimfiles/after"
6469 VMS: "sys$login:vimfiles,
6470 $VIM/vimfiles,
6471 $VIMRUNTIME,
6472 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006473 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474 global
6475 {not in Vi}
6476 This is a list of directories which will be searched for runtime
6477 files:
6478 filetype.vim filetypes by file name |new-filetype|
6479 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006480 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481 colors/ color scheme files |:colorscheme|
6482 compiler/ compiler files |:compiler|
6483 doc/ documentation |write-local-help|
6484 ftplugin/ filetype plugins |write-filetype-plugin|
6485 indent/ indent scripts |indent-expression|
6486 keymap/ key mapping files |mbyte-keymap|
6487 lang/ menu translations |:menutrans|
6488 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006489 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 plugin/ plugin scripts |write-plugin|
6491 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006492 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493 syntax/ syntax files |mysyntaxfile|
6494 tutor/ files for vimtutor |tutor|
6495
6496 And any other file searched for with the |:runtime| command.
6497
6498 The defaults for most systems are setup to search five locations:
6499 1. In your home directory, for your personal preferences.
6500 2. In a system-wide Vim directory, for preferences from the system
6501 administrator.
6502 3. In $VIMRUNTIME, for files distributed with Vim.
6503 *after-directory*
6504 4. In the "after" directory in the system-wide Vim directory. This is
6505 for the system administrator to overrule or add to the distributed
6506 defaults (rarely needed)
6507 5. In the "after" directory in your home directory. This is for
6508 personal preferences to overrule or add to the distributed defaults
6509 or system-wide settings (rarely needed).
6510
Bram Moolenaard0796902016-09-16 20:02:31 +02006511 More entries are added when using |packages|. If it gets very long
6512 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6513 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006514
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6516 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006517 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 wildcards.
6519 See |:runtime|.
6520 Example: >
6521 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6522< This will use the directory "~/vimruntime" first (containing your
6523 personal Vim runtime files), then "/mygroup/vim" (shared between a
6524 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6525 files).
6526 You probably should always include $VIMRUNTIME somewhere, to use the
6527 distributed runtime files. You can put a directory before $VIMRUNTIME
6528 to find files which replace a distributed runtime files. You can put
6529 a directory after $VIMRUNTIME to find files which add to distributed
6530 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006531 When Vim is started with |--clean| the home directory entries are not
6532 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533 This option cannot be set from a |modeline| or in the |sandbox|, for
6534 security reasons.
6535
6536 *'scroll'* *'scr'*
6537'scroll' 'scr' number (default: half the window height)
6538 local to window
6539 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6540 set to half the number of lines in the window when the window size
6541 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006542 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6544 the number of screen lines instead of file lines, makes a difference
6545 when lines wrap}
6546
6547 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6548'scrollbind' 'scb' boolean (default off)
6549 local to window
6550 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551 See also |scroll-binding|. When this option is set, the current
6552 window scrolls as other scrollbind windows (windows that also have
6553 this option set) scroll. This option is useful for viewing the
6554 differences between two versions of a file, see 'diff'.
6555 See |'scrollopt'| for options that determine how this option should be
6556 interpreted.
6557 This option is mostly reset when splitting a window to edit another
6558 file. This means that ":split | edit file" results in two windows
6559 with scroll-binding, but ":split file" does not.
6560
6561 *'scrolljump'* *'sj'*
6562'scrolljump' 'sj' number (default 1)
6563 global
6564 {not in Vi}
6565 Minimal number of lines to scroll when the cursor gets off the
6566 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6567 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006568 When set to a negative number from -1 to -100 this is used as the
6569 percentage of the window height. Thus -50 scrolls half the window
6570 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 NOTE: This option is set to 1 when 'compatible' is set.
6572
6573 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006574'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006575 global
6576 {not in Vi}
6577 Minimal number of screen lines to keep above and below the cursor.
6578 This will make some context visible around where you are working. If
6579 you set it to a very large value (999) the cursor line will always be
6580 in the middle of the window (except at the start or end of the file or
6581 when long lines wrap).
6582 For scrolling horizontally see 'sidescrolloff'.
6583 NOTE: This option is set to 0 when 'compatible' is set.
6584
6585 *'scrollopt'* *'sbo'*
6586'scrollopt' 'sbo' string (default "ver,jump")
6587 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 {not in Vi}
6589 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006590 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6591 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592 The following words are available:
6593 ver Bind vertical scrolling for 'scrollbind' windows
6594 hor Bind horizontal scrolling for 'scrollbind' windows
6595 jump Applies to the offset between two windows for vertical
6596 scrolling. This offset is the difference in the first
6597 displayed line of the bound windows. When moving
6598 around in a window, another 'scrollbind' window may
6599 reach a position before the start or after the end of
6600 the buffer. The offset is not changed though, when
6601 moving back the 'scrollbind' window will try to scroll
6602 to the desired position when possible.
6603 When now making that window the current one, two
6604 things can be done with the relative offset:
6605 1. When "jump" is not included, the relative offset is
6606 adjusted for the scroll position in the new current
6607 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006608 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006609 2. When "jump" is included, the other windows are
6610 scrolled to keep the same relative offset. When
6611 going back to the other window, it still uses the
6612 same relative offset.
6613 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006614 When 'diff' mode is active there always is vertical scroll binding,
6615 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616
6617 *'sections'* *'sect'*
6618'sections' 'sect' string (default "SHNHH HUnhsh")
6619 global
6620 Specifies the nroff macros that separate sections. These are pairs of
6621 two letters (See |object-motions|). The default makes a section start
6622 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6623
6624 *'secure'* *'nosecure'* *E523*
6625'secure' boolean (default off)
6626 global
6627 {not in Vi}
6628 When on, ":autocmd", shell and write commands are not allowed in
6629 ".vimrc" and ".exrc" in the current directory and map commands are
6630 displayed. Switch it off only if you know that you will not run into
6631 problems, or when the 'exrc' option is off. On Unix this option is
6632 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006633 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 'secure' at the end of your ~/.vimrc then.
6635 This option cannot be set from a |modeline| or in the |sandbox|, for
6636 security reasons.
6637
6638 *'selection'* *'sel'*
6639'selection' 'sel' string (default "inclusive")
6640 global
6641 {not in Vi}
6642 This option defines the behavior of the selection. It is only used
6643 in Visual and Select mode.
6644 Possible values:
6645 value past line inclusive ~
6646 old no yes
6647 inclusive yes yes
6648 exclusive yes no
6649 "past line" means that the cursor is allowed to be positioned one
6650 character past the line.
6651 "inclusive" means that the last character of the selection is included
6652 in an operation. For example, when "x" is used to delete the
6653 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006654 When "old" is used and 'virtualedit' allows the cursor to move past
6655 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 Note that when "exclusive" is used and selecting from the end
6657 backwards, you cannot include the last character of a line, when
6658 starting in Normal mode and 'virtualedit' empty.
6659
6660 The 'selection' option is set by the |:behave| command.
6661
6662 *'selectmode'* *'slm'*
6663'selectmode' 'slm' string (default "")
6664 global
6665 {not in Vi}
6666 This is a comma separated list of words, which specifies when to start
6667 Select mode instead of Visual mode, when a selection is started.
6668 Possible values:
6669 mouse when using the mouse
6670 key when using shifted special keys
6671 cmd when using "v", "V" or CTRL-V
6672 See |Select-mode|.
6673 The 'selectmode' option is set by the |:behave| command.
6674
6675 *'sessionoptions'* *'ssop'*
6676'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006677 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678 global
6679 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006680 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681 feature}
6682 Changes the effect of the |:mksession| command. It is a comma
6683 separated list of words. Each word enables saving and restoring
6684 something:
6685 word save and restore ~
6686 blank empty windows
6687 buffers hidden and unloaded buffers, not just those in windows
6688 curdir the current directory
6689 folds manually created folds, opened/closed folds and local
6690 fold options
6691 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006692 and contain at least one lowercase letter. Only
6693 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 help the help window
6695 localoptions options and mappings local to a window or buffer (not
6696 global values for local options)
6697 options all options and mappings (also global values for local
6698 options)
6699 resize size of the Vim window: 'lines' and 'columns'
6700 sesdir the directory in which the session file is located
6701 will become the current directory (useful with
6702 projects accessed over a network from different
6703 systems)
6704 slash backslashes in file names replaced with forward
6705 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006706 tabpages all tab pages; without this only the current tab page
6707 is restored, so that you can make a session for each
6708 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006709 terminal include terminal windows where the command can be
6710 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006711 unix with Unix end-of-line format (single <NL>), even when
6712 on Windows or DOS
6713 winpos position of the whole Vim window
6714 winsize window sizes
6715
6716 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006717 When neither "curdir" nor "sesdir" is included, file names are stored
6718 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 "slash" and "unix" are useful on Windows when sharing session files
6720 with Unix. The Unix version of Vim cannot source dos format scripts,
6721 but the Windows version of Vim can source unix format scripts.
6722
6723 *'shell'* *'sh'* *E91*
6724'shell' 'sh' string (default $SHELL or "sh",
6725 MS-DOS and Win32: "command.com" or
6726 "cmd.exe", OS/2: "cmd")
6727 global
6728 Name of the shell to use for ! and :! commands. When changing the
6729 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6730 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006731 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 See |option-backslash| about including spaces and backslashes.
6733 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006734
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006736 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006737 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6738< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006739 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006741 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006743 Example with escaped space (Vim will do this when initializing the
6744 option from $SHELL): >
6745 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006746< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006747 backslashes are consumed by `:set`.
6748
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749 Under MS-Windows, when the executable ends in ".com" it must be
6750 included. Thus setting the shell to "command.com" or "4dos.com"
6751 works, but "command" and "4dos" do not work for all commands (e.g.,
6752 filtering).
6753 For unknown reasons, when using "4dos.com" the current directory is
6754 changed to "C:\". To avoid this set 'shell' like this: >
6755 :set shell=command.com\ /c\ 4dos
6756< This option cannot be set from a |modeline| or in the |sandbox|, for
6757 security reasons.
6758
6759 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006760'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006761 MS-DOS and Win32, when 'shell' does not
6762 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 global
6764 {not in Vi}
6765 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6766 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6767 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006768 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006769 On Unix it can have more than one flag. Each white space separated
6770 part is passed as an argument to the shell command.
6771 See |option-backslash| about including spaces and backslashes.
6772 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 This option cannot be set from a |modeline| or in the |sandbox|, for
6774 security reasons.
6775
6776 *'shellpipe'* *'sp'*
6777'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6778 global
6779 {not in Vi}
6780 {not available when compiled without the |+quickfix|
6781 feature}
6782 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006783 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 including spaces and backslashes.
6785 The name of the temporary file can be represented by "%s" if necessary
6786 (the file name is appended automatically if no %s appears in the value
6787 of this option).
6788 For the Amiga and MS-DOS the default is ">". The output is directly
6789 saved in a file and not echoed to the screen.
6790 For Unix the default it "| tee". The stdout of the compiler is saved
6791 in a file and echoed to the screen. If the 'shell' option is "csh" or
6792 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006793 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6794 default becomes "2>&1| tee". This means that stderr is also included.
6795 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6796 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 The initialization of this option is done after reading the ".vimrc"
6798 and the other initializations, so that when the 'shell' option is set
6799 there, the 'shellpipe' option changes automatically, unless it was
6800 explicitly set before.
6801 When 'shellpipe' is set to an empty string, no redirection of the
6802 ":make" output will be done. This is useful if you use a 'makeprg'
6803 that writes to 'makeef' by itself. If you want no piping, but do
6804 want to include the 'makeef', set 'shellpipe' to a single space.
6805 Don't forget to precede the space with a backslash: ":set sp=\ ".
6806 In the future pipes may be used for filtering and this option will
6807 become obsolete (at least for Unix).
6808 This option cannot be set from a |modeline| or in the |sandbox|, for
6809 security reasons.
6810
6811 *'shellquote'* *'shq'*
6812'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6813 contains "sh" somewhere: "\"")
6814 global
6815 {not in Vi}
6816 Quoting character(s), put around the command passed to the shell, for
6817 the "!" and ":!" commands. The redirection is kept outside of the
6818 quoting. See 'shellxquote' to include the redirection. It's
6819 probably not useful to set both options.
6820 This is an empty string by default. Only known to be useful for
6821 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6822 or bash, where it should be "\"". The default is adjusted according
6823 the value of 'shell', to reduce the need to set this option by the
6824 user. See |dos-shell|.
6825 This option cannot be set from a |modeline| or in the |sandbox|, for
6826 security reasons.
6827
6828 *'shellredir'* *'srr'*
6829'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6830 global
6831 {not in Vi}
6832 String to be used to put the output of a filter command in a temporary
6833 file. See also |:!|. See |option-backslash| about including spaces
6834 and backslashes.
6835 The name of the temporary file can be represented by "%s" if necessary
6836 (the file name is appended automatically if no %s appears in the value
6837 of this option).
6838 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6839 or "zsh" during initializations, the default becomes ">&". If the
6840 'shell' option is "sh", "ksh" or "bash" the default becomes
6841 ">%s 2>&1". This means that stderr is also included.
6842 For Win32, the Unix checks are done and additionally "cmd" is checked
6843 for, which makes the default ">%s 2>&1". Also, the same names with
6844 ".exe" appended are checked for.
6845 The initialization of this option is done after reading the ".vimrc"
6846 and the other initializations, so that when the 'shell' option is set
6847 there, the 'shellredir' option changes automatically unless it was
6848 explicitly set before.
6849 In the future pipes may be used for filtering and this option will
6850 become obsolete (at least for Unix).
6851 This option cannot be set from a |modeline| or in the |sandbox|, for
6852 security reasons.
6853
6854 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6855'shellslash' 'ssl' boolean (default off)
6856 global
6857 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6858 When set, a forward slash is used when expanding file names. This is
6859 useful when a Unix-like shell is used instead of command.com or
6860 cmd.exe. Backward slashes can still be typed, but they are changed to
6861 forward slashes by Vim.
6862 Note that setting or resetting this option has no effect for some
6863 existing file names, thus this option needs to be set before opening
6864 any file for best results. This might change in the future.
6865 'shellslash' only works when a backslash can be used as a path
6866 separator. To test if this is so use: >
6867 if exists('+shellslash')
6868<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006869 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6870'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6871 global
6872 {not in Vi}
6873 When on, use temp files for shell commands. When off use a pipe.
6874 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006875 Currently a pipe is only supported on Unix and MS-Windows 2K and
6876 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006877 :if has("filterpipe")
6878< The advantage of using a pipe is that nobody can read the temp file
6879 and the 'shell' command does not need to support redirection.
6880 The advantage of using a temp file is that the file type and encoding
6881 can be detected.
6882 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6883 |FilterWritePost| autocommands event are not triggered when
6884 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006885 The `system()` function does not respect this option and always uses
6886 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006887 NOTE: This option is set to the Vim default value when 'compatible'
6888 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006889
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890 *'shelltype'* *'st'*
6891'shelltype' 'st' number (default 0)
6892 global
6893 {not in Vi} {only for the Amiga}
6894 On the Amiga this option influences the way how the commands work
6895 which use a shell.
6896 0 and 1: always use the shell
6897 2 and 3: use the shell only to filter lines
6898 4 and 5: use shell only for ':sh' command
6899 When not using the shell, the command is executed directly.
6900
6901 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6902 1 and 3: use "shell cmd" to start external commands
6903
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006904 *'shellxescape'* *'sxe'*
6905'shellxescape' 'sxe' string (default: "";
6906 for MS-DOS and MS-Windows: "\"&|<>()@^")
6907 global
6908 {not in Vi}
6909 When 'shellxquote' is set to "(" then the characters listed in this
6910 option will be escaped with a '^' character. This makes it possible
6911 to execute most external commands with cmd.exe.
6912
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 *'shellxquote'* *'sxq'*
6914'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006915 for Win32, when 'shell' is cmd.exe: "("
6916 for Win32, when 'shell' contains "sh"
6917 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 for Unix, when using system(): "\"")
6919 global
6920 {not in Vi}
6921 Quoting character(s), put around the command passed to the shell, for
6922 the "!" and ":!" commands. Includes the redirection. See
6923 'shellquote' to exclude the redirection. It's probably not useful
6924 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006925 When the value is '(' then ')' is appended. When the value is '"('
6926 then ')"' is appended.
6927 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006928 This is an empty string by default on most systems, but is known to be
6929 useful for on Win32 version, either for cmd.exe which automatically
6930 strips off the first and last quote on a command, or 3rd-party shells
6931 such as the MKS Korn Shell or bash, where it should be "\"". The
6932 default is adjusted according the value of 'shell', to reduce the need
6933 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934 This option cannot be set from a |modeline| or in the |sandbox|, for
6935 security reasons.
6936
6937 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6938'shiftround' 'sr' boolean (default off)
6939 global
6940 {not in Vi}
6941 Round indent to multiple of 'shiftwidth'. Applies to > and <
6942 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6943 a multiple of 'shiftwidth' (this is Vi compatible).
6944 NOTE: This option is reset when 'compatible' is set.
6945
6946 *'shiftwidth'* *'sw'*
6947'shiftwidth' 'sw' number (default 8)
6948 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006949 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006950 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006951 When zero the 'ts' value will be used. Use the |shiftwidth()|
6952 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953
6954 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006955'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6956 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 global
6958 {not in Vi}
6959 This option helps to avoid all the |hit-enter| prompts caused by file
6960 messages, for example with CTRL-G, and to avoid some other messages.
6961 It is a list of flags:
6962 flag meaning when present ~
6963 f use "(3 of 5)" instead of "(file 3 of 5)"
6964 i use "[noeol]" instead of "[Incomplete last line]"
6965 l use "999L, 888C" instead of "999 lines, 888 characters"
6966 m use "[+]" instead of "[Modified]"
6967 n use "[New]" instead of "[New File]"
6968 r use "[RO]" instead of "[readonly]"
6969 w use "[w]" instead of "written" for file write message
6970 and "[a]" instead of "appended" for ':w >> file' command
6971 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6972 "[unix format]" and "[mac]" instead of "[mac format]".
6973 a all of the above abbreviations
6974
6975 o overwrite message for writing a file with subsequent message
6976 for reading a file (useful for ":wn" or when 'autowrite' on)
6977 O message for reading a file overwrites any previous message.
6978 Also for quickfix message (e.g., ":cn").
6979 s don't give "search hit BOTTOM, continuing at TOP" or "search
6980 hit TOP, continuing at BOTTOM" messages
6981 t truncate file message at the start if it is too long to fit
6982 on the command-line, "<" will appear in the left most column.
6983 Ignored in Ex mode.
6984 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006985 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 Ignored in Ex mode.
6987 W don't give "written" or "[w]" when writing a file
6988 A don't give the "ATTENTION" message when an existing swap file
6989 is found.
6990 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006991 c don't give |ins-completion-menu| messages. For example,
6992 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6993 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006994 q use "recording" instead of "recording @a"
6995 F don't give the file info when editing a file, like `:silent`
6996 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997
6998 This gives you the opportunity to avoid that a change between buffers
6999 requires you to hit <Enter>, but still gives as useful a message as
7000 possible for the space available. To get the whole message that you
7001 would have got with 'shm' empty, use ":file!"
7002 Useful values:
7003 shm= No abbreviation of message.
7004 shm=a Abbreviation, but no loss of information.
7005 shm=at Abbreviation, and truncate message when necessary.
7006
7007 NOTE: This option is set to the Vi default value when 'compatible' is
7008 set and to the Vim default value when 'compatible' is reset.
7009
7010 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7011'shortname' 'sn' boolean (default off)
7012 local to buffer
7013 {not in Vi, not in MS-DOS versions}
7014 Filenames are assumed to be 8 characters plus one extension of 3
7015 characters. Multiple dots in file names are not allowed. When this
7016 option is on, dots in file names are replaced with underscores when
7017 adding an extension (".~" or ".swp"). This option is not available
7018 for MS-DOS, because then it would always be on. This option is useful
7019 when editing files on an MS-DOS compatible filesystem, e.g., messydos
7020 or crossdos. When running the Win32 GUI version under Win32s, this
7021 option is always on by default.
7022
7023 *'showbreak'* *'sbr'* *E595*
7024'showbreak' 'sbr' string (default "")
7025 global
7026 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007027 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028 feature}
7029 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007030 values are "> " or "+++ ": >
7031 :set showbreak=>\
7032< Note the backslash to escape the trailing space. It's easier like
7033 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007034 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007035< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036 comma (in a future version the comma might be used to separate the
7037 part that is shown at the end and at the start of a line).
7038 The characters are highlighted according to the '@' flag in
7039 'highlight'.
7040 Note that tabs after the showbreak will be displayed differently.
7041 If you want the 'showbreak' to appear in between line numbers, add the
7042 "n" flag to 'cpoptions'.
7043
7044 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007045'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7046 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047 global
7048 {not in Vi}
7049 {not available when compiled without the
7050 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007051 Show (partial) command in the last line of the screen. Set this
7052 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 In Visual mode the size of the selected area is shown:
7054 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007055 If the number of bytes is different it is also displayed: "2-6"
7056 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007057 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007058 - When selecting a block, the size in screen characters:
7059 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 NOTE: This option is set to the Vi default value when 'compatible' is
7061 set and to the Vim default value when 'compatible' is reset.
7062
7063 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7064'showfulltag' 'sft' boolean (default off)
7065 global
7066 {not in Vi}
7067 When completing a word in insert mode (see |ins-completion|) from the
7068 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007069 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 matched a C function, you can see a template for what arguments are
7071 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007072 Note that this doesn't work well together with having "longest" in
7073 'completeopt', because the completion from the search pattern may not
7074 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075
7076 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7077'showmatch' 'sm' boolean (default off)
7078 global
7079 When a bracket is inserted, briefly jump to the matching one. The
7080 jump is only done if the match can be seen on the screen. The time to
7081 show the match can be set with 'matchtime'.
7082 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007083 seen or not).
7084 This option is reset when 'paste' is set and restored when 'paste' is
7085 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007086 When the 'm' flag is not included in 'cpoptions', typing a character
7087 will immediately move the cursor back to where it belongs.
7088 See the "sm" field in 'guicursor' for setting the cursor shape and
7089 blinking when showing the match.
7090 The 'matchpairs' option can be used to specify the characters to show
7091 matches for. 'rightleft' and 'revins' are used to look for opposite
7092 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007093 Also see the matchparen plugin for highlighting the match when moving
7094 around |pi_paren.txt|.
7095 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096
7097 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7098'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7099 global
7100 If in Insert, Replace or Visual mode put a message on the last line.
7101 Use the 'M' flag in 'highlight' to set the type of highlighting for
7102 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007103 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007104 doesn't mean XIM is really active, especially when 'imactivatekey' is
7105 not set.
7106 NOTE: This option is set to the Vi default value when 'compatible' is
7107 set and to the Vim default value when 'compatible' is reset.
7108
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007109 *'showtabline'* *'stal'*
7110'showtabline' 'stal' number (default 1)
7111 global
7112 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007113 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007114 feature}
7115 The value of this option specifies when the line with tab page labels
7116 will be displayed:
7117 0: never
7118 1: only if there are at least two tab pages
7119 2: always
7120 This is both for the GUI and non-GUI implementation of the tab pages
7121 line.
7122 See |tab-page| for more information about tab pages.
7123
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 *'sidescroll'* *'ss'*
7125'sidescroll' 'ss' number (default 0)
7126 global
7127 {not in Vi}
7128 The minimal number of columns to scroll horizontally. Used only when
7129 the 'wrap' option is off and the cursor is moved off of the screen.
7130 When it is zero the cursor will be put in the middle of the screen.
7131 When using a slow terminal set it to a large number or 0. When using
7132 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7133 commands.
7134
7135 *'sidescrolloff'* *'siso'*
7136'sidescrolloff' 'siso' number (default 0)
7137 global
7138 {not in Vi}
7139 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007140 right of the cursor if 'nowrap' is set. Setting this option to a
7141 value greater than 0 while having |'sidescroll'| also at a non-zero
7142 value makes some context visible in the line you are scrolling in
7143 horizontally (except at beginning of the line). Setting this option
7144 to a large value (like 999) has the effect of keeping the cursor
7145 horizontally centered in the window, as long as one does not come too
7146 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 NOTE: This option is set to 0 when 'compatible' is set.
7148
7149 Example: Try this together with 'sidescroll' and 'listchars' as
7150 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007151 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152
7153 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7154 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007155<
7156 *'signcolumn'* *'scl'*
7157'signcolumn' 'scl' string (default "auto")
7158 local to window
7159 {not in Vi}
7160 {not available when compiled without the |+signs|
7161 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007162 Whether or not to draw the signcolumn. Valid values are:
7163 "auto" only when there is a sign to display
7164 "no" never
7165 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166
7167
7168 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7169'smartcase' 'scs' boolean (default off)
7170 global
7171 {not in Vi}
7172 Override the 'ignorecase' option if the search pattern contains upper
7173 case characters. Only used when the search pattern is typed and
7174 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007175 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7177 recalling the search pattern from history and hitting <Enter>.
7178 NOTE: This option is reset when 'compatible' is set.
7179
7180 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7181'smartindent' 'si' boolean (default off)
7182 local to buffer
7183 {not in Vi}
7184 {not available when compiled without the
7185 |+smartindent| feature}
7186 Do smart autoindenting when starting a new line. Works for C-like
7187 programs, but can also be used for other languages. 'cindent' does
7188 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007189 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007190 setting 'si' has no effect. 'indentexpr' is a more advanced
7191 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007192 Normally 'autoindent' should also be on when using 'smartindent'.
7193 An indent is automatically inserted:
7194 - After a line ending in '{'.
7195 - After a line starting with a keyword from 'cinwords'.
7196 - Before a line starting with '}' (only with the "O" command).
7197 When typing '}' as the first character in a new line, that line is
7198 given the same indent as the matching '{'.
7199 When typing '#' as the first character in a new line, the indent for
7200 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007201 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7203 When using the ">>" command, lines starting with '#' are not shifted
7204 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007205 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007206 This option is reset when 'paste' is set and restored when 'paste' is
7207 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208
7209 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7210'smarttab' 'sta' boolean (default off)
7211 global
7212 {not in Vi}
7213 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007214 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7215 <BS> will delete a 'shiftwidth' worth of space at the start of the
7216 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007217 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007218 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7219 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007220 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007221 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007222 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007223 This option is reset when 'paste' is set and restored when 'paste' is
7224 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 NOTE: This option is reset when 'compatible' is set.
7226
7227 *'softtabstop'* *'sts'*
7228'softtabstop' 'sts' number (default 0)
7229 local to buffer
7230 {not in Vi}
7231 Number of spaces that a <Tab> counts for while performing editing
7232 operations, like inserting a <Tab> or using <BS>. It "feels" like
7233 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7234 used. This is useful to keep the 'ts' setting at its standard value
7235 of 8, while being able to edit like it is set to 'sts'. However,
7236 commands like "x" still work on the actual characters.
7237 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007238 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007239 'softtabstop' is set to 0 when the 'paste' option is set and restored
7240 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007241 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7242 spaces is minimized by using <Tab>s.
7243 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7244 set.
7245 NOTE: This option is set to 0 when 'compatible' is set.
7246
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007247 If Vim is compiled with the |+vartabs| feature then the value of
7248 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7249 anything other than an empty string.
7250
Bram Moolenaar217ad922005-03-20 22:37:15 +00007251 *'spell'* *'nospell'*
7252'spell' boolean (default off)
7253 local to window
7254 {not in Vi}
7255 {not available when compiled without the |+syntax|
7256 feature}
7257 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007258 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007259
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007260 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007261'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007262 local to buffer
7263 {not in Vi}
7264 {not available when compiled without the |+syntax|
7265 feature}
7266 Pattern to locate the end of a sentence. The following word will be
7267 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007268 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007269 When this check is not wanted make this option empty.
7270 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007271 Be careful with special characters, see |option-backslash| about
7272 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007273 To set this option automatically depending on the language, see
7274 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007275
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007276 *'spellfile'* *'spf'*
7277'spellfile' 'spf' string (default empty)
7278 local to buffer
7279 {not in Vi}
7280 {not available when compiled without the |+syntax|
7281 feature}
7282 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007283 commands. It must end in ".{encoding}.add". You need to include the
7284 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007285 *E765*
7286 It may also be a comma separated list of names. A count before the
7287 |zg| and |zw| commands can be used to access each. This allows using
7288 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007289 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007290 you: Using the first directory in 'runtimepath' that is writable. If
7291 there is no "spell" directory yet it will be created. For the file
7292 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007293 ignoring the region.
7294 The resulting ".spl" file will be used for spell checking, it does not
7295 have to appear in 'spelllang'.
7296 Normally one file is used for all regions, but you can add the region
7297 name if you want to. However, it will then only be used when
7298 'spellfile' is set to it, for entries in 'spelllang' only files
7299 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007300 This option cannot be set from a |modeline| or in the |sandbox|, for
7301 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007302
Bram Moolenaar217ad922005-03-20 22:37:15 +00007303 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007304'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007305 local to buffer
7306 {not in Vi}
7307 {not available when compiled without the |+syntax|
7308 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007309 A comma separated list of word list names. When the 'spell' option is
7310 on spellchecking will be done for these languages. Example: >
7311 set spelllang=en_us,nl,medical
7312< This means US English, Dutch and medical words are recognized. Words
7313 that are not recognized will be highlighted.
7314 The word list name must not include a comma or dot. Using a dash is
7315 recommended to separate the two letter language name from a
7316 specification. Thus "en-rare" is used for rare English words.
7317 A region name must come last and have the form "_xx", where "xx" is
7318 the two-letter, lower case region name. You can use more than one
7319 region by listing them: "en_us,en_ca" supports both US and Canadian
7320 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007321 Britain. (Note: currently en_au and en_nz dictionaries are older than
7322 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007323 If the name "cjk" is included East Asian characters are excluded from
7324 spell checking. This is useful when editing text that also has Asian
7325 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007326 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007327 As a special case the name of a .spl file can be given as-is. The
7328 first "_xx" in the name is removed and used as the region name
7329 (_xx is an underscore, two letters and followed by a non-letter).
7330 This is mainly for testing purposes. You must make sure the correct
7331 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007332 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007333 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7334 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007335 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007336
Bram Moolenaar98692072006-02-04 00:57:42 +00007337 If the |spellfile.vim| plugin is active and you use a language name
7338 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7339 will ask you if you want to download the file.
7340
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007341 After this option has been set successfully, Vim will source the files
7342 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007343 up to the first character that is not an ASCII letter or number and
7344 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007345
7346
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007347 *'spellsuggest'* *'sps'*
7348'spellsuggest' 'sps' string (default "best")
7349 global
7350 {not in Vi}
7351 {not available when compiled without the |+syntax|
7352 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007353 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007354 the |spellsuggest()| function. This is a comma-separated list of
7355 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007356
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007357 best Internal method that works best for English. Finds
7358 changes like "fast" and uses a bit of sound-a-like
7359 scoring to improve the ordering.
7360
7361 double Internal method that uses two methods and mixes the
7362 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007363 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007364 word. That only works when the language specifies
7365 sound folding. Can be slow and doesn't always give
7366 better results.
7367
7368 fast Internal method that only checks for simple changes:
7369 character inserts/deletes/swaps. Works well for
7370 simple typing mistakes.
7371
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007372 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007373 Not used for |spellsuggest()|. The number of
7374 suggestions is never more than the value of 'lines'
7375 minus two.
7376
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007377 file:{filename} Read file {filename}, which must have two columns,
7378 separated by a slash. The first column contains the
7379 bad word, the second column the suggested good word.
7380 Example:
7381 theribal/terrible ~
7382 Use this for common mistakes that do not appear at the
7383 top of the suggestion list with the internal methods.
7384 Lines without a slash are ignored, use this for
7385 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007386 The word in the second column must be correct,
7387 otherwise it will not be used. Add the word to an
7388 ".add" file if it is currently flagged as a spelling
7389 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007390 The file is used for all languages.
7391
7392 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7393 trouble with spaces. |v:val| holds the badly spelled
7394 word. The expression must evaluate to a List of
7395 Lists, each with a suggestion and a score.
7396 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007397 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007398 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007399 internal methods use. A lower score is better.
7400 This may invoke |spellsuggest()| if you temporarily
7401 set 'spellsuggest' to exclude the "expr:" part.
7402 Errors are silently ignored, unless you set the
7403 'verbose' option to a non-zero value.
7404
7405 Only one of "best", "double" or "fast" may be used. The others may
7406 appear several times in any order. Example: >
7407 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7408<
7409 This option cannot be set from a |modeline| or in the |sandbox|, for
7410 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007411
7412
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7414'splitbelow' 'sb' boolean (default off)
7415 global
7416 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007417 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418 feature}
7419 When on, splitting a window will put the new window below the current
7420 one. |:split|
7421
7422 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7423'splitright' 'spr' boolean (default off)
7424 global
7425 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007426 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007427 feature}
7428 When on, splitting a window will put the new window right of the
7429 current one. |:vsplit|
7430
7431 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7432'startofline' 'sol' boolean (default on)
7433 global
7434 {not in Vi}
7435 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007436 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007437 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007438 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 with a linewise operator, with "%" with a count and to buffer changing
7440 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7441 only has a line number, e.g., ":25" or ":+".
7442 In case of buffer changing commands the cursor is placed at the column
7443 where it was the last time the buffer was edited.
7444 NOTE: This option is set when 'compatible' is set.
7445
Bram Moolenaar00654022011-02-25 14:42:19 +01007446 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007448 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 {not in Vi}
7450 {not available when compiled without the |+statusline|
7451 feature}
7452 When nonempty, this option determines the content of the status line.
7453 Also see |status-line|.
7454
7455 The option consists of printf style '%' items interspersed with
7456 normal text. Each status line item is of the form:
7457 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007458 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007459 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460
Bram Moolenaar238a5642006-02-21 22:12:05 +00007461 When the option starts with "%!" then it is used as an expression,
7462 evaluated and the result is used as the option value. Example: >
7463 :set statusline=%!MyStatusLine()
7464< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007465 Note that the "%!" expression is evaluated in the context of the
7466 current window and buffer, while %{} items are evaluated in the
7467 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007468
7469 When there is error while evaluating the option then it will be made
7470 empty to avoid further errors. Otherwise screen updating would loop.
7471
Bram Moolenaar071d4272004-06-13 20:20:40 +00007472 Note that the only effect of 'ruler' when this option is set (and
7473 'laststatus' is 2) is controlling the output of |CTRL-G|.
7474
7475 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007476 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007478 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007479 minwid Minimum width of the item, padding as set by '-' & '0'.
7480 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007481 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 on the left for text items. Numeric items will be
7483 shifted down to maxwid-2 digits followed by '>'number
7484 where number is the amount of missing digits, much like
7485 an exponential notation.
7486 item A one letter code as described below.
7487
7488 Following is a description of the possible statusline items. The
7489 second character in "item" is the type:
7490 N for number
7491 S for string
7492 F for flags as described below
7493 - not applicable
7494
7495 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007496 f S Path to the file in the buffer, as typed or relative to current
7497 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498 F S Full path to the file in the buffer.
7499 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007500 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007502 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007504 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007506 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007508 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007510 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7512 being used: "<keymap>"
7513 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007514 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515 B N As above, in hexadecimal.
7516 o N Byte number in file of byte under cursor, first byte is 1.
7517 Mnemonic: Offset from start of file (with one added)
7518 {not available when compiled without |+byte_offset| feature}
7519 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007520 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007521 l N Line number.
7522 L N Number of lines in buffer.
7523 c N Column number.
7524 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007525 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526 p N Percentage through file in lines as in |CTRL-G|.
7527 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007528 percentage described for 'ruler'. Always 3 in length, unless
7529 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007530 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007532 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007533 Note that there is no '%' before the closing '}'. The
7534 expression cannot contain a '}' character, call a function to
7535 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536 ( - Start of item group. Can be used for setting the width and
7537 alignment of a section. Must be followed by %) somewhere.
7538 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007539 T N For 'tabline': start of tab page N label. Use %T after the last
7540 label. This information is used for mouse clicks.
7541 X N For 'tabline': start of close tab N label. Use %X after the
7542 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7543 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 < - Where to truncate line if too long. Default is at the start.
7545 No width fields allowed.
7546 = - Separation point between left and right aligned items.
7547 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007548 # - Set highlight group. The name must follow and then a # again.
7549 Thus use %#HLname# for highlight group HLname. The same
7550 highlighting is used, also for the statusline of non-current
7551 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007553 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 The difference between User{N} and StatusLine will be applied
7555 to StatusLineNC for the statusline of non-current windows.
7556 The number N must be between 1 and 9. See |hl-User1..9|
7557
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007558 When displaying a flag, Vim removes the leading comma, if any, when
7559 that flag comes right after plaintext. This will make a nice display
7560 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007561
Bram Moolenaar582fd852005-03-28 20:58:01 +00007562 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007563 not set) and a minwid is not set for the group, the whole group will
7564 become empty. This will make a group like the following disappear
7565 completely from the statusline when none of the flags are set. >
7566 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007567< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 Beware that an expression is evaluated each and every time the status
7569 line is displayed. The current buffer and current window will be set
7570 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007571 currently being drawn. The expression will evaluate in this context.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007572 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007573 real current buffer.
7574
Bram Moolenaar30b65812012-07-12 22:01:11 +02007575 The 'statusline' option will be evaluated in the |sandbox| if set from
7576 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007577
7578 It is not allowed to change text or jump to another window while
7579 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580
7581 If the statusline is not updated when you want it (e.g., after setting
7582 a variable that's used in an expression), you can force an update by
7583 setting an option without changing its value. Example: >
7584 :let &ro = &ro
7585
7586< A result of all digits is regarded a number for display purposes.
7587 Otherwise the result is taken as flag text and applied to the rules
7588 described above.
7589
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007590 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007592 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007593
7594 Examples:
7595 Emulate standard status line with 'ruler' set >
7596 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7597< Similar, but add ASCII value of char under the cursor (like "ga") >
7598 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7599< Display byte count and byte value, modified flag in red. >
7600 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7601 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7602< Display a ,GZ flag if a compressed file is loaded >
7603 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7604< In the |:autocmd|'s: >
7605 :let b:gzflag = 1
7606< And: >
7607 :unlet b:gzflag
7608< And define this function: >
7609 :function VarExists(var, val)
7610 : if exists(a:var) | return a:val | else | return '' | endif
7611 :endfunction
7612<
7613 *'suffixes'* *'su'*
7614'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7615 global
7616 {not in Vi}
7617 Files with these suffixes get a lower priority when multiple files
7618 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007619 suffixes. Spaces after the comma are ignored. A dot is also seen as
7620 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007621 separator, precede it with a backslash (see |option-backslash| about
7622 including spaces and backslashes).
7623 See 'wildignore' for completely ignoring files.
7624 The use of |:set+=| and |:set-=| is preferred when adding or removing
7625 suffixes from the list. This avoids problems when a future version
7626 uses another default.
7627
7628 *'suffixesadd'* *'sua'*
7629'suffixesadd' 'sua' string (default "")
7630 local to buffer
7631 {not in Vi}
7632 {not available when compiled without the
7633 |+file_in_path| feature}
7634 Comma separated list of suffixes, which are used when searching for a
7635 file for the "gf", "[I", etc. commands. Example: >
7636 :set suffixesadd=.java
7637<
7638 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7639'swapfile' 'swf' boolean (default on)
7640 local to buffer
7641 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007642 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643 swapfile is not wanted for a specific buffer. For example, with
7644 confidential information that even root must not be able to access.
7645 Careful: All text will be in memory:
7646 - Don't use this for big files.
7647 - Recovery will be impossible!
7648 A swapfile will only be present when |'updatecount'| is non-zero and
7649 'swapfile' is set.
7650 When 'swapfile' is reset, the swap file for the current buffer is
7651 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7652 non-zero, a swap file is immediately created.
7653 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007654 If you want to open a new buffer without creating a swap file for it,
7655 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007656 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657
7658 This option is used together with 'bufhidden' and 'buftype' to
7659 specify special kinds of buffers. See |special-buffers|.
7660
7661 *'swapsync'* *'sws'*
7662'swapsync' 'sws' string (default "fsync")
7663 global
7664 {not in Vi}
7665 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007666 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667 When this option is empty parts of the swap file may be in memory and
7668 not written to disk. When the system crashes you may lose more work.
7669 On Unix the system does a sync now and then without Vim asking for it,
7670 so the disadvantage of setting this option off is small. On some
7671 systems the swap file will not be written at all. For a unix system
7672 setting it to "sync" will use the sync() call instead of the default
7673 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007674 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007675
7676 *'switchbuf'* *'swb'*
7677'switchbuf' 'swb' string (default "")
7678 global
7679 {not in Vi}
7680 This option controls the behavior when switching between buffers.
7681 Possible values (comma separated list):
7682 useopen If included, jump to the first open window that
7683 contains the specified buffer (if there is one).
7684 Otherwise: Do not examine other windows.
7685 This setting is checked with |quickfix| commands, when
7686 jumping to errors (":cc", ":cn", "cp", etc.). It is
7687 also used in all buffer related split commands, for
7688 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007689 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007690 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007691 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007692 a buffer for a |quickfix| command that display errors.
7693 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007694 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007695 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007696 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007697
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007698 *'synmaxcol'* *'smc'*
7699'synmaxcol' 'smc' number (default 3000)
7700 local to buffer
7701 {not in Vi}
7702 {not available when compiled without the |+syntax|
7703 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007704 Maximum column in which to search for syntax items. In long lines the
7705 text after this column is not highlighted and following lines may not
7706 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007707 This helps to avoid very slow redrawing for an XML file that is one
7708 long line.
7709 Set to zero to remove the limit.
7710
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711 *'syntax'* *'syn'*
7712'syntax' 'syn' string (default empty)
7713 local to buffer
7714 {not in Vi}
7715 {not available when compiled without the |+syntax|
7716 feature}
7717 When this option is set, the syntax with this name is loaded, unless
7718 syntax highlighting has been switched off with ":syntax off".
7719 Otherwise this option does not always reflect the current syntax (the
7720 b:current_syntax variable does).
7721 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007722 not automatically recognized. Example, in an IDL file:
7723 /* vim: set syntax=idl : */ ~
7724 When a dot appears in the value then this separates two filetype
7725 names. Example:
7726 /* vim: set syntax=c.doxygen : */ ~
7727 This will use the "c" syntax first, then the "doxygen" syntax.
7728 Note that the second one must be prepared to be loaded as an addition,
7729 otherwise it will be skipped. More than one dot may appear.
7730 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007731 :set syntax=OFF
7732< To switch syntax highlighting on according to the current value of the
7733 'filetype' option: >
7734 :set syntax=ON
7735< What actually happens when setting the 'syntax' option is that the
7736 Syntax autocommand event is triggered with the value as argument.
7737 This option is not copied to another buffer, independent of the 's' or
7738 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007739 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007741 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007742'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007743 global
7744 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007745 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007746 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007747 When nonempty, this option determines the content of the tab pages
7748 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007749 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007750
7751 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007752 option and only when there is no GUI tab line. When 'e' is in
7753 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007754 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007755
7756 The value is evaluated like with 'statusline'. You can use
7757 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007758 the text to be displayed. Use "%1T" for the first label, "%2T" for
7759 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007760
Bram Moolenaare12bab32019-01-08 22:02:56 +01007761 When changing something that is used in 'tabline' that does not
7762 trigger it to be updated, use |:redrawtabline|.
7763
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007764 Keep in mind that only one of the tab pages is the current one, others
7765 are invisible and you can't jump to their windows.
7766
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007767
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007768 *'tabpagemax'* *'tpm'*
7769'tabpagemax' 'tpm' number (default 10)
7770 global
7771 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007772 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007773 feature}
7774 Maximum number of tab pages to be opened by the |-p| command line
7775 argument or the ":tab all" command. |tabpage|
7776
7777
7778 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779'tabstop' 'ts' number (default 8)
7780 local to buffer
7781 Number of spaces that a <Tab> in the file counts for. Also see
7782 |:retab| command, and 'softtabstop' option.
7783
7784 Note: Setting 'tabstop' to any other value than 8 can make your file
7785 appear wrong in many places (e.g., when printing it).
7786
7787 There are four main ways to use tabs in Vim:
7788 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7789 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007790 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007791 behave like a tab appears every 4 (or 3) characters.
7792 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7793 'expandtab'. This way you will always insert spaces. The
7794 formatting will never be messed up when 'tabstop' is changed.
7795 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007796 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797 works when using Vim to edit the file.
7798 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7799 'noexpandtab'. This should then work (for initial indents only)
7800 for any tabstop setting that people use. It might be nice to have
7801 tabs after the first non-blank inserted as spaces if you do this
7802 though. Otherwise aligned comments will be wrong when 'tabstop' is
7803 changed.
7804
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007805 If Vim is compiled with the |+vartabs| feature then the value of
7806 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7807 than an empty string.
7808
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7810'tagbsearch' 'tbs' boolean (default on)
7811 global
7812 {not in Vi}
7813 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007814 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007815 searching makes searching for a tag a LOT faster, but a linear search
7816 will find more tags if the tags file wasn't properly sorted.
7817 Vim normally assumes that your tags files are sorted, or indicate that
7818 they are not sorted. Only when this is not the case does the
7819 'tagbsearch' option need to be switched off.
7820
7821 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007822 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 certain files, or retry all files with a linear search. When
7824 'tagbsearch' is off, only a linear search is done.
7825
7826 Linear searching is done anyway, for one file, when Vim finds a line
7827 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007828 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829< [The whitespace before and after the '0' must be a single <Tab>]
7830
7831 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007832 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007833 instead of a normal tag name, a retry is done with a linear search.
7834 Tags in unsorted tags files, and matches with different case will only
7835 be found in the retry.
7836
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007837 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007838 linear search can be avoided when case is ignored. Use a value of '2'
7839 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7840 sorted with the -f switch to "sort" in most unices, as in the command:
7841 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7842 (at least 5.5) the --sort=foldcase switch can be used for this as
7843 well. Note that case must be folded to uppercase for this to work.
7844
7845 By default, tag searches are case-sensitive. Case is ignored when
7846 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7847 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007848 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7849 'tagcase' is "smart", and the pattern contains only lowercase
7850 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851
7852 When 'tagbsearch' is off, tags searching is slower when a full match
7853 exists, but faster when no full match exists. Tags in unsorted tags
7854 files may only be found with 'tagbsearch' off.
7855 When the tags file is not sorted, or sorted in a wrong way (not on
7856 ASCII byte value), 'tagbsearch' should be off, or the line given above
7857 must be included in the tags file.
7858 This option doesn't affect commands that find all matching tags (e.g.,
7859 command-line completion and ":help").
7860 {Vi: always uses binary search in some versions}
7861
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007862 *'tagcase'* *'tc'*
7863'tagcase' 'tc' string (default "followic")
7864 global or local to buffer |global-local|
7865 {not in Vi}
7866 This option specifies how case is handled when searching the tags
7867 file:
7868 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007869 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007870 ignore Ignore case
7871 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007872 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007873 NOTE: This option is set to the Vi default value when 'compatible' is
7874 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007875
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876 *'taglength'* *'tl'*
7877'taglength' 'tl' number (default 0)
7878 global
7879 If non-zero, tags are significant up to this number of characters.
7880
7881 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7882'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7883 global
7884 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007885 If on and using a tags file in another directory, file names in that
7886 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 NOTE: This option is set to the Vi default value when 'compatible' is
7888 set and to the Vim default value when 'compatible' is reset.
7889
7890 *'tags'* *'tag'* *E433*
7891'tags' 'tag' string (default "./tags,tags", when compiled with
7892 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7893 global or local to buffer |global-local|
7894 Filenames for the tag command, separated by spaces or commas. To
7895 include a space or comma in a file name, precede it with a backslash
7896 (see |option-backslash| about including spaces and backslashes).
7897 When a file name starts with "./", the '.' is replaced with the path
7898 of the current file. But only when the 'd' flag is not included in
7899 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7900 |tags-option|.
7901 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007902 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7903 find all files named "tags" below "/lib". The filename itself cannot
7904 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7905 files called "tags?". {not available when compiled without the
7906 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007907 The |tagfiles()| function can be used to get a list of the file names
7908 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7910 files are also supported. They are automatically recognized. The
7911 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7912 differences are ignored (MS-Windows). |emacs-tags|
7913 The use of |:set+=| and |:set-=| is preferred when adding or removing
7914 file names from the list. This avoids problems when a future version
7915 uses another default.
7916 {Vi: default is "tags /usr/lib/tags"}
7917
7918 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7919'tagstack' 'tgst' boolean (default on)
7920 global
7921 {not in all versions of Vi}
7922 When on, the |tagstack| is used normally. When off, a ":tag" or
7923 ":tselect" command with an argument will not push the tag onto the
7924 tagstack. A following ":tag" without an argument, a ":pop" command or
7925 any other command that uses the tagstack will use the unmodified
7926 tagstack, but does change the pointer to the active entry.
7927 Resetting this option is useful when using a ":tag" command in a
7928 mapping which should not change the tagstack.
7929
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007930 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007931'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007932 global
7933 {not in Vi}
7934 {only available when compiled with the |+tcl/dyn|
7935 feature}
7936 Specifies the name of the Tcl shared library. The default is
7937 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007938 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007939 This option cannot be set from a |modeline| or in the |sandbox|, for
7940 security reasons.
7941
Bram Moolenaar071d4272004-06-13 20:20:40 +00007942 *'term'* *E529* *E530* *E531*
7943'term' string (default is $TERM, if that fails:
7944 in the GUI: "builtin_gui"
7945 on Amiga: "amiga"
7946 on BeOS: "beos-ansi"
7947 on Mac: "mac-ansi"
7948 on MiNT: "vt52"
7949 on MS-DOS: "pcterm"
7950 on OS/2: "os2ansi"
7951 on Unix: "ansi"
7952 on VMS: "ansi"
7953 on Win 32: "win32")
7954 global
7955 Name of the terminal. Used for choosing the terminal control
7956 characters. Environment variables are expanded |:set_env|.
7957 For example: >
7958 :set term=$TERM
7959< See |termcap|.
7960
7961 *'termbidi'* *'tbidi'*
7962 *'notermbidi'* *'notbidi'*
7963'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7964 global
7965 {not in Vi}
7966 {only available when compiled with the |+arabic|
7967 feature}
7968 The terminal is in charge of Bi-directionality of text (as specified
7969 by Unicode). The terminal is also expected to do the required shaping
7970 that some languages (such as Arabic) require.
7971 Setting this option implies that 'rightleft' will not be set when
7972 'arabic' is set and the value of 'arabicshape' will be ignored.
7973 Note that setting 'termbidi' has the immediate effect that
7974 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7975 This option is reset when the GUI is started.
7976 For further details see |arabic.txt|.
7977
7978 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007979'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007980 Macintosh GUI: "macroman")
7981 global
7982 {only available when compiled with the |+multi_byte|
7983 feature}
7984 {not in Vi}
7985 Encoding used for the terminal. This specifies what character
7986 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007987 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007988 display). Except for the Mac when 'macatsui' is off, then
7989 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007991 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007992 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7993 Any attempts to set a different value will be rejected, and an error
7994 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007995 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007996 because the Win32 system always passes Unicode characters.
7997 When empty, the same encoding is used as for the 'encoding' option.
7998 This is the normal value.
7999 Not all combinations for 'termencoding' and 'encoding' are valid. See
8000 |encoding-table|.
8001 The value for this option must be supported by internal conversions or
8002 iconv(). When this is not possible no conversion will be done and you
8003 will probably experience problems with non-ASCII characters.
8004 Example: You are working with the locale set to euc-jp (Japanese) and
8005 want to edit a UTF-8 file: >
8006 :let &termencoding = &encoding
8007 :set encoding=utf-8
8008< You need to do this when your system has no locale support for UTF-8.
8009
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008010 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008011'termguicolors' 'tgc' boolean (default off)
8012 global
8013 {not in Vi}
8014 {not available when compiled without the
8015 |+termguicolors| feature}
8016 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008017 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008018
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008019 Requires a ISO-8613-3 compatible terminal. If setting this option
8020 does not work (produces a colorless UI) reading |xterm-true-color|
8021 might help.
8022
8023 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8024 is required. Use this check to find out: >
8025 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008026< This requires Vim to be built with the |+vtp| feature.
8027
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008028 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008029 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008030
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008031 *'termwinscroll'* *'twsl'*
8032'termwinscroll' 'twsl' number (default 10000)
8033 local to buffer
Bram Moolenaar8c041b62018-04-14 18:14:06 +02008034 {not in Vi}
8035 {not available when compiled without the
8036 |+terminal| feature}
8037 Number of scrollback lines to keep. When going over this limit the
8038 first 10% of the scrollback lines are deleted. This is just to reduce
8039 the memory usage. See |Terminal-Normal|.
8040
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008041 *'termwinkey'* *'twk'*
8042'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008043 local to window
8044 {not in Vi}
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008045 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008046 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008047 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008048 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008049< The string must be one key stroke but can be multiple bytes.
8050 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008051 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008052 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008053
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008054 *'termwinsize'* *'tws'*
8055'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008056 local to window
8057 {not in Vi}
Bram Moolenaar498c2562018-04-15 23:45:15 +02008058 Size of the |terminal| window. Format: {rows}x{columns} or
8059 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008060 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008061 - When set with a "x" (e.g., "24x80") the terminal size is not
8062 adjusted to the window size. If the window is smaller only the
8063 top-left part is displayed.
8064 - When set with a "*" (e.g., "10*50") the terminal size follows the
8065 window size, but will not be smaller than the specified rows and/or
8066 columns.
8067 - When rows is zero then use the height of the window.
8068 - When columns is zero then use the width of the window.
8069 - Using "0x0" or "0*0" is the same as empty.
8070
8071 Examples:
8072 "30x0" uses 30 rows and the current window width.
8073 "20*0" uses at least 20 rows and the current window width.
8074 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008075 Note that the command running in the terminal window may still change
8076 the size of the terminal. In that case the Vim window will be
8077 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008078
Bram Moolenaar071d4272004-06-13 20:20:40 +00008079 *'terse'* *'noterse'*
8080'terse' boolean (default off)
8081 global
8082 When set: Add 's' flag to 'shortmess' option (this makes the message
8083 for a search that hits the start or end of the file not being
8084 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8085 shortens a lot of messages}
8086
8087 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8088'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8089 global
8090 {not in Vi}
8091 This option is obsolete. Use 'fileformats'.
8092 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8093 set to the default value for the current system. When 'textauto' is
8094 reset, 'fileformats' is made empty.
8095 NOTE: This option is set to the Vi default value when 'compatible' is
8096 set and to the Vim default value when 'compatible' is reset.
8097
8098 *'textmode'* *'tx'* *'notextmode'* *'notx'*
8099'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
8100 others: default off)
8101 local to buffer
8102 {not in Vi}
8103 This option is obsolete. Use 'fileformat'.
8104 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8105 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8106 "unix".
8107
8108 *'textwidth'* *'tw'*
8109'textwidth' 'tw' number (default 0)
8110 local to buffer
8111 {not in Vi}
8112 Maximum width of text that is being inserted. A longer line will be
8113 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008114 this.
8115 'textwidth' is set to 0 when the 'paste' option is set and restored
8116 when 'paste' is reset.
8117 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008118 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008119 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120 NOTE: This option is set to 0 when 'compatible' is set.
8121
8122 *'thesaurus'* *'tsr'*
8123'thesaurus' 'tsr' string (default "")
8124 global or local to buffer |global-local|
8125 {not in Vi}
8126 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008127 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
8128
8129 Each line in the file should contain words with similar meaning,
8130 separated by non-keyword characters (white space is preferred).
8131 Maximum line length is 510 bytes.
8132
Bram Moolenaard47d5222018-12-09 20:43:55 +01008133 An English word list was added to this github issue:
8134 https://github.com/vim/vim/issues/629#issuecomment-443293282
8135 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
8136 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
8137 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008138
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008139 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008140 after a comma are ignored, otherwise spaces are included in the file
8141 name. See |option-backslash| about using backslashes.
8142 The use of |:set+=| and |:set-=| is preferred when adding or removing
8143 directories from the list. This avoids problems when a future version
8144 uses another default.
8145 Backticks cannot be used in this option for security reasons.
8146
8147 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8148'tildeop' 'top' boolean (default off)
8149 global
8150 {not in Vi}
8151 When on: The tilde command "~" behaves like an operator.
8152 NOTE: This option is reset when 'compatible' is set.
8153
8154 *'timeout'* *'to'* *'notimeout'* *'noto'*
8155'timeout' 'to' boolean (default on)
8156 global
8157 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008158'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008159 global
8160 {not in Vi}
8161 These two options together determine the behavior when part of a
8162 mapped key sequence or keyboard code has been received:
8163
8164 'timeout' 'ttimeout' action ~
8165 off off do not time out
8166 on on or off time out on :mappings and key codes
8167 off on time out on key codes
8168
8169 If both options are off, Vim will wait until either the complete
8170 mapping or key sequence has been received, or it is clear that there
8171 is no mapping or key sequence for the received characters. For
8172 example: if you have mapped "vl" and Vim has received 'v', the next
8173 character is needed to see if the 'v' is followed by an 'l'.
8174 When one of the options is on, Vim will wait for about 1 second for
8175 the next character to arrive. After that the already received
8176 characters are interpreted as single characters. The waiting time can
8177 be changed with the 'timeoutlen' option.
8178 On slow terminals or very busy systems timing out may cause
8179 malfunctioning cursor keys. If both options are off, Vim waits
8180 forever after an entered <Esc> if there are key codes that start
8181 with <Esc>. You will have to type <Esc> twice. If you do not have
8182 problems with key codes, but would like to have :mapped key
8183 sequences not timing out in 1 second, set the 'ttimeout' option and
8184 reset the 'timeout' option.
8185
8186 NOTE: 'ttimeout' is reset when 'compatible' is set.
8187
8188 *'timeoutlen'* *'tm'*
8189'timeoutlen' 'tm' number (default 1000)
8190 global
8191 {not in all versions of Vi}
8192 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008193'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008194 global
8195 {not in Vi}
8196 The time in milliseconds that is waited for a key code or mapped key
8197 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8198 when part of a command has been typed.
8199 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8200 different timeout value for key codes is desired set 'ttimeoutlen' to
8201 a non-negative number.
8202
8203 ttimeoutlen mapping delay key code delay ~
8204 < 0 'timeoutlen' 'timeoutlen'
8205 >= 0 'timeoutlen' 'ttimeoutlen'
8206
8207 The timeout only happens when the 'timeout' and 'ttimeout' options
8208 tell so. A useful setting would be >
8209 :set timeout timeoutlen=3000 ttimeoutlen=100
8210< (time out on mapping after three seconds, time out on key codes after
8211 a tenth of a second).
8212
8213 *'title'* *'notitle'*
8214'title' boolean (default off, on when title can be restored)
8215 global
8216 {not in Vi}
8217 {not available when compiled without the |+title|
8218 feature}
8219 When on, the title of the window will be set to the value of
8220 'titlestring' (if it is not empty), or to:
8221 filename [+=-] (path) - VIM
8222 Where:
8223 filename the name of the file being edited
8224 - indicates the file cannot be modified, 'ma' off
8225 + indicates the file was modified
8226 = indicates the file is read-only
8227 =+ indicates the file is read-only and modified
8228 (path) is the path of the file being edited
8229 - VIM the server name |v:servername| or "VIM"
8230 Only works if the terminal supports setting window titles
8231 (currently Amiga console, Win32 console, all GUI versions and
8232 terminals with a non- empty 't_ts' option - these are Unix xterm and
8233 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8234 *X11*
8235 When Vim was compiled with HAVE_X11 defined, the original title will
8236 be restored if possible. The output of ":version" will include "+X11"
8237 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8238 works for the icon name |'icon'|.
8239 But: When Vim was started with the |-X| argument, restoring the title
8240 will not work (except in the GUI).
8241 If the title cannot be restored, it is set to the value of 'titleold'.
8242 You might want to restore the title outside of Vim then.
8243 When using an xterm from a remote machine you can use this command:
8244 rsh machine_name xterm -display $DISPLAY &
8245 then the WINDOWID environment variable should be inherited and the
8246 title of the window should change back to what it should be after
8247 exiting Vim.
8248
8249 *'titlelen'*
8250'titlelen' number (default 85)
8251 global
8252 {not in Vi}
8253 {not available when compiled without the |+title|
8254 feature}
8255 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008256 title. When the title is longer, only the end of the path name is
8257 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008258 Using a percentage makes this adapt to the width of the window. But
8259 it won't work perfectly, because the actual number of characters
8260 available also depends on the font used and other things in the title
8261 bar. When 'titlelen' is zero the full path is used. Otherwise,
8262 values from 1 to 30000 percent can be used.
8263 'titlelen' is also used for the 'titlestring' option.
8264
8265 *'titleold'*
8266'titleold' string (default "Thanks for flying Vim")
8267 global
8268 {not in Vi}
8269 {only available when compiled with the |+title|
8270 feature}
8271 This option will be used for the window title when exiting Vim if the
8272 original title cannot be restored. Only happens if 'title' is on or
8273 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008274 This option cannot be set from a |modeline| or in the |sandbox|, for
8275 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008276 *'titlestring'*
8277'titlestring' string (default "")
8278 global
8279 {not in Vi}
8280 {not available when compiled without the |+title|
8281 feature}
8282 When this option is not empty, it will be used for the title of the
8283 window. This happens only when the 'title' option is on.
8284 Only works if the terminal supports setting window titles (currently
8285 Amiga console, Win32 console, all GUI versions and terminals with a
8286 non-empty 't_ts' option).
8287 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008288 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008289 When this option contains printf-style '%' items, they will be
8290 expanded according to the rules used for 'statusline'.
8291 Example: >
8292 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8293 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8294< The value of 'titlelen' is used to align items in the middle or right
8295 of the available space.
8296 Some people prefer to have the file name first: >
8297 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8298< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008299 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008300 separating space only when needed.
8301 NOTE: Use of special characters in 'titlestring' may cause the display
8302 to be garbled (e.g., when it contains a CR or NL character).
8303 {not available when compiled without the |+statusline| feature}
8304
8305 *'toolbar'* *'tb'*
8306'toolbar' 'tb' string (default "icons,tooltips")
8307 global
8308 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8309 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008310 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311 possible values are:
8312 icons Toolbar buttons are shown with icons.
8313 text Toolbar buttons shown with text.
8314 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008315 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 tooltips Tooltips are active for toolbar buttons.
8317 Tooltips refer to the popup help text which appears after the mouse
8318 cursor is placed over a toolbar button for a brief moment.
8319
8320 If you want the toolbar to be shown with icons as well as text, do the
8321 following: >
8322 :set tb=icons,text
8323< Motif and Athena cannot display icons and text at the same time. They
8324 will show icons if both are requested.
8325
8326 If none of the strings specified in 'toolbar' are valid or if
8327 'toolbar' is empty, this option is ignored. If you want to disable
8328 the toolbar, you need to set the 'guioptions' option. For example: >
8329 :set guioptions-=T
8330< Also see |gui-toolbar|.
8331
8332 *'toolbariconsize'* *'tbis'*
8333'toolbariconsize' 'tbis' string (default "small")
8334 global
8335 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008336 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008338 tiny Use tiny icons.
8339 small Use small icons (default).
8340 medium Use medium-sized icons.
8341 large Use large icons.
8342 huge Use even larger icons.
8343 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008344 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008345 the current theme. Common dimensions are giant=48x48, huge=32x32,
8346 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347
8348 If 'toolbariconsize' is empty, the global default size as determined
8349 by user preferences or the current theme is used.
8350
8351 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8352'ttybuiltin' 'tbi' boolean (default on)
8353 global
8354 {not in Vi}
8355 When on, the builtin termcaps are searched before the external ones.
8356 When off the builtin termcaps are searched after the external ones.
8357 When this option is changed, you should set the 'term' option next for
8358 the change to take effect, for example: >
8359 :set notbi term=$TERM
8360< See also |termcap|.
8361 Rationale: The default for this option is "on", because the builtin
8362 termcap entries are generally better (many systems contain faulty
8363 xterm entries...).
8364
8365 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8366'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8367 sun-cmd, screen, rxvt, dtterm or
8368 iris-ansi; also on when running Vim in
8369 a DOS console)
8370 global
8371 {not in Vi}
8372 Indicates a fast terminal connection. More characters will be sent to
8373 the screen for redrawing, instead of using insert/delete line
8374 commands. Improves smoothness of redrawing when there are multiple
8375 windows and the terminal does not support a scrolling region.
8376 Also enables the extra writing of characters at the end of each screen
8377 line for lines that wrap. This helps when using copy/paste with the
8378 mouse in an xterm and other terminals.
8379
8380 *'ttymouse'* *'ttym'*
8381'ttymouse' 'ttym' string (default depends on 'term')
8382 global
8383 {not in Vi}
8384 {only in Unix and VMS, doesn't work in the GUI; not
8385 available when compiled without |+mouse|}
8386 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008387 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388 *xterm-mouse*
8389 xterm xterm-like mouse handling. The mouse generates
8390 "<Esc>[Mscr", where "scr" is three bytes:
8391 "s" = button state
8392 "c" = column plus 33
8393 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008394 This only works up to 223 columns! See "dec",
8395 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 xterm2 Works like "xterm", but with the xterm reporting the
8397 mouse position while the mouse is dragged. This works
8398 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008399 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 work. See below for how Vim detects this
8401 automatically.
8402 *netterm-mouse*
8403 netterm NetTerm mouse handling. The mouse generates
8404 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8405 for the row and column.
8406 *dec-mouse*
8407 dec DEC terminal mouse handling. The mouse generates a
8408 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008409 This is also available for an Xterm, if it was
8410 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 *jsbterm-mouse*
8412 jsbterm JSB term mouse handling.
8413 *pterm-mouse*
8414 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008415 *urxvt-mouse*
8416 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008417 The mouse works only if the terminal supports this
8418 encoding style, but it does not have 223 columns limit
8419 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008420 *sgr-mouse*
8421 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008422 mouse reporting. The mouse works even in columns
8423 beyond 223. This option is backward compatible with
8424 "xterm2" because it can also decode "xterm2" style
8425 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008426
8427 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008428 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8429 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008430 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8431 recognized, if enabled at compile time. DEC terminal mouse codes
8432 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008433 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8434 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008435 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008436 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8437 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8438 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008439 Additionally, if vim is compiled with the |+termresponse| feature and
8440 |t_RV| is set to the escape sequence to request the xterm version
8441 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008443 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8444 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8445 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008446 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8447 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008448 :set t_RV=
8449<
8450 *'ttyscroll'* *'tsl'*
8451'ttyscroll' 'tsl' number (default 999)
8452 global
8453 Maximum number of lines to scroll the screen. If there are more lines
8454 to scroll the window is redrawn. For terminals where scrolling is
8455 very slow and redrawing is not slow this can be set to a small number,
8456 e.g., 3, to speed up displaying.
8457
8458 *'ttytype'* *'tty'*
8459'ttytype' 'tty' string (default from $TERM)
8460 global
8461 Alias for 'term', see above.
8462
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008463 *'undodir'* *'udir'*
8464'undodir' 'udir' string (default ".")
8465 global
8466 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008467 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008468 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008469 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008470 "." means using the directory of the file. The undo file name for
8471 "file.txt" is ".file.txt.un~".
8472 For other directories the file name is the full path of the edited
8473 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008474 When writing: The first directory that exists is used. "." always
8475 works, no directories after "." will be used for writing.
8476 When reading all entries are tried to find an undo file. The first
8477 undo file that exists is used. When it cannot be read an error is
8478 given, no further entry is used.
8479 See |undo-persistence|.
8480
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008481 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008482'undofile' 'udf' boolean (default off)
8483 local to buffer
8484 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008485 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008486 When on, Vim automatically saves undo history to an undo file when
8487 writing a buffer to a file, and restores undo history from the same
8488 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008489 The directory where the undo file is stored is specified by 'undodir'.
8490 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008491 The undo file is not read when 'undoreload' causes the buffer from
8492 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008493 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008494 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008495
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496 *'undolevels'* *'ul'*
8497'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8498 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008499 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008500 {not in Vi}
8501 Maximum number of changes that can be undone. Since undo information
8502 is kept in memory, higher numbers will cause more memory to be used
8503 (nevertheless, a single change can use an unlimited amount of memory).
8504 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8505 itself: >
8506 set ul=0
8507< But you can also get Vi compatibility by including the 'u' flag in
8508 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008509 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008510 Set to -1 for no undo at all. You might want to do this only for the
8511 current buffer: >
8512 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008513< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008514
8515 The local value is set to -123456 when the global value is to be used.
8516
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008517 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008518
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008519 *'undoreload'* *'ur'*
8520'undoreload' 'ur' number (default 10000)
8521 global
8522 {not in Vi}
8523 Save the whole buffer for undo when reloading it. This applies to the
8524 ":e!" command and reloading for when the buffer changed outside of
8525 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008526 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008527 of lines is smaller than the value of this option.
8528 Set this option to zero to disable undo for a reload.
8529
8530 When saving undo for a reload, any undo file is not read.
8531
8532 Note that this causes the whole buffer to be stored in memory. Set
8533 this option to a lower value if you run out of memory.
8534
Bram Moolenaar071d4272004-06-13 20:20:40 +00008535 *'updatecount'* *'uc'*
8536'updatecount' 'uc' number (default: 200)
8537 global
8538 {not in Vi}
8539 After typing this many characters the swap file will be written to
8540 disk. When zero, no swap file will be created at all (see chapter on
8541 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8542 Vim with the "-n" option, see |startup|. When editing in readonly
8543 mode this option will be initialized to 10000.
8544 The swapfile can be disabled per buffer with |'swapfile'|.
8545 When 'updatecount' is set from zero to non-zero, swap files are
8546 created for all buffers that have 'swapfile' set. When 'updatecount'
8547 is set to zero, existing swap files are not deleted.
8548 Also see |'swapsync'|.
8549 This option has no meaning in buffers where |'buftype'| is "nofile"
8550 or "nowrite".
8551
8552 *'updatetime'* *'ut'*
8553'updatetime' 'ut' number (default 4000)
8554 global
8555 {not in Vi}
8556 If this many milliseconds nothing is typed the swap file will be
8557 written to disk (see |crash-recovery|). Also used for the
8558 |CursorHold| autocommand event.
8559
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008560 *'varsofttabstop'* *'vsts'*
8561'varsofttabstop' 'vsts' string (default "")
8562 local to buffer
8563 {only available when compiled with the |+vartabs|
8564 feature}
8565 {not in Vi}
8566 A list of the number of spaces that a <Tab> counts for while editing,
8567 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8568 width <Tab>s are being inserted, while in fact a mixture of spaces
8569 and <Tab>s is used. Tab widths are separated with commas, with the
8570 final value applying to all subsequent tabs.
8571
8572 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008573 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008574 to use the following: >
8575 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008576< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8577 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008578
8579 Note that the value of |'softtabstop'| will be ignored while
8580 'varsofttabstop' is set.
8581
8582 *'vartabstop'* *'vts'*
8583'vartabstop' 'vts' string (default "")
8584 local to buffer
8585 {only available when compiled with the |+vartabs|
8586 feature}
8587 {not in Vi}
8588 A list of the number of spaces that a <Tab> in the file counts for,
8589 separated by commas. Each value corresponds to one tab, with the
8590 final value applying to all subsequent tabs. For example: >
8591 :set vartabstop=4,20,10,8
8592< This will make the first tab 4 spaces wide, the second 20 spaces,
8593 the third 10 spaces, and all following tabs 8 spaces.
8594
8595 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8596 is set.
8597
Bram Moolenaar071d4272004-06-13 20:20:40 +00008598 *'verbose'* *'vbs'*
8599'verbose' 'vbs' number (default 0)
8600 global
8601 {not in Vi, although some versions have a boolean
8602 verbose option}
8603 When bigger than zero, Vim will give messages about what it is doing.
8604 Currently, these messages are given:
8605 >= 1 When the viminfo file is read or written.
8606 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008607 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008608 >= 8 Files for which a group of autocommands is executed.
8609 >= 9 Every executed autocommand.
8610 >= 12 Every executed function.
8611 >= 13 When an exception is thrown, caught, finished, or discarded.
8612 >= 14 Anything pending in a ":finally" clause.
8613 >= 15 Every executed Ex command (truncated at 200 characters).
8614
8615 This option can also be set with the "-V" argument. See |-V|.
8616 This option is also set by the |:verbose| command.
8617
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008618 When the 'verbosefile' option is set then the verbose messages are not
8619 displayed.
8620
8621 *'verbosefile'* *'vfile'*
8622'verbosefile' 'vfile' string (default empty)
8623 global
8624 {not in Vi}
8625 When not empty all messages are written in a file with this name.
8626 When the file exists messages are appended.
8627 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008628 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008629 Setting 'verbosefile' to a new value is like making it empty first.
8630 The difference with |:redir| is that verbose messages are not
8631 displayed when 'verbosefile' is set.
8632
Bram Moolenaar071d4272004-06-13 20:20:40 +00008633 *'viewdir'* *'vdir'*
8634'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8635 "$VIM/vimfiles/view",
8636 for Unix: "~/.vim/view",
8637 for Macintosh: "$VIM:vimfiles:view"
8638 for VMS: "sys$login:vimfiles/view"
8639 for RiscOS: "Choices:vimfiles/view")
8640 global
8641 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008642 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008643 feature}
8644 Name of the directory where to store files for |:mkview|.
8645 This option cannot be set from a |modeline| or in the |sandbox|, for
8646 security reasons.
8647
8648 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008649'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008650 global
8651 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008652 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 feature}
8654 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008655 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 word save and restore ~
8657 cursor cursor position in file and in window
8658 folds manually created folds, opened/closed folds and local
8659 fold options
8660 options options and mappings local to a window or buffer (not
8661 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008662 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008663 slash backslashes in file names replaced with forward
8664 slashes
8665 unix with Unix end-of-line format (single <NL>), even when
8666 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008667 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008668
8669 "slash" and "unix" are useful on Windows when sharing view files
8670 with Unix. The Unix version of Vim cannot source dos format scripts,
8671 but the Windows version of Vim can source unix format scripts.
8672
8673 *'viminfo'* *'vi'* *E526* *E527* *E528*
8674'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008675 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8676 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8677 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008678 global
8679 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008680 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681 feature}
8682 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008683 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8684 "NONE".
8685 The string should be a comma separated list of parameters, each
8686 consisting of a single character identifying the particular parameter,
8687 followed by a number or string which specifies the value of that
8688 parameter. If a particular character is left out, then the default
8689 value is used for that parameter. The following is a list of the
8690 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008692 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008693 ! When included, save and restore global variables that start
8694 with an uppercase letter, and don't contain a lowercase
8695 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008696 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008697 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008698 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699 " Maximum number of lines saved for each register. Old name of
8700 the '<' item, with the disadvantage that you need to put a
8701 backslash before the ", otherwise it will be recognized as the
8702 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008703 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008704 % When included, save and restore the buffer list. If Vim is
8705 started with a file name argument, the buffer list is not
8706 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008707 buffer list is restored from the viminfo file. Quickfix
8708 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8709 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008710 When followed by a number, the number specifies the maximum
8711 number of buffers that are stored. Without a number all
8712 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008713 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008714 ' Maximum number of previously edited files for which the marks
8715 are remembered. This parameter must always be included when
8716 'viminfo' is non-empty.
8717 Including this item also means that the |jumplist| and the
8718 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008719 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008720 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008721 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008722 patterns are also saved. When not included, the value of
8723 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008724 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008725 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008726 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008727 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 < Maximum number of lines saved for each register. If zero then
8729 registers are not saved. When not included, all lines are
8730 saved. '"' is the old name for this item.
8731 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008732 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008734 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008735 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 c When included, convert the text in the viminfo file from the
8737 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008738 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008739 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008740 f Whether file marks need to be stored. If zero, file marks ('0
8741 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008742 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008743 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008744 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 h Disable the effect of 'hlsearch' when loading the viminfo
8746 file. When not included, it depends on whether ":nohlsearch"
8747 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008748 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008749 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008750 the 'n'. Must be at the end of the option! If the
8751 'viminfofile' option is set, that file name overrides the one
8752 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008753 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008754 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008755 r Removable media. The argument is a string (up to the next
8756 ','). This parameter can be given several times. Each
8757 specifies the start of a path for which no marks will be
8758 stored. This is to avoid removable media. For MS-DOS you
8759 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8760 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8761 ignored. Maximum length of each 'r' argument is 50
8762 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008763 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764 s Maximum size of an item in Kbyte. If zero then registers are
8765 not saved. Currently only applies to registers. The default
8766 "s10" will exclude registers with more than 10 Kbyte of text.
8767 Also see the '<' item above: line count limit.
8768
8769 Example: >
8770 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8771<
8772 '50 Marks will be remembered for the last 50 files you
8773 edited.
8774 <1000 Contents of registers (up to 1000 lines each) will be
8775 remembered.
8776 s100 Registers with more than 100 Kbyte text are skipped.
8777 :0 Command-line history will not be saved.
8778 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8779 no / Since '/' is not specified, the default will be used,
8780 that is, save all of the search history, and also the
8781 previous search and substitute patterns.
8782 no % The buffer list will not be saved nor read back.
8783 no h 'hlsearch' highlighting will be restored.
8784
8785 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8786 load the contents of the file, this is not done automatically.
8787
8788 This option cannot be set from a |modeline| or in the |sandbox|, for
8789 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008790 NOTE: This option is set to the Vim default value when 'compatible'
8791 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008792
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008793 *'viminfofile'* *'vif'*
8794'viminfofile' 'vif' string (default: "")
8795 global
8796 {not in Vi}
8797 {not available when compiled without the |+viminfo|
8798 feature}
8799 When non-empty, overrides the file name used for viminfo.
8800 When equal to "NONE" no viminfo file will be read or written.
8801 This option can be set with the |-i| command line flag. The |--clean|
8802 command line flag sets it to "NONE".
8803
Bram Moolenaar071d4272004-06-13 20:20:40 +00008804 *'virtualedit'* *'ve'*
8805'virtualedit' 've' string (default "")
8806 global
8807 {not in Vi}
8808 {not available when compiled without the
8809 |+virtualedit| feature}
8810 A comma separated list of these words:
8811 block Allow virtual editing in Visual block mode.
8812 insert Allow virtual editing in Insert mode.
8813 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008814 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008815
Bram Moolenaar071d4272004-06-13 20:20:40 +00008816 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008817 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818 of the line. Useful for selecting a rectangle in Visual mode and
8819 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008820 "onemore" is not the same, it will only allow moving the cursor just
8821 after the last character of the line. This makes some commands more
8822 consistent. Previously the cursor was always past the end of the line
8823 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008824 break some plugins or Vim scripts. For example because |l| can move
8825 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008826 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008827 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008828 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008829 It doesn't make sense to combine "all" with "onemore", but you will
8830 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008831 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008832
8833 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8834'visualbell' 'vb' boolean (default off)
8835 global
8836 {not in Vi}
Bram Moolenaar74675a62017-07-15 13:53:23 +02008837 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008839 use: >
8840 :set vb t_vb=
8841< If you want a short flash, you can use this on many terminals: >
8842 :set vb t_vb=[?5h$<100>[?5l
8843< Here $<100> specifies the time, you can use a smaller or bigger value
8844 to get a shorter or longer flash.
8845
8846 Note: Vim will limit the bell to once per half a second. This avoids
8847 having to wait for the flashing to finish when there are lots of
8848 bells, e.g. on key repeat. This also happens without 'visualbell'
8849 set.
8850
Bram Moolenaar071d4272004-06-13 20:20:40 +00008851 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8852 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8853 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008854
8855 Note: When the GUI starts, 't_vb' is reset to its default value. You
8856 might want to set it again in your |gvimrc|.
8857
Bram Moolenaar071d4272004-06-13 20:20:40 +00008858 Does not work on the Amiga, you always get a screen flash.
8859 Also see 'errorbells'.
8860
8861 *'warn'* *'nowarn'*
8862'warn' boolean (default on)
8863 global
8864 Give a warning message when a shell command is used while the buffer
8865 has been changed.
8866
8867 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8868'weirdinvert' 'wiv' boolean (default off)
8869 global
8870 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008871 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008872 It is provided for backwards compatibility with version 4.x.
8873 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8874 vice versa. Has no effect when the GUI is running.
8875
8876 *'whichwrap'* *'ww'*
8877'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8878 global
8879 {not in Vi}
8880 Allow specified keys that move the cursor left/right to move to the
8881 previous/next line when the cursor is on the first/last character in
8882 the line. Concatenate characters to allow this for these keys:
8883 char key mode ~
8884 b <BS> Normal and Visual
8885 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008886 h "h" Normal and Visual (not recommended)
8887 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008888 < <Left> Normal and Visual
8889 > <Right> Normal and Visual
8890 ~ "~" Normal
8891 [ <Left> Insert and Replace
8892 ] <Right> Insert and Replace
8893 For example: >
8894 :set ww=<,>,[,]
8895< allows wrap only when cursor keys are used.
8896 When the movement keys are used in combination with a delete or change
8897 operator, the <EOL> also counts for a character. This makes "3h"
8898 different from "3dh" when the cursor crosses the end of a line. This
8899 is also true for "x" and "X", because they do the same as "dl" and
8900 "dh". If you use this, you may also want to use the mapping
8901 ":map <BS> X" to make backspace delete the character in front of the
8902 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008903 When 'l' is included and it is used after an operator at the end of a
8904 line then it will not move to the next line. This makes "dl", "cl",
8905 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008906 NOTE: This option is set to the Vi default value when 'compatible' is
8907 set and to the Vim default value when 'compatible' is reset.
8908
8909 *'wildchar'* *'wc'*
8910'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8911 global
8912 {not in Vi}
8913 Character you have to type to start wildcard expansion in the
8914 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008915 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008916 The character is not recognized when used inside a macro. See
8917 'wildcharm' for that.
8918 Although 'wc' is a number option, you can set it to a special key: >
8919 :set wc=<Esc>
8920< NOTE: This option is set to the Vi default value when 'compatible' is
8921 set and to the Vim default value when 'compatible' is reset.
8922
8923 *'wildcharm'* *'wcm'*
8924'wildcharm' 'wcm' number (default: none (0))
8925 global
8926 {not in Vi}
8927 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008928 recognized when used inside a macro. You can find "spare" command-line
8929 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008930 you'll never actually type 'wildcharm', just use it in mappings that
8931 automatically invoke completion mode, e.g.: >
8932 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008933 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008934< Then after typing :ss you can use CTRL-P & CTRL-N.
8935
8936 *'wildignore'* *'wig'*
8937'wildignore' 'wig' string (default "")
8938 global
8939 {not in Vi}
8940 {not available when compiled without the |+wildignore|
8941 feature}
8942 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008943 patterns is ignored when expanding |wildcards|, completing file or
8944 directory names, and influences the result of |expand()|, |glob()| and
8945 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8947 Also see 'suffixes'.
8948 Example: >
8949 :set wildignore=*.o,*.obj
8950< The use of |:set+=| and |:set-=| is preferred when adding or removing
8951 a pattern from the list. This avoids problems when a future version
8952 uses another default.
8953
Bram Moolenaar94950a92010-12-02 16:01:29 +01008954
Bram Moolenaar81af9252010-12-10 20:35:50 +01008955 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008956'wildignorecase' 'wic' boolean (default off)
8957 global
8958 {not in Vi}
8959 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008960 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008961 Does not apply when the shell is used to expand wildcards, which
8962 happens when there are special characters.
8963
8964
Bram Moolenaar071d4272004-06-13 20:20:40 +00008965 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008966'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008967 global
8968 {not in Vi}
8969 {not available if compiled without the |+wildmenu|
8970 feature}
8971 When 'wildmenu' is on, command-line completion operates in an enhanced
8972 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8973 the possible matches are shown just above the command line, with the
8974 first match highlighted (overwriting the status line, if there is
8975 one). Keys that show the previous/next match, such as <Tab> or
8976 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8977 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8978 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008979 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008980 If there are more matches than can fit in the line, a ">" is shown on
8981 the right and/or a "<" is shown on the left. The status line scrolls
8982 as needed.
8983 The "wildmenu" mode is abandoned when a key is hit that is not used
8984 for selecting a completion.
8985 While the "wildmenu" is active the following keys have special
8986 meanings:
8987
8988 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8989 <Down> - in filename/menu name completion: move into a
8990 subdirectory or submenu.
8991 <CR> - in menu completion, when the cursor is just after a
8992 dot: move into a submenu.
8993 <Up> - in filename/menu name completion: move up into
8994 parent directory or parent menu.
8995
8996 This makes the menus accessible from the console |console-menus|.
8997
8998 If you prefer the <Left> and <Right> keys to move the cursor instead
8999 of selecting a different match, use this: >
9000 :cnoremap <Left> <Space><BS><Left>
9001 :cnoremap <Right> <Space><BS><Right>
9002<
9003 The "WildMenu" highlighting is used for displaying the current match
9004 |hl-WildMenu|.
9005
9006 *'wildmode'* *'wim'*
9007'wildmode' 'wim' string (Vim default: "full")
9008 global
9009 {not in Vi}
9010 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009011 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009012 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 first part specifies the behavior for the first use of 'wildchar',
9014 The second part for the second use, etc.
9015 These are the possible values for each part:
9016 "" Complete only the first match.
9017 "full" Complete the next full match. After the last match,
9018 the original string is used and then the first match
9019 again.
9020 "longest" Complete till longest common string. If this doesn't
9021 result in a longer string, use the next part.
9022 "longest:full" Like "longest", but also start 'wildmenu' if it is
9023 enabled.
9024 "list" When more than one match, list all matches.
9025 "list:full" When more than one match, list all matches and
9026 complete first match.
9027 "list:longest" When more than one match, list all matches and
9028 complete till longest common string.
9029 When there is only a single match, it is fully completed in all cases.
9030
9031 Examples: >
9032 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009033< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009034 :set wildmode=longest,full
9035< Complete longest common string, then each full match >
9036 :set wildmode=list:full
9037< List all matches and complete each full match >
9038 :set wildmode=list,full
9039< List all matches without completing, then each full match >
9040 :set wildmode=longest,list
9041< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009042 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009043
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009044 *'wildoptions'* *'wop'*
9045'wildoptions' 'wop' string (default "")
9046 global
9047 {not in Vi}
9048 {not available when compiled without the |+wildignore|
9049 feature}
9050 A list of words that change how command line completion is done.
9051 Currently only one word is allowed:
9052 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009053 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009054 is displayed per line. Often used tag kinds are:
9055 d #define
9056 f function
9057 Also see |cmdline-completion|.
9058
Bram Moolenaar071d4272004-06-13 20:20:40 +00009059 *'winaltkeys'* *'wak'*
9060'winaltkeys' 'wak' string (default "menu")
9061 global
9062 {not in Vi}
9063 {only used in Win32, Motif, GTK and Photon GUI}
9064 Some GUI versions allow the access to menu entries by using the ALT
9065 key in combination with a character that appears underlined in the
9066 menu. This conflicts with the use of the ALT key for mappings and
9067 entering special characters. This option tells what to do:
9068 no Don't use ALT keys for menus. ALT key combinations can be
9069 mapped, but there is no automatic handling. This can then be
9070 done with the |:simalt| command.
9071 yes ALT key handling is done by the windowing system. ALT key
9072 combinations cannot be mapped.
9073 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009074 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009075 keys can be mapped.
9076 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9077 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009078 This option is not used for <F10>; on Win32 and with GTK <F10> will
9079 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009081 *'window'* *'wi'*
9082'window' 'wi' number (default screen height - 1)
9083 global
9084 Window height. Do not confuse this with the height of the Vim window,
9085 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00009086 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
9087 value is smaller than 'lines' minus one. The screen will scroll
9088 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009089 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9090 in a much smarter way, taking care of wrapping lines.
9091 When resizing the Vim window, the value is smaller than 1 or more than
9092 or equal to 'lines' it will be set to 'lines' minus 1.
9093 {Vi also uses the option to specify the number of displayed lines}
9094
Bram Moolenaar071d4272004-06-13 20:20:40 +00009095 *'winheight'* *'wh'* *E591*
9096'winheight' 'wh' number (default 1)
9097 global
9098 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009099 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009100 feature}
9101 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009102 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009103 focus goes to a window that is smaller, its size is increased, at the
9104 cost of the height of other windows.
9105 Set 'winheight' to a small number for normal editing.
9106 Set it to 999 to make the current window fill most of the screen.
9107 Other windows will be only 'winminheight' high. This has the drawback
9108 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9109 to create only two windows, set the option after startup is done,
9110 using the |VimEnter| event: >
9111 au VimEnter * set winheight=999
9112< Minimum value is 1.
9113 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009114 height of the current window.
9115 'winheight' applies to the current window. Use 'winminheight' to set
9116 the minimal height for other windows.
9117
9118 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9119'winfixheight' 'wfh' boolean (default off)
9120 local to window
9121 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009122 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009123 feature}
9124 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009125 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9126 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009127 The height may be changed anyway when running out of room.
9128
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009129 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9130'winfixwidth' 'wfw' boolean (default off)
9131 local to window
9132 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009133 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009134 feature}
9135 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009136 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009137 The width may be changed anyway when running out of room.
9138
Bram Moolenaar071d4272004-06-13 20:20:40 +00009139 *'winminheight'* *'wmh'*
9140'winminheight' 'wmh' number (default 1)
9141 global
9142 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009143 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009144 feature}
9145 The minimal height of a window, when it's not the current window.
9146 This is a hard minimum, windows will never become smaller.
9147 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9148 status bar) if necessary. They will return to at least one line when
9149 they become active (since the cursor has to have somewhere to go.)
9150 Use 'winheight' to set the minimal height of the current window.
9151 This option is only checked when making a window smaller. Don't use a
9152 large number, it will cause errors when opening more than a few
9153 windows. A value of 0 to 3 is reasonable.
9154
9155 *'winminwidth'* *'wmw'*
9156'winminwidth' 'wmw' number (default 1)
9157 global
9158 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009159 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009160 feature}
9161 The minimal width of a window, when it's not the current window.
9162 This is a hard minimum, windows will never become smaller.
9163 When set to zero, windows may be "squashed" to zero columns (i.e. just
9164 a vertical separator) if necessary. They will return to at least one
9165 line when they become active (since the cursor has to have somewhere
9166 to go.)
9167 Use 'winwidth' to set the minimal width of the current window.
9168 This option is only checked when making a window smaller. Don't use a
9169 large number, it will cause errors when opening more than a few
9170 windows. A value of 0 to 12 is reasonable.
9171
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009172 *'winptydll'*
9173'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9174 global
9175 {not in Vi}
9176 {only available when compiled with the |terminal|
9177 feature on MS-Windows}
9178 Specifies the name of the winpty shared library, used for the
9179 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009180 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009181 a fallback.
9182 Environment variables are expanded |:set_env|.
9183 This option cannot be set from a |modeline| or in the |sandbox|, for
9184 security reasons.
9185
Bram Moolenaar071d4272004-06-13 20:20:40 +00009186 *'winwidth'* *'wiw'* *E592*
9187'winwidth' 'wiw' number (default 20)
9188 global
9189 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009190 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009191 feature}
9192 Minimal number of columns for the current window. This is not a hard
9193 minimum, Vim will use fewer columns if there is not enough room. If
9194 the current window is smaller, its size is increased, at the cost of
9195 the width of other windows. Set it to 999 to make the current window
9196 always fill the screen. Set it to a small number for normal editing.
9197 The width is not adjusted after one of the commands to change the
9198 width of the current window.
9199 'winwidth' applies to the current window. Use 'winminwidth' to set
9200 the minimal width for other windows.
9201
9202 *'wrap'* *'nowrap'*
9203'wrap' boolean (default on)
9204 local to window
9205 {not in Vi}
9206 This option changes how text is displayed. It doesn't change the text
9207 in the buffer, see 'textwidth' for that.
9208 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009209 displaying continues on the next line. When off lines will not wrap
9210 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009211 moved to a part that is not shown, the screen will scroll
9212 horizontally.
9213 The line will be broken in the middle of a word if necessary. See
9214 'linebreak' to get the break at a word boundary.
9215 To make scrolling horizontally a bit more useful, try this: >
9216 :set sidescroll=5
9217 :set listchars+=precedes:<,extends:>
9218< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009219 This option can't be set from a |modeline| when the 'diff' option is
9220 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009221
9222 *'wrapmargin'* *'wm'*
9223'wrapmargin' 'wm' number (default 0)
9224 local to buffer
9225 Number of characters from the right window border where wrapping
9226 starts. When typing text beyond this limit, an <EOL> will be inserted
9227 and inserting continues on the next line.
9228 Options that add a margin, such as 'number' and 'foldcolumn', cause
9229 the text width to be further reduced. This is Vi compatible.
9230 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009231 This option is set to 0 when 'paste' is set and restored when 'paste'
9232 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009233 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
9234 and less usefully}
9235
9236 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9237'wrapscan' 'ws' boolean (default on) *E384* *E385*
9238 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009239 Searches wrap around the end of the file. Also applies to |]s| and
9240 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009241
9242 *'write'* *'nowrite'*
9243'write' boolean (default on)
9244 global
9245 {not in Vi}
9246 Allows writing files. When not set, writing a file is not allowed.
9247 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009248 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009249 argument. Filtering text is still possible, even though this requires
9250 writing a temporary file.
9251
9252 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9253'writeany' 'wa' boolean (default off)
9254 global
9255 Allows writing to any file with no need for "!" override.
9256
9257 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9258'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9259 otherwise)
9260 global
9261 {not in Vi}
9262 Make a backup before overwriting a file. The backup is removed after
9263 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009264 also on.
9265 WARNING: Switching this option off means that when Vim fails to write
9266 your buffer correctly and then, for whatever reason, Vim exits, you
9267 lose both the original file and what you were writing. Only reset
9268 this option if your file system is almost full and it makes the write
9269 fail (and make sure not to exit Vim until the write was successful).
9270 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009271 When the 'backupskip' pattern matches, a backup is not made anyway.
9272 NOTE: This option is set to the default value when 'compatible' is
9273 set.
9274
9275 *'writedelay'* *'wd'*
9276'writedelay' 'wd' number (default 0)
9277 global
9278 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009279 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009280 screen. When non-zero, characters are sent to the terminal one by
9281 one. For MS-DOS pcterm this does not work. For debugging purposes.
9282
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009283 vim:tw=78:ts=8:noet:ft=help:norl: