blob: 6b2dde82576ed9d0b7abf68d0b45827e04e59998 [file] [log] [blame]
Bram Moolenaar314dd792019-02-03 15:27:20 +01001*options.txt* For Vim version 8.1. Last change: 2019 Feb 03
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=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100357This only works for a string option. For a number or boolean option you need
358to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100360Note that for non-boolean and non-number options using "<" copies the global
361value to the local value, it doesn't switch back to using the global value
362(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000363 :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'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001567'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 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*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002276 y A yank command can be redone with ".". Think twice if
2277 you really want to use this, it may break some
2278 plugins, since most people expect "." to only repeat a
2279 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002280 *cpo-Z*
2281 Z When using "w!" while the 'readonly' option is set,
2282 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002283 *cpo-!*
2284 ! When redoing a filter command, use the last used
2285 external command, whatever it was. Otherwise the last
2286 used -filter- command is used.
2287 *cpo-$*
2288 $ When making a change to one line, don't redisplay the
2289 line, but put a '$' at the end of the changed text.
2290 The changed text will be overwritten when you type the
2291 new text. The line is redisplayed if you type any
2292 command that moves the cursor from the insertion
2293 point.
2294 *cpo-%*
2295 % Vi-compatible matching is done for the "%" command.
2296 Does not recognize "#if", "#endif", etc.
2297 Does not recognize "/*" and "*/".
2298 Parens inside single and double quotes are also
2299 counted, causing a string that contains a paren to
2300 disturb the matching. For example, in a line like
2301 "if (strcmp("foo(", s))" the first paren does not
2302 match the last one. When this flag is not included,
2303 parens inside single and double quotes are treated
2304 specially. When matching a paren outside of quotes,
2305 everything inside quotes is ignored. When matching a
2306 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002307 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002308 This flag is also used for other features, such as
2309 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002310 *cpo--*
2311 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002312 it would go above the first line or below the last
2313 line. Without it the cursor moves to the first or
2314 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002315 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002316 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002317 *cpo-+*
2318 + When included, a ":write file" command will reset the
2319 'modified' flag of the buffer, even though the buffer
2320 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002321 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002322 * Use ":*" in the same way as ":@". When not included,
2323 ":*" is an alias for ":'<,'>", select the Visual area.
2324 *cpo-<*
2325 < Disable the recognition of special key codes in |<>|
2326 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002327 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 ":map X <Tab>" results in X being mapped to:
2329 '<' included: "<Tab>" (5 characters)
2330 '<' excluded: "^I" (^I is a real <Tab>)
2331 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002332 *cpo->*
2333 > When appending to a register, put a line break before
2334 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002335 *cpo-;*
2336 ; When using |,| or |;| to repeat the last |t| search
2337 and the cursor is right in front of the searched
2338 character, the cursor won't move. When not included,
2339 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002340 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002341
2342 POSIX flags. These are not included in the Vi default value, except
2343 when $VIM_POSIX was set on startup. |posix|
2344
2345 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002346 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002347 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002348 *cpo-&*
2349 & When ":preserve" was used keep the swap file when
2350 exiting normally while this buffer is still loaded.
2351 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002352 *cpo-\*
2353 \ Backslash in a [] range in a search pattern is taken
2354 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002355 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2356 '\' excluded: "/[ \-]" finds <Space> and '-'
2357 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002358 *cpo-/*
2359 / When "%" is used as the replacement string in a |:s|
2360 command, use the previous replacement string. |:s%|
2361 *cpo-{*
2362 { The |{| and |}| commands also stop at a "{" character
2363 at the start of a line.
2364 *cpo-.*
2365 . The ":chdir" and ":cd" commands fail if the current
2366 buffer is modified, unless ! is used. Vim doesn't
2367 need this, since it remembers the full path of an
2368 opened file.
2369 *cpo-bar*
2370 | The value of the $LINES and $COLUMNS environment
2371 variables overrule the terminal size values obtained
2372 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002373
Bram Moolenaar071d4272004-06-13 20:20:40 +00002374
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002375 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002376'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002377 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002378 {not in Vi}
2379 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002380 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002381 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002382 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002383 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002384 blowfish Blowfish method. Medium strong encryption but it has
2385 an implementation flaw. Requires Vim 7.3 or later,
2386 files can NOT be read by Vim 7.2 and older. This adds
2387 a "seed" to the file, every time you write the file
2388 the encrypted bytes will be different.
2389 *blowfish2*
2390 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002391 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002392 and older. This adds a "seed" to the file, every time
2393 you write the file the encrypted bytes will be
2394 different. The whole undo file is encrypted, not just
2395 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002396
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002397 You should use "blowfish2", also to re-encrypt older files.
2398
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002399 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002400 to the detected method of the file being read. Thus if you write it
2401 without changing 'cryptmethod' the same method will be used.
2402 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002403 explicitly write it, you don't get a warning unless there are other
2404 modifications. Also see |:X|.
2405
2406 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002407 the value "blowfish2". When setting the local value to an empty
2408 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002409
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002410 When a new encryption method is added in a later version of Vim, and
2411 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002412 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002413
2414
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415 *'cscopepathcomp'* *'cspc'*
2416'cscopepathcomp' 'cspc' number (default 0)
2417 global
2418 {not available when compiled without the |+cscope|
2419 feature}
2420 {not in Vi}
2421 Determines how many components of the path to show in a list of tags.
2422 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002423 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002424
2425 *'cscopeprg'* *'csprg'*
2426'cscopeprg' 'csprg' string (default "cscope")
2427 global
2428 {not available when compiled without the |+cscope|
2429 feature}
2430 {not in Vi}
2431 Specifies the command to execute cscope. See |cscopeprg|.
2432 This option cannot be set from a |modeline| or in the |sandbox|, for
2433 security reasons.
2434
2435 *'cscopequickfix'* *'csqf'*
2436'cscopequickfix' 'csqf' string (default "")
2437 global
2438 {not available when compiled without the |+cscope|
2439 or |+quickfix| features}
2440 {not in Vi}
2441 Specifies whether to use quickfix window to show cscope results.
2442 See |cscopequickfix|.
2443
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002444 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002445'cscoperelative' 'csre' boolean (default off)
2446 global
2447 {not available when compiled without the |+cscope|
2448 feature}
2449 {not in Vi}
2450 In the absence of a prefix (-P) for cscope. setting this option enables
2451 to use the basename of cscope.out path as the prefix.
2452 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002453 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002454
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2456'cscopetag' 'cst' boolean (default off)
2457 global
2458 {not available when compiled without the |+cscope|
2459 feature}
2460 {not in Vi}
2461 Use cscope for tag commands. See |cscope-options|.
2462 NOTE: This option is reset when 'compatible' is set.
2463
2464 *'cscopetagorder'* *'csto'*
2465'cscopetagorder' 'csto' number (default 0)
2466 global
2467 {not available when compiled without the |+cscope|
2468 feature}
2469 {not in Vi}
2470 Determines the order in which ":cstag" performs a search. See
2471 |cscopetagorder|.
2472 NOTE: This option is set to 0 when 'compatible' is set.
2473
2474 *'cscopeverbose'* *'csverb'*
2475 *'nocscopeverbose'* *'nocsverb'*
2476'cscopeverbose' 'csverb' boolean (default off)
2477 global
2478 {not available when compiled without the |+cscope|
2479 feature}
2480 {not in Vi}
2481 Give messages when adding a cscope database. See |cscopeverbose|.
2482 NOTE: This option is reset when 'compatible' is set.
2483
Bram Moolenaar860cae12010-06-05 23:22:07 +02002484 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2485'cursorbind' 'crb' boolean (default off)
2486 local to window
2487 {not in Vi}
Bram Moolenaar860cae12010-06-05 23:22:07 +02002488 When this option is set, as the cursor in the current
2489 window moves other cursorbound windows (windows that also have
2490 this option set) move their cursors to the corresponding line and
2491 column. This option is useful for viewing the
2492 differences between two versions of a file (see 'diff'); in diff mode,
2493 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002494 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002495
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002496
2497 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2498'cursorcolumn' 'cuc' boolean (default off)
2499 local to window
2500 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002501 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002502 feature}
2503 Highlight the screen column of the cursor with CursorColumn
2504 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2505 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002506 If you only want the highlighting in the current window you can use
2507 these autocommands: >
2508 au WinLeave * set nocursorline nocursorcolumn
2509 au WinEnter * set cursorline cursorcolumn
2510<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002511
2512 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2513'cursorline' 'cul' boolean (default off)
2514 local to window
2515 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002516 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002517 feature}
2518 Highlight the screen line of the cursor with CursorLine
2519 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2520 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002521 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002522 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002523
2524
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 *'debug'*
2526'debug' string (default "")
2527 global
2528 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002529 These values can be used:
2530 msg Error messages that would otherwise be omitted will be given
2531 anyway.
2532 throw Error messages that would otherwise be omitted will be given
2533 anyway and also throw an exception and set |v:errmsg|.
2534 beep A message will be given when otherwise only a beep would be
2535 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002536 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002537 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2538 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539
2540 *'define'* *'def'*
2541'define' 'def' string (default "^\s*#\s*define")
2542 global or local to buffer |global-local|
2543 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002544 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545 pattern, just like for the "/" command. This option is used for the
2546 commands like "[i" and "[d" |include-search|. The 'isident' option is
2547 used to recognize the defined name after the match:
2548 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2549 See |option-backslash| about inserting backslashes to include a space
2550 or backslash.
2551 The default value is for C programs. For C++ this value would be
2552 useful, to include const type declarations: >
2553 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2554< When using the ":set" command, you need to double the backslashes!
2555
2556 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2557'delcombine' 'deco' boolean (default off)
2558 global
2559 {not in Vi}
2560 {only available when compiled with the |+multi_byte|
2561 feature}
2562 If editing Unicode and this option is set, backspace and Normal mode
2563 "x" delete each combining character on its own. When it is off (the
2564 default) the character along with its combining characters are
2565 deleted.
2566 Note: When 'delcombine' is set "xx" may work different from "2x"!
2567
2568 This is useful for Arabic, Hebrew and many other languages where one
2569 may have combining characters overtop of base characters, and want
2570 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002571 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572
2573 *'dictionary'* *'dict'*
2574'dictionary' 'dict' string (default "")
2575 global or local to buffer |global-local|
2576 {not in Vi}
2577 List of file names, separated by commas, that are used to lookup words
2578 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2579 contain a list of words. This can be one word per line, or several
2580 words per line, separated by non-keyword characters (white space is
2581 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002582
2583 When this option is empty or an entry "spell" is present, and spell
2584 checking is enabled, words in the word lists for the currently active
2585 'spelllang' are used. See |spell|.
2586
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002587 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 after a comma are ignored, otherwise spaces are included in the file
2589 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002590 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591 Where to find a list of words?
2592 - On FreeBSD, there is the file "/usr/share/dict/words".
2593 - In the Simtel archive, look in the "msdos/linguist" directory.
2594 - In "miscfiles" of the GNU collection.
2595 The use of |:set+=| and |:set-=| is preferred when adding or removing
2596 directories from the list. This avoids problems when a future version
2597 uses another default.
2598 Backticks cannot be used in this option for security reasons.
2599
2600 *'diff'* *'nodiff'*
2601'diff' boolean (default off)
2602 local to window
2603 {not in Vi}
2604 {not available when compiled without the |+diff|
2605 feature}
2606 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002607 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002608
2609 *'dex'* *'diffexpr'*
2610'diffexpr' 'dex' string (default "")
2611 global
2612 {not in Vi}
2613 {not available when compiled without the |+diff|
2614 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002615 Expression which is evaluated to obtain a diff file (either ed-style
2616 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002617 This option cannot be set from a |modeline| or in the |sandbox|, for
2618 security reasons.
2619
2620 *'dip'* *'diffopt'*
Bram Moolenaarc93262b2018-09-10 21:15:40 +02002621'diffopt' 'dip' string (default "internal,filler")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 global
2623 {not in Vi}
2624 {not available when compiled without the |+diff|
2625 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002626 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627 All are optional. Items must be separated by a comma.
2628
2629 filler Show filler lines, to keep the text
2630 synchronized with a window that has inserted
2631 lines at the same position. Mostly useful
2632 when windows are side-by-side and 'scrollbind'
2633 is set.
2634
2635 context:{n} Use a context of {n} lines between a change
2636 and a fold that contains unchanged lines.
2637 When omitted a context of six lines is used.
2638 See |fold-diff|.
2639
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002640 iblank Ignore changes where lines are all blank. Adds
2641 the "-B" flag to the "diff" command if
2642 'diffexpr' is empty. Check the documentation
2643 of the "diff" command for what this does
2644 exactly.
2645 NOTE: the diff windows will get out of sync,
2646 because no differences between blank lines are
2647 taken into account.
2648
Bram Moolenaar071d4272004-06-13 20:20:40 +00002649 icase Ignore changes in case of text. "a" and "A"
2650 are considered the same. Adds the "-i" flag
2651 to the "diff" command if 'diffexpr' is empty.
2652
2653 iwhite Ignore changes in amount of white space. Adds
2654 the "-b" flag to the "diff" command if
2655 'diffexpr' is empty. Check the documentation
2656 of the "diff" command for what this does
2657 exactly. It should ignore adding trailing
2658 white space, but not leading white space.
2659
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002660 iwhiteall Ignore all white space changes. Adds
2661 the "-w" flag to the "diff" command if
2662 'diffexpr' is empty. Check the documentation
2663 of the "diff" command for what this does
2664 exactly.
2665
2666 iwhiteeol Ignore white space changes at end of line.
2667 Adds the "-Z" flag to the "diff" command if
2668 'diffexpr' is empty. Check the documentation
2669 of the "diff" command for what this does
2670 exactly.
2671
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002672 horizontal Start diff mode with horizontal splits (unless
2673 explicitly specified otherwise).
2674
2675 vertical Start diff mode with vertical splits (unless
2676 explicitly specified otherwise).
2677
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002678 hiddenoff Do not use diff mode for a buffer when it
2679 becomes hidden.
2680
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002681 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2682 starting diff mode. Without this 2 is used.
2683
Bram Moolenaare828b762018-09-10 17:51:58 +02002684 internal Use the internal diff library. This is
2685 ignored when 'diffexpr' is set. *E960*
2686 When running out of memory when writing a
2687 buffer this item will be ignored for diffs
2688 involving that buffer. Set the 'verbose'
2689 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690
Bram Moolenaare828b762018-09-10 17:51:58 +02002691 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002692 Use the indent heuristic for the internal
2693 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002694
2695 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002696 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002697 algorithms are:
2698 myers the default algorithm
2699 minimal spend extra time to generate the
2700 smallest possible diff
2701 patience patience diff algorithm
2702 histogram histogram diff algorithm
2703
2704 Examples: >
2705 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002707 :set diffopt=internal,filler,foldcolumn:3
2708 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709<
2710 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2711'digraph' 'dg' boolean (default off)
2712 global
2713 {not in Vi}
2714 {not available when compiled without the |+digraphs|
2715 feature}
2716 Enable the entering of digraphs in Insert mode with {char1} <BS>
2717 {char2}. See |digraphs|.
2718 NOTE: This option is reset when 'compatible' is set.
2719
2720 *'directory'* *'dir'*
2721'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002722 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 for Unix: ".,~/tmp,/var/tmp,/tmp")
2724 global
2725 List of directory names for the swap file, separated with commas.
2726 - The swap file will be created in the first directory where this is
2727 possible.
2728 - Empty means that no swap file will be used (recovery is
2729 impossible!).
2730 - A directory "." means to put the swap file in the same directory as
2731 the edited file. On Unix, a dot is prepended to the file name, so
2732 it doesn't show in a directory listing. On MS-Windows the "hidden"
2733 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002734 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735 put the swap file relative to where the edited file is. The leading
2736 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002737 - For Unix and Win32, if a directory ends in two path separators "//",
2738 the swap file name will be built from the complete path to the file
2739 with all path separators substituted to percent '%' signs. This will
2740 ensure file name uniqueness in the preserve directory.
2741 On Win32, it is also possible to end with "\\". However, When a
2742 separating comma is following, you must use "//", since "\\" will
2743 include the comma in the file name. Therefore it is recommended to
2744 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 - Spaces after the comma are ignored, other spaces are considered part
2746 of the directory name. To have a space at the start of a directory
2747 name, precede it with a backslash.
2748 - To include a comma in a directory name precede it with a backslash.
2749 - A directory name may end in an ':' or '/'.
2750 - Environment variables are expanded |:set_env|.
2751 - Careful with '\' characters, type one before a space, type two to
2752 get one in the option (see |option-backslash|), for example: >
2753 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2754< - For backwards compatibility with Vim version 3.0 a '>' at the start
2755 of the option is removed.
2756 Using "." first in the list is recommended. This means that editing
2757 the same file twice will result in a warning. Using "/tmp" on Unix is
2758 discouraged: When the system crashes you lose the swap file.
2759 "/var/tmp" is often not cleared when rebooting, thus is a better
2760 choice than "/tmp". But it can contain a lot of files, your swap
2761 files get lost in the crowd. That is why a "tmp" directory in your
2762 home directory is tried first.
2763 The use of |:set+=| and |:set-=| is preferred when adding or removing
2764 directories from the list. This avoids problems when a future version
2765 uses another default.
2766 This option cannot be set from a |modeline| or in the |sandbox|, for
2767 security reasons.
2768 {Vi: directory to put temp file in, defaults to "/tmp"}
2769
2770 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002771'display' 'dy' string (default "", set to "truncate" in
2772 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 global
2774 {not in Vi}
2775 Change the way text is displayed. This is comma separated list of
2776 flags:
2777 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002778 in a window will be displayed. "@@@" is put in the
2779 last columns of the last screen line to indicate the
2780 rest of the line is not displayed.
2781 truncate Like "lastline", but "@@@" is displayed in the first
2782 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 uhex Show unprintable characters hexadecimal as <xx>
2784 instead of using ^C and ~C.
2785
Bram Moolenaard0796902016-09-16 20:02:31 +02002786 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002787 doesn't fit is replaced with "@" lines.
2788
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 *'eadirection'* *'ead'*
2790'eadirection' 'ead' string (default "both")
2791 global
2792 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002793 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 feature}
2795 Tells when the 'equalalways' option applies:
2796 ver vertically, width of windows is not affected
2797 hor horizontally, height of windows is not affected
2798 both width and height of windows is affected
2799
2800 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2801'edcompatible' 'ed' boolean (default off)
2802 global
2803 Makes the 'g' and 'c' flags of the ":substitute" command to be
2804 toggled each time the flag is given. See |complex-change|. See
2805 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002806 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807
Bram Moolenaar03413f42016-04-12 21:07:15 +02002808 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002809'emoji' 'emo' boolean (default: on)
2810 global
2811 {not in Vi}
2812 {only available when compiled with the |+multi_byte|
2813 feature}
2814 When on all Unicode emoji characters are considered to be full width.
2815
2816
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 *'encoding'* *'enc'* *E543*
2818'encoding' 'enc' string (default: "latin1" or value from $LANG)
2819 global
2820 {only available when compiled with the |+multi_byte|
2821 feature}
2822 {not in Vi}
2823 Sets the character encoding used inside Vim. It applies to text in
2824 the buffers, registers, Strings in expressions, text stored in the
2825 viminfo file, etc. It sets the kind of characters which Vim can work
2826 with. See |encoding-names| for the possible values.
2827
2828 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002829 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002831 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002832
Bram Moolenaar865242e2010-07-14 21:12:05 +02002833 This option cannot be set from a |modeline|. It would most likely
2834 corrupt the text.
2835
Bram Moolenaar3df01732017-02-17 22:47:16 +01002836 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2837 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838 'encoding', "utf-8" is the natural choice for the environment and
2839 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002840 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841 versions, and to avoid changing the encoding of newly created files
2842 without your knowledge (in case 'fileencodings' is empty).
2843
2844 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002845 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 iconv() or as specified with 'charconvert'.
2847
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002848 If you need to know whether 'encoding' is a multi-byte encoding, you
2849 can use: >
2850 if has("multi_byte_encoding")
2851<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852 Normally 'encoding' will be equal to your current locale. This will
2853 be the default if Vim recognizes your environment settings. If
2854 'encoding' is not set to the current locale, 'termencoding' must be
2855 set to convert typed and displayed text. See |encoding-table|.
2856
2857 When you set this option, it fires the |EncodingChanged| autocommand
2858 event so that you can set up fonts if necessary.
2859
2860 When the option is set, the value is converted to lowercase. Thus
2861 you can set it with uppercase values too. Underscores are translated
2862 to '-' signs.
2863 When the encoding is recognized, it is changed to the standard name.
2864 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2865 "iso-8859-2" and "utf8" becomes "utf-8".
2866
2867 Note: "latin1" is also used when the encoding could not be detected.
2868 This only works when editing files in the same encoding! When the
2869 actual character set is not latin1, make sure 'fileencoding' and
2870 'fileencodings' are empty. When conversion is needed, switch to using
2871 utf-8.
2872
2873 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2874 You don't notice this while editing, but it does matter for the
2875 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2876 setting 'encoding' to one of these values instead of utf-8 only has
2877 effect for encoding used for files when 'fileencoding' is empty.
2878
Bram Moolenaar661b1822005-07-28 22:36:45 +00002879 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2880 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881
2882 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2883'endofline' 'eol' boolean (default on)
2884 local to buffer
2885 {not in Vi}
2886 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002887 is on, or 'fixeol' option is off, no <EOL> will be written for the
2888 last line in the file. This option is automatically set or reset when
2889 starting to edit a new file, depending on whether file has an <EOL>
2890 for the last line in the file. Normally you don't have to set or
2891 reset this option.
2892 When 'binary' is off and 'fixeol' is on the value is not used when
2893 writing the file. When 'binary' is on or 'fixeol' is off it is used
2894 to remember the presence of a <EOL> for the last line in the file, so
2895 that when you write the file the situation from the original file can
2896 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897
2898 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2899'equalalways' 'ea' boolean (default on)
2900 global
2901 {not in Vi}
2902 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002903 splitting or closing a window. This also happens the moment the
2904 option is switched on. When off, splitting a window will reduce the
2905 size of the current window and leave the other windows the same. When
2906 closing a window the extra lines are given to the window next to it
2907 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 When mixing vertically and horizontally split windows, a minimal size
2909 is computed and some windows may be larger if there is room. The
2910 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002911 Changing the height and width of a window can be avoided by setting
2912 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002913 If a window size is specified when creating a new window sizes are
2914 currently not equalized (it's complicated, but may be implemented in
2915 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916
2917 *'equalprg'* *'ep'*
2918'equalprg' 'ep' string (default "")
2919 global or local to buffer |global-local|
2920 {not in Vi}
2921 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002922 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002923 or 'indentexpr'. When Vim was compiled without internal formatting,
2924 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002925 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926 about including spaces and backslashes.
2927 This option cannot be set from a |modeline| or in the |sandbox|, for
2928 security reasons.
2929
2930 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2931'errorbells' 'eb' boolean (default off)
2932 global
2933 Ring the bell (beep or screen flash) for error messages. This only
2934 makes a difference for error messages, the bell will be used always
2935 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002936 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002937 screen flash or do nothing. See 'belloff' to finetune when to ring the
2938 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939
2940 *'errorfile'* *'ef'*
2941'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2942 others: "errors.err")
2943 global
2944 {not in Vi}
2945 {not available when compiled without the |+quickfix|
2946 feature}
2947 Name of the errorfile for the QuickFix mode (see |:cf|).
2948 When the "-q" command-line argument is used, 'errorfile' is set to the
2949 following argument. See |-q|.
2950 NOT used for the ":make" command. See 'makeef' for that.
2951 Environment variables are expanded |:set_env|.
2952 See |option-backslash| about including spaces and backslashes.
2953 This option cannot be set from a |modeline| or in the |sandbox|, for
2954 security reasons.
2955
2956 *'errorformat'* *'efm'*
2957'errorformat' 'efm' string (default is very long)
2958 global or local to buffer |global-local|
2959 {not in Vi}
2960 {not available when compiled without the |+quickfix|
2961 feature}
2962 Scanf-like description of the format for the lines in the error file
2963 (see |errorformat|).
2964
2965 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2966'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2967 global
2968 {not in Vi}
2969 Function keys that start with an <Esc> are recognized in Insert
2970 mode. When this option is off, the cursor and function keys cannot be
2971 used in Insert mode if they start with an <Esc>. The advantage of
2972 this is that the single <Esc> is recognized immediately, instead of
2973 after one second. Instead of resetting this option, you might want to
2974 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2975 when 'esckeys' is off, you can still map anything, but the cursor keys
2976 won't work by default.
2977 NOTE: This option is set to the Vi default value when 'compatible' is
2978 set and to the Vim default value when 'compatible' is reset.
2979
2980 *'eventignore'* *'ei'*
2981'eventignore' 'ei' string (default "")
2982 global
2983 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002985 When set to "all" or when "all" is one of the items, all autocommand
2986 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 Otherwise this is a comma separated list of event names. Example: >
2988 :set ei=WinEnter,WinLeave
2989<
2990 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2991'expandtab' 'et' boolean (default off)
2992 local to buffer
2993 {not in Vi}
2994 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002995 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2997 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002998 This option is reset when the 'paste' option is set and restored when
2999 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 NOTE: This option is reset when 'compatible' is set.
3001
3002 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3003'exrc' 'ex' boolean (default off)
3004 global
3005 {not in Vi}
3006 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003007 directory.
3008
3009 Setting this option is a potential security leak. E.g., consider
3010 unpacking a package or fetching files from github, a .vimrc in there
3011 might be a trojan horse. BETTER NOT SET THIS OPTION!
3012 Instead, define an autocommand in your .vimrc to set options for a
3013 matching directory.
3014
3015 If you do switch this option on you should also consider setting the
3016 'secure' option (see |initialization|).
3017 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 This option cannot be set from a |modeline| or in the |sandbox|, for
3019 security reasons.
3020
3021 *'fileencoding'* *'fenc'* *E213*
3022'fileencoding' 'fenc' string (default: "")
3023 local to buffer
3024 {only available when compiled with the |+multi_byte|
3025 feature}
3026 {not in Vi}
3027 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003028
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003030 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 When 'fileencoding' is empty, the same value as 'encoding' will be
3032 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003033 No error will be given when the value is set, only when it is used,
3034 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003035 Conversion will also be done when 'encoding' and 'fileencoding' are
3036 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3037 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003039 'encoding' is "utf-8" or another Unicode encoding, conversion
3040 is most likely done in a way that the reverse conversion
3041 results in the same text. When 'encoding' is not "utf-8" some
3042 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003043
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 See 'encoding' for the possible values. Additionally, values may be
3045 specified that can be handled by the converter, see
3046 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003047
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048 When reading a file 'fileencoding' will be set from 'fileencodings'.
3049 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003050 'fileencoding', use the |++enc| argument. One exception: when
3051 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003052 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003053
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3055 When the option is set, the value is converted to lowercase. Thus
3056 you can set it with uppercase values too. '_' characters are
3057 replaced with '-'. If a name is recognized from the list for
3058 'encoding', it is replaced by the standard name. For example
3059 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003060
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 When this option is set, after starting to edit a file, the 'modified'
3062 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003063
3064 Keep in mind that changing 'fenc' from a modeline happens
3065 AFTER the text has been read, thus it applies to when the file will be
3066 written. If you do set 'fenc' in a modeline, you might want to set
3067 'nomodified' to avoid not being able to ":q".
3068
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069 This option can not be changed when 'modifiable' is off.
3070
3071 *'fe'*
3072 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003073 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 old short name was 'fe', which is no longer used.
3075
3076 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003077'fileencodings' 'fencs' string (default: "ucs-bom",
3078 "ucs-bom,utf-8,default,latin1" when
3079 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 global
3081 {only available when compiled with the |+multi_byte|
3082 feature}
3083 {not in Vi}
3084 This is a list of character encodings considered when starting to edit
3085 an existing file. When a file is read, Vim tries to use the first
3086 mentioned character encoding. If an error is detected, the next one
3087 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003088 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 an empty string, which means the value of 'encoding' is used.
3090 WARNING: Conversion can cause loss of information! When
3091 'encoding' is "utf-8" (or one of the other Unicode variants)
3092 conversion is most likely done in a way that the reverse
3093 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003094 "utf-8" some non-ASCII characters may be lost! You can use
3095 the |++bad| argument to specify what is done with characters
3096 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 For an empty file or a file with only ASCII characters most encodings
3098 will work and the first entry of 'fileencodings' will be used (except
3099 "ucs-bom", which requires the BOM to be present). If you prefer
3100 another encoding use an BufReadPost autocommand event to test if your
3101 preferred encoding is to be used. Example: >
3102 au BufReadPost * if search('\S', 'w') == 0 |
3103 \ set fenc=iso-2022-jp | endif
3104< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3105 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003106 When the |++enc| argument is used then the value of 'fileencodings' is
3107 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003108 Note that 'fileencodings' is not used for a new file, the global value
3109 of 'fileencoding' is used instead. You can set it with: >
3110 :setglobal fenc=iso-8859-2
3111< This means that a non-existing file may get a different encoding than
3112 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 The special value "ucs-bom" can be used to check for a Unicode BOM
3114 (Byte Order Mark) at the start of the file. It must not be preceded
3115 by "utf-8" or another Unicode encoding for this to work properly.
3116 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3117 because Vim cannot detect an error, thus the encoding is always
3118 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003119 The special value "default" can be used for the encoding from the
3120 environment. This is the default value for 'encoding'. It is useful
3121 when 'encoding' is set to "utf-8" and your environment uses a
3122 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003123 When 'encoding' is "utf-8" and a file contains an illegal byte
3124 sequence it won't be recognized as UTF-8. You can use the |8g8|
3125 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126 WRONG VALUES: WHAT'S WRONG:
3127 latin1,utf-8 "latin1" will always be used
3128 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3129 file
3130 cp1250,latin1 "cp1250" will always be used
3131 If 'fileencodings' is empty, 'fileencoding' is not modified.
3132 See 'fileencoding' for the possible values.
3133 Setting this option does not have an effect until the next time a file
3134 is read.
3135
3136 *'fileformat'* *'ff'*
3137'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3138 Unix default: "unix",
3139 Macintosh default: "mac")
3140 local to buffer
3141 {not in Vi}
3142 This gives the <EOL> of the current buffer, which is used for
3143 reading/writing the buffer from/to a file:
3144 dos <CR> <NL>
3145 unix <NL>
3146 mac <CR>
3147 When "dos" is used, CTRL-Z at the end of a file is ignored.
3148 See |file-formats| and |file-read|.
3149 For the character encoding of the file see 'fileencoding'.
3150 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003151 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 This option is set automatically when starting to edit a file and
3153 'fileformats' is not empty and 'binary' is off.
3154 When this option is set, after starting to edit a file, the 'modified'
3155 option is set, because the file would be different when written.
3156 This option can not be changed when 'modifiable' is off.
3157 For backwards compatibility: When this option is set to "dos",
3158 'textmode' is set, otherwise 'textmode' is reset.
3159
3160 *'fileformats'* *'ffs'*
3161'fileformats' 'ffs' string (default:
3162 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3163 Vim Unix: "unix,dos",
3164 Vim Mac: "mac,unix,dos",
3165 Vi Cygwin: "unix,dos",
3166 Vi others: "")
3167 global
3168 {not in Vi}
3169 This gives the end-of-line (<EOL>) formats that will be tried when
3170 starting to edit a new buffer and when reading a file into an existing
3171 buffer:
3172 - When empty, the format defined with 'fileformat' will be used
3173 always. It is not set automatically.
3174 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003175 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176 'fileformats' name will be used when a file is read into an existing
3177 buffer, no matter what 'fileformat' for that buffer is set to.
3178 - When more than one name is present, separated by commas, automatic
3179 <EOL> detection will be done when reading a file. When starting to
3180 edit a file, a check is done for the <EOL>:
3181 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3182 'fileformat' is set to "dos".
3183 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003184 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003186 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3187 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003188 This means that "mac" is only chosen when:
3189 "unix" is not present or no <NL> is found in the file, and
3190 "dos" is not present or no <CR><NL> is found in the file.
3191 Except: if "unix" was chosen, but there is a <CR> before
3192 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003193 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 4. If 'fileformat' is still not set, the first name from
3195 'fileformats' is used.
3196 When reading a file into an existing buffer, the same is done, but
3197 this happens like 'fileformat' has been set appropriately for that
3198 file only, the option is not changed.
3199 When 'binary' is set, the value of 'fileformats' is not used.
3200
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003201 When Vim starts up with an empty buffer the first item is used. You
3202 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003203
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3205 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3206 done:
3207 - When 'fileformats' is empty, there is no automatic detection. Dos
3208 format will be used.
3209 - When 'fileformats' is set to one or more names, automatic detection
3210 is done. This is based on the first <NL> in the file: If there is a
3211 <CR> in front of it, Dos format is used, otherwise Unix format is
3212 used.
3213 Also see |file-formats|.
3214 For backwards compatibility: When this option is set to an empty
3215 string or one format (no comma is included), 'textauto' is reset,
3216 otherwise 'textauto' is set.
3217 NOTE: This option is set to the Vi default value when 'compatible' is
3218 set and to the Vim default value when 'compatible' is reset.
3219
Bram Moolenaarbf884932013-04-05 22:26:15 +02003220 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3221'fileignorecase' 'fic' boolean (default on for systems where case in file
3222 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003223 global
3224 {not in Vi}
3225 When set case is ignored when using file names and directories.
3226 See 'wildignorecase' for only ignoring case when doing completion.
3227
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 *'filetype'* *'ft'*
3229'filetype' 'ft' string (default: "")
3230 local to buffer
3231 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 When this option is set, the FileType autocommand event is triggered.
3233 All autocommands that match with the value of this option will be
3234 executed. Thus the value of 'filetype' is used in place of the file
3235 name.
3236 Otherwise this option does not always reflect the current file type.
3237 This option is normally set when the file type is detected. To enable
3238 this use the ":filetype on" command. |:filetype|
3239 Setting this option to a different value is most useful in a modeline,
3240 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003241 Example, for in an IDL file:
3242 /* vim: set filetype=idl : */ ~
3243 |FileType| |filetypes|
3244 When a dot appears in the value then this separates two filetype
3245 names. Example:
3246 /* vim: set filetype=c.doxygen : */ ~
3247 This will use the "c" filetype first, then the "doxygen" filetype.
3248 This works both for filetype plugins and for syntax files. More than
3249 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250 This option is not copied to another buffer, independent of the 's' or
3251 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003252 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253
3254 *'fillchars'* *'fcs'*
3255'fillchars' 'fcs' string (default "vert:|,fold:-")
3256 global
3257 {not in Vi}
3258 {not available when compiled without the |+windows|
3259 and |+folding| features}
3260 Characters to fill the statuslines and vertical separators.
3261 It is a comma separated list of items:
3262
3263 item default Used for ~
3264 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003265 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 vert:c '|' vertical separators |:vsplit|
3267 fold:c '-' filling 'foldtext'
3268 diff:c '-' deleted lines of the 'diff' option
3269
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003270 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003271 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 otherwise.
3273
3274 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003275 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276< This is similar to the default, except that these characters will also
3277 be used when there is highlighting.
3278
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003279 for "stl" and "stlnc" only single-byte values are supported.
3280
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 The highlighting used for these items:
3282 item highlight group ~
3283 stl:c StatusLine |hl-StatusLine|
3284 stlnc:c StatusLineNC |hl-StatusLineNC|
3285 vert:c VertSplit |hl-VertSplit|
3286 fold:c Folded |hl-Folded|
3287 diff:c DiffDelete |hl-DiffDelete|
3288
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003289 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3290'fixendofline' 'fixeol' boolean (default on)
3291 local to buffer
3292 {not in Vi}
3293 When writing a file and this option is on, <EOL> at the end of file
3294 will be restored if missing. Turn this option off if you want to
3295 preserve the situation from the original file.
3296 When the 'binary' option is set the value of this option doesn't
3297 matter.
3298 See the 'endofline' option.
3299
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3301'fkmap' 'fk' boolean (default off) *E198*
3302 global
3303 {not in Vi}
3304 {only available when compiled with the |+rightleft|
3305 feature}
3306 When on, the keyboard is mapped for the Farsi character set.
3307 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003308 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309
3310 *'foldclose'* *'fcl'*
3311'foldclose' 'fcl' string (default "")
3312 global
3313 {not in Vi}
3314 {not available when compiled without the |+folding|
3315 feature}
3316 When set to "all", a fold is closed when the cursor isn't in it and
3317 its level is higher than 'foldlevel'. Useful if you want folds to
3318 automatically close when moving out of them.
3319
3320 *'foldcolumn'* *'fdc'*
3321'foldcolumn' 'fdc' number (default 0)
3322 local to window
3323 {not in Vi}
3324 {not available when compiled without the |+folding|
3325 feature}
3326 When non-zero, a column with the specified width is shown at the side
3327 of the window which indicates open and closed folds. The maximum
3328 value is 12.
3329 See |folding|.
3330
3331 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3332'foldenable' 'fen' boolean (default on)
3333 local to window
3334 {not in Vi}
3335 {not available when compiled without the |+folding|
3336 feature}
3337 When off, all folds are open. This option can be used to quickly
3338 switch between showing all text unfolded and viewing the text with
3339 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003340 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 'foldenable' is off.
3342 This option is set by commands that create a new fold or close a fold.
3343 See |folding|.
3344
3345 *'foldexpr'* *'fde'*
3346'foldexpr' 'fde' string (default: "0")
3347 local to window
3348 {not in Vi}
3349 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003350 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003352 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003353
Bram Moolenaar30b65812012-07-12 22:01:11 +02003354 The expression will be evaluated in the |sandbox| if set from a
3355 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003356 This option can't be set from a |modeline| when the 'diff' option is
3357 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003358
3359 It is not allowed to change text or jump to another window while
3360 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361
3362 *'foldignore'* *'fdi'*
3363'foldignore' 'fdi' string (default: "#")
3364 local to window
3365 {not in Vi}
3366 {not available when compiled without the |+folding|
3367 feature}
3368 Used only when 'foldmethod' is "indent". Lines starting with
3369 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003370 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371 The default "#" works well for C programs. See |fold-indent|.
3372
3373 *'foldlevel'* *'fdl'*
3374'foldlevel' 'fdl' number (default: 0)
3375 local to window
3376 {not in Vi}
3377 {not available when compiled without the |+folding|
3378 feature}
3379 Sets the fold level: Folds with a higher level will be closed.
3380 Setting this option to zero will close all folds. Higher numbers will
3381 close fewer folds.
3382 This option is set by commands like |zm|, |zM| and |zR|.
3383 See |fold-foldlevel|.
3384
3385 *'foldlevelstart'* *'fdls'*
3386'foldlevelstart' 'fdls' number (default: -1)
3387 global
3388 {not in Vi}
3389 {not available when compiled without the |+folding|
3390 feature}
3391 Sets 'foldlevel' when starting to edit another buffer in a window.
3392 Useful to always start editing with all folds closed (value zero),
3393 some folds closed (one) or no folds closed (99).
3394 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003395 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 ignores this option and closes all folds.
3397 It is also done before BufReadPre autocommands, to allow an autocmd to
3398 overrule the 'foldlevel' value for specific files.
3399 When the value is negative, it is not used.
3400
3401 *'foldmarker'* *'fmr'* *E536*
3402'foldmarker' 'fmr' string (default: "{{{,}}}")
3403 local to window
3404 {not in Vi}
3405 {not available when compiled without the |+folding|
3406 feature}
3407 The start and end marker used when 'foldmethod' is "marker". There
3408 must be one comma, which separates the start and end marker. The
3409 marker is a literal string (a regular expression would be too slow).
3410 See |fold-marker|.
3411
3412 *'foldmethod'* *'fdm'*
3413'foldmethod' 'fdm' string (default: "manual")
3414 local to window
3415 {not in Vi}
3416 {not available when compiled without the |+folding|
3417 feature}
3418 The kind of folding used for the current window. Possible values:
3419 |fold-manual| manual Folds are created manually.
3420 |fold-indent| indent Lines with equal indent form a fold.
3421 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3422 |fold-marker| marker Markers are used to specify folds.
3423 |fold-syntax| syntax Syntax highlighting items specify folds.
3424 |fold-diff| diff Fold text that is not changed.
3425
3426 *'foldminlines'* *'fml'*
3427'foldminlines' 'fml' number (default: 1)
3428 local to window
3429 {not in Vi}
3430 {not available when compiled without the |+folding|
3431 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003432 Sets the number of screen lines above which a fold can be displayed
3433 closed. Also for manually closed folds. With the default value of
3434 one a fold can only be closed if it takes up two or more screen lines.
3435 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003436 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 "zc" to close a fold, which is displayed open because it's smaller
3438 than 'foldminlines', a following "zc" may close a containing fold.
3439
3440 *'foldnestmax'* *'fdn'*
3441'foldnestmax' 'fdn' number (default: 20)
3442 local to window
3443 {not in Vi}
3444 {not available when compiled without the |+folding|
3445 feature}
3446 Sets the maximum nesting of folds for the "indent" and "syntax"
3447 methods. This avoids that too many folds will be created. Using more
3448 than 20 doesn't work, because the internal limit is 20.
3449
3450 *'foldopen'* *'fdo'*
3451'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3452 search,tag,undo")
3453 global
3454 {not in Vi}
3455 {not available when compiled without the |+folding|
3456 feature}
3457 Specifies for which type of commands folds will be opened, if the
3458 command moves the cursor into a closed fold. It is a comma separated
3459 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003460 NOTE: When the command is part of a mapping this option is not used.
3461 Add the |zv| command to the mapping to get the same effect.
3462 (rationale: the mapping may want to control opening folds itself)
3463
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 item commands ~
3465 all any
3466 block "(", "{", "[[", "[{", etc.
3467 hor horizontal movements: "l", "w", "fx", etc.
3468 insert any command in Insert mode
3469 jump far jumps: "G", "gg", etc.
3470 mark jumping to a mark: "'m", CTRL-O, etc.
3471 percent "%"
3472 quickfix ":cn", ":crew", ":make", etc.
3473 search search for a pattern: "/", "n", "*", "gd", etc.
3474 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003475 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 tag jumping to a tag: ":ta", CTRL-T, etc.
3477 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 When a movement command is used for an operator (e.g., "dl" or "y%")
3479 this option is not used. This means the operator will include the
3480 whole closed fold.
3481 Note that vertical movements are not here, because it would make it
3482 very difficult to move onto a closed fold.
3483 In insert mode the folds containing the cursor will always be open
3484 when text is inserted.
3485 To close folds you can re-apply 'foldlevel' with the |zx| command or
3486 set the 'foldclose' option to "all".
3487
3488 *'foldtext'* *'fdt'*
3489'foldtext' 'fdt' string (default: "foldtext()")
3490 local to window
3491 {not in Vi}
3492 {not available when compiled without the |+folding|
3493 feature}
3494 An expression which is used to specify the text displayed for a closed
3495 fold. See |fold-foldtext|.
3496
Bram Moolenaar30b65812012-07-12 22:01:11 +02003497 The expression will be evaluated in the |sandbox| if set from a
3498 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003499
3500 It is not allowed to change text or jump to another window while
3501 evaluating 'foldtext' |textlock|.
3502
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003503 *'formatexpr'* *'fex'*
3504'formatexpr' 'fex' string (default "")
3505 local to buffer
3506 {not in Vi}
3507 {not available when compiled without the |+eval|
3508 feature}
3509 Expression which is evaluated to format a range of lines for the |gq|
3510 operator or automatic formatting (see 'formatoptions'). When this
3511 option is empty 'formatprg' is used.
3512
3513 The |v:lnum| variable holds the first line to be formatted.
3514 The |v:count| variable holds the number of lines to be formatted.
3515 The |v:char| variable holds the character that is going to be
3516 inserted if the expression is being evaluated due to
3517 automatic formatting. This can be empty. Don't insert
3518 it yet!
3519
3520 Example: >
3521 :set formatexpr=mylang#Format()
3522< This will invoke the mylang#Format() function in the
3523 autoload/mylang.vim file in 'runtimepath'. |autoload|
3524
3525 The expression is also evaluated when 'textwidth' is set and adding
3526 text beyond that limit. This happens under the same conditions as
3527 when internal formatting is used. Make sure the cursor is kept in the
3528 same spot relative to the text then! The |mode()| function will
3529 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003530
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003531 When the expression evaluates to non-zero Vim will fall back to using
3532 the internal format mechanism.
3533
3534 The expression will be evaluated in the |sandbox| when set from a
3535 modeline, see |sandbox-option|. That stops the option from working,
3536 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003537 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003538
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 *'formatoptions'* *'fo'*
3540'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3541 local to buffer
3542 {not in Vi}
3543 This is a sequence of letters which describes how automatic
3544 formatting is to be done. See |fo-table|. When the 'paste' option is
3545 on, no formatting is done (like 'formatoptions' is empty). Commas can
3546 be inserted for readability.
3547 To avoid problems with flags that are added in the future, use the
3548 "+=" and "-=" feature of ":set" |add-option-flags|.
3549 NOTE: This option is set to the Vi default value when 'compatible' is
3550 set and to the Vim default value when 'compatible' is reset.
3551
Bram Moolenaar86b68352004-12-27 21:59:20 +00003552 *'formatlistpat'* *'flp'*
3553'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3554 local to buffer
3555 {not in Vi}
3556 A pattern that is used to recognize a list header. This is used for
3557 the "n" flag in 'formatoptions'.
3558 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003559 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003560 while still checking more characters. There must be a character
3561 following the pattern, when it matches the whole line it is handled
3562 like there is no match.
3563 The default recognizes a number, followed by an optional punctuation
3564 character and white space.
3565
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 *'formatprg'* *'fp'*
3567'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003568 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 {not in Vi}
3570 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003571 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003573 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003574 If the 'formatexpr' option is not empty it will be used instead.
3575 Otherwise, if 'formatprg' option is an empty string, the internal
3576 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003577 Environment variables are expanded |:set_env|. See |option-backslash|
3578 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003579 This option cannot be set from a |modeline| or in the |sandbox|, for
3580 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581
Bram Moolenaard94464e2015-11-02 15:28:18 +01003582 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003583'fsync' 'fs' boolean (default on)
3584 global
3585 {not in Vi}
3586 When on, the library function fsync() will be called after writing a
3587 file. This will flush a file to disk, ensuring that it is safely
3588 written even on filesystems which do metadata-only journaling. This
3589 will force the harddrive to spin up on Linux systems running in laptop
3590 mode, so it may be undesirable in some situations. Be warned that
3591 turning this off increases the chances of data loss after a crash. On
3592 systems without an fsync() implementation, this variable is always
3593 off.
3594 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003595 'fsync' also applies to |writefile()|, unless a flag is used to
3596 overrule it.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003597
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3599'gdefault' 'gd' boolean (default off)
3600 global
3601 {not in Vi}
3602 When on, the ":substitute" flag 'g' is default on. This means that
3603 all matches in a line are substituted instead of one. When a 'g' flag
3604 is given to a ":substitute" command, this will toggle the substitution
3605 of all or one match. See |complex-change|.
3606
3607 command 'gdefault' on 'gdefault' off ~
3608 :s/// subst. all subst. one
3609 :s///g subst. one subst. all
3610 :s///gg subst. all subst. one
3611
3612 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003613 DEPRECATED: Setting this option may break plugins that are not aware
3614 of this option. Also, many users get confused that adding the /g flag
3615 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616
3617 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003618'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 global
3620 {not in Vi}
3621 Format to recognize for the ":grep" command output.
3622 This is a scanf-like string that uses the same format as the
3623 'errorformat' option: see |errorformat|.
3624
3625 *'grepprg'* *'gp'*
3626'grepprg' 'gp' string (default "grep -n ",
3627 Unix: "grep -n $* /dev/null",
3628 Win32: "findstr /n" or "grep -n",
3629 VMS: "SEARCH/NUMBERS ")
3630 global or local to buffer |global-local|
3631 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003632 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 and '#' characters, which are expanded like when used in a command-
3634 line. The placeholder "$*" is allowed to specify where the arguments
3635 will be included. Environment variables are expanded |:set_env|. See
3636 |option-backslash| about including spaces and backslashes.
3637 When your "grep" accepts the "-H" argument, use this to make ":grep"
3638 also work well with a single file: >
3639 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003640< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003641 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3642 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003643 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 apply equally to 'grepprg'.
3645 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3646 otherwise it's "grep -n".
3647 This option cannot be set from a |modeline| or in the |sandbox|, for
3648 security reasons.
3649
3650 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3651'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3652 ve:ver35-Cursor,
3653 o:hor50-Cursor,
3654 i-ci:ver25-Cursor/lCursor,
3655 r-cr:hor20-Cursor/lCursor,
3656 sm:block-Cursor
3657 -blinkwait175-blinkoff150-blinkon175",
3658 for MS-DOS and Win32 console:
3659 "n-v-c:block,o:hor50,i-ci:hor15,
3660 r-cr:hor30,sm:block")
3661 global
3662 {not in Vi}
3663 {only available when compiled with GUI enabled, and
3664 for MS-DOS and Win32 console}
3665 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003666 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 the height of the cursor can be changed. This can be done by
3668 specifying a block cursor, or a percentage for a vertical or
3669 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003670 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3671 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003673 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 mode-list and an argument-list:
3675 mode-list:argument-list,mode-list:argument-list,..
3676 The mode-list is a dash separated list of these modes:
3677 n Normal mode
3678 v Visual mode
3679 ve Visual mode with 'selection' "exclusive" (same as 'v',
3680 if not specified)
3681 o Operator-pending mode
3682 i Insert mode
3683 r Replace mode
3684 c Command-line Normal (append) mode
3685 ci Command-line Insert mode
3686 cr Command-line Replace mode
3687 sm showmatch in Insert mode
3688 a all modes
3689 The argument-list is a dash separated list of these arguments:
3690 hor{N} horizontal bar, {N} percent of the character height
3691 ver{N} vertical bar, {N} percent of the character width
3692 block block cursor, fills the whole character
3693 [only one of the above three should be present]
3694 blinkwait{N} *cursor-blinking*
3695 blinkon{N}
3696 blinkoff{N}
3697 blink times for cursor: blinkwait is the delay before
3698 the cursor starts blinking, blinkon is the time that
3699 the cursor is shown and blinkoff is the time that the
3700 cursor is not shown. The times are in msec. When one
3701 of the numbers is zero, there is no blinking. The
3702 default is: "blinkwait700-blinkon400-blinkoff250".
3703 These numbers are used for a missing entry. This
3704 means that blinking is enabled by default. To switch
3705 blinking off you can use "blinkon0". The cursor only
3706 blinks when Vim is waiting for input, not while
3707 executing a command.
3708 To make the cursor blink in an xterm, see
3709 |xterm-blink|.
3710 {group-name}
3711 a highlight group name, that sets the color and font
3712 for the cursor
3713 {group-name}/{group-name}
3714 Two highlight group names, the first is used when
3715 no language mappings are used, the other when they
3716 are. |language-mapping|
3717
3718 Examples of parts:
3719 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3720 block cursor with colors from the "nCursor"
3721 highlight group
3722 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3723 In Insert and Command-line Insert mode, use a
3724 30% vertical bar cursor with colors from the
3725 "iCursor" highlight group. Blink a bit
3726 faster.
3727
3728 The 'a' mode is different. It will set the given argument-list for
3729 all modes. It does not reset anything to defaults. This can be used
3730 to do a common setting for all modes. For example, to switch off
3731 blinking: "a:blinkon0"
3732
3733 Examples of cursor highlighting: >
3734 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3735 :highlight Cursor gui=NONE guifg=bg guibg=fg
3736<
3737 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003738 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739'guifont' 'gfn' string (default "")
3740 global
3741 {not in Vi}
3742 {only available when compiled with GUI enabled}
3743 This is a list of fonts which will be used for the GUI version of Vim.
3744 In its simplest form the value is just one font name. When
3745 the font cannot be found you will get an error message. To try other
3746 font names a list can be specified, font names separated with commas.
3747 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003748
Bram Moolenaar05159a02005-02-26 23:04:13 +00003749 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3750 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003751
Bram Moolenaar3df01732017-02-17 22:47:16 +01003752 Note: As to the GTK GUIs, no error is given against any invalid names,
3753 and the first element of the list is always picked up and made use of.
3754 This is because, instead of identifying a given name with a font, the
3755 GTK GUIs use it to construct a pattern and try to look up a font which
3756 best matches the pattern among available fonts, and this way, the
3757 matching never fails. An invalid name doesn't matter because a number
3758 of font properties other than name will do to get the matching done.
3759
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 Spaces after a comma are ignored. To include a comma in a font name
3761 precede it with a backslash. Setting an option requires an extra
3762 backslash before a space and a backslash. See also
3763 |option-backslash|. For example: >
3764 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003765< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003767
3768 If none of the fonts can be loaded, Vim will keep the current setting.
3769 If an empty font list is given, Vim will try using other resource
3770 settings (for X, it will use the Vim.font resource), and finally it
3771 will try some builtin default which should always be there ("7x13" in
3772 the case of X). The font names given should be "normal" fonts. Vim
3773 will try to find the related bold and italic fonts.
3774
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003775 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003776 :set guifont=*
3777< will bring up a font requester, where you can pick the font you want.
3778
3779 The font name depends on the GUI used. See |setting-guifont| for a
3780 way to set 'guifont' for various systems.
3781
Bram Moolenaar3df01732017-02-17 22:47:16 +01003782 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003784< That's all. XLFDs are not used. For Chinese this is reported to work
3785 well: >
3786 if has("gui_gtk2")
3787 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3788 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3789 endif
3790<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003791 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3792
Bram Moolenaar05159a02005-02-26 23:04:13 +00003793 For Mac OSX you can use something like this: >
3794 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003795< Also see 'macatsui', it can help fix display problems.
3796 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003798 width). An exception is GTK: all fonts are accepted, but mono-spaced
3799 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003800
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801 To preview a font on X11, you might be able to use the "xfontsel"
3802 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003803
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 For the Win32 GUI *E244* *E245*
3805 - takes these options in the font name:
3806 hXX - height is XX (points, can be floating-point)
3807 wXX - width is XX (points, can be floating-point)
3808 b - bold
3809 i - italic
3810 u - underline
3811 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003812 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3814 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3815 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003816 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003817 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003818 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003819 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003820 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821
3822 Use a ':' to separate the options.
3823 - A '_' can be used in the place of a space, so you don't need to use
3824 backslashes to escape the spaces.
3825 - Examples: >
3826 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3827 :set guifont=Andale_Mono:h7.5:w4.5
3828< See also |font-sizes|.
3829
3830 *'guifontset'* *'gfs'*
3831 *E250* *E252* *E234* *E597* *E598*
3832'guifontset' 'gfs' string (default "")
3833 global
3834 {not in Vi}
3835 {only available when compiled with GUI enabled and
3836 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003837 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 When not empty, specifies two (or more) fonts to be used. The first
3839 one for normal English, the second one for your special language. See
3840 |xfontset|.
3841 Setting this option also means that all font names will be handled as
3842 a fontset name. Also the ones used for the "font" argument of the
3843 |:highlight| command.
3844 The fonts must match with the current locale. If fonts for the
3845 character sets that the current locale uses are not included, setting
3846 'guifontset' will fail.
3847 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3848 the comma-separated names are alternative names, one of which will be
3849 used. In 'guifontset' the whole string is one fontset name,
3850 including the commas. It is not possible to specify alternative
3851 fontset names.
3852 This example works on many X11 systems: >
3853 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3854<
3855 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3856'guifontwide' 'gfw' string (default "")
3857 global
3858 {not in Vi}
3859 {only available when compiled with GUI enabled}
3860 When not empty, specifies a comma-separated list of fonts to be used
3861 for double-width characters. The first font that can be loaded is
3862 used.
3863 Note: The size of these fonts must be exactly twice as wide as the one
3864 specified with 'guifont' and the same height.
3865
Bram Moolenaar3df01732017-02-17 22:47:16 +01003866 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867
3868 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3869 'guifontset' is empty or invalid.
3870 When 'guifont' is set and a valid font is found in it and
3871 'guifontwide' is empty Vim will attempt to find a matching
3872 double-width font and set 'guifontwide' to it.
3873
Bram Moolenaar3df01732017-02-17 22:47:16 +01003874 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875
3876 If set and valid, 'guifontwide' is always used for double width
3877 characters, even if 'encoding' is not set to "utf-8".
3878 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003879 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 font for characters not available in 'guifont'. Thus you do not need
3881 to set 'guifontwide' at all unless you want to override the choice
3882 made by Pango/Xft.
3883
Bram Moolenaar0f272122013-01-23 18:37:40 +01003884 Windows +multibyte only: *guifontwide_win_mbyte*
3885
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003886 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003887
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 *'guiheadroom'* *'ghr'*
3889'guiheadroom' 'ghr' number (default 50)
3890 global
3891 {not in Vi} {only for GTK and X11 GUI}
3892 The number of pixels subtracted from the screen height when fitting
3893 the GUI window on the screen. Set this before the GUI is started,
3894 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003895 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 lines will be left for window decorations and other items on the
3897 screen. Set it to a negative value to allow windows taller than the
3898 screen.
3899
3900 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003901'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3902 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003903 "aegimrLtT" (GTK, Motif and Athena),
3904 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 global
3906 {not in Vi}
3907 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003908 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 sequence of letters which describes what components and options of the
3910 GUI should be used.
3911 To avoid problems with flags that are added in the future, use the
3912 "+=" and "-=" feature of ":set" |add-option-flags|.
3913
Bram Moolenaar13568252018-03-16 20:46:58 +01003914 Valid characters are as follows:
3915 *'go-!'*
3916 '!' External commands are executed in a terminal window. Without
3917 this flag the MS-Windows GUI will open a console window to
3918 execute the command. The Unix GUI will simulate a dumb
3919 terminal to list the command output.
3920 The terminal window will be positioned at the bottom, and grow
3921 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003922 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 'a' Autoselect: If present, then whenever VISUAL mode is started,
3924 or the Visual area extended, Vim tries to become the owner of
3925 the windowing system's global selection. This means that the
3926 Visually highlighted text is available for pasting into other
3927 applications as well as into Vim itself. When the Visual mode
3928 ends, possibly due to an operation on the text, or when an
3929 application wants to paste the selection, the highlighted text
3930 is automatically yanked into the "* selection register.
3931 Thus the selection is still available for pasting into other
3932 applications after the VISUAL mode has ended.
3933 If not present, then Vim won't become the owner of the
3934 windowing system's global selection unless explicitly told to
3935 by a yank or delete operation for the "* register.
3936 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003937 *'go-P'*
3938 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003939 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003940 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003941 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942 applies to the modeless selection.
3943
3944 'guioptions' autoselect Visual autoselect modeless ~
3945 "" - -
3946 "a" yes yes
3947 "A" - yes
3948 "aA" yes yes
3949
Bram Moolenaar02467872007-05-06 13:22:01 +00003950 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 'c' Use console dialogs instead of popup dialogs for simple
3952 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003953 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003954 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003955 'guitablabel' can be used to change the text in the labels.
3956 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003957 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003958 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003959 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 'f' Foreground: Don't use fork() to detach the GUI from the shell
3961 where it was started. Use this for programs that wait for the
3962 editor to finish (e.g., an e-mail program). Alternatively you
3963 can use "gvim -f" or ":gui -f" to start the GUI in the
3964 foreground. |gui-fork|
3965 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003966 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003967 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3969 corner of the window. It's black&white on non-GTK, because of
3970 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003971 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003973 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003974 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003976 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003978 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003979 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 'g' Grey menu items: Make menu items that are not active grey. If
3981 'g' is not included inactive menu items are not shown at all.
3982 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003983 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 't' Include tearoff menu items. Currently only works for Win32,
3985 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003986 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003987 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003988 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003989 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003991 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 'R' Right-hand scrollbar is present when there is a vertically
3993 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003994 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003996 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 'L' Left-hand scrollbar is present when there is a vertically
3998 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003999 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4001 the longest visible line, or on the cursor line if the 'h'
4002 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004003 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 'h' Limit horizontal scrollbar size to the length of the cursor
4005 line. Reduces computations. |gui-horiz-scroll|
4006
4007 And yes, you may even have scrollbars on the left AND the right if
4008 you really want to :-). See |gui-scrollbars| for more information.
4009
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004010 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 'v' Use a vertical button layout for dialogs. When not included,
4012 a horizontal layout is preferred, but when it doesn't fit a
4013 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004014 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 'p' Use Pointer callbacks for X11 GUI. This is required for some
4016 window managers. If the cursor is not blinking or hollow at
4017 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004018 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004020 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004021 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004022 *'go-k'*
4023 'k' Keep the GUI window size when adding/removing a scrollbar, or
4024 toolbar, tabline, etc. Instead, the behavior is similar to
4025 when the window is maximized and will adjust 'lines' and
4026 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004027 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004028 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004029
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 *'guipty'* *'noguipty'*
4031'guipty' boolean (default on)
4032 global
4033 {not in Vi}
4034 {only available when compiled with GUI enabled}
4035 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4036 I/O to/from shell commands. See |gui-pty|.
4037
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004038 *'guitablabel'* *'gtl'*
4039'guitablabel' 'gtl' string (default empty)
4040 global
4041 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004042 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02004043 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004044 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004045 pages line. When empty and when the result is empty Vim will use a
4046 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004047
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004048 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004049 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004050 The expression will be evaluated in the |sandbox| when set from a
4051 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004052
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004053 Only used when the GUI tab pages line is displayed. 'e' must be
4054 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4055 used.
4056
Bram Moolenaar57657d82006-04-21 22:12:41 +00004057 *'guitabtooltip'* *'gtt'*
4058'guitabtooltip' 'gtt' string (default empty)
4059 global
4060 {not in Vi}
4061 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02004062 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004063 When nonempty describes the text to use in a tooltip for the GUI tab
4064 pages line. When empty Vim will use a default tooltip.
4065 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004066 You can include a line break. Simplest method is to use |:let|: >
4067 :let &guitabtooltip = "line one\nline two"
4068<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004069
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070 *'helpfile'* *'hf'*
4071'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
4072 (others) "$VIMRUNTIME/doc/help.txt")
4073 global
4074 {not in Vi}
4075 Name of the main help file. All distributed help files should be
4076 placed together in one directory. Additionally, all "doc" directories
4077 in 'runtimepath' will be used.
4078 Environment variables are expanded |:set_env|. For example:
4079 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004080 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081 spaces and backslashes.
4082 This option cannot be set from a |modeline| or in the |sandbox|, for
4083 security reasons.
4084
4085 *'helpheight'* *'hh'*
4086'helpheight' 'hh' number (default 20)
4087 global
4088 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004089 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 feature}
4091 Minimal initial height of the help window when it is opened with the
4092 ":help" command. The initial height of the help window is half of the
4093 current window, or (when the 'ea' option is on) the same as other
4094 windows. When the height is less than 'helpheight', the height is
4095 set to 'helpheight'. Set to zero to disable.
4096
4097 *'helplang'* *'hlg'*
4098'helplang' 'hlg' string (default: messages language or empty)
4099 global
4100 {only available when compiled with the |+multi_lang|
4101 feature}
4102 {not in Vi}
4103 Comma separated list of languages. Vim will use the first language
4104 for which the desired help can be found. The English help will always
4105 be used as a last resort. You can add "en" to prefer English over
4106 another language, but that will only find tags that exist in that
4107 language and not in the English help.
4108 Example: >
4109 :set helplang=de,it
4110< This will first search German, then Italian and finally English help
4111 files.
4112 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4113 try to find the tag in the current language before using this option.
4114 See |help-translated|.
4115
4116 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4117'hidden' 'hid' boolean (default off)
4118 global
4119 {not in Vi}
4120 When off a buffer is unloaded when it is |abandon|ed. When on a
4121 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4122 displayed in another window, it does not become hidden, of course.
4123 The commands that move through the buffer list sometimes make a buffer
4124 hidden although the 'hidden' option is off: When the buffer is
4125 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004126 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004127 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 This option is set for one command with ":hide {command}" |:hide|.
4129 WARNING: It's easy to forget that you have changes in hidden buffers.
4130 Think twice when using ":q!" or ":qa!".
4131
4132 *'highlight'* *'hl'*
4133'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004134 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4135 d:Directory,e:ErrorMsg,i:IncSearch,
4136 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4137 N:CursorLineNr,r:Question,s:StatusLine,
4138 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004139 v:Visual,V:VisualNOS,w:WarningMsg,
4140 W:WildMenu,f:Folded,F:FoldColumn,
4141 A:DiffAdd,C:DiffChange,D:DiffDelete,
4142 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004143 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004144 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004145 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4146 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004147 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004148 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 global
4150 {not in Vi}
4151 This option can be used to set highlighting mode for various
4152 occasions. It is a comma separated list of character pairs. The
4153 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004154 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004156 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4157 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 characters from 'showbreak'
4159 |hl-Directory| d directories in CTRL-D listing and other special
4160 things in listings
4161 |hl-ErrorMsg| e error messages
4162 h (obsolete, ignored)
4163 |hl-IncSearch| i 'incsearch' highlighting
4164 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4165 |hl-MoreMsg| m |more-prompt|
4166 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004167 |hl-LineNr| n line number for ":number" and ":#" commands, and
4168 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004169 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4170 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 |hl-Question| r |hit-enter| prompt and yes/no questions
4172 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004173 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4175 |hl-VertSplit| c column used to separate vertically split windows
4176 |hl-Visual| v Visual mode
4177 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4178 Selection" Only X11 Gui's |gui-x11| and
4179 |xterm-clipboard|.
4180 |hl-WarningMsg| w warning messages
4181 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4182 |hl-Folded| f line used for closed folds
4183 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004184 |hl-DiffAdd| A added line in diff mode
4185 |hl-DiffChange| C changed line in diff mode
4186 |hl-DiffDelete| D deleted line in diff mode
4187 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004189 |hl-Conceal| - the placeholders used for concealed characters
4190 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004191 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004192 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004193 |hl-SpellRare| R rare word |spell|
4194 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004195 |hl-Pmenu| + popup menu normal line
4196 |hl-PmenuSel| = popup menu selected line
4197 |hl-PmenuSbar| x popup menu scrollbar
4198 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199
4200 The display modes are:
4201 r reverse (termcap entry "mr" and "me")
4202 i italic (termcap entry "ZH" and "ZR")
4203 b bold (termcap entry "md" and "me")
4204 s standout (termcap entry "so" and "se")
4205 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004206 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004207 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 n no highlighting
4209 - no highlighting
4210 : use a highlight group
4211 The default is used for occasions that are not included.
4212 If you want to change what the display modes do, see |dos-colors|
4213 for an example.
4214 When using the ':' display mode, this must be followed by the name of
4215 a highlight group. A highlight group can be used to define any type
4216 of highlighting, including using color. See |:highlight| on how to
4217 define one. The default uses a different group for each occasion.
4218 See |highlight-default| for the default highlight groups.
4219
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004221'history' 'hi' number (Vim default: 50, Vi default: 0,
4222 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 global
4224 {not in Vi}
4225 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004226 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004228 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 NOTE: This option is set to the Vi default value when 'compatible' is
4230 set and to the Vim default value when 'compatible' is reset.
4231
4232 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4233'hkmap' 'hk' boolean (default off)
4234 global
4235 {not in Vi}
4236 {only available when compiled with the |+rightleft|
4237 feature}
4238 When on, the keyboard is mapped for the Hebrew character set.
4239 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4240 toggle this option. See |rileft.txt|.
4241 NOTE: This option is reset when 'compatible' is set.
4242
4243 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4244'hkmapp' 'hkp' boolean (default off)
4245 global
4246 {not in Vi}
4247 {only available when compiled with the |+rightleft|
4248 feature}
4249 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4250 This is useful if you have a non-Hebrew keyboard.
4251 See |rileft.txt|.
4252 NOTE: This option is reset when 'compatible' is set.
4253
Bram Moolenaar036986f2017-03-16 17:41:02 +01004254 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4255'hlsearch' 'hls' boolean (default off)
4256 global
4257 {not in Vi}
4258 {not available when compiled without the
4259 |+extra_search| feature}
4260 When there is a previous search pattern, highlight all its matches.
4261 The type of highlighting used can be set with the 'l' occasion in the
4262 'highlight' option. This uses the "Search" highlight group by
4263 default. Note that only the matching text is highlighted, any offsets
4264 are not applied.
4265 See also: 'incsearch' and |:match|.
4266 When you get bored looking at the highlighted matches, you can turn it
4267 off with |:nohlsearch|. This does not change the option value, as
4268 soon as you use a search command, the highlighting comes back.
4269 'redrawtime' specifies the maximum time spent on finding matches.
4270 When the search pattern can match an end-of-line, Vim will try to
4271 highlight all of the matched text. However, this depends on where the
4272 search starts. This will be the first line in the window or the first
4273 line below a closed fold. A match in a previous line which is not
4274 drawn may not continue in a newly drawn line.
4275 You can specify whether the highlight status is restored on startup
4276 with the 'h' flag in 'viminfo' |viminfo-h|.
4277 NOTE: This option is reset when 'compatible' is set.
4278
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 *'icon'* *'noicon'*
4280'icon' boolean (default off, on when title can be restored)
4281 global
4282 {not in Vi}
4283 {not available when compiled without the |+title|
4284 feature}
4285 When on, the icon text of the window will be set to the value of
4286 'iconstring' (if it is not empty), or to the name of the file
4287 currently being edited. Only the last part of the name is used.
4288 Overridden by the 'iconstring' option.
4289 Only works if the terminal supports setting window icons (currently
4290 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4291 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4292 builtin termcap).
4293 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004294 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004296 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297
4298 *'iconstring'*
4299'iconstring' string (default "")
4300 global
4301 {not in Vi}
4302 {not available when compiled without the |+title|
4303 feature}
4304 When this option is not empty, it will be used for the icon text of
4305 the window. This happens only when the 'icon' option is on.
4306 Only works if the terminal supports setting window icon text
4307 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4308 Does not work for MS Windows.
4309 When Vim was compiled with HAVE_X11 defined, the original icon will be
4310 restored if possible |X11|.
4311 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004312 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 'titlestring' for example settings.
4314 {not available when compiled without the |+statusline| feature}
4315
4316 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4317'ignorecase' 'ic' boolean (default off)
4318 global
4319 Ignore case in search patterns. Also used when searching in the tags
4320 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004321 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 Can be overruled by using "\c" or "\C" in the pattern, see
4323 |/ignorecase|.
4324
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004325 *'imactivatefunc'* *'imaf'*
4326'imactivatefunc' 'imaf' string (default "")
4327 global
4328 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004329 {only available when compiled with the |+multi_byte|
4330 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004331 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004332 activate or deactivate the Input Method.
4333 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004334
4335 Example: >
4336 function ImActivateFunc(active)
4337 if a:active
4338 ... do something
4339 else
4340 ... do something
4341 endif
4342 " return value is not used
4343 endfunction
4344 set imactivatefunc=ImActivateFunc
4345<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 *'imactivatekey'* *'imak'*
4347'imactivatekey' 'imak' string (default "")
4348 global
4349 {not in Vi}
4350 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004351 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 Specifies the key that your Input Method in X-Windows uses for
4353 activation. When this is specified correctly, vim can fully control
4354 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4355 You can't use this option to change the activation key, the option
4356 tells Vim what the key is.
4357 Format:
4358 [MODIFIER_FLAG-]KEY_STRING
4359
4360 These characters can be used for MODIFIER_FLAG (case is ignored):
4361 S Shift key
4362 L Lock key
4363 C Control key
4364 1 Mod1 key
4365 2 Mod2 key
4366 3 Mod3 key
4367 4 Mod4 key
4368 5 Mod5 key
4369 Combinations are allowed, for example "S-C-space" or "SC-space" are
4370 both shift+ctrl+space.
4371 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4372
4373 Example: >
4374 :set imactivatekey=S-space
4375< "S-space" means shift+space. This is the activation key for kinput2 +
4376 canna (Japanese), and ami (Korean).
4377
4378 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4379'imcmdline' 'imc' boolean (default off)
4380 global
4381 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004382 {only available when compiled with the |+multi_byte|
4383 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 When set the Input Method is always on when starting to edit a command
4385 line, unless entering a search pattern (see 'imsearch' for that).
4386 Setting this option is useful when your input method allows entering
4387 English characters directly, e.g., when it's used to type accented
4388 characters with dead keys.
4389
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004390 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4392 global
4393 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004394 {only available when compiled with the |+multi_byte|
4395 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 When set the Input Method is never used. This is useful to disable
4397 the IM when it doesn't work properly.
4398 Currently this option is on by default for SGI/IRIX machines. This
4399 may change in later releases.
4400
4401 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004402'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403 local to buffer
4404 {not in Vi}
4405 Specifies whether :lmap or an Input Method (IM) is to be used in
4406 Insert mode. Valid values:
4407 0 :lmap is off and IM is off
4408 1 :lmap is ON and IM is off
4409 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 To always reset the option to zero when leaving Insert mode with <Esc>
4411 this can be used: >
4412 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4413< This makes :lmap and IM turn off automatically when leaving Insert
4414 mode.
4415 Note that this option changes when using CTRL-^ in Insert mode
4416 |i_CTRL-^|.
4417 The value is set to 1 when setting 'keymap' to a valid keymap name.
4418 It is also used for the argument of commands like "r" and "f".
4419 The value 0 may not work correctly with Athena and Motif with some XIM
4420 methods. Use 'imdisable' to disable XIM then.
4421
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004422 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004423 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004424 |+multi_byte_ime| or |global-ime|.
4425
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004427'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 local to buffer
4429 {not in Vi}
4430 Specifies whether :lmap or an Input Method (IM) is to be used when
4431 entering a search pattern. Valid values:
4432 -1 the value of 'iminsert' is used, makes it look like
4433 'iminsert' is also used when typing a search pattern
4434 0 :lmap is off and IM is off
4435 1 :lmap is ON and IM is off
4436 2 :lmap is off and IM is ON
4437 Note that this option changes when using CTRL-^ in Command-line mode
4438 |c_CTRL-^|.
4439 The value is set to 1 when it is not -1 and setting the 'keymap'
4440 option to a valid keymap name.
4441 The value 0 may not work correctly with Athena and Motif with some XIM
4442 methods. Use 'imdisable' to disable XIM then.
4443
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004444 *'imstatusfunc'* *'imsf'*
4445'imstatusfunc' 'imsf' string (default "")
4446 global
4447 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004448 {only available when compiled with the |+multi_byte|
4449 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004450 This option specifies a function that is called to obtain the status
4451 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004452 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004453
4454 Example: >
4455 function ImStatusFunc()
4456 let is_active = ...do something
4457 return is_active ? 1 : 0
4458 endfunction
4459 set imstatusfunc=ImStatusFunc
4460<
4461 NOTE: This function is invoked very often. Keep it fast.
4462
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004463 *'imstyle'* *'imst'*
4464'imstyle' 'imst' number (default 1)
4465 global
4466 {not in Vi}
4467 {only available when compiled with |+xim| and
4468 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004469 This option specifies the input style of Input Method:
4470 0 use on-the-spot style
4471 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004472 See: |xim-input-style|
4473
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004474 For a long time on-the-spot style had been used in the GTK version of
4475 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004476 |single-repeat|, etc. Therefore over-the-spot style becomes the
4477 default now. This should work fine for most people, however if you
4478 have any problem with it, try using on-the-spot style.
4479
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 *'include'* *'inc'*
4481'include' 'inc' string (default "^\s*#\s*include")
4482 global or local to buffer |global-local|
4483 {not in Vi}
4484 {not available when compiled without the
4485 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004486 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 pattern, just like for the "/" command (See |pattern|). The default
4488 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004489 "]I", "[d", etc.
4490 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004491 comes after the matched pattern. But if "\zs" appears in the pattern
4492 then the text matched from "\zs" to the end, or until "\ze" if it
4493 appears, is used as the file name. Use this to include characters
4494 that are not in 'isfname', such as a space. You can then use
4495 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004496 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497
4498 *'includeexpr'* *'inex'*
4499'includeexpr' 'inex' string (default "")
4500 local to buffer
4501 {not in Vi}
4502 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004503 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004505 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 :set includeexpr=substitute(v:fname,'\\.','/','g')
4507< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004508
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004510 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511 Also used for |<cfile>|.
4512
Bram Moolenaar30b65812012-07-12 22:01:11 +02004513 The expression will be evaluated in the |sandbox| when set from a
4514 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004515
4516 It is not allowed to change text or jump to another window while
4517 evaluating 'includeexpr' |textlock|.
4518
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004520'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4521 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 global
4523 {not in Vi}
4524 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004525 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004526 While typing a search command, show where the pattern, as it was typed
4527 so far, matches. The matched string is highlighted. If the pattern
4528 is invalid or not found, nothing is shown. The screen will be updated
4529 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004530 Also applies to the pattern in commands: >
4531 :global
4532 :lvimgrep
4533 :lvimgrepadd
4534 :smagic
4535 :snomagic
4536 :sort
4537 :substitute
4538 :vglobal
4539 :vimgrep
4540 :vimgrepadd
4541< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004542 original position when no match is found and when pressing <Esc>. You
4543 still need to finish the search command with <Enter> to move the
4544 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004545 You can use the CTRL-G and CTRL-T keys to move to the next and
4546 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004547 When compiled with the |+reltime| feature Vim only searches for about
4548 half a second. With a complicated pattern and/or a lot of text the
4549 match may not be found. This is to avoid that Vim hangs while you
4550 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004551 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004552 When 'hlsearch' is on, all matched strings are highlighted too while
4553 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004554 If you don't want to turn 'hlsearch' on, but want to highlight all
4555 matches while searching, you can turn on and off 'hlsearch' with
4556 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004557 augroup vimrc-incsearch-highlight
4558 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004559 autocmd CmdlineEnter /,\? :set hlsearch
4560 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004561 augroup END
4562<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004563 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004564 to the command line. If 'ignorecase' and 'smartcase' are set and the
4565 command line has no uppercase characters, the added character is
4566 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004567 CTRL-R CTRL-W can be used to add the word at the end of the current
4568 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 NOTE: This option is reset when 'compatible' is set.
4570
4571 *'indentexpr'* *'inde'*
4572'indentexpr' 'inde' string (default "")
4573 local to buffer
4574 {not in Vi}
4575 {not available when compiled without the |+cindent|
4576 or |+eval| features}
4577 Expression which is evaluated to obtain the proper indent for a line.
4578 It is used when a new line is created, for the |=| operator and
4579 in Insert mode as specified with the 'indentkeys' option.
4580 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004581 'smartindent' indenting. When 'lisp' is set, this option is
4582 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 When 'paste' is set this option is not used for indenting.
4584 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004585 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586 when the expression is evaluated (but it may be moved around).
4587 The expression must return the number of spaces worth of indent. It
4588 can return "-1" to keep the current indent (this means 'autoindent' is
4589 used for the indent).
4590 Functions useful for computing the indent are |indent()|, |cindent()|
4591 and |lispindent()|.
4592 The evaluation of the expression must not have side effects! It must
4593 not change the text, jump to another window, etc. Afterwards the
4594 cursor position is always restored, thus the cursor may be moved.
4595 Normally this option would be set to call a function: >
4596 :set indentexpr=GetMyIndent()
4597< Error messages will be suppressed, unless the 'debug' option contains
4598 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004599 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004600 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601
Bram Moolenaar30b65812012-07-12 22:01:11 +02004602 The expression will be evaluated in the |sandbox| when set from a
4603 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004604
4605 It is not allowed to change text or jump to another window while
4606 evaluating 'indentexpr' |textlock|.
4607
4608
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004610'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 local to buffer
4612 {not in Vi}
4613 {not available when compiled without the |+cindent|
4614 feature}
4615 A list of keys that, when typed in Insert mode, cause reindenting of
4616 the current line. Only happens if 'indentexpr' isn't empty.
4617 The format is identical to 'cinkeys', see |indentkeys-format|.
4618 See |C-indenting| and |indent-expression|.
4619
4620 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4621'infercase' 'inf' boolean (default off)
4622 local to buffer
4623 {not in Vi}
4624 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004625 'ignorecase' is also on, the case of the match is adjusted depending
4626 on the typed text. If the typed text contains a lowercase letter
4627 where the match has an upper case letter, the completed part is made
4628 lowercase. If the typed text has no lowercase letters and the match
4629 has a lowercase letter where the typed text has an uppercase letter,
4630 and there is a letter before it, the completed part is made uppercase.
4631 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632
4633 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4634'insertmode' 'im' boolean (default off)
4635 global
4636 {not in Vi}
4637 Makes Vim work in a way that Insert mode is the default mode. Useful
4638 if you want to use Vim as a modeless editor. Used for |evim|.
4639 These Insert mode commands will be useful:
4640 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004641 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 this is a mapping, it is executed as if 'insertmode' was off.
4643 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004645 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4646 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647
4648 These items change when 'insertmode' is set:
4649 - when starting to edit of a file, Vim goes to Insert mode.
4650 - <Esc> in Insert mode is a no-op and beeps.
4651 - <Esc> in Normal mode makes Vim go to Insert mode.
4652 - CTRL-L in Insert mode is a command, it is not inserted.
4653 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4654 However, when <Esc> is used inside a mapping, it behaves like
4655 'insertmode' was not set. This was done to be able to use the same
4656 mappings with 'insertmode' set or not set.
4657 When executing commands with |:normal| 'insertmode' is not used.
4658
4659 NOTE: This option is reset when 'compatible' is set.
4660
4661 *'isfname'* *'isf'*
4662'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4663 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4664 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4665 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4666 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4667 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4668 global
4669 {not in Vi}
4670 The characters specified by this option are included in file names and
4671 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004672 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 Multi-byte characters 256 and above are always included, only the
4674 characters up to 255 are specified with this option.
4675 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004676 Think twice before adding white space to this option. Although a
4677 space may appear inside a file name, the effect will be that Vim
4678 doesn't know where a file name starts or ends when doing completion.
4679 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680
4681 Note that on systems using a backslash as path separator, Vim tries to
4682 do its best to make it work as you would expect. That is a bit
4683 tricky, since Vi originally used the backslash to escape special
4684 characters. Vim will not remove a backslash in front of a normal file
4685 name character on these systems, but it will on Unix and alikes. The
4686 '&' and '^' are not included by default, because these are special for
4687 cmd.exe.
4688
4689 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004690 Each part can be a single character number or a range. A range is two
4691 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 decimal number between 0 and 255 or the ASCII character itself (does
4693 not work for digits). Example:
4694 "_,-,128-140,#-43" (include '_' and '-' and the range
4695 128 to 140 and '#' to 43)
4696 If a part starts with '^', the following character number or range
4697 will be excluded from the option. The option is interpreted from left
4698 to right. Put the excluded character after the range where it is
4699 included. To include '^' itself use it as the last character of the
4700 option or the end of a range. Example:
4701 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4702 If the character is '@', all characters where isalpha() returns TRUE
4703 are included. Normally these are the characters a to z and A to Z,
4704 plus accented characters. To include '@' itself use "@-@". Examples:
4705 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004706 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 "a-z,A-Z,@-@" All letters plus the '@' character.
4708 A comma can be included by using it where a character number is
4709 expected. Example:
4710 "48-57,,,_" Digits, comma and underscore.
4711 A comma can be excluded by prepending a '^'. Example:
4712 " -~,^,,9" All characters from space to '~', excluding
4713 comma, plus <Tab>.
4714 See |option-backslash| about including spaces and backslashes.
4715
4716 *'isident'* *'isi'*
4717'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4718 "@,48-57,_,128-167,224-235"
4719 otherwise: "@,48-57,_,192-255")
4720 global
4721 {not in Vi}
4722 The characters given by this option are included in identifiers.
4723 Identifiers are used in recognizing environment variables and after a
4724 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004725 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004726 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004728 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4730
4731 *'iskeyword'* *'isk'*
4732'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4733 "@,48-57,_,128-167,224-235"
4734 otherwise: "@,48-57,_,192-255"
4735 Vi default: "@,48-57,_")
4736 local to buffer
4737 {not in Vi}
4738 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004739 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004740 'isfname' for a description of the format of this option. For '@'
4741 characters above 255 check the "word" character class.
4742 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 For a help file it is set to all non-blank printable characters except
4744 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4745 command).
4746 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004747 This option also influences syntax highlighting, unless the syntax
4748 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004749 NOTE: This option is set to the Vi default value when 'compatible' is
4750 set and to the Vim default value when 'compatible' is reset.
4751
4752 *'isprint'* *'isp'*
4753'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4754 "@,~-255"; otherwise: "@,161-255")
4755 global
4756 {not in Vi}
4757 The characters given by this option are displayed directly on the
4758 screen. It is also used for "\p" in a |pattern|. The characters from
4759 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4760 even when they are not included in 'isprint' or excluded. See
4761 'isfname' for a description of the format of this option.
4762
4763 Non-printable characters are displayed with two characters:
4764 0 - 31 "^@" - "^_"
4765 32 - 126 always single characters
4766 127 "^?"
4767 128 - 159 "~@" - "~_"
4768 160 - 254 "| " - "|~"
4769 255 "~?"
4770 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4771 displayed as <xx>, with the hexadecimal value of the byte.
4772 When 'display' contains "uhex" all unprintable characters are
4773 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004774 The SpecialKey highlighting will be used for unprintable characters.
4775 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776
4777 Multi-byte characters 256 and above are always included, only the
4778 characters up to 255 are specified with this option. When a character
4779 is printable but it is not available in the current font, a
4780 replacement character will be shown.
4781 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4782 There is no option to specify these characters.
4783
4784 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4785'joinspaces' 'js' boolean (default on)
4786 global
4787 {not in Vi}
4788 Insert two spaces after a '.', '?' and '!' with a join command.
4789 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4790 Otherwise only one space is inserted.
4791 NOTE: This option is set when 'compatible' is set.
4792
4793 *'key'*
4794'key' string (default "")
4795 local to buffer
4796 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004797 {only available when compiled with the |+cryptv|
4798 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004800 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801 Careful: Do not set the key value by hand, someone might see the typed
4802 key. Use the |:X| command. But you can make 'key' empty: >
4803 :set key=
4804< It is not possible to get the value of this option with ":set key" or
4805 "echo &key". This is to avoid showing it to someone who shouldn't
4806 know. It also means you cannot see it yourself once you have set it,
4807 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004808 You can use "&key" in an expression to detect whether encryption is
4809 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810
4811 *'keymap'* *'kmp'* *E544*
4812'keymap' 'kmp' string (default "")
4813 local to buffer
4814 {not in Vi}
4815 {only available when compiled with the |+keymap|
4816 feature}
4817 Name of a keyboard mapping. See |mbyte-keymap|.
4818 Setting this option to a valid keymap name has the side effect of
4819 setting 'iminsert' to one, so that the keymap becomes effective.
4820 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004821 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822
4823 *'keymodel'* *'km'*
4824'keymodel' 'km' string (default "")
4825 global
4826 {not in Vi}
4827 List of comma separated words, which enable special things that keys
4828 can do. These values can be used:
4829 startsel Using a shifted special key starts selection (either
4830 Select mode or Visual mode, depending on "key" being
4831 present in 'selectmode').
4832 stopsel Using a not-shifted special key stops selection.
4833 Special keys in this context are the cursor keys, <End>, <Home>,
4834 <PageUp> and <PageDown>.
4835 The 'keymodel' option is set by the |:behave| command.
4836
4837 *'keywordprg'* *'kp'*
4838'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004839 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 global or local to buffer |global-local|
4841 {not in Vi}
4842 Program to use for the |K| command. Environment variables are
4843 expanded |:set_env|. ":help" may be used to access the Vim internal
4844 help. (Note that previously setting the global option to the empty
4845 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004846 When the first character is ":", the command is invoked as a Vim
4847 Ex command prefixed with [count].
4848 When "man", "man -s" or an Ex command is used, Vim will automatically
4849 translate a count for the "K" command and pass it as the first
4850 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 See |option-backslash| about including spaces and backslashes.
4852 Example: >
4853 :set keywordprg=man\ -s
4854< This option cannot be set from a |modeline| or in the |sandbox|, for
4855 security reasons.
4856
4857 *'langmap'* *'lmap'* *E357* *E358*
4858'langmap' 'lmap' string (default "")
4859 global
4860 {not in Vi}
4861 {only available when compiled with the |+langmap|
4862 feature}
4863 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004864 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004865 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 care of translating these special characters to the original meaning
4867 of the key. This means you don't have to change the keyboard mode to
4868 be able to execute Normal mode commands.
4869 This is the opposite of the 'keymap' option, where characters are
4870 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004871 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004872 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004873 This option cannot be set from a |modeline| or in the |sandbox|, for
4874 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004876 Example (for Greek, in UTF-8): *greek* >
4877 :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 +00004878< Example (exchanges meaning of z and y for commands): >
4879 :set langmap=zy,yz,ZY,YZ
4880<
4881 The 'langmap' option is a list of parts, separated with commas. Each
4882 part can be in one of two forms:
4883 1. A list of pairs. Each pair is a "from" character immediately
4884 followed by the "to" character. Examples: "aA", "aAbBcC".
4885 2. A list of "from" characters, a semi-colon and a list of "to"
4886 characters. Example: "abc;ABC"
4887 Example: "aA,fgh;FGH,cCdDeE"
4888 Special characters need to be preceded with a backslash. These are
4889 ";", ',' and backslash itself.
4890
4891 This will allow you to activate vim actions without having to switch
4892 back and forth between the languages. Your language characters will
4893 be understood as normal vim English characters (according to the
4894 langmap mappings) in the following cases:
4895 o Normal/Visual mode (commands, buffer/register names, user mappings)
4896 o Insert/Replace Mode: Register names after CTRL-R
4897 o Insert/Replace Mode: Mappings
4898 Characters entered in Command-line mode will NOT be affected by
4899 this option. Note that this option can be changed at any time
4900 allowing to switch between mappings for different languages/encodings.
4901 Use a mapping to avoid having to type it each time!
4902
4903 *'langmenu'* *'lm'*
4904'langmenu' 'lm' string (default "")
4905 global
4906 {not in Vi}
4907 {only available when compiled with the |+menu| and
4908 |+multi_lang| features}
4909 Language to use for menu translation. Tells which file is loaded
4910 from the "lang" directory in 'runtimepath': >
4911 "lang/menu_" . &langmenu . ".vim"
4912< (without the spaces). For example, to always use the Dutch menus, no
4913 matter what $LANG is set to: >
4914 :set langmenu=nl_NL.ISO_8859-1
4915< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004916 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917 If your $LANG is set to a non-English language but you do want to use
4918 the English menus: >
4919 :set langmenu=none
4920< This option must be set before loading menus, switching on filetype
4921 detection or syntax highlighting. Once the menus are defined setting
4922 this option has no effect. But you could do this: >
4923 :source $VIMRUNTIME/delmenu.vim
4924 :set langmenu=de_DE.ISO_8859-1
4925 :source $VIMRUNTIME/menu.vim
4926< Warning: This deletes all menus that you defined yourself!
4927
Bram Moolenaard94464e2015-11-02 15:28:18 +01004928 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004929'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004930 global
4931 {not in Vi}
4932 {only available when compiled with the |+langmap|
4933 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004934 This is just like 'langremap' but with the value inverted. It only
4935 exists for backwards compatibility. When setting 'langremap' then
4936 'langnoremap' is set to the inverted value, and the other way around.
4937
4938 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4939'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4940 global
4941 {not in Vi}
4942 {only available when compiled with the |+langmap|
4943 feature}
4944 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004945 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004946 'langmap' disables some of your mappings, try resetting this option.
4947 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004948 that works for you to avoid mappings to break.
4949
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 *'laststatus'* *'ls'*
4951'laststatus' 'ls' number (default 1)
4952 global
4953 {not in Vi}
4954 The value of this option influences when the last window will have a
4955 status line:
4956 0: never
4957 1: only if there are at least two windows
4958 2: always
4959 The screen looks nicer with a status line if you have several
4960 windows, but it takes another screen line. |status-line|
4961
4962 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4963'lazyredraw' 'lz' boolean (default off)
4964 global
4965 {not in Vi}
4966 When this option is set, the screen will not be redrawn while
4967 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004968 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969 update use |:redraw|.
4970
4971 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4972'linebreak' 'lbr' boolean (default off)
4973 local to window
4974 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004975 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004977 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 than at the last character that fits on the screen. Unlike
4979 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004980 it only affects the way the file is displayed, not its contents.
4981 If 'breakindent' is set, line is visually indented. Then, the value
4982 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004983 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 Note that <Tab> characters after an <EOL> are mostly not displayed
4985 with the right amount of white space.
4986
4987 *'lines'* *E593*
4988'lines' number (default 24 or terminal height)
4989 global
4990 Number of lines of the Vim window.
4991 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004992 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 When Vim is running in the GUI or in a resizable window, setting this
4994 option will cause the window size to be changed. When you only want
4995 to use the size for the GUI, put the command in your |gvimrc| file.
4996 Vim limits the number of lines to what fits on the screen. You can
4997 use this command to get the tallest window possible: >
4998 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004999< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005000 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 When you set this option and Vim is unable to change the physical
5002 number of lines of the display, the display may be messed up.
5003
5004 *'linespace'* *'lsp'*
5005'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5006 global
5007 {not in Vi}
5008 {only in the GUI}
5009 Number of pixel lines inserted between characters. Useful if the font
5010 uses the full character cell height, making lines touch each other.
5011 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005012 With some fonts there can be too much room between lines (to have
5013 space for ascents and descents). Then it makes sense to set
5014 'linespace' to a negative value. This may cause display problems
5015 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016
5017 *'lisp'* *'nolisp'*
5018'lisp' boolean (default off)
5019 local to buffer
5020 {not available when compiled without the |+lispindent|
5021 feature}
5022 Lisp mode: When <Enter> is typed in insert mode set the indent for
5023 the next line to Lisp standards (well, sort of). Also happens with
5024 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5025 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5026 better. Also see 'lispwords'.
5027 The '-' character is included in keyword characters. Redefines the
5028 "=" operator to use this same indentation algorithm rather than
5029 calling an external program if 'equalprg' is empty.
5030 This option is not used when 'paste' is set.
5031 {Vi: Does it a little bit differently}
5032
5033 *'lispwords'* *'lw'*
5034'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005035 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 {not in Vi}
5037 {not available when compiled without the |+lispindent|
5038 feature}
5039 Comma separated list of words that influence the Lisp indenting.
5040 |'lisp'|
5041
5042 *'list'* *'nolist'*
5043'list' boolean (default off)
5044 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005045 List mode: Show tabs as CTRL-I is displayed, display $ after end of
5046 line. Useful to see the difference between tabs and spaces and for
5047 trailing blanks. Further changed by the 'listchars' option.
5048
5049 The cursor is displayed at the start of the space a Tab character
5050 occupies, not at the end as usual in Normal mode. To get this cursor
5051 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005052 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005053<
5054 Note that list mode will also affect formatting (set with 'textwidth'
5055 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 changing the way tabs are displayed.
5057
5058 *'listchars'* *'lcs'*
5059'listchars' 'lcs' string (default "eol:$")
5060 global
5061 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005062 Strings to use in 'list' mode and for the |:list| command. It is a
5063 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005064 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 eol:c Character to show at the end of each line. When
5066 omitted, there is no extra character at the end of the
5067 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005068 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005069 tab:xy[z] Two or three characters to be used to show a tab.
5070 The third character is optional.
5071
5072 tab:xy The 'x' is always used, then 'y' as many times as will
5073 fit. Thus "tab:>-" displays:
5074 >
5075 >-
5076 >--
5077 etc.
5078
5079 tab:xyz The 'z' is always used, then 'x' is prepended, and
5080 then 'y' is used as many times as will fit. Thus
5081 "tab:<->" displays:
5082 >
5083 <>
5084 <->
5085 <-->
5086 etc.
5087
5088 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005089 *lcs-space*
5090 space:c Character to show for a space. When omitted, spaces
5091 are left blank.
5092 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005093 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02005094 trailing spaces are blank. Overrides the "space"
5095 setting for trailing spaces.
5096 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 extends:c Character to show in the last column, when 'wrap' is
5098 off and the line continues beyond the right of the
5099 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005100 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 precedes:c Character to show in the first column, when 'wrap'
5102 is off and there is text preceding the character
5103 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005104 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005105 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005106 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005107 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005108 nbsp:c Character to show for a non-breakable space character
5109 (0xA0 (160 decimal) and U+202F). Left blank when
5110 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005112 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005114 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115
5116 Examples: >
5117 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005118 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 :set lcs=extends:>,precedes:<
5120< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02005121 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005122 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123
5124 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5125'loadplugins' 'lpl' boolean (default on)
5126 global
5127 {not in Vi}
5128 When on the plugin scripts are loaded when starting up |load-plugins|.
5129 This option can be reset in your |vimrc| file to disable the loading
5130 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005131 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5132 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133
Bram Moolenaard94464e2015-11-02 15:28:18 +01005134 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005135'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005136 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005137 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005138 {only available when compiled with the |+lua/dyn|
5139 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005140 Specifies the name of the Lua shared library. The default is
5141 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005142 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005143 This option cannot be set from a |modeline| or in the |sandbox|, for
5144 security reasons.
5145
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005146 *'macatsui'* *'nomacatsui'*
5147'macatsui' boolean (default on)
5148 global
5149 {only available in Mac GUI version}
5150 This is a workaround for when drawing doesn't work properly. When set
5151 and compiled with multi-byte support ATSUI text drawing is used. When
5152 not set ATSUI text drawing is not used. Switch this option off when
5153 you experience drawing problems. In a future version the problems may
5154 be solved and this option becomes obsolete. Therefore use this method
5155 to unset it: >
5156 if exists('&macatsui')
5157 set nomacatsui
5158 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00005159< Another option to check if you have drawing problems is
5160 'termencoding'.
5161
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 *'magic'* *'nomagic'*
5163'magic' boolean (default on)
5164 global
5165 Changes the special characters that can be used in search patterns.
5166 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005167 WARNING: Switching this option off most likely breaks plugins! That
5168 is because many patterns assume it's on and will fail when it's off.
5169 Only switch it off when working with old Vi scripts. In any other
5170 situation write patterns that work when 'magic' is on. Include "\M"
5171 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172
5173 *'makeef'* *'mef'*
5174'makeef' 'mef' string (default: "")
5175 global
5176 {not in Vi}
5177 {not available when compiled without the |+quickfix|
5178 feature}
5179 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5180 and the |:grep| command.
5181 When it is empty, an internally generated temp file will be used.
5182 When "##" is included, it is replaced by a number to make the name
5183 unique. This makes sure that the ":make" command doesn't overwrite an
5184 existing file.
5185 NOT used for the ":cf" command. See 'errorfile' for that.
5186 Environment variables are expanded |:set_env|.
5187 See |option-backslash| about including spaces and backslashes.
5188 This option cannot be set from a |modeline| or in the |sandbox|, for
5189 security reasons.
5190
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005191 *'makeencoding'* *'menc'*
5192'makeencoding' 'menc' string (default "")
5193 global or local to buffer |global-local|
5194 {only available when compiled with the |+multi_byte|
5195 feature}
5196 {not in Vi}
5197 Encoding used for reading the output of external commands. When empty,
5198 encoding is not converted.
5199 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5200 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5201 and `:laddfile`.
5202
5203 This would be mostly useful when you use MS-Windows and set 'encoding'
5204 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5205 'makeencoding' to "char" has the same effect as setting to the system
5206 locale encoding. Example: >
5207 :set encoding=utf-8
5208 :set makeencoding=char " system locale is used
5209<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210 *'makeprg'* *'mp'*
5211'makeprg' 'mp' string (default "make", VMS: "MMS")
5212 global or local to buffer |global-local|
5213 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005214 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005215 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5216 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005217 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005218 Environment variables are expanded |:set_env|. See |option-backslash|
5219 about including spaces and backslashes.
5220 Note that a '|' must be escaped twice: once for ":set" and once for
5221 the interpretation of a command. When you use a filter called
5222 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 :set makeprg=gmake\ \\\|\ myfilter
5224< The placeholder "$*" can be given (even multiple times) to specify
5225 where the arguments will be included, for example: >
5226 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5227< This option cannot be set from a |modeline| or in the |sandbox|, for
5228 security reasons.
5229
5230 *'matchpairs'* *'mps'*
5231'matchpairs' 'mps' string (default "(:),{:},[:]")
5232 local to buffer
5233 {not in Vi}
5234 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005235 other.
5236 Only character pairs are allowed that are different, thus you cannot
5237 jump between two double quotes.
5238 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005239 The pairs must be separated by a comma. Example for including '<' and
5240 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241 :set mps+=<:>
5242
5243< A more exotic example, to jump between the '=' and ';' in an
5244 assignment, useful for languages like C and Java: >
5245 :au FileType c,cpp,java set mps+==:;
5246
5247< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005248 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005249
5250 *'matchtime'* *'mat'*
5251'matchtime' 'mat' number (default 5)
5252 global
5253 {not in Vi}{in Nvi}
5254 Tenths of a second to show the matching paren, when 'showmatch' is
5255 set. Note that this is not in milliseconds, like other options that
5256 set a time. This is to be compatible with Nvi.
5257
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005258 *'maxcombine'* *'mco'*
5259'maxcombine' 'mco' number (default 2)
5260 global
5261 {not in Vi}
5262 {only available when compiled with the |+multi_byte|
5263 feature}
5264 The maximum number of combining characters supported for displaying.
5265 Only used when 'encoding' is "utf-8".
5266 The default is OK for most languages. Hebrew may require 4.
5267 Maximum value is 6.
5268 Even when this option is set to 2 you can still edit text with more
5269 combining characters, you just can't see them. Use |g8| or |ga|.
5270 See |mbyte-combining|.
5271
Bram Moolenaar071d4272004-06-13 20:20:40 +00005272 *'maxfuncdepth'* *'mfd'*
5273'maxfuncdepth' 'mfd' number (default 100)
5274 global
5275 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005276 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005277 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005278 Maximum depth of function calls for user functions. This normally
5279 catches endless recursion. When using a recursive function with
5280 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5281 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005282 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005283 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284 See also |:function|.
5285
5286 *'maxmapdepth'* *'mmd'* *E223*
5287'maxmapdepth' 'mmd' number (default 1000)
5288 global
5289 {not in Vi}
5290 Maximum number of times a mapping is done without resulting in a
5291 character to be used. This normally catches endless mappings, like
5292 ":map x y" with ":map y x". It still does not catch ":map g wg",
5293 because the 'w' is used before the next mapping is done. See also
5294 |key-mapping|.
5295
5296 *'maxmem'* *'mm'*
5297'maxmem' 'mm' number (default between 256 to 5120 (system
5298 dependent) or half the amount of memory
5299 available)
5300 global
5301 {not in Vi}
5302 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5303 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005304 other memory to be freed.
5305 The maximum usable value is about 2000000. Use this to work without a
5306 limit.
5307 The value is ignored when 'swapfile' is off.
5308 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005310 *'maxmempattern'* *'mmp'*
5311'maxmempattern' 'mmp' number (default 1000)
5312 global
5313 {not in Vi}
5314 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005315 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005316 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005317 When Vim runs into the limit it gives an error message and mostly
5318 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005319 Running into the limit often means that the pattern is very
5320 inefficient or too complex. This may already happen with the pattern
5321 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005322 Might also happen on redraw, when syntax rules try to match a complex
5323 text structure.
5324 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5325 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005326
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327 *'maxmemtot'* *'mmt'*
5328'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5329 dependent) or half the amount of memory
5330 available)
5331 global
5332 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005333 Maximum amount of memory in Kbyte to use for all buffers together.
5334 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005335 without a limit.
5336 On 64 bit machines higher values might work. But hey, do you really
5337 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005338 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005339 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005340 Buffers with 'swapfile' off still count to the total amount of memory
5341 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005342 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343
5344 *'menuitems'* *'mis'*
5345'menuitems' 'mis' number (default 25)
5346 global
5347 {not in Vi}
5348 {not available when compiled without the |+menu|
5349 feature}
5350 Maximum number of items to use in a menu. Used for menus that are
5351 generated from a list of items, e.g., the Buffers menu. Changing this
5352 option has no direct effect, the menu must be refreshed first.
5353
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005354 *'mkspellmem'* *'msm'*
5355'mkspellmem' 'msm' string (default "460000,2000,500")
5356 global
5357 {not in Vi}
5358 {not available when compiled without the |+syntax|
5359 feature}
5360 Parameters for |:mkspell|. This tunes when to start compressing the
5361 word tree. Compression can be slow when there are many words, but
5362 it's needed to avoid running out of memory. The amount of memory used
5363 per word depends very much on how similar the words are, that's why
5364 this tuning is complicated.
5365
5366 There are three numbers, separated by commas:
5367 {start},{inc},{added}
5368
5369 For most languages the uncompressed word tree fits in memory. {start}
5370 gives the amount of memory in Kbyte that can be used before any
5371 compression is done. It should be a bit smaller than the amount of
5372 memory that is available to Vim.
5373
5374 When going over the {start} limit the {inc} number specifies the
5375 amount of memory in Kbyte that can be allocated before another
5376 compression is done. A low number means compression is done after
5377 less words are added, which is slow. A high number means more memory
5378 will be allocated.
5379
5380 After doing compression, {added} times 1024 words can be added before
5381 the {inc} limit is ignored and compression is done when any extra
5382 amount of memory is needed. A low number means there is a smaller
5383 chance of hitting the {inc} limit, less memory is used but it's
5384 slower.
5385
5386 The languages for which these numbers are important are Italian and
5387 Hungarian. The default works for when you have about 512 Mbyte. If
5388 you have 1 Gbyte you could use: >
5389 :set mkspellmem=900000,3000,800
5390< If you have less than 512 Mbyte |:mkspell| may fail for some
5391 languages, no matter what you set 'mkspellmem' to.
5392
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005394'modeline' 'ml' boolean (Vim default: on (off for root),
5395 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396 local to buffer
5397 *'modelines'* *'mls'*
5398'modelines' 'mls' number (default 5)
5399 global
5400 {not in Vi}
5401 If 'modeline' is on 'modelines' gives the number of lines that is
5402 checked for set commands. If 'modeline' is off or 'modelines' is zero
5403 no lines are checked. See |modeline|.
5404 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5405 set and to the Vim default value when 'compatible' is reset.
5406
5407 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5408'modifiable' 'ma' boolean (default on)
5409 local to buffer
5410 {not in Vi} *E21*
5411 When off the buffer contents cannot be changed. The 'fileformat' and
5412 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005413 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414
5415 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5416'modified' 'mod' boolean (default off)
5417 local to buffer
5418 {not in Vi}
5419 When on, the buffer is considered to be modified. This option is set
5420 when:
5421 1. A change was made to the text since it was last written. Using the
5422 |undo| command to go back to the original text will reset the
5423 option. But undoing changes that were made before writing the
5424 buffer will set the option again, since the text is different from
5425 when it was written.
5426 2. 'fileformat' or 'fileencoding' is different from its original
5427 value. The original value is set when the buffer is read or
5428 written. A ":set nomodified" command also resets the original
5429 values to the current values and the 'modified' option will be
5430 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005431 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005432 This option is not set when a change is made to the buffer as the
5433 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5434 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5435 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5437 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005438 Note that the text may actually be the same, e.g. 'modified' is set
5439 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440
5441 *'more'* *'nomore'*
5442'more' boolean (Vim default: on, Vi default: off)
5443 global
5444 {not in Vi}
5445 When on, listings pause when the whole screen is filled. You will get
5446 the |more-prompt|. When this option is off there are no pauses, the
5447 listing continues until finished.
5448 NOTE: This option is set to the Vi default value when 'compatible' is
5449 set and to the Vim default value when 'compatible' is reset.
5450
5451 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005452'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5453 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 global
5455 {not in Vi}
5456 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005457 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5458 sysmouse and Linux console with gpm). For using the mouse in the
5459 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005461 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462 v Visual mode
5463 i Insert mode
5464 c Command-line mode
5465 h all previous modes when editing a help file
5466 a all previous modes
5467 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005468 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 :set mouse=a
5470< When the mouse is not enabled, the GUI will still use the mouse for
5471 modeless selection. This doesn't move the text cursor.
5472
5473 See |mouse-using|. Also see |'clipboard'|.
5474
5475 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005476 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477 the mouse buttons can still be used by keeping the shift key pressed.
5478 Also see the 'clipboard' option.
5479
5480 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5481'mousefocus' 'mousef' boolean (default off)
5482 global
5483 {not in Vi}
5484 {only works in the GUI}
5485 The window that the mouse pointer is on is automatically activated.
5486 When changing the window layout or window focus in another way, the
5487 mouse pointer is moved to the window with keyboard focus. Off is the
5488 default because it makes using the pull down menus a little goofy, as
5489 a pointer transit may activate a window unintentionally.
5490
5491 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5492'mousehide' 'mh' boolean (default on)
5493 global
5494 {not in Vi}
5495 {only works in the GUI}
5496 When on, the mouse pointer is hidden when characters are typed.
5497 The mouse pointer is restored when the mouse is moved.
5498
5499 *'mousemodel'* *'mousem'*
5500'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5501 global
5502 {not in Vi}
5503 Sets the model to use for the mouse. The name mostly specifies what
5504 the right mouse button is used for:
5505 extend Right mouse button extends a selection. This works
5506 like in an xterm.
5507 popup Right mouse button pops up a menu. The shifted left
5508 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005509 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 popup_setpos Like "popup", but the cursor will be moved to the
5511 position where the mouse was clicked, and thus the
5512 selected operation will act upon the clicked object.
5513 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005514 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 course, that right clicking outside a selection will
5516 end Visual mode.
5517 Overview of what button does what for each model:
5518 mouse extend popup(_setpos) ~
5519 left click place cursor place cursor
5520 left drag start selection start selection
5521 shift-left search word extend selection
5522 right click extend selection popup menu (place cursor)
5523 right drag extend selection -
5524 middle click paste paste
5525
5526 In the "popup" model the right mouse button produces a pop-up menu.
5527 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005528 In a terminal the popup menu works if Vim is compiled with the
5529 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530
5531 Note that you can further refine the meaning of buttons with mappings.
5532 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5533 selection (because that's handled in the GUI code directly).
5534
5535 The 'mousemodel' option is set by the |:behave| command.
5536
5537 *'mouseshape'* *'mouses'* *E547*
5538'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005539 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 global
5541 {not in Vi}
5542 {only available when compiled with the |+mouseshape|
5543 feature}
5544 This option tells Vim what the mouse pointer should look like in
5545 different modes. The option is a comma separated list of parts, much
5546 like used for 'guicursor'. Each part consist of a mode/location-list
5547 and an argument-list:
5548 mode-list:shape,mode-list:shape,..
5549 The mode-list is a dash separated list of these modes/locations:
5550 In a normal window: ~
5551 n Normal mode
5552 v Visual mode
5553 ve Visual mode with 'selection' "exclusive" (same as 'v',
5554 if not specified)
5555 o Operator-pending mode
5556 i Insert mode
5557 r Replace mode
5558
5559 Others: ~
5560 c appending to the command-line
5561 ci inserting in the command-line
5562 cr replacing in the command-line
5563 m at the 'Hit ENTER' or 'More' prompts
5564 ml idem, but cursor in the last line
5565 e any mode, pointer below last window
5566 s any mode, pointer on a status line
5567 sd any mode, while dragging a status line
5568 vs any mode, pointer on a vertical separator line
5569 vd any mode, while dragging a vertical separator line
5570 a everywhere
5571
5572 The shape is one of the following:
5573 avail name looks like ~
5574 w x arrow Normal mouse pointer
5575 w x blank no pointer at all (use with care!)
5576 w x beam I-beam
5577 w x updown up-down sizing arrows
5578 w x leftright left-right sizing arrows
5579 w x busy The system's usual busy pointer
5580 w x no The system's usual 'no input' pointer
5581 x udsizing indicates up-down resizing
5582 x lrsizing indicates left-right resizing
5583 x crosshair like a big thin +
5584 x hand1 black hand
5585 x hand2 white hand
5586 x pencil what you write with
5587 x question big ?
5588 x rightup-arrow arrow pointing right-up
5589 w x up-arrow arrow pointing up
5590 x <number> any X11 pointer number (see X11/cursorfont.h)
5591
5592 The "avail" column contains a 'w' if the shape is available for Win32,
5593 x for X11.
5594 Any modes not specified or shapes not available use the normal mouse
5595 pointer.
5596
5597 Example: >
5598 :set mouseshape=s:udsizing,m:no
5599< will make the mouse turn to a sizing arrow over the status lines and
5600 indicate no input when the hit-enter prompt is displayed (since
5601 clicking the mouse has no effect in this state.)
5602
5603 *'mousetime'* *'mouset'*
5604'mousetime' 'mouset' number (default 500)
5605 global
5606 {not in Vi}
5607 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5608 time in msec between two mouse clicks for the second click to be
5609 recognized as a multi click.
5610
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005611 *'mzschemedll'*
5612'mzschemedll' string (default depends on the build)
5613 global
5614 {not in Vi}
5615 {only available when compiled with the |+mzscheme/dyn|
5616 feature}
5617 Specifies the name of the MzScheme shared library. The default is
5618 DYNAMIC_MZSCH_DLL which was specified at compile time.
5619 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005620 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005621 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005622 This option cannot be set from a |modeline| or in the |sandbox|, for
5623 security reasons.
5624
5625 *'mzschemegcdll'*
5626'mzschemegcdll' string (default depends on the build)
5627 global
5628 {not in Vi}
5629 {only available when compiled with the |+mzscheme/dyn|
5630 feature}
5631 Specifies the name of the MzScheme GC shared library. The default is
5632 DYNAMIC_MZGC_DLL which was specified at compile time.
5633 The value can be equal to 'mzschemedll' if it includes the GC code.
5634 Environment variables are expanded |:set_env|.
5635 This option cannot be set from a |modeline| or in the |sandbox|, for
5636 security reasons.
5637
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005638 *'mzquantum'* *'mzq'*
5639'mzquantum' 'mzq' number (default 100)
5640 global
5641 {not in Vi}
5642 {not available when compiled without the |+mzscheme|
5643 feature}
5644 The number of milliseconds between polls for MzScheme threads.
5645 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005646 NOTE: This option is set to the Vim default value when 'compatible'
5647 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005648
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005650'nrformats' 'nf' string (default "bin,octal,hex",
5651 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005652 local to buffer
5653 {not in Vi}
5654 This defines what bases Vim will consider for numbers when using the
5655 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5656 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005657 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005659 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005660 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005662 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663 considered to be hexadecimal. Example: Using CTRL-X on
5664 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005665 bin If included, numbers starting with "0b" or "0B" will be
5666 considered to be binary. Example: Using CTRL-X on
5667 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668 Numbers which simply begin with a digit in the range 1-9 are always
5669 considered decimal. This also happens for numbers that are not
5670 recognized as octal or hex.
5671
5672 *'number'* *'nu'* *'nonumber'* *'nonu'*
5673'number' 'nu' boolean (default off)
5674 local to window
5675 Print the line number in front of each line. When the 'n' option is
5676 excluded from 'cpoptions' a wrapped line will not use the column of
5677 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005678 The 'numberwidth' option can be used to set the room used for the line
5679 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680 When a long, wrapped line doesn't start with the first character, '-'
5681 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005682 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5683 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005684 *number_relativenumber*
5685 The 'relativenumber' option changes the displayed number to be
5686 relative to the cursor. Together with 'number' there are these
5687 four combinations (cursor in line 3):
5688
Bram Moolenaar3848e002016-03-19 18:42:29 +01005689 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005690 'nornu' 'nornu' 'rnu' 'rnu'
5691
5692 |apple | 1 apple | 2 apple | 2 apple
5693 |pear | 2 pear | 1 pear | 1 pear
5694 |nobody | 3 nobody | 0 nobody |3 nobody
5695 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005697 *'numberwidth'* *'nuw'*
5698'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5699 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005700 {not in Vi}
5701 {only available when compiled with the |+linebreak|
5702 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005703 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005704 when the 'number' or 'relativenumber' option is set or printing lines
5705 with a line number. Since one space is always between the number and
5706 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005707 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005708 fit the highest line number in the buffer respectively the number of
5709 rows in the window, depending on whether 'number' or 'relativenumber'
5710 is set. Thus with the Vim default of 4 there is room for a line number
5711 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005712 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005713 NOTE: This option is set to the Vi default value when 'compatible' is
5714 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005715
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005716 *'omnifunc'* *'ofu'*
5717'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005718 local to buffer
5719 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005720 {not available when compiled without the |+eval|
5721 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005722 This option specifies a function to be used for Insert mode omni
5723 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005724 See |complete-functions| for an explanation of how the function is
5725 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005726 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005727 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005728 This option cannot be set from a |modeline| or in the |sandbox|, for
5729 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005730
5731
Bram Moolenaar02467872007-05-06 13:22:01 +00005732 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005733'opendevice' 'odev' boolean (default off)
5734 global
5735 {not in Vi}
5736 {only for MS-DOS, MS-Windows and OS/2}
5737 Enable reading and writing from devices. This may get Vim stuck on a
5738 device that can be opened but doesn't actually do the I/O. Therefore
5739 it is off by default.
5740 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5741 result in editing a device.
5742
5743
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005744 *'operatorfunc'* *'opfunc'*
5745'operatorfunc' 'opfunc' string (default: empty)
5746 global
5747 {not in Vi}
5748 This option specifies a function to be called by the |g@| operator.
5749 See |:map-operator| for more info and an example.
5750
5751 This option cannot be set from a |modeline| or in the |sandbox|, for
5752 security reasons.
5753
5754
Bram Moolenaar251e1912011-06-19 05:09:16 +02005755 *'osfiletype'* *'oft'*
5756'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757 local to buffer
5758 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005759 This option was supported on RISC OS, which has been removed.
5760
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005762 *'packpath'* *'pp'*
5763'packpath' 'pp' string (default: see 'runtimepath')
5764 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005765 Directories used to find packages. See |packages|.
5766
5767
Bram Moolenaar071d4272004-06-13 20:20:40 +00005768 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005769'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770 global
5771 Specifies the nroff macros that separate paragraphs. These are pairs
5772 of two letters (see |object-motions|).
5773
5774 *'paste'* *'nopaste'*
5775'paste' boolean (default off)
5776 global
5777 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005778 Put Vim in Paste mode. This is useful if you want to cut or copy
5779 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780 unexpected effects.
5781 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005782 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 knows about pasting and will mostly do the right thing without 'paste'
5784 being set. The same is true for a terminal where Vim handles the
5785 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005786 This option is reset when starting the GUI. Thus if you set it in
5787 your .vimrc it will work in a terminal, but not in the GUI. Setting
5788 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5789 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790 When the 'paste' option is switched on (also when it was already on):
5791 - mapping in Insert mode and Command-line mode is disabled
5792 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005794 - 'expandtab' is reset
5795 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005796 - 'revins' is reset
5797 - 'ruler' is reset
5798 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005799 - 'smartindent' is reset
5800 - 'smarttab' is reset
5801 - 'softtabstop' is set to 0
5802 - 'textwidth' is set to 0
5803 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005804 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005806 - 'indentexpr'
5807 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005808 NOTE: When you start editing another file while the 'paste' option is
5809 on, settings from the modelines or autocommands may change the
5810 settings again, causing trouble when pasting text. You might want to
5811 set the 'paste' option again.
5812 When the 'paste' option is reset the mentioned options are restored to
5813 the value before the moment 'paste' was switched from off to on.
5814 Resetting 'paste' before ever setting it does not have any effect.
5815 Since mapping doesn't work while 'paste' is active, you need to use
5816 the 'pastetoggle' option to toggle the 'paste' option with some key.
5817
5818 *'pastetoggle'* *'pt'*
5819'pastetoggle' 'pt' string (default "")
5820 global
5821 {not in Vi}
5822 When non-empty, specifies the key sequence that toggles the 'paste'
5823 option. This is like specifying a mapping: >
5824 :map {keys} :set invpaste<CR>
5825< Where {keys} is the value of 'pastetoggle'.
5826 The difference is that it will work even when 'paste' is set.
5827 'pastetoggle' works in Insert mode and Normal mode, but not in
5828 Command-line mode.
5829 Mappings are checked first, thus overrule 'pastetoggle'. However,
5830 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5831 this: >
5832 :map <F10> :set paste<CR>
5833 :map <F11> :set nopaste<CR>
5834 :imap <F10> <C-O>:set paste<CR>
5835 :imap <F11> <nop>
5836 :set pastetoggle=<F11>
5837< This will make <F10> start paste mode and <F11> stop paste mode.
5838 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5839 mode everything is inserted literally, except the 'pastetoggle' key
5840 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005841 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005842
5843 *'pex'* *'patchexpr'*
5844'patchexpr' 'pex' string (default "")
5845 global
5846 {not in Vi}
5847 {not available when compiled without the |+diff|
5848 feature}
5849 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005850 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851
Bram Moolenaardbc28022014-07-26 13:40:44 +02005852 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853'patchmode' 'pm' string (default "")
5854 global
5855 {not in Vi}
5856 When non-empty the oldest version of a file is kept. This can be used
5857 to keep the original version of a file if you are changing files in a
5858 source distribution. Only the first time that a file is written a
5859 copy of the original file will be kept. The name of the copy is the
5860 name of the original file with the string in the 'patchmode' option
5861 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005862 ".orig" or ".org". 'backupdir' must not be empty for this to work
5863 (Detail: The backup file is renamed to the patchmode file after the
5864 new file has been successfully written, that's why it must be possible
5865 to write a backup file). If there was no file to be backed up, an
5866 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005867 When the 'backupskip' pattern matches, a patchmode file is not made.
5868 Using 'patchmode' for compressed files appends the extension at the
5869 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5870 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005871 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005872
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005873 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874'path' 'pa' string (default on Unix: ".,/usr/include,,"
5875 on OS/2: ".,/emx/include,,"
5876 other systems: ".,,")
5877 global or local to buffer |global-local|
5878 {not in Vi}
5879 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005880 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5881 provided that the file being searched for has a relative path (not
5882 starting with "/", "./" or "../"). The directories in the 'path'
5883 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884 - Use commas to separate directory names: >
5885 :set path=.,/usr/local/include,/usr/include
5886< - Spaces can also be used to separate directory names (for backwards
5887 compatibility with version 3.0). To have a space in a directory
5888 name, precede it with an extra backslash, and escape the space: >
5889 :set path=.,/dir/with\\\ space
5890< - To include a comma in a directory name precede it with an extra
5891 backslash: >
5892 :set path=.,/dir/with\\,comma
5893< - To search relative to the directory of the current file, use: >
5894 :set path=.
5895< - To search in the current directory use an empty string between two
5896 commas: >
5897 :set path=,,
5898< - A directory name may end in a ':' or '/'.
5899 - Environment variables are expanded |:set_env|.
5900 - When using |netrw.vim| URLs can be used. For example, adding
5901 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005902 - Search upwards and downwards in a directory tree using "*", "**" and
5903 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 {not available when compiled without the |+path_extra| feature}
5905 - Careful with '\' characters, type two to get one in the option: >
5906 :set path=.,c:\\include
5907< Or just use '/' instead: >
5908 :set path=.,c:/include
5909< Don't forget "." or files won't even be found in the same directory as
5910 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005911 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912 it is something like 256 or 1024 characters.
5913 You can check if all the include files are found, using the value of
5914 'path', see |:checkpath|.
5915 The use of |:set+=| and |:set-=| is preferred when adding or removing
5916 directories from the list. This avoids problems when a future version
5917 uses another default. To remove the current directory use: >
5918 :set path-=
5919< To add the current directory use: >
5920 :set path+=
5921< To use an environment variable, you probably need to replace the
5922 separator. Here is an example to append $INCL, in which directory
5923 names are separated with a semi-colon: >
5924 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5925< Replace the ';' with a ':' or whatever separator is used. Note that
5926 this doesn't work when $INCL contains a comma or white space.
5927
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005928 *'perldll'*
5929'perldll' string (default depends on the build)
5930 global
5931 {not in Vi}
5932 {only available when compiled with the |+perl/dyn|
5933 feature}
5934 Specifies the name of the Perl shared library. The default is
5935 DYNAMIC_PERL_DLL, which was specified at compile time.
5936 Environment variables are expanded |:set_env|.
5937 This option cannot be set from a |modeline| or in the |sandbox|, for
5938 security reasons.
5939
Bram Moolenaar071d4272004-06-13 20:20:40 +00005940 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5941'preserveindent' 'pi' boolean (default off)
5942 local to buffer
5943 {not in Vi}
5944 When changing the indent of the current line, preserve as much of the
5945 indent structure as possible. Normally the indent is replaced by a
5946 series of tabs followed by spaces as required (unless |'expandtab'| is
5947 enabled, in which case only spaces are used). Enabling this option
5948 means the indent will preserve as many existing characters as possible
5949 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005950 'expandtab' does not apply to the preserved white space, a Tab remains
5951 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005952 NOTE: When using ">>" multiple times the resulting indent is a mix of
5953 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005954 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005955 Also see 'copyindent'.
5956 Use |:retab| to clean up white space.
5957
5958 *'previewheight'* *'pvh'*
5959'previewheight' 'pvh' number (default 12)
5960 global
5961 {not in Vi}
5962 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005963 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005964 Default height for a preview window. Used for |:ptag| and associated
5965 commands. Used for |CTRL-W_}| when no count is given.
5966
5967 *'previewwindow'* *'nopreviewwindow'*
5968 *'pvw'* *'nopvw'* *E590*
5969'previewwindow' 'pvw' boolean (default off)
5970 local to window
5971 {not in Vi}
5972 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005973 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005974 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005975 set. It's normally not set directly, but by using one of the commands
5976 |:ptag|, |:pedit|, etc.
5977
5978 *'printdevice'* *'pdev'*
5979'printdevice' 'pdev' string (default empty)
5980 global
5981 {not in Vi}
5982 {only available when compiled with the |+printer|
5983 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005984 The name of the printer to be used for |:hardcopy|.
5985 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005986 This option cannot be set from a |modeline| or in the |sandbox|, for
5987 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988
Bram Moolenaar8299df92004-07-10 09:47:34 +00005989 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005990'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005991 global
5992 {not in Vi}
5993 {only available when compiled with the |+printer|
5994 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005995 Sets the character encoding used when printing.
5996 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005997
5998 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005999'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006000 global
6001 {not in Vi}
6002 {only available when compiled with the |+printer|
6003 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006004 Expression used to print the PostScript produced with |:hardcopy|.
6005 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006006 This option cannot be set from a |modeline| or in the |sandbox|, for
6007 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008
Bram Moolenaar8299df92004-07-10 09:47:34 +00006009 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010'printfont' 'pfn' string (default "courier")
6011 global
6012 {not in Vi}
6013 {only available when compiled with the |+printer|
6014 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006015 The name of the font that will be used for |:hardcopy|.
6016 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017
6018 *'printheader'* *'pheader'*
6019'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6020 global
6021 {not in Vi}
6022 {only available when compiled with the |+printer|
6023 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006024 The format of the header produced in |:hardcopy| output.
6025 See |pheader-option|.
6026
6027 *'printmbcharset'* *'pmbcs'*
6028'printmbcharset' 'pmbcs' string (default "")
6029 global
6030 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006031 {only available when compiled with the |+printer|,
6032 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006033 The CJK character set to be used for CJK output from |:hardcopy|.
6034 See |pmbcs-option|.
6035
6036 *'printmbfont'* *'pmbfn'*
6037'printmbfont' 'pmbfn' string (default "")
6038 global
6039 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006040 {only available when compiled with the |+printer|,
6041 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006042 List of font names to be used for CJK output from |:hardcopy|.
6043 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044
6045 *'printoptions'* *'popt'*
6046'printoptions' 'popt' string (default "")
6047 global
6048 {not in Vi}
6049 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006050 List of items that control the format of the output of |:hardcopy|.
6051 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006052
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006053 *'prompt'* *'noprompt'*
6054'prompt' boolean (default on)
6055 global
6056 When on a ":" prompt is used in Ex mode.
6057
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006058 *'pumheight'* *'ph'*
6059'pumheight' 'ph' number (default 0)
6060 global
6061 {not available when compiled without the
6062 |+insert_expand| feature}
6063 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006064 Determines the maximum number of items to show in the popup menu for
6065 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006066 |ins-completion-menu|.
6067
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006068 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006069'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006070 global
6071 {not available when compiled without the
6072 |+insert_expand| feature}
6073 {not in Vi}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006074 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006075 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006076
Bram Moolenaard94464e2015-11-02 15:28:18 +01006077 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006078'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006079 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006080 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006081 {only available when compiled with the |+python/dyn|
6082 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006083 Specifies the name of the Python 2.x shared library. The default is
6084 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006085 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006086 This option cannot be set from a |modeline| or in the |sandbox|, for
6087 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006088
Bram Moolenaar94073162018-01-31 21:49:05 +01006089 *'pythonhome'*
6090'pythonhome' string (default "")
6091 global
6092 {not in Vi}
6093 {only available when compiled with the |+python/dyn|
6094 feature}
6095 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6096 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6097 which was specified at compile time, will be used for the Python 2.x
6098 home directory.
6099 Environment variables are expanded |:set_env|.
6100 This option cannot be set from a |modeline| or in the |sandbox|, for
6101 security reasons.
6102
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006103 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006104'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006105 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006106 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006107 {only available when compiled with the |+python3/dyn|
6108 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006109 Specifies the name of the Python 3 shared library. The default is
6110 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006111 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006112 This option cannot be set from a |modeline| or in the |sandbox|, for
6113 security reasons.
6114
Bram Moolenaar94073162018-01-31 21:49:05 +01006115 *'pythonthreehome'*
6116'pythonthreehome' string (default "")
6117 global
6118 {not in Vi}
6119 {only available when compiled with the |+python3/dyn|
6120 feature}
6121 Specifies the name of the Python 3 home directory. When
6122 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6123 PYTHON3_HOME, which was specified at compile time, will be used for
6124 the Python 3 home directory.
6125 Environment variables are expanded |:set_env|.
6126 This option cannot be set from a |modeline| or in the |sandbox|, for
6127 security reasons.
6128
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006129 *'pyxversion'* *'pyx'*
6130'pyxversion' 'pyx' number (default depends on the build)
6131 global
6132 {not in Vi}
6133 {only available when compiled with the |+python| or
6134 the |+python3| feature}
6135 Specifies the python version used for pyx* functions and commands
6136 |python_x|. The default value is as follows:
6137
6138 Compiled with Default ~
6139 |+python| and |+python3| 0
6140 only |+python| 2
6141 only |+python3| 3
6142
6143 Available values are 0, 2 and 3.
6144 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6145 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6146 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6147 to 2 if Python 2 is available.
6148 See also: |has-pythonx|
6149
6150 If Vim is compiled with only |+python| or |+python3| setting
6151 'pyxversion' has no effect. The pyx* functions and commands are
6152 always the same as the compiled version.
6153
6154 This option cannot be set from a |modeline| or in the |sandbox|, for
6155 security reasons.
6156
Bram Moolenaar677ee682005-01-27 14:41:15 +00006157 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006158'quoteescape' 'qe' string (default "\")
6159 local to buffer
6160 {not in Vi}
6161 The characters that are used to escape quotes in a string. Used for
6162 objects like a', a" and a` |a'|.
6163 When one of the characters in this option is found inside a string,
6164 the following character will be skipped. The default value makes the
6165 text "foo\"bar\\" considered to be one string.
6166
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6168'readonly' 'ro' boolean (default off)
6169 local to buffer
6170 If on, writes fail unless you use a '!'. Protects you from
6171 accidentally overwriting a file. Default on when Vim is started
6172 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006173 When using ":w!" the 'readonly' option is reset for the current
6174 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006175 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006176 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006177 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006179 *'redrawtime'* *'rdt'*
6180'redrawtime' 'rdt' number (default 2000)
6181 global
6182 {not in Vi}
6183 {only available when compiled with the |+reltime|
6184 feature}
6185 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006186 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006187 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006188 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006189 matches will be highlighted.
6190 For syntax highlighting the time applies per window. When over the
6191 limit syntax highlighting is disabled until |CTRL-L| is used.
6192 This is used to avoid that Vim hangs when using a very complicated
6193 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006194
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006195 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006196'regexpengine' 're' number (default 0)
6197 global
6198 {not in Vi}
6199 This selects the default regexp engine. |two-engines|
6200 The possible values are:
6201 0 automatic selection
6202 1 old engine
6203 2 NFA engine
6204 Note that when using the NFA engine and the pattern contains something
6205 that is not supported the pattern will not match. This is only useful
6206 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006207 Using automatic selection enables Vim to switch the engine, if the
6208 default engine becomes too costly. E.g., when the NFA engine uses too
6209 many states. This should prevent Vim from hanging on a combination of
6210 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006211
Bram Moolenaar64486672010-05-16 15:46:46 +02006212 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6213'relativenumber' 'rnu' boolean (default off)
6214 local to window
6215 {not in Vi}
6216 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006217 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006218 precede some vertical motion commands (e.g. j k + -) with, without
6219 having to calculate it yourself. Especially useful in combination with
6220 other commands (e.g. y d c < > gq gw =).
6221 When the 'n' option is excluded from 'cpoptions' a wrapped
6222 line will not use the column of line numbers (this is the default when
6223 'compatible' isn't set).
6224 The 'numberwidth' option can be used to set the room used for the line
6225 number.
6226 When a long, wrapped line doesn't start with the first character, '-'
6227 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006228 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6229 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006230
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006231 The number in front of the cursor line also depends on the value of
6232 'number', see |number_relativenumber| for all combinations of the two
6233 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006234
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235 *'remap'* *'noremap'*
6236'remap' boolean (default on)
6237 global
6238 Allows for mappings to work recursively. If you do not want this for
6239 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006240 NOTE: To avoid portability problems with Vim scripts, always keep
6241 this option at the default "on". Only switch it off when working with
6242 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006244 *'renderoptions'* *'rop'*
6245'renderoptions' 'rop' string (default: empty)
6246 global
6247 {not in Vi}
6248 {only available when compiled with GUI and DIRECTX on
6249 MS-Windows}
6250 Select a text renderer and set its options. The options depend on the
6251 renderer.
6252
6253 Syntax: >
6254 set rop=type:{renderer}(,{name}:{value})*
6255<
6256 Currently, only one optional renderer is available.
6257
6258 render behavior ~
6259 directx Vim will draw text using DirectX (DirectWrite). It makes
6260 drawn glyphs more beautiful than default GDI.
6261 It requires 'encoding' is "utf-8", and only works on
6262 MS-Windows Vista or newer version.
6263
6264 Options:
6265 name meaning type value ~
6266 gamma gamma float 1.0 - 2.2 (maybe)
6267 contrast enhancedContrast float (unknown)
6268 level clearTypeLevel float (unknown)
6269 geom pixelGeometry int 0 - 2 (see below)
6270 renmode renderingMode int 0 - 6 (see below)
6271 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006272 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006273
Bram Moolenaar92467d32017-12-05 13:22:16 +01006274 See this URL for detail (except for scrlines):
6275 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006276
6277 For geom: structure of a device pixel.
6278 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6279 1 - DWRITE_PIXEL_GEOMETRY_RGB
6280 2 - DWRITE_PIXEL_GEOMETRY_BGR
6281
6282 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006283 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006284
6285 For renmode: method of rendering glyphs.
6286 0 - DWRITE_RENDERING_MODE_DEFAULT
6287 1 - DWRITE_RENDERING_MODE_ALIASED
6288 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6289 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6290 4 - DWRITE_RENDERING_MODE_NATURAL
6291 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6292 6 - DWRITE_RENDERING_MODE_OUTLINE
6293
6294 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006295 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006296
6297 For taamode: antialiasing mode used for drawing text.
6298 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6299 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6300 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6301 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6302
6303 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006304 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6305
Bram Moolenaara338adc2018-01-31 20:51:47 +01006306 For scrlines:
6307 This was used for optimizing scrolling behavior, however this
6308 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006309
6310 Example: >
6311 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006312 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006313 set rop=type:directx
6314<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006315 If select a raster font (Courier, Terminal or FixedSys which
6316 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006317 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006318
6319 NOTE: It is known that some fonts and options combination
6320 causes trouble on drawing glyphs.
6321
Bram Moolenaar92467d32017-12-05 13:22:16 +01006322 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006323 special made fonts (True-Type fonts which includes only
6324 bitmap glyphs).
6325 - 'taamode:3' will not work with some vector fonts.
6326
6327 NOTE: With this option, you can display colored emoji
6328 (emoticon) in Windows 8.1 or later. To display colored emoji,
6329 there are some conditions which you should notice.
6330
6331 - If your font includes non-colored emoji already, it will
6332 be used.
6333 - If your font doesn't have emoji, the system chooses an
6334 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6335 will be used.
6336 - When this alternative font didn't have fixed width glyph,
6337 emoji might be rendered beyond the bounding box of drawing
6338 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006339
6340 Other render types are currently not supported.
6341
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 *'report'*
6343'report' number (default 2)
6344 global
6345 Threshold for reporting number of lines changed. When the number of
6346 changed lines is more than 'report' a message will be given for most
6347 ":" commands. If you want it always, set 'report' to 0.
6348 For the ":substitute" command the number of substitutions is used
6349 instead of the number of lines.
6350
6351 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6352'restorescreen' 'rs' boolean (default on)
6353 global
6354 {not in Vi} {only in Windows 95/NT console version}
6355 When set, the screen contents is restored when exiting Vim. This also
6356 happens when executing external commands.
6357
6358 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6359 options in your .vimrc. To disable restoring:
6360 set t_ti= t_te=
6361 To enable restoring (for an xterm):
6362 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6363 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6364
6365 *'revins'* *'ri'* *'norevins'* *'nori'*
6366'revins' 'ri' boolean (default off)
6367 global
6368 {not in Vi}
6369 {only available when compiled with the |+rightleft|
6370 feature}
6371 Inserting characters in Insert mode will work backwards. See "typing
6372 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6373 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006374 NOTE: This option is reset when 'compatible' is set.
6375 This option is reset when 'paste' is set and restored when 'paste' is
6376 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006377
6378 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6379'rightleft' 'rl' boolean (default off)
6380 local to window
6381 {not in Vi}
6382 {only available when compiled with the |+rightleft|
6383 feature}
6384 When on, display orientation becomes right-to-left, i.e., characters
6385 that are stored in the file appear from the right to the left.
6386 Using this option, it is possible to edit files for languages that
6387 are written from the right to the left such as Hebrew and Arabic.
6388 This option is per window, so it is possible to edit mixed files
6389 simultaneously, or to view the same file in both ways (this is
6390 useful whenever you have a mixed text file with both right-to-left
6391 and left-to-right strings so that both sets are displayed properly
6392 in different windows). Also see |rileft.txt|.
6393
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006394 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395'rightleftcmd' 'rlc' string (default "search")
6396 local to window
6397 {not in Vi}
6398 {only available when compiled with the |+rightleft|
6399 feature}
6400 Each word in this option enables the command line editing to work in
6401 right-to-left mode for a group of commands:
6402
6403 search "/" and "?" commands
6404
6405 This is useful for languages such as Hebrew, Arabic and Farsi.
6406 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6407
Bram Moolenaard94464e2015-11-02 15:28:18 +01006408 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006409'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006410 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006411 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006412 {only available when compiled with the |+ruby/dyn|
6413 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006414 Specifies the name of the Ruby shared library. The default is
6415 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006416 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006417 This option cannot be set from a |modeline| or in the |sandbox|, for
6418 security reasons.
6419
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006421'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 global
6423 {not in Vi}
6424 {not available when compiled without the
6425 |+cmdline_info| feature}
6426 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006427 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006428 text in the file is shown on the far right:
6429 Top first line is visible
6430 Bot last line is visible
6431 All first and last line are visible
6432 45% relative position in the file
6433 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006434 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006436 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 this option takes precedence over 'ruler' and 'rulerformat'
6438 If the number of characters displayed is different from the number of
6439 bytes in the text (e.g., for a TAB or a multi-byte character), both
6440 the text column (byte number) and the screen column are shown,
6441 separated with a dash.
6442 For an empty line "0-1" is shown.
6443 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006444 This option is reset when 'paste' is set and restored when 'paste' is
6445 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006446 If you don't want to see the ruler all the time but want to know where
6447 you are, use "g CTRL-G" |g_CTRL-G|.
6448 NOTE: This option is reset when 'compatible' is set.
6449
6450 *'rulerformat'* *'ruf'*
6451'rulerformat' 'ruf' string (default empty)
6452 global
6453 {not in Vi}
6454 {not available when compiled without the |+statusline|
6455 feature}
6456 When this option is not empty, it determines the content of the ruler
6457 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006458 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 The default ruler width is 17 characters. To make the ruler 15
6460 characters wide, put "%15(" at the start and "%)" at the end.
6461 Example: >
6462 :set rulerformat=%15(%c%V\ %p%%%)
6463<
6464 *'runtimepath'* *'rtp'* *vimfiles*
6465'runtimepath' 'rtp' string (default:
6466 Unix: "$HOME/.vim,
6467 $VIM/vimfiles,
6468 $VIMRUNTIME,
6469 $VIM/vimfiles/after,
6470 $HOME/.vim/after"
6471 Amiga: "home:vimfiles,
6472 $VIM/vimfiles,
6473 $VIMRUNTIME,
6474 $VIM/vimfiles/after,
6475 home:vimfiles/after"
6476 PC, OS/2: "$HOME/vimfiles,
6477 $VIM/vimfiles,
6478 $VIMRUNTIME,
6479 $VIM/vimfiles/after,
6480 $HOME/vimfiles/after"
6481 Macintosh: "$VIM:vimfiles,
6482 $VIMRUNTIME,
6483 $VIM:vimfiles:after"
6484 RISC-OS: "Choices:vimfiles,
6485 $VIMRUNTIME,
6486 Choices:vimfiles/after"
6487 VMS: "sys$login:vimfiles,
6488 $VIM/vimfiles,
6489 $VIMRUNTIME,
6490 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006491 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 global
6493 {not in Vi}
6494 This is a list of directories which will be searched for runtime
6495 files:
6496 filetype.vim filetypes by file name |new-filetype|
6497 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006498 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006499 colors/ color scheme files |:colorscheme|
6500 compiler/ compiler files |:compiler|
6501 doc/ documentation |write-local-help|
6502 ftplugin/ filetype plugins |write-filetype-plugin|
6503 indent/ indent scripts |indent-expression|
6504 keymap/ key mapping files |mbyte-keymap|
6505 lang/ menu translations |:menutrans|
6506 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006507 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 plugin/ plugin scripts |write-plugin|
6509 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006510 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511 syntax/ syntax files |mysyntaxfile|
6512 tutor/ files for vimtutor |tutor|
6513
6514 And any other file searched for with the |:runtime| command.
6515
6516 The defaults for most systems are setup to search five locations:
6517 1. In your home directory, for your personal preferences.
6518 2. In a system-wide Vim directory, for preferences from the system
6519 administrator.
6520 3. In $VIMRUNTIME, for files distributed with Vim.
6521 *after-directory*
6522 4. In the "after" directory in the system-wide Vim directory. This is
6523 for the system administrator to overrule or add to the distributed
6524 defaults (rarely needed)
6525 5. In the "after" directory in your home directory. This is for
6526 personal preferences to overrule or add to the distributed defaults
6527 or system-wide settings (rarely needed).
6528
Bram Moolenaard0796902016-09-16 20:02:31 +02006529 More entries are added when using |packages|. If it gets very long
6530 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6531 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006532
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6534 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006535 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 wildcards.
6537 See |:runtime|.
6538 Example: >
6539 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6540< This will use the directory "~/vimruntime" first (containing your
6541 personal Vim runtime files), then "/mygroup/vim" (shared between a
6542 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6543 files).
6544 You probably should always include $VIMRUNTIME somewhere, to use the
6545 distributed runtime files. You can put a directory before $VIMRUNTIME
6546 to find files which replace a distributed runtime files. You can put
6547 a directory after $VIMRUNTIME to find files which add to distributed
6548 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006549 When Vim is started with |--clean| the home directory entries are not
6550 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551 This option cannot be set from a |modeline| or in the |sandbox|, for
6552 security reasons.
6553
6554 *'scroll'* *'scr'*
6555'scroll' 'scr' number (default: half the window height)
6556 local to window
6557 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6558 set to half the number of lines in the window when the window size
6559 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006560 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6562 the number of screen lines instead of file lines, makes a difference
6563 when lines wrap}
6564
6565 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6566'scrollbind' 'scb' boolean (default off)
6567 local to window
6568 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569 See also |scroll-binding|. When this option is set, the current
6570 window scrolls as other scrollbind windows (windows that also have
6571 this option set) scroll. This option is useful for viewing the
6572 differences between two versions of a file, see 'diff'.
6573 See |'scrollopt'| for options that determine how this option should be
6574 interpreted.
6575 This option is mostly reset when splitting a window to edit another
6576 file. This means that ":split | edit file" results in two windows
6577 with scroll-binding, but ":split file" does not.
6578
6579 *'scrolljump'* *'sj'*
6580'scrolljump' 'sj' number (default 1)
6581 global
6582 {not in Vi}
6583 Minimal number of lines to scroll when the cursor gets off the
6584 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6585 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006586 When set to a negative number from -1 to -100 this is used as the
6587 percentage of the window height. Thus -50 scrolls half the window
6588 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006589 NOTE: This option is set to 1 when 'compatible' is set.
6590
6591 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006592'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006593 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 {not in Vi}
6595 Minimal number of screen lines to keep above and below the cursor.
6596 This will make some context visible around where you are working. If
6597 you set it to a very large value (999) the cursor line will always be
6598 in the middle of the window (except at the start or end of the file or
6599 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006600 After using the local value, go back the global value with one of
6601 these two: >
6602 setlocal scrolloff<
6603 setlocal scrolloff=-1
6604< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 NOTE: This option is set to 0 when 'compatible' is set.
6606
6607 *'scrollopt'* *'sbo'*
6608'scrollopt' 'sbo' string (default "ver,jump")
6609 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610 {not in Vi}
6611 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006612 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6613 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 The following words are available:
6615 ver Bind vertical scrolling for 'scrollbind' windows
6616 hor Bind horizontal scrolling for 'scrollbind' windows
6617 jump Applies to the offset between two windows for vertical
6618 scrolling. This offset is the difference in the first
6619 displayed line of the bound windows. When moving
6620 around in a window, another 'scrollbind' window may
6621 reach a position before the start or after the end of
6622 the buffer. The offset is not changed though, when
6623 moving back the 'scrollbind' window will try to scroll
6624 to the desired position when possible.
6625 When now making that window the current one, two
6626 things can be done with the relative offset:
6627 1. When "jump" is not included, the relative offset is
6628 adjusted for the scroll position in the new current
6629 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006630 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 2. When "jump" is included, the other windows are
6632 scrolled to keep the same relative offset. When
6633 going back to the other window, it still uses the
6634 same relative offset.
6635 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006636 When 'diff' mode is active there always is vertical scroll binding,
6637 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638
6639 *'sections'* *'sect'*
6640'sections' 'sect' string (default "SHNHH HUnhsh")
6641 global
6642 Specifies the nroff macros that separate sections. These are pairs of
6643 two letters (See |object-motions|). The default makes a section start
6644 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6645
6646 *'secure'* *'nosecure'* *E523*
6647'secure' boolean (default off)
6648 global
6649 {not in Vi}
6650 When on, ":autocmd", shell and write commands are not allowed in
6651 ".vimrc" and ".exrc" in the current directory and map commands are
6652 displayed. Switch it off only if you know that you will not run into
6653 problems, or when the 'exrc' option is off. On Unix this option is
6654 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006655 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 'secure' at the end of your ~/.vimrc then.
6657 This option cannot be set from a |modeline| or in the |sandbox|, for
6658 security reasons.
6659
6660 *'selection'* *'sel'*
6661'selection' 'sel' string (default "inclusive")
6662 global
6663 {not in Vi}
6664 This option defines the behavior of the selection. It is only used
6665 in Visual and Select mode.
6666 Possible values:
6667 value past line inclusive ~
6668 old no yes
6669 inclusive yes yes
6670 exclusive yes no
6671 "past line" means that the cursor is allowed to be positioned one
6672 character past the line.
6673 "inclusive" means that the last character of the selection is included
6674 in an operation. For example, when "x" is used to delete the
6675 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006676 When "old" is used and 'virtualedit' allows the cursor to move past
6677 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678 Note that when "exclusive" is used and selecting from the end
6679 backwards, you cannot include the last character of a line, when
6680 starting in Normal mode and 'virtualedit' empty.
6681
6682 The 'selection' option is set by the |:behave| command.
6683
6684 *'selectmode'* *'slm'*
6685'selectmode' 'slm' string (default "")
6686 global
6687 {not in Vi}
6688 This is a comma separated list of words, which specifies when to start
6689 Select mode instead of Visual mode, when a selection is started.
6690 Possible values:
6691 mouse when using the mouse
6692 key when using shifted special keys
6693 cmd when using "v", "V" or CTRL-V
6694 See |Select-mode|.
6695 The 'selectmode' option is set by the |:behave| command.
6696
6697 *'sessionoptions'* *'ssop'*
6698'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006699 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700 global
6701 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006702 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703 feature}
6704 Changes the effect of the |:mksession| command. It is a comma
6705 separated list of words. Each word enables saving and restoring
6706 something:
6707 word save and restore ~
6708 blank empty windows
6709 buffers hidden and unloaded buffers, not just those in windows
6710 curdir the current directory
6711 folds manually created folds, opened/closed folds and local
6712 fold options
6713 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006714 and contain at least one lowercase letter. Only
6715 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 help the help window
6717 localoptions options and mappings local to a window or buffer (not
6718 global values for local options)
6719 options all options and mappings (also global values for local
6720 options)
6721 resize size of the Vim window: 'lines' and 'columns'
6722 sesdir the directory in which the session file is located
6723 will become the current directory (useful with
6724 projects accessed over a network from different
6725 systems)
6726 slash backslashes in file names replaced with forward
6727 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006728 tabpages all tab pages; without this only the current tab page
6729 is restored, so that you can make a session for each
6730 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006731 terminal include terminal windows where the command can be
6732 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733 unix with Unix end-of-line format (single <NL>), even when
6734 on Windows or DOS
6735 winpos position of the whole Vim window
6736 winsize window sizes
6737
6738 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006739 When neither "curdir" nor "sesdir" is included, file names are stored
6740 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741 "slash" and "unix" are useful on Windows when sharing session files
6742 with Unix. The Unix version of Vim cannot source dos format scripts,
6743 but the Windows version of Vim can source unix format scripts.
6744
6745 *'shell'* *'sh'* *E91*
6746'shell' 'sh' string (default $SHELL or "sh",
6747 MS-DOS and Win32: "command.com" or
6748 "cmd.exe", OS/2: "cmd")
6749 global
6750 Name of the shell to use for ! and :! commands. When changing the
6751 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6752 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006753 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 See |option-backslash| about including spaces and backslashes.
6755 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006756
Bram Moolenaar071d4272004-06-13 20:20:40 +00006757 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006758 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006759 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6760< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006761 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006763 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006765 Example with escaped space (Vim will do this when initializing the
6766 option from $SHELL): >
6767 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006768< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006769 backslashes are consumed by `:set`.
6770
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771 Under MS-Windows, when the executable ends in ".com" it must be
6772 included. Thus setting the shell to "command.com" or "4dos.com"
6773 works, but "command" and "4dos" do not work for all commands (e.g.,
6774 filtering).
6775 For unknown reasons, when using "4dos.com" the current directory is
6776 changed to "C:\". To avoid this set 'shell' like this: >
6777 :set shell=command.com\ /c\ 4dos
6778< This option cannot be set from a |modeline| or in the |sandbox|, for
6779 security reasons.
6780
6781 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006782'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006783 MS-DOS and Win32, when 'shell' does not
6784 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 global
6786 {not in Vi}
6787 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6788 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6789 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006790 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006791 On Unix it can have more than one flag. Each white space separated
6792 part is passed as an argument to the shell command.
6793 See |option-backslash| about including spaces and backslashes.
6794 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795 This option cannot be set from a |modeline| or in the |sandbox|, for
6796 security reasons.
6797
6798 *'shellpipe'* *'sp'*
6799'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6800 global
6801 {not in Vi}
6802 {not available when compiled without the |+quickfix|
6803 feature}
6804 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006805 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 including spaces and backslashes.
6807 The name of the temporary file can be represented by "%s" if necessary
6808 (the file name is appended automatically if no %s appears in the value
6809 of this option).
6810 For the Amiga and MS-DOS the default is ">". The output is directly
6811 saved in a file and not echoed to the screen.
6812 For Unix the default it "| tee". The stdout of the compiler is saved
6813 in a file and echoed to the screen. If the 'shell' option is "csh" or
6814 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006815 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6816 default becomes "2>&1| tee". This means that stderr is also included.
6817 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6818 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 The initialization of this option is done after reading the ".vimrc"
6820 and the other initializations, so that when the 'shell' option is set
6821 there, the 'shellpipe' option changes automatically, unless it was
6822 explicitly set before.
6823 When 'shellpipe' is set to an empty string, no redirection of the
6824 ":make" output will be done. This is useful if you use a 'makeprg'
6825 that writes to 'makeef' by itself. If you want no piping, but do
6826 want to include the 'makeef', set 'shellpipe' to a single space.
6827 Don't forget to precede the space with a backslash: ":set sp=\ ".
6828 In the future pipes may be used for filtering and this option will
6829 become obsolete (at least for Unix).
6830 This option cannot be set from a |modeline| or in the |sandbox|, for
6831 security reasons.
6832
6833 *'shellquote'* *'shq'*
6834'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6835 contains "sh" somewhere: "\"")
6836 global
6837 {not in Vi}
6838 Quoting character(s), put around the command passed to the shell, for
6839 the "!" and ":!" commands. The redirection is kept outside of the
6840 quoting. See 'shellxquote' to include the redirection. It's
6841 probably not useful to set both options.
6842 This is an empty string by default. Only known to be useful for
6843 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6844 or bash, where it should be "\"". The default is adjusted according
6845 the value of 'shell', to reduce the need to set this option by the
6846 user. See |dos-shell|.
6847 This option cannot be set from a |modeline| or in the |sandbox|, for
6848 security reasons.
6849
6850 *'shellredir'* *'srr'*
6851'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6852 global
6853 {not in Vi}
6854 String to be used to put the output of a filter command in a temporary
6855 file. See also |:!|. See |option-backslash| about including spaces
6856 and backslashes.
6857 The name of the temporary file can be represented by "%s" if necessary
6858 (the file name is appended automatically if no %s appears in the value
6859 of this option).
6860 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6861 or "zsh" during initializations, the default becomes ">&". If the
6862 'shell' option is "sh", "ksh" or "bash" the default becomes
6863 ">%s 2>&1". This means that stderr is also included.
6864 For Win32, the Unix checks are done and additionally "cmd" is checked
6865 for, which makes the default ">%s 2>&1". Also, the same names with
6866 ".exe" appended are checked for.
6867 The initialization of this option is done after reading the ".vimrc"
6868 and the other initializations, so that when the 'shell' option is set
6869 there, the 'shellredir' option changes automatically unless it was
6870 explicitly set before.
6871 In the future pipes may be used for filtering and this option will
6872 become obsolete (at least for Unix).
6873 This option cannot be set from a |modeline| or in the |sandbox|, for
6874 security reasons.
6875
6876 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6877'shellslash' 'ssl' boolean (default off)
6878 global
6879 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6880 When set, a forward slash is used when expanding file names. This is
6881 useful when a Unix-like shell is used instead of command.com or
6882 cmd.exe. Backward slashes can still be typed, but they are changed to
6883 forward slashes by Vim.
6884 Note that setting or resetting this option has no effect for some
6885 existing file names, thus this option needs to be set before opening
6886 any file for best results. This might change in the future.
6887 'shellslash' only works when a backslash can be used as a path
6888 separator. To test if this is so use: >
6889 if exists('+shellslash')
6890<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006891 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6892'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6893 global
6894 {not in Vi}
6895 When on, use temp files for shell commands. When off use a pipe.
6896 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006897 Currently a pipe is only supported on Unix and MS-Windows 2K and
6898 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006899 :if has("filterpipe")
6900< The advantage of using a pipe is that nobody can read the temp file
6901 and the 'shell' command does not need to support redirection.
6902 The advantage of using a temp file is that the file type and encoding
6903 can be detected.
6904 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6905 |FilterWritePost| autocommands event are not triggered when
6906 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006907 The `system()` function does not respect this option and always uses
6908 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006909 NOTE: This option is set to the Vim default value when 'compatible'
6910 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006911
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 *'shelltype'* *'st'*
6913'shelltype' 'st' number (default 0)
6914 global
6915 {not in Vi} {only for the Amiga}
6916 On the Amiga this option influences the way how the commands work
6917 which use a shell.
6918 0 and 1: always use the shell
6919 2 and 3: use the shell only to filter lines
6920 4 and 5: use shell only for ':sh' command
6921 When not using the shell, the command is executed directly.
6922
6923 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6924 1 and 3: use "shell cmd" to start external commands
6925
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006926 *'shellxescape'* *'sxe'*
6927'shellxescape' 'sxe' string (default: "";
6928 for MS-DOS and MS-Windows: "\"&|<>()@^")
6929 global
6930 {not in Vi}
6931 When 'shellxquote' is set to "(" then the characters listed in this
6932 option will be escaped with a '^' character. This makes it possible
6933 to execute most external commands with cmd.exe.
6934
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 *'shellxquote'* *'sxq'*
6936'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006937 for Win32, when 'shell' is cmd.exe: "("
6938 for Win32, when 'shell' contains "sh"
6939 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 for Unix, when using system(): "\"")
6941 global
6942 {not in Vi}
6943 Quoting character(s), put around the command passed to the shell, for
6944 the "!" and ":!" commands. Includes the redirection. See
6945 'shellquote' to exclude the redirection. It's probably not useful
6946 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006947 When the value is '(' then ')' is appended. When the value is '"('
6948 then ')"' is appended.
6949 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006950 This is an empty string by default on most systems, but is known to be
6951 useful for on Win32 version, either for cmd.exe which automatically
6952 strips off the first and last quote on a command, or 3rd-party shells
6953 such as the MKS Korn Shell or bash, where it should be "\"". The
6954 default is adjusted according the value of 'shell', to reduce the need
6955 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 This option cannot be set from a |modeline| or in the |sandbox|, for
6957 security reasons.
6958
6959 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6960'shiftround' 'sr' boolean (default off)
6961 global
6962 {not in Vi}
6963 Round indent to multiple of 'shiftwidth'. Applies to > and <
6964 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6965 a multiple of 'shiftwidth' (this is Vi compatible).
6966 NOTE: This option is reset when 'compatible' is set.
6967
6968 *'shiftwidth'* *'sw'*
6969'shiftwidth' 'sw' number (default 8)
6970 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006971 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006973 When zero the 'ts' value will be used. Use the |shiftwidth()|
6974 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975
6976 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006977'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6978 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006979 global
6980 {not in Vi}
6981 This option helps to avoid all the |hit-enter| prompts caused by file
6982 messages, for example with CTRL-G, and to avoid some other messages.
6983 It is a list of flags:
6984 flag meaning when present ~
6985 f use "(3 of 5)" instead of "(file 3 of 5)"
6986 i use "[noeol]" instead of "[Incomplete last line]"
6987 l use "999L, 888C" instead of "999 lines, 888 characters"
6988 m use "[+]" instead of "[Modified]"
6989 n use "[New]" instead of "[New File]"
6990 r use "[RO]" instead of "[readonly]"
6991 w use "[w]" instead of "written" for file write message
6992 and "[a]" instead of "appended" for ':w >> file' command
6993 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6994 "[unix format]" and "[mac]" instead of "[mac format]".
6995 a all of the above abbreviations
6996
6997 o overwrite message for writing a file with subsequent message
6998 for reading a file (useful for ":wn" or when 'autowrite' on)
6999 O message for reading a file overwrites any previous message.
7000 Also for quickfix message (e.g., ":cn").
7001 s don't give "search hit BOTTOM, continuing at TOP" or "search
7002 hit TOP, continuing at BOTTOM" messages
7003 t truncate file message at the start if it is too long to fit
7004 on the command-line, "<" will appear in the left most column.
7005 Ignored in Ex mode.
7006 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00007007 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 Ignored in Ex mode.
7009 W don't give "written" or "[w]" when writing a file
7010 A don't give the "ATTENTION" message when an existing swap file
7011 is found.
7012 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02007013 c don't give |ins-completion-menu| messages. For example,
7014 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
7015 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01007016 q use "recording" instead of "recording @a"
7017 F don't give the file info when editing a file, like `:silent`
7018 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019
7020 This gives you the opportunity to avoid that a change between buffers
7021 requires you to hit <Enter>, but still gives as useful a message as
7022 possible for the space available. To get the whole message that you
7023 would have got with 'shm' empty, use ":file!"
7024 Useful values:
7025 shm= No abbreviation of message.
7026 shm=a Abbreviation, but no loss of information.
7027 shm=at Abbreviation, and truncate message when necessary.
7028
7029 NOTE: This option is set to the Vi default value when 'compatible' is
7030 set and to the Vim default value when 'compatible' is reset.
7031
7032 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7033'shortname' 'sn' boolean (default off)
7034 local to buffer
7035 {not in Vi, not in MS-DOS versions}
7036 Filenames are assumed to be 8 characters plus one extension of 3
7037 characters. Multiple dots in file names are not allowed. When this
7038 option is on, dots in file names are replaced with underscores when
7039 adding an extension (".~" or ".swp"). This option is not available
7040 for MS-DOS, because then it would always be on. This option is useful
7041 when editing files on an MS-DOS compatible filesystem, e.g., messydos
7042 or crossdos. When running the Win32 GUI version under Win32s, this
7043 option is always on by default.
7044
7045 *'showbreak'* *'sbr'* *E595*
7046'showbreak' 'sbr' string (default "")
7047 global
7048 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007049 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050 feature}
7051 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007052 values are "> " or "+++ ": >
7053 :set showbreak=>\
7054< Note the backslash to escape the trailing space. It's easier like
7055 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007056 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007057< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 comma (in a future version the comma might be used to separate the
7059 part that is shown at the end and at the start of a line).
7060 The characters are highlighted according to the '@' flag in
7061 'highlight'.
7062 Note that tabs after the showbreak will be displayed differently.
7063 If you want the 'showbreak' to appear in between line numbers, add the
7064 "n" flag to 'cpoptions'.
7065
7066 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007067'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7068 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007069 global
7070 {not in Vi}
7071 {not available when compiled without the
7072 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007073 Show (partial) command in the last line of the screen. Set this
7074 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075 In Visual mode the size of the selected area is shown:
7076 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007077 If the number of bytes is different it is also displayed: "2-6"
7078 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007080 - When selecting a block, the size in screen characters:
7081 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082 NOTE: This option is set to the Vi default value when 'compatible' is
7083 set and to the Vim default value when 'compatible' is reset.
7084
7085 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7086'showfulltag' 'sft' boolean (default off)
7087 global
7088 {not in Vi}
7089 When completing a word in insert mode (see |ins-completion|) from the
7090 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007091 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 matched a C function, you can see a template for what arguments are
7093 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007094 Note that this doesn't work well together with having "longest" in
7095 'completeopt', because the completion from the search pattern may not
7096 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097
7098 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7099'showmatch' 'sm' boolean (default off)
7100 global
7101 When a bracket is inserted, briefly jump to the matching one. The
7102 jump is only done if the match can be seen on the screen. The time to
7103 show the match can be set with 'matchtime'.
7104 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007105 seen or not).
7106 This option is reset when 'paste' is set and restored when 'paste' is
7107 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108 When the 'm' flag is not included in 'cpoptions', typing a character
7109 will immediately move the cursor back to where it belongs.
7110 See the "sm" field in 'guicursor' for setting the cursor shape and
7111 blinking when showing the match.
7112 The 'matchpairs' option can be used to specify the characters to show
7113 matches for. 'rightleft' and 'revins' are used to look for opposite
7114 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007115 Also see the matchparen plugin for highlighting the match when moving
7116 around |pi_paren.txt|.
7117 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118
7119 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7120'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7121 global
7122 If in Insert, Replace or Visual mode put a message on the last line.
7123 Use the 'M' flag in 'highlight' to set the type of highlighting for
7124 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007125 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 doesn't mean XIM is really active, especially when 'imactivatekey' is
7127 not set.
7128 NOTE: This option is set to the Vi default value when 'compatible' is
7129 set and to the Vim default value when 'compatible' is reset.
7130
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007131 *'showtabline'* *'stal'*
7132'showtabline' 'stal' number (default 1)
7133 global
7134 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007135 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007136 feature}
7137 The value of this option specifies when the line with tab page labels
7138 will be displayed:
7139 0: never
7140 1: only if there are at least two tab pages
7141 2: always
7142 This is both for the GUI and non-GUI implementation of the tab pages
7143 line.
7144 See |tab-page| for more information about tab pages.
7145
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 *'sidescroll'* *'ss'*
7147'sidescroll' 'ss' number (default 0)
7148 global
7149 {not in Vi}
7150 The minimal number of columns to scroll horizontally. Used only when
7151 the 'wrap' option is off and the cursor is moved off of the screen.
7152 When it is zero the cursor will be put in the middle of the screen.
7153 When using a slow terminal set it to a large number or 0. When using
7154 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7155 commands.
7156
7157 *'sidescrolloff'* *'siso'*
7158'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007159 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 {not in Vi}
7161 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007162 right of the cursor if 'nowrap' is set. Setting this option to a
7163 value greater than 0 while having |'sidescroll'| also at a non-zero
7164 value makes some context visible in the line you are scrolling in
7165 horizontally (except at beginning of the line). Setting this option
7166 to a large value (like 999) has the effect of keeping the cursor
7167 horizontally centered in the window, as long as one does not come too
7168 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007169 After using the local value, go back the global value with one of
7170 these two: >
7171 setlocal sidescrolloff<
7172 setlocal sidescrolloff=-1
7173< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174
7175 Example: Try this together with 'sidescroll' and 'listchars' as
7176 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007177 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178
7179 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7180 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007181<
7182 *'signcolumn'* *'scl'*
7183'signcolumn' 'scl' string (default "auto")
7184 local to window
7185 {not in Vi}
7186 {not available when compiled without the |+signs|
7187 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007188 Whether or not to draw the signcolumn. Valid values are:
7189 "auto" only when there is a sign to display
7190 "no" never
7191 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00007192
7193
7194 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7195'smartcase' 'scs' boolean (default off)
7196 global
7197 {not in Vi}
7198 Override the 'ignorecase' option if the search pattern contains upper
7199 case characters. Only used when the search pattern is typed and
7200 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007201 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7203 recalling the search pattern from history and hitting <Enter>.
7204 NOTE: This option is reset when 'compatible' is set.
7205
7206 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7207'smartindent' 'si' boolean (default off)
7208 local to buffer
7209 {not in Vi}
7210 {not available when compiled without the
7211 |+smartindent| feature}
7212 Do smart autoindenting when starting a new line. Works for C-like
7213 programs, but can also be used for other languages. 'cindent' does
7214 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007215 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007216 setting 'si' has no effect. 'indentexpr' is a more advanced
7217 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007218 Normally 'autoindent' should also be on when using 'smartindent'.
7219 An indent is automatically inserted:
7220 - After a line ending in '{'.
7221 - After a line starting with a keyword from 'cinwords'.
7222 - Before a line starting with '}' (only with the "O" command).
7223 When typing '}' as the first character in a new line, that line is
7224 given the same indent as the matching '{'.
7225 When typing '#' as the first character in a new line, the indent for
7226 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007227 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7229 When using the ">>" command, lines starting with '#' are not shifted
7230 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007231 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007232 This option is reset when 'paste' is set and restored when 'paste' is
7233 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234
7235 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7236'smarttab' 'sta' boolean (default off)
7237 global
7238 {not in Vi}
7239 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007240 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7241 <BS> will delete a 'shiftwidth' worth of space at the start of the
7242 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007243 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007244 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7245 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007246 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007248 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007249 This option is reset when 'paste' is set and restored when 'paste' is
7250 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007251 NOTE: This option is reset when 'compatible' is set.
7252
7253 *'softtabstop'* *'sts'*
7254'softtabstop' 'sts' number (default 0)
7255 local to buffer
7256 {not in Vi}
7257 Number of spaces that a <Tab> counts for while performing editing
7258 operations, like inserting a <Tab> or using <BS>. It "feels" like
7259 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7260 used. This is useful to keep the 'ts' setting at its standard value
7261 of 8, while being able to edit like it is set to 'sts'. However,
7262 commands like "x" still work on the actual characters.
7263 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007264 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007265 'softtabstop' is set to 0 when the 'paste' option is set and restored
7266 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007267 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7268 spaces is minimized by using <Tab>s.
7269 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7270 set.
7271 NOTE: This option is set to 0 when 'compatible' is set.
7272
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007273 If Vim is compiled with the |+vartabs| feature then the value of
7274 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7275 anything other than an empty string.
7276
Bram Moolenaar217ad922005-03-20 22:37:15 +00007277 *'spell'* *'nospell'*
7278'spell' boolean (default off)
7279 local to window
7280 {not in Vi}
7281 {not available when compiled without the |+syntax|
7282 feature}
7283 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007284 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007285
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007286 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007287'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007288 local to buffer
7289 {not in Vi}
7290 {not available when compiled without the |+syntax|
7291 feature}
7292 Pattern to locate the end of a sentence. The following word will be
7293 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007294 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007295 When this check is not wanted make this option empty.
7296 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007297 Be careful with special characters, see |option-backslash| about
7298 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007299 To set this option automatically depending on the language, see
7300 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007301
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007302 *'spellfile'* *'spf'*
7303'spellfile' 'spf' string (default empty)
7304 local to buffer
7305 {not in Vi}
7306 {not available when compiled without the |+syntax|
7307 feature}
7308 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007309 commands. It must end in ".{encoding}.add". You need to include the
7310 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007311 *E765*
7312 It may also be a comma separated list of names. A count before the
7313 |zg| and |zw| commands can be used to access each. This allows using
7314 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007315 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007316 you: Using the first directory in 'runtimepath' that is writable. If
7317 there is no "spell" directory yet it will be created. For the file
7318 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007319 ignoring the region.
7320 The resulting ".spl" file will be used for spell checking, it does not
7321 have to appear in 'spelllang'.
7322 Normally one file is used for all regions, but you can add the region
7323 name if you want to. However, it will then only be used when
7324 'spellfile' is set to it, for entries in 'spelllang' only files
7325 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007326 This option cannot be set from a |modeline| or in the |sandbox|, for
7327 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007328
Bram Moolenaar217ad922005-03-20 22:37:15 +00007329 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007330'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007331 local to buffer
7332 {not in Vi}
7333 {not available when compiled without the |+syntax|
7334 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007335 A comma separated list of word list names. When the 'spell' option is
7336 on spellchecking will be done for these languages. Example: >
7337 set spelllang=en_us,nl,medical
7338< This means US English, Dutch and medical words are recognized. Words
7339 that are not recognized will be highlighted.
7340 The word list name must not include a comma or dot. Using a dash is
7341 recommended to separate the two letter language name from a
7342 specification. Thus "en-rare" is used for rare English words.
7343 A region name must come last and have the form "_xx", where "xx" is
7344 the two-letter, lower case region name. You can use more than one
7345 region by listing them: "en_us,en_ca" supports both US and Canadian
7346 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007347 Britain. (Note: currently en_au and en_nz dictionaries are older than
7348 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007349 If the name "cjk" is included East Asian characters are excluded from
7350 spell checking. This is useful when editing text that also has Asian
7351 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007352 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007353 As a special case the name of a .spl file can be given as-is. The
7354 first "_xx" in the name is removed and used as the region name
7355 (_xx is an underscore, two letters and followed by a non-letter).
7356 This is mainly for testing purposes. You must make sure the correct
7357 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007358 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007359 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7360 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007361 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007362
Bram Moolenaar98692072006-02-04 00:57:42 +00007363 If the |spellfile.vim| plugin is active and you use a language name
7364 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7365 will ask you if you want to download the file.
7366
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007367 After this option has been set successfully, Vim will source the files
7368 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007369 up to the first character that is not an ASCII letter or number and
7370 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007371
7372
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007373 *'spellsuggest'* *'sps'*
7374'spellsuggest' 'sps' string (default "best")
7375 global
7376 {not in Vi}
7377 {not available when compiled without the |+syntax|
7378 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007379 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007380 the |spellsuggest()| function. This is a comma-separated list of
7381 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007382
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007383 best Internal method that works best for English. Finds
7384 changes like "fast" and uses a bit of sound-a-like
7385 scoring to improve the ordering.
7386
7387 double Internal method that uses two methods and mixes the
7388 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007389 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007390 word. That only works when the language specifies
7391 sound folding. Can be slow and doesn't always give
7392 better results.
7393
7394 fast Internal method that only checks for simple changes:
7395 character inserts/deletes/swaps. Works well for
7396 simple typing mistakes.
7397
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007398 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007399 Not used for |spellsuggest()|. The number of
7400 suggestions is never more than the value of 'lines'
7401 minus two.
7402
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007403 file:{filename} Read file {filename}, which must have two columns,
7404 separated by a slash. The first column contains the
7405 bad word, the second column the suggested good word.
7406 Example:
7407 theribal/terrible ~
7408 Use this for common mistakes that do not appear at the
7409 top of the suggestion list with the internal methods.
7410 Lines without a slash are ignored, use this for
7411 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007412 The word in the second column must be correct,
7413 otherwise it will not be used. Add the word to an
7414 ".add" file if it is currently flagged as a spelling
7415 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007416 The file is used for all languages.
7417
7418 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7419 trouble with spaces. |v:val| holds the badly spelled
7420 word. The expression must evaluate to a List of
7421 Lists, each with a suggestion and a score.
7422 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007423 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007424 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007425 internal methods use. A lower score is better.
7426 This may invoke |spellsuggest()| if you temporarily
7427 set 'spellsuggest' to exclude the "expr:" part.
7428 Errors are silently ignored, unless you set the
7429 'verbose' option to a non-zero value.
7430
7431 Only one of "best", "double" or "fast" may be used. The others may
7432 appear several times in any order. Example: >
7433 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7434<
7435 This option cannot be set from a |modeline| or in the |sandbox|, for
7436 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007437
7438
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7440'splitbelow' 'sb' boolean (default off)
7441 global
7442 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007443 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007444 feature}
7445 When on, splitting a window will put the new window below the current
7446 one. |:split|
7447
7448 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7449'splitright' 'spr' boolean (default off)
7450 global
7451 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007452 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007453 feature}
7454 When on, splitting a window will put the new window right of the
7455 current one. |:vsplit|
7456
7457 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7458'startofline' 'sol' boolean (default on)
7459 global
7460 {not in Vi}
7461 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007462 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007463 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007464 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 with a linewise operator, with "%" with a count and to buffer changing
7466 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7467 only has a line number, e.g., ":25" or ":+".
7468 In case of buffer changing commands the cursor is placed at the column
7469 where it was the last time the buffer was edited.
7470 NOTE: This option is set when 'compatible' is set.
7471
Bram Moolenaar00654022011-02-25 14:42:19 +01007472 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007474 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007475 {not in Vi}
7476 {not available when compiled without the |+statusline|
7477 feature}
7478 When nonempty, this option determines the content of the status line.
7479 Also see |status-line|.
7480
7481 The option consists of printf style '%' items interspersed with
7482 normal text. Each status line item is of the form:
7483 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007484 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007485 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486
Bram Moolenaar238a5642006-02-21 22:12:05 +00007487 When the option starts with "%!" then it is used as an expression,
7488 evaluated and the result is used as the option value. Example: >
7489 :set statusline=%!MyStatusLine()
7490< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007491 Note that the "%!" expression is evaluated in the context of the
7492 current window and buffer, while %{} items are evaluated in the
7493 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007494
7495 When there is error while evaluating the option then it will be made
7496 empty to avoid further errors. Otherwise screen updating would loop.
7497
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498 Note that the only effect of 'ruler' when this option is set (and
7499 'laststatus' is 2) is controlling the output of |CTRL-G|.
7500
7501 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007502 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007504 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 minwid Minimum width of the item, padding as set by '-' & '0'.
7506 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007507 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 on the left for text items. Numeric items will be
7509 shifted down to maxwid-2 digits followed by '>'number
7510 where number is the amount of missing digits, much like
7511 an exponential notation.
7512 item A one letter code as described below.
7513
7514 Following is a description of the possible statusline items. The
7515 second character in "item" is the type:
7516 N for number
7517 S for string
7518 F for flags as described below
7519 - not applicable
7520
7521 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007522 f S Path to the file in the buffer, as typed or relative to current
7523 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007524 F S Full path to the file in the buffer.
7525 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007526 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007528 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007530 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007532 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007533 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007534 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007536 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7538 being used: "<keymap>"
7539 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007540 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007541 B N As above, in hexadecimal.
7542 o N Byte number in file of byte under cursor, first byte is 1.
7543 Mnemonic: Offset from start of file (with one added)
7544 {not available when compiled without |+byte_offset| feature}
7545 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007546 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007547 l N Line number.
7548 L N Number of lines in buffer.
7549 c N Column number.
7550 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007551 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 p N Percentage through file in lines as in |CTRL-G|.
7553 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007554 percentage described for 'ruler'. Always 3 in length, unless
7555 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007556 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007558 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007559 Note that there is no '%' before the closing '}'. The
7560 expression cannot contain a '}' character, call a function to
7561 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 ( - Start of item group. Can be used for setting the width and
7563 alignment of a section. Must be followed by %) somewhere.
7564 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007565 T N For 'tabline': start of tab page N label. Use %T after the last
7566 label. This information is used for mouse clicks.
7567 X N For 'tabline': start of close tab N label. Use %X after the
7568 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7569 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007570 < - Where to truncate line if too long. Default is at the start.
7571 No width fields allowed.
7572 = - Separation point between left and right aligned items.
7573 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007574 # - Set highlight group. The name must follow and then a # again.
7575 Thus use %#HLname# for highlight group HLname. The same
7576 highlighting is used, also for the statusline of non-current
7577 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007579 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580 The difference between User{N} and StatusLine will be applied
7581 to StatusLineNC for the statusline of non-current windows.
7582 The number N must be between 1 and 9. See |hl-User1..9|
7583
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007584 When displaying a flag, Vim removes the leading comma, if any, when
7585 that flag comes right after plaintext. This will make a nice display
7586 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587
Bram Moolenaar582fd852005-03-28 20:58:01 +00007588 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589 not set) and a minwid is not set for the group, the whole group will
7590 become empty. This will make a group like the following disappear
7591 completely from the statusline when none of the flags are set. >
7592 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007593< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594 Beware that an expression is evaluated each and every time the status
7595 line is displayed. The current buffer and current window will be set
7596 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007597 currently being drawn. The expression will evaluate in this context.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007598 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007599 real current buffer.
7600
Bram Moolenaar30b65812012-07-12 22:01:11 +02007601 The 'statusline' option will be evaluated in the |sandbox| if set from
7602 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007603
7604 It is not allowed to change text or jump to another window while
7605 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606
7607 If the statusline is not updated when you want it (e.g., after setting
7608 a variable that's used in an expression), you can force an update by
7609 setting an option without changing its value. Example: >
7610 :let &ro = &ro
7611
7612< A result of all digits is regarded a number for display purposes.
7613 Otherwise the result is taken as flag text and applied to the rules
7614 described above.
7615
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007616 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007617 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007618 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007619
7620 Examples:
7621 Emulate standard status line with 'ruler' set >
7622 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7623< Similar, but add ASCII value of char under the cursor (like "ga") >
7624 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7625< Display byte count and byte value, modified flag in red. >
7626 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7627 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7628< Display a ,GZ flag if a compressed file is loaded >
7629 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7630< In the |:autocmd|'s: >
7631 :let b:gzflag = 1
7632< And: >
7633 :unlet b:gzflag
7634< And define this function: >
7635 :function VarExists(var, val)
7636 : if exists(a:var) | return a:val | else | return '' | endif
7637 :endfunction
7638<
7639 *'suffixes'* *'su'*
7640'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7641 global
7642 {not in Vi}
7643 Files with these suffixes get a lower priority when multiple files
7644 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007645 suffixes. Spaces after the comma are ignored. A dot is also seen as
7646 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647 separator, precede it with a backslash (see |option-backslash| about
7648 including spaces and backslashes).
7649 See 'wildignore' for completely ignoring files.
7650 The use of |:set+=| and |:set-=| is preferred when adding or removing
7651 suffixes from the list. This avoids problems when a future version
7652 uses another default.
7653
7654 *'suffixesadd'* *'sua'*
7655'suffixesadd' 'sua' string (default "")
7656 local to buffer
7657 {not in Vi}
7658 {not available when compiled without the
7659 |+file_in_path| feature}
7660 Comma separated list of suffixes, which are used when searching for a
7661 file for the "gf", "[I", etc. commands. Example: >
7662 :set suffixesadd=.java
7663<
7664 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7665'swapfile' 'swf' boolean (default on)
7666 local to buffer
7667 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007668 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007669 swapfile is not wanted for a specific buffer. For example, with
7670 confidential information that even root must not be able to access.
7671 Careful: All text will be in memory:
7672 - Don't use this for big files.
7673 - Recovery will be impossible!
7674 A swapfile will only be present when |'updatecount'| is non-zero and
7675 'swapfile' is set.
7676 When 'swapfile' is reset, the swap file for the current buffer is
7677 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7678 non-zero, a swap file is immediately created.
7679 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007680 If you want to open a new buffer without creating a swap file for it,
7681 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007682 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683
7684 This option is used together with 'bufhidden' and 'buftype' to
7685 specify special kinds of buffers. See |special-buffers|.
7686
7687 *'swapsync'* *'sws'*
7688'swapsync' 'sws' string (default "fsync")
7689 global
7690 {not in Vi}
7691 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007692 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693 When this option is empty parts of the swap file may be in memory and
7694 not written to disk. When the system crashes you may lose more work.
7695 On Unix the system does a sync now and then without Vim asking for it,
7696 so the disadvantage of setting this option off is small. On some
7697 systems the swap file will not be written at all. For a unix system
7698 setting it to "sync" will use the sync() call instead of the default
7699 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007700 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007701
7702 *'switchbuf'* *'swb'*
7703'switchbuf' 'swb' string (default "")
7704 global
7705 {not in Vi}
7706 This option controls the behavior when switching between buffers.
7707 Possible values (comma separated list):
7708 useopen If included, jump to the first open window that
7709 contains the specified buffer (if there is one).
7710 Otherwise: Do not examine other windows.
7711 This setting is checked with |quickfix| commands, when
7712 jumping to errors (":cc", ":cn", "cp", etc.). It is
7713 also used in all buffer related split commands, for
7714 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007715 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007716 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007717 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007718 a buffer for a |quickfix| command that display errors.
7719 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007720 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007721 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007722 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007724 *'synmaxcol'* *'smc'*
7725'synmaxcol' 'smc' number (default 3000)
7726 local to buffer
7727 {not in Vi}
7728 {not available when compiled without the |+syntax|
7729 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007730 Maximum column in which to search for syntax items. In long lines the
7731 text after this column is not highlighted and following lines may not
7732 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007733 This helps to avoid very slow redrawing for an XML file that is one
7734 long line.
7735 Set to zero to remove the limit.
7736
Bram Moolenaar071d4272004-06-13 20:20:40 +00007737 *'syntax'* *'syn'*
7738'syntax' 'syn' string (default empty)
7739 local to buffer
7740 {not in Vi}
7741 {not available when compiled without the |+syntax|
7742 feature}
7743 When this option is set, the syntax with this name is loaded, unless
7744 syntax highlighting has been switched off with ":syntax off".
7745 Otherwise this option does not always reflect the current syntax (the
7746 b:current_syntax variable does).
7747 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007748 not automatically recognized. Example, in an IDL file:
7749 /* vim: set syntax=idl : */ ~
7750 When a dot appears in the value then this separates two filetype
7751 names. Example:
7752 /* vim: set syntax=c.doxygen : */ ~
7753 This will use the "c" syntax first, then the "doxygen" syntax.
7754 Note that the second one must be prepared to be loaded as an addition,
7755 otherwise it will be skipped. More than one dot may appear.
7756 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757 :set syntax=OFF
7758< To switch syntax highlighting on according to the current value of the
7759 'filetype' option: >
7760 :set syntax=ON
7761< What actually happens when setting the 'syntax' option is that the
7762 Syntax autocommand event is triggered with the value as argument.
7763 This option is not copied to another buffer, independent of the 's' or
7764 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007765 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007766
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007767 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007768'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007769 global
7770 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007771 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007772 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007773 When nonempty, this option determines the content of the tab pages
7774 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007775 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007776
7777 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007778 option and only when there is no GUI tab line. When 'e' is in
7779 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007780 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007781
7782 The value is evaluated like with 'statusline'. You can use
7783 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007784 the text to be displayed. Use "%1T" for the first label, "%2T" for
7785 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007786
Bram Moolenaare12bab32019-01-08 22:02:56 +01007787 When changing something that is used in 'tabline' that does not
7788 trigger it to be updated, use |:redrawtabline|.
7789
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007790 Keep in mind that only one of the tab pages is the current one, others
7791 are invisible and you can't jump to their windows.
7792
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007793
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007794 *'tabpagemax'* *'tpm'*
7795'tabpagemax' 'tpm' number (default 10)
7796 global
7797 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007798 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007799 feature}
7800 Maximum number of tab pages to be opened by the |-p| command line
7801 argument or the ":tab all" command. |tabpage|
7802
7803
7804 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007805'tabstop' 'ts' number (default 8)
7806 local to buffer
7807 Number of spaces that a <Tab> in the file counts for. Also see
7808 |:retab| command, and 'softtabstop' option.
7809
7810 Note: Setting 'tabstop' to any other value than 8 can make your file
7811 appear wrong in many places (e.g., when printing it).
7812
7813 There are four main ways to use tabs in Vim:
7814 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7815 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007816 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817 behave like a tab appears every 4 (or 3) characters.
7818 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7819 'expandtab'. This way you will always insert spaces. The
7820 formatting will never be messed up when 'tabstop' is changed.
7821 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007822 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 works when using Vim to edit the file.
7824 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7825 'noexpandtab'. This should then work (for initial indents only)
7826 for any tabstop setting that people use. It might be nice to have
7827 tabs after the first non-blank inserted as spaces if you do this
7828 though. Otherwise aligned comments will be wrong when 'tabstop' is
7829 changed.
7830
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007831 If Vim is compiled with the |+vartabs| feature then the value of
7832 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7833 than an empty string.
7834
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7836'tagbsearch' 'tbs' boolean (default on)
7837 global
7838 {not in Vi}
7839 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007840 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007841 searching makes searching for a tag a LOT faster, but a linear search
7842 will find more tags if the tags file wasn't properly sorted.
7843 Vim normally assumes that your tags files are sorted, or indicate that
7844 they are not sorted. Only when this is not the case does the
7845 'tagbsearch' option need to be switched off.
7846
7847 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007848 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849 certain files, or retry all files with a linear search. When
7850 'tagbsearch' is off, only a linear search is done.
7851
7852 Linear searching is done anyway, for one file, when Vim finds a line
7853 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007854 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855< [The whitespace before and after the '0' must be a single <Tab>]
7856
7857 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007858 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859 instead of a normal tag name, a retry is done with a linear search.
7860 Tags in unsorted tags files, and matches with different case will only
7861 be found in the retry.
7862
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007863 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007864 linear search can be avoided when case is ignored. Use a value of '2'
7865 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7866 sorted with the -f switch to "sort" in most unices, as in the command:
7867 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7868 (at least 5.5) the --sort=foldcase switch can be used for this as
7869 well. Note that case must be folded to uppercase for this to work.
7870
7871 By default, tag searches are case-sensitive. Case is ignored when
7872 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7873 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007874 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7875 'tagcase' is "smart", and the pattern contains only lowercase
7876 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007877
7878 When 'tagbsearch' is off, tags searching is slower when a full match
7879 exists, but faster when no full match exists. Tags in unsorted tags
7880 files may only be found with 'tagbsearch' off.
7881 When the tags file is not sorted, or sorted in a wrong way (not on
7882 ASCII byte value), 'tagbsearch' should be off, or the line given above
7883 must be included in the tags file.
7884 This option doesn't affect commands that find all matching tags (e.g.,
7885 command-line completion and ":help").
7886 {Vi: always uses binary search in some versions}
7887
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007888 *'tagcase'* *'tc'*
7889'tagcase' 'tc' string (default "followic")
7890 global or local to buffer |global-local|
7891 {not in Vi}
7892 This option specifies how case is handled when searching the tags
7893 file:
7894 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007895 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007896 ignore Ignore case
7897 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007898 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007899 NOTE: This option is set to the Vi default value when 'compatible' is
7900 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007901
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 *'taglength'* *'tl'*
7903'taglength' 'tl' number (default 0)
7904 global
7905 If non-zero, tags are significant up to this number of characters.
7906
7907 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7908'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7909 global
7910 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007911 If on and using a tags file in another directory, file names in that
7912 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 NOTE: This option is set to the Vi default value when 'compatible' is
7914 set and to the Vim default value when 'compatible' is reset.
7915
7916 *'tags'* *'tag'* *E433*
7917'tags' 'tag' string (default "./tags,tags", when compiled with
7918 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7919 global or local to buffer |global-local|
7920 Filenames for the tag command, separated by spaces or commas. To
7921 include a space or comma in a file name, precede it with a backslash
7922 (see |option-backslash| about including spaces and backslashes).
7923 When a file name starts with "./", the '.' is replaced with the path
7924 of the current file. But only when the 'd' flag is not included in
7925 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7926 |tags-option|.
7927 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007928 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7929 find all files named "tags" below "/lib". The filename itself cannot
7930 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7931 files called "tags?". {not available when compiled without the
7932 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007933 The |tagfiles()| function can be used to get a list of the file names
7934 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7936 files are also supported. They are automatically recognized. The
7937 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7938 differences are ignored (MS-Windows). |emacs-tags|
7939 The use of |:set+=| and |:set-=| is preferred when adding or removing
7940 file names from the list. This avoids problems when a future version
7941 uses another default.
7942 {Vi: default is "tags /usr/lib/tags"}
7943
7944 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7945'tagstack' 'tgst' boolean (default on)
7946 global
7947 {not in all versions of Vi}
7948 When on, the |tagstack| is used normally. When off, a ":tag" or
7949 ":tselect" command with an argument will not push the tag onto the
7950 tagstack. A following ":tag" without an argument, a ":pop" command or
7951 any other command that uses the tagstack will use the unmodified
7952 tagstack, but does change the pointer to the active entry.
7953 Resetting this option is useful when using a ":tag" command in a
7954 mapping which should not change the tagstack.
7955
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007956 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007957'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007958 global
7959 {not in Vi}
7960 {only available when compiled with the |+tcl/dyn|
7961 feature}
7962 Specifies the name of the Tcl shared library. The default is
7963 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007964 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007965 This option cannot be set from a |modeline| or in the |sandbox|, for
7966 security reasons.
7967
Bram Moolenaar071d4272004-06-13 20:20:40 +00007968 *'term'* *E529* *E530* *E531*
7969'term' string (default is $TERM, if that fails:
7970 in the GUI: "builtin_gui"
7971 on Amiga: "amiga"
7972 on BeOS: "beos-ansi"
7973 on Mac: "mac-ansi"
7974 on MiNT: "vt52"
7975 on MS-DOS: "pcterm"
7976 on OS/2: "os2ansi"
7977 on Unix: "ansi"
7978 on VMS: "ansi"
7979 on Win 32: "win32")
7980 global
7981 Name of the terminal. Used for choosing the terminal control
7982 characters. Environment variables are expanded |:set_env|.
7983 For example: >
7984 :set term=$TERM
7985< See |termcap|.
7986
7987 *'termbidi'* *'tbidi'*
7988 *'notermbidi'* *'notbidi'*
7989'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7990 global
7991 {not in Vi}
7992 {only available when compiled with the |+arabic|
7993 feature}
7994 The terminal is in charge of Bi-directionality of text (as specified
7995 by Unicode). The terminal is also expected to do the required shaping
7996 that some languages (such as Arabic) require.
7997 Setting this option implies that 'rightleft' will not be set when
7998 'arabic' is set and the value of 'arabicshape' will be ignored.
7999 Note that setting 'termbidi' has the immediate effect that
8000 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8001 This option is reset when the GUI is started.
8002 For further details see |arabic.txt|.
8003
8004 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008005'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00008006 Macintosh GUI: "macroman")
8007 global
8008 {only available when compiled with the |+multi_byte|
8009 feature}
8010 {not in Vi}
8011 Encoding used for the terminal. This specifies what character
8012 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008013 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00008014 display). Except for the Mac when 'macatsui' is off, then
8015 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008016 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008017 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008018 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8019 Any attempts to set a different value will be rejected, and an error
8020 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008021 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 because the Win32 system always passes Unicode characters.
8023 When empty, the same encoding is used as for the 'encoding' option.
8024 This is the normal value.
8025 Not all combinations for 'termencoding' and 'encoding' are valid. See
8026 |encoding-table|.
8027 The value for this option must be supported by internal conversions or
8028 iconv(). When this is not possible no conversion will be done and you
8029 will probably experience problems with non-ASCII characters.
8030 Example: You are working with the locale set to euc-jp (Japanese) and
8031 want to edit a UTF-8 file: >
8032 :let &termencoding = &encoding
8033 :set encoding=utf-8
8034< You need to do this when your system has no locale support for UTF-8.
8035
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008036 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008037'termguicolors' 'tgc' boolean (default off)
8038 global
8039 {not in Vi}
8040 {not available when compiled without the
8041 |+termguicolors| feature}
8042 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008043 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008044
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008045 Requires a ISO-8613-3 compatible terminal. If setting this option
8046 does not work (produces a colorless UI) reading |xterm-true-color|
8047 might help.
8048
8049 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8050 is required. Use this check to find out: >
8051 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008052< This requires Vim to be built with the |+vtp| feature.
8053
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008054 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008055 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008056
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008057 *'termwinscroll'* *'twsl'*
8058'termwinscroll' 'twsl' number (default 10000)
8059 local to buffer
Bram Moolenaar8c041b62018-04-14 18:14:06 +02008060 {not in Vi}
8061 {not available when compiled without the
8062 |+terminal| feature}
8063 Number of scrollback lines to keep. When going over this limit the
8064 first 10% of the scrollback lines are deleted. This is just to reduce
8065 the memory usage. See |Terminal-Normal|.
8066
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008067 *'termwinkey'* *'twk'*
8068'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008069 local to window
8070 {not in Vi}
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008071 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008072 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008073 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008074 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008075< The string must be one key stroke but can be multiple bytes.
8076 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008077 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008078 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008079
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008080 *'termwinsize'* *'tws'*
8081'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008082 local to window
8083 {not in Vi}
Bram Moolenaar498c2562018-04-15 23:45:15 +02008084 Size of the |terminal| window. Format: {rows}x{columns} or
8085 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008086 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008087 - When set with a "x" (e.g., "24x80") the terminal size is not
8088 adjusted to the window size. If the window is smaller only the
8089 top-left part is displayed.
8090 - When set with a "*" (e.g., "10*50") the terminal size follows the
8091 window size, but will not be smaller than the specified rows and/or
8092 columns.
8093 - When rows is zero then use the height of the window.
8094 - When columns is zero then use the width of the window.
8095 - Using "0x0" or "0*0" is the same as empty.
8096
8097 Examples:
8098 "30x0" uses 30 rows and the current window width.
8099 "20*0" uses at least 20 rows and the current window width.
8100 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008101 Note that the command running in the terminal window may still change
8102 the size of the terminal. In that case the Vim window will be
8103 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008104
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008105 *'termwintype'* *'twt'*
8106'termwintype' 'twt' string (default "")
8107 global
8108 {not in Vi}
8109 {only available when compiled with the |terminal|
8110 feature on MS-Windows}
8111 Specify the virtual console (pty) used when opening the terminal
8112 window.
8113
8114 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008115 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008116 "winpty" use winpty, fail if not supported
8117 "conpty" use |ConPTY|, fail if not supported
8118
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008119 |ConPTY| support depends on the platform. Windows 10 October 2018
8120 Update is the first version that supports ConPTY, however it is still
8121 considered unstable. ConPTY might become stable in the next release
8122 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008123 supported then you cannot open a terminal window.
8124
Bram Moolenaar071d4272004-06-13 20:20:40 +00008125 *'terse'* *'noterse'*
8126'terse' boolean (default off)
8127 global
8128 When set: Add 's' flag to 'shortmess' option (this makes the message
8129 for a search that hits the start or end of the file not being
8130 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8131 shortens a lot of messages}
8132
8133 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8134'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8135 global
8136 {not in Vi}
8137 This option is obsolete. Use 'fileformats'.
8138 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8139 set to the default value for the current system. When 'textauto' is
8140 reset, 'fileformats' is made empty.
8141 NOTE: This option is set to the Vi default value when 'compatible' is
8142 set and to the Vim default value when 'compatible' is reset.
8143
8144 *'textmode'* *'tx'* *'notextmode'* *'notx'*
8145'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
8146 others: default off)
8147 local to buffer
8148 {not in Vi}
8149 This option is obsolete. Use 'fileformat'.
8150 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8151 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8152 "unix".
8153
8154 *'textwidth'* *'tw'*
8155'textwidth' 'tw' number (default 0)
8156 local to buffer
8157 {not in Vi}
8158 Maximum width of text that is being inserted. A longer line will be
8159 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008160 this.
8161 'textwidth' is set to 0 when the 'paste' option is set and restored
8162 when 'paste' is reset.
8163 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008165 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008166 NOTE: This option is set to 0 when 'compatible' is set.
8167
8168 *'thesaurus'* *'tsr'*
8169'thesaurus' 'tsr' string (default "")
8170 global or local to buffer |global-local|
8171 {not in Vi}
8172 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008173 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
8174
8175 Each line in the file should contain words with similar meaning,
8176 separated by non-keyword characters (white space is preferred).
8177 Maximum line length is 510 bytes.
8178
Bram Moolenaard47d5222018-12-09 20:43:55 +01008179 An English word list was added to this github issue:
8180 https://github.com/vim/vim/issues/629#issuecomment-443293282
8181 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
8182 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
8183 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008184
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008185 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008186 after a comma are ignored, otherwise spaces are included in the file
8187 name. See |option-backslash| about using backslashes.
8188 The use of |:set+=| and |:set-=| is preferred when adding or removing
8189 directories from the list. This avoids problems when a future version
8190 uses another default.
8191 Backticks cannot be used in this option for security reasons.
8192
8193 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8194'tildeop' 'top' boolean (default off)
8195 global
8196 {not in Vi}
8197 When on: The tilde command "~" behaves like an operator.
8198 NOTE: This option is reset when 'compatible' is set.
8199
8200 *'timeout'* *'to'* *'notimeout'* *'noto'*
8201'timeout' 'to' boolean (default on)
8202 global
8203 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008204'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008205 global
8206 {not in Vi}
8207 These two options together determine the behavior when part of a
8208 mapped key sequence or keyboard code has been received:
8209
8210 'timeout' 'ttimeout' action ~
8211 off off do not time out
8212 on on or off time out on :mappings and key codes
8213 off on time out on key codes
8214
8215 If both options are off, Vim will wait until either the complete
8216 mapping or key sequence has been received, or it is clear that there
8217 is no mapping or key sequence for the received characters. For
8218 example: if you have mapped "vl" and Vim has received 'v', the next
8219 character is needed to see if the 'v' is followed by an 'l'.
8220 When one of the options is on, Vim will wait for about 1 second for
8221 the next character to arrive. After that the already received
8222 characters are interpreted as single characters. The waiting time can
8223 be changed with the 'timeoutlen' option.
8224 On slow terminals or very busy systems timing out may cause
8225 malfunctioning cursor keys. If both options are off, Vim waits
8226 forever after an entered <Esc> if there are key codes that start
8227 with <Esc>. You will have to type <Esc> twice. If you do not have
8228 problems with key codes, but would like to have :mapped key
8229 sequences not timing out in 1 second, set the 'ttimeout' option and
8230 reset the 'timeout' option.
8231
8232 NOTE: 'ttimeout' is reset when 'compatible' is set.
8233
8234 *'timeoutlen'* *'tm'*
8235'timeoutlen' 'tm' number (default 1000)
8236 global
8237 {not in all versions of Vi}
8238 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008239'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008240 global
8241 {not in Vi}
8242 The time in milliseconds that is waited for a key code or mapped key
8243 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8244 when part of a command has been typed.
8245 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8246 different timeout value for key codes is desired set 'ttimeoutlen' to
8247 a non-negative number.
8248
8249 ttimeoutlen mapping delay key code delay ~
8250 < 0 'timeoutlen' 'timeoutlen'
8251 >= 0 'timeoutlen' 'ttimeoutlen'
8252
8253 The timeout only happens when the 'timeout' and 'ttimeout' options
8254 tell so. A useful setting would be >
8255 :set timeout timeoutlen=3000 ttimeoutlen=100
8256< (time out on mapping after three seconds, time out on key codes after
8257 a tenth of a second).
8258
8259 *'title'* *'notitle'*
8260'title' boolean (default off, on when title can be restored)
8261 global
8262 {not in Vi}
8263 {not available when compiled without the |+title|
8264 feature}
8265 When on, the title of the window will be set to the value of
8266 'titlestring' (if it is not empty), or to:
8267 filename [+=-] (path) - VIM
8268 Where:
8269 filename the name of the file being edited
8270 - indicates the file cannot be modified, 'ma' off
8271 + indicates the file was modified
8272 = indicates the file is read-only
8273 =+ indicates the file is read-only and modified
8274 (path) is the path of the file being edited
8275 - VIM the server name |v:servername| or "VIM"
8276 Only works if the terminal supports setting window titles
8277 (currently Amiga console, Win32 console, all GUI versions and
8278 terminals with a non- empty 't_ts' option - these are Unix xterm and
8279 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8280 *X11*
8281 When Vim was compiled with HAVE_X11 defined, the original title will
8282 be restored if possible. The output of ":version" will include "+X11"
8283 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8284 works for the icon name |'icon'|.
8285 But: When Vim was started with the |-X| argument, restoring the title
8286 will not work (except in the GUI).
8287 If the title cannot be restored, it is set to the value of 'titleold'.
8288 You might want to restore the title outside of Vim then.
8289 When using an xterm from a remote machine you can use this command:
8290 rsh machine_name xterm -display $DISPLAY &
8291 then the WINDOWID environment variable should be inherited and the
8292 title of the window should change back to what it should be after
8293 exiting Vim.
8294
8295 *'titlelen'*
8296'titlelen' number (default 85)
8297 global
8298 {not in Vi}
8299 {not available when compiled without the |+title|
8300 feature}
8301 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008302 title. When the title is longer, only the end of the path name is
8303 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008304 Using a percentage makes this adapt to the width of the window. But
8305 it won't work perfectly, because the actual number of characters
8306 available also depends on the font used and other things in the title
8307 bar. When 'titlelen' is zero the full path is used. Otherwise,
8308 values from 1 to 30000 percent can be used.
8309 'titlelen' is also used for the 'titlestring' option.
8310
8311 *'titleold'*
8312'titleold' string (default "Thanks for flying Vim")
8313 global
8314 {not in Vi}
8315 {only available when compiled with the |+title|
8316 feature}
8317 This option will be used for the window title when exiting Vim if the
8318 original title cannot be restored. Only happens if 'title' is on or
8319 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008320 This option cannot be set from a |modeline| or in the |sandbox|, for
8321 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322 *'titlestring'*
8323'titlestring' string (default "")
8324 global
8325 {not in Vi}
8326 {not available when compiled without the |+title|
8327 feature}
8328 When this option is not empty, it will be used for the title of the
8329 window. This happens only when the 'title' option is on.
8330 Only works if the terminal supports setting window titles (currently
8331 Amiga console, Win32 console, all GUI versions and terminals with a
8332 non-empty 't_ts' option).
8333 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008334 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 When this option contains printf-style '%' items, they will be
8336 expanded according to the rules used for 'statusline'.
8337 Example: >
8338 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8339 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8340< The value of 'titlelen' is used to align items in the middle or right
8341 of the available space.
8342 Some people prefer to have the file name first: >
8343 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8344< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008345 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346 separating space only when needed.
8347 NOTE: Use of special characters in 'titlestring' may cause the display
8348 to be garbled (e.g., when it contains a CR or NL character).
8349 {not available when compiled without the |+statusline| feature}
8350
8351 *'toolbar'* *'tb'*
8352'toolbar' 'tb' string (default "icons,tooltips")
8353 global
8354 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8355 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008356 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357 possible values are:
8358 icons Toolbar buttons are shown with icons.
8359 text Toolbar buttons shown with text.
8360 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008361 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362 tooltips Tooltips are active for toolbar buttons.
8363 Tooltips refer to the popup help text which appears after the mouse
8364 cursor is placed over a toolbar button for a brief moment.
8365
8366 If you want the toolbar to be shown with icons as well as text, do the
8367 following: >
8368 :set tb=icons,text
8369< Motif and Athena cannot display icons and text at the same time. They
8370 will show icons if both are requested.
8371
8372 If none of the strings specified in 'toolbar' are valid or if
8373 'toolbar' is empty, this option is ignored. If you want to disable
8374 the toolbar, you need to set the 'guioptions' option. For example: >
8375 :set guioptions-=T
8376< Also see |gui-toolbar|.
8377
8378 *'toolbariconsize'* *'tbis'*
8379'toolbariconsize' 'tbis' string (default "small")
8380 global
8381 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008382 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008384 tiny Use tiny icons.
8385 small Use small icons (default).
8386 medium Use medium-sized icons.
8387 large Use large icons.
8388 huge Use even larger icons.
8389 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008390 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008391 the current theme. Common dimensions are giant=48x48, huge=32x32,
8392 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008393
8394 If 'toolbariconsize' is empty, the global default size as determined
8395 by user preferences or the current theme is used.
8396
8397 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8398'ttybuiltin' 'tbi' boolean (default on)
8399 global
8400 {not in Vi}
8401 When on, the builtin termcaps are searched before the external ones.
8402 When off the builtin termcaps are searched after the external ones.
8403 When this option is changed, you should set the 'term' option next for
8404 the change to take effect, for example: >
8405 :set notbi term=$TERM
8406< See also |termcap|.
8407 Rationale: The default for this option is "on", because the builtin
8408 termcap entries are generally better (many systems contain faulty
8409 xterm entries...).
8410
8411 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8412'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8413 sun-cmd, screen, rxvt, dtterm or
8414 iris-ansi; also on when running Vim in
8415 a DOS console)
8416 global
8417 {not in Vi}
8418 Indicates a fast terminal connection. More characters will be sent to
8419 the screen for redrawing, instead of using insert/delete line
8420 commands. Improves smoothness of redrawing when there are multiple
8421 windows and the terminal does not support a scrolling region.
8422 Also enables the extra writing of characters at the end of each screen
8423 line for lines that wrap. This helps when using copy/paste with the
8424 mouse in an xterm and other terminals.
8425
8426 *'ttymouse'* *'ttym'*
8427'ttymouse' 'ttym' string (default depends on 'term')
8428 global
8429 {not in Vi}
8430 {only in Unix and VMS, doesn't work in the GUI; not
8431 available when compiled without |+mouse|}
8432 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008433 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008434 *xterm-mouse*
8435 xterm xterm-like mouse handling. The mouse generates
8436 "<Esc>[Mscr", where "scr" is three bytes:
8437 "s" = button state
8438 "c" = column plus 33
8439 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008440 This only works up to 223 columns! See "dec",
8441 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442 xterm2 Works like "xterm", but with the xterm reporting the
8443 mouse position while the mouse is dragged. This works
8444 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008445 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008446 work. See below for how Vim detects this
8447 automatically.
8448 *netterm-mouse*
8449 netterm NetTerm mouse handling. The mouse generates
8450 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8451 for the row and column.
8452 *dec-mouse*
8453 dec DEC terminal mouse handling. The mouse generates a
8454 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008455 This is also available for an Xterm, if it was
8456 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008457 *jsbterm-mouse*
8458 jsbterm JSB term mouse handling.
8459 *pterm-mouse*
8460 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008461 *urxvt-mouse*
8462 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008463 The mouse works only if the terminal supports this
8464 encoding style, but it does not have 223 columns limit
8465 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008466 *sgr-mouse*
8467 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008468 mouse reporting. The mouse works even in columns
8469 beyond 223. This option is backward compatible with
8470 "xterm2" because it can also decode "xterm2" style
8471 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008472
8473 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008474 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8475 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008476 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8477 recognized, if enabled at compile time. DEC terminal mouse codes
8478 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008479 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8480 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008481 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008482 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8483 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8484 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008485 Additionally, if vim is compiled with the |+termresponse| feature and
8486 |t_RV| is set to the escape sequence to request the xterm version
8487 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008488 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008489 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8490 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8491 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008492 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8493 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008494 :set t_RV=
8495<
8496 *'ttyscroll'* *'tsl'*
8497'ttyscroll' 'tsl' number (default 999)
8498 global
8499 Maximum number of lines to scroll the screen. If there are more lines
8500 to scroll the window is redrawn. For terminals where scrolling is
8501 very slow and redrawing is not slow this can be set to a small number,
8502 e.g., 3, to speed up displaying.
8503
8504 *'ttytype'* *'tty'*
8505'ttytype' 'tty' string (default from $TERM)
8506 global
8507 Alias for 'term', see above.
8508
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008509 *'undodir'* *'udir'*
8510'undodir' 'udir' string (default ".")
8511 global
8512 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008513 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008514 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008515 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008516 "." means using the directory of the file. The undo file name for
8517 "file.txt" is ".file.txt.un~".
8518 For other directories the file name is the full path of the edited
8519 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008520 When writing: The first directory that exists is used. "." always
8521 works, no directories after "." will be used for writing.
8522 When reading all entries are tried to find an undo file. The first
8523 undo file that exists is used. When it cannot be read an error is
8524 given, no further entry is used.
8525 See |undo-persistence|.
8526
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008527 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008528'undofile' 'udf' boolean (default off)
8529 local to buffer
8530 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008531 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008532 When on, Vim automatically saves undo history to an undo file when
8533 writing a buffer to a file, and restores undo history from the same
8534 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008535 The directory where the undo file is stored is specified by 'undodir'.
8536 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008537 The undo file is not read when 'undoreload' causes the buffer from
8538 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008539 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008540 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008541
Bram Moolenaar071d4272004-06-13 20:20:40 +00008542 *'undolevels'* *'ul'*
8543'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8544 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008545 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008546 {not in Vi}
8547 Maximum number of changes that can be undone. Since undo information
8548 is kept in memory, higher numbers will cause more memory to be used
8549 (nevertheless, a single change can use an unlimited amount of memory).
8550 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8551 itself: >
8552 set ul=0
8553< But you can also get Vi compatibility by including the 'u' flag in
8554 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008555 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008556 Set to -1 for no undo at all. You might want to do this only for the
8557 current buffer: >
8558 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008560
8561 The local value is set to -123456 when the global value is to be used.
8562
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008563 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008564
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008565 *'undoreload'* *'ur'*
8566'undoreload' 'ur' number (default 10000)
8567 global
8568 {not in Vi}
8569 Save the whole buffer for undo when reloading it. This applies to the
8570 ":e!" command and reloading for when the buffer changed outside of
8571 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008572 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008573 of lines is smaller than the value of this option.
8574 Set this option to zero to disable undo for a reload.
8575
8576 When saving undo for a reload, any undo file is not read.
8577
8578 Note that this causes the whole buffer to be stored in memory. Set
8579 this option to a lower value if you run out of memory.
8580
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581 *'updatecount'* *'uc'*
8582'updatecount' 'uc' number (default: 200)
8583 global
8584 {not in Vi}
8585 After typing this many characters the swap file will be written to
8586 disk. When zero, no swap file will be created at all (see chapter on
8587 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8588 Vim with the "-n" option, see |startup|. When editing in readonly
8589 mode this option will be initialized to 10000.
8590 The swapfile can be disabled per buffer with |'swapfile'|.
8591 When 'updatecount' is set from zero to non-zero, swap files are
8592 created for all buffers that have 'swapfile' set. When 'updatecount'
8593 is set to zero, existing swap files are not deleted.
8594 Also see |'swapsync'|.
8595 This option has no meaning in buffers where |'buftype'| is "nofile"
8596 or "nowrite".
8597
8598 *'updatetime'* *'ut'*
8599'updatetime' 'ut' number (default 4000)
8600 global
8601 {not in Vi}
8602 If this many milliseconds nothing is typed the swap file will be
8603 written to disk (see |crash-recovery|). Also used for the
8604 |CursorHold| autocommand event.
8605
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008606 *'varsofttabstop'* *'vsts'*
8607'varsofttabstop' 'vsts' string (default "")
8608 local to buffer
8609 {only available when compiled with the |+vartabs|
8610 feature}
8611 {not in Vi}
8612 A list of the number of spaces that a <Tab> counts for while editing,
8613 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8614 width <Tab>s are being inserted, while in fact a mixture of spaces
8615 and <Tab>s is used. Tab widths are separated with commas, with the
8616 final value applying to all subsequent tabs.
8617
8618 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008619 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008620 to use the following: >
8621 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008622< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8623 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008624
8625 Note that the value of |'softtabstop'| will be ignored while
8626 'varsofttabstop' is set.
8627
8628 *'vartabstop'* *'vts'*
8629'vartabstop' 'vts' string (default "")
8630 local to buffer
8631 {only available when compiled with the |+vartabs|
8632 feature}
8633 {not in Vi}
8634 A list of the number of spaces that a <Tab> in the file counts for,
8635 separated by commas. Each value corresponds to one tab, with the
8636 final value applying to all subsequent tabs. For example: >
8637 :set vartabstop=4,20,10,8
8638< This will make the first tab 4 spaces wide, the second 20 spaces,
8639 the third 10 spaces, and all following tabs 8 spaces.
8640
8641 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8642 is set.
8643
Bram Moolenaar071d4272004-06-13 20:20:40 +00008644 *'verbose'* *'vbs'*
8645'verbose' 'vbs' number (default 0)
8646 global
8647 {not in Vi, although some versions have a boolean
8648 verbose option}
8649 When bigger than zero, Vim will give messages about what it is doing.
8650 Currently, these messages are given:
8651 >= 1 When the viminfo file is read or written.
8652 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008653 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654 >= 8 Files for which a group of autocommands is executed.
8655 >= 9 Every executed autocommand.
8656 >= 12 Every executed function.
8657 >= 13 When an exception is thrown, caught, finished, or discarded.
8658 >= 14 Anything pending in a ":finally" clause.
8659 >= 15 Every executed Ex command (truncated at 200 characters).
8660
8661 This option can also be set with the "-V" argument. See |-V|.
8662 This option is also set by the |:verbose| command.
8663
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008664 When the 'verbosefile' option is set then the verbose messages are not
8665 displayed.
8666
8667 *'verbosefile'* *'vfile'*
8668'verbosefile' 'vfile' string (default empty)
8669 global
8670 {not in Vi}
8671 When not empty all messages are written in a file with this name.
8672 When the file exists messages are appended.
8673 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008674 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008675 Setting 'verbosefile' to a new value is like making it empty first.
8676 The difference with |:redir| is that verbose messages are not
8677 displayed when 'verbosefile' is set.
8678
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679 *'viewdir'* *'vdir'*
8680'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8681 "$VIM/vimfiles/view",
8682 for Unix: "~/.vim/view",
8683 for Macintosh: "$VIM:vimfiles:view"
8684 for VMS: "sys$login:vimfiles/view"
8685 for RiscOS: "Choices:vimfiles/view")
8686 global
8687 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008688 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008689 feature}
8690 Name of the directory where to store files for |:mkview|.
8691 This option cannot be set from a |modeline| or in the |sandbox|, for
8692 security reasons.
8693
8694 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008695'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 global
8697 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008698 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699 feature}
8700 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008701 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008702 word save and restore ~
8703 cursor cursor position in file and in window
8704 folds manually created folds, opened/closed folds and local
8705 fold options
8706 options options and mappings local to a window or buffer (not
8707 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008708 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709 slash backslashes in file names replaced with forward
8710 slashes
8711 unix with Unix end-of-line format (single <NL>), even when
8712 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008713 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008714
8715 "slash" and "unix" are useful on Windows when sharing view files
8716 with Unix. The Unix version of Vim cannot source dos format scripts,
8717 but the Windows version of Vim can source unix format scripts.
8718
8719 *'viminfo'* *'vi'* *E526* *E527* *E528*
8720'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008721 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8722 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8723 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008724 global
8725 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008726 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008727 feature}
8728 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008729 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8730 "NONE".
8731 The string should be a comma separated list of parameters, each
8732 consisting of a single character identifying the particular parameter,
8733 followed by a number or string which specifies the value of that
8734 parameter. If a particular character is left out, then the default
8735 value is used for that parameter. The following is a list of the
8736 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008737 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008738 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008739 ! When included, save and restore global variables that start
8740 with an uppercase letter, and don't contain a lowercase
8741 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008742 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008743 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008744 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 " Maximum number of lines saved for each register. Old name of
8746 the '<' item, with the disadvantage that you need to put a
8747 backslash before the ", otherwise it will be recognized as the
8748 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008749 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008750 % When included, save and restore the buffer list. If Vim is
8751 started with a file name argument, the buffer list is not
8752 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008753 buffer list is restored from the viminfo file. Quickfix
8754 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8755 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008756 When followed by a number, the number specifies the maximum
8757 number of buffers that are stored. Without a number all
8758 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008759 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760 ' Maximum number of previously edited files for which the marks
8761 are remembered. This parameter must always be included when
8762 'viminfo' is non-empty.
8763 Including this item also means that the |jumplist| and the
8764 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008765 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008766 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008767 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008768 patterns are also saved. When not included, the value of
8769 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008770 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008772 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008773 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 < Maximum number of lines saved for each register. If zero then
8775 registers are not saved. When not included, all lines are
8776 saved. '"' is the old name for this item.
8777 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008778 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008780 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008781 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782 c When included, convert the text in the viminfo file from the
8783 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008784 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008785 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 f Whether file marks need to be stored. If zero, file marks ('0
8787 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008788 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008789 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008790 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008791 h Disable the effect of 'hlsearch' when loading the viminfo
8792 file. When not included, it depends on whether ":nohlsearch"
8793 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008794 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008795 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008796 the 'n'. Must be at the end of the option! If the
8797 'viminfofile' option is set, that file name overrides the one
8798 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008799 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008800 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008801 r Removable media. The argument is a string (up to the next
8802 ','). This parameter can be given several times. Each
8803 specifies the start of a path for which no marks will be
8804 stored. This is to avoid removable media. For MS-DOS you
8805 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8806 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8807 ignored. Maximum length of each 'r' argument is 50
8808 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008809 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008810 s Maximum size of an item in Kbyte. If zero then registers are
8811 not saved. Currently only applies to registers. The default
8812 "s10" will exclude registers with more than 10 Kbyte of text.
8813 Also see the '<' item above: line count limit.
8814
8815 Example: >
8816 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8817<
8818 '50 Marks will be remembered for the last 50 files you
8819 edited.
8820 <1000 Contents of registers (up to 1000 lines each) will be
8821 remembered.
8822 s100 Registers with more than 100 Kbyte text are skipped.
8823 :0 Command-line history will not be saved.
8824 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8825 no / Since '/' is not specified, the default will be used,
8826 that is, save all of the search history, and also the
8827 previous search and substitute patterns.
8828 no % The buffer list will not be saved nor read back.
8829 no h 'hlsearch' highlighting will be restored.
8830
8831 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8832 load the contents of the file, this is not done automatically.
8833
8834 This option cannot be set from a |modeline| or in the |sandbox|, for
8835 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008836 NOTE: This option is set to the Vim default value when 'compatible'
8837 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008839 *'viminfofile'* *'vif'*
8840'viminfofile' 'vif' string (default: "")
8841 global
8842 {not in Vi}
8843 {not available when compiled without the |+viminfo|
8844 feature}
8845 When non-empty, overrides the file name used for viminfo.
8846 When equal to "NONE" no viminfo file will be read or written.
8847 This option can be set with the |-i| command line flag. The |--clean|
8848 command line flag sets it to "NONE".
8849
Bram Moolenaar071d4272004-06-13 20:20:40 +00008850 *'virtualedit'* *'ve'*
8851'virtualedit' 've' string (default "")
8852 global
8853 {not in Vi}
8854 {not available when compiled without the
8855 |+virtualedit| feature}
8856 A comma separated list of these words:
8857 block Allow virtual editing in Visual block mode.
8858 insert Allow virtual editing in Insert mode.
8859 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008860 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008861
Bram Moolenaar071d4272004-06-13 20:20:40 +00008862 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008863 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008864 of the line. Useful for selecting a rectangle in Visual mode and
8865 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008866 "onemore" is not the same, it will only allow moving the cursor just
8867 after the last character of the line. This makes some commands more
8868 consistent. Previously the cursor was always past the end of the line
8869 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008870 break some plugins or Vim scripts. For example because |l| can move
8871 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008872 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008873 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008874 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008875 It doesn't make sense to combine "all" with "onemore", but you will
8876 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008877 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008878
8879 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8880'visualbell' 'vb' boolean (default off)
8881 global
8882 {not in Vi}
Bram Moolenaar74675a62017-07-15 13:53:23 +02008883 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008884 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008885 use: >
8886 :set vb t_vb=
8887< If you want a short flash, you can use this on many terminals: >
8888 :set vb t_vb=[?5h$<100>[?5l
8889< Here $<100> specifies the time, you can use a smaller or bigger value
8890 to get a shorter or longer flash.
8891
8892 Note: Vim will limit the bell to once per half a second. This avoids
8893 having to wait for the flashing to finish when there are lots of
8894 bells, e.g. on key repeat. This also happens without 'visualbell'
8895 set.
8896
Bram Moolenaar071d4272004-06-13 20:20:40 +00008897 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8898 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8899 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008900
8901 Note: When the GUI starts, 't_vb' is reset to its default value. You
8902 might want to set it again in your |gvimrc|.
8903
Bram Moolenaar071d4272004-06-13 20:20:40 +00008904 Does not work on the Amiga, you always get a screen flash.
8905 Also see 'errorbells'.
8906
8907 *'warn'* *'nowarn'*
8908'warn' boolean (default on)
8909 global
8910 Give a warning message when a shell command is used while the buffer
8911 has been changed.
8912
8913 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8914'weirdinvert' 'wiv' boolean (default off)
8915 global
8916 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008917 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008918 It is provided for backwards compatibility with version 4.x.
8919 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8920 vice versa. Has no effect when the GUI is running.
8921
8922 *'whichwrap'* *'ww'*
8923'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8924 global
8925 {not in Vi}
8926 Allow specified keys that move the cursor left/right to move to the
8927 previous/next line when the cursor is on the first/last character in
8928 the line. Concatenate characters to allow this for these keys:
8929 char key mode ~
8930 b <BS> Normal and Visual
8931 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008932 h "h" Normal and Visual (not recommended)
8933 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008934 < <Left> Normal and Visual
8935 > <Right> Normal and Visual
8936 ~ "~" Normal
8937 [ <Left> Insert and Replace
8938 ] <Right> Insert and Replace
8939 For example: >
8940 :set ww=<,>,[,]
8941< allows wrap only when cursor keys are used.
8942 When the movement keys are used in combination with a delete or change
8943 operator, the <EOL> also counts for a character. This makes "3h"
8944 different from "3dh" when the cursor crosses the end of a line. This
8945 is also true for "x" and "X", because they do the same as "dl" and
8946 "dh". If you use this, you may also want to use the mapping
8947 ":map <BS> X" to make backspace delete the character in front of the
8948 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008949 When 'l' is included and it is used after an operator at the end of a
8950 line then it will not move to the next line. This makes "dl", "cl",
8951 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008952 NOTE: This option is set to the Vi default value when 'compatible' is
8953 set and to the Vim default value when 'compatible' is reset.
8954
8955 *'wildchar'* *'wc'*
8956'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8957 global
8958 {not in Vi}
8959 Character you have to type to start wildcard expansion in the
8960 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008961 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008962 The character is not recognized when used inside a macro. See
8963 'wildcharm' for that.
8964 Although 'wc' is a number option, you can set it to a special key: >
8965 :set wc=<Esc>
8966< NOTE: This option is set to the Vi default value when 'compatible' is
8967 set and to the Vim default value when 'compatible' is reset.
8968
8969 *'wildcharm'* *'wcm'*
8970'wildcharm' 'wcm' number (default: none (0))
8971 global
8972 {not in Vi}
8973 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008974 recognized when used inside a macro. You can find "spare" command-line
8975 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008976 you'll never actually type 'wildcharm', just use it in mappings that
8977 automatically invoke completion mode, e.g.: >
8978 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008979 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008980< Then after typing :ss you can use CTRL-P & CTRL-N.
8981
8982 *'wildignore'* *'wig'*
8983'wildignore' 'wig' string (default "")
8984 global
8985 {not in Vi}
8986 {not available when compiled without the |+wildignore|
8987 feature}
8988 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008989 patterns is ignored when expanding |wildcards|, completing file or
8990 directory names, and influences the result of |expand()|, |glob()| and
8991 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008992 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8993 Also see 'suffixes'.
8994 Example: >
8995 :set wildignore=*.o,*.obj
8996< The use of |:set+=| and |:set-=| is preferred when adding or removing
8997 a pattern from the list. This avoids problems when a future version
8998 uses another default.
8999
Bram Moolenaar94950a92010-12-02 16:01:29 +01009000
Bram Moolenaar81af9252010-12-10 20:35:50 +01009001 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009002'wildignorecase' 'wic' boolean (default off)
9003 global
9004 {not in Vi}
9005 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009006 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009007 Does not apply when the shell is used to expand wildcards, which
9008 happens when there are special characters.
9009
9010
Bram Moolenaar071d4272004-06-13 20:20:40 +00009011 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009012'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 global
9014 {not in Vi}
9015 {not available if compiled without the |+wildmenu|
9016 feature}
9017 When 'wildmenu' is on, command-line completion operates in an enhanced
9018 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
9019 the possible matches are shown just above the command line, with the
9020 first match highlighted (overwriting the status line, if there is
9021 one). Keys that show the previous/next match, such as <Tab> or
9022 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9023 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9024 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009025 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009026 If there are more matches than can fit in the line, a ">" is shown on
9027 the right and/or a "<" is shown on the left. The status line scrolls
9028 as needed.
9029 The "wildmenu" mode is abandoned when a key is hit that is not used
9030 for selecting a completion.
9031 While the "wildmenu" is active the following keys have special
9032 meanings:
9033
9034 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9035 <Down> - in filename/menu name completion: move into a
9036 subdirectory or submenu.
9037 <CR> - in menu completion, when the cursor is just after a
9038 dot: move into a submenu.
9039 <Up> - in filename/menu name completion: move up into
9040 parent directory or parent menu.
9041
9042 This makes the menus accessible from the console |console-menus|.
9043
9044 If you prefer the <Left> and <Right> keys to move the cursor instead
9045 of selecting a different match, use this: >
9046 :cnoremap <Left> <Space><BS><Left>
9047 :cnoremap <Right> <Space><BS><Right>
9048<
9049 The "WildMenu" highlighting is used for displaying the current match
9050 |hl-WildMenu|.
9051
9052 *'wildmode'* *'wim'*
9053'wildmode' 'wim' string (Vim default: "full")
9054 global
9055 {not in Vi}
9056 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009057 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009058 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009059 first part specifies the behavior for the first use of 'wildchar',
9060 The second part for the second use, etc.
9061 These are the possible values for each part:
9062 "" Complete only the first match.
9063 "full" Complete the next full match. After the last match,
9064 the original string is used and then the first match
9065 again.
9066 "longest" Complete till longest common string. If this doesn't
9067 result in a longer string, use the next part.
9068 "longest:full" Like "longest", but also start 'wildmenu' if it is
9069 enabled.
9070 "list" When more than one match, list all matches.
9071 "list:full" When more than one match, list all matches and
9072 complete first match.
9073 "list:longest" When more than one match, list all matches and
9074 complete till longest common string.
9075 When there is only a single match, it is fully completed in all cases.
9076
9077 Examples: >
9078 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009079< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 :set wildmode=longest,full
9081< Complete longest common string, then each full match >
9082 :set wildmode=list:full
9083< List all matches and complete each full match >
9084 :set wildmode=list,full
9085< List all matches without completing, then each full match >
9086 :set wildmode=longest,list
9087< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009088 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009089
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009090 *'wildoptions'* *'wop'*
9091'wildoptions' 'wop' string (default "")
9092 global
9093 {not in Vi}
9094 {not available when compiled without the |+wildignore|
9095 feature}
9096 A list of words that change how command line completion is done.
9097 Currently only one word is allowed:
9098 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009099 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009100 is displayed per line. Often used tag kinds are:
9101 d #define
9102 f function
9103 Also see |cmdline-completion|.
9104
Bram Moolenaar071d4272004-06-13 20:20:40 +00009105 *'winaltkeys'* *'wak'*
9106'winaltkeys' 'wak' string (default "menu")
9107 global
9108 {not in Vi}
9109 {only used in Win32, Motif, GTK and Photon GUI}
9110 Some GUI versions allow the access to menu entries by using the ALT
9111 key in combination with a character that appears underlined in the
9112 menu. This conflicts with the use of the ALT key for mappings and
9113 entering special characters. This option tells what to do:
9114 no Don't use ALT keys for menus. ALT key combinations can be
9115 mapped, but there is no automatic handling. This can then be
9116 done with the |:simalt| command.
9117 yes ALT key handling is done by the windowing system. ALT key
9118 combinations cannot be mapped.
9119 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009120 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009121 keys can be mapped.
9122 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9123 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009124 This option is not used for <F10>; on Win32 and with GTK <F10> will
9125 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009126
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009127 *'window'* *'wi'*
9128'window' 'wi' number (default screen height - 1)
9129 global
9130 Window height. Do not confuse this with the height of the Vim window,
9131 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00009132 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
9133 value is smaller than 'lines' minus one. The screen will scroll
9134 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009135 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9136 in a much smarter way, taking care of wrapping lines.
9137 When resizing the Vim window, the value is smaller than 1 or more than
9138 or equal to 'lines' it will be set to 'lines' minus 1.
9139 {Vi also uses the option to specify the number of displayed lines}
9140
Bram Moolenaar071d4272004-06-13 20:20:40 +00009141 *'winheight'* *'wh'* *E591*
9142'winheight' 'wh' number (default 1)
9143 global
9144 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009145 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009146 feature}
9147 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009148 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009149 focus goes to a window that is smaller, its size is increased, at the
9150 cost of the height of other windows.
9151 Set 'winheight' to a small number for normal editing.
9152 Set it to 999 to make the current window fill most of the screen.
9153 Other windows will be only 'winminheight' high. This has the drawback
9154 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9155 to create only two windows, set the option after startup is done,
9156 using the |VimEnter| event: >
9157 au VimEnter * set winheight=999
9158< Minimum value is 1.
9159 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009160 height of the current window.
9161 'winheight' applies to the current window. Use 'winminheight' to set
9162 the minimal height for other windows.
9163
9164 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9165'winfixheight' 'wfh' boolean (default off)
9166 local to window
9167 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009168 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009169 feature}
9170 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009171 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9172 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009173 The height may be changed anyway when running out of room.
9174
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009175 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9176'winfixwidth' 'wfw' boolean (default off)
9177 local to window
9178 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009179 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009180 feature}
9181 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009182 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009183 The width may be changed anyway when running out of room.
9184
Bram Moolenaar071d4272004-06-13 20:20:40 +00009185 *'winminheight'* *'wmh'*
9186'winminheight' 'wmh' number (default 1)
9187 global
9188 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009189 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009190 feature}
9191 The minimal height of a window, when it's not the current window.
9192 This is a hard minimum, windows will never become smaller.
9193 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9194 status bar) if necessary. They will return to at least one line when
9195 they become active (since the cursor has to have somewhere to go.)
9196 Use 'winheight' to set the minimal height of the current window.
9197 This option is only checked when making a window smaller. Don't use a
9198 large number, it will cause errors when opening more than a few
9199 windows. A value of 0 to 3 is reasonable.
9200
9201 *'winminwidth'* *'wmw'*
9202'winminwidth' 'wmw' number (default 1)
9203 global
9204 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009205 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009206 feature}
9207 The minimal width of a window, when it's not the current window.
9208 This is a hard minimum, windows will never become smaller.
9209 When set to zero, windows may be "squashed" to zero columns (i.e. just
9210 a vertical separator) if necessary. They will return to at least one
9211 line when they become active (since the cursor has to have somewhere
9212 to go.)
9213 Use 'winwidth' to set the minimal width of the current window.
9214 This option is only checked when making a window smaller. Don't use a
9215 large number, it will cause errors when opening more than a few
9216 windows. A value of 0 to 12 is reasonable.
9217
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009218 *'winptydll'*
9219'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9220 global
9221 {not in Vi}
9222 {only available when compiled with the |terminal|
9223 feature on MS-Windows}
9224 Specifies the name of the winpty shared library, used for the
9225 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009226 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009227 a fallback.
9228 Environment variables are expanded |:set_env|.
9229 This option cannot be set from a |modeline| or in the |sandbox|, for
9230 security reasons.
9231
Bram Moolenaar071d4272004-06-13 20:20:40 +00009232 *'winwidth'* *'wiw'* *E592*
9233'winwidth' 'wiw' number (default 20)
9234 global
9235 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009236 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009237 feature}
9238 Minimal number of columns for the current window. This is not a hard
9239 minimum, Vim will use fewer columns if there is not enough room. If
9240 the current window is smaller, its size is increased, at the cost of
9241 the width of other windows. Set it to 999 to make the current window
9242 always fill the screen. Set it to a small number for normal editing.
9243 The width is not adjusted after one of the commands to change the
9244 width of the current window.
9245 'winwidth' applies to the current window. Use 'winminwidth' to set
9246 the minimal width for other windows.
9247
9248 *'wrap'* *'nowrap'*
9249'wrap' boolean (default on)
9250 local to window
9251 {not in Vi}
9252 This option changes how text is displayed. It doesn't change the text
9253 in the buffer, see 'textwidth' for that.
9254 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009255 displaying continues on the next line. When off lines will not wrap
9256 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009257 moved to a part that is not shown, the screen will scroll
9258 horizontally.
9259 The line will be broken in the middle of a word if necessary. See
9260 'linebreak' to get the break at a word boundary.
9261 To make scrolling horizontally a bit more useful, try this: >
9262 :set sidescroll=5
9263 :set listchars+=precedes:<,extends:>
9264< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009265 This option can't be set from a |modeline| when the 'diff' option is
9266 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009267
9268 *'wrapmargin'* *'wm'*
9269'wrapmargin' 'wm' number (default 0)
9270 local to buffer
9271 Number of characters from the right window border where wrapping
9272 starts. When typing text beyond this limit, an <EOL> will be inserted
9273 and inserting continues on the next line.
9274 Options that add a margin, such as 'number' and 'foldcolumn', cause
9275 the text width to be further reduced. This is Vi compatible.
9276 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009277 This option is set to 0 when 'paste' is set and restored when 'paste'
9278 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009279 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
9280 and less usefully}
9281
9282 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9283'wrapscan' 'ws' boolean (default on) *E384* *E385*
9284 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009285 Searches wrap around the end of the file. Also applies to |]s| and
9286 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009287
9288 *'write'* *'nowrite'*
9289'write' boolean (default on)
9290 global
9291 {not in Vi}
9292 Allows writing files. When not set, writing a file is not allowed.
9293 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009294 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009295 argument. Filtering text is still possible, even though this requires
9296 writing a temporary file.
9297
9298 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9299'writeany' 'wa' boolean (default off)
9300 global
9301 Allows writing to any file with no need for "!" override.
9302
9303 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9304'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9305 otherwise)
9306 global
9307 {not in Vi}
9308 Make a backup before overwriting a file. The backup is removed after
9309 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009310 also on.
9311 WARNING: Switching this option off means that when Vim fails to write
9312 your buffer correctly and then, for whatever reason, Vim exits, you
9313 lose both the original file and what you were writing. Only reset
9314 this option if your file system is almost full and it makes the write
9315 fail (and make sure not to exit Vim until the write was successful).
9316 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009317 When the 'backupskip' pattern matches, a backup is not made anyway.
9318 NOTE: This option is set to the default value when 'compatible' is
9319 set.
9320
9321 *'writedelay'* *'wd'*
9322'writedelay' 'wd' number (default 0)
9323 global
9324 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009325 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009326 screen. When non-zero, characters are sent to the terminal one by
9327 one. For MS-DOS pcterm this does not work. For debugging purposes.
9328
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009329 vim:tw=78:ts=8:noet:ft=help:norl: