blob: 691a8b68baa61467ec3cc4542bf00188f5f46885 [file] [log] [blame]
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001*options.txt* For Vim version 8.1. Last change: 2019 May 08
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
Bram Moolenaar6c60f472019-04-28 16:00:35 +020045:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000046
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049 current value of 'compatible'.
50:se[t] {option}&vi Reset option to its Vi default value.
51:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000052
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.
Bram Moolenaar071d4272004-06-13 20:20:40 +000065
66 *:set-args* *E487* *E521*
67:se[t] {option}={value} or
68:se[t] {option}:{value}
69 Set string or number option to {value}.
70 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010071 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000072 The old value can be inserted by typing 'wildchar' (by
73 default this is a <Tab> or CTRL-E if 'compatible' is
74 set). See |cmdline-completion|.
75 White space between {option} and '=' is allowed and
76 will be ignored. White space between '=' and {value}
77 is not allowed.
78 See |option-backslash| for using white space and
79 backslashes in {value}.
80
81:se[t] {option}+={value} *:set+=*
82 Add the {value} to a number option, or append the
83 {value} to a string option. When the option is a
84 comma separated list, a comma is added, unless the
85 value was empty.
86 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000087 are removed. When adding a flag that was already
88 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000089 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000090
91:se[t] {option}^={value} *:set^=*
92 Multiply the {value} to a number option, or prepend
93 the {value} to a string option. When the option is a
94 comma separated list, a comma is added, unless the
95 value was empty.
96 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000097
98:se[t] {option}-={value} *:set-=*
99 Subtract the {value} from a number option, or remove
100 the {value} from a string option, if it is there.
101 If the {value} is not found in a string option, there
102 is no error or warning. When the option is a comma
103 separated list, a comma is deleted, unless the option
104 becomes empty.
105 When the option is a list of flags, {value} must be
106 exactly as they appear in the option. Remove flags
107 one by one to avoid problems.
108 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109
110The {option} arguments to ":set" may be repeated. For example: >
111 :set ai nosi sw=3 ts=3
112If you make an error in one of the arguments, an error message will be given
113and the following arguments will be ignored.
114
115 *:set-verbose*
116When 'verbose' is non-zero, displaying an option value will also tell where it
117was last set. Example: >
118 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200119< shiftwidth=4 ~
120 Last set from modeline line 1 ~
121 cindent ~
122 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123This is only done when specific option values are requested, not for ":verbose
124set all" or ":verbose set" without an argument.
125When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000126When the option was set while executing a function, user command or
127autocommand, the script in which it was defined is reported.
128Note that an option may also have been set as a side effect of setting
129'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000130A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200131 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000132 Option was set in a |modeline|.
133 Last set from --cmd argument ~
134 Option was set with command line argument |--cmd| or +.
135 Last set from -c argument ~
136 Option was set with command line argument |-c|, +, |-S| or
137 |-q|.
138 Last set from environment variable ~
139 Option was set from an environment variable, $VIMINIT,
140 $GVIMINIT or $EXINIT.
141 Last set from error handler ~
142 Option was cleared when evaluating it resulted in an error.
143
Bram Moolenaardb84e452010-08-15 13:50:43 +0200144{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145
146 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000147For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148override the value from the termcap. You can then use it in a mapping. If
149the "xx" part contains special characters, use the <t_xx> form: >
150 :set <t_#4>=^[Ot
151This can also be used to translate a special code for a normal key. For
152example, if Alt-b produces <Esc>b, use this: >
153 :set <M-b>=^[b
154(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
155The advantage over a mapping is that it works in all situations.
156
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100157You can define any key codes, e.g.: >
158 :set t_xy=^[foo;
159There is no warning for using a name that isn't recognized. You can map these
160codes as you like: >
161 :map <t_xy> something
162< *E846*
163When a key code is not set, it's like it does not exist. Trying to get its
164value will result in an error: >
165 :set t_kb=
166 :set t_kb
167 E846: Key code not set: t_kb
168
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000169The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
170security reasons.
171
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000173at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174"set all" probably does not fit on the screen, causing Vim to give the
175|more-prompt|.
176
177 *option-backslash*
178To include white space in a string option value it has to be preceded with a
179backslash. To include a backslash you have to use two. Effectively this
180means that the number of backslashes in an option value is halved (rounded
181down).
182A few examples: >
183 :set tags=tags\ /usr/tags results in "tags /usr/tags"
184 :set tags=tags\\,file results in "tags\,file"
185 :set tags=tags\\\ file results in "tags\ file"
186
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000187The "|" character separates a ":set" command from a following command. To
188include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189'titlestring' option to "hi|there": >
190 :set titlestring=hi\|there
191This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
192 :set titlestring=hi|set iconstring=there
193
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000194Similarly, the double quote character starts a comment. To include the '"' in
195the option value, use '\"' instead. This example sets the 'titlestring'
196option to 'hi "there"': >
197 :set titlestring=hi\ \"there\"
198
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000199For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200precise: For options that expect a file name (those where environment
201variables are expanded) a backslash before a normal file name character is not
202removed. But a backslash before a special character (space, backslash, comma,
203etc.) is used like explained above.
204There is one special situation, when the value starts with "\\": >
205 :set dir=\\machine\path results in "\\machine\path"
206 :set dir=\\\\machine\\path results in "\\machine\path"
207 :set dir=\\path\\file results in "\\path\file" (wrong!)
208For the first one the start is kept, but for the second one the backslashes
209are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000210halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211result which is probably not what you want. Avoid it.
212
213 *add-option-flags* *remove-option-flags*
214 *E539* *E550* *E551* *E552*
215Some options are a list of flags. When you want to add a flag to such an
216option, without changing the existing ones, you can do it like this: >
217 :set guioptions+=a
218Remove a flag from an option like this: >
219 :set guioptions-=a
220This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000221Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
223doesn't appear.
224
225 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000226Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227environment variable exists the '$' and the following environment variable
228name is replaced with its value. If it does not exist the '$' and the name
229are not modified. Any non-id character (not a letter, digit or '_') may
230follow the environment variable name. That character and what follows is
231appended to the value of the environment variable. Examples: >
232 :set term=$TERM.new
233 :set path=/usr/$INCLUDE,$HOME/include,.
234When adding or removing a string from an option with ":set opt-=val" or ":set
235opt+=val" the expansion is done before the adding or removing.
236
237
238Handling of local options *local-options*
239
240Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100241has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242allows you to set 'list' in one window but not in another. And set
243'shiftwidth' to 3 in one buffer and 4 in another.
244
245The following explains what happens to these local options in specific
246situations. You don't really need to know all of this, since Vim mostly uses
247the option values you would expect. Unfortunately, doing what the user
248expects is a bit complicated...
249
250When splitting a window, the local options are copied to the new window. Thus
251right after the split the contents of the two windows look the same.
252
253When editing a new buffer, its local option values must be initialized. Since
254the local options of the current buffer might be specifically for that buffer,
255these are not used. Instead, for each buffer-local option there also is a
256global value, which is used for new buffers. With ":set" both the local and
257global value is changed. With "setlocal" only the local value is changed,
258thus this value is not used when editing a new buffer.
259
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200260When editing a buffer that has been edited before, the options from the window
261that was last closed are used again. If this buffer has been edited in this
262window, the values from back then are used. Otherwise the values from the
263last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264
265It's possible to set a local window option specifically for a type of buffer.
266When you edit another buffer in the same window, you don't want to keep
267using these local window options. Therefore Vim keeps a global value of the
268local window options, which is used when editing another buffer. Each window
269has its own copy of these values. Thus these are local to the window, but
270global to all buffers in the window. With this you can do: >
271 :e one
272 :set list
273 :e two
274Now the 'list' option will also be set in "two", since with the ":set list"
275command you have also set the global value. >
276 :set nolist
277 :e one
278 :setlocal list
279 :e two
280Now the 'list' option is not set, because ":set nolist" resets the global
281value, ":setlocal list" only changes the local value and ":e two" gets the
282global value. Note that if you do this next: >
283 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200284You will get back the 'list' value as it was the last time you edited "one".
285The options local to a window are remembered for each buffer. This also
286happens when the buffer is not loaded, but they are lost when the buffer is
287wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000288
289 *:setl* *:setlocal*
290:setl[ocal] ... Like ":set" but set only the value local to the
291 current buffer or window. Not all options have a
292 local value. If the option does not have a local
293 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200294 With the "all" argument: display local values for all
295 local options.
296 Without argument: Display local values for all local
297 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000299 local value. For a global/local boolean option, when
300 the global value is being used, "--" is displayed
301 before the option name.
302 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000305:setl[ocal] {option}< Set the local value of {option} to its global value by
306 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000307
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100308:se[t] {option}< For |global-local| options: Remove the local value of
309 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310
311 *:setg* *:setglobal*
312:setg[lobal] ... Like ":set" but set only the global value for a local
313 option without changing the local value.
314 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200315 With the "all" argument: display global values for all
316 local options.
317 Without argument: display global values for all local
318 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319
320For buffer-local and window-local options:
321 Command global value local value ~
322 :set option=value set set
323 :setlocal option=value - set
324:setglobal option=value set -
325 :set option? - display
326 :setlocal option? - display
327:setglobal option? display -
328
329
330Global options with a local value *global-local*
331
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000332Options are global when you mostly use one value for all buffers and windows.
333For some global options it's useful to sometimes have a different local value.
334You can set the local value with ":setlocal". That buffer or window will then
335use the local value, while other buffers and windows continue using the global
336value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337
338For example, you have two windows, both on C source code. They use the global
339'makeprg' option. If you do this in one of the two windows: >
340 :set makeprg=gmake
341then the other window will switch to the same value. There is no need to set
342the 'makeprg' option in the other C source window too.
343However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000344another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000345files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346 :setlocal makeprg=perlmake
347You can switch back to using the global value by making the local value empty: >
348 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100349This only works for a string option. For a number or boolean option you need
350to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100352Note that for non-boolean and non-number options using "<" copies the global
353value to the local value, it doesn't switch back to using the global value
354(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000355 :set path<
356This will make the local value of 'path' empty, so that the global value is
357used. Thus it does the same as: >
358 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359Note: In the future more global options can be made global-local. Using
360":setlocal" on a global option might work differently then.
361
362
363Setting the filetype
364
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200365:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366 Set the 'filetype' option to {filetype}, but only if
367 not done yet in a sequence of (nested) autocommands.
368 This is short for: >
369 :if !did_filetype()
370 : setlocal filetype={filetype}
371 :endif
372< This command is used in a filetype.vim file to avoid
373 setting the 'filetype' option twice, causing different
374 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200375
376 When the optional FALLBACK argument is present, a
377 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100378 'filetype'. This is to be used for filetype
379 detections that are just a guess. |did_filetype()|
380 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200381
Bram Moolenaard58e9292011-02-09 17:07:58 +0100382 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
384:opt[ions] Open a window for viewing and setting all options.
385 Options are grouped by function.
386 Offers short help for each option. Hit <CR> on the
387 short help to open a help window with more help for
388 the option.
389 Modify the value of the option and hit <CR> on the
390 "set" line to set the new value. For window and
391 buffer specific options, the last accessed window is
392 used to set the option value in, unless this is a help
393 window, in which case the window below help window is
394 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100395 {not available when compiled without the |+eval|
396 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397
398 *$HOME*
399Using "~" is like using "$HOME", but it is only recognized at the start of an
400option and after a space or comma.
401
402On Unix systems "~user" can be used too. It is replaced by the home directory
403of user "user". Example: >
404 :set path=~mool/include,/usr/include,.
405
406On Unix systems the form "${HOME}" can be used too. The name between {} can
407contain non-id characters then. Note that if you want to use this for the
408"gf" command, you need to add the '{' and '}' characters to 'isfname'.
409
410NOTE: expanding environment variables and "~/" is only done with the ":set"
411command, not when assigning a value to an option with ":let".
412
Bram Moolenaarc572da52017-08-27 16:52:01 +0200413 *$HOME-windows*
414On MS-Windows, if $HOME is not defined as an environment variable, then
415at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200416If $HOMEDRIVE is not set then $USERPROFILE is used.
417
418This expanded value is not exported to the environment, this matters when
419running an external command: >
420 :echo system('set | findstr ^HOME=')
421and >
422 :echo luaeval('os.getenv("HOME")')
423should echo nothing (an empty string) despite exists('$HOME') being true.
424When setting $HOME to a non-empty string it will be exported to the
425subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200426
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427
428Note the maximum length of an expanded option is limited. How much depends on
429the system, mostly it is something like 256 or 1024 characters.
430
431 *:fix* *:fixdel*
432:fix[del] Set the value of 't_kD':
433 't_kb' is 't_kD' becomes ~
434 CTRL-? CTRL-H
435 not CTRL-? CTRL-?
436
Bram Moolenaar6c60f472019-04-28 16:00:35 +0200437 (CTRL-? is 0177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438
439 If your delete key terminal code is wrong, but the
440 code for backspace is alright, you can put this in
441 your .vimrc: >
442 :fixdel
443< This works no matter what the actual code for
444 backspace is.
445
446 If the backspace key terminal code is wrong you can
447 use this: >
448 :if &term == "termname"
449 : set t_kb=^V<BS>
450 : fixdel
451 :endif
452< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000453 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454 with your terminal name.
455
456 If your <Delete> key sends a strange key sequence (not
457 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
458 :if &term == "termname"
459 : set t_kD=^V<Delete>
460 :endif
461< Where "^V" is CTRL-V and "<Delete>" is the delete key
462 (don't type eight characters!). Replace "termname"
463 with your terminal name.
464
465 *Linux-backspace*
466 Note about Linux: By default the backspace key
467 produces CTRL-?, which is wrong. You can fix it by
468 putting this line in your rc.local: >
469 echo "keycode 14 = BackSpace" | loadkeys
470<
471 *NetBSD-backspace*
472 Note about NetBSD: If your backspace doesn't produce
473 the right code, try this: >
474 xmodmap -e "keycode 22 = BackSpace"
475< If this works, add this in your .Xmodmap file: >
476 keysym 22 = BackSpace
477< You need to restart for this to take effect.
478
479==============================================================================
4802. Automatically setting options *auto-setting*
481
482Besides changing options with the ":set" command, there are three alternatives
483to set options automatically for one or more files:
484
4851. When starting Vim initializations are read from various places. See
486 |initialization|. Most of them are performed for all editing sessions,
487 and some of them depend on the directory where Vim is started.
488 You can create an initialization file with |:mkvimrc|, |:mkview| and
489 |:mksession|.
4902. If you start editing a new file, the automatic commands are executed.
491 This can be used to set options for files matching a particular pattern and
492 many other things. See |autocommand|.
4933. If you start editing a new file, and the 'modeline' option is on, a
494 number of lines at the beginning and end of the file are checked for
495 modelines. This is explained here.
496
497 *modeline* *vim:* *vi:* *ex:* *E520*
498There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200499 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200501[text] any text or empty
502{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200504[white] optional white space
505{options} a list of option settings, separated with white space
506 or ':', where each part between ':' is the argument
507 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar14b69452013-06-29 23:05:20 +0200509Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000510 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200511 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000512
513The second form (this is compatible with some versions of Vi):
514
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200515 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000516
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200517[text] any text or empty
518{white} at least one blank character (<Space> or <Tab>)
519{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
520[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200521se[t] the string "set " or "se " (note the space); When
522 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200523{options} a list of options, separated with white space, which
524 is the argument for a ":set" command
525: a colon
526[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527
Bram Moolenaar14b69452013-06-29 23:05:20 +0200528Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000529 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200530 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000531
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200532The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
533chance that a normal word like "lex:" is caught. There is one exception:
534"vi:" and "vim:" can also be at the start of the line (for compatibility with
535version 3.0). Using "ex:" at the start of the line will be ignored (this
536could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538 *modeline-local*
539The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000540buffer and window that contain the file. Although it's possible to set global
541options from a modeline, this is unusual. If you have two windows open and
542the files in it set the same global option to a different value, the result
543depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000545When editing a file that was already loaded, only the window-local options
546from the modeline are used. Thus if you manually changed a buffer-local
547option after opening the file, it won't be changed if you edit the same buffer
548in another window. But window-local options will be set.
549
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 *modeline-version*
551If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200552number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553 vim{vers}: version {vers} or later
554 vim<{vers}: version before {vers}
555 vim={vers}: version {vers}
556 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100557{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
558For example, to use a modeline only for Vim 7.0:
559 /* vim700: set foldmethod=marker */ ~
560To use a modeline for Vim after version 7.2:
561 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562There can be no blanks between "vim" and the ":".
563
564
565The number of lines that are checked can be set with the 'modelines' option.
566If 'modeline' is off or 'modelines' is 0 no lines are checked.
567
568Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000569like:
570 /* vi:ts=4: */ ~
571will give an error message for the trailing "*/". This line is OK:
572 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573
574If an error is detected the rest of the line is skipped.
575
576If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000577backslash in front of the ':' will be removed. Example:
578 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579This sets the 'dir' option to "c:\tmp". Only a single backslash before the
580':' is removed. Thus to include "\:" you have to specify "\\:".
581
582No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000583might create a Trojan horse text file with modelines). And not all options
584can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000585|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000586causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
587are wrapped unexpectedly. So disable modelines before editing untrusted text.
588The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589
590Hint: If you would like to do something else than setting an option, you could
591define an autocommand that checks the file for a specific string. For
592example: >
593 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
594And define a function SetVar() that does something with the line containing
595"VAR".
596
597==============================================================================
5983. Options summary *option-summary*
599
600In the list below all the options are mentioned with their full name and with
601an abbreviation if there is one. Both forms may be used.
602
603In this document when a boolean option is "set" that means that ":set option"
604is entered. When an option is "reset", ":set nooption" is used.
605
606For some options there are two default values: The "Vim default", which is
607used when 'compatible' is not set, and the "Vi default", which is used when
608'compatible' is set.
609
610Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000611are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612different value in each window. For example the 'list' option can be set in
613one window and reset in another for the same text, giving both types of view
614at the same time. There are a few options that are specific to a certain
615file. These can have a different value for each file or buffer. For example
616the 'textwidth' option can be 78 for a normal text file and 0 for a C
617program.
618
619 global one option for all buffers and windows
620 local to window each window has its own copy of this option
621 local to buffer each buffer has its own copy of this option
622
623When creating a new window the option values from the currently active window
624are used as a default value for the window-specific options. For the
625buffer-specific options this depends on the 's' and 'S' flags in the
626'cpoptions' option. If 's' is included (which is the default) the values for
627buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000628first entered. If 'S' is present the options are copied each time the buffer
629is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630present, the options are copied from the currently active buffer when the
631buffer is created.
632
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000633Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000634
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000635Not all options are supported in all versions. This depends on the supported
636features and sometimes on the system. A remark about this is in curly braces
637below. When an option is not supported it may still be set without getting an
638error, this is called a hidden option. You can't get the value of a hidden
639option though, it is not stored.
640
641To test if option "foo" can be used with ":set" use something like this: >
642 if exists('&foo')
643This also returns true for a hidden option. To test if option "foo" is really
644supported use something like this: >
645 if exists('+foo')
646<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647 *E355*
648A jump table for the options with a short description can be found at |Q_op|.
649
650 *'aleph'* *'al'* *aleph* *Aleph*
651'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
652 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653 {only available when compiled with the |+rightleft|
654 feature}
655 The ASCII code for the first letter of the Hebrew alphabet. The
656 routine that maps the keyboard in Hebrew mode, both in Insert mode
657 (when hkmap is set) and on the command-line (when hitting CTRL-_)
658 outputs the Hebrew characters in the range [aleph..aleph+26].
659 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
660 See |rileft.txt|.
661
662 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
663'allowrevins' 'ari' boolean (default off)
664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665 {only available when compiled with the |+rightleft|
666 feature}
667 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
668 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
669 into reverse Insert mode, and don't know how to get out. See
670 'revins'.
671 NOTE: This option is reset when 'compatible' is set.
672
673 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
674'altkeymap' 'akm' boolean (default off)
675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 {only available when compiled with the |+farsi|
677 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100678 This option was for using Farsi, which has been removed. See
679 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680
681 *'ambiwidth'* *'ambw'*
682'ambiwidth' 'ambw' string (default: "single")
683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
685 Tells Vim what to do with characters with East Asian Width Class
686 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
687 letters, Cyrillic letters).
688
689 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000690 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691 expected by most users.
692 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200693 *E834* *E835*
694 The value "double" cannot be used if 'listchars' or 'fillchars'
695 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696
697 There are a number of CJK fonts for which the width of glyphs for
698 those characters are solely based on how many octets they take in
699 legacy/traditional CJK encodings. In those encodings, Euro,
700 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000701 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000702 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000703 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000704 Vim is running inside a terminal (emulators) that uses a CJK font
705 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
706 this option should be set to "double" to match the width perceived
707 by Vim with the width of glyphs in the font. Perhaps it also has
708 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
709 when the system locale is set to one of CJK locales. See Unicode
710 Standard Annex #11 (http://www.unicode.org/reports/tr11).
711
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100712 Vim may set this option automatically at startup time when Vim is
713 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200714 escape sequence to request cursor position report. The response can
715 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100716
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
718'antialias' 'anti' boolean (default: off)
719 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 {only available when compiled with GUI enabled
721 on Mac OS X}
722 This option only has an effect in the GUI version of Vim on Mac OS X
723 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
724 which can be easier to read at certain sizes on certain displays.
725 Setting this option can sometimes cause problems if 'guifont' is set
726 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100727 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728
729 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
730'autochdir' 'acd' boolean (default off)
731 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200732 {only available when compiled with it, use
733 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000734 When on, Vim will change the current working directory whenever you
735 open a file, switch buffers, delete a buffer or open/close a window.
736 It will change to the directory containing the file which was opened
737 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000738 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739
740 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
741'arabic' 'arab' boolean (default off)
742 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743 {only available when compiled with the |+arabic|
744 feature}
745 This option can be set to start editing Arabic text.
746 Setting this option will:
747 - Set the 'rightleft' option, unless 'termbidi' is set.
748 - Set the 'arabicshape' option, unless 'termbidi' is set.
749 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
750 between typing English and Arabic key mapping.
751 - Set the 'delcombine' option
752 Note that 'encoding' must be "utf-8" for working with Arabic text.
753
754 Resetting this option will:
755 - Reset the 'rightleft' option.
756 - Disable the use of 'keymap' (without changing its value).
757 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200758 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100759 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760 Also see |arabic.txt|.
761
762 *'arabicshape'* *'arshape'*
763 *'noarabicshape'* *'noarshape'*
764'arabicshape' 'arshape' boolean (default on)
765 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766 {only available when compiled with the |+arabic|
767 feature}
768 When on and 'termbidi' is off, the required visual character
769 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200770 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771 one which encompasses:
772 a) the changing/morphing of characters based on their location
773 within a word (initial, medial, final and stand-alone).
774 b) the enabling of the ability to compose characters
775 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100776 When disabled the display shows each character's true stand-alone
777 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778 Arabic is a complex language which requires other settings, for
779 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100780 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781
782 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
783'autoindent' 'ai' boolean (default off)
784 local to buffer
785 Copy indent from current line when starting a new line (typing <CR>
786 in Insert mode or when using the "o" or "O" command). If you do not
787 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000788 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
789 to another line has the same effect, unless the 'I' flag is included
790 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000791 When autoindent is on, formatting (with the "gq" command or when you
792 reach 'textwidth' in Insert mode) uses the indentation of the first
793 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794 When 'smartindent' or 'cindent' is on the indent is changed in
795 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200796 The 'autoindent' option is reset when the 'paste' option is set and
797 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798
799 *'autoread'* *'ar'* *'noautoread'* *'noar'*
800'autoread' 'ar' boolean (default off)
801 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802 When a file has been detected to have been changed outside of Vim and
803 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200804 When the file has been deleted this is not done, so you have the text
805 from before it was deleted. When it appears again then it is read.
806 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807 If this option has a local value, use this command to switch back to
808 using the global value: >
809 :set autoread<
810<
811 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
812'autowrite' 'aw' boolean (default off)
813 global
814 Write the contents of the file, if it has been modified, on each
815 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000816 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
818 Note that for some commands the 'autowrite' option is not used, see
819 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200820 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200821 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822
823 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
824'autowriteall' 'awa' boolean (default off)
825 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
827 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
828 Setting this option also implies that Vim behaves like 'autowrite' has
829 been set.
830
831 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200832'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834 When set to "dark", Vim will try to use colors that look good on a
835 dark background. When set to "light", Vim will try to use colors that
836 look good on a light background. Any other value is illegal.
837 Vim tries to set the default value according to the terminal used.
838 This will not always be correct.
839 Setting this option does not change the background color, it tells Vim
840 what the background color looks like. For changing the background
841 color, see |:hi-normal|.
842
843 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000844 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000845 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100846 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847 setting 'background' will cause the color scheme to be reloaded. If
848 the color scheme adjusts to the value of 'background' this will work.
849 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100850 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851
852 When setting 'background' to the default value with: >
853 :set background&
854< Vim will guess the value. In the GUI this should work correctly,
855 in other cases Vim might not be able to guess the right value.
856
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200857 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200858 color from the terminal. If the returned RGB value is dark/light and
859 'background' is not dark/light, 'background' will be set and the
860 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200861 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100862 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200863
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 When starting the GUI, the default value for 'background' will be
865 "light". When the value is not set in the .gvimrc, and Vim detects
866 that the background is actually quite dark, 'background' is set to
867 "dark". But this happens only AFTER the .gvimrc file has been read
868 (because the window needs to be opened to find the actual background
869 color). To get around this, force the GUI window to be opened by
870 putting a ":gui" command in the .gvimrc file, before where the value
871 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200872
873 For MS-DOS, Windows and OS/2 the default is "dark".
874 For other systems "dark" is used when 'term' is "linux",
875 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
876 background. Otherwise the default is "light".
877
Bram Moolenaarc572da52017-08-27 16:52:01 +0200878 The |:terminal| command and the |term_start()| function use the
879 'background' value to decide whether the terminal window will start
880 with a white or black background.
881
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 Normally this option would be set in the .vimrc file. Possibly
883 depending on the terminal name. Example: >
884 :if &term == "pcterm"
885 : set background=dark
886 :endif
887< When this option is set, the default settings for the highlight groups
888 will change. To use other settings, place ":highlight" commands AFTER
889 the setting of the 'background' option.
890 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
891 to select the colors for syntax highlighting. After changing this
892 option, you must load syntax.vim again to see the result. This can be
893 done with ":syntax on".
894
895 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200896'backspace' 'bs' string (default "", set to "indent,eol,start"
897 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
900 mode. This is a list of items, separated by commas. Each item allows
901 a way to backspace over something:
902 value effect ~
903 indent allow backspacing over autoindent
904 eol allow backspacing over line breaks (join lines)
905 start allow backspacing over the start of insert; CTRL-W and CTRL-U
906 stop once at the start of insert.
907
908 When the value is empty, Vi compatible backspacing is used.
909
910 For backwards compatibility with version 5.4 and earlier:
911 value effect ~
912 0 same as ":set backspace=" (Vi compatible)
913 1 same as ":set backspace=indent,eol"
914 2 same as ":set backspace=indent,eol,start"
915
916 See |:fixdel| if your <BS> or <Del> key does not do what you want.
917 NOTE: This option is set to "" when 'compatible' is set.
918
919 *'backup'* *'bk'* *'nobackup'* *'nobk'*
920'backup' 'bk' boolean (default off)
921 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 Make a backup before overwriting a file. Leave it around after the
923 file has been successfully written. If you do not want to keep the
924 backup file, but you do want a backup while the file is being
925 written, reset this option and set the 'writebackup' option (this is
926 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000927 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928 |backup-table| for more explanations.
929 When the 'backupskip' pattern matches, a backup is not made anyway.
930 When 'patchmode' is set, the backup may be renamed to become the
931 oldest version of a file.
932 NOTE: This option is reset when 'compatible' is set.
933
934 *'backupcopy'* *'bkc'*
935'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200936 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 When writing a file and a backup is made, this option tells how it's
938 done. This is a comma separated list of words.
939
940 The main values are:
941 "yes" make a copy of the file and overwrite the original one
942 "no" rename the file and write a new one
943 "auto" one of the previous, what works best
944
945 Extra values that can be combined with the ones above are:
946 "breaksymlink" always break symlinks when writing
947 "breakhardlink" always break hardlinks when writing
948
949 Making a copy and overwriting the original file:
950 - Takes extra time to copy the file.
951 + When the file has special attributes, is a (hard/symbolic) link or
952 has a resource fork, all this is preserved.
953 - When the file is a link the backup will have the name of the link,
954 not of the real file.
955
956 Renaming the file and writing a new one:
957 + It's fast.
958 - Sometimes not all attributes of the file can be copied to the new
959 file.
960 - When the file is a link the new file will not be a link.
961
962 The "auto" value is the middle way: When Vim sees that renaming file
963 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000964 the file is not a link) that is used. When problems are expected, a
965 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966
967 The "breaksymlink" and "breakhardlink" values can be used in
968 combination with any of "yes", "no" and "auto". When included, they
969 force Vim to always break either symbolic or hard links by doing
970 exactly what the "no" option does, renaming the original file to
971 become the backup and writing a new file in its place. This can be
972 useful for example in source trees where all the files are symbolic or
973 hard links and any changes should stay in the local source tree, not
974 be propagated back to the original source.
975 *crontab*
976 One situation where "no" and "auto" will cause problems: A program
977 that opens a file, invokes Vim to edit that file, and then tests if
978 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000979 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000980 example.
981
982 When a copy is made, the original file is truncated and then filled
983 with the new text. This means that protection bits, owner and
984 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000985 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986 group of the backup is set to the group of the original file. If this
987 fails, the protection bits for the group are made the same as for
988 others.
989
990 When the file is renamed this is the other way around: The backup has
991 the same attributes of the original file, and the newly written file
992 is owned by the current user. When the file was a (hard/symbolic)
993 link, the new file will not! That's why the "auto" value doesn't
994 rename when the file is a link. The owner and group of the newly
995 written file will be set to the same ones as the original file, but
996 the system may refuse to do this. In that case the "auto" value will
997 again not rename the file.
998
Bram Moolenaar036986f2017-03-16 17:41:02 +0100999 NOTE: This option is set to the Vi default value when 'compatible' is
1000 set and to the Vim default value when 'compatible' is reset.
1001
Bram Moolenaar071d4272004-06-13 20:20:40 +00001002 *'backupdir'* *'bdir'*
1003'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001004 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 for Unix: ".,~/tmp,~/")
1006 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 List of directories for the backup file, separated with commas.
1008 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001009 where this is possible. The directory must exist, Vim will not
1010 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001011 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 impossible!). Writing may fail because of this.
1013 - A directory "." means to put the backup file in the same directory
1014 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001015 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 put the backup file relative to where the edited file is. The
1017 leading "." is replaced with the path name of the edited file.
1018 ("." inside a directory name has no special meaning).
1019 - Spaces after the comma are ignored, other spaces are considered part
1020 of the directory name. To have a space at the start of a directory
1021 name, precede it with a backslash.
1022 - To include a comma in a directory name precede it with a backslash.
1023 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001024 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001025 the backup file name will be built from the complete path to the
1026 file with all path separators changed to percent '%' signs. This
1027 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001028 On Win32, it is also possible to end with "\\". However, When a
1029 separating comma is following, you must use "//", since "\\" will
1030 include the comma in the file name. Therefore it is recommended to
1031 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 - Environment variables are expanded |:set_env|.
1033 - Careful with '\' characters, type one before a space, type two to
1034 get one in the option (see |option-backslash|), for example: >
1035 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1036< - For backwards compatibility with Vim version 3.0 a '>' at the start
1037 of the option is removed.
1038 See also 'backup' and 'writebackup' options.
1039 If you want to hide your backup files on Unix, consider this value: >
1040 :set backupdir=./.backup,~/.backup,.,/tmp
1041< You must create a ".backup" directory in each directory and in your
1042 home directory for this to work properly.
1043 The use of |:set+=| and |:set-=| is preferred when adding or removing
1044 directories from the list. This avoids problems when a future version
1045 uses another default.
1046 This option cannot be set from a |modeline| or in the |sandbox|, for
1047 security reasons.
1048
1049 *'backupext'* *'bex'* *E589*
1050'backupext' 'bex' string (default "~", for VMS: "_")
1051 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001052 String which is appended to a file name to make the name of the
1053 backup file. The default is quite unusual, because this avoids
1054 accidentally overwriting existing files with a backup file. You might
1055 prefer using ".bak", but make sure that you don't have files with
1056 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001057 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001059 If you like to keep a lot of backups, you could use a BufWritePre
1060 autocommand to change 'backupext' just before writing the file to
1061 include a timestamp. >
1062 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1063< Use 'backupdir' to put the backup in a different directory.
1064
Bram Moolenaar071d4272004-06-13 20:20:40 +00001065 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001066'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1067 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1068 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 {not available when compiled without the |+wildignore|
1071 feature}
1072 A list of file patterns. When one of the patterns matches with the
1073 name of the file which is written, no backup file is created. Both
1074 the specified file name and the full path name of the file are used.
1075 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1076 Watch out for special characters, see |option-backslash|.
1077 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001078 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001079
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001080 WARNING: Not having a backup file means that when Vim fails to write
1081 your buffer correctly and then, for whatever reason, Vim exits, you
1082 lose both the original file and what you were writing. Only disable
1083 backups if you don't care about losing the file.
1084
Bram Moolenaar02467872007-05-06 13:22:01 +00001085 Note that environment variables are not expanded. If you want to use
1086 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001087 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001088
1089< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001090 backup would be made by renaming the original file crontab won't see
1091 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092
1093 *'balloondelay'* *'bdlay'*
1094'balloondelay' 'bdlay' number (default: 600)
1095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 {only available when compiled with the |+balloon_eval|
1097 feature}
1098 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1099
1100 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1101'ballooneval' 'beval' boolean (default off)
1102 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001103 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001104 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001105 Switch on the |balloon-eval| functionality for the GUI.
1106
1107 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1108 *'nobevalterm'*
1109'balloonevalterm' 'bevalterm' boolean (default off)
1110 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001111 {only available when compiled with the
1112 |+balloon_eval_term| feature}
1113 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001115 *'balloonexpr'* *'bexpr'*
1116'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001117 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001118 {only available when compiled with the |+balloon_eval|
1119 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001120 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001121 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1122 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001123
1124 v:beval_bufnr number of the buffer in which balloon is going to show
1125 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001126 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001127 v:beval_lnum line number
1128 v:beval_col column number (byte index)
1129 v:beval_text word under or after the mouse pointer
1130
1131 The evaluation of the expression must not have side effects!
1132 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001133 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001134 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001135 \', column ' . v:beval_col .
1136 \ ' of file ' . bufname(v:beval_bufnr) .
1137 \ ' on word "' . v:beval_text . '"'
1138 endfunction
1139 set bexpr=MyBalloonExpr()
1140 set ballooneval
1141<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001142 Also see |balloon_show()|, can be used if the content of the balloon
1143 is to be fetched asynchronously.
1144
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001145 NOTE: The balloon is displayed only if the cursor is on a text
1146 character. If the result of evaluating 'balloonexpr' is not empty,
1147 Vim does not try to send a message to an external debugger (Netbeans
1148 or Sun Workshop).
1149
Bram Moolenaar30b65812012-07-12 22:01:11 +02001150 The expression will be evaluated in the |sandbox| when set from a
1151 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001152
1153 It is not allowed to change text or jump to another window while
1154 evaluating 'balloonexpr' |textlock|.
1155
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001156 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001157 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001158< When they are supported "\n" characters will start a new line. If the
1159 expression evaluates to a |List| this is equal to using each List item
1160 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001161 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001162
Bram Moolenaar165bc692015-07-21 17:53:25 +02001163 *'belloff'* *'bo'*
1164'belloff' 'bo' string (default "")
1165 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001166 Specifies for which events the bell will not be rung. It is a comma
1167 separated list of items. For each item that is present, the bell
1168 will be silenced. This is most useful to specify specific events in
1169 insert mode to be silenced.
1170
1171 item meaning when present ~
1172 all All events.
1173 backspace When hitting <BS> or <Del> and deleting results in an
1174 error.
1175 cursor Fail to move around using the cursor keys or
1176 <PageUp>/<PageDown> in |Insert-mode|.
1177 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1178 |i_CTRL-X_CTRL-T|.
1179 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1180 |i_CTRL-E|.
1181 ctrlg Unknown Char after <C-G> in Insert mode.
1182 error Other Error occurred (e.g. try to join last line)
1183 (mostly used in |Normal-mode| or |Cmdline-mode|).
1184 esc hitting <Esc> in |Normal-mode|.
1185 ex In |Visual-mode|, hitting |Q| results in an error.
1186 hangul Error occurred when using hangul input.
1187 insertmode Pressing <Esc> in 'insertmode'.
1188 lang Calling the beep module for Lua/Mzscheme/TCL.
1189 mess No output available for |g<|.
1190 showmatch Error occurred for 'showmatch' function.
1191 operator Empty region error |cpo-E|.
1192 register Unknown register after <C-R> in |Insert-mode|.
1193 shell Bell from shell output |:!|.
1194 spell Error happened on spell suggest.
1195 wildmode More matches in |cmdline-completion| available
1196 (depends on the 'wildmode' setting).
1197
Bram Moolenaar036986f2017-03-16 17:41:02 +01001198 This is most useful to fine tune when in Insert mode the bell should
1199 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001200 indicate that an error occurred. It can be silenced by adding the
1201 "error" keyword.
1202
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1204'binary' 'bin' boolean (default off)
1205 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206 This option should be set before editing a binary file. You can also
1207 use the |-b| Vim argument. When this option is switched on a few
1208 options will be changed (also when it already was on):
1209 'textwidth' will be set to 0
1210 'wrapmargin' will be set to 0
1211 'modeline' will be off
1212 'expandtab' will be off
1213 Also, 'fileformat' and 'fileformats' options will not be used, the
1214 file is read and written like 'fileformat' was "unix" (a single <NL>
1215 separates lines).
1216 The 'fileencoding' and 'fileencodings' options will not be used, the
1217 file is read without conversion.
1218 NOTE: When you start editing a(nother) file while the 'bin' option is
1219 on, settings from autocommands may change the settings again (e.g.,
1220 'textwidth'), causing trouble when editing. You might want to set
1221 'bin' again when the file has been loaded.
1222 The previous values of these options are remembered and restored when
1223 'bin' is switched from on to off. Each buffer has its own set of
1224 saved option values.
1225 To edit a file with 'binary' set you can use the |++bin| argument.
1226 This avoids you have to do ":set bin", which would have effect for all
1227 files you edit.
1228 When writing a file the <EOL> for the last line is only written if
1229 there was one in the original file (normally Vim appends an <EOL> to
1230 the last line if there is none; this would make the file longer). See
1231 the 'endofline' option.
1232
1233 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1234'bioskey' 'biosk' boolean (default on)
1235 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001236 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001237 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238
1239 *'bomb'* *'nobomb'*
1240'bomb' boolean (default off)
1241 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242 When writing a file and the following conditions are met, a BOM (Byte
1243 Order Mark) is prepended to the file:
1244 - this option is on
1245 - the 'binary' option is off
1246 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1247 endian variants.
1248 Some applications use the BOM to recognize the encoding of the file.
1249 Often used for UCS-2 files on MS-Windows. For other applications it
1250 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001251 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1253 check for the presence of the BOM is done and 'bomb' set accordingly.
1254 Unless 'binary' is set, it is removed from the first line, so that you
1255 don't see it when editing. When you don't change the options, the BOM
1256 will be restored when writing the file.
1257
1258 *'breakat'* *'brk'*
1259'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1260 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001261 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 feature}
1263 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001264 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1265 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001267 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001268'breakindent' 'bri' boolean (default off)
1269 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001270 {not available when compiled without the |+linebreak|
1271 feature}
1272 Every wrapped line will continue visually indented (same amount of
1273 space as the beginning of that line), thus preserving horizontal blocks
1274 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001275 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001276
1277 *'breakindentopt'* *'briopt'*
1278'breakindentopt' 'briopt' string (default empty)
1279 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001280 {not available when compiled without the |+linebreak|
1281 feature}
1282 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001283 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001284 min:{n} Minimum text width that will be kept after
1285 applying 'breakindent', even if the resulting
1286 text should normally be narrower. This prevents
1287 text indented almost to the right window border
1288 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001289 shift:{n} After applying 'breakindent', the wrapped line's
1290 beginning will be shifted by the given number of
1291 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001292 indentation (negative) or emphasizing the line
1293 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001294 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001295 additional indent.
1296 The default value for min is 20 and shift is 0.
1297
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001299'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001300 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001301 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001302 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001303 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001304 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001305 buffer Use the directory of the related buffer.
1306 current Use the current directory.
1307 {path} Use the specified directory
1308
1309 *'bufhidden'* *'bh'*
1310'bufhidden' 'bh' string (default: "")
1311 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 This option specifies what happens when a buffer is no longer
1313 displayed in a window:
1314 <empty> follow the global 'hidden' option
1315 hide hide the buffer (don't unload it), also when 'hidden'
1316 is not set
1317 unload unload the buffer, also when 'hidden' is set or using
1318 |:hide|
1319 delete delete the buffer from the buffer list, also when
1320 'hidden' is set or using |:hide|, like using
1321 |:bdelete|
1322 wipe wipe out the buffer from the buffer list, also when
1323 'hidden' is set or using |:hide|, like using
1324 |:bwipeout|
1325
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001326 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001327 are lost without a warning. Also, these values may break autocommands
1328 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329 This option is used together with 'buftype' and 'swapfile' to specify
1330 special kinds of buffers. See |special-buffers|.
1331
1332 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1333'buflisted' 'bl' boolean (default: on)
1334 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335 When this option is set, the buffer shows up in the buffer list. If
1336 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1337 This option is reset by Vim for buffers that are only used to remember
1338 a file name or marks. Vim sets it when starting to edit a buffer.
1339 But not when moving to a buffer with ":buffer".
1340
1341 *'buftype'* *'bt'* *E382*
1342'buftype' 'bt' string (default: "")
1343 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344 The value of this option specifies the type of a buffer:
1345 <empty> normal buffer
1346 nofile buffer which is not related to a file and will not be
1347 written
1348 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001349 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001350 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001351 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001352 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353 help help buffer (you are not supposed to set this
1354 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001355 terminal buffer for a |terminal| (you are not supposed to set
1356 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001357 prompt buffer where only the last line can be edited, meant
1358 to be used by a plugin, see |prompt-buffer|
1359 {only when compiled with the |+channel| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001360
1361 This option is used together with 'bufhidden' and 'swapfile' to
1362 specify special kinds of buffers. See |special-buffers|.
1363
1364 Be careful with changing this option, it can have many side effects!
1365
Bram Moolenaar280f1262006-01-30 00:14:18 +00001366 A "quickfix" buffer is only used for the error list and the location
1367 list. This value is set by the |:cwindow| and |:lwindow| commands and
1368 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369
1370 "nofile" and "nowrite" buffers are similar:
1371 both: The buffer is not to be written to disk, ":w" doesn't
1372 work (":w filename" does work though).
1373 both: The buffer is never considered to be |'modified'|.
1374 There is no warning when the changes will be lost, for
1375 example when you quit Vim.
1376 both: A swap file is only created when using too much memory
1377 (when 'swapfile' has been reset there is never a swap
1378 file).
1379 nofile only: The buffer name is fixed, it is not handled like a
1380 file name. It is not modified in response to a |:cd|
1381 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001382 both: When using ":e bufname" and already editing "bufname"
1383 the buffer is made empty and autocommands are
1384 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001385 *E676*
1386 "acwrite" implies that the buffer name is not related to a file, like
1387 "nofile", but it will be written. Thus, in contrast to "nofile" and
1388 "nowrite", ":w" does work and a modified buffer can't be abandoned
1389 without saving. For writing there must be matching |BufWriteCmd|,
1390 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391
1392 *'casemap'* *'cmp'*
1393'casemap' 'cmp' string (default: "internal,keepascii")
1394 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395 Specifies details about changing the case of letters. It may contain
1396 these words, separated by a comma:
1397 internal Use internal case mapping functions, the current
1398 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001399 matters when 'encoding' is a Unicode encoding,
1400 "latin1" or "iso-8859-15". When "internal" is
1401 omitted, the towupper() and towlower() system library
1402 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1404 case mapping, the current locale is not effective.
1405 This probably only matters for Turkish.
1406
1407 *'cdpath'* *'cd'* *E344* *E346*
1408'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1409 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410 {not available when compiled without the
1411 |+file_in_path| feature}
1412 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001413 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1414 searched for has a relative path, not an absolute part starting with
1415 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001416 The 'cdpath' option's value has the same form and semantics as
1417 |'path'|. Also see |file-searching|.
1418 The default value is taken from $CDPATH, with a "," prepended to look
1419 in the current directory first.
1420 If the default value taken from $CDPATH is not what you want, include
1421 a modified version of the following command in your vimrc file to
1422 override it: >
1423 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1424< This option cannot be set from a |modeline| or in the |sandbox|, for
1425 security reasons.
1426 (parts of 'cdpath' can be passed to the shell to expand file names).
1427
1428 *'cedit'*
1429'cedit' string (Vi default: "", Vim default: CTRL-F)
1430 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431 {not available when compiled without the |+vertsplit|
1432 feature}
1433 The key used in Command-line Mode to open the command-line window.
1434 The default is CTRL-F when 'compatible' is off.
1435 Only non-printable keys are allowed.
1436 The key can be specified as a single character, but it is difficult to
1437 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001438 :exe "set cedit=\<C-Y>"
1439 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440< |Nvi| also has this option, but it only uses the first character.
1441 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001442 NOTE: This option is set to the Vim default value when 'compatible'
1443 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001444
1445 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1446'charconvert' 'ccv' string (default "")
1447 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001448 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001449 An expression that is used for character encoding conversion. It is
1450 evaluated when a file that is to be read or has been written has a
1451 different encoding from what is desired.
1452 'charconvert' is not used when the internal iconv() function is
1453 supported and is able to do the conversion. Using iconv() is
1454 preferred, because it is much faster.
1455 'charconvert' is not used when reading stdin |--|, because there is no
1456 file to convert from. You will have to save the text in a file first.
1457 The expression must return zero or an empty string for success,
1458 non-zero for failure.
1459 The possible encoding names encountered are in 'encoding'.
1460 Additionally, names given in 'fileencodings' and 'fileencoding' are
1461 used.
1462 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1463 is done internally by Vim, 'charconvert' is not used for this.
1464 'charconvert' is also used to convert the viminfo file, if the 'c'
1465 flag is present in 'viminfo'. Also used for Unicode conversion.
1466 Example: >
1467 set charconvert=CharConvert()
1468 fun CharConvert()
1469 system("recode "
1470 \ . v:charconvert_from . ".." . v:charconvert_to
1471 \ . " <" . v:fname_in . " >" v:fname_out)
1472 return v:shell_error
1473 endfun
1474< The related Vim variables are:
1475 v:charconvert_from name of the current encoding
1476 v:charconvert_to name of the desired encoding
1477 v:fname_in name of the input file
1478 v:fname_out name of the output file
1479 Note that v:fname_in and v:fname_out will never be the same.
1480 Note that v:charconvert_from and v:charconvert_to may be different
1481 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1482 Encryption is not done by Vim when using 'charconvert'. If you want
1483 to encrypt the file after conversion, 'charconvert' should take care
1484 of this.
1485 This option cannot be set from a |modeline| or in the |sandbox|, for
1486 security reasons.
1487
1488 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1489'cindent' 'cin' boolean (default off)
1490 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001491 {not available when compiled without the |+cindent|
1492 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001493 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494 that trigger reindenting in insert mode and 'cinoptions' to set your
1495 preferred indent style.
1496 If 'indentexpr' is not empty, it overrules 'cindent'.
1497 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1498 the "=" operator indents using this algorithm rather than calling an
1499 external program.
1500 See |C-indenting|.
1501 When you don't like the way 'cindent' works, try the 'smartindent'
1502 option or 'indentexpr'.
1503 This option is not used when 'paste' is set.
1504 NOTE: This option is reset when 'compatible' is set.
1505
1506 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001507'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509 {not available when compiled without the |+cindent|
1510 feature}
1511 A list of keys that, when typed in Insert mode, cause reindenting of
1512 the current line. Only used if 'cindent' is on and 'indentexpr' is
1513 empty.
1514 For the format of this option see |cinkeys-format|.
1515 See |C-indenting|.
1516
1517 *'cinoptions'* *'cino'*
1518'cinoptions' 'cino' string (default "")
1519 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 {not available when compiled without the |+cindent|
1521 feature}
1522 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1523 program. See |cinoptions-values| for the values of this option, and
1524 |C-indenting| for info on C indenting in general.
1525
1526
1527 *'cinwords'* *'cinw'*
1528'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1529 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530 {not available when compiled without both the
1531 |+cindent| and the |+smartindent| features}
1532 These keywords start an extra indent in the next line when
1533 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1534 an appropriate place (inside {}).
1535 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1536 matter, include the keyword both the uppercase and lowercase:
1537 "if,If,IF".
1538
1539 *'clipboard'* *'cb'*
1540'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1541 for X-windows, "" otherwise)
1542 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001543 {only in GUI versions or when the |+xterm_clipboard|
1544 feature is included}
1545 This option is a list of comma separated names.
1546 These names are recognized:
1547
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001548 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549 unnamed When included, Vim will use the clipboard register '*'
1550 for all yank, delete, change and put operations which
1551 would normally go to the unnamed register. When a
1552 register is explicitly specified, it will always be
1553 used regardless of whether "unnamed" is in 'clipboard'
1554 or not. The clipboard register can always be
1555 explicitly accessed using the "* notation. Also see
1556 |gui-clipboard|.
1557
Bram Moolenaar30b65812012-07-12 22:01:11 +02001558 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001559 unnamedplus A variant of the "unnamed" flag which uses the
1560 clipboard register '+' (|quoteplus|) instead of
1561 register '*' for all yank, delete, change and put
1562 operations which would normally go to the unnamed
1563 register. When "unnamed" is also included to the
1564 option, yank operations (but not delete, change or
1565 put) will additionally copy the text into register
1566 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001567 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001568 Availability can be checked with: >
1569 if has('unnamedplus')
1570<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001571 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572 autoselect Works like the 'a' flag in 'guioptions': If present,
1573 then whenever Visual mode is started, or the Visual
1574 area extended, Vim tries to become the owner of the
1575 windowing system's global selection or put the
1576 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001577 register "*. See |'go-a'| and |quotestar| for details.
1578 When the GUI is active, the 'a' flag in 'guioptions'
1579 is used, when the GUI is not active, this "autoselect"
1580 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581 Also applies to the modeless selection.
1582
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001583 *clipboard-autoselectplus*
1584 autoselectplus Like "autoselect" but using the + register instead of
1585 the * register. Compare to the 'P' flag in
1586 'guioptions'.
1587
1588 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589 autoselectml Like "autoselect", but for the modeless selection
1590 only. Compare to the 'A' flag in 'guioptions'.
1591
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001592 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001593 html When the clipboard contains HTML, use this when
1594 pasting. When putting text on the clipboard, mark it
1595 as HTML. This works to copy rendered HTML from
1596 Firefox, paste it as raw HTML in Vim, select the HTML
1597 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001598 You probably want to add this only temporarily,
1599 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001600 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001601
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001602 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603 exclude:{pattern}
1604 Defines a pattern that is matched against the name of
1605 the terminal 'term'. If there is a match, no
1606 connection will be made to the X server. This is
1607 useful in this situation:
1608 - Running Vim in a console.
1609 - $DISPLAY is set to start applications on another
1610 display.
1611 - You do not want to connect to the X server in the
1612 console, but do want this in a terminal emulator.
1613 To never connect to the X server use: >
1614 exclude:.*
1615< This has the same effect as using the |-X| argument.
1616 Note that when there is no connection to the X server
1617 the window title won't be restored and the clipboard
1618 cannot be accessed.
1619 The value of 'magic' is ignored, {pattern} is
1620 interpreted as if 'magic' was on.
1621 The rest of the option value will be used for
1622 {pattern}, this must be the last entry.
1623
1624 *'cmdheight'* *'ch'*
1625'cmdheight' 'ch' number (default 1)
1626 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 Number of screen lines to use for the command-line. Helps avoiding
1628 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001629 The value of this option is stored with the tab page, so that each tab
1630 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631
1632 *'cmdwinheight'* *'cwh'*
1633'cmdwinheight' 'cwh' number (default 7)
1634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635 {not available when compiled without the |+vertsplit|
1636 feature}
1637 Number of screen lines to use for the command-line window. |cmdwin|
1638
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001639 *'colorcolumn'* *'cc'*
1640'colorcolumn' 'cc' string (default "")
1641 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001642 {not available when compiled without the |+syntax|
1643 feature}
1644 'colorcolumn' is a comma separated list of screen columns that are
1645 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1646 text. Will make screen redrawing slower.
1647 The screen column can be an absolute number, or a number preceded with
1648 '+' or '-', which is added to or subtracted from 'textwidth'. >
1649
1650 :set cc=+1 " highlight column after 'textwidth'
1651 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1652 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1653<
1654 When 'textwidth' is zero then the items with '-' and '+' are not used.
1655 A maximum of 256 columns are highlighted.
1656
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657 *'columns'* *'co'* *E594*
1658'columns' 'co' number (default 80 or terminal width)
1659 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001661 initialization and does not have to be set by hand. Also see
1662 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 When Vim is running in the GUI or in a resizable window, setting this
1664 option will cause the window size to be changed. When you only want
1665 to use the size for the GUI, put the command in your |gvimrc| file.
1666 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001667 number of columns of the display, the display may be messed up. For
1668 the GUI it is always possible and Vim limits the number of columns to
1669 what fits on the screen. You can use this command to get the widest
1670 window possible: >
1671 :set columns=9999
1672< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673
1674 *'comments'* *'com'* *E524* *E525*
1675'comments' 'com' string (default
1676 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1677 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 {not available when compiled without the |+comments|
1679 feature}
1680 A comma separated list of strings that can start a comment line. See
1681 |format-comments|. See |option-backslash| about using backslashes to
1682 insert a space.
1683
1684 *'commentstring'* *'cms'* *E537*
1685'commentstring' 'cms' string (default "/*%s*/")
1686 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687 {not available when compiled without the |+folding|
1688 feature}
1689 A template for a comment. The "%s" in the value is replaced with the
1690 comment text. Currently only used to add markers for folding, see
1691 |fold-marker|.
1692
1693 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001694'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001695 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001696 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697 This option has the effect of making Vim either more Vi-compatible, or
1698 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001699
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001701 other options are also changed as a side effect.
1702 NOTE: Setting or resetting this option can have a lot of unexpected
1703 effects: Mappings are interpreted in another way, undo behaves
1704 differently, etc. If you set this option in your vimrc file, you
1705 should probably put it at the very start.
1706
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707 By default this option is on and the Vi defaults are used for the
1708 options. This default was chosen for those people who want to use Vim
1709 just like Vi, and don't even (want to) know about the 'compatible'
1710 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001711 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001712 this option is switched off, and all options that have not been
1713 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001714 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001715 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001716 happen for the system-wide vimrc or gvimrc file, nor for a file given
1717 with the |-u| argument). Also see |compatible-default| and
1718 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 You can also set this option with the "-C" argument, and reset it with
1720 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001721 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722
Bram Moolenaar214641f2017-03-05 17:04:09 +01001723 When this option is set, numerous other options are set to make Vim as
1724 Vi-compatible as possible. When this option is unset, various options
1725 are set to make Vim more useful. The table below lists all the
1726 options affected.
1727 The {?} column indicates when the options are affected:
1728 + Means that the option is set to the value given in {set value} when
1729 'compatible' is set.
1730 & Means that the option is set to the value given in {set value} when
1731 'compatible' is set AND is set to its Vim default value when
1732 'compatible' is unset.
1733 - Means the option is NOT changed when setting 'compatible' but IS
1734 set to its Vim default when 'compatible' is unset.
1735 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001736
Bram Moolenaar036986f2017-03-16 17:41:02 +01001737 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001738
1739 'allowrevins' + off no CTRL-_ command
1740 'antialias' + off don't use antialiased fonts
1741 'arabic' + off reset arabic-related options
1742 'arabicshape' + on correct character shapes
1743 'backspace' + "" normal backspace
1744 'backup' + off no backup file
1745 'backupcopy' & Unix: "yes" backup file is a copy
1746 else: "auto" copy or rename backup file
1747 'balloonexpr' + "" text to show in evaluation balloon
1748 'breakindent' + off don't indent when wrapping lines
1749 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1750 'cindent' + off no C code indentation
1751 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1752 'copyindent' + off don't copy indent structure
1753 'cpoptions' & (all flags) Vi-compatible flags
1754 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001755 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001756 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001757 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001758 'cscopeverbose' + off see |cscopeverbose|
1759 'delcombine' + off unicode: delete whole char combination
1760 'digraph' + off no digraphs
1761 'esckeys' & off no <Esc>-keys in Insert mode
1762 'expandtab' + off tabs not expanded to spaces
1763 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001765 'formatexpr' + "" use 'formatprg' for auto-formatting
1766 'formatoptions' & "vt" Vi compatible formatting
1767 'gdefault' + off no default 'g' flag for ":s"
1768 'history' & 0 no commandline history
1769 'hkmap' + off no Hebrew keyboard mapping
1770 'hkmapp' + off no phonetic Hebrew keyboard mapping
1771 'hlsearch' + off no highlighting of search matches
1772 'incsearch' + off no incremental searching
1773 'indentexpr' + "" no indenting by expression
1774 'insertmode' + off do not start in Insert mode
1775 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001777 'joinspaces' + on insert 2 spaces after period
1778 'modeline' & off no modelines
1779 'more' & off no pauses in listings
1780 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1781 'numberwidth' & 8 min number of columns for line number
1782 'preserveindent'+ off don't preserve current indent structure
1783 when changing it
1784 'revins' + off no reverse insert
1785 'ruler' + off no ruler
1786 'scrolljump' + 1 no jump scroll
1787 'scrolloff' + 0 no scroll offset
1788 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1789 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001790 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001791 'showcmd' & off command characters not shown
1792 'showmode' & off current mode not shown
1793 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1794 'smartcase' + off no automatic ignore case switch
1795 'smartindent' + off no smart indentation
1796 'smarttab' + off no smart tab size
1797 'softtabstop' + 0 tabs are always 'tabstop' positions
1798 'startofline' + on goto startofline with some commands
1799 'tagcase' & "followic" 'ignorecase' when searching tags file
1800 'tagrelative' & off tag file names are not relative
1801 'termguicolors' + off don't use highlight-(guifg|guibg)
1802 'textauto' & off no automatic textmode detection
1803 'textwidth' + 0 no automatic line wrap
1804 'tildeop' + off tilde is not an operator
1805 'ttimeout' + off no terminal timeout
1806 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001807 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001808 'virtualedit' + "" cursor can only be placed on characters
1809 'whichwrap' & "" left-right movements don't wrap
1810 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001812 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813
1814 *'complete'* *'cpt'* *E535*
1815'complete' 'cpt' string (default: ".,w,b,u,t,i")
1816 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817 This option specifies how keyword completion |ins-completion| works
1818 when CTRL-P or CTRL-N are used. It is also used for whole-line
1819 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1820 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001821 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 w scan buffers from other windows
1823 b scan other loaded buffers that are in the buffer list
1824 u scan the unloaded buffers that are in the buffer list
1825 U scan the buffers that are not in the buffer list
1826 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001827 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001828 k{dict} scan the file {dict}. Several "k" flags can be given,
1829 patterns are valid too. For example: >
1830 :set cpt=k/usr/dict/*,k~/spanish
1831< s scan the files given with the 'thesaurus' option
1832 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1833 are valid too.
1834 i scan current and included files
1835 d scan current and included files for defined name or macro
1836 |i_CTRL-X_CTRL-D|
1837 ] tag completion
1838 t same as "]"
1839
1840 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1841 not executed, this may lead to unexpected completions from some files
1842 (gzipped files for example). Unloaded buffers are not scanned for
1843 whole-line completion.
1844
1845 The default is ".,w,b,u,t,i", which means to scan:
1846 1. the current buffer
1847 2. buffers in other windows
1848 3. other loaded buffers
1849 4. unloaded buffers
1850 5. tags
1851 6. included files
1852
1853 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001854 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1855 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001857 *'completefunc'* *'cfu'*
1858'completefunc' 'cfu' string (default: empty)
1859 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001860 {not available when compiled without the |+eval|
1861 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001862 This option specifies a function to be used for Insert mode completion
1863 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001864 See |complete-functions| for an explanation of how the function is
1865 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001866 This option cannot be set from a |modeline| or in the |sandbox|, for
1867 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001868
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001869 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001870'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001871 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001872 {not available when compiled without the
1873 |+insert_expand| feature}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001874 A comma separated list of options for Insert mode completion
1875 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001876
1877 menu Use a popup menu to show the possible completions. The
1878 menu is only shown when there is more than one match and
1879 sufficient colors are available. |ins-completion-menu|
1880
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001881 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001882 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001883 match, e.g., what file it comes from.
1884
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001885 longest Only insert the longest common text of the matches. If
1886 the menu is displayed you can use CTRL-L to add more
1887 characters. Whether case is ignored depends on the kind
1888 of completion. For buffer text the 'ignorecase' option is
1889 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001890
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001891 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001892 completion in the preview window. Only works in
1893 combination with "menu" or "menuone".
1894
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001895 noinsert Do not insert any text for a match until the user selects
1896 a match from the menu. Only works in combination with
1897 "menu" or "menuone". No effect if "longest" is present.
1898
1899 noselect Do not select a match in the menu, force the user to
1900 select one from the menu. Only works in combination with
1901 "menu" or "menuone".
1902
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001903
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001904 *'concealcursor'* *'cocu'*
1905'concealcursor' 'cocu' string (default: "")
1906 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001907 {not available when compiled without the |+conceal|
1908 feature}
1909 Sets the modes in which text in the cursor line can also be concealed.
1910 When the current mode is listed then concealing happens just like in
1911 other lines.
1912 n Normal mode
1913 v Visual mode
1914 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001915 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001916
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001917 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001918 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001919 are moving around text is concealed, but when starting to insert text
1920 or selecting a Visual area the concealed text is displayed, so that
1921 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001922 Keep in mind that the cursor position is not always where it's
1923 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001924
1925
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001926 *'conceallevel'* *'cole'*
1927'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001928 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001929 {not available when compiled without the |+conceal|
1930 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001931 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1932 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001933
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001934 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001935 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001936 1 Each block of concealed text is replaced with one
1937 character. If the syntax item does not have a custom
1938 replacement character defined (see |:syn-cchar|) the
1939 character defined in 'listchars' is used (default is a
1940 space).
1941 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001942 2 Concealed text is completely hidden unless it has a
1943 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001944 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001945 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001946
Bram Moolenaara7781e02010-07-19 20:13:22 +02001947 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001948 edit and copy the text. This can be changed with the 'concealcursor'
1949 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001950
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1952'confirm' 'cf' boolean (default off)
1953 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954 When 'confirm' is on, certain operations that would normally
1955 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1956 instead raise a |dialog| asking if you wish to save the current
1957 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1958 If 'confirm' is off you can still activate confirmation for one
1959 command only (this is most useful in mappings) with the |:confirm|
1960 command.
1961 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1962
1963 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1964'conskey' 'consk' boolean (default off)
1965 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01001966 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967
1968 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1969'copyindent' 'ci' boolean (default off)
1970 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971 Copy the structure of the existing lines indent when autoindenting a
1972 new line. Normally the new indent is reconstructed by a series of
1973 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1974 in which case only spaces are used). Enabling this option makes the
1975 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001976 existing line. 'expandtab' has no effect on these characters, a Tab
1977 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001978 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001979 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980 Also see 'preserveindent'.
1981
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001982 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001983'cpoptions' 'cpo' string (Vim default: "aABceFs",
1984 Vi default: all flags)
1985 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001986 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001987 this indicates Vi-compatible behavior. This is used for things where
1988 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001989 'cpoptions' stands for "compatible-options".
1990 Commas can be added for readability.
1991 To avoid problems with flags that are added in the future, use the
1992 "+=" and "-=" feature of ":set" |add-option-flags|.
1993 NOTE: This option is set to the Vi default value when 'compatible' is
1994 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001995 NOTE: This option is set to the POSIX default value at startup when
1996 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001997 variable exists |posix|. This means Vim tries to behave like the
1998 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001999
2000 contains behavior ~
2001 *cpo-a*
2002 a When included, a ":read" command with a file name
2003 argument will set the alternate file name for the
2004 current window.
2005 *cpo-A*
2006 A When included, a ":write" command with a file name
2007 argument will set the alternate file name for the
2008 current window.
2009 *cpo-b*
2010 b "\|" in a ":map" command is recognized as the end of
2011 the map command. The '\' is included in the mapping,
2012 the text after the '|' is interpreted as the next
2013 command. Use a CTRL-V instead of a backslash to
2014 include the '|' in the mapping. Applies to all
2015 mapping, abbreviation, menu and autocmd commands.
2016 See also |map_bar|.
2017 *cpo-B*
2018 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002019 abbreviations, user commands and the "to" part of the
2020 menu commands. Remove this flag to be able to use a
2021 backslash like a CTRL-V. For example, the command
2022 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 'B' included: "\^[" (^[ is a real <Esc>)
2024 'B' excluded: "<Esc>" (5 characters)
2025 ('<' excluded in both cases)
2026 *cpo-c*
2027 c Searching continues at the end of any match at the
2028 cursor position, but not further than the start of the
2029 next line. When not present searching continues
2030 one character from the cursor position. With 'c'
2031 "abababababab" only gets three matches when repeating
2032 "/abab", without 'c' there are five matches.
2033 *cpo-C*
2034 C Do not concatenate sourced lines that start with a
2035 backslash. See |line-continuation|.
2036 *cpo-d*
2037 d Using "./" in the 'tags' option doesn't mean to use
2038 the tags file relative to the current file, but the
2039 tags file in the current directory.
2040 *cpo-D*
2041 D Can't use CTRL-K to enter a digraph after Normal mode
2042 commands with a character argument, like |r|, |f| and
2043 |t|.
2044 *cpo-e*
2045 e When executing a register with ":@r", always add a
2046 <CR> to the last line, also when the register is not
2047 linewise. If this flag is not present, the register
2048 is not linewise and the last line does not end in a
2049 <CR>, then the last line is put on the command-line
2050 and can be edited before hitting <CR>.
2051 *cpo-E*
2052 E It is an error when using "y", "d", "c", "g~", "gu" or
2053 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002054 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 This makes "y0" fail in the first column.
2056 *cpo-f*
2057 f When included, a ":read" command with a file name
2058 argument will set the file name for the current buffer,
2059 if the current buffer doesn't have a file name yet.
2060 *cpo-F*
2061 F When included, a ":write" command with a file name
2062 argument will set the file name for the current
2063 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002064 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065 *cpo-g*
2066 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002067 *cpo-H*
2068 H When using "I" on a line with only blanks, insert
2069 before the last blank. Without this flag insert after
2070 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071 *cpo-i*
2072 i When included, interrupting the reading of a file will
2073 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002074 *cpo-I*
2075 I When moving the cursor up or down just after inserting
2076 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077 *cpo-j*
2078 j When joining lines, only add two spaces after a '.',
2079 not after '!' or '?'. Also see 'joinspaces'.
2080 *cpo-J*
2081 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002082 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083 white space.
2084 *cpo-k*
2085 k Disable the recognition of raw key codes in
2086 mappings, abbreviations, and the "to" part of menu
2087 commands. For example, if <Key> sends ^[OA (where ^[
2088 is <Esc>), the command ":map X ^[OA" results in X
2089 being mapped to:
2090 'k' included: "^[OA" (3 characters)
2091 'k' excluded: "<Key>" (one key code)
2092 Also see the '<' flag below.
2093 *cpo-K*
2094 K Don't wait for a key code to complete when it is
2095 halfway a mapping. This breaks mapping <F1><F1> when
2096 only part of the second <F1> has been read. It
2097 enables cancelling the mapping by typing <F1><Esc>.
2098 *cpo-l*
2099 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002100 literally, only "\]", "\^", "\-" and "\\" are special.
2101 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2103 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002104 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 *cpo-L*
2106 L When the 'list' option is set, 'wrapmargin',
2107 'textwidth', 'softtabstop' and Virtual Replace mode
2108 (see |gR|) count a <Tab> as two characters, instead of
2109 the normal behavior of a <Tab>.
2110 *cpo-m*
2111 m When included, a showmatch will always wait half a
2112 second. When not included, a showmatch will wait half
2113 a second or until a character is typed. |'showmatch'|
2114 *cpo-M*
2115 M When excluded, "%" matching will take backslashes into
2116 account. Thus in "( \( )" and "\( ( \)" the outer
2117 parenthesis match. When included "%" ignores
2118 backslashes, which is Vi compatible.
2119 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002120 n When included, the column used for 'number' and
2121 'relativenumber' will also be used for text of wrapped
2122 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123 *cpo-o*
2124 o Line offset to search command is not remembered for
2125 next search.
2126 *cpo-O*
2127 O Don't complain if a file is being overwritten, even
2128 when it didn't exist when editing it. This is a
2129 protection against a file unexpectedly created by
2130 someone else. Vi didn't complain about this.
2131 *cpo-p*
2132 p Vi compatible Lisp indenting. When not present, a
2133 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002134 *cpo-P*
2135 P When included, a ":write" command that appends to a
2136 file will set the file name for the current buffer, if
2137 the current buffer doesn't have a file name yet and
2138 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002139 *cpo-q*
2140 q When joining multiple lines leave the cursor at the
2141 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142 *cpo-r*
2143 r Redo ("." command) uses "/" to repeat a search
2144 command, instead of the actually used search string.
2145 *cpo-R*
2146 R Remove marks from filtered lines. Without this flag
2147 marks are kept like |:keepmarks| was used.
2148 *cpo-s*
2149 s Set buffer options when entering the buffer for the
2150 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002151 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152 set when the buffer is created.
2153 *cpo-S*
2154 S Set buffer options always when entering a buffer
2155 (except 'readonly', 'fileformat', 'filetype' and
2156 'syntax'). This is the (most) Vi compatible setting.
2157 The options are set to the values in the current
2158 buffer. When you change an option and go to another
2159 buffer, the value is copied. Effectively makes the
2160 buffer options global to all buffers.
2161
2162 's' 'S' copy buffer options
2163 no no when buffer created
2164 yes no when buffer first entered (default)
2165 X yes each time when buffer entered (vi comp.)
2166 *cpo-t*
2167 t Search pattern for the tag command is remembered for
2168 "n" command. Otherwise Vim only puts the pattern in
2169 the history for search pattern, but doesn't change the
2170 last used search pattern.
2171 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002172 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173 *cpo-v*
2174 v Backspaced characters remain visible on the screen in
2175 Insert mode. Without this flag the characters are
2176 erased from the screen right away. With this flag the
2177 screen newly typed text overwrites backspaced
2178 characters.
2179 *cpo-w*
2180 w When using "cw" on a blank character, only change one
2181 character and not all blanks until the start of the
2182 next word.
2183 *cpo-W*
2184 W Don't overwrite a readonly file. When omitted, ":w!"
2185 overwrites a readonly file, if possible.
2186 *cpo-x*
2187 x <Esc> on the command-line executes the command-line.
2188 The default in Vim is to abandon the command-line,
2189 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002190 *cpo-X*
2191 X When using a count with "R" the replaced text is
2192 deleted only once. Also when repeating "R" with "."
2193 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002195 y A yank command can be redone with ".". Think twice if
2196 you really want to use this, it may break some
2197 plugins, since most people expect "." to only repeat a
2198 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002199 *cpo-Z*
2200 Z When using "w!" while the 'readonly' option is set,
2201 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002202 *cpo-!*
2203 ! When redoing a filter command, use the last used
2204 external command, whatever it was. Otherwise the last
2205 used -filter- command is used.
2206 *cpo-$*
2207 $ When making a change to one line, don't redisplay the
2208 line, but put a '$' at the end of the changed text.
2209 The changed text will be overwritten when you type the
2210 new text. The line is redisplayed if you type any
2211 command that moves the cursor from the insertion
2212 point.
2213 *cpo-%*
2214 % Vi-compatible matching is done for the "%" command.
2215 Does not recognize "#if", "#endif", etc.
2216 Does not recognize "/*" and "*/".
2217 Parens inside single and double quotes are also
2218 counted, causing a string that contains a paren to
2219 disturb the matching. For example, in a line like
2220 "if (strcmp("foo(", s))" the first paren does not
2221 match the last one. When this flag is not included,
2222 parens inside single and double quotes are treated
2223 specially. When matching a paren outside of quotes,
2224 everything inside quotes is ignored. When matching a
2225 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002226 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002227 This flag is also used for other features, such as
2228 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002229 *cpo--*
2230 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002231 it would go above the first line or below the last
2232 line. Without it the cursor moves to the first or
2233 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002234 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002235 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002236 *cpo-+*
2237 + When included, a ":write file" command will reset the
2238 'modified' flag of the buffer, even though the buffer
2239 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002240 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002241 * Use ":*" in the same way as ":@". When not included,
2242 ":*" is an alias for ":'<,'>", select the Visual area.
2243 *cpo-<*
2244 < Disable the recognition of special key codes in |<>|
2245 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002246 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 ":map X <Tab>" results in X being mapped to:
2248 '<' included: "<Tab>" (5 characters)
2249 '<' excluded: "^I" (^I is a real <Tab>)
2250 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002251 *cpo->*
2252 > When appending to a register, put a line break before
2253 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002254 *cpo-;*
2255 ; When using |,| or |;| to repeat the last |t| search
2256 and the cursor is right in front of the searched
2257 character, the cursor won't move. When not included,
2258 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002259 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002260
2261 POSIX flags. These are not included in the Vi default value, except
2262 when $VIM_POSIX was set on startup. |posix|
2263
2264 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002265 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002266 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002267 *cpo-&*
2268 & When ":preserve" was used keep the swap file when
2269 exiting normally while this buffer is still loaded.
2270 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002271 *cpo-\*
2272 \ Backslash in a [] range in a search pattern is taken
2273 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002274 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2275 '\' excluded: "/[ \-]" finds <Space> and '-'
2276 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002277 *cpo-/*
2278 / When "%" is used as the replacement string in a |:s|
2279 command, use the previous replacement string. |:s%|
2280 *cpo-{*
2281 { The |{| and |}| commands also stop at a "{" character
2282 at the start of a line.
2283 *cpo-.*
2284 . The ":chdir" and ":cd" commands fail if the current
2285 buffer is modified, unless ! is used. Vim doesn't
2286 need this, since it remembers the full path of an
2287 opened file.
2288 *cpo-bar*
2289 | The value of the $LINES and $COLUMNS environment
2290 variables overrule the terminal size values obtained
2291 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002292
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002294 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002295'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002296 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002297 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002298 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002299 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002300 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002301 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002302 blowfish Blowfish method. Medium strong encryption but it has
2303 an implementation flaw. Requires Vim 7.3 or later,
2304 files can NOT be read by Vim 7.2 and older. This adds
2305 a "seed" to the file, every time you write the file
2306 the encrypted bytes will be different.
2307 *blowfish2*
2308 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002309 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002310 and older. This adds a "seed" to the file, every time
2311 you write the file the encrypted bytes will be
2312 different. The whole undo file is encrypted, not just
2313 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002314
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002315 You should use "blowfish2", also to re-encrypt older files.
2316
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002317 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002318 to the detected method of the file being read. Thus if you write it
2319 without changing 'cryptmethod' the same method will be used.
2320 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002321 explicitly write it, you don't get a warning unless there are other
2322 modifications. Also see |:X|.
2323
2324 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002325 the value "blowfish2". When setting the local value to an empty
2326 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002327
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002328 When a new encryption method is added in a later version of Vim, and
2329 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002330 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002331
2332
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333 *'cscopepathcomp'* *'cspc'*
2334'cscopepathcomp' 'cspc' number (default 0)
2335 global
2336 {not available when compiled without the |+cscope|
2337 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338 Determines how many components of the path to show in a list of tags.
2339 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002340 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341
2342 *'cscopeprg'* *'csprg'*
2343'cscopeprg' 'csprg' string (default "cscope")
2344 global
2345 {not available when compiled without the |+cscope|
2346 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002347 Specifies the command to execute cscope. See |cscopeprg|.
2348 This option cannot be set from a |modeline| or in the |sandbox|, for
2349 security reasons.
2350
2351 *'cscopequickfix'* *'csqf'*
2352'cscopequickfix' 'csqf' string (default "")
2353 global
2354 {not available when compiled without the |+cscope|
2355 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356 Specifies whether to use quickfix window to show cscope results.
2357 See |cscopequickfix|.
2358
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002359 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002360'cscoperelative' 'csre' boolean (default off)
2361 global
2362 {not available when compiled without the |+cscope|
2363 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002364 In the absence of a prefix (-P) for cscope. setting this option enables
2365 to use the basename of cscope.out path as the prefix.
2366 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002367 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002368
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2370'cscopetag' 'cst' boolean (default off)
2371 global
2372 {not available when compiled without the |+cscope|
2373 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002374 Use cscope for tag commands. See |cscope-options|.
2375 NOTE: This option is reset when 'compatible' is set.
2376
2377 *'cscopetagorder'* *'csto'*
2378'cscopetagorder' 'csto' number (default 0)
2379 global
2380 {not available when compiled without the |+cscope|
2381 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382 Determines the order in which ":cstag" performs a search. See
2383 |cscopetagorder|.
2384 NOTE: This option is set to 0 when 'compatible' is set.
2385
2386 *'cscopeverbose'* *'csverb'*
2387 *'nocscopeverbose'* *'nocsverb'*
2388'cscopeverbose' 'csverb' boolean (default off)
2389 global
2390 {not available when compiled without the |+cscope|
2391 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 Give messages when adding a cscope database. See |cscopeverbose|.
2393 NOTE: This option is reset when 'compatible' is set.
2394
Bram Moolenaar860cae12010-06-05 23:22:07 +02002395 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2396'cursorbind' 'crb' boolean (default off)
2397 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002398 When this option is set, as the cursor in the current
2399 window moves other cursorbound windows (windows that also have
2400 this option set) move their cursors to the corresponding line and
2401 column. This option is useful for viewing the
2402 differences between two versions of a file (see 'diff'); in diff mode,
2403 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002404 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002405
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002406
2407 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2408'cursorcolumn' 'cuc' boolean (default off)
2409 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002410 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002411 feature}
2412 Highlight the screen column of the cursor with CursorColumn
2413 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2414 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002415 If you only want the highlighting in the current window you can use
2416 these autocommands: >
2417 au WinLeave * set nocursorline nocursorcolumn
2418 au WinEnter * set cursorline cursorcolumn
2419<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002420
2421 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2422'cursorline' 'cul' boolean (default off)
2423 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002424 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002425 feature}
2426 Highlight the screen line of the cursor with CursorLine
2427 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2428 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002429 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002430 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002431
2432
Bram Moolenaar071d4272004-06-13 20:20:40 +00002433 *'debug'*
2434'debug' string (default "")
2435 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002436 These values can be used:
2437 msg Error messages that would otherwise be omitted will be given
2438 anyway.
2439 throw Error messages that would otherwise be omitted will be given
2440 anyway and also throw an exception and set |v:errmsg|.
2441 beep A message will be given when otherwise only a beep would be
2442 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002443 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002444 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2445 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002446
2447 *'define'* *'def'*
2448'define' 'def' string (default "^\s*#\s*define")
2449 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002450 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002451 pattern, just like for the "/" command. This option is used for the
2452 commands like "[i" and "[d" |include-search|. The 'isident' option is
2453 used to recognize the defined name after the match:
2454 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2455 See |option-backslash| about inserting backslashes to include a space
2456 or backslash.
2457 The default value is for C programs. For C++ this value would be
2458 useful, to include const type declarations: >
2459 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002460< You can also use "\ze" just before the name and continue the pattern
2461 to check what is following. E.g. for Javascript, if a function is
2462 defined with "func_name = function(args)": >
2463 ^\s*\ze\i\+\s*=\s*function(
2464< If the function is defined with "func_name : function() {...": >
2465 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002466< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002467 To avoid that use `:let` with a single quote string: >
2468 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002469<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002470
2471 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2472'delcombine' 'deco' boolean (default off)
2473 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474 If editing Unicode and this option is set, backspace and Normal mode
2475 "x" delete each combining character on its own. When it is off (the
2476 default) the character along with its combining characters are
2477 deleted.
2478 Note: When 'delcombine' is set "xx" may work different from "2x"!
2479
2480 This is useful for Arabic, Hebrew and many other languages where one
2481 may have combining characters overtop of base characters, and want
2482 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002483 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484
2485 *'dictionary'* *'dict'*
2486'dictionary' 'dict' string (default "")
2487 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488 List of file names, separated by commas, that are used to lookup words
2489 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2490 contain a list of words. This can be one word per line, or several
2491 words per line, separated by non-keyword characters (white space is
2492 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002493
2494 When this option is empty or an entry "spell" is present, and spell
2495 checking is enabled, words in the word lists for the currently active
2496 'spelllang' are used. See |spell|.
2497
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002498 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002499 after a comma are ignored, otherwise spaces are included in the file
2500 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002501 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502 Where to find a list of words?
2503 - On FreeBSD, there is the file "/usr/share/dict/words".
2504 - In the Simtel archive, look in the "msdos/linguist" directory.
2505 - In "miscfiles" of the GNU collection.
2506 The use of |:set+=| and |:set-=| is preferred when adding or removing
2507 directories from the list. This avoids problems when a future version
2508 uses another default.
2509 Backticks cannot be used in this option for security reasons.
2510
2511 *'diff'* *'nodiff'*
2512'diff' boolean (default off)
2513 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002514 {not available when compiled without the |+diff|
2515 feature}
2516 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002517 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518
2519 *'dex'* *'diffexpr'*
2520'diffexpr' 'dex' string (default "")
2521 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 {not available when compiled without the |+diff|
2523 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002524 Expression which is evaluated to obtain a diff file (either ed-style
2525 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526 This option cannot be set from a |modeline| or in the |sandbox|, for
2527 security reasons.
2528
2529 *'dip'* *'diffopt'*
Bram Moolenaarc93262b2018-09-10 21:15:40 +02002530'diffopt' 'dip' string (default "internal,filler")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532 {not available when compiled without the |+diff|
2533 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002534 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535 All are optional. Items must be separated by a comma.
2536
2537 filler Show filler lines, to keep the text
2538 synchronized with a window that has inserted
2539 lines at the same position. Mostly useful
2540 when windows are side-by-side and 'scrollbind'
2541 is set.
2542
2543 context:{n} Use a context of {n} lines between a change
2544 and a fold that contains unchanged lines.
2545 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002546 When using zero the context is actually one,
2547 since folds require a line in between, also
2548 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 See |fold-diff|.
2550
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002551 iblank Ignore changes where lines are all blank. Adds
2552 the "-B" flag to the "diff" command if
2553 'diffexpr' is empty. Check the documentation
2554 of the "diff" command for what this does
2555 exactly.
2556 NOTE: the diff windows will get out of sync,
2557 because no differences between blank lines are
2558 taken into account.
2559
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560 icase Ignore changes in case of text. "a" and "A"
2561 are considered the same. Adds the "-i" flag
2562 to the "diff" command if 'diffexpr' is empty.
2563
2564 iwhite Ignore changes in amount of white space. Adds
2565 the "-b" flag to the "diff" command if
2566 'diffexpr' is empty. Check the documentation
2567 of the "diff" command for what this does
2568 exactly. It should ignore adding trailing
2569 white space, but not leading white space.
2570
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002571 iwhiteall Ignore all white space changes. Adds
2572 the "-w" flag to the "diff" command if
2573 'diffexpr' is empty. Check the documentation
2574 of the "diff" command for what this does
2575 exactly.
2576
2577 iwhiteeol Ignore white space changes at end of line.
2578 Adds the "-Z" flag to the "diff" command if
2579 'diffexpr' is empty. Check the documentation
2580 of the "diff" command for what this does
2581 exactly.
2582
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002583 horizontal Start diff mode with horizontal splits (unless
2584 explicitly specified otherwise).
2585
2586 vertical Start diff mode with vertical splits (unless
2587 explicitly specified otherwise).
2588
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002589 hiddenoff Do not use diff mode for a buffer when it
2590 becomes hidden.
2591
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002592 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2593 starting diff mode. Without this 2 is used.
2594
Bram Moolenaare828b762018-09-10 17:51:58 +02002595 internal Use the internal diff library. This is
2596 ignored when 'diffexpr' is set. *E960*
2597 When running out of memory when writing a
2598 buffer this item will be ignored for diffs
2599 involving that buffer. Set the 'verbose'
2600 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601
Bram Moolenaare828b762018-09-10 17:51:58 +02002602 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002603 Use the indent heuristic for the internal
2604 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002605
2606 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002607 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002608 algorithms are:
2609 myers the default algorithm
2610 minimal spend extra time to generate the
2611 smallest possible diff
2612 patience patience diff algorithm
2613 histogram histogram diff algorithm
2614
2615 Examples: >
2616 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002617 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002618 :set diffopt=internal,filler,foldcolumn:3
2619 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002620<
2621 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2622'digraph' 'dg' boolean (default off)
2623 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 {not available when compiled without the |+digraphs|
2625 feature}
2626 Enable the entering of digraphs in Insert mode with {char1} <BS>
2627 {char2}. See |digraphs|.
2628 NOTE: This option is reset when 'compatible' is set.
2629
2630 *'directory'* *'dir'*
2631'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002632 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 for Unix: ".,~/tmp,/var/tmp,/tmp")
2634 global
2635 List of directory names for the swap file, separated with commas.
2636 - The swap file will be created in the first directory where this is
2637 possible.
2638 - Empty means that no swap file will be used (recovery is
2639 impossible!).
2640 - A directory "." means to put the swap file in the same directory as
2641 the edited file. On Unix, a dot is prepended to the file name, so
2642 it doesn't show in a directory listing. On MS-Windows the "hidden"
2643 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002644 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645 put the swap file relative to where the edited file is. The leading
2646 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002647 - For Unix and Win32, if a directory ends in two path separators "//",
2648 the swap file name will be built from the complete path to the file
2649 with all path separators substituted to percent '%' signs. This will
2650 ensure file name uniqueness in the preserve directory.
2651 On Win32, it is also possible to end with "\\". However, When a
2652 separating comma is following, you must use "//", since "\\" will
2653 include the comma in the file name. Therefore it is recommended to
2654 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655 - Spaces after the comma are ignored, other spaces are considered part
2656 of the directory name. To have a space at the start of a directory
2657 name, precede it with a backslash.
2658 - To include a comma in a directory name precede it with a backslash.
2659 - A directory name may end in an ':' or '/'.
2660 - Environment variables are expanded |:set_env|.
2661 - Careful with '\' characters, type one before a space, type two to
2662 get one in the option (see |option-backslash|), for example: >
2663 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2664< - For backwards compatibility with Vim version 3.0 a '>' at the start
2665 of the option is removed.
2666 Using "." first in the list is recommended. This means that editing
2667 the same file twice will result in a warning. Using "/tmp" on Unix is
2668 discouraged: When the system crashes you lose the swap file.
2669 "/var/tmp" is often not cleared when rebooting, thus is a better
2670 choice than "/tmp". But it can contain a lot of files, your swap
2671 files get lost in the crowd. That is why a "tmp" directory in your
2672 home directory is tried first.
2673 The use of |:set+=| and |:set-=| is preferred when adding or removing
2674 directories from the list. This avoids problems when a future version
2675 uses another default.
2676 This option cannot be set from a |modeline| or in the |sandbox|, for
2677 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678
2679 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002680'display' 'dy' string (default "", set to "truncate" in
2681 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 Change the way text is displayed. This is comma separated list of
2684 flags:
2685 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002686 in a window will be displayed. "@@@" is put in the
2687 last columns of the last screen line to indicate the
2688 rest of the line is not displayed.
2689 truncate Like "lastline", but "@@@" is displayed in the first
2690 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691 uhex Show unprintable characters hexadecimal as <xx>
2692 instead of using ^C and ~C.
2693
Bram Moolenaard0796902016-09-16 20:02:31 +02002694 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002695 doesn't fit is replaced with "@" lines.
2696
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 *'eadirection'* *'ead'*
2698'eadirection' 'ead' string (default "both")
2699 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02002700 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 feature}
2702 Tells when the 'equalalways' option applies:
2703 ver vertically, width of windows is not affected
2704 hor horizontally, height of windows is not affected
2705 both width and height of windows is affected
2706
2707 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2708'edcompatible' 'ed' boolean (default off)
2709 global
2710 Makes the 'g' and 'c' flags of the ":substitute" command to be
2711 toggled each time the flag is given. See |complex-change|. See
2712 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002713 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714
Bram Moolenaar03413f42016-04-12 21:07:15 +02002715 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002716'emoji' 'emo' boolean (default: on)
2717 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002718 When on all Unicode emoji characters are considered to be full width.
2719
2720
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721 *'encoding'* *'enc'* *E543*
2722'encoding' 'enc' string (default: "latin1" or value from $LANG)
2723 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 Sets the character encoding used inside Vim. It applies to text in
2725 the buffers, registers, Strings in expressions, text stored in the
2726 viminfo file, etc. It sets the kind of characters which Vim can work
2727 with. See |encoding-names| for the possible values.
2728
2729 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002730 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002732 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733
Bram Moolenaar865242e2010-07-14 21:12:05 +02002734 This option cannot be set from a |modeline|. It would most likely
2735 corrupt the text.
2736
Bram Moolenaar3df01732017-02-17 22:47:16 +01002737 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2738 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739 'encoding', "utf-8" is the natural choice for the environment and
2740 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002741 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 versions, and to avoid changing the encoding of newly created files
2743 without your knowledge (in case 'fileencodings' is empty).
2744
2745 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002746 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002747 iconv() or as specified with 'charconvert'.
2748
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002749 If you need to know whether 'encoding' is a multi-byte encoding, you
2750 can use: >
2751 if has("multi_byte_encoding")
2752<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 Normally 'encoding' will be equal to your current locale. This will
2754 be the default if Vim recognizes your environment settings. If
2755 'encoding' is not set to the current locale, 'termencoding' must be
2756 set to convert typed and displayed text. See |encoding-table|.
2757
2758 When you set this option, it fires the |EncodingChanged| autocommand
2759 event so that you can set up fonts if necessary.
2760
2761 When the option is set, the value is converted to lowercase. Thus
2762 you can set it with uppercase values too. Underscores are translated
2763 to '-' signs.
2764 When the encoding is recognized, it is changed to the standard name.
2765 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2766 "iso-8859-2" and "utf8" becomes "utf-8".
2767
2768 Note: "latin1" is also used when the encoding could not be detected.
2769 This only works when editing files in the same encoding! When the
2770 actual character set is not latin1, make sure 'fileencoding' and
2771 'fileencodings' are empty. When conversion is needed, switch to using
2772 utf-8.
2773
2774 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2775 You don't notice this while editing, but it does matter for the
2776 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2777 setting 'encoding' to one of these values instead of utf-8 only has
2778 effect for encoding used for files when 'fileencoding' is empty.
2779
Bram Moolenaar661b1822005-07-28 22:36:45 +00002780 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2781 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782
2783 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2784'endofline' 'eol' boolean (default on)
2785 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002787 is on, or 'fixeol' option is off, no <EOL> will be written for the
2788 last line in the file. This option is automatically set or reset when
2789 starting to edit a new file, depending on whether file has an <EOL>
2790 for the last line in the file. Normally you don't have to set or
2791 reset this option.
2792 When 'binary' is off and 'fixeol' is on the value is not used when
2793 writing the file. When 'binary' is on or 'fixeol' is off it is used
2794 to remember the presence of a <EOL> for the last line in the file, so
2795 that when you write the file the situation from the original file can
2796 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797
2798 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2799'equalalways' 'ea' boolean (default on)
2800 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002802 splitting or closing a window. This also happens the moment the
2803 option is switched on. When off, splitting a window will reduce the
2804 size of the current window and leave the other windows the same. When
2805 closing a window the extra lines are given to the window next to it
2806 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 When mixing vertically and horizontally split windows, a minimal size
2808 is computed and some windows may be larger if there is room. The
2809 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002810 Changing the height and width of a window can be avoided by setting
2811 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002812 If a window size is specified when creating a new window sizes are
2813 currently not equalized (it's complicated, but may be implemented in
2814 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815
2816 *'equalprg'* *'ep'*
2817'equalprg' 'ep' string (default "")
2818 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002820 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002821 or 'indentexpr'. When Vim was compiled without internal formatting,
2822 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002823 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824 about including spaces and backslashes.
2825 This option cannot be set from a |modeline| or in the |sandbox|, for
2826 security reasons.
2827
2828 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2829'errorbells' 'eb' boolean (default off)
2830 global
2831 Ring the bell (beep or screen flash) for error messages. This only
2832 makes a difference for error messages, the bell will be used always
2833 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002834 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002835 screen flash or do nothing. See 'belloff' to finetune when to ring the
2836 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837
2838 *'errorfile'* *'ef'*
2839'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2840 others: "errors.err")
2841 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 {not available when compiled without the |+quickfix|
2843 feature}
2844 Name of the errorfile for the QuickFix mode (see |:cf|).
2845 When the "-q" command-line argument is used, 'errorfile' is set to the
2846 following argument. See |-q|.
2847 NOT used for the ":make" command. See 'makeef' for that.
2848 Environment variables are expanded |:set_env|.
2849 See |option-backslash| about including spaces and backslashes.
2850 This option cannot be set from a |modeline| or in the |sandbox|, for
2851 security reasons.
2852
2853 *'errorformat'* *'efm'*
2854'errorformat' 'efm' string (default is very long)
2855 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856 {not available when compiled without the |+quickfix|
2857 feature}
2858 Scanf-like description of the format for the lines in the error file
2859 (see |errorformat|).
2860
2861 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2862'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2863 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864 Function keys that start with an <Esc> are recognized in Insert
2865 mode. When this option is off, the cursor and function keys cannot be
2866 used in Insert mode if they start with an <Esc>. The advantage of
2867 this is that the single <Esc> is recognized immediately, instead of
2868 after one second. Instead of resetting this option, you might want to
2869 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2870 when 'esckeys' is off, you can still map anything, but the cursor keys
2871 won't work by default.
2872 NOTE: This option is set to the Vi default value when 'compatible' is
2873 set and to the Vim default value when 'compatible' is reset.
2874
2875 *'eventignore'* *'ei'*
2876'eventignore' 'ei' string (default "")
2877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002879 When set to "all" or when "all" is one of the items, all autocommand
2880 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881 Otherwise this is a comma separated list of event names. Example: >
2882 :set ei=WinEnter,WinLeave
2883<
2884 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2885'expandtab' 'et' boolean (default off)
2886 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002888 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2890 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002891 This option is reset when the 'paste' option is set and restored when
2892 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 NOTE: This option is reset when 'compatible' is set.
2894
2895 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2896'exrc' 'ex' boolean (default off)
2897 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002899 directory.
2900
2901 Setting this option is a potential security leak. E.g., consider
2902 unpacking a package or fetching files from github, a .vimrc in there
2903 might be a trojan horse. BETTER NOT SET THIS OPTION!
2904 Instead, define an autocommand in your .vimrc to set options for a
2905 matching directory.
2906
2907 If you do switch this option on you should also consider setting the
2908 'secure' option (see |initialization|).
2909 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 This option cannot be set from a |modeline| or in the |sandbox|, for
2911 security reasons.
2912
2913 *'fileencoding'* *'fenc'* *E213*
2914'fileencoding' 'fenc' string (default: "")
2915 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002917
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002919 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 When 'fileencoding' is empty, the same value as 'encoding' will be
2921 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002922 No error will be given when the value is set, only when it is used,
2923 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002924 Conversion will also be done when 'encoding' and 'fileencoding' are
2925 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2926 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002928 'encoding' is "utf-8" or another Unicode encoding, conversion
2929 is most likely done in a way that the reverse conversion
2930 results in the same text. When 'encoding' is not "utf-8" some
2931 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002932
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 See 'encoding' for the possible values. Additionally, values may be
2934 specified that can be handled by the converter, see
2935 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002936
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937 When reading a file 'fileencoding' will be set from 'fileencodings'.
2938 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002939 'fileencoding', use the |++enc| argument. One exception: when
2940 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002941 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002942
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2944 When the option is set, the value is converted to lowercase. Thus
2945 you can set it with uppercase values too. '_' characters are
2946 replaced with '-'. If a name is recognized from the list for
2947 'encoding', it is replaced by the standard name. For example
2948 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002949
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 When this option is set, after starting to edit a file, the 'modified'
2951 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002952
2953 Keep in mind that changing 'fenc' from a modeline happens
2954 AFTER the text has been read, thus it applies to when the file will be
2955 written. If you do set 'fenc' in a modeline, you might want to set
2956 'nomodified' to avoid not being able to ":q".
2957
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 This option can not be changed when 'modifiable' is off.
2959
2960 *'fe'*
2961 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002962 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 old short name was 'fe', which is no longer used.
2964
2965 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002966'fileencodings' 'fencs' string (default: "ucs-bom",
2967 "ucs-bom,utf-8,default,latin1" when
2968 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 This is a list of character encodings considered when starting to edit
2971 an existing file. When a file is read, Vim tries to use the first
2972 mentioned character encoding. If an error is detected, the next one
2973 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002974 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 an empty string, which means the value of 'encoding' is used.
2976 WARNING: Conversion can cause loss of information! When
2977 'encoding' is "utf-8" (or one of the other Unicode variants)
2978 conversion is most likely done in a way that the reverse
2979 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002980 "utf-8" some non-ASCII characters may be lost! You can use
2981 the |++bad| argument to specify what is done with characters
2982 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983 For an empty file or a file with only ASCII characters most encodings
2984 will work and the first entry of 'fileencodings' will be used (except
2985 "ucs-bom", which requires the BOM to be present). If you prefer
2986 another encoding use an BufReadPost autocommand event to test if your
2987 preferred encoding is to be used. Example: >
2988 au BufReadPost * if search('\S', 'w') == 0 |
2989 \ set fenc=iso-2022-jp | endif
2990< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2991 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002992 When the |++enc| argument is used then the value of 'fileencodings' is
2993 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002994 Note that 'fileencodings' is not used for a new file, the global value
2995 of 'fileencoding' is used instead. You can set it with: >
2996 :setglobal fenc=iso-8859-2
2997< This means that a non-existing file may get a different encoding than
2998 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 The special value "ucs-bom" can be used to check for a Unicode BOM
3000 (Byte Order Mark) at the start of the file. It must not be preceded
3001 by "utf-8" or another Unicode encoding for this to work properly.
3002 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3003 because Vim cannot detect an error, thus the encoding is always
3004 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003005 The special value "default" can be used for the encoding from the
3006 environment. This is the default value for 'encoding'. It is useful
3007 when 'encoding' is set to "utf-8" and your environment uses a
3008 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003009 When 'encoding' is "utf-8" and a file contains an illegal byte
3010 sequence it won't be recognized as UTF-8. You can use the |8g8|
3011 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 WRONG VALUES: WHAT'S WRONG:
3013 latin1,utf-8 "latin1" will always be used
3014 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3015 file
3016 cp1250,latin1 "cp1250" will always be used
3017 If 'fileencodings' is empty, 'fileencoding' is not modified.
3018 See 'fileencoding' for the possible values.
3019 Setting this option does not have an effect until the next time a file
3020 is read.
3021
3022 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003023'fileformat' 'ff' string (MS-Windows default: "dos",
3024 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 This gives the <EOL> of the current buffer, which is used for
3027 reading/writing the buffer from/to a file:
3028 dos <CR> <NL>
3029 unix <NL>
3030 mac <CR>
3031 When "dos" is used, CTRL-Z at the end of a file is ignored.
3032 See |file-formats| and |file-read|.
3033 For the character encoding of the file see 'fileencoding'.
3034 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003035 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 This option is set automatically when starting to edit a file and
3037 'fileformats' is not empty and 'binary' is off.
3038 When this option is set, after starting to edit a file, the 'modified'
3039 option is set, because the file would be different when written.
3040 This option can not be changed when 'modifiable' is off.
3041 For backwards compatibility: When this option is set to "dos",
3042 'textmode' is set, otherwise 'textmode' is reset.
3043
3044 *'fileformats'* *'ffs'*
3045'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003046 Vim+Vi MS-Windows: "dos,unix",
3047 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048 Vi Cygwin: "unix,dos",
3049 Vi others: "")
3050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 This gives the end-of-line (<EOL>) formats that will be tried when
3052 starting to edit a new buffer and when reading a file into an existing
3053 buffer:
3054 - When empty, the format defined with 'fileformat' will be used
3055 always. It is not set automatically.
3056 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003057 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058 'fileformats' name will be used when a file is read into an existing
3059 buffer, no matter what 'fileformat' for that buffer is set to.
3060 - When more than one name is present, separated by commas, automatic
3061 <EOL> detection will be done when reading a file. When starting to
3062 edit a file, a check is done for the <EOL>:
3063 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3064 'fileformat' is set to "dos".
3065 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003066 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003068 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3069 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003070 This means that "mac" is only chosen when:
3071 "unix" is not present or no <NL> is found in the file, and
3072 "dos" is not present or no <CR><NL> is found in the file.
3073 Except: if "unix" was chosen, but there is a <CR> before
3074 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003075 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 4. If 'fileformat' is still not set, the first name from
3077 'fileformats' is used.
3078 When reading a file into an existing buffer, the same is done, but
3079 this happens like 'fileformat' has been set appropriately for that
3080 file only, the option is not changed.
3081 When 'binary' is set, the value of 'fileformats' is not used.
3082
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003083 When Vim starts up with an empty buffer the first item is used. You
3084 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003085
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3087 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3088 done:
3089 - When 'fileformats' is empty, there is no automatic detection. Dos
3090 format will be used.
3091 - When 'fileformats' is set to one or more names, automatic detection
3092 is done. This is based on the first <NL> in the file: If there is a
3093 <CR> in front of it, Dos format is used, otherwise Unix format is
3094 used.
3095 Also see |file-formats|.
3096 For backwards compatibility: When this option is set to an empty
3097 string or one format (no comma is included), 'textauto' is reset,
3098 otherwise 'textauto' is set.
3099 NOTE: This option is set to the Vi default value when 'compatible' is
3100 set and to the Vim default value when 'compatible' is reset.
3101
Bram Moolenaarbf884932013-04-05 22:26:15 +02003102 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3103'fileignorecase' 'fic' boolean (default on for systems where case in file
3104 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003105 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003106 When set case is ignored when using file names and directories.
3107 See 'wildignorecase' for only ignoring case when doing completion.
3108
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 *'filetype'* *'ft'*
3110'filetype' 'ft' string (default: "")
3111 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 When this option is set, the FileType autocommand event is triggered.
3113 All autocommands that match with the value of this option will be
3114 executed. Thus the value of 'filetype' is used in place of the file
3115 name.
3116 Otherwise this option does not always reflect the current file type.
3117 This option is normally set when the file type is detected. To enable
3118 this use the ":filetype on" command. |:filetype|
3119 Setting this option to a different value is most useful in a modeline,
3120 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003121 Example, for in an IDL file:
3122 /* vim: set filetype=idl : */ ~
3123 |FileType| |filetypes|
3124 When a dot appears in the value then this separates two filetype
3125 names. Example:
3126 /* vim: set filetype=c.doxygen : */ ~
3127 This will use the "c" filetype first, then the "doxygen" filetype.
3128 This works both for filetype plugins and for syntax files. More than
3129 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 This option is not copied to another buffer, independent of the 's' or
3131 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003132 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133
3134 *'fillchars'* *'fcs'*
3135'fillchars' 'fcs' string (default "vert:|,fold:-")
3136 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 {not available when compiled without the |+windows|
3138 and |+folding| features}
3139 Characters to fill the statuslines and vertical separators.
3140 It is a comma separated list of items:
3141
3142 item default Used for ~
3143 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003144 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 vert:c '|' vertical separators |:vsplit|
3146 fold:c '-' filling 'foldtext'
3147 diff:c '-' deleted lines of the 'diff' option
3148
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003149 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003150 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 otherwise.
3152
3153 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003154 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155< This is similar to the default, except that these characters will also
3156 be used when there is highlighting.
3157
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003158 for "stl" and "stlnc" only single-byte values are supported.
3159
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 The highlighting used for these items:
3161 item highlight group ~
3162 stl:c StatusLine |hl-StatusLine|
3163 stlnc:c StatusLineNC |hl-StatusLineNC|
3164 vert:c VertSplit |hl-VertSplit|
3165 fold:c Folded |hl-Folded|
3166 diff:c DiffDelete |hl-DiffDelete|
3167
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003168 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3169'fixendofline' 'fixeol' boolean (default on)
3170 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003171 When writing a file and this option is on, <EOL> at the end of file
3172 will be restored if missing. Turn this option off if you want to
3173 preserve the situation from the original file.
3174 When the 'binary' option is set the value of this option doesn't
3175 matter.
3176 See the 'endofline' option.
3177
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3179'fkmap' 'fk' boolean (default off) *E198*
3180 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 {only available when compiled with the |+rightleft|
3182 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003183 This option was for using Farsi, which has been removed. See
3184 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185
3186 *'foldclose'* *'fcl'*
3187'foldclose' 'fcl' string (default "")
3188 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 {not available when compiled without the |+folding|
3190 feature}
3191 When set to "all", a fold is closed when the cursor isn't in it and
3192 its level is higher than 'foldlevel'. Useful if you want folds to
3193 automatically close when moving out of them.
3194
3195 *'foldcolumn'* *'fdc'*
3196'foldcolumn' 'fdc' number (default 0)
3197 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 {not available when compiled without the |+folding|
3199 feature}
3200 When non-zero, a column with the specified width is shown at the side
3201 of the window which indicates open and closed folds. The maximum
3202 value is 12.
3203 See |folding|.
3204
3205 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3206'foldenable' 'fen' boolean (default on)
3207 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 {not available when compiled without the |+folding|
3209 feature}
3210 When off, all folds are open. This option can be used to quickly
3211 switch between showing all text unfolded and viewing the text with
3212 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003213 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 'foldenable' is off.
3215 This option is set by commands that create a new fold or close a fold.
3216 See |folding|.
3217
3218 *'foldexpr'* *'fde'*
3219'foldexpr' 'fde' string (default: "0")
3220 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003222 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003224 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003225
Bram Moolenaar30b65812012-07-12 22:01:11 +02003226 The expression will be evaluated in the |sandbox| if set from a
3227 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003228 This option can't be set from a |modeline| when the 'diff' option is
3229 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003230
3231 It is not allowed to change text or jump to another window while
3232 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233
3234 *'foldignore'* *'fdi'*
3235'foldignore' 'fdi' string (default: "#")
3236 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 {not available when compiled without the |+folding|
3238 feature}
3239 Used only when 'foldmethod' is "indent". Lines starting with
3240 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003241 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 The default "#" works well for C programs. See |fold-indent|.
3243
3244 *'foldlevel'* *'fdl'*
3245'foldlevel' 'fdl' number (default: 0)
3246 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 {not available when compiled without the |+folding|
3248 feature}
3249 Sets the fold level: Folds with a higher level will be closed.
3250 Setting this option to zero will close all folds. Higher numbers will
3251 close fewer folds.
3252 This option is set by commands like |zm|, |zM| and |zR|.
3253 See |fold-foldlevel|.
3254
3255 *'foldlevelstart'* *'fdls'*
3256'foldlevelstart' 'fdls' number (default: -1)
3257 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 {not available when compiled without the |+folding|
3259 feature}
3260 Sets 'foldlevel' when starting to edit another buffer in a window.
3261 Useful to always start editing with all folds closed (value zero),
3262 some folds closed (one) or no folds closed (99).
3263 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003264 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 ignores this option and closes all folds.
3266 It is also done before BufReadPre autocommands, to allow an autocmd to
3267 overrule the 'foldlevel' value for specific files.
3268 When the value is negative, it is not used.
3269
3270 *'foldmarker'* *'fmr'* *E536*
3271'foldmarker' 'fmr' string (default: "{{{,}}}")
3272 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273 {not available when compiled without the |+folding|
3274 feature}
3275 The start and end marker used when 'foldmethod' is "marker". There
3276 must be one comma, which separates the start and end marker. The
3277 marker is a literal string (a regular expression would be too slow).
3278 See |fold-marker|.
3279
3280 *'foldmethod'* *'fdm'*
3281'foldmethod' 'fdm' string (default: "manual")
3282 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 {not available when compiled without the |+folding|
3284 feature}
3285 The kind of folding used for the current window. Possible values:
3286 |fold-manual| manual Folds are created manually.
3287 |fold-indent| indent Lines with equal indent form a fold.
3288 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3289 |fold-marker| marker Markers are used to specify folds.
3290 |fold-syntax| syntax Syntax highlighting items specify folds.
3291 |fold-diff| diff Fold text that is not changed.
3292
3293 *'foldminlines'* *'fml'*
3294'foldminlines' 'fml' number (default: 1)
3295 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 {not available when compiled without the |+folding|
3297 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003298 Sets the number of screen lines above which a fold can be displayed
3299 closed. Also for manually closed folds. With the default value of
3300 one a fold can only be closed if it takes up two or more screen lines.
3301 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003302 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 "zc" to close a fold, which is displayed open because it's smaller
3304 than 'foldminlines', a following "zc" may close a containing fold.
3305
3306 *'foldnestmax'* *'fdn'*
3307'foldnestmax' 'fdn' number (default: 20)
3308 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 {not available when compiled without the |+folding|
3310 feature}
3311 Sets the maximum nesting of folds for the "indent" and "syntax"
3312 methods. This avoids that too many folds will be created. Using more
3313 than 20 doesn't work, because the internal limit is 20.
3314
3315 *'foldopen'* *'fdo'*
3316'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3317 search,tag,undo")
3318 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 {not available when compiled without the |+folding|
3320 feature}
3321 Specifies for which type of commands folds will be opened, if the
3322 command moves the cursor into a closed fold. It is a comma separated
3323 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003324 NOTE: When the command is part of a mapping this option is not used.
3325 Add the |zv| command to the mapping to get the same effect.
3326 (rationale: the mapping may want to control opening folds itself)
3327
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 item commands ~
3329 all any
3330 block "(", "{", "[[", "[{", etc.
3331 hor horizontal movements: "l", "w", "fx", etc.
3332 insert any command in Insert mode
3333 jump far jumps: "G", "gg", etc.
3334 mark jumping to a mark: "'m", CTRL-O, etc.
3335 percent "%"
3336 quickfix ":cn", ":crew", ":make", etc.
3337 search search for a pattern: "/", "n", "*", "gd", etc.
3338 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003339 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 tag jumping to a tag: ":ta", CTRL-T, etc.
3341 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 When a movement command is used for an operator (e.g., "dl" or "y%")
3343 this option is not used. This means the operator will include the
3344 whole closed fold.
3345 Note that vertical movements are not here, because it would make it
3346 very difficult to move onto a closed fold.
3347 In insert mode the folds containing the cursor will always be open
3348 when text is inserted.
3349 To close folds you can re-apply 'foldlevel' with the |zx| command or
3350 set the 'foldclose' option to "all".
3351
3352 *'foldtext'* *'fdt'*
3353'foldtext' 'fdt' string (default: "foldtext()")
3354 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 {not available when compiled without the |+folding|
3356 feature}
3357 An expression which is used to specify the text displayed for a closed
3358 fold. See |fold-foldtext|.
3359
Bram Moolenaar30b65812012-07-12 22:01:11 +02003360 The expression will be evaluated in the |sandbox| if set from a
3361 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003362
3363 It is not allowed to change text or jump to another window while
3364 evaluating 'foldtext' |textlock|.
3365
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003366 *'formatexpr'* *'fex'*
3367'formatexpr' 'fex' string (default "")
3368 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003369 {not available when compiled without the |+eval|
3370 feature}
3371 Expression which is evaluated to format a range of lines for the |gq|
3372 operator or automatic formatting (see 'formatoptions'). When this
3373 option is empty 'formatprg' is used.
3374
3375 The |v:lnum| variable holds the first line to be formatted.
3376 The |v:count| variable holds the number of lines to be formatted.
3377 The |v:char| variable holds the character that is going to be
3378 inserted if the expression is being evaluated due to
3379 automatic formatting. This can be empty. Don't insert
3380 it yet!
3381
3382 Example: >
3383 :set formatexpr=mylang#Format()
3384< This will invoke the mylang#Format() function in the
3385 autoload/mylang.vim file in 'runtimepath'. |autoload|
3386
3387 The expression is also evaluated when 'textwidth' is set and adding
3388 text beyond that limit. This happens under the same conditions as
3389 when internal formatting is used. Make sure the cursor is kept in the
3390 same spot relative to the text then! The |mode()| function will
3391 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003392
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003393 When the expression evaluates to non-zero Vim will fall back to using
3394 the internal format mechanism.
3395
3396 The expression will be evaluated in the |sandbox| when set from a
3397 modeline, see |sandbox-option|. That stops the option from working,
3398 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003399 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003400
Bram Moolenaar86b68352004-12-27 21:59:20 +00003401 *'formatlistpat'* *'flp'*
3402'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3403 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003404 A pattern that is used to recognize a list header. This is used for
3405 the "n" flag in 'formatoptions'.
3406 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003407 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003408 while still checking more characters. There must be a character
3409 following the pattern, when it matches the whole line it is handled
3410 like there is no match.
3411 The default recognizes a number, followed by an optional punctuation
3412 character and white space.
3413
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003414 *'formatoptions'* *'fo'*
3415'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3416 local to buffer
3417 This is a sequence of letters which describes how automatic
3418 formatting is to be done. See |fo-table|. When the 'paste' option is
3419 on, no formatting is done (like 'formatoptions' is empty). Commas can
3420 be inserted for readability.
3421 To avoid problems with flags that are added in the future, use the
3422 "+=" and "-=" feature of ":set" |add-option-flags|.
3423 NOTE: This option is set to the Vi default value when 'compatible' is
3424 set and to the Vim default value when 'compatible' is reset.
3425
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 *'formatprg'* *'fp'*
3427'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003428 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003430 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003432 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003433 If the 'formatexpr' option is not empty it will be used instead.
3434 Otherwise, if 'formatprg' option is an empty string, the internal
3435 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003436 Environment variables are expanded |:set_env|. See |option-backslash|
3437 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003438 This option cannot be set from a |modeline| or in the |sandbox|, for
3439 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440
Bram Moolenaard94464e2015-11-02 15:28:18 +01003441 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003442'fsync' 'fs' boolean (default on)
3443 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003444 When on, the library function fsync() will be called after writing a
3445 file. This will flush a file to disk, ensuring that it is safely
3446 written even on filesystems which do metadata-only journaling. This
3447 will force the harddrive to spin up on Linux systems running in laptop
3448 mode, so it may be undesirable in some situations. Be warned that
3449 turning this off increases the chances of data loss after a crash. On
3450 systems without an fsync() implementation, this variable is always
3451 off.
3452 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003453 'fsync' also applies to |writefile()|, unless a flag is used to
3454 overrule it.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003455
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3457'gdefault' 'gd' boolean (default off)
3458 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 When on, the ":substitute" flag 'g' is default on. This means that
3460 all matches in a line are substituted instead of one. When a 'g' flag
3461 is given to a ":substitute" command, this will toggle the substitution
3462 of all or one match. See |complex-change|.
3463
3464 command 'gdefault' on 'gdefault' off ~
3465 :s/// subst. all subst. one
3466 :s///g subst. one subst. all
3467 :s///gg subst. all subst. one
3468
3469 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003470 DEPRECATED: Setting this option may break plugins that are not aware
3471 of this option. Also, many users get confused that adding the /g flag
3472 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473
3474 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003475'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 Format to recognize for the ":grep" command output.
3478 This is a scanf-like string that uses the same format as the
3479 'errorformat' option: see |errorformat|.
3480
3481 *'grepprg'* *'gp'*
3482'grepprg' 'gp' string (default "grep -n ",
3483 Unix: "grep -n $* /dev/null",
3484 Win32: "findstr /n" or "grep -n",
3485 VMS: "SEARCH/NUMBERS ")
3486 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003487 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 and '#' characters, which are expanded like when used in a command-
3489 line. The placeholder "$*" is allowed to specify where the arguments
3490 will be included. Environment variables are expanded |:set_env|. See
3491 |option-backslash| about including spaces and backslashes.
3492 When your "grep" accepts the "-H" argument, use this to make ":grep"
3493 also work well with a single file: >
3494 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003495< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003496 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3497 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003498 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 apply equally to 'grepprg'.
3500 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3501 otherwise it's "grep -n".
3502 This option cannot be set from a |modeline| or in the |sandbox|, for
3503 security reasons.
3504
3505 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3506'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3507 ve:ver35-Cursor,
3508 o:hor50-Cursor,
3509 i-ci:ver25-Cursor/lCursor,
3510 r-cr:hor20-Cursor/lCursor,
3511 sm:block-Cursor
3512 -blinkwait175-blinkoff150-blinkon175",
3513 for MS-DOS and Win32 console:
3514 "n-v-c:block,o:hor50,i-ci:hor15,
3515 r-cr:hor30,sm:block")
3516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517 {only available when compiled with GUI enabled, and
3518 for MS-DOS and Win32 console}
3519 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003520 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 the height of the cursor can be changed. This can be done by
3522 specifying a block cursor, or a percentage for a vertical or
3523 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003524 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3525 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003527 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528 mode-list and an argument-list:
3529 mode-list:argument-list,mode-list:argument-list,..
3530 The mode-list is a dash separated list of these modes:
3531 n Normal mode
3532 v Visual mode
3533 ve Visual mode with 'selection' "exclusive" (same as 'v',
3534 if not specified)
3535 o Operator-pending mode
3536 i Insert mode
3537 r Replace mode
3538 c Command-line Normal (append) mode
3539 ci Command-line Insert mode
3540 cr Command-line Replace mode
3541 sm showmatch in Insert mode
3542 a all modes
3543 The argument-list is a dash separated list of these arguments:
3544 hor{N} horizontal bar, {N} percent of the character height
3545 ver{N} vertical bar, {N} percent of the character width
3546 block block cursor, fills the whole character
3547 [only one of the above three should be present]
3548 blinkwait{N} *cursor-blinking*
3549 blinkon{N}
3550 blinkoff{N}
3551 blink times for cursor: blinkwait is the delay before
3552 the cursor starts blinking, blinkon is the time that
3553 the cursor is shown and blinkoff is the time that the
3554 cursor is not shown. The times are in msec. When one
3555 of the numbers is zero, there is no blinking. The
3556 default is: "blinkwait700-blinkon400-blinkoff250".
3557 These numbers are used for a missing entry. This
3558 means that blinking is enabled by default. To switch
3559 blinking off you can use "blinkon0". The cursor only
3560 blinks when Vim is waiting for input, not while
3561 executing a command.
3562 To make the cursor blink in an xterm, see
3563 |xterm-blink|.
3564 {group-name}
3565 a highlight group name, that sets the color and font
3566 for the cursor
3567 {group-name}/{group-name}
3568 Two highlight group names, the first is used when
3569 no language mappings are used, the other when they
3570 are. |language-mapping|
3571
3572 Examples of parts:
3573 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3574 block cursor with colors from the "nCursor"
3575 highlight group
3576 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3577 In Insert and Command-line Insert mode, use a
3578 30% vertical bar cursor with colors from the
3579 "iCursor" highlight group. Blink a bit
3580 faster.
3581
3582 The 'a' mode is different. It will set the given argument-list for
3583 all modes. It does not reset anything to defaults. This can be used
3584 to do a common setting for all modes. For example, to switch off
3585 blinking: "a:blinkon0"
3586
3587 Examples of cursor highlighting: >
3588 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3589 :highlight Cursor gui=NONE guifg=bg guibg=fg
3590<
3591 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003592 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593'guifont' 'gfn' string (default "")
3594 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 {only available when compiled with GUI enabled}
3596 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003597 In its simplest form the value is just one font name.
3598 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599
3600 *'guifontset'* *'gfs'*
3601 *E250* *E252* *E234* *E597* *E598*
3602'guifontset' 'gfs' string (default "")
3603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 {only available when compiled with GUI enabled and
3605 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003606 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607 When not empty, specifies two (or more) fonts to be used. The first
3608 one for normal English, the second one for your special language. See
3609 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003610
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3612'guifontwide' 'gfw' string (default "")
3613 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 {only available when compiled with GUI enabled}
3615 When not empty, specifies a comma-separated list of fonts to be used
3616 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003617 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003618
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 *'guiheadroom'* *'ghr'*
3620'guiheadroom' 'ghr' number (default 50)
3621 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003622- {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003623 The number of pixels subtracted from the screen height when fitting
3624 the GUI window on the screen. Set this before the GUI is started,
3625 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003626 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 lines will be left for window decorations and other items on the
3628 screen. Set it to a negative value to allow windows taller than the
3629 screen.
3630
3631 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003632'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3633 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003634 "aegimrLtT" (GTK, Motif and Athena),
3635 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003638 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 sequence of letters which describes what components and options of the
3640 GUI should be used.
3641 To avoid problems with flags that are added in the future, use the
3642 "+=" and "-=" feature of ":set" |add-option-flags|.
3643
Bram Moolenaar13568252018-03-16 20:46:58 +01003644 Valid characters are as follows:
3645 *'go-!'*
3646 '!' External commands are executed in a terminal window. Without
3647 this flag the MS-Windows GUI will open a console window to
3648 execute the command. The Unix GUI will simulate a dumb
3649 terminal to list the command output.
3650 The terminal window will be positioned at the bottom, and grow
3651 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003652 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653 'a' Autoselect: If present, then whenever VISUAL mode is started,
3654 or the Visual area extended, Vim tries to become the owner of
3655 the windowing system's global selection. This means that the
3656 Visually highlighted text is available for pasting into other
3657 applications as well as into Vim itself. When the Visual mode
3658 ends, possibly due to an operation on the text, or when an
3659 application wants to paste the selection, the highlighted text
3660 is automatically yanked into the "* selection register.
3661 Thus the selection is still available for pasting into other
3662 applications after the VISUAL mode has ended.
3663 If not present, then Vim won't become the owner of the
3664 windowing system's global selection unless explicitly told to
3665 by a yank or delete operation for the "* register.
3666 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003667 *'go-P'*
3668 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003669 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003670 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003671 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 applies to the modeless selection.
3673
3674 'guioptions' autoselect Visual autoselect modeless ~
3675 "" - -
3676 "a" yes yes
3677 "A" - yes
3678 "aA" yes yes
3679
Bram Moolenaar02467872007-05-06 13:22:01 +00003680 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 'c' Use console dialogs instead of popup dialogs for simple
3682 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003683 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003684 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003685 'guitablabel' can be used to change the text in the labels.
3686 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003687 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003688 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003689 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 'f' Foreground: Don't use fork() to detach the GUI from the shell
3691 where it was started. Use this for programs that wait for the
3692 editor to finish (e.g., an e-mail program). Alternatively you
3693 can use "gvim -f" or ":gui -f" to start the GUI in the
3694 foreground. |gui-fork|
3695 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003696 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003697 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3699 corner of the window. It's black&white on non-GTK, because of
3700 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003701 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003703 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003704 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003706 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003708 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003709 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 'g' Grey menu items: Make menu items that are not active grey. If
3711 'g' is not included inactive menu items are not shown at all.
3712 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003713 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 't' Include tearoff menu items. Currently only works for Win32,
3715 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003716 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003717 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003718 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003719 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003721 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 'R' Right-hand scrollbar is present when there is a vertically
3723 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003724 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003726 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727 'L' Left-hand scrollbar is present when there is a vertically
3728 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003729 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3731 the longest visible line, or on the cursor line if the 'h'
3732 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003733 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 'h' Limit horizontal scrollbar size to the length of the cursor
3735 line. Reduces computations. |gui-horiz-scroll|
3736
3737 And yes, you may even have scrollbars on the left AND the right if
3738 you really want to :-). See |gui-scrollbars| for more information.
3739
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003740 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741 'v' Use a vertical button layout for dialogs. When not included,
3742 a horizontal layout is preferred, but when it doesn't fit a
3743 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003744 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 'p' Use Pointer callbacks for X11 GUI. This is required for some
3746 window managers. If the cursor is not blinking or hollow at
3747 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003748 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003750 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003751 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003752 *'go-k'*
3753 'k' Keep the GUI window size when adding/removing a scrollbar, or
3754 toolbar, tabline, etc. Instead, the behavior is similar to
3755 when the window is maximized and will adjust 'lines' and
3756 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003757 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003758 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003759
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 *'guipty'* *'noguipty'*
3761'guipty' boolean (default on)
3762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 {only available when compiled with GUI enabled}
3764 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3765 I/O to/from shell commands. See |gui-pty|.
3766
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003767 *'guitablabel'* *'gtl'*
3768'guitablabel' 'gtl' string (default empty)
3769 global
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003770 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003771 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003772 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003773 pages line. When empty and when the result is empty Vim will use a
3774 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003775
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003776 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003777 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003778 The expression will be evaluated in the |sandbox| when set from a
3779 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003780
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003781 Only used when the GUI tab pages line is displayed. 'e' must be
3782 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3783 used.
3784
Bram Moolenaar57657d82006-04-21 22:12:41 +00003785 *'guitabtooltip'* *'gtt'*
3786'guitabtooltip' 'gtt' string (default empty)
3787 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00003788 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003789 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003790 When nonempty describes the text to use in a tooltip for the GUI tab
3791 pages line. When empty Vim will use a default tooltip.
3792 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003793 You can include a line break. Simplest method is to use |:let|: >
3794 :let &guitabtooltip = "line one\nline two"
3795<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003796
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 *'helpfile'* *'hf'*
3798'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3799 (others) "$VIMRUNTIME/doc/help.txt")
3800 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801 Name of the main help file. All distributed help files should be
3802 placed together in one directory. Additionally, all "doc" directories
3803 in 'runtimepath' will be used.
3804 Environment variables are expanded |:set_env|. For example:
3805 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003806 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 spaces and backslashes.
3808 This option cannot be set from a |modeline| or in the |sandbox|, for
3809 security reasons.
3810
3811 *'helpheight'* *'hh'*
3812'helpheight' 'hh' number (default 20)
3813 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02003814 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 feature}
3816 Minimal initial height of the help window when it is opened with the
3817 ":help" command. The initial height of the help window is half of the
3818 current window, or (when the 'ea' option is on) the same as other
3819 windows. When the height is less than 'helpheight', the height is
3820 set to 'helpheight'. Set to zero to disable.
3821
3822 *'helplang'* *'hlg'*
3823'helplang' 'hlg' string (default: messages language or empty)
3824 global
3825 {only available when compiled with the |+multi_lang|
3826 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 Comma separated list of languages. Vim will use the first language
3828 for which the desired help can be found. The English help will always
3829 be used as a last resort. You can add "en" to prefer English over
3830 another language, but that will only find tags that exist in that
3831 language and not in the English help.
3832 Example: >
3833 :set helplang=de,it
3834< This will first search German, then Italian and finally English help
3835 files.
3836 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3837 try to find the tag in the current language before using this option.
3838 See |help-translated|.
3839
3840 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3841'hidden' 'hid' boolean (default off)
3842 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843 When off a buffer is unloaded when it is |abandon|ed. When on a
3844 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3845 displayed in another window, it does not become hidden, of course.
3846 The commands that move through the buffer list sometimes make a buffer
3847 hidden although the 'hidden' option is off: When the buffer is
3848 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003849 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003850 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 This option is set for one command with ":hide {command}" |:hide|.
3852 WARNING: It's easy to forget that you have changes in hidden buffers.
3853 Think twice when using ":q!" or ":qa!".
3854
3855 *'highlight'* *'hl'*
3856'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003857 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3858 d:Directory,e:ErrorMsg,i:IncSearch,
3859 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
3860 N:CursorLineNr,r:Question,s:StatusLine,
3861 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003862 v:Visual,V:VisualNOS,w:WarningMsg,
3863 W:WildMenu,f:Folded,F:FoldColumn,
3864 A:DiffAdd,C:DiffChange,D:DiffDelete,
3865 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003866 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003867 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003868 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3869 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003870 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003871 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 This option can be used to set highlighting mode for various
3874 occasions. It is a comma separated list of character pairs. The
3875 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003876 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003878 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3879 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 characters from 'showbreak'
3881 |hl-Directory| d directories in CTRL-D listing and other special
3882 things in listings
3883 |hl-ErrorMsg| e error messages
3884 h (obsolete, ignored)
3885 |hl-IncSearch| i 'incsearch' highlighting
3886 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3887 |hl-MoreMsg| m |more-prompt|
3888 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003889 |hl-LineNr| n line number for ":number" and ":#" commands, and
3890 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003891 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3892 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 |hl-Question| r |hit-enter| prompt and yes/no questions
3894 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003895 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3897 |hl-VertSplit| c column used to separate vertically split windows
3898 |hl-Visual| v Visual mode
3899 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3900 Selection" Only X11 Gui's |gui-x11| and
3901 |xterm-clipboard|.
3902 |hl-WarningMsg| w warning messages
3903 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3904 |hl-Folded| f line used for closed folds
3905 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003906 |hl-DiffAdd| A added line in diff mode
3907 |hl-DiffChange| C changed line in diff mode
3908 |hl-DiffDelete| D deleted line in diff mode
3909 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003911 |hl-Conceal| - the placeholders used for concealed characters
3912 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003913 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003914 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003915 |hl-SpellRare| R rare word |spell|
3916 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003917 |hl-Pmenu| + popup menu normal line
3918 |hl-PmenuSel| = popup menu selected line
3919 |hl-PmenuSbar| x popup menu scrollbar
3920 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921
3922 The display modes are:
3923 r reverse (termcap entry "mr" and "me")
3924 i italic (termcap entry "ZH" and "ZR")
3925 b bold (termcap entry "md" and "me")
3926 s standout (termcap entry "so" and "se")
3927 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003928 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02003929 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930 n no highlighting
3931 - no highlighting
3932 : use a highlight group
3933 The default is used for occasions that are not included.
3934 If you want to change what the display modes do, see |dos-colors|
3935 for an example.
3936 When using the ':' display mode, this must be followed by the name of
3937 a highlight group. A highlight group can be used to define any type
3938 of highlighting, including using color. See |:highlight| on how to
3939 define one. The default uses a different group for each occasion.
3940 See |highlight-default| for the default highlight groups.
3941
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003943'history' 'hi' number (Vim default: 50, Vi default: 0,
3944 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003947 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003949 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 NOTE: This option is set to the Vi default value when 'compatible' is
3951 set and to the Vim default value when 'compatible' is reset.
3952
3953 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3954'hkmap' 'hk' boolean (default off)
3955 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 {only available when compiled with the |+rightleft|
3957 feature}
3958 When on, the keyboard is mapped for the Hebrew character set.
3959 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3960 toggle this option. See |rileft.txt|.
3961 NOTE: This option is reset when 'compatible' is set.
3962
3963 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3964'hkmapp' 'hkp' boolean (default off)
3965 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 {only available when compiled with the |+rightleft|
3967 feature}
3968 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3969 This is useful if you have a non-Hebrew keyboard.
3970 See |rileft.txt|.
3971 NOTE: This option is reset when 'compatible' is set.
3972
Bram Moolenaar036986f2017-03-16 17:41:02 +01003973 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3974'hlsearch' 'hls' boolean (default off)
3975 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01003976 {not available when compiled without the
3977 |+extra_search| feature}
3978 When there is a previous search pattern, highlight all its matches.
3979 The type of highlighting used can be set with the 'l' occasion in the
3980 'highlight' option. This uses the "Search" highlight group by
3981 default. Note that only the matching text is highlighted, any offsets
3982 are not applied.
3983 See also: 'incsearch' and |:match|.
3984 When you get bored looking at the highlighted matches, you can turn it
3985 off with |:nohlsearch|. This does not change the option value, as
3986 soon as you use a search command, the highlighting comes back.
3987 'redrawtime' specifies the maximum time spent on finding matches.
3988 When the search pattern can match an end-of-line, Vim will try to
3989 highlight all of the matched text. However, this depends on where the
3990 search starts. This will be the first line in the window or the first
3991 line below a closed fold. A match in a previous line which is not
3992 drawn may not continue in a newly drawn line.
3993 You can specify whether the highlight status is restored on startup
3994 with the 'h' flag in 'viminfo' |viminfo-h|.
3995 NOTE: This option is reset when 'compatible' is set.
3996
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 *'icon'* *'noicon'*
3998'icon' boolean (default off, on when title can be restored)
3999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 {not available when compiled without the |+title|
4001 feature}
4002 When on, the icon text of the window will be set to the value of
4003 'iconstring' (if it is not empty), or to the name of the file
4004 currently being edited. Only the last part of the name is used.
4005 Overridden by the 'iconstring' option.
4006 Only works if the terminal supports setting window icons (currently
4007 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4008 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4009 builtin termcap).
4010 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004011 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004013 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014
4015 *'iconstring'*
4016'iconstring' string (default "")
4017 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 {not available when compiled without the |+title|
4019 feature}
4020 When this option is not empty, it will be used for the icon text of
4021 the window. This happens only when the 'icon' option is on.
4022 Only works if the terminal supports setting window icon text
4023 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4024 Does not work for MS Windows.
4025 When Vim was compiled with HAVE_X11 defined, the original icon will be
4026 restored if possible |X11|.
4027 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004028 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 'titlestring' for example settings.
4030 {not available when compiled without the |+statusline| feature}
4031
4032 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4033'ignorecase' 'ic' boolean (default off)
4034 global
4035 Ignore case in search patterns. Also used when searching in the tags
4036 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004037 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 Can be overruled by using "\c" or "\C" in the pattern, see
4039 |/ignorecase|.
4040
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004041 *'imactivatefunc'* *'imaf'*
4042'imactivatefunc' 'imaf' string (default "")
4043 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004044 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004045 activate or deactivate the Input Method.
4046 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004047
4048 Example: >
4049 function ImActivateFunc(active)
4050 if a:active
4051 ... do something
4052 else
4053 ... do something
4054 endif
4055 " return value is not used
4056 endfunction
4057 set imactivatefunc=ImActivateFunc
4058<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059 *'imactivatekey'* *'imak'*
4060'imactivatekey' 'imak' string (default "")
4061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004063 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004064 Specifies the key that your Input Method in X-Windows uses for
4065 activation. When this is specified correctly, vim can fully control
4066 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4067 You can't use this option to change the activation key, the option
4068 tells Vim what the key is.
4069 Format:
4070 [MODIFIER_FLAG-]KEY_STRING
4071
4072 These characters can be used for MODIFIER_FLAG (case is ignored):
4073 S Shift key
4074 L Lock key
4075 C Control key
4076 1 Mod1 key
4077 2 Mod2 key
4078 3 Mod3 key
4079 4 Mod4 key
4080 5 Mod5 key
4081 Combinations are allowed, for example "S-C-space" or "SC-space" are
4082 both shift+ctrl+space.
4083 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4084
4085 Example: >
4086 :set imactivatekey=S-space
4087< "S-space" means shift+space. This is the activation key for kinput2 +
4088 canna (Japanese), and ami (Korean).
4089
4090 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4091'imcmdline' 'imc' boolean (default off)
4092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 When set the Input Method is always on when starting to edit a command
4094 line, unless entering a search pattern (see 'imsearch' for that).
4095 Setting this option is useful when your input method allows entering
4096 English characters directly, e.g., when it's used to type accented
4097 characters with dead keys.
4098
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004099 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 When set the Input Method is never used. This is useful to disable
4103 the IM when it doesn't work properly.
4104 Currently this option is on by default for SGI/IRIX machines. This
4105 may change in later releases.
4106
4107 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004108'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004110 Specifies whether :lmap or an Input Method (IM) is to be used in
4111 Insert mode. Valid values:
4112 0 :lmap is off and IM is off
4113 1 :lmap is ON and IM is off
4114 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004115 To always reset the option to zero when leaving Insert mode with <Esc>
4116 this can be used: >
4117 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4118< This makes :lmap and IM turn off automatically when leaving Insert
4119 mode.
4120 Note that this option changes when using CTRL-^ in Insert mode
4121 |i_CTRL-^|.
4122 The value is set to 1 when setting 'keymap' to a valid keymap name.
4123 It is also used for the argument of commands like "r" and "f".
4124 The value 0 may not work correctly with Athena and Motif with some XIM
4125 methods. Use 'imdisable' to disable XIM then.
4126
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004127 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004128 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004129 |+multi_byte_ime| or |global-ime|.
4130
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004132'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134 Specifies whether :lmap or an Input Method (IM) is to be used when
4135 entering a search pattern. Valid values:
4136 -1 the value of 'iminsert' is used, makes it look like
4137 'iminsert' is also used when typing a search pattern
4138 0 :lmap is off and IM is off
4139 1 :lmap is ON and IM is off
4140 2 :lmap is off and IM is ON
4141 Note that this option changes when using CTRL-^ in Command-line mode
4142 |c_CTRL-^|.
4143 The value is set to 1 when it is not -1 and setting the 'keymap'
4144 option to a valid keymap name.
4145 The value 0 may not work correctly with Athena and Motif with some XIM
4146 methods. Use 'imdisable' to disable XIM then.
4147
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004148 *'imstatusfunc'* *'imsf'*
4149'imstatusfunc' 'imsf' string (default "")
4150 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004151 This option specifies a function that is called to obtain the status
4152 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004153 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004154
4155 Example: >
4156 function ImStatusFunc()
4157 let is_active = ...do something
4158 return is_active ? 1 : 0
4159 endfunction
4160 set imstatusfunc=ImStatusFunc
4161<
4162 NOTE: This function is invoked very often. Keep it fast.
4163
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004164 *'imstyle'* *'imst'*
4165'imstyle' 'imst' number (default 1)
4166 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004167 {only available when compiled with |+xim| and
4168 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004169 This option specifies the input style of Input Method:
4170 0 use on-the-spot style
4171 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004172 See: |xim-input-style|
4173
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004174 For a long time on-the-spot style had been used in the GTK version of
4175 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004176 |single-repeat|, etc. Therefore over-the-spot style becomes the
4177 default now. This should work fine for most people, however if you
4178 have any problem with it, try using on-the-spot style.
4179
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 *'include'* *'inc'*
4181'include' 'inc' string (default "^\s*#\s*include")
4182 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 {not available when compiled without the
4184 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004185 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 pattern, just like for the "/" command (See |pattern|). The default
4187 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004188 "]I", "[d", etc.
4189 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004190 comes after the matched pattern. But if "\zs" appears in the pattern
4191 then the text matched from "\zs" to the end, or until "\ze" if it
4192 appears, is used as the file name. Use this to include characters
4193 that are not in 'isfname', such as a space. You can then use
4194 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004195 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196
4197 *'includeexpr'* *'inex'*
4198'includeexpr' 'inex' string (default "")
4199 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004201 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004203 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 :set includeexpr=substitute(v:fname,'\\.','/','g')
4205< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004206
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004208 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 Also used for |<cfile>|.
4210
Bram Moolenaar30b65812012-07-12 22:01:11 +02004211 The expression will be evaluated in the |sandbox| when set from a
4212 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004213
4214 It is not allowed to change text or jump to another window while
4215 evaluating 'includeexpr' |textlock|.
4216
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004218'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4219 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004222 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004223 While typing a search command, show where the pattern, as it was typed
4224 so far, matches. The matched string is highlighted. If the pattern
4225 is invalid or not found, nothing is shown. The screen will be updated
4226 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004227 Also applies to the pattern in commands: >
4228 :global
4229 :lvimgrep
4230 :lvimgrepadd
4231 :smagic
4232 :snomagic
4233 :sort
4234 :substitute
4235 :vglobal
4236 :vimgrep
4237 :vimgrepadd
4238< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004239 original position when no match is found and when pressing <Esc>. You
4240 still need to finish the search command with <Enter> to move the
4241 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004242 You can use the CTRL-G and CTRL-T keys to move to the next and
4243 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004244 When compiled with the |+reltime| feature Vim only searches for about
4245 half a second. With a complicated pattern and/or a lot of text the
4246 match may not be found. This is to avoid that Vim hangs while you
4247 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004248 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004249 When 'hlsearch' is on, all matched strings are highlighted too while
4250 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004251 If you don't want to turn 'hlsearch' on, but want to highlight all
4252 matches while searching, you can turn on and off 'hlsearch' with
4253 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004254 augroup vimrc-incsearch-highlight
4255 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004256 autocmd CmdlineEnter /,\? :set hlsearch
4257 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004258 augroup END
4259<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004260 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004261 to the command line. If 'ignorecase' and 'smartcase' are set and the
4262 command line has no uppercase characters, the added character is
4263 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004264 CTRL-R CTRL-W can be used to add the word at the end of the current
4265 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 NOTE: This option is reset when 'compatible' is set.
4267
4268 *'indentexpr'* *'inde'*
4269'indentexpr' 'inde' string (default "")
4270 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 {not available when compiled without the |+cindent|
4272 or |+eval| features}
4273 Expression which is evaluated to obtain the proper indent for a line.
4274 It is used when a new line is created, for the |=| operator and
4275 in Insert mode as specified with the 'indentkeys' option.
4276 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004277 'smartindent' indenting. When 'lisp' is set, this option is
4278 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 When 'paste' is set this option is not used for indenting.
4280 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004281 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 when the expression is evaluated (but it may be moved around).
4283 The expression must return the number of spaces worth of indent. It
4284 can return "-1" to keep the current indent (this means 'autoindent' is
4285 used for the indent).
4286 Functions useful for computing the indent are |indent()|, |cindent()|
4287 and |lispindent()|.
4288 The evaluation of the expression must not have side effects! It must
4289 not change the text, jump to another window, etc. Afterwards the
4290 cursor position is always restored, thus the cursor may be moved.
4291 Normally this option would be set to call a function: >
4292 :set indentexpr=GetMyIndent()
4293< Error messages will be suppressed, unless the 'debug' option contains
4294 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004295 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004296 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297
Bram Moolenaar30b65812012-07-12 22:01:11 +02004298 The expression will be evaluated in the |sandbox| when set from a
4299 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004300
4301 It is not allowed to change text or jump to another window while
4302 evaluating 'indentexpr' |textlock|.
4303
4304
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004306'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 {not available when compiled without the |+cindent|
4309 feature}
4310 A list of keys that, when typed in Insert mode, cause reindenting of
4311 the current line. Only happens if 'indentexpr' isn't empty.
4312 The format is identical to 'cinkeys', see |indentkeys-format|.
4313 See |C-indenting| and |indent-expression|.
4314
4315 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4316'infercase' 'inf' boolean (default off)
4317 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004319 'ignorecase' is also on, the case of the match is adjusted depending
4320 on the typed text. If the typed text contains a lowercase letter
4321 where the match has an upper case letter, the completed part is made
4322 lowercase. If the typed text has no lowercase letters and the match
4323 has a lowercase letter where the typed text has an uppercase letter,
4324 and there is a letter before it, the completed part is made uppercase.
4325 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326
4327 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4328'insertmode' 'im' boolean (default off)
4329 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330 Makes Vim work in a way that Insert mode is the default mode. Useful
4331 if you want to use Vim as a modeless editor. Used for |evim|.
4332 These Insert mode commands will be useful:
4333 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004334 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 this is a mapping, it is executed as if 'insertmode' was off.
4336 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004338 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4339 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340
4341 These items change when 'insertmode' is set:
4342 - when starting to edit of a file, Vim goes to Insert mode.
4343 - <Esc> in Insert mode is a no-op and beeps.
4344 - <Esc> in Normal mode makes Vim go to Insert mode.
4345 - CTRL-L in Insert mode is a command, it is not inserted.
4346 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4347 However, when <Esc> is used inside a mapping, it behaves like
4348 'insertmode' was not set. This was done to be able to use the same
4349 mappings with 'insertmode' set or not set.
4350 When executing commands with |:normal| 'insertmode' is not used.
4351
4352 NOTE: This option is reset when 'compatible' is set.
4353
4354 *'isfname'* *'isf'*
4355'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4356 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4357 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4358 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4359 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4360 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4361 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 The characters specified by this option are included in file names and
4363 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004364 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 Multi-byte characters 256 and above are always included, only the
4366 characters up to 255 are specified with this option.
4367 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004368 Think twice before adding white space to this option. Although a
4369 space may appear inside a file name, the effect will be that Vim
4370 doesn't know where a file name starts or ends when doing completion.
4371 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372
4373 Note that on systems using a backslash as path separator, Vim tries to
4374 do its best to make it work as you would expect. That is a bit
4375 tricky, since Vi originally used the backslash to escape special
4376 characters. Vim will not remove a backslash in front of a normal file
4377 name character on these systems, but it will on Unix and alikes. The
4378 '&' and '^' are not included by default, because these are special for
4379 cmd.exe.
4380
4381 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004382 Each part can be a single character number or a range. A range is two
4383 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 decimal number between 0 and 255 or the ASCII character itself (does
4385 not work for digits). Example:
4386 "_,-,128-140,#-43" (include '_' and '-' and the range
4387 128 to 140 and '#' to 43)
4388 If a part starts with '^', the following character number or range
4389 will be excluded from the option. The option is interpreted from left
4390 to right. Put the excluded character after the range where it is
4391 included. To include '^' itself use it as the last character of the
4392 option or the end of a range. Example:
4393 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4394 If the character is '@', all characters where isalpha() returns TRUE
4395 are included. Normally these are the characters a to z and A to Z,
4396 plus accented characters. To include '@' itself use "@-@". Examples:
4397 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004398 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 "a-z,A-Z,@-@" All letters plus the '@' character.
4400 A comma can be included by using it where a character number is
4401 expected. Example:
4402 "48-57,,,_" Digits, comma and underscore.
4403 A comma can be excluded by prepending a '^'. Example:
4404 " -~,^,,9" All characters from space to '~', excluding
4405 comma, plus <Tab>.
4406 See |option-backslash| about including spaces and backslashes.
4407
4408 *'isident'* *'isi'*
4409'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4410 "@,48-57,_,128-167,224-235"
4411 otherwise: "@,48-57,_,192-255")
4412 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413 The characters given by this option are included in identifiers.
4414 Identifiers are used in recognizing environment variables and after a
4415 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004416 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004417 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004419 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4421
4422 *'iskeyword'* *'isk'*
4423'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4424 "@,48-57,_,128-167,224-235"
4425 otherwise: "@,48-57,_,192-255"
4426 Vi default: "@,48-57,_")
4427 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004429 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004430 'isfname' for a description of the format of this option. For '@'
4431 characters above 255 check the "word" character class.
4432 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 For a help file it is set to all non-blank printable characters except
4434 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4435 command).
4436 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004437 This option also influences syntax highlighting, unless the syntax
4438 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 NOTE: This option is set to the Vi default value when 'compatible' is
4440 set and to the Vim default value when 'compatible' is reset.
4441
4442 *'isprint'* *'isp'*
4443'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4444 "@,~-255"; otherwise: "@,161-255")
4445 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446 The characters given by this option are displayed directly on the
4447 screen. It is also used for "\p" in a |pattern|. The characters from
4448 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4449 even when they are not included in 'isprint' or excluded. See
4450 'isfname' for a description of the format of this option.
4451
4452 Non-printable characters are displayed with two characters:
4453 0 - 31 "^@" - "^_"
4454 32 - 126 always single characters
4455 127 "^?"
4456 128 - 159 "~@" - "~_"
4457 160 - 254 "| " - "|~"
4458 255 "~?"
4459 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4460 displayed as <xx>, with the hexadecimal value of the byte.
4461 When 'display' contains "uhex" all unprintable characters are
4462 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004463 The SpecialKey highlighting will be used for unprintable characters.
4464 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465
4466 Multi-byte characters 256 and above are always included, only the
4467 characters up to 255 are specified with this option. When a character
4468 is printable but it is not available in the current font, a
4469 replacement character will be shown.
4470 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4471 There is no option to specify these characters.
4472
4473 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4474'joinspaces' 'js' boolean (default on)
4475 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 Insert two spaces after a '.', '?' and '!' with a join command.
4477 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4478 Otherwise only one space is inserted.
4479 NOTE: This option is set when 'compatible' is set.
4480
4481 *'key'*
4482'key' string (default "")
4483 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004484 {only available when compiled with the |+cryptv|
4485 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004487 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 Careful: Do not set the key value by hand, someone might see the typed
4489 key. Use the |:X| command. But you can make 'key' empty: >
4490 :set key=
4491< It is not possible to get the value of this option with ":set key" or
4492 "echo &key". This is to avoid showing it to someone who shouldn't
4493 know. It also means you cannot see it yourself once you have set it,
4494 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004495 You can use "&key" in an expression to detect whether encryption is
4496 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497
4498 *'keymap'* *'kmp'* *E544*
4499'keymap' 'kmp' string (default "")
4500 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 {only available when compiled with the |+keymap|
4502 feature}
4503 Name of a keyboard mapping. See |mbyte-keymap|.
4504 Setting this option to a valid keymap name has the side effect of
4505 setting 'iminsert' to one, so that the keymap becomes effective.
4506 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004507 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508
4509 *'keymodel'* *'km'*
4510'keymodel' 'km' string (default "")
4511 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004512 List of comma separated words, which enable special things that keys
4513 can do. These values can be used:
4514 startsel Using a shifted special key starts selection (either
4515 Select mode or Visual mode, depending on "key" being
4516 present in 'selectmode').
4517 stopsel Using a not-shifted special key stops selection.
4518 Special keys in this context are the cursor keys, <End>, <Home>,
4519 <PageUp> and <PageDown>.
4520 The 'keymodel' option is set by the |:behave| command.
4521
4522 *'keywordprg'* *'kp'*
4523'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004524 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 Program to use for the |K| command. Environment variables are
4527 expanded |:set_env|. ":help" may be used to access the Vim internal
4528 help. (Note that previously setting the global option to the empty
4529 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004530 When the first character is ":", the command is invoked as a Vim
4531 Ex command prefixed with [count].
4532 When "man", "man -s" or an Ex command is used, Vim will automatically
4533 translate a count for the "K" command and pass it as the first
4534 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 See |option-backslash| about including spaces and backslashes.
4536 Example: >
4537 :set keywordprg=man\ -s
4538< This option cannot be set from a |modeline| or in the |sandbox|, for
4539 security reasons.
4540
4541 *'langmap'* *'lmap'* *E357* *E358*
4542'langmap' 'lmap' string (default "")
4543 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 {only available when compiled with the |+langmap|
4545 feature}
4546 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004547 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004548 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 care of translating these special characters to the original meaning
4550 of the key. This means you don't have to change the keyboard mode to
4551 be able to execute Normal mode commands.
4552 This is the opposite of the 'keymap' option, where characters are
4553 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004554 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004555 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004556 This option cannot be set from a |modeline| or in the |sandbox|, for
4557 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004559 Example (for Greek, in UTF-8): *greek* >
4560 :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 +00004561< Example (exchanges meaning of z and y for commands): >
4562 :set langmap=zy,yz,ZY,YZ
4563<
4564 The 'langmap' option is a list of parts, separated with commas. Each
4565 part can be in one of two forms:
4566 1. A list of pairs. Each pair is a "from" character immediately
4567 followed by the "to" character. Examples: "aA", "aAbBcC".
4568 2. A list of "from" characters, a semi-colon and a list of "to"
4569 characters. Example: "abc;ABC"
4570 Example: "aA,fgh;FGH,cCdDeE"
4571 Special characters need to be preceded with a backslash. These are
4572 ";", ',' and backslash itself.
4573
4574 This will allow you to activate vim actions without having to switch
4575 back and forth between the languages. Your language characters will
4576 be understood as normal vim English characters (according to the
4577 langmap mappings) in the following cases:
4578 o Normal/Visual mode (commands, buffer/register names, user mappings)
4579 o Insert/Replace Mode: Register names after CTRL-R
4580 o Insert/Replace Mode: Mappings
4581 Characters entered in Command-line mode will NOT be affected by
4582 this option. Note that this option can be changed at any time
4583 allowing to switch between mappings for different languages/encodings.
4584 Use a mapping to avoid having to type it each time!
4585
4586 *'langmenu'* *'lm'*
4587'langmenu' 'lm' string (default "")
4588 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 {only available when compiled with the |+menu| and
4590 |+multi_lang| features}
4591 Language to use for menu translation. Tells which file is loaded
4592 from the "lang" directory in 'runtimepath': >
4593 "lang/menu_" . &langmenu . ".vim"
4594< (without the spaces). For example, to always use the Dutch menus, no
4595 matter what $LANG is set to: >
4596 :set langmenu=nl_NL.ISO_8859-1
4597< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004598 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004599 If your $LANG is set to a non-English language but you do want to use
4600 the English menus: >
4601 :set langmenu=none
4602< This option must be set before loading menus, switching on filetype
4603 detection or syntax highlighting. Once the menus are defined setting
4604 this option has no effect. But you could do this: >
4605 :source $VIMRUNTIME/delmenu.vim
4606 :set langmenu=de_DE.ISO_8859-1
4607 :source $VIMRUNTIME/menu.vim
4608< Warning: This deletes all menus that you defined yourself!
4609
Bram Moolenaard94464e2015-11-02 15:28:18 +01004610 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004611'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004612 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004613 {only available when compiled with the |+langmap|
4614 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004615 This is just like 'langremap' but with the value inverted. It only
4616 exists for backwards compatibility. When setting 'langremap' then
4617 'langnoremap' is set to the inverted value, and the other way around.
4618
4619 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4620'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4621 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004622 {only available when compiled with the |+langmap|
4623 feature}
4624 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004625 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004626 'langmap' disables some of your mappings, try resetting this option.
4627 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004628 that works for you to avoid mappings to break.
4629
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 *'laststatus'* *'ls'*
4631'laststatus' 'ls' number (default 1)
4632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 The value of this option influences when the last window will have a
4634 status line:
4635 0: never
4636 1: only if there are at least two windows
4637 2: always
4638 The screen looks nicer with a status line if you have several
4639 windows, but it takes another screen line. |status-line|
4640
4641 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4642'lazyredraw' 'lz' boolean (default off)
4643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 When this option is set, the screen will not be redrawn while
4645 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004646 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 update use |:redraw|.
4648
4649 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4650'linebreak' 'lbr' boolean (default off)
4651 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004652 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004654 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 than at the last character that fits on the screen. Unlike
4656 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004657 it only affects the way the file is displayed, not its contents.
4658 If 'breakindent' is set, line is visually indented. Then, the value
4659 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004660 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004661 Note that <Tab> characters after an <EOL> are mostly not displayed
4662 with the right amount of white space.
4663
4664 *'lines'* *E593*
4665'lines' number (default 24 or terminal height)
4666 global
4667 Number of lines of the Vim window.
4668 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004669 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 When Vim is running in the GUI or in a resizable window, setting this
4671 option will cause the window size to be changed. When you only want
4672 to use the size for the GUI, put the command in your |gvimrc| file.
4673 Vim limits the number of lines to what fits on the screen. You can
4674 use this command to get the tallest window possible: >
4675 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004676< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004677 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 When you set this option and Vim is unable to change the physical
4679 number of lines of the display, the display may be messed up.
4680
4681 *'linespace'* *'lsp'*
4682'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 {only in the GUI}
4685 Number of pixel lines inserted between characters. Useful if the font
4686 uses the full character cell height, making lines touch each other.
4687 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004688 With some fonts there can be too much room between lines (to have
4689 space for ascents and descents). Then it makes sense to set
4690 'linespace' to a negative value. This may cause display problems
4691 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692
4693 *'lisp'* *'nolisp'*
4694'lisp' boolean (default off)
4695 local to buffer
4696 {not available when compiled without the |+lispindent|
4697 feature}
4698 Lisp mode: When <Enter> is typed in insert mode set the indent for
4699 the next line to Lisp standards (well, sort of). Also happens with
4700 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4701 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4702 better. Also see 'lispwords'.
4703 The '-' character is included in keyword characters. Redefines the
4704 "=" operator to use this same indentation algorithm rather than
4705 calling an external program if 'equalprg' is empty.
4706 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707
4708 *'lispwords'* *'lw'*
4709'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004710 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 {not available when compiled without the |+lispindent|
4712 feature}
4713 Comma separated list of words that influence the Lisp indenting.
4714 |'lisp'|
4715
4716 *'list'* *'nolist'*
4717'list' boolean (default off)
4718 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004719 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4720 line. Useful to see the difference between tabs and spaces and for
4721 trailing blanks. Further changed by the 'listchars' option.
4722
4723 The cursor is displayed at the start of the space a Tab character
4724 occupies, not at the end as usual in Normal mode. To get this cursor
4725 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004726 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004727<
4728 Note that list mode will also affect formatting (set with 'textwidth'
4729 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 changing the way tabs are displayed.
4731
4732 *'listchars'* *'lcs'*
4733'listchars' 'lcs' string (default "eol:$")
4734 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004735 Strings to use in 'list' mode and for the |:list| command. It is a
4736 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004737 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 eol:c Character to show at the end of each line. When
4739 omitted, there is no extra character at the end of the
4740 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004741 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004742 tab:xy[z] Two or three characters to be used to show a tab.
4743 The third character is optional.
4744
4745 tab:xy The 'x' is always used, then 'y' as many times as will
4746 fit. Thus "tab:>-" displays:
4747 >
4748 >-
4749 >--
4750 etc.
4751
4752 tab:xyz The 'z' is always used, then 'x' is prepended, and
4753 then 'y' is used as many times as will fit. Thus
4754 "tab:<->" displays:
4755 >
4756 <>
4757 <->
4758 <-->
4759 etc.
4760
4761 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004762 *lcs-space*
4763 space:c Character to show for a space. When omitted, spaces
4764 are left blank.
4765 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004766 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004767 trailing spaces are blank. Overrides the "space"
4768 setting for trailing spaces.
4769 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770 extends:c Character to show in the last column, when 'wrap' is
4771 off and the line continues beyond the right of the
4772 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004773 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774 precedes:c Character to show in the first column, when 'wrap'
4775 is off and there is text preceding the character
4776 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004777 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004778 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004779 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004780 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004781 nbsp:c Character to show for a non-breakable space character
4782 (0xA0 (160 decimal) and U+202F). Left blank when
4783 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004785 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004787 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788
4789 Examples: >
4790 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004791 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 :set lcs=extends:>,precedes:<
4793< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004794 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004795 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796
4797 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4798'loadplugins' 'lpl' boolean (default on)
4799 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 When on the plugin scripts are loaded when starting up |load-plugins|.
4801 This option can be reset in your |vimrc| file to disable the loading
4802 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004803 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4804 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805
Bram Moolenaard94464e2015-11-02 15:28:18 +01004806 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004807'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004808 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004809 {only available when compiled with the |+lua/dyn|
4810 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004811 Specifies the name of the Lua shared library. The default is
4812 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004813 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004814 This option cannot be set from a |modeline| or in the |sandbox|, for
4815 security reasons.
4816
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004817 *'macatsui'* *'nomacatsui'*
4818'macatsui' boolean (default on)
4819 global
4820 {only available in Mac GUI version}
4821 This is a workaround for when drawing doesn't work properly. When set
4822 and compiled with multi-byte support ATSUI text drawing is used. When
4823 not set ATSUI text drawing is not used. Switch this option off when
4824 you experience drawing problems. In a future version the problems may
4825 be solved and this option becomes obsolete. Therefore use this method
4826 to unset it: >
4827 if exists('&macatsui')
4828 set nomacatsui
4829 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004830< Another option to check if you have drawing problems is
4831 'termencoding'.
4832
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833 *'magic'* *'nomagic'*
4834'magic' boolean (default on)
4835 global
4836 Changes the special characters that can be used in search patterns.
4837 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004838 WARNING: Switching this option off most likely breaks plugins! That
4839 is because many patterns assume it's on and will fail when it's off.
4840 Only switch it off when working with old Vi scripts. In any other
4841 situation write patterns that work when 'magic' is on. Include "\M"
4842 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843
4844 *'makeef'* *'mef'*
4845'makeef' 'mef' string (default: "")
4846 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847 {not available when compiled without the |+quickfix|
4848 feature}
4849 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4850 and the |:grep| command.
4851 When it is empty, an internally generated temp file will be used.
4852 When "##" is included, it is replaced by a number to make the name
4853 unique. This makes sure that the ":make" command doesn't overwrite an
4854 existing file.
4855 NOT used for the ":cf" command. See 'errorfile' for that.
4856 Environment variables are expanded |:set_env|.
4857 See |option-backslash| about including spaces and backslashes.
4858 This option cannot be set from a |modeline| or in the |sandbox|, for
4859 security reasons.
4860
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004861 *'makeencoding'* *'menc'*
4862'makeencoding' 'menc' string (default "")
4863 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004864 Encoding used for reading the output of external commands. When empty,
4865 encoding is not converted.
4866 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4867 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4868 and `:laddfile`.
4869
4870 This would be mostly useful when you use MS-Windows and set 'encoding'
4871 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4872 'makeencoding' to "char" has the same effect as setting to the system
4873 locale encoding. Example: >
4874 :set encoding=utf-8
4875 :set makeencoding=char " system locale is used
4876<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 *'makeprg'* *'mp'*
4878'makeprg' 'mp' string (default "make", VMS: "MMS")
4879 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004880 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004881 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4882 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004883 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004884 Environment variables are expanded |:set_env|. See |option-backslash|
4885 about including spaces and backslashes.
4886 Note that a '|' must be escaped twice: once for ":set" and once for
4887 the interpretation of a command. When you use a filter called
4888 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 :set makeprg=gmake\ \\\|\ myfilter
4890< The placeholder "$*" can be given (even multiple times) to specify
4891 where the arguments will be included, for example: >
4892 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4893< This option cannot be set from a |modeline| or in the |sandbox|, for
4894 security reasons.
4895
4896 *'matchpairs'* *'mps'*
4897'matchpairs' 'mps' string (default "(:),{:},[:]")
4898 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004900 other.
4901 Only character pairs are allowed that are different, thus you cannot
4902 jump between two double quotes.
4903 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004904 The pairs must be separated by a comma. Example for including '<' and
4905 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906 :set mps+=<:>
4907
4908< A more exotic example, to jump between the '=' and ';' in an
4909 assignment, useful for languages like C and Java: >
4910 :au FileType c,cpp,java set mps+==:;
4911
4912< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01004913 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914
4915 *'matchtime'* *'mat'*
4916'matchtime' 'mat' number (default 5)
4917 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02004918 {in Nvi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 Tenths of a second to show the matching paren, when 'showmatch' is
4920 set. Note that this is not in milliseconds, like other options that
4921 set a time. This is to be compatible with Nvi.
4922
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004923 *'maxcombine'* *'mco'*
4924'maxcombine' 'mco' number (default 2)
4925 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004926 The maximum number of combining characters supported for displaying.
4927 Only used when 'encoding' is "utf-8".
4928 The default is OK for most languages. Hebrew may require 4.
4929 Maximum value is 6.
4930 Even when this option is set to 2 you can still edit text with more
4931 combining characters, you just can't see them. Use |g8| or |ga|.
4932 See |mbyte-combining|.
4933
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934 *'maxfuncdepth'* *'mfd'*
4935'maxfuncdepth' 'mfd' number (default 100)
4936 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02004937 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004938 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 Maximum depth of function calls for user functions. This normally
4940 catches endless recursion. When using a recursive function with
4941 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4942 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01004943 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02004944 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 See also |:function|.
4946
4947 *'maxmapdepth'* *'mmd'* *E223*
4948'maxmapdepth' 'mmd' number (default 1000)
4949 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 Maximum number of times a mapping is done without resulting in a
4951 character to be used. This normally catches endless mappings, like
4952 ":map x y" with ":map y x". It still does not catch ":map g wg",
4953 because the 'w' is used before the next mapping is done. See also
4954 |key-mapping|.
4955
4956 *'maxmem'* *'mm'*
4957'maxmem' 'mm' number (default between 256 to 5120 (system
4958 dependent) or half the amount of memory
4959 available)
4960 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4962 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01004963 other memory to be freed.
4964 The maximum usable value is about 2000000. Use this to work without a
4965 limit.
4966 The value is ignored when 'swapfile' is off.
4967 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004969 *'maxmempattern'* *'mmp'*
4970'maxmempattern' 'mmp' number (default 1000)
4971 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004972 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004973 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004974 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004975 When Vim runs into the limit it gives an error message and mostly
4976 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004977 Running into the limit often means that the pattern is very
4978 inefficient or too complex. This may already happen with the pattern
4979 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02004980 Might also happen on redraw, when syntax rules try to match a complex
4981 text structure.
4982 Vim may run out of memory before hitting the 'maxmempattern' limit, in
4983 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004984
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985 *'maxmemtot'* *'mmt'*
4986'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4987 dependent) or half the amount of memory
4988 available)
4989 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004990 Maximum amount of memory in Kbyte to use for all buffers together.
4991 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01004992 without a limit.
4993 On 64 bit machines higher values might work. But hey, do you really
4994 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004995 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01004996 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01004997 Buffers with 'swapfile' off still count to the total amount of memory
4998 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004999 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000
5001 *'menuitems'* *'mis'*
5002'menuitems' 'mis' number (default 25)
5003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 {not available when compiled without the |+menu|
5005 feature}
5006 Maximum number of items to use in a menu. Used for menus that are
5007 generated from a list of items, e.g., the Buffers menu. Changing this
5008 option has no direct effect, the menu must be refreshed first.
5009
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005010 *'mkspellmem'* *'msm'*
5011'mkspellmem' 'msm' string (default "460000,2000,500")
5012 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005013 {not available when compiled without the |+syntax|
5014 feature}
5015 Parameters for |:mkspell|. This tunes when to start compressing the
5016 word tree. Compression can be slow when there are many words, but
5017 it's needed to avoid running out of memory. The amount of memory used
5018 per word depends very much on how similar the words are, that's why
5019 this tuning is complicated.
5020
5021 There are three numbers, separated by commas:
5022 {start},{inc},{added}
5023
5024 For most languages the uncompressed word tree fits in memory. {start}
5025 gives the amount of memory in Kbyte that can be used before any
5026 compression is done. It should be a bit smaller than the amount of
5027 memory that is available to Vim.
5028
5029 When going over the {start} limit the {inc} number specifies the
5030 amount of memory in Kbyte that can be allocated before another
5031 compression is done. A low number means compression is done after
5032 less words are added, which is slow. A high number means more memory
5033 will be allocated.
5034
5035 After doing compression, {added} times 1024 words can be added before
5036 the {inc} limit is ignored and compression is done when any extra
5037 amount of memory is needed. A low number means there is a smaller
5038 chance of hitting the {inc} limit, less memory is used but it's
5039 slower.
5040
5041 The languages for which these numbers are important are Italian and
5042 Hungarian. The default works for when you have about 512 Mbyte. If
5043 you have 1 Gbyte you could use: >
5044 :set mkspellmem=900000,3000,800
5045< If you have less than 512 Mbyte |:mkspell| may fail for some
5046 languages, no matter what you set 'mkspellmem' to.
5047
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005049'modeline' 'ml' boolean (Vim default: on (off for root),
5050 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 local to buffer
5052 *'modelines'* *'mls'*
5053'modelines' 'mls' number (default 5)
5054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 If 'modeline' is on 'modelines' gives the number of lines that is
5056 checked for set commands. If 'modeline' is off or 'modelines' is zero
5057 no lines are checked. See |modeline|.
5058 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5059 set and to the Vim default value when 'compatible' is reset.
5060
5061 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5062'modifiable' 'ma' boolean (default on)
5063 local to buffer
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005064 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 When off the buffer contents cannot be changed. The 'fileformat' and
5066 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005067 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068
5069 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5070'modified' 'mod' boolean (default off)
5071 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 When on, the buffer is considered to be modified. This option is set
5073 when:
5074 1. A change was made to the text since it was last written. Using the
5075 |undo| command to go back to the original text will reset the
5076 option. But undoing changes that were made before writing the
5077 buffer will set the option again, since the text is different from
5078 when it was written.
5079 2. 'fileformat' or 'fileencoding' is different from its original
5080 value. The original value is set when the buffer is read or
5081 written. A ":set nomodified" command also resets the original
5082 values to the current values and the 'modified' option will be
5083 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005084 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005085 This option is not set when a change is made to the buffer as the
5086 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5087 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5088 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5090 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005091 Note that the text may actually be the same, e.g. 'modified' is set
5092 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093
5094 *'more'* *'nomore'*
5095'more' boolean (Vim default: on, Vi default: off)
5096 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 When on, listings pause when the whole screen is filled. You will get
5098 the |more-prompt|. When this option is off there are no pauses, the
5099 listing continues until finished.
5100 NOTE: This option is set to the Vi default value when 'compatible' is
5101 set and to the Vim default value when 'compatible' is reset.
5102
5103 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005104'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5105 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005108 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5109 sysmouse and Linux console with gpm). For using the mouse in the
5110 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005112 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113 v Visual mode
5114 i Insert mode
5115 c Command-line mode
5116 h all previous modes when editing a help file
5117 a all previous modes
5118 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005119 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 :set mouse=a
5121< When the mouse is not enabled, the GUI will still use the mouse for
5122 modeless selection. This doesn't move the text cursor.
5123
5124 See |mouse-using|. Also see |'clipboard'|.
5125
5126 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005127 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128 the mouse buttons can still be used by keeping the shift key pressed.
5129 Also see the 'clipboard' option.
5130
5131 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5132'mousefocus' 'mousef' boolean (default off)
5133 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 {only works in the GUI}
5135 The window that the mouse pointer is on is automatically activated.
5136 When changing the window layout or window focus in another way, the
5137 mouse pointer is moved to the window with keyboard focus. Off is the
5138 default because it makes using the pull down menus a little goofy, as
5139 a pointer transit may activate a window unintentionally.
5140
5141 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5142'mousehide' 'mh' boolean (default on)
5143 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144 {only works in the GUI}
5145 When on, the mouse pointer is hidden when characters are typed.
5146 The mouse pointer is restored when the mouse is moved.
5147
5148 *'mousemodel'* *'mousem'*
5149'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 Sets the model to use for the mouse. The name mostly specifies what
5152 the right mouse button is used for:
5153 extend Right mouse button extends a selection. This works
5154 like in an xterm.
5155 popup Right mouse button pops up a menu. The shifted left
5156 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005157 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 popup_setpos Like "popup", but the cursor will be moved to the
5159 position where the mouse was clicked, and thus the
5160 selected operation will act upon the clicked object.
5161 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005162 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 course, that right clicking outside a selection will
5164 end Visual mode.
5165 Overview of what button does what for each model:
5166 mouse extend popup(_setpos) ~
5167 left click place cursor place cursor
5168 left drag start selection start selection
5169 shift-left search word extend selection
5170 right click extend selection popup menu (place cursor)
5171 right drag extend selection -
5172 middle click paste paste
5173
5174 In the "popup" model the right mouse button produces a pop-up menu.
5175 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005176 In a terminal the popup menu works if Vim is compiled with the
5177 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178
5179 Note that you can further refine the meaning of buttons with mappings.
5180 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5181 selection (because that's handled in the GUI code directly).
5182
5183 The 'mousemodel' option is set by the |:behave| command.
5184
5185 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005186'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5187 vs:leftright,vd:lrsizing,m:no,
5188 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190 {only available when compiled with the |+mouseshape|
5191 feature}
5192 This option tells Vim what the mouse pointer should look like in
5193 different modes. The option is a comma separated list of parts, much
5194 like used for 'guicursor'. Each part consist of a mode/location-list
5195 and an argument-list:
5196 mode-list:shape,mode-list:shape,..
5197 The mode-list is a dash separated list of these modes/locations:
5198 In a normal window: ~
5199 n Normal mode
5200 v Visual mode
5201 ve Visual mode with 'selection' "exclusive" (same as 'v',
5202 if not specified)
5203 o Operator-pending mode
5204 i Insert mode
5205 r Replace mode
5206
5207 Others: ~
5208 c appending to the command-line
5209 ci inserting in the command-line
5210 cr replacing in the command-line
5211 m at the 'Hit ENTER' or 'More' prompts
5212 ml idem, but cursor in the last line
5213 e any mode, pointer below last window
5214 s any mode, pointer on a status line
5215 sd any mode, while dragging a status line
5216 vs any mode, pointer on a vertical separator line
5217 vd any mode, while dragging a vertical separator line
5218 a everywhere
5219
5220 The shape is one of the following:
5221 avail name looks like ~
5222 w x arrow Normal mouse pointer
5223 w x blank no pointer at all (use with care!)
5224 w x beam I-beam
5225 w x updown up-down sizing arrows
5226 w x leftright left-right sizing arrows
5227 w x busy The system's usual busy pointer
5228 w x no The system's usual 'no input' pointer
5229 x udsizing indicates up-down resizing
5230 x lrsizing indicates left-right resizing
5231 x crosshair like a big thin +
5232 x hand1 black hand
5233 x hand2 white hand
5234 x pencil what you write with
5235 x question big ?
5236 x rightup-arrow arrow pointing right-up
5237 w x up-arrow arrow pointing up
5238 x <number> any X11 pointer number (see X11/cursorfont.h)
5239
5240 The "avail" column contains a 'w' if the shape is available for Win32,
5241 x for X11.
5242 Any modes not specified or shapes not available use the normal mouse
5243 pointer.
5244
5245 Example: >
5246 :set mouseshape=s:udsizing,m:no
5247< will make the mouse turn to a sizing arrow over the status lines and
5248 indicate no input when the hit-enter prompt is displayed (since
5249 clicking the mouse has no effect in this state.)
5250
5251 *'mousetime'* *'mouset'*
5252'mousetime' 'mouset' number (default 500)
5253 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5255 time in msec between two mouse clicks for the second click to be
5256 recognized as a multi click.
5257
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005258 *'mzschemedll'*
5259'mzschemedll' string (default depends on the build)
5260 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005261 {only available when compiled with the |+mzscheme/dyn|
5262 feature}
5263 Specifies the name of the MzScheme shared library. The default is
5264 DYNAMIC_MZSCH_DLL which was specified at compile time.
5265 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005266 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005267 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005268 This option cannot be set from a |modeline| or in the |sandbox|, for
5269 security reasons.
5270
5271 *'mzschemegcdll'*
5272'mzschemegcdll' string (default depends on the build)
5273 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005274 {only available when compiled with the |+mzscheme/dyn|
5275 feature}
5276 Specifies the name of the MzScheme GC shared library. The default is
5277 DYNAMIC_MZGC_DLL which was specified at compile time.
5278 The value can be equal to 'mzschemedll' if it includes the GC code.
5279 Environment variables are expanded |:set_env|.
5280 This option cannot be set from a |modeline| or in the |sandbox|, for
5281 security reasons.
5282
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005283 *'mzquantum'* *'mzq'*
5284'mzquantum' 'mzq' number (default 100)
5285 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005286 {not available when compiled without the |+mzscheme|
5287 feature}
5288 The number of milliseconds between polls for MzScheme threads.
5289 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005290 NOTE: This option is set to the Vim default value when 'compatible'
5291 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005292
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005294'nrformats' 'nf' string (default "bin,octal,hex",
5295 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005296 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005297 This defines what bases Vim will consider for numbers when using the
5298 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5299 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005300 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005302 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005303 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005304 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005305 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005306 considered to be hexadecimal. Example: Using CTRL-X on
5307 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005308 bin If included, numbers starting with "0b" or "0B" will be
5309 considered to be binary. Example: Using CTRL-X on
5310 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 Numbers which simply begin with a digit in the range 1-9 are always
5312 considered decimal. This also happens for numbers that are not
5313 recognized as octal or hex.
5314
5315 *'number'* *'nu'* *'nonumber'* *'nonu'*
5316'number' 'nu' boolean (default off)
5317 local to window
5318 Print the line number in front of each line. When the 'n' option is
5319 excluded from 'cpoptions' a wrapped line will not use the column of
5320 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005321 The 'numberwidth' option can be used to set the room used for the line
5322 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005323 When a long, wrapped line doesn't start with the first character, '-'
5324 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005325 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5326 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005327 *number_relativenumber*
5328 The 'relativenumber' option changes the displayed number to be
5329 relative to the cursor. Together with 'number' there are these
5330 four combinations (cursor in line 3):
5331
Bram Moolenaar3848e002016-03-19 18:42:29 +01005332 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005333 'nornu' 'nornu' 'rnu' 'rnu'
5334
5335 |apple | 1 apple | 2 apple | 2 apple
5336 |pear | 2 pear | 1 pear | 1 pear
5337 |nobody | 3 nobody | 0 nobody |3 nobody
5338 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005339
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005340 *'numberwidth'* *'nuw'*
5341'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5342 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005343 {only available when compiled with the |+linebreak|
5344 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005345 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005346 when the 'number' or 'relativenumber' option is set or printing lines
5347 with a line number. Since one space is always between the number and
5348 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005349 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005350 fit the highest line number in the buffer respectively the number of
5351 rows in the window, depending on whether 'number' or 'relativenumber'
5352 is set. Thus with the Vim default of 4 there is room for a line number
5353 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005354 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005355 NOTE: This option is set to the Vi default value when 'compatible' is
5356 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005357
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005358 *'omnifunc'* *'ofu'*
5359'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005360 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005361 {not available when compiled without the |+eval|
5362 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005363 This option specifies a function to be used for Insert mode omni
5364 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005365 See |complete-functions| for an explanation of how the function is
5366 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005367 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005368 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005369 This option cannot be set from a |modeline| or in the |sandbox|, for
5370 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005371
5372
Bram Moolenaar02467872007-05-06 13:22:01 +00005373 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005374'opendevice' 'odev' boolean (default off)
5375 global
Bram Moolenaar043545e2006-10-10 16:44:07 +00005376 {only for MS-DOS, MS-Windows and OS/2}
5377 Enable reading and writing from devices. This may get Vim stuck on a
5378 device that can be opened but doesn't actually do the I/O. Therefore
5379 it is off by default.
5380 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5381 result in editing a device.
5382
5383
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005384 *'operatorfunc'* *'opfunc'*
5385'operatorfunc' 'opfunc' string (default: empty)
5386 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005387 This option specifies a function to be called by the |g@| operator.
5388 See |:map-operator| for more info and an example.
5389
5390 This option cannot be set from a |modeline| or in the |sandbox|, for
5391 security reasons.
5392
5393
Bram Moolenaar251e1912011-06-19 05:09:16 +02005394 *'osfiletype'* *'oft'*
5395'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005397 This option was supported on RISC OS, which has been removed.
5398
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005400 *'packpath'* *'pp'*
5401'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005402 Directories used to find packages. See |packages|.
5403
5404
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005406'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407 global
5408 Specifies the nroff macros that separate paragraphs. These are pairs
5409 of two letters (see |object-motions|).
5410
5411 *'paste'* *'nopaste'*
5412'paste' boolean (default off)
5413 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005414 Put Vim in Paste mode. This is useful if you want to cut or copy
5415 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416 unexpected effects.
5417 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005418 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 knows about pasting and will mostly do the right thing without 'paste'
5420 being set. The same is true for a terminal where Vim handles the
5421 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005422 This option is reset when starting the GUI. Thus if you set it in
5423 your .vimrc it will work in a terminal, but not in the GUI. Setting
5424 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5425 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426 When the 'paste' option is switched on (also when it was already on):
5427 - mapping in Insert mode and Command-line mode is disabled
5428 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005430 - 'expandtab' is reset
5431 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432 - 'revins' is reset
5433 - 'ruler' is reset
5434 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005435 - 'smartindent' is reset
5436 - 'smarttab' is reset
5437 - 'softtabstop' is set to 0
5438 - 'textwidth' is set to 0
5439 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005442 - 'indentexpr'
5443 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 NOTE: When you start editing another file while the 'paste' option is
5445 on, settings from the modelines or autocommands may change the
5446 settings again, causing trouble when pasting text. You might want to
5447 set the 'paste' option again.
5448 When the 'paste' option is reset the mentioned options are restored to
5449 the value before the moment 'paste' was switched from off to on.
5450 Resetting 'paste' before ever setting it does not have any effect.
5451 Since mapping doesn't work while 'paste' is active, you need to use
5452 the 'pastetoggle' option to toggle the 'paste' option with some key.
5453
5454 *'pastetoggle'* *'pt'*
5455'pastetoggle' 'pt' string (default "")
5456 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457 When non-empty, specifies the key sequence that toggles the 'paste'
5458 option. This is like specifying a mapping: >
5459 :map {keys} :set invpaste<CR>
5460< Where {keys} is the value of 'pastetoggle'.
5461 The difference is that it will work even when 'paste' is set.
5462 'pastetoggle' works in Insert mode and Normal mode, but not in
5463 Command-line mode.
5464 Mappings are checked first, thus overrule 'pastetoggle'. However,
5465 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5466 this: >
5467 :map <F10> :set paste<CR>
5468 :map <F11> :set nopaste<CR>
5469 :imap <F10> <C-O>:set paste<CR>
5470 :imap <F11> <nop>
5471 :set pastetoggle=<F11>
5472< This will make <F10> start paste mode and <F11> stop paste mode.
5473 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5474 mode everything is inserted literally, except the 'pastetoggle' key
5475 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005476 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477
5478 *'pex'* *'patchexpr'*
5479'patchexpr' 'pex' string (default "")
5480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 {not available when compiled without the |+diff|
5482 feature}
5483 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005484 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005485
Bram Moolenaardbc28022014-07-26 13:40:44 +02005486 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487'patchmode' 'pm' string (default "")
5488 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489 When non-empty the oldest version of a file is kept. This can be used
5490 to keep the original version of a file if you are changing files in a
5491 source distribution. Only the first time that a file is written a
5492 copy of the original file will be kept. The name of the copy is the
5493 name of the original file with the string in the 'patchmode' option
5494 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005495 ".orig" or ".org". 'backupdir' must not be empty for this to work
5496 (Detail: The backup file is renamed to the patchmode file after the
5497 new file has been successfully written, that's why it must be possible
5498 to write a backup file). If there was no file to be backed up, an
5499 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005500 When the 'backupskip' pattern matches, a patchmode file is not made.
5501 Using 'patchmode' for compressed files appends the extension at the
5502 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5503 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005504 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005506 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507'path' 'pa' string (default on Unix: ".,/usr/include,,"
5508 on OS/2: ".,/emx/include,,"
5509 other systems: ".,,")
5510 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005512 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5513 provided that the file being searched for has a relative path (not
5514 starting with "/", "./" or "../"). The directories in the 'path'
5515 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516 - Use commas to separate directory names: >
5517 :set path=.,/usr/local/include,/usr/include
5518< - Spaces can also be used to separate directory names (for backwards
5519 compatibility with version 3.0). To have a space in a directory
5520 name, precede it with an extra backslash, and escape the space: >
5521 :set path=.,/dir/with\\\ space
5522< - To include a comma in a directory name precede it with an extra
5523 backslash: >
5524 :set path=.,/dir/with\\,comma
5525< - To search relative to the directory of the current file, use: >
5526 :set path=.
5527< - To search in the current directory use an empty string between two
5528 commas: >
5529 :set path=,,
5530< - A directory name may end in a ':' or '/'.
5531 - Environment variables are expanded |:set_env|.
5532 - When using |netrw.vim| URLs can be used. For example, adding
5533 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005534 - Search upwards and downwards in a directory tree using "*", "**" and
5535 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005536 {not available when compiled without the |+path_extra| feature}
5537 - Careful with '\' characters, type two to get one in the option: >
5538 :set path=.,c:\\include
5539< Or just use '/' instead: >
5540 :set path=.,c:/include
5541< Don't forget "." or files won't even be found in the same directory as
5542 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005543 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 it is something like 256 or 1024 characters.
5545 You can check if all the include files are found, using the value of
5546 'path', see |:checkpath|.
5547 The use of |:set+=| and |:set-=| is preferred when adding or removing
5548 directories from the list. This avoids problems when a future version
5549 uses another default. To remove the current directory use: >
5550 :set path-=
5551< To add the current directory use: >
5552 :set path+=
5553< To use an environment variable, you probably need to replace the
5554 separator. Here is an example to append $INCL, in which directory
5555 names are separated with a semi-colon: >
5556 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5557< Replace the ';' with a ':' or whatever separator is used. Note that
5558 this doesn't work when $INCL contains a comma or white space.
5559
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005560 *'perldll'*
5561'perldll' string (default depends on the build)
5562 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005563 {only available when compiled with the |+perl/dyn|
5564 feature}
5565 Specifies the name of the Perl shared library. The default is
5566 DYNAMIC_PERL_DLL, which was specified at compile time.
5567 Environment variables are expanded |:set_env|.
5568 This option cannot be set from a |modeline| or in the |sandbox|, for
5569 security reasons.
5570
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5572'preserveindent' 'pi' boolean (default off)
5573 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574 When changing the indent of the current line, preserve as much of the
5575 indent structure as possible. Normally the indent is replaced by a
5576 series of tabs followed by spaces as required (unless |'expandtab'| is
5577 enabled, in which case only spaces are used). Enabling this option
5578 means the indent will preserve as many existing characters as possible
5579 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005580 'expandtab' does not apply to the preserved white space, a Tab remains
5581 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582 NOTE: When using ">>" multiple times the resulting indent is a mix of
5583 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005584 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 Also see 'copyindent'.
5586 Use |:retab| to clean up white space.
5587
5588 *'previewheight'* *'pvh'*
5589'previewheight' 'pvh' number (default 12)
5590 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005592 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593 Default height for a preview window. Used for |:ptag| and associated
5594 commands. Used for |CTRL-W_}| when no count is given.
5595
5596 *'previewwindow'* *'nopreviewwindow'*
5597 *'pvw'* *'nopvw'* *E590*
5598'previewwindow' 'pvw' boolean (default off)
5599 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005601 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005602 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603 set. It's normally not set directly, but by using one of the commands
5604 |:ptag|, |:pedit|, etc.
5605
5606 *'printdevice'* *'pdev'*
5607'printdevice' 'pdev' string (default empty)
5608 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005609 {only available when compiled with the |+printer|
5610 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005611 The name of the printer to be used for |:hardcopy|.
5612 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005613 This option cannot be set from a |modeline| or in the |sandbox|, for
5614 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615
Bram Moolenaar8299df92004-07-10 09:47:34 +00005616 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005617'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619 {only available when compiled with the |+printer|
5620 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005621 Sets the character encoding used when printing.
5622 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623
5624 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005625'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 {only available when compiled with the |+printer|
5628 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005629 Expression used to print the PostScript produced with |:hardcopy|.
5630 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005631 This option cannot be set from a |modeline| or in the |sandbox|, for
5632 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633
Bram Moolenaar8299df92004-07-10 09:47:34 +00005634 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635'printfont' 'pfn' string (default "courier")
5636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005637 {only available when compiled with the |+printer|
5638 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005639 The name of the font that will be used for |:hardcopy|.
5640 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641
5642 *'printheader'* *'pheader'*
5643'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005645 {only available when compiled with the |+printer|
5646 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005647 The format of the header produced in |:hardcopy| output.
5648 See |pheader-option|.
5649
5650 *'printmbcharset'* *'pmbcs'*
5651'printmbcharset' 'pmbcs' string (default "")
5652 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005653 {only available when compiled with the |+printer|
5654 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005655 The CJK character set to be used for CJK output from |:hardcopy|.
5656 See |pmbcs-option|.
5657
5658 *'printmbfont'* *'pmbfn'*
5659'printmbfont' 'pmbfn' string (default "")
5660 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005661 {only available when compiled with the |+printer|
5662 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005663 List of font names to be used for CJK output from |:hardcopy|.
5664 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665
5666 *'printoptions'* *'popt'*
5667'printoptions' 'popt' string (default "")
5668 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005670 List of items that control the format of the output of |:hardcopy|.
5671 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005673 *'prompt'* *'noprompt'*
5674'prompt' boolean (default on)
5675 global
5676 When on a ":" prompt is used in Ex mode.
5677
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005678 *'pumheight'* *'ph'*
5679'pumheight' 'ph' number (default 0)
5680 global
5681 {not available when compiled without the
5682 |+insert_expand| feature}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005683 Determines the maximum number of items to show in the popup menu for
5684 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005685 |ins-completion-menu|.
5686
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005687 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005688'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005689 global
5690 {not available when compiled without the
5691 |+insert_expand| feature}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005692 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005693 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005694
Bram Moolenaard94464e2015-11-02 15:28:18 +01005695 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005696'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005697 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005698 {only available when compiled with the |+python/dyn|
5699 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005700 Specifies the name of the Python 2.x shared library. The default is
5701 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005702 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005703 This option cannot be set from a |modeline| or in the |sandbox|, for
5704 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005705
Bram Moolenaar94073162018-01-31 21:49:05 +01005706 *'pythonhome'*
5707'pythonhome' string (default "")
5708 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005709 {only available when compiled with the |+python/dyn|
5710 feature}
5711 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5712 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5713 which was specified at compile time, will be used for the Python 2.x
5714 home directory.
5715 Environment variables are expanded |:set_env|.
5716 This option cannot be set from a |modeline| or in the |sandbox|, for
5717 security reasons.
5718
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005719 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005720'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005721 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005722 {only available when compiled with the |+python3/dyn|
5723 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005724 Specifies the name of the Python 3 shared library. The default is
5725 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005726 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005727 This option cannot be set from a |modeline| or in the |sandbox|, for
5728 security reasons.
5729
Bram Moolenaar94073162018-01-31 21:49:05 +01005730 *'pythonthreehome'*
5731'pythonthreehome' string (default "")
5732 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005733 {only available when compiled with the |+python3/dyn|
5734 feature}
5735 Specifies the name of the Python 3 home directory. When
5736 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5737 PYTHON3_HOME, which was specified at compile time, will be used for
5738 the Python 3 home directory.
5739 Environment variables are expanded |:set_env|.
5740 This option cannot be set from a |modeline| or in the |sandbox|, for
5741 security reasons.
5742
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005743 *'pyxversion'* *'pyx'*
5744'pyxversion' 'pyx' number (default depends on the build)
5745 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005746 {only available when compiled with the |+python| or
5747 the |+python3| feature}
5748 Specifies the python version used for pyx* functions and commands
5749 |python_x|. The default value is as follows:
5750
5751 Compiled with Default ~
5752 |+python| and |+python3| 0
5753 only |+python| 2
5754 only |+python3| 3
5755
5756 Available values are 0, 2 and 3.
5757 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5758 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5759 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5760 to 2 if Python 2 is available.
5761 See also: |has-pythonx|
5762
5763 If Vim is compiled with only |+python| or |+python3| setting
5764 'pyxversion' has no effect. The pyx* functions and commands are
5765 always the same as the compiled version.
5766
5767 This option cannot be set from a |modeline| or in the |sandbox|, for
5768 security reasons.
5769
Bram Moolenaar677ee682005-01-27 14:41:15 +00005770 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005771'quoteescape' 'qe' string (default "\")
5772 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005773 The characters that are used to escape quotes in a string. Used for
5774 objects like a', a" and a` |a'|.
5775 When one of the characters in this option is found inside a string,
5776 the following character will be skipped. The default value makes the
5777 text "foo\"bar\\" considered to be one string.
5778
Bram Moolenaar071d4272004-06-13 20:20:40 +00005779 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5780'readonly' 'ro' boolean (default off)
5781 local to buffer
5782 If on, writes fail unless you use a '!'. Protects you from
5783 accidentally overwriting a file. Default on when Vim is started
5784 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005785 When using ":w!" the 'readonly' option is reset for the current
5786 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005787 When using the ":view" command the 'readonly' option is set for the
5788 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005789 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005791 *'redrawtime'* *'rdt'*
5792'redrawtime' 'rdt' number (default 2000)
5793 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005794 {only available when compiled with the |+reltime|
5795 feature}
5796 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005797 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005798 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005799 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005800 matches will be highlighted.
5801 For syntax highlighting the time applies per window. When over the
5802 limit syntax highlighting is disabled until |CTRL-L| is used.
5803 This is used to avoid that Vim hangs when using a very complicated
5804 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005805
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005806 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005807'regexpengine' 're' number (default 0)
5808 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005809 This selects the default regexp engine. |two-engines|
5810 The possible values are:
5811 0 automatic selection
5812 1 old engine
5813 2 NFA engine
5814 Note that when using the NFA engine and the pattern contains something
5815 that is not supported the pattern will not match. This is only useful
5816 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005817 Using automatic selection enables Vim to switch the engine, if the
5818 default engine becomes too costly. E.g., when the NFA engine uses too
5819 many states. This should prevent Vim from hanging on a combination of
5820 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005821
Bram Moolenaar64486672010-05-16 15:46:46 +02005822 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5823'relativenumber' 'rnu' boolean (default off)
5824 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005825 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005826 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005827 precede some vertical motion commands (e.g. j k + -) with, without
5828 having to calculate it yourself. Especially useful in combination with
5829 other commands (e.g. y d c < > gq gw =).
5830 When the 'n' option is excluded from 'cpoptions' a wrapped
5831 line will not use the column of line numbers (this is the default when
5832 'compatible' isn't set).
5833 The 'numberwidth' option can be used to set the room used for the line
5834 number.
5835 When a long, wrapped line doesn't start with the first character, '-'
5836 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005837 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5838 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005839
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005840 The number in front of the cursor line also depends on the value of
5841 'number', see |number_relativenumber| for all combinations of the two
5842 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005843
Bram Moolenaar071d4272004-06-13 20:20:40 +00005844 *'remap'* *'noremap'*
5845'remap' boolean (default on)
5846 global
5847 Allows for mappings to work recursively. If you do not want this for
5848 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005849 NOTE: To avoid portability problems with Vim scripts, always keep
5850 this option at the default "on". Only switch it off when working with
5851 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005852
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005853 *'renderoptions'* *'rop'*
5854'renderoptions' 'rop' string (default: empty)
5855 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005856 {only available when compiled with GUI and DIRECTX on
5857 MS-Windows}
5858 Select a text renderer and set its options. The options depend on the
5859 renderer.
5860
5861 Syntax: >
5862 set rop=type:{renderer}(,{name}:{value})*
5863<
5864 Currently, only one optional renderer is available.
5865
5866 render behavior ~
5867 directx Vim will draw text using DirectX (DirectWrite). It makes
5868 drawn glyphs more beautiful than default GDI.
5869 It requires 'encoding' is "utf-8", and only works on
5870 MS-Windows Vista or newer version.
5871
5872 Options:
5873 name meaning type value ~
5874 gamma gamma float 1.0 - 2.2 (maybe)
5875 contrast enhancedContrast float (unknown)
5876 level clearTypeLevel float (unknown)
5877 geom pixelGeometry int 0 - 2 (see below)
5878 renmode renderingMode int 0 - 6 (see below)
5879 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01005880 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005881
Bram Moolenaar92467d32017-12-05 13:22:16 +01005882 See this URL for detail (except for scrlines):
5883 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005884
5885 For geom: structure of a device pixel.
5886 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5887 1 - DWRITE_PIXEL_GEOMETRY_RGB
5888 2 - DWRITE_PIXEL_GEOMETRY_BGR
5889
5890 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005891 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005892
5893 For renmode: method of rendering glyphs.
5894 0 - DWRITE_RENDERING_MODE_DEFAULT
5895 1 - DWRITE_RENDERING_MODE_ALIASED
5896 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5897 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5898 4 - DWRITE_RENDERING_MODE_NATURAL
5899 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5900 6 - DWRITE_RENDERING_MODE_OUTLINE
5901
5902 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005903 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005904
5905 For taamode: antialiasing mode used for drawing text.
5906 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5907 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5908 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5909 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5910
5911 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005912 https://msdn.microsoft.com/en-us/library/dd368170.aspx
5913
Bram Moolenaara338adc2018-01-31 20:51:47 +01005914 For scrlines:
5915 This was used for optimizing scrolling behavior, however this
5916 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005917
5918 Example: >
5919 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005920 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005921 set rop=type:directx
5922<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005923 If select a raster font (Courier, Terminal or FixedSys which
5924 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01005925 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005926
5927 NOTE: It is known that some fonts and options combination
5928 causes trouble on drawing glyphs.
5929
Bram Moolenaar92467d32017-12-05 13:22:16 +01005930 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005931 special made fonts (True-Type fonts which includes only
5932 bitmap glyphs).
5933 - 'taamode:3' will not work with some vector fonts.
5934
5935 NOTE: With this option, you can display colored emoji
5936 (emoticon) in Windows 8.1 or later. To display colored emoji,
5937 there are some conditions which you should notice.
5938
5939 - If your font includes non-colored emoji already, it will
5940 be used.
5941 - If your font doesn't have emoji, the system chooses an
5942 alternative symbol font. On Windows 10, "Segoe UI Emoji"
5943 will be used.
5944 - When this alternative font didn't have fixed width glyph,
5945 emoji might be rendered beyond the bounding box of drawing
5946 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005947
5948 Other render types are currently not supported.
5949
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 *'report'*
5951'report' number (default 2)
5952 global
5953 Threshold for reporting number of lines changed. When the number of
5954 changed lines is more than 'report' a message will be given for most
5955 ":" commands. If you want it always, set 'report' to 0.
5956 For the ":substitute" command the number of substitutions is used
5957 instead of the number of lines.
5958
5959 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5960'restorescreen' 'rs' boolean (default on)
5961 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005962 {only in Windows 95/NT console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963 When set, the screen contents is restored when exiting Vim. This also
5964 happens when executing external commands.
5965
5966 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5967 options in your .vimrc. To disable restoring:
5968 set t_ti= t_te=
5969 To enable restoring (for an xterm):
5970 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5971 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5972
5973 *'revins'* *'ri'* *'norevins'* *'nori'*
5974'revins' 'ri' boolean (default off)
5975 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976 {only available when compiled with the |+rightleft|
5977 feature}
5978 Inserting characters in Insert mode will work backwards. See "typing
5979 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5980 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02005981 NOTE: This option is reset when 'compatible' is set.
5982 This option is reset when 'paste' is set and restored when 'paste' is
5983 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005984
5985 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5986'rightleft' 'rl' boolean (default off)
5987 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988 {only available when compiled with the |+rightleft|
5989 feature}
5990 When on, display orientation becomes right-to-left, i.e., characters
5991 that are stored in the file appear from the right to the left.
5992 Using this option, it is possible to edit files for languages that
5993 are written from the right to the left such as Hebrew and Arabic.
5994 This option is per window, so it is possible to edit mixed files
5995 simultaneously, or to view the same file in both ways (this is
5996 useful whenever you have a mixed text file with both right-to-left
5997 and left-to-right strings so that both sets are displayed properly
5998 in different windows). Also see |rileft.txt|.
5999
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006000 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001'rightleftcmd' 'rlc' string (default "search")
6002 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006003 {only available when compiled with the |+rightleft|
6004 feature}
6005 Each word in this option enables the command line editing to work in
6006 right-to-left mode for a group of commands:
6007
6008 search "/" and "?" commands
6009
6010 This is useful for languages such as Hebrew, Arabic and Farsi.
6011 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6012
Bram Moolenaard94464e2015-11-02 15:28:18 +01006013 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006014'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006015 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006016 {only available when compiled with the |+ruby/dyn|
6017 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006018 Specifies the name of the Ruby shared library. The default is
6019 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006020 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006021 This option cannot be set from a |modeline| or in the |sandbox|, for
6022 security reasons.
6023
Bram Moolenaar071d4272004-06-13 20:20:40 +00006024 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006025'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006026 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006027 {not available when compiled without the
6028 |+cmdline_info| feature}
6029 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006030 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 text in the file is shown on the far right:
6032 Top first line is visible
6033 Bot last line is visible
6034 All first and last line are visible
6035 45% relative position in the file
6036 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006037 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006039 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006040 this option takes precedence over 'ruler' and 'rulerformat'
6041 If the number of characters displayed is different from the number of
6042 bytes in the text (e.g., for a TAB or a multi-byte character), both
6043 the text column (byte number) and the screen column are shown,
6044 separated with a dash.
6045 For an empty line "0-1" is shown.
6046 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006047 This option is reset when 'paste' is set and restored when 'paste' is
6048 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006049 If you don't want to see the ruler all the time but want to know where
6050 you are, use "g CTRL-G" |g_CTRL-G|.
6051 NOTE: This option is reset when 'compatible' is set.
6052
6053 *'rulerformat'* *'ruf'*
6054'rulerformat' 'ruf' string (default empty)
6055 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006056 {not available when compiled without the |+statusline|
6057 feature}
6058 When this option is not empty, it determines the content of the ruler
6059 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006060 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061 The default ruler width is 17 characters. To make the ruler 15
6062 characters wide, put "%15(" at the start and "%)" at the end.
6063 Example: >
6064 :set rulerformat=%15(%c%V\ %p%%%)
6065<
6066 *'runtimepath'* *'rtp'* *vimfiles*
6067'runtimepath' 'rtp' string (default:
6068 Unix: "$HOME/.vim,
6069 $VIM/vimfiles,
6070 $VIMRUNTIME,
6071 $VIM/vimfiles/after,
6072 $HOME/.vim/after"
6073 Amiga: "home:vimfiles,
6074 $VIM/vimfiles,
6075 $VIMRUNTIME,
6076 $VIM/vimfiles/after,
6077 home:vimfiles/after"
6078 PC, OS/2: "$HOME/vimfiles,
6079 $VIM/vimfiles,
6080 $VIMRUNTIME,
6081 $VIM/vimfiles/after,
6082 $HOME/vimfiles/after"
6083 Macintosh: "$VIM:vimfiles,
6084 $VIMRUNTIME,
6085 $VIM:vimfiles:after"
6086 RISC-OS: "Choices:vimfiles,
6087 $VIMRUNTIME,
6088 Choices:vimfiles/after"
6089 VMS: "sys$login:vimfiles,
6090 $VIM/vimfiles,
6091 $VIMRUNTIME,
6092 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006093 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 This is a list of directories which will be searched for runtime
6096 files:
6097 filetype.vim filetypes by file name |new-filetype|
6098 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006099 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 colors/ color scheme files |:colorscheme|
6101 compiler/ compiler files |:compiler|
6102 doc/ documentation |write-local-help|
6103 ftplugin/ filetype plugins |write-filetype-plugin|
6104 indent/ indent scripts |indent-expression|
6105 keymap/ key mapping files |mbyte-keymap|
6106 lang/ menu translations |:menutrans|
6107 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006108 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006109 plugin/ plugin scripts |write-plugin|
6110 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006111 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006112 syntax/ syntax files |mysyntaxfile|
6113 tutor/ files for vimtutor |tutor|
6114
6115 And any other file searched for with the |:runtime| command.
6116
6117 The defaults for most systems are setup to search five locations:
6118 1. In your home directory, for your personal preferences.
6119 2. In a system-wide Vim directory, for preferences from the system
6120 administrator.
6121 3. In $VIMRUNTIME, for files distributed with Vim.
6122 *after-directory*
6123 4. In the "after" directory in the system-wide Vim directory. This is
6124 for the system administrator to overrule or add to the distributed
6125 defaults (rarely needed)
6126 5. In the "after" directory in your home directory. This is for
6127 personal preferences to overrule or add to the distributed defaults
6128 or system-wide settings (rarely needed).
6129
Bram Moolenaard0796902016-09-16 20:02:31 +02006130 More entries are added when using |packages|. If it gets very long
6131 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6132 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006133
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6135 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006136 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006137 wildcards.
6138 See |:runtime|.
6139 Example: >
6140 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6141< This will use the directory "~/vimruntime" first (containing your
6142 personal Vim runtime files), then "/mygroup/vim" (shared between a
6143 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6144 files).
6145 You probably should always include $VIMRUNTIME somewhere, to use the
6146 distributed runtime files. You can put a directory before $VIMRUNTIME
6147 to find files which replace a distributed runtime files. You can put
6148 a directory after $VIMRUNTIME to find files which add to distributed
6149 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006150 When Vim is started with |--clean| the home directory entries are not
6151 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 This option cannot be set from a |modeline| or in the |sandbox|, for
6153 security reasons.
6154
6155 *'scroll'* *'scr'*
6156'scroll' 'scr' number (default: half the window height)
6157 local to window
6158 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6159 set to half the number of lines in the window when the window size
6160 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006161 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006162 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163
6164 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6165'scrollbind' 'scb' boolean (default off)
6166 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 See also |scroll-binding|. When this option is set, the current
6168 window scrolls as other scrollbind windows (windows that also have
6169 this option set) scroll. This option is useful for viewing the
6170 differences between two versions of a file, see 'diff'.
6171 See |'scrollopt'| for options that determine how this option should be
6172 interpreted.
6173 This option is mostly reset when splitting a window to edit another
6174 file. This means that ":split | edit file" results in two windows
6175 with scroll-binding, but ":split file" does not.
6176
6177 *'scrolljump'* *'sj'*
6178'scrolljump' 'sj' number (default 1)
6179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006180 Minimal number of lines to scroll when the cursor gets off the
6181 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6182 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006183 When set to a negative number from -1 to -100 this is used as the
6184 percentage of the window height. Thus -50 scrolls half the window
6185 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186 NOTE: This option is set to 1 when 'compatible' is set.
6187
6188 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006189'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006190 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191 Minimal number of screen lines to keep above and below the cursor.
6192 This will make some context visible around where you are working. If
6193 you set it to a very large value (999) the cursor line will always be
6194 in the middle of the window (except at the start or end of the file or
6195 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006196 After using the local value, go back the global value with one of
6197 these two: >
6198 setlocal scrolloff<
6199 setlocal scrolloff=-1
6200< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 NOTE: This option is set to 0 when 'compatible' is set.
6202
6203 *'scrollopt'* *'sbo'*
6204'scrollopt' 'sbo' string (default "ver,jump")
6205 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006207 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6208 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209 The following words are available:
6210 ver Bind vertical scrolling for 'scrollbind' windows
6211 hor Bind horizontal scrolling for 'scrollbind' windows
6212 jump Applies to the offset between two windows for vertical
6213 scrolling. This offset is the difference in the first
6214 displayed line of the bound windows. When moving
6215 around in a window, another 'scrollbind' window may
6216 reach a position before the start or after the end of
6217 the buffer. The offset is not changed though, when
6218 moving back the 'scrollbind' window will try to scroll
6219 to the desired position when possible.
6220 When now making that window the current one, two
6221 things can be done with the relative offset:
6222 1. When "jump" is not included, the relative offset is
6223 adjusted for the scroll position in the new current
6224 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006225 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006226 2. When "jump" is included, the other windows are
6227 scrolled to keep the same relative offset. When
6228 going back to the other window, it still uses the
6229 same relative offset.
6230 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006231 When 'diff' mode is active there always is vertical scroll binding,
6232 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233
6234 *'sections'* *'sect'*
6235'sections' 'sect' string (default "SHNHH HUnhsh")
6236 global
6237 Specifies the nroff macros that separate sections. These are pairs of
6238 two letters (See |object-motions|). The default makes a section start
6239 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6240
6241 *'secure'* *'nosecure'* *E523*
6242'secure' boolean (default off)
6243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244 When on, ":autocmd", shell and write commands are not allowed in
6245 ".vimrc" and ".exrc" in the current directory and map commands are
6246 displayed. Switch it off only if you know that you will not run into
6247 problems, or when the 'exrc' option is off. On Unix this option is
6248 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006249 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006250 'secure' at the end of your ~/.vimrc then.
6251 This option cannot be set from a |modeline| or in the |sandbox|, for
6252 security reasons.
6253
6254 *'selection'* *'sel'*
6255'selection' 'sel' string (default "inclusive")
6256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 This option defines the behavior of the selection. It is only used
6258 in Visual and Select mode.
6259 Possible values:
6260 value past line inclusive ~
6261 old no yes
6262 inclusive yes yes
6263 exclusive yes no
6264 "past line" means that the cursor is allowed to be positioned one
6265 character past the line.
6266 "inclusive" means that the last character of the selection is included
6267 in an operation. For example, when "x" is used to delete the
6268 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006269 When "old" is used and 'virtualedit' allows the cursor to move past
6270 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271 Note that when "exclusive" is used and selecting from the end
6272 backwards, you cannot include the last character of a line, when
6273 starting in Normal mode and 'virtualedit' empty.
6274
6275 The 'selection' option is set by the |:behave| command.
6276
6277 *'selectmode'* *'slm'*
6278'selectmode' 'slm' string (default "")
6279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280 This is a comma separated list of words, which specifies when to start
6281 Select mode instead of Visual mode, when a selection is started.
6282 Possible values:
6283 mouse when using the mouse
6284 key when using shifted special keys
6285 cmd when using "v", "V" or CTRL-V
6286 See |Select-mode|.
6287 The 'selectmode' option is set by the |:behave| command.
6288
6289 *'sessionoptions'* *'ssop'*
6290'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006291 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006292 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006293 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294 feature}
6295 Changes the effect of the |:mksession| command. It is a comma
6296 separated list of words. Each word enables saving and restoring
6297 something:
6298 word save and restore ~
6299 blank empty windows
6300 buffers hidden and unloaded buffers, not just those in windows
6301 curdir the current directory
6302 folds manually created folds, opened/closed folds and local
6303 fold options
6304 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006305 and contain at least one lowercase letter. Only
6306 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 help the help window
6308 localoptions options and mappings local to a window or buffer (not
6309 global values for local options)
6310 options all options and mappings (also global values for local
6311 options)
6312 resize size of the Vim window: 'lines' and 'columns'
6313 sesdir the directory in which the session file is located
6314 will become the current directory (useful with
6315 projects accessed over a network from different
6316 systems)
6317 slash backslashes in file names replaced with forward
6318 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006319 tabpages all tab pages; without this only the current tab page
6320 is restored, so that you can make a session for each
6321 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006322 terminal include terminal windows where the command can be
6323 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 unix with Unix end-of-line format (single <NL>), even when
6325 on Windows or DOS
6326 winpos position of the whole Vim window
6327 winsize window sizes
6328
6329 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006330 When neither "curdir" nor "sesdir" is included, file names are stored
6331 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 "slash" and "unix" are useful on Windows when sharing session files
6333 with Unix. The Unix version of Vim cannot source dos format scripts,
6334 but the Windows version of Vim can source unix format scripts.
6335
6336 *'shell'* *'sh'* *E91*
6337'shell' 'sh' string (default $SHELL or "sh",
6338 MS-DOS and Win32: "command.com" or
6339 "cmd.exe", OS/2: "cmd")
6340 global
6341 Name of the shell to use for ! and :! commands. When changing the
6342 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6343 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006344 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 See |option-backslash| about including spaces and backslashes.
6346 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006347
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006349 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6351< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006352 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006354 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006356 Example with escaped space (Vim will do this when initializing the
6357 option from $SHELL): >
6358 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006359< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006360 backslashes are consumed by `:set`.
6361
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 Under MS-Windows, when the executable ends in ".com" it must be
6363 included. Thus setting the shell to "command.com" or "4dos.com"
6364 works, but "command" and "4dos" do not work for all commands (e.g.,
6365 filtering).
6366 For unknown reasons, when using "4dos.com" the current directory is
6367 changed to "C:\". To avoid this set 'shell' like this: >
6368 :set shell=command.com\ /c\ 4dos
6369< This option cannot be set from a |modeline| or in the |sandbox|, for
6370 security reasons.
6371
6372 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006373'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006374 MS-DOS and Win32, when 'shell' does not
6375 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006377 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6378 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6379 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006380 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006381 On Unix it can have more than one flag. Each white space separated
6382 part is passed as an argument to the shell command.
6383 See |option-backslash| about including spaces and backslashes.
6384 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385 This option cannot be set from a |modeline| or in the |sandbox|, for
6386 security reasons.
6387
6388 *'shellpipe'* *'sp'*
6389'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6390 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 {not available when compiled without the |+quickfix|
6392 feature}
6393 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006394 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 including spaces and backslashes.
6396 The name of the temporary file can be represented by "%s" if necessary
6397 (the file name is appended automatically if no %s appears in the value
6398 of this option).
6399 For the Amiga and MS-DOS the default is ">". The output is directly
6400 saved in a file and not echoed to the screen.
6401 For Unix the default it "| tee". The stdout of the compiler is saved
6402 in a file and echoed to the screen. If the 'shell' option is "csh" or
6403 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006404 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6405 default becomes "2>&1| tee". This means that stderr is also included.
6406 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6407 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 The initialization of this option is done after reading the ".vimrc"
6409 and the other initializations, so that when the 'shell' option is set
6410 there, the 'shellpipe' option changes automatically, unless it was
6411 explicitly set before.
6412 When 'shellpipe' is set to an empty string, no redirection of the
6413 ":make" output will be done. This is useful if you use a 'makeprg'
6414 that writes to 'makeef' by itself. If you want no piping, but do
6415 want to include the 'makeef', set 'shellpipe' to a single space.
6416 Don't forget to precede the space with a backslash: ":set sp=\ ".
6417 In the future pipes may be used for filtering and this option will
6418 become obsolete (at least for Unix).
6419 This option cannot be set from a |modeline| or in the |sandbox|, for
6420 security reasons.
6421
6422 *'shellquote'* *'shq'*
6423'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6424 contains "sh" somewhere: "\"")
6425 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426 Quoting character(s), put around the command passed to the shell, for
6427 the "!" and ":!" commands. The redirection is kept outside of the
6428 quoting. See 'shellxquote' to include the redirection. It's
6429 probably not useful to set both options.
6430 This is an empty string by default. Only known to be useful for
6431 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6432 or bash, where it should be "\"". The default is adjusted according
6433 the value of 'shell', to reduce the need to set this option by the
6434 user. See |dos-shell|.
6435 This option cannot be set from a |modeline| or in the |sandbox|, for
6436 security reasons.
6437
6438 *'shellredir'* *'srr'*
6439'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6440 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441 String to be used to put the output of a filter command in a temporary
6442 file. See also |:!|. See |option-backslash| about including spaces
6443 and backslashes.
6444 The name of the temporary file can be represented by "%s" if necessary
6445 (the file name is appended automatically if no %s appears in the value
6446 of this option).
6447 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6448 or "zsh" during initializations, the default becomes ">&". If the
6449 'shell' option is "sh", "ksh" or "bash" the default becomes
6450 ">%s 2>&1". This means that stderr is also included.
6451 For Win32, the Unix checks are done and additionally "cmd" is checked
6452 for, which makes the default ">%s 2>&1". Also, the same names with
6453 ".exe" appended are checked for.
6454 The initialization of this option is done after reading the ".vimrc"
6455 and the other initializations, so that when the 'shell' option is set
6456 there, the 'shellredir' option changes automatically unless it was
6457 explicitly set before.
6458 In the future pipes may be used for filtering and this option will
6459 become obsolete (at least for Unix).
6460 This option cannot be set from a |modeline| or in the |sandbox|, for
6461 security reasons.
6462
6463 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6464'shellslash' 'ssl' boolean (default off)
6465 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006466 {only for MSDOS, MS-Windows and OS/2}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 When set, a forward slash is used when expanding file names. This is
6468 useful when a Unix-like shell is used instead of command.com or
6469 cmd.exe. Backward slashes can still be typed, but they are changed to
6470 forward slashes by Vim.
6471 Note that setting or resetting this option has no effect for some
6472 existing file names, thus this option needs to be set before opening
6473 any file for best results. This might change in the future.
6474 'shellslash' only works when a backslash can be used as a path
6475 separator. To test if this is so use: >
6476 if exists('+shellslash')
6477<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006478 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6479'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6480 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006481 When on, use temp files for shell commands. When off use a pipe.
6482 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006483 Currently a pipe is only supported on Unix and MS-Windows 2K and
6484 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006485 :if has("filterpipe")
6486< The advantage of using a pipe is that nobody can read the temp file
6487 and the 'shell' command does not need to support redirection.
6488 The advantage of using a temp file is that the file type and encoding
6489 can be detected.
6490 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6491 |FilterWritePost| autocommands event are not triggered when
6492 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006493 The `system()` function does not respect this option and always uses
6494 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006495 NOTE: This option is set to the Vim default value when 'compatible'
6496 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006497
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 *'shelltype'* *'st'*
6499'shelltype' 'st' number (default 0)
6500 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006501 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 On the Amiga this option influences the way how the commands work
6503 which use a shell.
6504 0 and 1: always use the shell
6505 2 and 3: use the shell only to filter lines
6506 4 and 5: use shell only for ':sh' command
6507 When not using the shell, the command is executed directly.
6508
6509 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6510 1 and 3: use "shell cmd" to start external commands
6511
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006512 *'shellxescape'* *'sxe'*
6513'shellxescape' 'sxe' string (default: "";
6514 for MS-DOS and MS-Windows: "\"&|<>()@^")
6515 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006516 When 'shellxquote' is set to "(" then the characters listed in this
6517 option will be escaped with a '^' character. This makes it possible
6518 to execute most external commands with cmd.exe.
6519
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 *'shellxquote'* *'sxq'*
6521'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006522 for Win32, when 'shell' is cmd.exe: "("
6523 for Win32, when 'shell' contains "sh"
6524 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 for Unix, when using system(): "\"")
6526 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 Quoting character(s), put around the command passed to the shell, for
6528 the "!" and ":!" commands. Includes the redirection. See
6529 'shellquote' to exclude the redirection. It's probably not useful
6530 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006531 When the value is '(' then ')' is appended. When the value is '"('
6532 then ')"' is appended.
6533 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006534 This is an empty string by default on most systems, but is known to be
6535 useful for on Win32 version, either for cmd.exe which automatically
6536 strips off the first and last quote on a command, or 3rd-party shells
6537 such as the MKS Korn Shell or bash, where it should be "\"". The
6538 default is adjusted according the value of 'shell', to reduce the need
6539 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 This option cannot be set from a |modeline| or in the |sandbox|, for
6541 security reasons.
6542
6543 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6544'shiftround' 'sr' boolean (default off)
6545 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 Round indent to multiple of 'shiftwidth'. Applies to > and <
6547 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6548 a multiple of 'shiftwidth' (this is Vi compatible).
6549 NOTE: This option is reset when 'compatible' is set.
6550
6551 *'shiftwidth'* *'sw'*
6552'shiftwidth' 'sw' number (default 8)
6553 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006554 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006556 When zero the 'ts' value will be used. Use the |shiftwidth()|
6557 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006558
6559 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006560'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6561 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 This option helps to avoid all the |hit-enter| prompts caused by file
6564 messages, for example with CTRL-G, and to avoid some other messages.
6565 It is a list of flags:
6566 flag meaning when present ~
6567 f use "(3 of 5)" instead of "(file 3 of 5)"
6568 i use "[noeol]" instead of "[Incomplete last line]"
6569 l use "999L, 888C" instead of "999 lines, 888 characters"
6570 m use "[+]" instead of "[Modified]"
6571 n use "[New]" instead of "[New File]"
6572 r use "[RO]" instead of "[readonly]"
6573 w use "[w]" instead of "written" for file write message
6574 and "[a]" instead of "appended" for ':w >> file' command
6575 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6576 "[unix format]" and "[mac]" instead of "[mac format]".
6577 a all of the above abbreviations
6578
6579 o overwrite message for writing a file with subsequent message
6580 for reading a file (useful for ":wn" or when 'autowrite' on)
6581 O message for reading a file overwrites any previous message.
6582 Also for quickfix message (e.g., ":cn").
6583 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006584 hit TOP, continuing at BOTTOM" messages; when using the search
6585 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 t truncate file message at the start if it is too long to fit
6587 on the command-line, "<" will appear in the left most column.
6588 Ignored in Ex mode.
6589 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006590 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591 Ignored in Ex mode.
6592 W don't give "written" or "[w]" when writing a file
6593 A don't give the "ATTENTION" message when an existing swap file
6594 is found.
6595 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006596 c don't give |ins-completion-menu| messages. For example,
6597 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6598 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006599 q use "recording" instead of "recording @a"
6600 F don't give the file info when editing a file, like `:silent`
6601 was used for the command
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006602 S do not show search count message when searching, e.g.
6603 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604
6605 This gives you the opportunity to avoid that a change between buffers
6606 requires you to hit <Enter>, but still gives as useful a message as
6607 possible for the space available. To get the whole message that you
6608 would have got with 'shm' empty, use ":file!"
6609 Useful values:
6610 shm= No abbreviation of message.
6611 shm=a Abbreviation, but no loss of information.
6612 shm=at Abbreviation, and truncate message when necessary.
6613
6614 NOTE: This option is set to the Vi default value when 'compatible' is
6615 set and to the Vim default value when 'compatible' is reset.
6616
6617 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6618'shortname' 'sn' boolean (default off)
6619 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 Filenames are assumed to be 8 characters plus one extension of 3
6621 characters. Multiple dots in file names are not allowed. When this
6622 option is on, dots in file names are replaced with underscores when
6623 adding an extension (".~" or ".swp"). This option is not available
6624 for MS-DOS, because then it would always be on. This option is useful
6625 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6626 or crossdos. When running the Win32 GUI version under Win32s, this
6627 option is always on by default.
6628
6629 *'showbreak'* *'sbr'* *E595*
6630'showbreak' 'sbr' string (default "")
6631 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006632 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633 feature}
6634 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006635 values are "> " or "+++ ": >
6636 :set showbreak=>\
6637< Note the backslash to escape the trailing space. It's easier like
6638 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006639 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006640< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006641 comma (in a future version the comma might be used to separate the
6642 part that is shown at the end and at the start of a line).
6643 The characters are highlighted according to the '@' flag in
6644 'highlight'.
6645 Note that tabs after the showbreak will be displayed differently.
6646 If you want the 'showbreak' to appear in between line numbers, add the
6647 "n" flag to 'cpoptions'.
6648
6649 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006650'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6651 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 {not available when compiled without the
6654 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006655 Show (partial) command in the last line of the screen. Set this
6656 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 In Visual mode the size of the selected area is shown:
6658 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006659 If the number of bytes is different it is also displayed: "2-6"
6660 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006662 - When selecting a block, the size in screen characters:
6663 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 NOTE: This option is set to the Vi default value when 'compatible' is
6665 set and to the Vim default value when 'compatible' is reset.
6666
6667 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6668'showfulltag' 'sft' boolean (default off)
6669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 When completing a word in insert mode (see |ins-completion|) from the
6671 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006672 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 matched a C function, you can see a template for what arguments are
6674 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006675 Note that this doesn't work well together with having "longest" in
6676 'completeopt', because the completion from the search pattern may not
6677 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678
6679 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6680'showmatch' 'sm' boolean (default off)
6681 global
6682 When a bracket is inserted, briefly jump to the matching one. The
6683 jump is only done if the match can be seen on the screen. The time to
6684 show the match can be set with 'matchtime'.
6685 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006686 seen or not).
6687 This option is reset when 'paste' is set and restored when 'paste' is
6688 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 When the 'm' flag is not included in 'cpoptions', typing a character
6690 will immediately move the cursor back to where it belongs.
6691 See the "sm" field in 'guicursor' for setting the cursor shape and
6692 blinking when showing the match.
6693 The 'matchpairs' option can be used to specify the characters to show
6694 matches for. 'rightleft' and 'revins' are used to look for opposite
6695 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006696 Also see the matchparen plugin for highlighting the match when moving
6697 around |pi_paren.txt|.
6698 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699
6700 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6701'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6702 global
6703 If in Insert, Replace or Visual mode put a message on the last line.
6704 Use the 'M' flag in 'highlight' to set the type of highlighting for
6705 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006706 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707 doesn't mean XIM is really active, especially when 'imactivatekey' is
6708 not set.
6709 NOTE: This option is set to the Vi default value when 'compatible' is
6710 set and to the Vim default value when 'compatible' is reset.
6711
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006712 *'showtabline'* *'stal'*
6713'showtabline' 'stal' number (default 1)
6714 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006715 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006716 feature}
6717 The value of this option specifies when the line with tab page labels
6718 will be displayed:
6719 0: never
6720 1: only if there are at least two tab pages
6721 2: always
6722 This is both for the GUI and non-GUI implementation of the tab pages
6723 line.
6724 See |tab-page| for more information about tab pages.
6725
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726 *'sidescroll'* *'ss'*
6727'sidescroll' 'ss' number (default 0)
6728 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 The minimal number of columns to scroll horizontally. Used only when
6730 the 'wrap' option is off and the cursor is moved off of the screen.
6731 When it is zero the cursor will be put in the middle of the screen.
6732 When using a slow terminal set it to a large number or 0. When using
6733 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6734 commands.
6735
6736 *'sidescrolloff'* *'siso'*
6737'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006738 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006740 right of the cursor if 'nowrap' is set. Setting this option to a
6741 value greater than 0 while having |'sidescroll'| also at a non-zero
6742 value makes some context visible in the line you are scrolling in
6743 horizontally (except at beginning of the line). Setting this option
6744 to a large value (like 999) has the effect of keeping the cursor
6745 horizontally centered in the window, as long as one does not come too
6746 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006747 After using the local value, go back the global value with one of
6748 these two: >
6749 setlocal sidescrolloff<
6750 setlocal sidescrolloff=-1
6751< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752
6753 Example: Try this together with 'sidescroll' and 'listchars' as
6754 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006755 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756
6757 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6758 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006759<
6760 *'signcolumn'* *'scl'*
6761'signcolumn' 'scl' string (default "auto")
6762 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006763 {not available when compiled without the |+signs|
6764 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006765 Whether or not to draw the signcolumn. Valid values are:
6766 "auto" only when there is a sign to display
6767 "no" never
6768 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769
6770
6771 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6772'smartcase' 'scs' boolean (default off)
6773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006774 Override the 'ignorecase' option if the search pattern contains upper
6775 case characters. Only used when the search pattern is typed and
6776 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006777 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006778 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6779 recalling the search pattern from history and hitting <Enter>.
6780 NOTE: This option is reset when 'compatible' is set.
6781
6782 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6783'smartindent' 'si' boolean (default off)
6784 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 {not available when compiled without the
6786 |+smartindent| feature}
6787 Do smart autoindenting when starting a new line. Works for C-like
6788 programs, but can also be used for other languages. 'cindent' does
6789 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006790 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006791 setting 'si' has no effect. 'indentexpr' is a more advanced
6792 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793 Normally 'autoindent' should also be on when using 'smartindent'.
6794 An indent is automatically inserted:
6795 - After a line ending in '{'.
6796 - After a line starting with a keyword from 'cinwords'.
6797 - Before a line starting with '}' (only with the "O" command).
6798 When typing '}' as the first character in a new line, that line is
6799 given the same indent as the matching '{'.
6800 When typing '#' as the first character in a new line, the indent for
6801 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006802 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6804 When using the ">>" command, lines starting with '#' are not shifted
6805 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006806 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006807 This option is reset when 'paste' is set and restored when 'paste' is
6808 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809
6810 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6811'smarttab' 'sta' boolean (default off)
6812 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006814 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6815 <BS> will delete a 'shiftwidth' worth of space at the start of the
6816 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006817 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006818 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6819 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006820 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006822 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006823 This option is reset when 'paste' is set and restored when 'paste' is
6824 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 NOTE: This option is reset when 'compatible' is set.
6826
6827 *'softtabstop'* *'sts'*
6828'softtabstop' 'sts' number (default 0)
6829 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 Number of spaces that a <Tab> counts for while performing editing
6831 operations, like inserting a <Tab> or using <BS>. It "feels" like
6832 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6833 used. This is useful to keep the 'ts' setting at its standard value
6834 of 8, while being able to edit like it is set to 'sts'. However,
6835 commands like "x" still work on the actual characters.
6836 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006837 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006838 'softtabstop' is set to 0 when the 'paste' option is set and restored
6839 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6841 spaces is minimized by using <Tab>s.
6842 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6843 set.
6844 NOTE: This option is set to 0 when 'compatible' is set.
6845
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006846 If Vim is compiled with the |+vartabs| feature then the value of
6847 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6848 anything other than an empty string.
6849
Bram Moolenaar217ad922005-03-20 22:37:15 +00006850 *'spell'* *'nospell'*
6851'spell' boolean (default off)
6852 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006853 {not available when compiled without the |+syntax|
6854 feature}
6855 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006856 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006857
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006858 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006859'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006860 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006861 {not available when compiled without the |+syntax|
6862 feature}
6863 Pattern to locate the end of a sentence. The following word will be
6864 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006865 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006866 When this check is not wanted make this option empty.
6867 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006868 Be careful with special characters, see |option-backslash| about
6869 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006870 To set this option automatically depending on the language, see
6871 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006872
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006873 *'spellfile'* *'spf'*
6874'spellfile' 'spf' string (default empty)
6875 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006876 {not available when compiled without the |+syntax|
6877 feature}
6878 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006879 commands. It must end in ".{encoding}.add". You need to include the
6880 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006881 *E765*
6882 It may also be a comma separated list of names. A count before the
6883 |zg| and |zw| commands can be used to access each. This allows using
6884 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006885 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006886 you: Using the first directory in 'runtimepath' that is writable. If
6887 there is no "spell" directory yet it will be created. For the file
6888 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006889 ignoring the region.
6890 The resulting ".spl" file will be used for spell checking, it does not
6891 have to appear in 'spelllang'.
6892 Normally one file is used for all regions, but you can add the region
6893 name if you want to. However, it will then only be used when
6894 'spellfile' is set to it, for entries in 'spelllang' only files
6895 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006896 This option cannot be set from a |modeline| or in the |sandbox|, for
6897 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006898
Bram Moolenaar217ad922005-03-20 22:37:15 +00006899 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006900'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006901 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00006902 {not available when compiled without the |+syntax|
6903 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006904 A comma separated list of word list names. When the 'spell' option is
6905 on spellchecking will be done for these languages. Example: >
6906 set spelllang=en_us,nl,medical
6907< This means US English, Dutch and medical words are recognized. Words
6908 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02006909 The word list name must consist of alphanumeric characters, a dash or
6910 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00006911 recommended to separate the two letter language name from a
6912 specification. Thus "en-rare" is used for rare English words.
6913 A region name must come last and have the form "_xx", where "xx" is
6914 the two-letter, lower case region name. You can use more than one
6915 region by listing them: "en_us,en_ca" supports both US and Canadian
6916 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01006917 Britain. (Note: currently en_au and en_nz dictionaries are older than
6918 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006919 If the name "cjk" is included East Asian characters are excluded from
6920 spell checking. This is useful when editing text that also has Asian
6921 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006922 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006923 As a special case the name of a .spl file can be given as-is. The
6924 first "_xx" in the name is removed and used as the region name
6925 (_xx is an underscore, two letters and followed by a non-letter).
6926 This is mainly for testing purposes. You must make sure the correct
6927 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006928 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006929 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6930 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006931 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006932
Bram Moolenaar98692072006-02-04 00:57:42 +00006933 If the |spellfile.vim| plugin is active and you use a language name
6934 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6935 will ask you if you want to download the file.
6936
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006937 After this option has been set successfully, Vim will source the files
6938 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01006939 up to the first character that is not an ASCII letter or number and
6940 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006941
6942
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006943 *'spellsuggest'* *'sps'*
6944'spellsuggest' 'sps' string (default "best")
6945 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006946 {not available when compiled without the |+syntax|
6947 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006948 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006949 the |spellsuggest()| function. This is a comma-separated list of
6950 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006951
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006952 best Internal method that works best for English. Finds
6953 changes like "fast" and uses a bit of sound-a-like
6954 scoring to improve the ordering.
6955
6956 double Internal method that uses two methods and mixes the
6957 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006958 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006959 word. That only works when the language specifies
6960 sound folding. Can be slow and doesn't always give
6961 better results.
6962
6963 fast Internal method that only checks for simple changes:
6964 character inserts/deletes/swaps. Works well for
6965 simple typing mistakes.
6966
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006967 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006968 Not used for |spellsuggest()|. The number of
6969 suggestions is never more than the value of 'lines'
6970 minus two.
6971
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006972 file:{filename} Read file {filename}, which must have two columns,
6973 separated by a slash. The first column contains the
6974 bad word, the second column the suggested good word.
6975 Example:
6976 theribal/terrible ~
6977 Use this for common mistakes that do not appear at the
6978 top of the suggestion list with the internal methods.
6979 Lines without a slash are ignored, use this for
6980 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006981 The word in the second column must be correct,
6982 otherwise it will not be used. Add the word to an
6983 ".add" file if it is currently flagged as a spelling
6984 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006985 The file is used for all languages.
6986
6987 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6988 trouble with spaces. |v:val| holds the badly spelled
6989 word. The expression must evaluate to a List of
6990 Lists, each with a suggestion and a score.
6991 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01006992 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006993 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006994 internal methods use. A lower score is better.
6995 This may invoke |spellsuggest()| if you temporarily
6996 set 'spellsuggest' to exclude the "expr:" part.
6997 Errors are silently ignored, unless you set the
6998 'verbose' option to a non-zero value.
6999
7000 Only one of "best", "double" or "fast" may be used. The others may
7001 appear several times in any order. Example: >
7002 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7003<
7004 This option cannot be set from a |modeline| or in the |sandbox|, for
7005 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007006
7007
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7009'splitbelow' 'sb' boolean (default off)
7010 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007011 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007012 feature}
7013 When on, splitting a window will put the new window below the current
7014 one. |:split|
7015
7016 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7017'splitright' 'spr' boolean (default off)
7018 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007019 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 feature}
7021 When on, splitting a window will put the new window right of the
7022 current one. |:vsplit|
7023
7024 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7025'startofline' 'sol' boolean (default on)
7026 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007028 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007029 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007030 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 with a linewise operator, with "%" with a count and to buffer changing
7032 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7033 only has a line number, e.g., ":25" or ":+".
7034 In case of buffer changing commands the cursor is placed at the column
7035 where it was the last time the buffer was edited.
7036 NOTE: This option is set when 'compatible' is set.
7037
Bram Moolenaar00654022011-02-25 14:42:19 +01007038 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007039'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007040 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041 {not available when compiled without the |+statusline|
7042 feature}
7043 When nonempty, this option determines the content of the status line.
7044 Also see |status-line|.
7045
7046 The option consists of printf style '%' items interspersed with
7047 normal text. Each status line item is of the form:
7048 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007049 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007050 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007051
Bram Moolenaar238a5642006-02-21 22:12:05 +00007052 When the option starts with "%!" then it is used as an expression,
7053 evaluated and the result is used as the option value. Example: >
7054 :set statusline=%!MyStatusLine()
7055< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007056 Note that the "%!" expression is evaluated in the context of the
7057 current window and buffer, while %{} items are evaluated in the
7058 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007059
7060 When there is error while evaluating the option then it will be made
7061 empty to avoid further errors. Otherwise screen updating would loop.
7062
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 Note that the only effect of 'ruler' when this option is set (and
7064 'laststatus' is 2) is controlling the output of |CTRL-G|.
7065
7066 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007067 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007069 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 minwid Minimum width of the item, padding as set by '-' & '0'.
7071 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007072 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007073 on the left for text items. Numeric items will be
7074 shifted down to maxwid-2 digits followed by '>'number
7075 where number is the amount of missing digits, much like
7076 an exponential notation.
7077 item A one letter code as described below.
7078
7079 Following is a description of the possible statusline items. The
7080 second character in "item" is the type:
7081 N for number
7082 S for string
7083 F for flags as described below
7084 - not applicable
7085
7086 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007087 f S Path to the file in the buffer, as typed or relative to current
7088 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 F S Full path to the file in the buffer.
7090 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007091 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007093 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007095 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007097 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007098 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007099 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007101 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7103 being used: "<keymap>"
7104 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007105 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106 B N As above, in hexadecimal.
7107 o N Byte number in file of byte under cursor, first byte is 1.
7108 Mnemonic: Offset from start of file (with one added)
7109 {not available when compiled without |+byte_offset| feature}
7110 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007111 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007112 l N Line number.
7113 L N Number of lines in buffer.
7114 c N Column number.
7115 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007116 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117 p N Percentage through file in lines as in |CTRL-G|.
7118 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007119 percentage described for 'ruler'. Always 3 in length, unless
7120 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007121 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007122 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007123 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007124 Note that there is no '%' before the closing '}'. The
7125 expression cannot contain a '}' character, call a function to
7126 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007127 ( - Start of item group. Can be used for setting the width and
7128 alignment of a section. Must be followed by %) somewhere.
7129 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007130 T N For 'tabline': start of tab page N label. Use %T after the last
7131 label. This information is used for mouse clicks.
7132 X N For 'tabline': start of close tab N label. Use %X after the
7133 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7134 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135 < - Where to truncate line if too long. Default is at the start.
7136 No width fields allowed.
7137 = - Separation point between left and right aligned items.
7138 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007139 # - Set highlight group. The name must follow and then a # again.
7140 Thus use %#HLname# for highlight group HLname. The same
7141 highlighting is used, also for the statusline of non-current
7142 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007144 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145 The difference between User{N} and StatusLine will be applied
7146 to StatusLineNC for the statusline of non-current windows.
7147 The number N must be between 1 and 9. See |hl-User1..9|
7148
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007149 When displaying a flag, Vim removes the leading comma, if any, when
7150 that flag comes right after plaintext. This will make a nice display
7151 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152
Bram Moolenaar582fd852005-03-28 20:58:01 +00007153 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154 not set) and a minwid is not set for the group, the whole group will
7155 become empty. This will make a group like the following disappear
7156 completely from the statusline when none of the flags are set. >
7157 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007158< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 Beware that an expression is evaluated each and every time the status
7160 line is displayed. The current buffer and current window will be set
7161 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007162 currently being drawn. The expression will evaluate in this context.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007163 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007164 real current buffer.
7165
Bram Moolenaar30b65812012-07-12 22:01:11 +02007166 The 'statusline' option will be evaluated in the |sandbox| if set from
7167 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007168
7169 It is not allowed to change text or jump to another window while
7170 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007171
7172 If the statusline is not updated when you want it (e.g., after setting
7173 a variable that's used in an expression), you can force an update by
7174 setting an option without changing its value. Example: >
7175 :let &ro = &ro
7176
7177< A result of all digits is regarded a number for display purposes.
7178 Otherwise the result is taken as flag text and applied to the rules
7179 described above.
7180
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007181 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007183 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007184
7185 Examples:
7186 Emulate standard status line with 'ruler' set >
7187 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7188< Similar, but add ASCII value of char under the cursor (like "ga") >
7189 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7190< Display byte count and byte value, modified flag in red. >
7191 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7192 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7193< Display a ,GZ flag if a compressed file is loaded >
7194 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7195< In the |:autocmd|'s: >
7196 :let b:gzflag = 1
7197< And: >
7198 :unlet b:gzflag
7199< And define this function: >
7200 :function VarExists(var, val)
7201 : if exists(a:var) | return a:val | else | return '' | endif
7202 :endfunction
7203<
7204 *'suffixes'* *'su'*
7205'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7206 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007207 Files with these suffixes get a lower priority when multiple files
7208 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007209 suffixes. Spaces after the comma are ignored. A dot is also seen as
7210 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 separator, precede it with a backslash (see |option-backslash| about
7212 including spaces and backslashes).
7213 See 'wildignore' for completely ignoring files.
7214 The use of |:set+=| and |:set-=| is preferred when adding or removing
7215 suffixes from the list. This avoids problems when a future version
7216 uses another default.
7217
7218 *'suffixesadd'* *'sua'*
7219'suffixesadd' 'sua' string (default "")
7220 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007221 {not available when compiled without the
7222 |+file_in_path| feature}
7223 Comma separated list of suffixes, which are used when searching for a
7224 file for the "gf", "[I", etc. commands. Example: >
7225 :set suffixesadd=.java
7226<
7227 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7228'swapfile' 'swf' boolean (default on)
7229 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007230 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 swapfile is not wanted for a specific buffer. For example, with
7232 confidential information that even root must not be able to access.
7233 Careful: All text will be in memory:
7234 - Don't use this for big files.
7235 - Recovery will be impossible!
7236 A swapfile will only be present when |'updatecount'| is non-zero and
7237 'swapfile' is set.
7238 When 'swapfile' is reset, the swap file for the current buffer is
7239 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7240 non-zero, a swap file is immediately created.
7241 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007242 If you want to open a new buffer without creating a swap file for it,
7243 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007244 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007245
7246 This option is used together with 'bufhidden' and 'buftype' to
7247 specify special kinds of buffers. See |special-buffers|.
7248
7249 *'swapsync'* *'sws'*
7250'swapsync' 'sws' string (default "fsync")
7251 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007253 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254 When this option is empty parts of the swap file may be in memory and
7255 not written to disk. When the system crashes you may lose more work.
7256 On Unix the system does a sync now and then without Vim asking for it,
7257 so the disadvantage of setting this option off is small. On some
7258 systems the swap file will not be written at all. For a unix system
7259 setting it to "sync" will use the sync() call instead of the default
7260 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007261 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007262
7263 *'switchbuf'* *'swb'*
7264'switchbuf' 'swb' string (default "")
7265 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 This option controls the behavior when switching between buffers.
7267 Possible values (comma separated list):
7268 useopen If included, jump to the first open window that
7269 contains the specified buffer (if there is one).
7270 Otherwise: Do not examine other windows.
7271 This setting is checked with |quickfix| commands, when
7272 jumping to errors (":cc", ":cn", "cp", etc.). It is
7273 also used in all buffer related split commands, for
7274 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007275 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007276 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007278 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007279 Otherwise: do not split, use current window (when used
7280 in the quickfix window: the previously used window or
7281 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007282 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007283 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007284 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007286 *'synmaxcol'* *'smc'*
7287'synmaxcol' 'smc' number (default 3000)
7288 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007289 {not available when compiled without the |+syntax|
7290 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007291 Maximum column in which to search for syntax items. In long lines the
7292 text after this column is not highlighted and following lines may not
7293 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007294 This helps to avoid very slow redrawing for an XML file that is one
7295 long line.
7296 Set to zero to remove the limit.
7297
Bram Moolenaar071d4272004-06-13 20:20:40 +00007298 *'syntax'* *'syn'*
7299'syntax' 'syn' string (default empty)
7300 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007301 {not available when compiled without the |+syntax|
7302 feature}
7303 When this option is set, the syntax with this name is loaded, unless
7304 syntax highlighting has been switched off with ":syntax off".
7305 Otherwise this option does not always reflect the current syntax (the
7306 b:current_syntax variable does).
7307 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007308 not automatically recognized. Example, in an IDL file:
7309 /* vim: set syntax=idl : */ ~
7310 When a dot appears in the value then this separates two filetype
7311 names. Example:
7312 /* vim: set syntax=c.doxygen : */ ~
7313 This will use the "c" syntax first, then the "doxygen" syntax.
7314 Note that the second one must be prepared to be loaded as an addition,
7315 otherwise it will be skipped. More than one dot may appear.
7316 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317 :set syntax=OFF
7318< To switch syntax highlighting on according to the current value of the
7319 'filetype' option: >
7320 :set syntax=ON
7321< What actually happens when setting the 'syntax' option is that the
7322 Syntax autocommand event is triggered with the value as argument.
7323 This option is not copied to another buffer, independent of the 's' or
7324 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007325 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007327 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007328'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007329 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007330 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007331 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007332 When nonempty, this option determines the content of the tab pages
7333 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007334 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007335
7336 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007337 option and only when there is no GUI tab line. When 'e' is in
7338 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007339 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007340
7341 The value is evaluated like with 'statusline'. You can use
7342 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007343 the text to be displayed. Use "%1T" for the first label, "%2T" for
7344 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007345
Bram Moolenaare12bab32019-01-08 22:02:56 +01007346 When changing something that is used in 'tabline' that does not
7347 trigger it to be updated, use |:redrawtabline|.
7348
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007349 Keep in mind that only one of the tab pages is the current one, others
7350 are invisible and you can't jump to their windows.
7351
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007352
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007353 *'tabpagemax'* *'tpm'*
7354'tabpagemax' 'tpm' number (default 10)
7355 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007356 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007357 feature}
7358 Maximum number of tab pages to be opened by the |-p| command line
7359 argument or the ":tab all" command. |tabpage|
7360
7361
7362 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363'tabstop' 'ts' number (default 8)
7364 local to buffer
7365 Number of spaces that a <Tab> in the file counts for. Also see
7366 |:retab| command, and 'softtabstop' option.
7367
7368 Note: Setting 'tabstop' to any other value than 8 can make your file
7369 appear wrong in many places (e.g., when printing it).
7370
7371 There are four main ways to use tabs in Vim:
7372 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7373 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007374 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 behave like a tab appears every 4 (or 3) characters.
7376 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7377 'expandtab'. This way you will always insert spaces. The
7378 formatting will never be messed up when 'tabstop' is changed.
7379 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007380 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381 works when using Vim to edit the file.
7382 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7383 'noexpandtab'. This should then work (for initial indents only)
7384 for any tabstop setting that people use. It might be nice to have
7385 tabs after the first non-blank inserted as spaces if you do this
7386 though. Otherwise aligned comments will be wrong when 'tabstop' is
7387 changed.
7388
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007389 If Vim is compiled with the |+vartabs| feature then the value of
7390 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7391 than an empty string.
7392
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7394'tagbsearch' 'tbs' boolean (default on)
7395 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007397 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398 searching makes searching for a tag a LOT faster, but a linear search
7399 will find more tags if the tags file wasn't properly sorted.
7400 Vim normally assumes that your tags files are sorted, or indicate that
7401 they are not sorted. Only when this is not the case does the
7402 'tagbsearch' option need to be switched off.
7403
7404 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007405 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406 certain files, or retry all files with a linear search. When
7407 'tagbsearch' is off, only a linear search is done.
7408
7409 Linear searching is done anyway, for one file, when Vim finds a line
7410 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007411 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007412< [The whitespace before and after the '0' must be a single <Tab>]
7413
7414 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007415 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 instead of a normal tag name, a retry is done with a linear search.
7417 Tags in unsorted tags files, and matches with different case will only
7418 be found in the retry.
7419
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007420 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007421 linear search can be avoided when case is ignored. Use a value of '2'
7422 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7423 sorted with the -f switch to "sort" in most unices, as in the command:
7424 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7425 (at least 5.5) the --sort=foldcase switch can be used for this as
7426 well. Note that case must be folded to uppercase for this to work.
7427
7428 By default, tag searches are case-sensitive. Case is ignored when
7429 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7430 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007431 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7432 'tagcase' is "smart", and the pattern contains only lowercase
7433 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434
7435 When 'tagbsearch' is off, tags searching is slower when a full match
7436 exists, but faster when no full match exists. Tags in unsorted tags
7437 files may only be found with 'tagbsearch' off.
7438 When the tags file is not sorted, or sorted in a wrong way (not on
7439 ASCII byte value), 'tagbsearch' should be off, or the line given above
7440 must be included in the tags file.
7441 This option doesn't affect commands that find all matching tags (e.g.,
7442 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007444 *'tagcase'* *'tc'*
7445'tagcase' 'tc' string (default "followic")
7446 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007447 This option specifies how case is handled when searching the tags
7448 file:
7449 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007450 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007451 ignore Ignore case
7452 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007453 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007454 NOTE: This option is set to the Vi default value when 'compatible' is
7455 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007456
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007457 *'tagfunc'* *'tfu'*
7458'tagfunc' 'tfu' string (default: empty)
7459 local to buffer
7460 {not available when compiled without the |+eval|
7461 feature}
7462 This option specifies a function to be used to perform tag searches.
7463 The function gets the tag pattern and should return a List of matching
7464 tags. See |tag-function| for an explanation of how to write the
7465 function and an example.
7466
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467 *'taglength'* *'tl'*
7468'taglength' 'tl' number (default 0)
7469 global
7470 If non-zero, tags are significant up to this number of characters.
7471
7472 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7473'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7474 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007475 If on and using a tags file in another directory, file names in that
7476 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 NOTE: This option is set to the Vi default value when 'compatible' is
7478 set and to the Vim default value when 'compatible' is reset.
7479
7480 *'tags'* *'tag'* *E433*
7481'tags' 'tag' string (default "./tags,tags", when compiled with
7482 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7483 global or local to buffer |global-local|
7484 Filenames for the tag command, separated by spaces or commas. To
7485 include a space or comma in a file name, precede it with a backslash
7486 (see |option-backslash| about including spaces and backslashes).
7487 When a file name starts with "./", the '.' is replaced with the path
7488 of the current file. But only when the 'd' flag is not included in
7489 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7490 |tags-option|.
7491 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007492 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7493 find all files named "tags" below "/lib". The filename itself cannot
7494 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7495 files called "tags?". {not available when compiled without the
7496 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007497 The |tagfiles()| function can be used to get a list of the file names
7498 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007499 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7500 files are also supported. They are automatically recognized. The
7501 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7502 differences are ignored (MS-Windows). |emacs-tags|
7503 The use of |:set+=| and |:set-=| is preferred when adding or removing
7504 file names from the list. This avoids problems when a future version
7505 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007506
7507 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7508'tagstack' 'tgst' boolean (default on)
7509 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007510 When on, the |tagstack| is used normally. When off, a ":tag" or
7511 ":tselect" command with an argument will not push the tag onto the
7512 tagstack. A following ":tag" without an argument, a ":pop" command or
7513 any other command that uses the tagstack will use the unmodified
7514 tagstack, but does change the pointer to the active entry.
7515 Resetting this option is useful when using a ":tag" command in a
7516 mapping which should not change the tagstack.
7517
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007518 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007519'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007520 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007521 {only available when compiled with the |+tcl/dyn|
7522 feature}
7523 Specifies the name of the Tcl shared library. The default is
7524 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007525 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007526 This option cannot be set from a |modeline| or in the |sandbox|, for
7527 security reasons.
7528
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 *'term'* *E529* *E530* *E531*
7530'term' string (default is $TERM, if that fails:
7531 in the GUI: "builtin_gui"
7532 on Amiga: "amiga"
7533 on BeOS: "beos-ansi"
7534 on Mac: "mac-ansi"
7535 on MiNT: "vt52"
7536 on MS-DOS: "pcterm"
7537 on OS/2: "os2ansi"
7538 on Unix: "ansi"
7539 on VMS: "ansi"
7540 on Win 32: "win32")
7541 global
7542 Name of the terminal. Used for choosing the terminal control
7543 characters. Environment variables are expanded |:set_env|.
7544 For example: >
7545 :set term=$TERM
7546< See |termcap|.
7547
7548 *'termbidi'* *'tbidi'*
7549 *'notermbidi'* *'notbidi'*
7550'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7551 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 {only available when compiled with the |+arabic|
7553 feature}
7554 The terminal is in charge of Bi-directionality of text (as specified
7555 by Unicode). The terminal is also expected to do the required shaping
7556 that some languages (such as Arabic) require.
7557 Setting this option implies that 'rightleft' will not be set when
7558 'arabic' is set and the value of 'arabicshape' will be ignored.
7559 Note that setting 'termbidi' has the immediate effect that
7560 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7561 This option is reset when the GUI is started.
7562 For further details see |arabic.txt|.
7563
7564 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007565'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 Macintosh GUI: "macroman")
7567 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 Encoding used for the terminal. This specifies what character
7569 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007570 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007571 display). Except for the Mac when 'macatsui' is off, then
7572 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007574 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7576 Any attempts to set a different value will be rejected, and an error
7577 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007578 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579 because the Win32 system always passes Unicode characters.
7580 When empty, the same encoding is used as for the 'encoding' option.
7581 This is the normal value.
7582 Not all combinations for 'termencoding' and 'encoding' are valid. See
7583 |encoding-table|.
7584 The value for this option must be supported by internal conversions or
7585 iconv(). When this is not possible no conversion will be done and you
7586 will probably experience problems with non-ASCII characters.
7587 Example: You are working with the locale set to euc-jp (Japanese) and
7588 want to edit a UTF-8 file: >
7589 :let &termencoding = &encoding
7590 :set encoding=utf-8
7591< You need to do this when your system has no locale support for UTF-8.
7592
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007593 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007594'termguicolors' 'tgc' boolean (default off)
7595 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007596 {not available when compiled without the
7597 |+termguicolors| feature}
7598 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007599 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007600
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007601 Requires a ISO-8613-3 compatible terminal. If setting this option
7602 does not work (produces a colorless UI) reading |xterm-true-color|
7603 might help.
7604
7605 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7606 is required. Use this check to find out: >
7607 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007608< This requires Vim to be built with the |+vtp| feature.
7609
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007610 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007611 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007612
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007613 *'termwinkey'* *'twk'*
7614'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007615 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007616 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007617 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007618 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007619 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007620< The string must be one key stroke but can be multiple bytes.
7621 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007622 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007623 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007624
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007625 *'termwinscroll'* *'twsl'*
7626'termwinscroll' 'twsl' number (default 10000)
7627 local to buffer
7628 {not available when compiled without the
7629 |+terminal| feature}
7630 Number of scrollback lines to keep. When going over this limit the
7631 first 10% of the scrollback lines are deleted. This is just to reduce
7632 the memory usage. See |Terminal-Normal|.
7633
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007634 *'termwinsize'* *'tws'*
7635'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007636 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007637 Size of the |terminal| window. Format: {rows}x{columns} or
7638 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007639 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007640 - When set with a "x" (e.g., "24x80") the terminal size is not
7641 adjusted to the window size. If the window is smaller only the
7642 top-left part is displayed.
7643 - When set with a "*" (e.g., "10*50") the terminal size follows the
7644 window size, but will not be smaller than the specified rows and/or
7645 columns.
7646 - When rows is zero then use the height of the window.
7647 - When columns is zero then use the width of the window.
7648 - Using "0x0" or "0*0" is the same as empty.
7649
7650 Examples:
7651 "30x0" uses 30 rows and the current window width.
7652 "20*0" uses at least 20 rows and the current window width.
7653 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007654 Note that the command running in the terminal window may still change
7655 the size of the terminal. In that case the Vim window will be
7656 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007657
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007658 *'termwintype'* *'twt'*
7659'termwintype' 'twt' string (default "")
7660 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007661 {only available when compiled with the |terminal|
7662 feature on MS-Windows}
7663 Specify the virtual console (pty) used when opening the terminal
7664 window.
7665
7666 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007667 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007668 "winpty" use winpty, fail if not supported
7669 "conpty" use |ConPTY|, fail if not supported
7670
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007671 |ConPTY| support depends on the platform. Windows 10 October 2018
7672 Update is the first version that supports ConPTY, however it is still
7673 considered unstable. ConPTY might become stable in the next release
7674 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007675 supported then you cannot open a terminal window.
7676
Bram Moolenaar071d4272004-06-13 20:20:40 +00007677 *'terse'* *'noterse'*
7678'terse' boolean (default off)
7679 global
7680 When set: Add 's' flag to 'shortmess' option (this makes the message
7681 for a search that hits the start or end of the file not being
7682 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7683 shortens a lot of messages}
7684
7685 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7686'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7687 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007688 This option is obsolete. Use 'fileformats'.
7689 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7690 set to the default value for the current system. When 'textauto' is
7691 reset, 'fileformats' is made empty.
7692 NOTE: This option is set to the Vi default value when 'compatible' is
7693 set and to the Vim default value when 'compatible' is reset.
7694
7695 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7696'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7697 others: default off)
7698 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007699 This option is obsolete. Use 'fileformat'.
7700 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7701 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7702 "unix".
7703
7704 *'textwidth'* *'tw'*
7705'textwidth' 'tw' number (default 0)
7706 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007707 Maximum width of text that is being inserted. A longer line will be
7708 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007709 this.
7710 'textwidth' is set to 0 when the 'paste' option is set and restored
7711 when 'paste' is reset.
7712 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007714 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715 NOTE: This option is set to 0 when 'compatible' is set.
7716
7717 *'thesaurus'* *'tsr'*
7718'thesaurus' 'tsr' string (default "")
7719 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007720 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007721 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7722
7723 Each line in the file should contain words with similar meaning,
7724 separated by non-keyword characters (white space is preferred).
7725 Maximum line length is 510 bytes.
7726
Bram Moolenaard47d5222018-12-09 20:43:55 +01007727 An English word list was added to this github issue:
7728 https://github.com/vim/vim/issues/629#issuecomment-443293282
7729 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7730 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7731 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007732
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007733 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734 after a comma are ignored, otherwise spaces are included in the file
7735 name. See |option-backslash| about using backslashes.
7736 The use of |:set+=| and |:set-=| is preferred when adding or removing
7737 directories from the list. This avoids problems when a future version
7738 uses another default.
7739 Backticks cannot be used in this option for security reasons.
7740
7741 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7742'tildeop' 'top' boolean (default off)
7743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007744 When on: The tilde command "~" behaves like an operator.
7745 NOTE: This option is reset when 'compatible' is set.
7746
7747 *'timeout'* *'to'* *'notimeout'* *'noto'*
7748'timeout' 'to' boolean (default on)
7749 global
7750 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007751'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753 These two options together determine the behavior when part of a
7754 mapped key sequence or keyboard code has been received:
7755
7756 'timeout' 'ttimeout' action ~
7757 off off do not time out
7758 on on or off time out on :mappings and key codes
7759 off on time out on key codes
7760
7761 If both options are off, Vim will wait until either the complete
7762 mapping or key sequence has been received, or it is clear that there
7763 is no mapping or key sequence for the received characters. For
7764 example: if you have mapped "vl" and Vim has received 'v', the next
7765 character is needed to see if the 'v' is followed by an 'l'.
7766 When one of the options is on, Vim will wait for about 1 second for
7767 the next character to arrive. After that the already received
7768 characters are interpreted as single characters. The waiting time can
7769 be changed with the 'timeoutlen' option.
7770 On slow terminals or very busy systems timing out may cause
7771 malfunctioning cursor keys. If both options are off, Vim waits
7772 forever after an entered <Esc> if there are key codes that start
7773 with <Esc>. You will have to type <Esc> twice. If you do not have
7774 problems with key codes, but would like to have :mapped key
7775 sequences not timing out in 1 second, set the 'ttimeout' option and
7776 reset the 'timeout' option.
7777
7778 NOTE: 'ttimeout' is reset when 'compatible' is set.
7779
7780 *'timeoutlen'* *'tm'*
7781'timeoutlen' 'tm' number (default 1000)
7782 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007783
Bram Moolenaar071d4272004-06-13 20:20:40 +00007784 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007785'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787 The time in milliseconds that is waited for a key code or mapped key
7788 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7789 when part of a command has been typed.
7790 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7791 different timeout value for key codes is desired set 'ttimeoutlen' to
7792 a non-negative number.
7793
7794 ttimeoutlen mapping delay key code delay ~
7795 < 0 'timeoutlen' 'timeoutlen'
7796 >= 0 'timeoutlen' 'ttimeoutlen'
7797
7798 The timeout only happens when the 'timeout' and 'ttimeout' options
7799 tell so. A useful setting would be >
7800 :set timeout timeoutlen=3000 ttimeoutlen=100
7801< (time out on mapping after three seconds, time out on key codes after
7802 a tenth of a second).
7803
7804 *'title'* *'notitle'*
7805'title' boolean (default off, on when title can be restored)
7806 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 {not available when compiled without the |+title|
7808 feature}
7809 When on, the title of the window will be set to the value of
7810 'titlestring' (if it is not empty), or to:
7811 filename [+=-] (path) - VIM
7812 Where:
7813 filename the name of the file being edited
7814 - indicates the file cannot be modified, 'ma' off
7815 + indicates the file was modified
7816 = indicates the file is read-only
7817 =+ indicates the file is read-only and modified
7818 (path) is the path of the file being edited
7819 - VIM the server name |v:servername| or "VIM"
7820 Only works if the terminal supports setting window titles
7821 (currently Amiga console, Win32 console, all GUI versions and
7822 terminals with a non- empty 't_ts' option - these are Unix xterm and
7823 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7824 *X11*
7825 When Vim was compiled with HAVE_X11 defined, the original title will
7826 be restored if possible. The output of ":version" will include "+X11"
7827 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7828 works for the icon name |'icon'|.
7829 But: When Vim was started with the |-X| argument, restoring the title
7830 will not work (except in the GUI).
7831 If the title cannot be restored, it is set to the value of 'titleold'.
7832 You might want to restore the title outside of Vim then.
7833 When using an xterm from a remote machine you can use this command:
7834 rsh machine_name xterm -display $DISPLAY &
7835 then the WINDOWID environment variable should be inherited and the
7836 title of the window should change back to what it should be after
7837 exiting Vim.
7838
7839 *'titlelen'*
7840'titlelen' number (default 85)
7841 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007842 {not available when compiled without the |+title|
7843 feature}
7844 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007845 title. When the title is longer, only the end of the path name is
7846 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847 Using a percentage makes this adapt to the width of the window. But
7848 it won't work perfectly, because the actual number of characters
7849 available also depends on the font used and other things in the title
7850 bar. When 'titlelen' is zero the full path is used. Otherwise,
7851 values from 1 to 30000 percent can be used.
7852 'titlelen' is also used for the 'titlestring' option.
7853
7854 *'titleold'*
7855'titleold' string (default "Thanks for flying Vim")
7856 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007857 {only available when compiled with the |+title|
7858 feature}
7859 This option will be used for the window title when exiting Vim if the
7860 original title cannot be restored. Only happens if 'title' is on or
7861 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007862 This option cannot be set from a |modeline| or in the |sandbox|, for
7863 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 *'titlestring'*
7865'titlestring' string (default "")
7866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007867 {not available when compiled without the |+title|
7868 feature}
7869 When this option is not empty, it will be used for the title of the
7870 window. This happens only when the 'title' option is on.
7871 Only works if the terminal supports setting window titles (currently
7872 Amiga console, Win32 console, all GUI versions and terminals with a
7873 non-empty 't_ts' option).
7874 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007875 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876 When this option contains printf-style '%' items, they will be
7877 expanded according to the rules used for 'statusline'.
7878 Example: >
7879 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7880 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7881< The value of 'titlelen' is used to align items in the middle or right
7882 of the available space.
7883 Some people prefer to have the file name first: >
7884 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7885< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007886 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 separating space only when needed.
7888 NOTE: Use of special characters in 'titlestring' may cause the display
7889 to be garbled (e.g., when it contains a CR or NL character).
7890 {not available when compiled without the |+statusline| feature}
7891
7892 *'toolbar'* *'tb'*
7893'toolbar' 'tb' string (default "icons,tooltips")
7894 global
7895 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7896 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007897 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007898 possible values are:
7899 icons Toolbar buttons are shown with icons.
7900 text Toolbar buttons shown with text.
7901 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007902 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903 tooltips Tooltips are active for toolbar buttons.
7904 Tooltips refer to the popup help text which appears after the mouse
7905 cursor is placed over a toolbar button for a brief moment.
7906
7907 If you want the toolbar to be shown with icons as well as text, do the
7908 following: >
7909 :set tb=icons,text
7910< Motif and Athena cannot display icons and text at the same time. They
7911 will show icons if both are requested.
7912
7913 If none of the strings specified in 'toolbar' are valid or if
7914 'toolbar' is empty, this option is ignored. If you want to disable
7915 the toolbar, you need to set the 'guioptions' option. For example: >
7916 :set guioptions-=T
7917< Also see |gui-toolbar|.
7918
7919 *'toolbariconsize'* *'tbis'*
7920'toolbariconsize' 'tbis' string (default "small")
7921 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01007922 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007923 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007924 tiny Use tiny icons.
7925 small Use small icons (default).
7926 medium Use medium-sized icons.
7927 large Use large icons.
7928 huge Use even larger icons.
7929 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007930 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007931 the current theme. Common dimensions are giant=48x48, huge=32x32,
7932 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007933
7934 If 'toolbariconsize' is empty, the global default size as determined
7935 by user preferences or the current theme is used.
7936
7937 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7938'ttybuiltin' 'tbi' boolean (default on)
7939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007940 When on, the builtin termcaps are searched before the external ones.
7941 When off the builtin termcaps are searched after the external ones.
7942 When this option is changed, you should set the 'term' option next for
7943 the change to take effect, for example: >
7944 :set notbi term=$TERM
7945< See also |termcap|.
7946 Rationale: The default for this option is "on", because the builtin
7947 termcap entries are generally better (many systems contain faulty
7948 xterm entries...).
7949
7950 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7951'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7952 sun-cmd, screen, rxvt, dtterm or
7953 iris-ansi; also on when running Vim in
7954 a DOS console)
7955 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 Indicates a fast terminal connection. More characters will be sent to
7957 the screen for redrawing, instead of using insert/delete line
7958 commands. Improves smoothness of redrawing when there are multiple
7959 windows and the terminal does not support a scrolling region.
7960 Also enables the extra writing of characters at the end of each screen
7961 line for lines that wrap. This helps when using copy/paste with the
7962 mouse in an xterm and other terminals.
7963
7964 *'ttymouse'* *'ttym'*
7965'ttymouse' 'ttym' string (default depends on 'term')
7966 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007967 {only in Unix and VMS, doesn't work in the GUI; not
7968 available when compiled without |+mouse|}
7969 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007970 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971 *xterm-mouse*
7972 xterm xterm-like mouse handling. The mouse generates
7973 "<Esc>[Mscr", where "scr" is three bytes:
7974 "s" = button state
7975 "c" = column plus 33
7976 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02007977 This only works up to 223 columns! See "dec",
7978 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007979 xterm2 Works like "xterm", but with the xterm reporting the
7980 mouse position while the mouse is dragged. This works
7981 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007982 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007983 work. See below for how Vim detects this
7984 automatically.
7985 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007986 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00007987 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007988 for the row and column. No other mouse events are
7989 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990 *dec-mouse*
7991 dec DEC terminal mouse handling. The mouse generates a
7992 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007993 This is also available for an Xterm, if it was
7994 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 *jsbterm-mouse*
7996 jsbterm JSB term mouse handling.
7997 *pterm-mouse*
7998 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007999 *urxvt-mouse*
8000 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008001 The mouse works only if the terminal supports this
8002 encoding style, but it does not have 223 columns limit
8003 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008004 *sgr-mouse*
8005 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008006 mouse reporting. The mouse works even in columns
8007 beyond 223. This option is backward compatible with
8008 "xterm2" because it can also decode "xterm2" style
8009 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008010
8011 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008012 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8013 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008014 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8015 recognized, if enabled at compile time. DEC terminal mouse codes
8016 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008017 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8018 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008020 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8021 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8022 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008023 Additionally, if vim is compiled with the |+termresponse| feature and
8024 |t_RV| is set to the escape sequence to request the xterm version
8025 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008026 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008027 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8028 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8029 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008030 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8031 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032 :set t_RV=
8033<
8034 *'ttyscroll'* *'tsl'*
8035'ttyscroll' 'tsl' number (default 999)
8036 global
8037 Maximum number of lines to scroll the screen. If there are more lines
8038 to scroll the window is redrawn. For terminals where scrolling is
8039 very slow and redrawing is not slow this can be set to a small number,
8040 e.g., 3, to speed up displaying.
8041
8042 *'ttytype'* *'tty'*
8043'ttytype' 'tty' string (default from $TERM)
8044 global
8045 Alias for 'term', see above.
8046
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008047 *'undodir'* *'udir'*
8048'undodir' 'udir' string (default ".")
8049 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008050 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008051 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008052 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008053 "." means using the directory of the file. The undo file name for
8054 "file.txt" is ".file.txt.un~".
8055 For other directories the file name is the full path of the edited
8056 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008057 When writing: The first directory that exists is used. "." always
8058 works, no directories after "." will be used for writing.
8059 When reading all entries are tried to find an undo file. The first
8060 undo file that exists is used. When it cannot be read an error is
8061 given, no further entry is used.
8062 See |undo-persistence|.
8063
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008064 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008065'undofile' 'udf' boolean (default off)
8066 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008067 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008068 When on, Vim automatically saves undo history to an undo file when
8069 writing a buffer to a file, and restores undo history from the same
8070 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008071 The directory where the undo file is stored is specified by 'undodir'.
8072 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008073 The undo file is not read when 'undoreload' causes the buffer from
8074 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008075 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008076 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008077
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 *'undolevels'* *'ul'*
8079'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8080 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008081 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 Maximum number of changes that can be undone. Since undo information
8083 is kept in memory, higher numbers will cause more memory to be used
8084 (nevertheless, a single change can use an unlimited amount of memory).
8085 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8086 itself: >
8087 set ul=0
8088< But you can also get Vi compatibility by including the 'u' flag in
8089 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008090 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008091 Set to -1 for no undo at all. You might want to do this only for the
8092 current buffer: >
8093 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008094< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008095
8096 The local value is set to -123456 when the global value is to be used.
8097
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008098 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008099
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008100 *'undoreload'* *'ur'*
8101'undoreload' 'ur' number (default 10000)
8102 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008103 Save the whole buffer for undo when reloading it. This applies to the
8104 ":e!" command and reloading for when the buffer changed outside of
8105 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008106 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008107 of lines is smaller than the value of this option.
8108 Set this option to zero to disable undo for a reload.
8109
8110 When saving undo for a reload, any undo file is not read.
8111
8112 Note that this causes the whole buffer to be stored in memory. Set
8113 this option to a lower value if you run out of memory.
8114
Bram Moolenaar071d4272004-06-13 20:20:40 +00008115 *'updatecount'* *'uc'*
8116'updatecount' 'uc' number (default: 200)
8117 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008118 After typing this many characters the swap file will be written to
8119 disk. When zero, no swap file will be created at all (see chapter on
8120 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8121 Vim with the "-n" option, see |startup|. When editing in readonly
8122 mode this option will be initialized to 10000.
8123 The swapfile can be disabled per buffer with |'swapfile'|.
8124 When 'updatecount' is set from zero to non-zero, swap files are
8125 created for all buffers that have 'swapfile' set. When 'updatecount'
8126 is set to zero, existing swap files are not deleted.
8127 Also see |'swapsync'|.
8128 This option has no meaning in buffers where |'buftype'| is "nofile"
8129 or "nowrite".
8130
8131 *'updatetime'* *'ut'*
8132'updatetime' 'ut' number (default 4000)
8133 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008134 If this many milliseconds nothing is typed the swap file will be
8135 written to disk (see |crash-recovery|). Also used for the
8136 |CursorHold| autocommand event.
8137
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008138 *'varsofttabstop'* *'vsts'*
8139'varsofttabstop' 'vsts' string (default "")
8140 local to buffer
8141 {only available when compiled with the |+vartabs|
8142 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008143 A list of the number of spaces that a <Tab> counts for while editing,
8144 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8145 width <Tab>s are being inserted, while in fact a mixture of spaces
8146 and <Tab>s is used. Tab widths are separated with commas, with the
8147 final value applying to all subsequent tabs.
8148
8149 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008150 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008151 to use the following: >
8152 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008153< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8154 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008155
8156 Note that the value of |'softtabstop'| will be ignored while
8157 'varsofttabstop' is set.
8158
8159 *'vartabstop'* *'vts'*
8160'vartabstop' 'vts' string (default "")
8161 local to buffer
8162 {only available when compiled with the |+vartabs|
8163 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008164 A list of the number of spaces that a <Tab> in the file counts for,
8165 separated by commas. Each value corresponds to one tab, with the
8166 final value applying to all subsequent tabs. For example: >
8167 :set vartabstop=4,20,10,8
8168< This will make the first tab 4 spaces wide, the second 20 spaces,
8169 the third 10 spaces, and all following tabs 8 spaces.
8170
8171 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8172 is set.
8173
Bram Moolenaar071d4272004-06-13 20:20:40 +00008174 *'verbose'* *'vbs'*
8175'verbose' 'vbs' number (default 0)
8176 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008177 When bigger than zero, Vim will give messages about what it is doing.
8178 Currently, these messages are given:
8179 >= 1 When the viminfo file is read or written.
8180 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008181 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008182 >= 8 Files for which a group of autocommands is executed.
8183 >= 9 Every executed autocommand.
8184 >= 12 Every executed function.
8185 >= 13 When an exception is thrown, caught, finished, or discarded.
8186 >= 14 Anything pending in a ":finally" clause.
8187 >= 15 Every executed Ex command (truncated at 200 characters).
8188
8189 This option can also be set with the "-V" argument. See |-V|.
8190 This option is also set by the |:verbose| command.
8191
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008192 When the 'verbosefile' option is set then the verbose messages are not
8193 displayed.
8194
8195 *'verbosefile'* *'vfile'*
8196'verbosefile' 'vfile' string (default empty)
8197 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008198 When not empty all messages are written in a file with this name.
8199 When the file exists messages are appended.
8200 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008201 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008202 Setting 'verbosefile' to a new value is like making it empty first.
8203 The difference with |:redir| is that verbose messages are not
8204 displayed when 'verbosefile' is set.
8205
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206 *'viewdir'* *'vdir'*
8207'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8208 "$VIM/vimfiles/view",
8209 for Unix: "~/.vim/view",
8210 for Macintosh: "$VIM:vimfiles:view"
8211 for VMS: "sys$login:vimfiles/view"
8212 for RiscOS: "Choices:vimfiles/view")
8213 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008214 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008215 feature}
8216 Name of the directory where to store files for |:mkview|.
8217 This option cannot be set from a |modeline| or in the |sandbox|, for
8218 security reasons.
8219
8220 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008221'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008222 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008223 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008224 feature}
8225 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008226 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227 word save and restore ~
8228 cursor cursor position in file and in window
8229 folds manually created folds, opened/closed folds and local
8230 fold options
8231 options options and mappings local to a window or buffer (not
8232 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008233 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008234 slash backslashes in file names replaced with forward
8235 slashes
8236 unix with Unix end-of-line format (single <NL>), even when
8237 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008238 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008239
8240 "slash" and "unix" are useful on Windows when sharing view files
8241 with Unix. The Unix version of Vim cannot source dos format scripts,
8242 but the Windows version of Vim can source unix format scripts.
8243
8244 *'viminfo'* *'vi'* *E526* *E527* *E528*
8245'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008246 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8247 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8248 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008250 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008251 feature}
8252 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008253 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8254 "NONE".
8255 The string should be a comma separated list of parameters, each
8256 consisting of a single character identifying the particular parameter,
8257 followed by a number or string which specifies the value of that
8258 parameter. If a particular character is left out, then the default
8259 value is used for that parameter. The following is a list of the
8260 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008261 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008262 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008263 ! When included, save and restore global variables that start
8264 with an uppercase letter, and don't contain a lowercase
8265 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008266 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008267 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008268 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008269 " Maximum number of lines saved for each register. Old name of
8270 the '<' item, with the disadvantage that you need to put a
8271 backslash before the ", otherwise it will be recognized as the
8272 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008273 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008274 % When included, save and restore the buffer list. If Vim is
8275 started with a file name argument, the buffer list is not
8276 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008277 buffer list is restored from the viminfo file. Quickfix
8278 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8279 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008280 When followed by a number, the number specifies the maximum
8281 number of buffers that are stored. Without a number all
8282 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008283 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284 ' Maximum number of previously edited files for which the marks
8285 are remembered. This parameter must always be included when
8286 'viminfo' is non-empty.
8287 Including this item also means that the |jumplist| and the
8288 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008289 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008290 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008291 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008292 patterns are also saved. When not included, the value of
8293 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008294 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008296 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008297 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008298 < Maximum number of lines saved for each register. If zero then
8299 registers are not saved. When not included, all lines are
8300 saved. '"' is the old name for this item.
8301 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008302 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008303 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008304 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008305 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 c When included, convert the text in the viminfo file from the
8307 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008308 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008309 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008310 f Whether file marks need to be stored. If zero, file marks ('0
8311 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008312 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008314 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008315 h Disable the effect of 'hlsearch' when loading the viminfo
8316 file. When not included, it depends on whether ":nohlsearch"
8317 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008318 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008320 the 'n'. Must be at the end of the option! If the
8321 'viminfofile' option is set, that file name overrides the one
8322 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008323 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008324 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008325 r Removable media. The argument is a string (up to the next
8326 ','). This parameter can be given several times. Each
8327 specifies the start of a path for which no marks will be
8328 stored. This is to avoid removable media. For MS-DOS you
8329 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8330 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8331 ignored. Maximum length of each 'r' argument is 50
8332 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008333 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008334 s Maximum size of an item in Kbyte. If zero then registers are
8335 not saved. Currently only applies to registers. The default
8336 "s10" will exclude registers with more than 10 Kbyte of text.
8337 Also see the '<' item above: line count limit.
8338
8339 Example: >
8340 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8341<
8342 '50 Marks will be remembered for the last 50 files you
8343 edited.
8344 <1000 Contents of registers (up to 1000 lines each) will be
8345 remembered.
8346 s100 Registers with more than 100 Kbyte text are skipped.
8347 :0 Command-line history will not be saved.
8348 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8349 no / Since '/' is not specified, the default will be used,
8350 that is, save all of the search history, and also the
8351 previous search and substitute patterns.
8352 no % The buffer list will not be saved nor read back.
8353 no h 'hlsearch' highlighting will be restored.
8354
8355 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8356 load the contents of the file, this is not done automatically.
8357
8358 This option cannot be set from a |modeline| or in the |sandbox|, for
8359 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008360 NOTE: This option is set to the Vim default value when 'compatible'
8361 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008363 *'viminfofile'* *'vif'*
8364'viminfofile' 'vif' string (default: "")
8365 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008366 {not available when compiled without the |+viminfo|
8367 feature}
8368 When non-empty, overrides the file name used for viminfo.
8369 When equal to "NONE" no viminfo file will be read or written.
8370 This option can be set with the |-i| command line flag. The |--clean|
8371 command line flag sets it to "NONE".
8372
Bram Moolenaar071d4272004-06-13 20:20:40 +00008373 *'virtualedit'* *'ve'*
8374'virtualedit' 've' string (default "")
8375 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008376 {not available when compiled without the
8377 |+virtualedit| feature}
8378 A comma separated list of these words:
8379 block Allow virtual editing in Visual block mode.
8380 insert Allow virtual editing in Insert mode.
8381 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008382 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008383
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008385 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 of the line. Useful for selecting a rectangle in Visual mode and
8387 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008388 "onemore" is not the same, it will only allow moving the cursor just
8389 after the last character of the line. This makes some commands more
8390 consistent. Previously the cursor was always past the end of the line
8391 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008392 break some plugins or Vim scripts. For example because |l| can move
8393 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008394 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008395 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008396 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008397 It doesn't make sense to combine "all" with "onemore", but you will
8398 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008399 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400
8401 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8402'visualbell' 'vb' boolean (default off)
8403 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008404 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008405 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008406 use: >
8407 :set vb t_vb=
8408< If you want a short flash, you can use this on many terminals: >
8409 :set vb t_vb=[?5h$<100>[?5l
8410< Here $<100> specifies the time, you can use a smaller or bigger value
8411 to get a shorter or longer flash.
8412
8413 Note: Vim will limit the bell to once per half a second. This avoids
8414 having to wait for the flashing to finish when there are lots of
8415 bells, e.g. on key repeat. This also happens without 'visualbell'
8416 set.
8417
Bram Moolenaar071d4272004-06-13 20:20:40 +00008418 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8419 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8420 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008421
8422 Note: When the GUI starts, 't_vb' is reset to its default value. You
8423 might want to set it again in your |gvimrc|.
8424
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425 Does not work on the Amiga, you always get a screen flash.
8426 Also see 'errorbells'.
8427
8428 *'warn'* *'nowarn'*
8429'warn' boolean (default on)
8430 global
8431 Give a warning message when a shell command is used while the buffer
8432 has been changed.
8433
8434 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8435'weirdinvert' 'wiv' boolean (default off)
8436 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008437 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008438 It is provided for backwards compatibility with version 4.x.
8439 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8440 vice versa. Has no effect when the GUI is running.
8441
8442 *'whichwrap'* *'ww'*
8443'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8444 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008445 Allow specified keys that move the cursor left/right to move to the
8446 previous/next line when the cursor is on the first/last character in
8447 the line. Concatenate characters to allow this for these keys:
8448 char key mode ~
8449 b <BS> Normal and Visual
8450 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008451 h "h" Normal and Visual (not recommended)
8452 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453 < <Left> Normal and Visual
8454 > <Right> Normal and Visual
8455 ~ "~" Normal
8456 [ <Left> Insert and Replace
8457 ] <Right> Insert and Replace
8458 For example: >
8459 :set ww=<,>,[,]
8460< allows wrap only when cursor keys are used.
8461 When the movement keys are used in combination with a delete or change
8462 operator, the <EOL> also counts for a character. This makes "3h"
8463 different from "3dh" when the cursor crosses the end of a line. This
8464 is also true for "x" and "X", because they do the same as "dl" and
8465 "dh". If you use this, you may also want to use the mapping
8466 ":map <BS> X" to make backspace delete the character in front of the
8467 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008468 When 'l' is included and it is used after an operator at the end of a
8469 line then it will not move to the next line. This makes "dl", "cl",
8470 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 NOTE: This option is set to the Vi default value when 'compatible' is
8472 set and to the Vim default value when 'compatible' is reset.
8473
8474 *'wildchar'* *'wc'*
8475'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8476 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008477 Character you have to type to start wildcard expansion in the
8478 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008479 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008480 The character is not recognized when used inside a macro. See
8481 'wildcharm' for that.
8482 Although 'wc' is a number option, you can set it to a special key: >
8483 :set wc=<Esc>
8484< NOTE: This option is set to the Vi default value when 'compatible' is
8485 set and to the Vim default value when 'compatible' is reset.
8486
8487 *'wildcharm'* *'wcm'*
8488'wildcharm' 'wcm' number (default: none (0))
8489 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008490 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008491 recognized when used inside a macro. You can find "spare" command-line
8492 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008493 you'll never actually type 'wildcharm', just use it in mappings that
8494 automatically invoke completion mode, e.g.: >
8495 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008496 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497< Then after typing :ss you can use CTRL-P & CTRL-N.
8498
8499 *'wildignore'* *'wig'*
8500'wildignore' 'wig' string (default "")
8501 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 {not available when compiled without the |+wildignore|
8503 feature}
8504 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008505 patterns is ignored when expanding |wildcards|, completing file or
8506 directory names, and influences the result of |expand()|, |glob()| and
8507 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8509 Also see 'suffixes'.
8510 Example: >
8511 :set wildignore=*.o,*.obj
8512< The use of |:set+=| and |:set-=| is preferred when adding or removing
8513 a pattern from the list. This avoids problems when a future version
8514 uses another default.
8515
Bram Moolenaar94950a92010-12-02 16:01:29 +01008516
Bram Moolenaar81af9252010-12-10 20:35:50 +01008517 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008518'wildignorecase' 'wic' boolean (default off)
8519 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008520 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008521 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008522 Does not apply when the shell is used to expand wildcards, which
8523 happens when there are special characters.
8524
8525
Bram Moolenaar071d4272004-06-13 20:20:40 +00008526 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008527'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008528 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529 {not available if compiled without the |+wildmenu|
8530 feature}
8531 When 'wildmenu' is on, command-line completion operates in an enhanced
8532 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8533 the possible matches are shown just above the command line, with the
8534 first match highlighted (overwriting the status line, if there is
8535 one). Keys that show the previous/next match, such as <Tab> or
8536 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8537 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8538 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008539 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008540 If there are more matches than can fit in the line, a ">" is shown on
8541 the right and/or a "<" is shown on the left. The status line scrolls
8542 as needed.
8543 The "wildmenu" mode is abandoned when a key is hit that is not used
8544 for selecting a completion.
8545 While the "wildmenu" is active the following keys have special
8546 meanings:
8547
8548 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8549 <Down> - in filename/menu name completion: move into a
8550 subdirectory or submenu.
8551 <CR> - in menu completion, when the cursor is just after a
8552 dot: move into a submenu.
8553 <Up> - in filename/menu name completion: move up into
8554 parent directory or parent menu.
8555
8556 This makes the menus accessible from the console |console-menus|.
8557
8558 If you prefer the <Left> and <Right> keys to move the cursor instead
8559 of selecting a different match, use this: >
8560 :cnoremap <Left> <Space><BS><Left>
8561 :cnoremap <Right> <Space><BS><Right>
8562<
8563 The "WildMenu" highlighting is used for displaying the current match
8564 |hl-WildMenu|.
8565
8566 *'wildmode'* *'wim'*
8567'wildmode' 'wim' string (Vim default: "full")
8568 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008569 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008570 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008571 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008572 first part specifies the behavior for the first use of 'wildchar',
8573 The second part for the second use, etc.
8574 These are the possible values for each part:
8575 "" Complete only the first match.
8576 "full" Complete the next full match. After the last match,
8577 the original string is used and then the first match
8578 again.
8579 "longest" Complete till longest common string. If this doesn't
8580 result in a longer string, use the next part.
8581 "longest:full" Like "longest", but also start 'wildmenu' if it is
8582 enabled.
8583 "list" When more than one match, list all matches.
8584 "list:full" When more than one match, list all matches and
8585 complete first match.
8586 "list:longest" When more than one match, list all matches and
8587 complete till longest common string.
8588 When there is only a single match, it is fully completed in all cases.
8589
8590 Examples: >
8591 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008592< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008593 :set wildmode=longest,full
8594< Complete longest common string, then each full match >
8595 :set wildmode=list:full
8596< List all matches and complete each full match >
8597 :set wildmode=list,full
8598< List all matches without completing, then each full match >
8599 :set wildmode=longest,list
8600< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008601 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008602
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008603 *'wildoptions'* *'wop'*
8604'wildoptions' 'wop' string (default "")
8605 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008606 {not available when compiled without the |+wildignore|
8607 feature}
8608 A list of words that change how command line completion is done.
8609 Currently only one word is allowed:
8610 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008611 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008612 is displayed per line. Often used tag kinds are:
8613 d #define
8614 f function
8615 Also see |cmdline-completion|.
8616
Bram Moolenaar071d4272004-06-13 20:20:40 +00008617 *'winaltkeys'* *'wak'*
8618'winaltkeys' 'wak' string (default "menu")
8619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008620 {only used in Win32, Motif, GTK and Photon GUI}
8621 Some GUI versions allow the access to menu entries by using the ALT
8622 key in combination with a character that appears underlined in the
8623 menu. This conflicts with the use of the ALT key for mappings and
8624 entering special characters. This option tells what to do:
8625 no Don't use ALT keys for menus. ALT key combinations can be
8626 mapped, but there is no automatic handling. This can then be
8627 done with the |:simalt| command.
8628 yes ALT key handling is done by the windowing system. ALT key
8629 combinations cannot be mapped.
8630 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008631 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008632 keys can be mapped.
8633 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8634 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008635 This option is not used for <F10>; on Win32 and with GTK <F10> will
8636 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008637
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008638 *'window'* *'wi'*
8639'window' 'wi' number (default screen height - 1)
8640 global
8641 Window height. Do not confuse this with the height of the Vim window,
8642 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008643 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8644 value is smaller than 'lines' minus one. The screen will scroll
8645 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008646 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8647 in a much smarter way, taking care of wrapping lines.
8648 When resizing the Vim window, the value is smaller than 1 or more than
8649 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008650
Bram Moolenaar071d4272004-06-13 20:20:40 +00008651 *'winheight'* *'wh'* *E591*
8652'winheight' 'wh' number (default 1)
8653 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008654 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008655 feature}
8656 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008657 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008658 focus goes to a window that is smaller, its size is increased, at the
8659 cost of the height of other windows.
8660 Set 'winheight' to a small number for normal editing.
8661 Set it to 999 to make the current window fill most of the screen.
8662 Other windows will be only 'winminheight' high. This has the drawback
8663 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8664 to create only two windows, set the option after startup is done,
8665 using the |VimEnter| event: >
8666 au VimEnter * set winheight=999
8667< Minimum value is 1.
8668 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 height of the current window.
8670 'winheight' applies to the current window. Use 'winminheight' to set
8671 the minimal height for other windows.
8672
8673 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8674'winfixheight' 'wfh' boolean (default off)
8675 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02008676 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008677 feature}
8678 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008679 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8680 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681 The height may be changed anyway when running out of room.
8682
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008683 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8684'winfixwidth' 'wfw' boolean (default off)
8685 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02008686 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008687 feature}
8688 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008689 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008690 The width may be changed anyway when running out of room.
8691
Bram Moolenaar071d4272004-06-13 20:20:40 +00008692 *'winminheight'* *'wmh'*
8693'winminheight' 'wmh' number (default 1)
8694 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008695 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 feature}
8697 The minimal height of a window, when it's not the current window.
8698 This is a hard minimum, windows will never become smaller.
8699 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8700 status bar) if necessary. They will return to at least one line when
8701 they become active (since the cursor has to have somewhere to go.)
8702 Use 'winheight' to set the minimal height of the current window.
8703 This option is only checked when making a window smaller. Don't use a
8704 large number, it will cause errors when opening more than a few
8705 windows. A value of 0 to 3 is reasonable.
8706
8707 *'winminwidth'* *'wmw'*
8708'winminwidth' 'wmw' number (default 1)
8709 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008710 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008711 feature}
8712 The minimal width of a window, when it's not the current window.
8713 This is a hard minimum, windows will never become smaller.
8714 When set to zero, windows may be "squashed" to zero columns (i.e. just
8715 a vertical separator) if necessary. They will return to at least one
8716 line when they become active (since the cursor has to have somewhere
8717 to go.)
8718 Use 'winwidth' to set the minimal width of the current window.
8719 This option is only checked when making a window smaller. Don't use a
8720 large number, it will cause errors when opening more than a few
8721 windows. A value of 0 to 12 is reasonable.
8722
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008723 *'winptydll'*
8724'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8725 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008726 {only available when compiled with the |terminal|
8727 feature on MS-Windows}
8728 Specifies the name of the winpty shared library, used for the
8729 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008730 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008731 a fallback.
8732 Environment variables are expanded |:set_env|.
8733 This option cannot be set from a |modeline| or in the |sandbox|, for
8734 security reasons.
8735
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 *'winwidth'* *'wiw'* *E592*
8737'winwidth' 'wiw' number (default 20)
8738 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008739 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008740 feature}
8741 Minimal number of columns for the current window. This is not a hard
8742 minimum, Vim will use fewer columns if there is not enough room. If
8743 the current window is smaller, its size is increased, at the cost of
8744 the width of other windows. Set it to 999 to make the current window
8745 always fill the screen. Set it to a small number for normal editing.
8746 The width is not adjusted after one of the commands to change the
8747 width of the current window.
8748 'winwidth' applies to the current window. Use 'winminwidth' to set
8749 the minimal width for other windows.
8750
8751 *'wrap'* *'nowrap'*
8752'wrap' boolean (default on)
8753 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 This option changes how text is displayed. It doesn't change the text
8755 in the buffer, see 'textwidth' for that.
8756 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008757 displaying continues on the next line. When off lines will not wrap
8758 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008759 moved to a part that is not shown, the screen will scroll
8760 horizontally.
8761 The line will be broken in the middle of a word if necessary. See
8762 'linebreak' to get the break at a word boundary.
8763 To make scrolling horizontally a bit more useful, try this: >
8764 :set sidescroll=5
8765 :set listchars+=precedes:<,extends:>
8766< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008767 This option can't be set from a |modeline| when the 'diff' option is
8768 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008769
8770 *'wrapmargin'* *'wm'*
8771'wrapmargin' 'wm' number (default 0)
8772 local to buffer
8773 Number of characters from the right window border where wrapping
8774 starts. When typing text beyond this limit, an <EOL> will be inserted
8775 and inserting continues on the next line.
8776 Options that add a margin, such as 'number' and 'foldcolumn', cause
8777 the text width to be further reduced. This is Vi compatible.
8778 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008779 This option is set to 0 when 'paste' is set and restored when 'paste'
8780 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008781 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782
8783 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8784'wrapscan' 'ws' boolean (default on) *E384* *E385*
8785 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008786 Searches wrap around the end of the file. Also applies to |]s| and
8787 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008788
8789 *'write'* *'nowrite'*
8790'write' boolean (default on)
8791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008792 Allows writing files. When not set, writing a file is not allowed.
8793 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008794 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008795 argument. Filtering text is still possible, even though this requires
8796 writing a temporary file.
8797
8798 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8799'writeany' 'wa' boolean (default off)
8800 global
8801 Allows writing to any file with no need for "!" override.
8802
8803 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8804'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8805 otherwise)
8806 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008807 Make a backup before overwriting a file. The backup is removed after
8808 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008809 also on.
8810 WARNING: Switching this option off means that when Vim fails to write
8811 your buffer correctly and then, for whatever reason, Vim exits, you
8812 lose both the original file and what you were writing. Only reset
8813 this option if your file system is almost full and it makes the write
8814 fail (and make sure not to exit Vim until the write was successful).
8815 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008816 When the 'backupskip' pattern matches, a backup is not made anyway.
8817 NOTE: This option is set to the default value when 'compatible' is
8818 set.
8819
8820 *'writedelay'* *'wd'*
8821'writedelay' 'wd' number (default 0)
8822 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008823 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008824 screen. When non-zero, characters are sent to the terminal one by
8825 one. For MS-DOS pcterm this does not work. For debugging purposes.
8826
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008827 vim:tw=78:ts=8:noet:ft=help:norl: