blob: 2c2afa17c2031df35cb031d3139317874e5f70a6 [file] [log] [blame]
Bram Moolenaar110289e2019-05-23 15:38:06 +02001*options.txt* For Vim version 8.1. Last change: 2019 May 23
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 "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200581 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582No 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
Bram Moolenaar110289e2019-05-23 15:38:06 +0200584can be set. For some options a flag is set, so that when the value is used
585the |sandbox| is effective. Some options can only be set from the modeline
586when 'modelineexpr' is set (the default is off).
587
588Still, there is always a small risk that a modeline causes trouble. E.g.,
589when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
590So disable modelines before editing untrusted text. The mail ftplugin does
591this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592
593Hint: If you would like to do something else than setting an option, you could
594define an autocommand that checks the file for a specific string. For
595example: >
596 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
597And define a function SetVar() that does something with the line containing
598"VAR".
599
600==============================================================================
6013. Options summary *option-summary*
602
603In the list below all the options are mentioned with their full name and with
604an abbreviation if there is one. Both forms may be used.
605
606In this document when a boolean option is "set" that means that ":set option"
607is entered. When an option is "reset", ":set nooption" is used.
608
609For some options there are two default values: The "Vim default", which is
610used when 'compatible' is not set, and the "Vi default", which is used when
611'compatible' is set.
612
613Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000614are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615different value in each window. For example the 'list' option can be set in
616one window and reset in another for the same text, giving both types of view
617at the same time. There are a few options that are specific to a certain
618file. These can have a different value for each file or buffer. For example
619the 'textwidth' option can be 78 for a normal text file and 0 for a C
620program.
621
622 global one option for all buffers and windows
623 local to window each window has its own copy of this option
624 local to buffer each buffer has its own copy of this option
625
626When creating a new window the option values from the currently active window
627are used as a default value for the window-specific options. For the
628buffer-specific options this depends on the 's' and 'S' flags in the
629'cpoptions' option. If 's' is included (which is the default) the values for
630buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000631first entered. If 'S' is present the options are copied each time the buffer
632is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633present, the options are copied from the currently active buffer when the
634buffer is created.
635
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000636Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000637
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000638Not all options are supported in all versions. This depends on the supported
639features and sometimes on the system. A remark about this is in curly braces
640below. When an option is not supported it may still be set without getting an
641error, this is called a hidden option. You can't get the value of a hidden
642option though, it is not stored.
643
644To test if option "foo" can be used with ":set" use something like this: >
645 if exists('&foo')
646This also returns true for a hidden option. To test if option "foo" is really
647supported use something like this: >
648 if exists('+foo')
649<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 *E355*
651A jump table for the options with a short description can be found at |Q_op|.
652
653 *'aleph'* *'al'* *aleph* *Aleph*
654'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 {only available when compiled with the |+rightleft|
657 feature}
658 The ASCII code for the first letter of the Hebrew alphabet. The
659 routine that maps the keyboard in Hebrew mode, both in Insert mode
660 (when hkmap is set) and on the command-line (when hitting CTRL-_)
661 outputs the Hebrew characters in the range [aleph..aleph+26].
662 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
663 See |rileft.txt|.
664
665 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
666'allowrevins' 'ari' boolean (default off)
667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668 {only available when compiled with the |+rightleft|
669 feature}
670 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
671 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
672 into reverse Insert mode, and don't know how to get out. See
673 'revins'.
674 NOTE: This option is reset when 'compatible' is set.
675
676 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
677'altkeymap' 'akm' boolean (default off)
678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679 {only available when compiled with the |+farsi|
680 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100681 This option was for using Farsi, which has been removed. See
682 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683
684 *'ambiwidth'* *'ambw'*
685'ambiwidth' 'ambw' string (default: "single")
686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
688 Tells Vim what to do with characters with East Asian Width Class
689 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
690 letters, Cyrillic letters).
691
692 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 expected by most users.
695 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200696 *E834* *E835*
697 The value "double" cannot be used if 'listchars' or 'fillchars'
698 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700 There are a number of CJK fonts for which the width of glyphs for
701 those characters are solely based on how many octets they take in
702 legacy/traditional CJK encodings. In those encodings, Euro,
703 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000704 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000706 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 Vim is running inside a terminal (emulators) that uses a CJK font
708 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
709 this option should be set to "double" to match the width perceived
710 by Vim with the width of glyphs in the font. Perhaps it also has
711 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
712 when the system locale is set to one of CJK locales. See Unicode
713 Standard Annex #11 (http://www.unicode.org/reports/tr11).
714
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100715 Vim may set this option automatically at startup time when Vim is
716 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200717 escape sequence to request cursor position report. The response can
718 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100719
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
721'antialias' 'anti' boolean (default: off)
722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 {only available when compiled with GUI enabled
724 on Mac OS X}
725 This option only has an effect in the GUI version of Vim on Mac OS X
726 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
727 which can be easier to read at certain sizes on certain displays.
728 Setting this option can sometimes cause problems if 'guifont' is set
729 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100730 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731
732 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
733'autochdir' 'acd' boolean (default off)
734 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200735 {only available when compiled with it, use
736 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000737 When on, Vim will change the current working directory whenever you
738 open a file, switch buffers, delete a buffer or open/close a window.
739 It will change to the directory containing the file which was opened
740 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000741 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742
743 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
744'arabic' 'arab' boolean (default off)
745 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 {only available when compiled with the |+arabic|
747 feature}
748 This option can be set to start editing Arabic text.
749 Setting this option will:
750 - Set the 'rightleft' option, unless 'termbidi' is set.
751 - Set the 'arabicshape' option, unless 'termbidi' is set.
752 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
753 between typing English and Arabic key mapping.
754 - Set the 'delcombine' option
755 Note that 'encoding' must be "utf-8" for working with Arabic text.
756
757 Resetting this option will:
758 - Reset the 'rightleft' option.
759 - Disable the use of 'keymap' (without changing its value).
760 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200761 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100762 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 Also see |arabic.txt|.
764
765 *'arabicshape'* *'arshape'*
766 *'noarabicshape'* *'noarshape'*
767'arabicshape' 'arshape' boolean (default on)
768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 {only available when compiled with the |+arabic|
770 feature}
771 When on and 'termbidi' is off, the required visual character
772 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200773 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 one which encompasses:
775 a) the changing/morphing of characters based on their location
776 within a word (initial, medial, final and stand-alone).
777 b) the enabling of the ability to compose characters
778 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100779 When disabled the display shows each character's true stand-alone
780 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 Arabic is a complex language which requires other settings, for
782 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100783 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784
785 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
786'autoindent' 'ai' boolean (default off)
787 local to buffer
788 Copy indent from current line when starting a new line (typing <CR>
789 in Insert mode or when using the "o" or "O" command). If you do not
790 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000791 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
792 to another line has the same effect, unless the 'I' flag is included
793 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000794 When autoindent is on, formatting (with the "gq" command or when you
795 reach 'textwidth' in Insert mode) uses the indentation of the first
796 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 When 'smartindent' or 'cindent' is on the indent is changed in
798 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200799 The 'autoindent' option is reset when the 'paste' option is set and
800 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801
802 *'autoread'* *'ar'* *'noautoread'* *'noar'*
803'autoread' 'ar' boolean (default off)
804 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805 When a file has been detected to have been changed outside of Vim and
806 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200807 When the file has been deleted this is not done, so you have the text
808 from before it was deleted. When it appears again then it is read.
809 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 If this option has a local value, use this command to switch back to
811 using the global value: >
812 :set autoread<
813<
814 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
815'autowrite' 'aw' boolean (default off)
816 global
817 Write the contents of the file, if it has been modified, on each
818 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000819 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
821 Note that for some commands the 'autowrite' option is not used, see
822 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200823 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200824 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
826 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
827'autowriteall' 'awa' boolean (default off)
828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
830 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
831 Setting this option also implies that Vim behaves like 'autowrite' has
832 been set.
833
834 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200835'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 When set to "dark", Vim will try to use colors that look good on a
838 dark background. When set to "light", Vim will try to use colors that
839 look good on a light background. Any other value is illegal.
840 Vim tries to set the default value according to the terminal used.
841 This will not always be correct.
842 Setting this option does not change the background color, it tells Vim
843 what the background color looks like. For changing the background
844 color, see |:hi-normal|.
845
846 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000847 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000848 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100849 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 setting 'background' will cause the color scheme to be reloaded. If
851 the color scheme adjusts to the value of 'background' this will work.
852 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100853 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854
855 When setting 'background' to the default value with: >
856 :set background&
857< Vim will guess the value. In the GUI this should work correctly,
858 in other cases Vim might not be able to guess the right value.
859
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200860 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200861 color from the terminal. If the returned RGB value is dark/light and
862 'background' is not dark/light, 'background' will be set and the
863 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200864 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100865 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200866
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 When starting the GUI, the default value for 'background' will be
868 "light". When the value is not set in the .gvimrc, and Vim detects
869 that the background is actually quite dark, 'background' is set to
870 "dark". But this happens only AFTER the .gvimrc file has been read
871 (because the window needs to be opened to find the actual background
872 color). To get around this, force the GUI window to be opened by
873 putting a ":gui" command in the .gvimrc file, before where the value
874 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200875
876 For MS-DOS, Windows and OS/2 the default is "dark".
877 For other systems "dark" is used when 'term' is "linux",
878 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
879 background. Otherwise the default is "light".
880
Bram Moolenaarc572da52017-08-27 16:52:01 +0200881 The |:terminal| command and the |term_start()| function use the
882 'background' value to decide whether the terminal window will start
883 with a white or black background.
884
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 Normally this option would be set in the .vimrc file. Possibly
886 depending on the terminal name. Example: >
887 :if &term == "pcterm"
888 : set background=dark
889 :endif
890< When this option is set, the default settings for the highlight groups
891 will change. To use other settings, place ":highlight" commands AFTER
892 the setting of the 'background' option.
893 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
894 to select the colors for syntax highlighting. After changing this
895 option, you must load syntax.vim again to see the result. This can be
896 done with ":syntax on".
897
898 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200899'backspace' 'bs' string (default "", set to "indent,eol,start"
900 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
903 mode. This is a list of items, separated by commas. Each item allows
904 a way to backspace over something:
905 value effect ~
906 indent allow backspacing over autoindent
907 eol allow backspacing over line breaks (join lines)
908 start allow backspacing over the start of insert; CTRL-W and CTRL-U
909 stop once at the start of insert.
910
911 When the value is empty, Vi compatible backspacing is used.
912
913 For backwards compatibility with version 5.4 and earlier:
914 value effect ~
915 0 same as ":set backspace=" (Vi compatible)
916 1 same as ":set backspace=indent,eol"
917 2 same as ":set backspace=indent,eol,start"
918
919 See |:fixdel| if your <BS> or <Del> key does not do what you want.
920 NOTE: This option is set to "" when 'compatible' is set.
921
922 *'backup'* *'bk'* *'nobackup'* *'nobk'*
923'backup' 'bk' boolean (default off)
924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 Make a backup before overwriting a file. Leave it around after the
926 file has been successfully written. If you do not want to keep the
927 backup file, but you do want a backup while the file is being
928 written, reset this option and set the 'writebackup' option (this is
929 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000930 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931 |backup-table| for more explanations.
932 When the 'backupskip' pattern matches, a backup is not made anyway.
933 When 'patchmode' is set, the backup may be renamed to become the
934 oldest version of a file.
935 NOTE: This option is reset when 'compatible' is set.
936
937 *'backupcopy'* *'bkc'*
938'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200939 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 When writing a file and a backup is made, this option tells how it's
941 done. This is a comma separated list of words.
942
943 The main values are:
944 "yes" make a copy of the file and overwrite the original one
945 "no" rename the file and write a new one
946 "auto" one of the previous, what works best
947
948 Extra values that can be combined with the ones above are:
949 "breaksymlink" always break symlinks when writing
950 "breakhardlink" always break hardlinks when writing
951
952 Making a copy and overwriting the original file:
953 - Takes extra time to copy the file.
954 + When the file has special attributes, is a (hard/symbolic) link or
955 has a resource fork, all this is preserved.
956 - When the file is a link the backup will have the name of the link,
957 not of the real file.
958
959 Renaming the file and writing a new one:
960 + It's fast.
961 - Sometimes not all attributes of the file can be copied to the new
962 file.
963 - When the file is a link the new file will not be a link.
964
965 The "auto" value is the middle way: When Vim sees that renaming file
966 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000967 the file is not a link) that is used. When problems are expected, a
968 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969
970 The "breaksymlink" and "breakhardlink" values can be used in
971 combination with any of "yes", "no" and "auto". When included, they
972 force Vim to always break either symbolic or hard links by doing
973 exactly what the "no" option does, renaming the original file to
974 become the backup and writing a new file in its place. This can be
975 useful for example in source trees where all the files are symbolic or
976 hard links and any changes should stay in the local source tree, not
977 be propagated back to the original source.
978 *crontab*
979 One situation where "no" and "auto" will cause problems: A program
980 that opens a file, invokes Vim to edit that file, and then tests if
981 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000982 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983 example.
984
985 When a copy is made, the original file is truncated and then filled
986 with the new text. This means that protection bits, owner and
987 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000988 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 group of the backup is set to the group of the original file. If this
990 fails, the protection bits for the group are made the same as for
991 others.
992
993 When the file is renamed this is the other way around: The backup has
994 the same attributes of the original file, and the newly written file
995 is owned by the current user. When the file was a (hard/symbolic)
996 link, the new file will not! That's why the "auto" value doesn't
997 rename when the file is a link. The owner and group of the newly
998 written file will be set to the same ones as the original file, but
999 the system may refuse to do this. In that case the "auto" value will
1000 again not rename the file.
1001
Bram Moolenaar036986f2017-03-16 17:41:02 +01001002 NOTE: This option is set to the Vi default value when 'compatible' is
1003 set and to the Vim default value when 'compatible' is reset.
1004
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 *'backupdir'* *'bdir'*
1006'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001007 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 for Unix: ".,~/tmp,~/")
1009 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 List of directories for the backup file, separated with commas.
1011 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001012 where this is possible. The directory must exist, Vim will not
1013 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001014 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015 impossible!). Writing may fail because of this.
1016 - A directory "." means to put the backup file in the same directory
1017 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001018 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019 put the backup file relative to where the edited file is. The
1020 leading "." is replaced with the path name of the edited file.
1021 ("." inside a directory name has no special meaning).
1022 - Spaces after the comma are ignored, other spaces are considered part
1023 of the directory name. To have a space at the start of a directory
1024 name, precede it with a backslash.
1025 - To include a comma in a directory name precede it with a backslash.
1026 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001027 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001028 the backup file name will be built from the complete path to the
1029 file with all path separators changed to percent '%' signs. This
1030 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001031 On Win32, it is also possible to end with "\\". However, When a
1032 separating comma is following, you must use "//", since "\\" will
1033 include the comma in the file name. Therefore it is recommended to
1034 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035 - Environment variables are expanded |:set_env|.
1036 - Careful with '\' characters, type one before a space, type two to
1037 get one in the option (see |option-backslash|), for example: >
1038 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1039< - For backwards compatibility with Vim version 3.0 a '>' at the start
1040 of the option is removed.
1041 See also 'backup' and 'writebackup' options.
1042 If you want to hide your backup files on Unix, consider this value: >
1043 :set backupdir=./.backup,~/.backup,.,/tmp
1044< You must create a ".backup" directory in each directory and in your
1045 home directory for this to work properly.
1046 The use of |:set+=| and |:set-=| is preferred when adding or removing
1047 directories from the list. This avoids problems when a future version
1048 uses another default.
1049 This option cannot be set from a |modeline| or in the |sandbox|, for
1050 security reasons.
1051
1052 *'backupext'* *'bex'* *E589*
1053'backupext' 'bex' string (default "~", for VMS: "_")
1054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001055 String which is appended to a file name to make the name of the
1056 backup file. The default is quite unusual, because this avoids
1057 accidentally overwriting existing files with a backup file. You might
1058 prefer using ".bak", but make sure that you don't have files with
1059 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001060 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001062 If you like to keep a lot of backups, you could use a BufWritePre
1063 autocommand to change 'backupext' just before writing the file to
1064 include a timestamp. >
1065 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1066< Use 'backupdir' to put the backup in a different directory.
1067
Bram Moolenaar071d4272004-06-13 20:20:40 +00001068 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001069'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1070 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1071 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 {not available when compiled without the |+wildignore|
1074 feature}
1075 A list of file patterns. When one of the patterns matches with the
1076 name of the file which is written, no backup file is created. Both
1077 the specified file name and the full path name of the file are used.
1078 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1079 Watch out for special characters, see |option-backslash|.
1080 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001081 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001082
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001083 WARNING: Not having a backup file means that when Vim fails to write
1084 your buffer correctly and then, for whatever reason, Vim exits, you
1085 lose both the original file and what you were writing. Only disable
1086 backups if you don't care about losing the file.
1087
Bram Moolenaar02467872007-05-06 13:22:01 +00001088 Note that environment variables are not expanded. If you want to use
1089 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001090 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001091
1092< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001093 backup would be made by renaming the original file crontab won't see
1094 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
1096 *'balloondelay'* *'bdlay'*
1097'balloondelay' 'bdlay' number (default: 600)
1098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 {only available when compiled with the |+balloon_eval|
1100 feature}
1101 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1102
1103 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1104'ballooneval' 'beval' boolean (default off)
1105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001107 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001108 Switch on the |balloon-eval| functionality for the GUI.
1109
1110 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1111 *'nobevalterm'*
1112'balloonevalterm' 'bevalterm' boolean (default off)
1113 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001114 {only available when compiled with the
1115 |+balloon_eval_term| feature}
1116 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001118 *'balloonexpr'* *'bexpr'*
1119'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001120 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001121 {only available when compiled with the |+balloon_eval|
1122 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001123 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001124 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1125 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001126
1127 v:beval_bufnr number of the buffer in which balloon is going to show
1128 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001129 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001130 v:beval_lnum line number
1131 v:beval_col column number (byte index)
1132 v:beval_text word under or after the mouse pointer
1133
1134 The evaluation of the expression must not have side effects!
1135 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001136 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001137 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001138 \', column ' . v:beval_col .
1139 \ ' of file ' . bufname(v:beval_bufnr) .
1140 \ ' on word "' . v:beval_text . '"'
1141 endfunction
1142 set bexpr=MyBalloonExpr()
1143 set ballooneval
1144<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001145 Also see |balloon_show()|, can be used if the content of the balloon
1146 is to be fetched asynchronously.
1147
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001148 NOTE: The balloon is displayed only if the cursor is on a text
1149 character. If the result of evaluating 'balloonexpr' is not empty,
1150 Vim does not try to send a message to an external debugger (Netbeans
1151 or Sun Workshop).
1152
Bram Moolenaar30b65812012-07-12 22:01:11 +02001153 The expression will be evaluated in the |sandbox| when set from a
1154 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001155 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001156
1157 It is not allowed to change text or jump to another window while
1158 evaluating 'balloonexpr' |textlock|.
1159
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001160 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001161 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001162< When they are supported "\n" characters will start a new line. If the
1163 expression evaluates to a |List| this is equal to using each List item
1164 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001165 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001166
Bram Moolenaar165bc692015-07-21 17:53:25 +02001167 *'belloff'* *'bo'*
1168'belloff' 'bo' string (default "")
1169 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001170 Specifies for which events the bell will not be rung. It is a comma
1171 separated list of items. For each item that is present, the bell
1172 will be silenced. This is most useful to specify specific events in
1173 insert mode to be silenced.
1174
1175 item meaning when present ~
1176 all All events.
1177 backspace When hitting <BS> or <Del> and deleting results in an
1178 error.
1179 cursor Fail to move around using the cursor keys or
1180 <PageUp>/<PageDown> in |Insert-mode|.
1181 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1182 |i_CTRL-X_CTRL-T|.
1183 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1184 |i_CTRL-E|.
1185 ctrlg Unknown Char after <C-G> in Insert mode.
1186 error Other Error occurred (e.g. try to join last line)
1187 (mostly used in |Normal-mode| or |Cmdline-mode|).
1188 esc hitting <Esc> in |Normal-mode|.
1189 ex In |Visual-mode|, hitting |Q| results in an error.
1190 hangul Error occurred when using hangul input.
1191 insertmode Pressing <Esc> in 'insertmode'.
1192 lang Calling the beep module for Lua/Mzscheme/TCL.
1193 mess No output available for |g<|.
1194 showmatch Error occurred for 'showmatch' function.
1195 operator Empty region error |cpo-E|.
1196 register Unknown register after <C-R> in |Insert-mode|.
1197 shell Bell from shell output |:!|.
1198 spell Error happened on spell suggest.
1199 wildmode More matches in |cmdline-completion| available
1200 (depends on the 'wildmode' setting).
1201
Bram Moolenaar036986f2017-03-16 17:41:02 +01001202 This is most useful to fine tune when in Insert mode the bell should
1203 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001204 indicate that an error occurred. It can be silenced by adding the
1205 "error" keyword.
1206
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1208'binary' 'bin' boolean (default off)
1209 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210 This option should be set before editing a binary file. You can also
1211 use the |-b| Vim argument. When this option is switched on a few
1212 options will be changed (also when it already was on):
1213 'textwidth' will be set to 0
1214 'wrapmargin' will be set to 0
1215 'modeline' will be off
1216 'expandtab' will be off
1217 Also, 'fileformat' and 'fileformats' options will not be used, the
1218 file is read and written like 'fileformat' was "unix" (a single <NL>
1219 separates lines).
1220 The 'fileencoding' and 'fileencodings' options will not be used, the
1221 file is read without conversion.
1222 NOTE: When you start editing a(nother) file while the 'bin' option is
1223 on, settings from autocommands may change the settings again (e.g.,
1224 'textwidth'), causing trouble when editing. You might want to set
1225 'bin' again when the file has been loaded.
1226 The previous values of these options are remembered and restored when
1227 'bin' is switched from on to off. Each buffer has its own set of
1228 saved option values.
1229 To edit a file with 'binary' set you can use the |++bin| argument.
1230 This avoids you have to do ":set bin", which would have effect for all
1231 files you edit.
1232 When writing a file the <EOL> for the last line is only written if
1233 there was one in the original file (normally Vim appends an <EOL> to
1234 the last line if there is none; this would make the file longer). See
1235 the 'endofline' option.
1236
1237 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1238'bioskey' 'biosk' boolean (default on)
1239 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001240 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001241 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242
1243 *'bomb'* *'nobomb'*
1244'bomb' boolean (default off)
1245 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 When writing a file and the following conditions are met, a BOM (Byte
1247 Order Mark) is prepended to the file:
1248 - this option is on
1249 - the 'binary' option is off
1250 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1251 endian variants.
1252 Some applications use the BOM to recognize the encoding of the file.
1253 Often used for UCS-2 files on MS-Windows. For other applications it
1254 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001255 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1257 check for the presence of the BOM is done and 'bomb' set accordingly.
1258 Unless 'binary' is set, it is removed from the first line, so that you
1259 don't see it when editing. When you don't change the options, the BOM
1260 will be restored when writing the file.
1261
1262 *'breakat'* *'brk'*
1263'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1264 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001265 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266 feature}
1267 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001268 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1269 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001271 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001272'breakindent' 'bri' boolean (default off)
1273 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001274 {not available when compiled without the |+linebreak|
1275 feature}
1276 Every wrapped line will continue visually indented (same amount of
1277 space as the beginning of that line), thus preserving horizontal blocks
1278 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001279 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001280
1281 *'breakindentopt'* *'briopt'*
1282'breakindentopt' 'briopt' string (default empty)
1283 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001284 {not available when compiled without the |+linebreak|
1285 feature}
1286 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001287 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001288 min:{n} Minimum text width that will be kept after
1289 applying 'breakindent', even if the resulting
1290 text should normally be narrower. This prevents
1291 text indented almost to the right window border
1292 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001293 shift:{n} After applying 'breakindent', the wrapped line's
1294 beginning will be shifted by the given number of
1295 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001296 indentation (negative) or emphasizing the line
1297 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001298 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001299 additional indent.
1300 The default value for min is 20 and shift is 0.
1301
Bram Moolenaar071d4272004-06-13 20:20:40 +00001302 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001303'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001305 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001307 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001308 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001309 buffer Use the directory of the related buffer.
1310 current Use the current directory.
1311 {path} Use the specified directory
1312
1313 *'bufhidden'* *'bh'*
1314'bufhidden' 'bh' string (default: "")
1315 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316 This option specifies what happens when a buffer is no longer
1317 displayed in a window:
1318 <empty> follow the global 'hidden' option
1319 hide hide the buffer (don't unload it), also when 'hidden'
1320 is not set
1321 unload unload the buffer, also when 'hidden' is set or using
1322 |:hide|
1323 delete delete the buffer from the buffer list, also when
1324 'hidden' is set or using |:hide|, like using
1325 |:bdelete|
1326 wipe wipe out the buffer from the buffer list, also when
1327 'hidden' is set or using |:hide|, like using
1328 |:bwipeout|
1329
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001330 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001331 are lost without a warning. Also, these values may break autocommands
1332 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001333 This option is used together with 'buftype' and 'swapfile' to specify
1334 special kinds of buffers. See |special-buffers|.
1335
1336 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1337'buflisted' 'bl' boolean (default: on)
1338 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 When this option is set, the buffer shows up in the buffer list. If
1340 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1341 This option is reset by Vim for buffers that are only used to remember
1342 a file name or marks. Vim sets it when starting to edit a buffer.
1343 But not when moving to a buffer with ":buffer".
1344
1345 *'buftype'* *'bt'* *E382*
1346'buftype' 'bt' string (default: "")
1347 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348 The value of this option specifies the type of a buffer:
1349 <empty> normal buffer
1350 nofile buffer which is not related to a file and will not be
1351 written
1352 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001353 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001354 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001356 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357 help help buffer (you are not supposed to set this
1358 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001359 terminal buffer for a |terminal| (you are not supposed to set
1360 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001361 prompt buffer where only the last line can be edited, meant
1362 to be used by a plugin, see |prompt-buffer|
1363 {only when compiled with the |+channel| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001364
1365 This option is used together with 'bufhidden' and 'swapfile' to
1366 specify special kinds of buffers. See |special-buffers|.
1367
1368 Be careful with changing this option, it can have many side effects!
1369
Bram Moolenaar280f1262006-01-30 00:14:18 +00001370 A "quickfix" buffer is only used for the error list and the location
1371 list. This value is set by the |:cwindow| and |:lwindow| commands and
1372 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001373
1374 "nofile" and "nowrite" buffers are similar:
1375 both: The buffer is not to be written to disk, ":w" doesn't
1376 work (":w filename" does work though).
1377 both: The buffer is never considered to be |'modified'|.
1378 There is no warning when the changes will be lost, for
1379 example when you quit Vim.
1380 both: A swap file is only created when using too much memory
1381 (when 'swapfile' has been reset there is never a swap
1382 file).
1383 nofile only: The buffer name is fixed, it is not handled like a
1384 file name. It is not modified in response to a |:cd|
1385 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001386 both: When using ":e bufname" and already editing "bufname"
1387 the buffer is made empty and autocommands are
1388 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001389 *E676*
1390 "acwrite" implies that the buffer name is not related to a file, like
1391 "nofile", but it will be written. Thus, in contrast to "nofile" and
1392 "nowrite", ":w" does work and a modified buffer can't be abandoned
1393 without saving. For writing there must be matching |BufWriteCmd|,
1394 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395
1396 *'casemap'* *'cmp'*
1397'casemap' 'cmp' string (default: "internal,keepascii")
1398 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399 Specifies details about changing the case of letters. It may contain
1400 these words, separated by a comma:
1401 internal Use internal case mapping functions, the current
1402 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001403 matters when 'encoding' is a Unicode encoding,
1404 "latin1" or "iso-8859-15". When "internal" is
1405 omitted, the towupper() and towlower() system library
1406 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1408 case mapping, the current locale is not effective.
1409 This probably only matters for Turkish.
1410
1411 *'cdpath'* *'cd'* *E344* *E346*
1412'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1413 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414 {not available when compiled without the
1415 |+file_in_path| feature}
1416 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001417 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1418 searched for has a relative path, not an absolute part starting with
1419 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001420 The 'cdpath' option's value has the same form and semantics as
1421 |'path'|. Also see |file-searching|.
1422 The default value is taken from $CDPATH, with a "," prepended to look
1423 in the current directory first.
1424 If the default value taken from $CDPATH is not what you want, include
1425 a modified version of the following command in your vimrc file to
1426 override it: >
1427 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1428< This option cannot be set from a |modeline| or in the |sandbox|, for
1429 security reasons.
1430 (parts of 'cdpath' can be passed to the shell to expand file names).
1431
1432 *'cedit'*
1433'cedit' string (Vi default: "", Vim default: CTRL-F)
1434 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435 {not available when compiled without the |+vertsplit|
1436 feature}
1437 The key used in Command-line Mode to open the command-line window.
1438 The default is CTRL-F when 'compatible' is off.
1439 Only non-printable keys are allowed.
1440 The key can be specified as a single character, but it is difficult to
1441 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001442 :exe "set cedit=\<C-Y>"
1443 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001444< |Nvi| also has this option, but it only uses the first character.
1445 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001446 NOTE: This option is set to the Vim default value when 'compatible'
1447 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448
1449 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1450'charconvert' 'ccv' string (default "")
1451 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001452 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453 An expression that is used for character encoding conversion. It is
1454 evaluated when a file that is to be read or has been written has a
1455 different encoding from what is desired.
1456 'charconvert' is not used when the internal iconv() function is
1457 supported and is able to do the conversion. Using iconv() is
1458 preferred, because it is much faster.
1459 'charconvert' is not used when reading stdin |--|, because there is no
1460 file to convert from. You will have to save the text in a file first.
1461 The expression must return zero or an empty string for success,
1462 non-zero for failure.
1463 The possible encoding names encountered are in 'encoding'.
1464 Additionally, names given in 'fileencodings' and 'fileencoding' are
1465 used.
1466 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1467 is done internally by Vim, 'charconvert' is not used for this.
1468 'charconvert' is also used to convert the viminfo file, if the 'c'
1469 flag is present in 'viminfo'. Also used for Unicode conversion.
1470 Example: >
1471 set charconvert=CharConvert()
1472 fun CharConvert()
1473 system("recode "
1474 \ . v:charconvert_from . ".." . v:charconvert_to
1475 \ . " <" . v:fname_in . " >" v:fname_out)
1476 return v:shell_error
1477 endfun
1478< The related Vim variables are:
1479 v:charconvert_from name of the current encoding
1480 v:charconvert_to name of the desired encoding
1481 v:fname_in name of the input file
1482 v:fname_out name of the output file
1483 Note that v:fname_in and v:fname_out will never be the same.
1484 Note that v:charconvert_from and v:charconvert_to may be different
1485 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1486 Encryption is not done by Vim when using 'charconvert'. If you want
1487 to encrypt the file after conversion, 'charconvert' should take care
1488 of this.
1489 This option cannot be set from a |modeline| or in the |sandbox|, for
1490 security reasons.
1491
1492 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1493'cindent' 'cin' boolean (default off)
1494 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001495 {not available when compiled without the |+cindent|
1496 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001497 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498 that trigger reindenting in insert mode and 'cinoptions' to set your
1499 preferred indent style.
1500 If 'indentexpr' is not empty, it overrules 'cindent'.
1501 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1502 the "=" operator indents using this algorithm rather than calling an
1503 external program.
1504 See |C-indenting|.
1505 When you don't like the way 'cindent' works, try the 'smartindent'
1506 option or 'indentexpr'.
1507 This option is not used when 'paste' is set.
1508 NOTE: This option is reset when 'compatible' is set.
1509
1510 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001511'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513 {not available when compiled without the |+cindent|
1514 feature}
1515 A list of keys that, when typed in Insert mode, cause reindenting of
1516 the current line. Only used if 'cindent' is on and 'indentexpr' is
1517 empty.
1518 For the format of this option see |cinkeys-format|.
1519 See |C-indenting|.
1520
1521 *'cinoptions'* *'cino'*
1522'cinoptions' 'cino' string (default "")
1523 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001524 {not available when compiled without the |+cindent|
1525 feature}
1526 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1527 program. See |cinoptions-values| for the values of this option, and
1528 |C-indenting| for info on C indenting in general.
1529
1530
1531 *'cinwords'* *'cinw'*
1532'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1533 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001534 {not available when compiled without both the
1535 |+cindent| and the |+smartindent| features}
1536 These keywords start an extra indent in the next line when
1537 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1538 an appropriate place (inside {}).
1539 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1540 matter, include the keyword both the uppercase and lowercase:
1541 "if,If,IF".
1542
1543 *'clipboard'* *'cb'*
1544'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1545 for X-windows, "" otherwise)
1546 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547 {only in GUI versions or when the |+xterm_clipboard|
1548 feature is included}
1549 This option is a list of comma separated names.
1550 These names are recognized:
1551
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001552 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553 unnamed When included, Vim will use the clipboard register '*'
1554 for all yank, delete, change and put operations which
1555 would normally go to the unnamed register. When a
1556 register is explicitly specified, it will always be
1557 used regardless of whether "unnamed" is in 'clipboard'
1558 or not. The clipboard register can always be
1559 explicitly accessed using the "* notation. Also see
1560 |gui-clipboard|.
1561
Bram Moolenaar30b65812012-07-12 22:01:11 +02001562 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001563 unnamedplus A variant of the "unnamed" flag which uses the
1564 clipboard register '+' (|quoteplus|) instead of
1565 register '*' for all yank, delete, change and put
1566 operations which would normally go to the unnamed
1567 register. When "unnamed" is also included to the
1568 option, yank operations (but not delete, change or
1569 put) will additionally copy the text into register
1570 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001571 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001572 Availability can be checked with: >
1573 if has('unnamedplus')
1574<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001575 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576 autoselect Works like the 'a' flag in 'guioptions': If present,
1577 then whenever Visual mode is started, or the Visual
1578 area extended, Vim tries to become the owner of the
1579 windowing system's global selection or put the
1580 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001581 register "*. See |'go-a'| and |quotestar| for details.
1582 When the GUI is active, the 'a' flag in 'guioptions'
1583 is used, when the GUI is not active, this "autoselect"
1584 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001585 Also applies to the modeless selection.
1586
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001587 *clipboard-autoselectplus*
1588 autoselectplus Like "autoselect" but using the + register instead of
1589 the * register. Compare to the 'P' flag in
1590 'guioptions'.
1591
1592 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001593 autoselectml Like "autoselect", but for the modeless selection
1594 only. Compare to the 'A' flag in 'guioptions'.
1595
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001596 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001597 html When the clipboard contains HTML, use this when
1598 pasting. When putting text on the clipboard, mark it
1599 as HTML. This works to copy rendered HTML from
1600 Firefox, paste it as raw HTML in Vim, select the HTML
1601 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001602 You probably want to add this only temporarily,
1603 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001604 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001605
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001606 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 exclude:{pattern}
1608 Defines a pattern that is matched against the name of
1609 the terminal 'term'. If there is a match, no
1610 connection will be made to the X server. This is
1611 useful in this situation:
1612 - Running Vim in a console.
1613 - $DISPLAY is set to start applications on another
1614 display.
1615 - You do not want to connect to the X server in the
1616 console, but do want this in a terminal emulator.
1617 To never connect to the X server use: >
1618 exclude:.*
1619< This has the same effect as using the |-X| argument.
1620 Note that when there is no connection to the X server
1621 the window title won't be restored and the clipboard
1622 cannot be accessed.
1623 The value of 'magic' is ignored, {pattern} is
1624 interpreted as if 'magic' was on.
1625 The rest of the option value will be used for
1626 {pattern}, this must be the last entry.
1627
1628 *'cmdheight'* *'ch'*
1629'cmdheight' 'ch' number (default 1)
1630 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631 Number of screen lines to use for the command-line. Helps avoiding
1632 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001633 The value of this option is stored with the tab page, so that each tab
1634 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635
1636 *'cmdwinheight'* *'cwh'*
1637'cmdwinheight' 'cwh' number (default 7)
1638 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639 {not available when compiled without the |+vertsplit|
1640 feature}
1641 Number of screen lines to use for the command-line window. |cmdwin|
1642
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001643 *'colorcolumn'* *'cc'*
1644'colorcolumn' 'cc' string (default "")
1645 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001646 {not available when compiled without the |+syntax|
1647 feature}
1648 'colorcolumn' is a comma separated list of screen columns that are
1649 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1650 text. Will make screen redrawing slower.
1651 The screen column can be an absolute number, or a number preceded with
1652 '+' or '-', which is added to or subtracted from 'textwidth'. >
1653
1654 :set cc=+1 " highlight column after 'textwidth'
1655 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1656 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1657<
1658 When 'textwidth' is zero then the items with '-' and '+' are not used.
1659 A maximum of 256 columns are highlighted.
1660
Bram Moolenaar071d4272004-06-13 20:20:40 +00001661 *'columns'* *'co'* *E594*
1662'columns' 'co' number (default 80 or terminal width)
1663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001665 initialization and does not have to be set by hand. Also see
1666 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 When Vim is running in the GUI or in a resizable window, setting this
1668 option will cause the window size to be changed. When you only want
1669 to use the size for the GUI, put the command in your |gvimrc| file.
1670 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001671 number of columns of the display, the display may be messed up. For
1672 the GUI it is always possible and Vim limits the number of columns to
1673 what fits on the screen. You can use this command to get the widest
1674 window possible: >
1675 :set columns=9999
1676< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677
1678 *'comments'* *'com'* *E524* *E525*
1679'comments' 'com' string (default
1680 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1681 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682 {not available when compiled without the |+comments|
1683 feature}
1684 A comma separated list of strings that can start a comment line. See
1685 |format-comments|. See |option-backslash| about using backslashes to
1686 insert a space.
1687
1688 *'commentstring'* *'cms'* *E537*
1689'commentstring' 'cms' string (default "/*%s*/")
1690 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691 {not available when compiled without the |+folding|
1692 feature}
1693 A template for a comment. The "%s" in the value is replaced with the
1694 comment text. Currently only used to add markers for folding, see
1695 |fold-marker|.
1696
1697 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001698'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001699 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 This option has the effect of making Vim either more Vi-compatible, or
1702 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001703
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001705 other options are also changed as a side effect.
1706 NOTE: Setting or resetting this option can have a lot of unexpected
1707 effects: Mappings are interpreted in another way, undo behaves
1708 differently, etc. If you set this option in your vimrc file, you
1709 should probably put it at the very start.
1710
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 By default this option is on and the Vi defaults are used for the
1712 options. This default was chosen for those people who want to use Vim
1713 just like Vi, and don't even (want to) know about the 'compatible'
1714 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001715 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001716 this option is switched off, and all options that have not been
1717 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001718 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001719 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001720 happen for the system-wide vimrc or gvimrc file, nor for a file given
1721 with the |-u| argument). Also see |compatible-default| and
1722 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 You can also set this option with the "-C" argument, and reset it with
1724 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001725 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726
Bram Moolenaar214641f2017-03-05 17:04:09 +01001727 When this option is set, numerous other options are set to make Vim as
1728 Vi-compatible as possible. When this option is unset, various options
1729 are set to make Vim more useful. The table below lists all the
1730 options affected.
1731 The {?} column indicates when the options are affected:
1732 + Means that the option is set to the value given in {set value} when
1733 'compatible' is set.
1734 & Means that the option is set to the value given in {set value} when
1735 'compatible' is set AND is set to its Vim default value when
1736 'compatible' is unset.
1737 - Means the option is NOT changed when setting 'compatible' but IS
1738 set to its Vim default when 'compatible' is unset.
1739 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740
Bram Moolenaar036986f2017-03-16 17:41:02 +01001741 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001742
1743 'allowrevins' + off no CTRL-_ command
1744 'antialias' + off don't use antialiased fonts
1745 'arabic' + off reset arabic-related options
1746 'arabicshape' + on correct character shapes
1747 'backspace' + "" normal backspace
1748 'backup' + off no backup file
1749 'backupcopy' & Unix: "yes" backup file is a copy
1750 else: "auto" copy or rename backup file
1751 'balloonexpr' + "" text to show in evaluation balloon
1752 'breakindent' + off don't indent when wrapping lines
1753 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1754 'cindent' + off no C code indentation
1755 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1756 'copyindent' + off don't copy indent structure
1757 'cpoptions' & (all flags) Vi-compatible flags
1758 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001759 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001760 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001761 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001762 'cscopeverbose' + off see |cscopeverbose|
1763 'delcombine' + off unicode: delete whole char combination
1764 'digraph' + off no digraphs
1765 'esckeys' & off no <Esc>-keys in Insert mode
1766 'expandtab' + off tabs not expanded to spaces
1767 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001769 'formatexpr' + "" use 'formatprg' for auto-formatting
1770 'formatoptions' & "vt" Vi compatible formatting
1771 'gdefault' + off no default 'g' flag for ":s"
1772 'history' & 0 no commandline history
1773 'hkmap' + off no Hebrew keyboard mapping
1774 'hkmapp' + off no phonetic Hebrew keyboard mapping
1775 'hlsearch' + off no highlighting of search matches
1776 'incsearch' + off no incremental searching
1777 'indentexpr' + "" no indenting by expression
1778 'insertmode' + off do not start in Insert mode
1779 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001780 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001781 'joinspaces' + on insert 2 spaces after period
1782 'modeline' & off no modelines
1783 'more' & off no pauses in listings
1784 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1785 'numberwidth' & 8 min number of columns for line number
1786 'preserveindent'+ off don't preserve current indent structure
1787 when changing it
1788 'revins' + off no reverse insert
1789 'ruler' + off no ruler
1790 'scrolljump' + 1 no jump scroll
1791 'scrolloff' + 0 no scroll offset
1792 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1793 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001794 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001795 'showcmd' & off command characters not shown
1796 'showmode' & off current mode not shown
1797 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1798 'smartcase' + off no automatic ignore case switch
1799 'smartindent' + off no smart indentation
1800 'smarttab' + off no smart tab size
1801 'softtabstop' + 0 tabs are always 'tabstop' positions
1802 'startofline' + on goto startofline with some commands
1803 'tagcase' & "followic" 'ignorecase' when searching tags file
1804 'tagrelative' & off tag file names are not relative
1805 'termguicolors' + off don't use highlight-(guifg|guibg)
1806 'textauto' & off no automatic textmode detection
1807 'textwidth' + 0 no automatic line wrap
1808 'tildeop' + off tilde is not an operator
1809 'ttimeout' + off no terminal timeout
1810 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001811 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001812 'virtualedit' + "" cursor can only be placed on characters
1813 'whichwrap' & "" left-right movements don't wrap
1814 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001816 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817
1818 *'complete'* *'cpt'* *E535*
1819'complete' 'cpt' string (default: ".,w,b,u,t,i")
1820 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 This option specifies how keyword completion |ins-completion| works
1822 when CTRL-P or CTRL-N are used. It is also used for whole-line
1823 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1824 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001825 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 w scan buffers from other windows
1827 b scan other loaded buffers that are in the buffer list
1828 u scan the unloaded buffers that are in the buffer list
1829 U scan the buffers that are not in the buffer list
1830 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001831 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 k{dict} scan the file {dict}. Several "k" flags can be given,
1833 patterns are valid too. For example: >
1834 :set cpt=k/usr/dict/*,k~/spanish
1835< s scan the files given with the 'thesaurus' option
1836 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1837 are valid too.
1838 i scan current and included files
1839 d scan current and included files for defined name or macro
1840 |i_CTRL-X_CTRL-D|
1841 ] tag completion
1842 t same as "]"
1843
1844 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1845 not executed, this may lead to unexpected completions from some files
1846 (gzipped files for example). Unloaded buffers are not scanned for
1847 whole-line completion.
1848
1849 The default is ".,w,b,u,t,i", which means to scan:
1850 1. the current buffer
1851 2. buffers in other windows
1852 3. other loaded buffers
1853 4. unloaded buffers
1854 5. tags
1855 6. included files
1856
1857 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001858 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1859 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001861 *'completefunc'* *'cfu'*
1862'completefunc' 'cfu' string (default: empty)
1863 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001864 {not available when compiled without the |+eval|
1865 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001866 This option specifies a function to be used for Insert mode completion
1867 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001868 See |complete-functions| for an explanation of how the function is
1869 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001870 This option cannot be set from a |modeline| or in the |sandbox|, for
1871 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001872
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001873 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001874'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001875 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001876 {not available when compiled without the
1877 |+insert_expand| feature}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001878 A comma separated list of options for Insert mode completion
1879 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001880
1881 menu Use a popup menu to show the possible completions. The
1882 menu is only shown when there is more than one match and
1883 sufficient colors are available. |ins-completion-menu|
1884
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001885 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001886 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001887 match, e.g., what file it comes from.
1888
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001889 longest Only insert the longest common text of the matches. If
1890 the menu is displayed you can use CTRL-L to add more
1891 characters. Whether case is ignored depends on the kind
1892 of completion. For buffer text the 'ignorecase' option is
1893 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001894
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001895 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001896 completion in the preview window. Only works in
1897 combination with "menu" or "menuone".
1898
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001899 noinsert Do not insert any text for a match until the user selects
1900 a match from the menu. Only works in combination with
1901 "menu" or "menuone". No effect if "longest" is present.
1902
1903 noselect Do not select a match in the menu, force the user to
1904 select one from the menu. Only works in combination with
1905 "menu" or "menuone".
1906
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001907
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001908 *'concealcursor'* *'cocu'*
1909'concealcursor' 'cocu' string (default: "")
1910 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001911 {not available when compiled without the |+conceal|
1912 feature}
1913 Sets the modes in which text in the cursor line can also be concealed.
1914 When the current mode is listed then concealing happens just like in
1915 other lines.
1916 n Normal mode
1917 v Visual mode
1918 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001919 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001920
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001921 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001922 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001923 are moving around text is concealed, but when starting to insert text
1924 or selecting a Visual area the concealed text is displayed, so that
1925 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001926 Keep in mind that the cursor position is not always where it's
1927 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001928
1929
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001930 *'conceallevel'* *'cole'*
1931'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001932 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001933 {not available when compiled without the |+conceal|
1934 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001935 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1936 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001937
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001938 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001939 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001940 1 Each block of concealed text is replaced with one
1941 character. If the syntax item does not have a custom
1942 replacement character defined (see |:syn-cchar|) the
1943 character defined in 'listchars' is used (default is a
1944 space).
1945 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001946 2 Concealed text is completely hidden unless it has a
1947 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001948 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001949 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001950
Bram Moolenaara7781e02010-07-19 20:13:22 +02001951 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001952 edit and copy the text. This can be changed with the 'concealcursor'
1953 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001954
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1956'confirm' 'cf' boolean (default off)
1957 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001958 When 'confirm' is on, certain operations that would normally
1959 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1960 instead raise a |dialog| asking if you wish to save the current
1961 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1962 If 'confirm' is off you can still activate confirmation for one
1963 command only (this is most useful in mappings) with the |:confirm|
1964 command.
1965 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1966
1967 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1968'conskey' 'consk' boolean (default off)
1969 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01001970 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971
1972 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1973'copyindent' 'ci' boolean (default off)
1974 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001975 Copy the structure of the existing lines indent when autoindenting a
1976 new line. Normally the new indent is reconstructed by a series of
1977 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1978 in which case only spaces are used). Enabling this option makes the
1979 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001980 existing line. 'expandtab' has no effect on these characters, a Tab
1981 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001983 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984 Also see 'preserveindent'.
1985
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001986 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001987'cpoptions' 'cpo' string (Vim default: "aABceFs",
1988 Vi default: all flags)
1989 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001991 this indicates Vi-compatible behavior. This is used for things where
1992 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993 'cpoptions' stands for "compatible-options".
1994 Commas can be added for readability.
1995 To avoid problems with flags that are added in the future, use the
1996 "+=" and "-=" feature of ":set" |add-option-flags|.
1997 NOTE: This option is set to the Vi default value when 'compatible' is
1998 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001999 NOTE: This option is set to the POSIX default value at startup when
2000 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002001 variable exists |posix|. This means Vim tries to behave like the
2002 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003
2004 contains behavior ~
2005 *cpo-a*
2006 a When included, a ":read" command with a file name
2007 argument will set the alternate file name for the
2008 current window.
2009 *cpo-A*
2010 A When included, a ":write" command with a file name
2011 argument will set the alternate file name for the
2012 current window.
2013 *cpo-b*
2014 b "\|" in a ":map" command is recognized as the end of
2015 the map command. The '\' is included in the mapping,
2016 the text after the '|' is interpreted as the next
2017 command. Use a CTRL-V instead of a backslash to
2018 include the '|' in the mapping. Applies to all
2019 mapping, abbreviation, menu and autocmd commands.
2020 See also |map_bar|.
2021 *cpo-B*
2022 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002023 abbreviations, user commands and the "to" part of the
2024 menu commands. Remove this flag to be able to use a
2025 backslash like a CTRL-V. For example, the command
2026 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 'B' included: "\^[" (^[ is a real <Esc>)
2028 'B' excluded: "<Esc>" (5 characters)
2029 ('<' excluded in both cases)
2030 *cpo-c*
2031 c Searching continues at the end of any match at the
2032 cursor position, but not further than the start of the
2033 next line. When not present searching continues
2034 one character from the cursor position. With 'c'
2035 "abababababab" only gets three matches when repeating
2036 "/abab", without 'c' there are five matches.
2037 *cpo-C*
2038 C Do not concatenate sourced lines that start with a
2039 backslash. See |line-continuation|.
2040 *cpo-d*
2041 d Using "./" in the 'tags' option doesn't mean to use
2042 the tags file relative to the current file, but the
2043 tags file in the current directory.
2044 *cpo-D*
2045 D Can't use CTRL-K to enter a digraph after Normal mode
2046 commands with a character argument, like |r|, |f| and
2047 |t|.
2048 *cpo-e*
2049 e When executing a register with ":@r", always add a
2050 <CR> to the last line, also when the register is not
2051 linewise. If this flag is not present, the register
2052 is not linewise and the last line does not end in a
2053 <CR>, then the last line is put on the command-line
2054 and can be edited before hitting <CR>.
2055 *cpo-E*
2056 E It is an error when using "y", "d", "c", "g~", "gu" or
2057 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002058 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 This makes "y0" fail in the first column.
2060 *cpo-f*
2061 f When included, a ":read" command with a file name
2062 argument will set the file name for the current buffer,
2063 if the current buffer doesn't have a file name yet.
2064 *cpo-F*
2065 F When included, a ":write" command with a file name
2066 argument will set the file name for the current
2067 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002068 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002069 *cpo-g*
2070 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002071 *cpo-H*
2072 H When using "I" on a line with only blanks, insert
2073 before the last blank. Without this flag insert after
2074 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 *cpo-i*
2076 i When included, interrupting the reading of a file will
2077 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002078 *cpo-I*
2079 I When moving the cursor up or down just after inserting
2080 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002081 *cpo-j*
2082 j When joining lines, only add two spaces after a '.',
2083 not after '!' or '?'. Also see 'joinspaces'.
2084 *cpo-J*
2085 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002086 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087 white space.
2088 *cpo-k*
2089 k Disable the recognition of raw key codes in
2090 mappings, abbreviations, and the "to" part of menu
2091 commands. For example, if <Key> sends ^[OA (where ^[
2092 is <Esc>), the command ":map X ^[OA" results in X
2093 being mapped to:
2094 'k' included: "^[OA" (3 characters)
2095 'k' excluded: "<Key>" (one key code)
2096 Also see the '<' flag below.
2097 *cpo-K*
2098 K Don't wait for a key code to complete when it is
2099 halfway a mapping. This breaks mapping <F1><F1> when
2100 only part of the second <F1> has been read. It
2101 enables cancelling the mapping by typing <F1><Esc>.
2102 *cpo-l*
2103 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002104 literally, only "\]", "\^", "\-" and "\\" are special.
2105 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2107 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002108 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109 *cpo-L*
2110 L When the 'list' option is set, 'wrapmargin',
2111 'textwidth', 'softtabstop' and Virtual Replace mode
2112 (see |gR|) count a <Tab> as two characters, instead of
2113 the normal behavior of a <Tab>.
2114 *cpo-m*
2115 m When included, a showmatch will always wait half a
2116 second. When not included, a showmatch will wait half
2117 a second or until a character is typed. |'showmatch'|
2118 *cpo-M*
2119 M When excluded, "%" matching will take backslashes into
2120 account. Thus in "( \( )" and "\( ( \)" the outer
2121 parenthesis match. When included "%" ignores
2122 backslashes, which is Vi compatible.
2123 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002124 n When included, the column used for 'number' and
2125 'relativenumber' will also be used for text of wrapped
2126 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 *cpo-o*
2128 o Line offset to search command is not remembered for
2129 next search.
2130 *cpo-O*
2131 O Don't complain if a file is being overwritten, even
2132 when it didn't exist when editing it. This is a
2133 protection against a file unexpectedly created by
2134 someone else. Vi didn't complain about this.
2135 *cpo-p*
2136 p Vi compatible Lisp indenting. When not present, a
2137 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002138 *cpo-P*
2139 P When included, a ":write" command that appends to a
2140 file will set the file name for the current buffer, if
2141 the current buffer doesn't have a file name yet and
2142 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002143 *cpo-q*
2144 q When joining multiple lines leave the cursor at the
2145 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 *cpo-r*
2147 r Redo ("." command) uses "/" to repeat a search
2148 command, instead of the actually used search string.
2149 *cpo-R*
2150 R Remove marks from filtered lines. Without this flag
2151 marks are kept like |:keepmarks| was used.
2152 *cpo-s*
2153 s Set buffer options when entering the buffer for the
2154 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002155 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 set when the buffer is created.
2157 *cpo-S*
2158 S Set buffer options always when entering a buffer
2159 (except 'readonly', 'fileformat', 'filetype' and
2160 'syntax'). This is the (most) Vi compatible setting.
2161 The options are set to the values in the current
2162 buffer. When you change an option and go to another
2163 buffer, the value is copied. Effectively makes the
2164 buffer options global to all buffers.
2165
2166 's' 'S' copy buffer options
2167 no no when buffer created
2168 yes no when buffer first entered (default)
2169 X yes each time when buffer entered (vi comp.)
2170 *cpo-t*
2171 t Search pattern for the tag command is remembered for
2172 "n" command. Otherwise Vim only puts the pattern in
2173 the history for search pattern, but doesn't change the
2174 last used search pattern.
2175 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002176 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 *cpo-v*
2178 v Backspaced characters remain visible on the screen in
2179 Insert mode. Without this flag the characters are
2180 erased from the screen right away. With this flag the
2181 screen newly typed text overwrites backspaced
2182 characters.
2183 *cpo-w*
2184 w When using "cw" on a blank character, only change one
2185 character and not all blanks until the start of the
2186 next word.
2187 *cpo-W*
2188 W Don't overwrite a readonly file. When omitted, ":w!"
2189 overwrites a readonly file, if possible.
2190 *cpo-x*
2191 x <Esc> on the command-line executes the command-line.
2192 The default in Vim is to abandon the command-line,
2193 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002194 *cpo-X*
2195 X When using a count with "R" the replaced text is
2196 deleted only once. Also when repeating "R" with "."
2197 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002199 y A yank command can be redone with ".". Think twice if
2200 you really want to use this, it may break some
2201 plugins, since most people expect "." to only repeat a
2202 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002203 *cpo-Z*
2204 Z When using "w!" while the 'readonly' option is set,
2205 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206 *cpo-!*
2207 ! When redoing a filter command, use the last used
2208 external command, whatever it was. Otherwise the last
2209 used -filter- command is used.
2210 *cpo-$*
2211 $ When making a change to one line, don't redisplay the
2212 line, but put a '$' at the end of the changed text.
2213 The changed text will be overwritten when you type the
2214 new text. The line is redisplayed if you type any
2215 command that moves the cursor from the insertion
2216 point.
2217 *cpo-%*
2218 % Vi-compatible matching is done for the "%" command.
2219 Does not recognize "#if", "#endif", etc.
2220 Does not recognize "/*" and "*/".
2221 Parens inside single and double quotes are also
2222 counted, causing a string that contains a paren to
2223 disturb the matching. For example, in a line like
2224 "if (strcmp("foo(", s))" the first paren does not
2225 match the last one. When this flag is not included,
2226 parens inside single and double quotes are treated
2227 specially. When matching a paren outside of quotes,
2228 everything inside quotes is ignored. When matching a
2229 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002230 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002231 This flag is also used for other features, such as
2232 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002233 *cpo--*
2234 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002235 it would go above the first line or below the last
2236 line. Without it the cursor moves to the first or
2237 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002238 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002239 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002240 *cpo-+*
2241 + When included, a ":write file" command will reset the
2242 'modified' flag of the buffer, even though the buffer
2243 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002244 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002245 * Use ":*" in the same way as ":@". When not included,
2246 ":*" is an alias for ":'<,'>", select the Visual area.
2247 *cpo-<*
2248 < Disable the recognition of special key codes in |<>|
2249 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002250 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 ":map X <Tab>" results in X being mapped to:
2252 '<' included: "<Tab>" (5 characters)
2253 '<' excluded: "^I" (^I is a real <Tab>)
2254 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002255 *cpo->*
2256 > When appending to a register, put a line break before
2257 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002258 *cpo-;*
2259 ; When using |,| or |;| to repeat the last |t| search
2260 and the cursor is right in front of the searched
2261 character, the cursor won't move. When not included,
2262 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002263 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002264
2265 POSIX flags. These are not included in the Vi default value, except
2266 when $VIM_POSIX was set on startup. |posix|
2267
2268 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002269 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002270 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002271 *cpo-&*
2272 & When ":preserve" was used keep the swap file when
2273 exiting normally while this buffer is still loaded.
2274 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002275 *cpo-\*
2276 \ Backslash in a [] range in a search pattern is taken
2277 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002278 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2279 '\' excluded: "/[ \-]" finds <Space> and '-'
2280 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002281 *cpo-/*
2282 / When "%" is used as the replacement string in a |:s|
2283 command, use the previous replacement string. |:s%|
2284 *cpo-{*
2285 { The |{| and |}| commands also stop at a "{" character
2286 at the start of a line.
2287 *cpo-.*
2288 . The ":chdir" and ":cd" commands fail if the current
2289 buffer is modified, unless ! is used. Vim doesn't
2290 need this, since it remembers the full path of an
2291 opened file.
2292 *cpo-bar*
2293 | The value of the $LINES and $COLUMNS environment
2294 variables overrule the terminal size values obtained
2295 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002296
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002298 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002299'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002300 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002301 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002302 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002303 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002304 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002305 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002306 blowfish Blowfish method. Medium strong encryption but it has
2307 an implementation flaw. Requires Vim 7.3 or later,
2308 files can NOT be read by Vim 7.2 and older. This adds
2309 a "seed" to the file, every time you write the file
2310 the encrypted bytes will be different.
2311 *blowfish2*
2312 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002313 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002314 and older. This adds a "seed" to the file, every time
2315 you write the file the encrypted bytes will be
2316 different. The whole undo file is encrypted, not just
2317 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002318
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002319 You should use "blowfish2", also to re-encrypt older files.
2320
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002321 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002322 to the detected method of the file being read. Thus if you write it
2323 without changing 'cryptmethod' the same method will be used.
2324 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002325 explicitly write it, you don't get a warning unless there are other
2326 modifications. Also see |:X|.
2327
2328 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002329 the value "blowfish2". When setting the local value to an empty
2330 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002331
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002332 When a new encryption method is added in a later version of Vim, and
2333 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002334 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002335
2336
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 *'cscopepathcomp'* *'cspc'*
2338'cscopepathcomp' 'cspc' number (default 0)
2339 global
2340 {not available when compiled without the |+cscope|
2341 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002342 Determines how many components of the path to show in a list of tags.
2343 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002344 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345
2346 *'cscopeprg'* *'csprg'*
2347'cscopeprg' 'csprg' string (default "cscope")
2348 global
2349 {not available when compiled without the |+cscope|
2350 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351 Specifies the command to execute cscope. See |cscopeprg|.
2352 This option cannot be set from a |modeline| or in the |sandbox|, for
2353 security reasons.
2354
2355 *'cscopequickfix'* *'csqf'*
2356'cscopequickfix' 'csqf' string (default "")
2357 global
2358 {not available when compiled without the |+cscope|
2359 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 Specifies whether to use quickfix window to show cscope results.
2361 See |cscopequickfix|.
2362
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002363 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002364'cscoperelative' 'csre' boolean (default off)
2365 global
2366 {not available when compiled without the |+cscope|
2367 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002368 In the absence of a prefix (-P) for cscope. setting this option enables
2369 to use the basename of cscope.out path as the prefix.
2370 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002371 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002372
Bram Moolenaar071d4272004-06-13 20:20:40 +00002373 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2374'cscopetag' 'cst' boolean (default off)
2375 global
2376 {not available when compiled without the |+cscope|
2377 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002378 Use cscope for tag commands. See |cscope-options|.
2379 NOTE: This option is reset when 'compatible' is set.
2380
2381 *'cscopetagorder'* *'csto'*
2382'cscopetagorder' 'csto' number (default 0)
2383 global
2384 {not available when compiled without the |+cscope|
2385 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386 Determines the order in which ":cstag" performs a search. See
2387 |cscopetagorder|.
2388 NOTE: This option is set to 0 when 'compatible' is set.
2389
2390 *'cscopeverbose'* *'csverb'*
2391 *'nocscopeverbose'* *'nocsverb'*
2392'cscopeverbose' 'csverb' boolean (default off)
2393 global
2394 {not available when compiled without the |+cscope|
2395 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396 Give messages when adding a cscope database. See |cscopeverbose|.
2397 NOTE: This option is reset when 'compatible' is set.
2398
Bram Moolenaar860cae12010-06-05 23:22:07 +02002399 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2400'cursorbind' 'crb' boolean (default off)
2401 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002402 When this option is set, as the cursor in the current
2403 window moves other cursorbound windows (windows that also have
2404 this option set) move their cursors to the corresponding line and
2405 column. This option is useful for viewing the
2406 differences between two versions of a file (see 'diff'); in diff mode,
2407 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002408 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002409
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002410
2411 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2412'cursorcolumn' 'cuc' boolean (default off)
2413 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002414 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002415 feature}
2416 Highlight the screen column of the cursor with CursorColumn
2417 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2418 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002419 If you only want the highlighting in the current window you can use
2420 these autocommands: >
2421 au WinLeave * set nocursorline nocursorcolumn
2422 au WinEnter * set cursorline cursorcolumn
2423<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002424
2425 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2426'cursorline' 'cul' boolean (default off)
2427 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002428 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002429 feature}
2430 Highlight the screen line of the cursor with CursorLine
2431 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2432 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002433 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002434 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002435
2436
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437 *'debug'*
2438'debug' string (default "")
2439 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002440 These values can be used:
2441 msg Error messages that would otherwise be omitted will be given
2442 anyway.
2443 throw Error messages that would otherwise be omitted will be given
2444 anyway and also throw an exception and set |v:errmsg|.
2445 beep A message will be given when otherwise only a beep would be
2446 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002447 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002448 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2449 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450
2451 *'define'* *'def'*
2452'define' 'def' string (default "^\s*#\s*define")
2453 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002454 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455 pattern, just like for the "/" command. This option is used for the
2456 commands like "[i" and "[d" |include-search|. The 'isident' option is
2457 used to recognize the defined name after the match:
2458 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2459 See |option-backslash| about inserting backslashes to include a space
2460 or backslash.
2461 The default value is for C programs. For C++ this value would be
2462 useful, to include const type declarations: >
2463 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002464< You can also use "\ze" just before the name and continue the pattern
2465 to check what is following. E.g. for Javascript, if a function is
2466 defined with "func_name = function(args)": >
2467 ^\s*\ze\i\+\s*=\s*function(
2468< If the function is defined with "func_name : function() {...": >
2469 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002470< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002471 To avoid that use `:let` with a single quote string: >
2472 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002473<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474
2475 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2476'delcombine' 'deco' boolean (default off)
2477 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478 If editing Unicode and this option is set, backspace and Normal mode
2479 "x" delete each combining character on its own. When it is off (the
2480 default) the character along with its combining characters are
2481 deleted.
2482 Note: When 'delcombine' is set "xx" may work different from "2x"!
2483
2484 This is useful for Arabic, Hebrew and many other languages where one
2485 may have combining characters overtop of base characters, and want
2486 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002487 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488
2489 *'dictionary'* *'dict'*
2490'dictionary' 'dict' string (default "")
2491 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002492 List of file names, separated by commas, that are used to lookup words
2493 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2494 contain a list of words. This can be one word per line, or several
2495 words per line, separated by non-keyword characters (white space is
2496 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002497
2498 When this option is empty or an entry "spell" is present, and spell
2499 checking is enabled, words in the word lists for the currently active
2500 'spelllang' are used. See |spell|.
2501
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002502 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002503 after a comma are ignored, otherwise spaces are included in the file
2504 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002505 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506 Where to find a list of words?
2507 - On FreeBSD, there is the file "/usr/share/dict/words".
2508 - In the Simtel archive, look in the "msdos/linguist" directory.
2509 - In "miscfiles" of the GNU collection.
2510 The use of |:set+=| and |:set-=| is preferred when adding or removing
2511 directories from the list. This avoids problems when a future version
2512 uses another default.
2513 Backticks cannot be used in this option for security reasons.
2514
2515 *'diff'* *'nodiff'*
2516'diff' boolean (default off)
2517 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518 {not available when compiled without the |+diff|
2519 feature}
2520 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002521 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522
2523 *'dex'* *'diffexpr'*
2524'diffexpr' 'dex' string (default "")
2525 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526 {not available when compiled without the |+diff|
2527 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002528 Expression which is evaluated to obtain a diff file (either ed-style
2529 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530 This option cannot be set from a |modeline| or in the |sandbox|, for
2531 security reasons.
2532
2533 *'dip'* *'diffopt'*
Bram Moolenaarc93262b2018-09-10 21:15:40 +02002534'diffopt' 'dip' string (default "internal,filler")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002536 {not available when compiled without the |+diff|
2537 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002538 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539 All are optional. Items must be separated by a comma.
2540
2541 filler Show filler lines, to keep the text
2542 synchronized with a window that has inserted
2543 lines at the same position. Mostly useful
2544 when windows are side-by-side and 'scrollbind'
2545 is set.
2546
2547 context:{n} Use a context of {n} lines between a change
2548 and a fold that contains unchanged lines.
2549 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002550 When using zero the context is actually one,
2551 since folds require a line in between, also
2552 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553 See |fold-diff|.
2554
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002555 iblank Ignore changes where lines are all blank. Adds
2556 the "-B" flag to the "diff" command if
2557 'diffexpr' is empty. Check the documentation
2558 of the "diff" command for what this does
2559 exactly.
2560 NOTE: the diff windows will get out of sync,
2561 because no differences between blank lines are
2562 taken into account.
2563
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 icase Ignore changes in case of text. "a" and "A"
2565 are considered the same. Adds the "-i" flag
2566 to the "diff" command if 'diffexpr' is empty.
2567
2568 iwhite Ignore changes in amount of white space. Adds
2569 the "-b" flag to the "diff" command if
2570 'diffexpr' is empty. Check the documentation
2571 of the "diff" command for what this does
2572 exactly. It should ignore adding trailing
2573 white space, but not leading white space.
2574
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002575 iwhiteall Ignore all white space changes. Adds
2576 the "-w" flag to the "diff" command if
2577 'diffexpr' is empty. Check the documentation
2578 of the "diff" command for what this does
2579 exactly.
2580
2581 iwhiteeol Ignore white space changes at end of line.
2582 Adds the "-Z" flag to the "diff" command if
2583 'diffexpr' is empty. Check the documentation
2584 of the "diff" command for what this does
2585 exactly.
2586
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002587 horizontal Start diff mode with horizontal splits (unless
2588 explicitly specified otherwise).
2589
2590 vertical Start diff mode with vertical splits (unless
2591 explicitly specified otherwise).
2592
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002593 hiddenoff Do not use diff mode for a buffer when it
2594 becomes hidden.
2595
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002596 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2597 starting diff mode. Without this 2 is used.
2598
Bram Moolenaare828b762018-09-10 17:51:58 +02002599 internal Use the internal diff library. This is
2600 ignored when 'diffexpr' is set. *E960*
2601 When running out of memory when writing a
2602 buffer this item will be ignored for diffs
2603 involving that buffer. Set the 'verbose'
2604 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605
Bram Moolenaare828b762018-09-10 17:51:58 +02002606 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002607 Use the indent heuristic for the internal
2608 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002609
2610 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002611 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002612 algorithms are:
2613 myers the default algorithm
2614 minimal spend extra time to generate the
2615 smallest possible diff
2616 patience patience diff algorithm
2617 histogram histogram diff algorithm
2618
2619 Examples: >
2620 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002621 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002622 :set diffopt=internal,filler,foldcolumn:3
2623 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624<
2625 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2626'digraph' 'dg' boolean (default off)
2627 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 {not available when compiled without the |+digraphs|
2629 feature}
2630 Enable the entering of digraphs in Insert mode with {char1} <BS>
2631 {char2}. See |digraphs|.
2632 NOTE: This option is reset when 'compatible' is set.
2633
2634 *'directory'* *'dir'*
2635'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002636 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 for Unix: ".,~/tmp,/var/tmp,/tmp")
2638 global
2639 List of directory names for the swap file, separated with commas.
2640 - The swap file will be created in the first directory where this is
2641 possible.
2642 - Empty means that no swap file will be used (recovery is
2643 impossible!).
2644 - A directory "." means to put the swap file in the same directory as
2645 the edited file. On Unix, a dot is prepended to the file name, so
2646 it doesn't show in a directory listing. On MS-Windows the "hidden"
2647 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002648 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002649 put the swap file relative to where the edited file is. The leading
2650 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002651 - For Unix and Win32, if a directory ends in two path separators "//",
2652 the swap file name will be built from the complete path to the file
2653 with all path separators substituted to percent '%' signs. This will
2654 ensure file name uniqueness in the preserve directory.
2655 On Win32, it is also possible to end with "\\". However, When a
2656 separating comma is following, you must use "//", since "\\" will
2657 include the comma in the file name. Therefore it is recommended to
2658 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659 - Spaces after the comma are ignored, other spaces are considered part
2660 of the directory name. To have a space at the start of a directory
2661 name, precede it with a backslash.
2662 - To include a comma in a directory name precede it with a backslash.
2663 - A directory name may end in an ':' or '/'.
2664 - Environment variables are expanded |:set_env|.
2665 - Careful with '\' characters, type one before a space, type two to
2666 get one in the option (see |option-backslash|), for example: >
2667 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2668< - For backwards compatibility with Vim version 3.0 a '>' at the start
2669 of the option is removed.
2670 Using "." first in the list is recommended. This means that editing
2671 the same file twice will result in a warning. Using "/tmp" on Unix is
2672 discouraged: When the system crashes you lose the swap file.
2673 "/var/tmp" is often not cleared when rebooting, thus is a better
2674 choice than "/tmp". But it can contain a lot of files, your swap
2675 files get lost in the crowd. That is why a "tmp" directory in your
2676 home directory is tried first.
2677 The use of |:set+=| and |:set-=| is preferred when adding or removing
2678 directories from the list. This avoids problems when a future version
2679 uses another default.
2680 This option cannot be set from a |modeline| or in the |sandbox|, for
2681 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682
2683 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002684'display' 'dy' string (default "", set to "truncate" in
2685 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 Change the way text is displayed. This is comma separated list of
2688 flags:
2689 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002690 in a window will be displayed. "@@@" is put in the
2691 last columns of the last screen line to indicate the
2692 rest of the line is not displayed.
2693 truncate Like "lastline", but "@@@" is displayed in the first
2694 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 uhex Show unprintable characters hexadecimal as <xx>
2696 instead of using ^C and ~C.
2697
Bram Moolenaard0796902016-09-16 20:02:31 +02002698 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002699 doesn't fit is replaced with "@" lines.
2700
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 *'eadirection'* *'ead'*
2702'eadirection' 'ead' string (default "both")
2703 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02002704 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 feature}
2706 Tells when the 'equalalways' option applies:
2707 ver vertically, width of windows is not affected
2708 hor horizontally, height of windows is not affected
2709 both width and height of windows is affected
2710
2711 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2712'edcompatible' 'ed' boolean (default off)
2713 global
2714 Makes the 'g' and 'c' flags of the ":substitute" command to be
2715 toggled each time the flag is given. See |complex-change|. See
2716 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002717 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718
Bram Moolenaar03413f42016-04-12 21:07:15 +02002719 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002720'emoji' 'emo' boolean (default: on)
2721 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002722 When on all Unicode emoji characters are considered to be full width.
2723
2724
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 *'encoding'* *'enc'* *E543*
2726'encoding' 'enc' string (default: "latin1" or value from $LANG)
2727 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728 Sets the character encoding used inside Vim. It applies to text in
2729 the buffers, registers, Strings in expressions, text stored in the
2730 viminfo file, etc. It sets the kind of characters which Vim can work
2731 with. See |encoding-names| for the possible values.
2732
2733 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002734 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002736 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737
Bram Moolenaar865242e2010-07-14 21:12:05 +02002738 This option cannot be set from a |modeline|. It would most likely
2739 corrupt the text.
2740
Bram Moolenaar3df01732017-02-17 22:47:16 +01002741 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2742 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743 'encoding', "utf-8" is the natural choice for the environment and
2744 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002745 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 versions, and to avoid changing the encoding of newly created files
2747 without your knowledge (in case 'fileencodings' is empty).
2748
2749 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002750 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 iconv() or as specified with 'charconvert'.
2752
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002753 If you need to know whether 'encoding' is a multi-byte encoding, you
2754 can use: >
2755 if has("multi_byte_encoding")
2756<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 Normally 'encoding' will be equal to your current locale. This will
2758 be the default if Vim recognizes your environment settings. If
2759 'encoding' is not set to the current locale, 'termencoding' must be
2760 set to convert typed and displayed text. See |encoding-table|.
2761
2762 When you set this option, it fires the |EncodingChanged| autocommand
2763 event so that you can set up fonts if necessary.
2764
2765 When the option is set, the value is converted to lowercase. Thus
2766 you can set it with uppercase values too. Underscores are translated
2767 to '-' signs.
2768 When the encoding is recognized, it is changed to the standard name.
2769 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2770 "iso-8859-2" and "utf8" becomes "utf-8".
2771
2772 Note: "latin1" is also used when the encoding could not be detected.
2773 This only works when editing files in the same encoding! When the
2774 actual character set is not latin1, make sure 'fileencoding' and
2775 'fileencodings' are empty. When conversion is needed, switch to using
2776 utf-8.
2777
2778 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2779 You don't notice this while editing, but it does matter for the
2780 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2781 setting 'encoding' to one of these values instead of utf-8 only has
2782 effect for encoding used for files when 'fileencoding' is empty.
2783
Bram Moolenaar661b1822005-07-28 22:36:45 +00002784 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2785 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786
2787 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2788'endofline' 'eol' boolean (default on)
2789 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002791 is on, or 'fixeol' option is off, no <EOL> will be written for the
2792 last line in the file. This option is automatically set or reset when
2793 starting to edit a new file, depending on whether file has an <EOL>
2794 for the last line in the file. Normally you don't have to set or
2795 reset this option.
2796 When 'binary' is off and 'fixeol' is on the value is not used when
2797 writing the file. When 'binary' is on or 'fixeol' is off it is used
2798 to remember the presence of a <EOL> for the last line in the file, so
2799 that when you write the file the situation from the original file can
2800 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801
2802 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2803'equalalways' 'ea' boolean (default on)
2804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002806 splitting or closing a window. This also happens the moment the
2807 option is switched on. When off, splitting a window will reduce the
2808 size of the current window and leave the other windows the same. When
2809 closing a window the extra lines are given to the window next to it
2810 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 When mixing vertically and horizontally split windows, a minimal size
2812 is computed and some windows may be larger if there is room. The
2813 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002814 Changing the height and width of a window can be avoided by setting
2815 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002816 If a window size is specified when creating a new window sizes are
2817 currently not equalized (it's complicated, but may be implemented in
2818 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819
2820 *'equalprg'* *'ep'*
2821'equalprg' 'ep' string (default "")
2822 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002824 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002825 or 'indentexpr'. When Vim was compiled without internal formatting,
2826 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002827 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 about including spaces and backslashes.
2829 This option cannot be set from a |modeline| or in the |sandbox|, for
2830 security reasons.
2831
2832 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2833'errorbells' 'eb' boolean (default off)
2834 global
2835 Ring the bell (beep or screen flash) for error messages. This only
2836 makes a difference for error messages, the bell will be used always
2837 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002838 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002839 screen flash or do nothing. See 'belloff' to finetune when to ring the
2840 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841
2842 *'errorfile'* *'ef'*
2843'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2844 others: "errors.err")
2845 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 {not available when compiled without the |+quickfix|
2847 feature}
2848 Name of the errorfile for the QuickFix mode (see |:cf|).
2849 When the "-q" command-line argument is used, 'errorfile' is set to the
2850 following argument. See |-q|.
2851 NOT used for the ":make" command. See 'makeef' for that.
2852 Environment variables are expanded |:set_env|.
2853 See |option-backslash| about including spaces and backslashes.
2854 This option cannot be set from a |modeline| or in the |sandbox|, for
2855 security reasons.
2856
2857 *'errorformat'* *'efm'*
2858'errorformat' 'efm' string (default is very long)
2859 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860 {not available when compiled without the |+quickfix|
2861 feature}
2862 Scanf-like description of the format for the lines in the error file
2863 (see |errorformat|).
2864
2865 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2866'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2867 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 Function keys that start with an <Esc> are recognized in Insert
2869 mode. When this option is off, the cursor and function keys cannot be
2870 used in Insert mode if they start with an <Esc>. The advantage of
2871 this is that the single <Esc> is recognized immediately, instead of
2872 after one second. Instead of resetting this option, you might want to
2873 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2874 when 'esckeys' is off, you can still map anything, but the cursor keys
2875 won't work by default.
2876 NOTE: This option is set to the Vi default value when 'compatible' is
2877 set and to the Vim default value when 'compatible' is reset.
2878
2879 *'eventignore'* *'ei'*
2880'eventignore' 'ei' string (default "")
2881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002883 When set to "all" or when "all" is one of the items, all autocommand
2884 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 Otherwise this is a comma separated list of event names. Example: >
2886 :set ei=WinEnter,WinLeave
2887<
2888 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2889'expandtab' 'et' boolean (default off)
2890 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002892 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2894 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002895 This option is reset when the 'paste' option is set and restored when
2896 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897 NOTE: This option is reset when 'compatible' is set.
2898
2899 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2900'exrc' 'ex' boolean (default off)
2901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002903 directory.
2904
2905 Setting this option is a potential security leak. E.g., consider
2906 unpacking a package or fetching files from github, a .vimrc in there
2907 might be a trojan horse. BETTER NOT SET THIS OPTION!
2908 Instead, define an autocommand in your .vimrc to set options for a
2909 matching directory.
2910
2911 If you do switch this option on you should also consider setting the
2912 'secure' option (see |initialization|).
2913 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 This option cannot be set from a |modeline| or in the |sandbox|, for
2915 security reasons.
2916
2917 *'fileencoding'* *'fenc'* *E213*
2918'fileencoding' 'fenc' string (default: "")
2919 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002921
Bram Moolenaar071d4272004-06-13 20:20:40 +00002922 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002923 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 When 'fileencoding' is empty, the same value as 'encoding' will be
2925 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002926 No error will be given when the value is set, only when it is used,
2927 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002928 Conversion will also be done when 'encoding' and 'fileencoding' are
2929 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2930 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002932 'encoding' is "utf-8" or another Unicode encoding, conversion
2933 is most likely done in a way that the reverse conversion
2934 results in the same text. When 'encoding' is not "utf-8" some
2935 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002936
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937 See 'encoding' for the possible values. Additionally, values may be
2938 specified that can be handled by the converter, see
2939 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002940
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 When reading a file 'fileencoding' will be set from 'fileencodings'.
2942 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002943 'fileencoding', use the |++enc| argument. One exception: when
2944 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002945 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002946
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2948 When the option is set, the value is converted to lowercase. Thus
2949 you can set it with uppercase values too. '_' characters are
2950 replaced with '-'. If a name is recognized from the list for
2951 'encoding', it is replaced by the standard name. For example
2952 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002953
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 When this option is set, after starting to edit a file, the 'modified'
2955 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002956
2957 Keep in mind that changing 'fenc' from a modeline happens
2958 AFTER the text has been read, thus it applies to when the file will be
2959 written. If you do set 'fenc' in a modeline, you might want to set
2960 'nomodified' to avoid not being able to ":q".
2961
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 This option can not be changed when 'modifiable' is off.
2963
2964 *'fe'*
2965 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002966 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 old short name was 'fe', which is no longer used.
2968
2969 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002970'fileencodings' 'fencs' string (default: "ucs-bom",
2971 "ucs-bom,utf-8,default,latin1" when
2972 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974 This is a list of character encodings considered when starting to edit
2975 an existing file. When a file is read, Vim tries to use the first
2976 mentioned character encoding. If an error is detected, the next one
2977 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002978 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 an empty string, which means the value of 'encoding' is used.
2980 WARNING: Conversion can cause loss of information! When
2981 'encoding' is "utf-8" (or one of the other Unicode variants)
2982 conversion is most likely done in a way that the reverse
2983 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002984 "utf-8" some non-ASCII characters may be lost! You can use
2985 the |++bad| argument to specify what is done with characters
2986 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 For an empty file or a file with only ASCII characters most encodings
2988 will work and the first entry of 'fileencodings' will be used (except
2989 "ucs-bom", which requires the BOM to be present). If you prefer
2990 another encoding use an BufReadPost autocommand event to test if your
2991 preferred encoding is to be used. Example: >
2992 au BufReadPost * if search('\S', 'w') == 0 |
2993 \ set fenc=iso-2022-jp | endif
2994< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2995 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002996 When the |++enc| argument is used then the value of 'fileencodings' is
2997 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002998 Note that 'fileencodings' is not used for a new file, the global value
2999 of 'fileencoding' is used instead. You can set it with: >
3000 :setglobal fenc=iso-8859-2
3001< This means that a non-existing file may get a different encoding than
3002 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 The special value "ucs-bom" can be used to check for a Unicode BOM
3004 (Byte Order Mark) at the start of the file. It must not be preceded
3005 by "utf-8" or another Unicode encoding for this to work properly.
3006 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3007 because Vim cannot detect an error, thus the encoding is always
3008 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003009 The special value "default" can be used for the encoding from the
3010 environment. This is the default value for 'encoding'. It is useful
3011 when 'encoding' is set to "utf-8" and your environment uses a
3012 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003013 When 'encoding' is "utf-8" and a file contains an illegal byte
3014 sequence it won't be recognized as UTF-8. You can use the |8g8|
3015 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 WRONG VALUES: WHAT'S WRONG:
3017 latin1,utf-8 "latin1" will always be used
3018 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3019 file
3020 cp1250,latin1 "cp1250" will always be used
3021 If 'fileencodings' is empty, 'fileencoding' is not modified.
3022 See 'fileencoding' for the possible values.
3023 Setting this option does not have an effect until the next time a file
3024 is read.
3025
3026 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003027'fileformat' 'ff' string (MS-Windows default: "dos",
3028 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 This gives the <EOL> of the current buffer, which is used for
3031 reading/writing the buffer from/to a file:
3032 dos <CR> <NL>
3033 unix <NL>
3034 mac <CR>
3035 When "dos" is used, CTRL-Z at the end of a file is ignored.
3036 See |file-formats| and |file-read|.
3037 For the character encoding of the file see 'fileencoding'.
3038 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003039 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 This option is set automatically when starting to edit a file and
3041 'fileformats' is not empty and 'binary' is off.
3042 When this option is set, after starting to edit a file, the 'modified'
3043 option is set, because the file would be different when written.
3044 This option can not be changed when 'modifiable' is off.
3045 For backwards compatibility: When this option is set to "dos",
3046 'textmode' is set, otherwise 'textmode' is reset.
3047
3048 *'fileformats'* *'ffs'*
3049'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003050 Vim+Vi MS-Windows: "dos,unix",
3051 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 Vi Cygwin: "unix,dos",
3053 Vi others: "")
3054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 This gives the end-of-line (<EOL>) formats that will be tried when
3056 starting to edit a new buffer and when reading a file into an existing
3057 buffer:
3058 - When empty, the format defined with 'fileformat' will be used
3059 always. It is not set automatically.
3060 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003061 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 'fileformats' name will be used when a file is read into an existing
3063 buffer, no matter what 'fileformat' for that buffer is set to.
3064 - When more than one name is present, separated by commas, automatic
3065 <EOL> detection will be done when reading a file. When starting to
3066 edit a file, a check is done for the <EOL>:
3067 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3068 'fileformat' is set to "dos".
3069 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003070 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003072 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3073 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003074 This means that "mac" is only chosen when:
3075 "unix" is not present or no <NL> is found in the file, and
3076 "dos" is not present or no <CR><NL> is found in the file.
3077 Except: if "unix" was chosen, but there is a <CR> before
3078 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003079 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 4. If 'fileformat' is still not set, the first name from
3081 'fileformats' is used.
3082 When reading a file into an existing buffer, the same is done, but
3083 this happens like 'fileformat' has been set appropriately for that
3084 file only, the option is not changed.
3085 When 'binary' is set, the value of 'fileformats' is not used.
3086
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003087 When Vim starts up with an empty buffer the first item is used. You
3088 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003089
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3091 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3092 done:
3093 - When 'fileformats' is empty, there is no automatic detection. Dos
3094 format will be used.
3095 - When 'fileformats' is set to one or more names, automatic detection
3096 is done. This is based on the first <NL> in the file: If there is a
3097 <CR> in front of it, Dos format is used, otherwise Unix format is
3098 used.
3099 Also see |file-formats|.
3100 For backwards compatibility: When this option is set to an empty
3101 string or one format (no comma is included), 'textauto' is reset,
3102 otherwise 'textauto' is set.
3103 NOTE: This option is set to the Vi default value when 'compatible' is
3104 set and to the Vim default value when 'compatible' is reset.
3105
Bram Moolenaarbf884932013-04-05 22:26:15 +02003106 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3107'fileignorecase' 'fic' boolean (default on for systems where case in file
3108 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003109 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003110 When set case is ignored when using file names and directories.
3111 See 'wildignorecase' for only ignoring case when doing completion.
3112
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 *'filetype'* *'ft'*
3114'filetype' 'ft' string (default: "")
3115 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 When this option is set, the FileType autocommand event is triggered.
3117 All autocommands that match with the value of this option will be
3118 executed. Thus the value of 'filetype' is used in place of the file
3119 name.
3120 Otherwise this option does not always reflect the current file type.
3121 This option is normally set when the file type is detected. To enable
3122 this use the ":filetype on" command. |:filetype|
3123 Setting this option to a different value is most useful in a modeline,
3124 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003125 Example, for in an IDL file:
3126 /* vim: set filetype=idl : */ ~
3127 |FileType| |filetypes|
3128 When a dot appears in the value then this separates two filetype
3129 names. Example:
3130 /* vim: set filetype=c.doxygen : */ ~
3131 This will use the "c" filetype first, then the "doxygen" filetype.
3132 This works both for filetype plugins and for syntax files. More than
3133 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 This option is not copied to another buffer, independent of the 's' or
3135 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003136 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137
3138 *'fillchars'* *'fcs'*
3139'fillchars' 'fcs' string (default "vert:|,fold:-")
3140 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 {not available when compiled without the |+windows|
3142 and |+folding| features}
3143 Characters to fill the statuslines and vertical separators.
3144 It is a comma separated list of items:
3145
3146 item default Used for ~
3147 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003148 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149 vert:c '|' vertical separators |:vsplit|
3150 fold:c '-' filling 'foldtext'
3151 diff:c '-' deleted lines of the 'diff' option
3152
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003153 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003154 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155 otherwise.
3156
3157 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003158 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159< This is similar to the default, except that these characters will also
3160 be used when there is highlighting.
3161
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003162 for "stl" and "stlnc" only single-byte values are supported.
3163
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 The highlighting used for these items:
3165 item highlight group ~
3166 stl:c StatusLine |hl-StatusLine|
3167 stlnc:c StatusLineNC |hl-StatusLineNC|
3168 vert:c VertSplit |hl-VertSplit|
3169 fold:c Folded |hl-Folded|
3170 diff:c DiffDelete |hl-DiffDelete|
3171
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003172 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3173'fixendofline' 'fixeol' boolean (default on)
3174 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003175 When writing a file and this option is on, <EOL> at the end of file
3176 will be restored if missing. Turn this option off if you want to
3177 preserve the situation from the original file.
3178 When the 'binary' option is set the value of this option doesn't
3179 matter.
3180 See the 'endofline' option.
3181
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3183'fkmap' 'fk' boolean (default off) *E198*
3184 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 {only available when compiled with the |+rightleft|
3186 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003187 This option was for using Farsi, which has been removed. See
3188 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189
3190 *'foldclose'* *'fcl'*
3191'foldclose' 'fcl' string (default "")
3192 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 {not available when compiled without the |+folding|
3194 feature}
3195 When set to "all", a fold is closed when the cursor isn't in it and
3196 its level is higher than 'foldlevel'. Useful if you want folds to
3197 automatically close when moving out of them.
3198
3199 *'foldcolumn'* *'fdc'*
3200'foldcolumn' 'fdc' number (default 0)
3201 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 {not available when compiled without the |+folding|
3203 feature}
3204 When non-zero, a column with the specified width is shown at the side
3205 of the window which indicates open and closed folds. The maximum
3206 value is 12.
3207 See |folding|.
3208
3209 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3210'foldenable' 'fen' boolean (default on)
3211 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 {not available when compiled without the |+folding|
3213 feature}
3214 When off, all folds are open. This option can be used to quickly
3215 switch between showing all text unfolded and viewing the text with
3216 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003217 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 'foldenable' is off.
3219 This option is set by commands that create a new fold or close a fold.
3220 See |folding|.
3221
3222 *'foldexpr'* *'fde'*
3223'foldexpr' 'fde' string (default: "0")
3224 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003226 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003228 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003229
Bram Moolenaar30b65812012-07-12 22:01:11 +02003230 The expression will be evaluated in the |sandbox| if set from a
3231 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003232 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003233 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003234
3235 It is not allowed to change text or jump to another window while
3236 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237
3238 *'foldignore'* *'fdi'*
3239'foldignore' 'fdi' string (default: "#")
3240 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 {not available when compiled without the |+folding|
3242 feature}
3243 Used only when 'foldmethod' is "indent". Lines starting with
3244 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003245 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 The default "#" works well for C programs. See |fold-indent|.
3247
3248 *'foldlevel'* *'fdl'*
3249'foldlevel' 'fdl' number (default: 0)
3250 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003251 {not available when compiled without the |+folding|
3252 feature}
3253 Sets the fold level: Folds with a higher level will be closed.
3254 Setting this option to zero will close all folds. Higher numbers will
3255 close fewer folds.
3256 This option is set by commands like |zm|, |zM| and |zR|.
3257 See |fold-foldlevel|.
3258
3259 *'foldlevelstart'* *'fdls'*
3260'foldlevelstart' 'fdls' number (default: -1)
3261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262 {not available when compiled without the |+folding|
3263 feature}
3264 Sets 'foldlevel' when starting to edit another buffer in a window.
3265 Useful to always start editing with all folds closed (value zero),
3266 some folds closed (one) or no folds closed (99).
3267 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003268 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 ignores this option and closes all folds.
3270 It is also done before BufReadPre autocommands, to allow an autocmd to
3271 overrule the 'foldlevel' value for specific files.
3272 When the value is negative, it is not used.
3273
3274 *'foldmarker'* *'fmr'* *E536*
3275'foldmarker' 'fmr' string (default: "{{{,}}}")
3276 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277 {not available when compiled without the |+folding|
3278 feature}
3279 The start and end marker used when 'foldmethod' is "marker". There
3280 must be one comma, which separates the start and end marker. The
3281 marker is a literal string (a regular expression would be too slow).
3282 See |fold-marker|.
3283
3284 *'foldmethod'* *'fdm'*
3285'foldmethod' 'fdm' string (default: "manual")
3286 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287 {not available when compiled without the |+folding|
3288 feature}
3289 The kind of folding used for the current window. Possible values:
3290 |fold-manual| manual Folds are created manually.
3291 |fold-indent| indent Lines with equal indent form a fold.
3292 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3293 |fold-marker| marker Markers are used to specify folds.
3294 |fold-syntax| syntax Syntax highlighting items specify folds.
3295 |fold-diff| diff Fold text that is not changed.
3296
3297 *'foldminlines'* *'fml'*
3298'foldminlines' 'fml' number (default: 1)
3299 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 {not available when compiled without the |+folding|
3301 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003302 Sets the number of screen lines above which a fold can be displayed
3303 closed. Also for manually closed folds. With the default value of
3304 one a fold can only be closed if it takes up two or more screen lines.
3305 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003306 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 "zc" to close a fold, which is displayed open because it's smaller
3308 than 'foldminlines', a following "zc" may close a containing fold.
3309
3310 *'foldnestmax'* *'fdn'*
3311'foldnestmax' 'fdn' number (default: 20)
3312 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 {not available when compiled without the |+folding|
3314 feature}
3315 Sets the maximum nesting of folds for the "indent" and "syntax"
3316 methods. This avoids that too many folds will be created. Using more
3317 than 20 doesn't work, because the internal limit is 20.
3318
3319 *'foldopen'* *'fdo'*
3320'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3321 search,tag,undo")
3322 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 {not available when compiled without the |+folding|
3324 feature}
3325 Specifies for which type of commands folds will be opened, if the
3326 command moves the cursor into a closed fold. It is a comma separated
3327 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003328 NOTE: When the command is part of a mapping this option is not used.
3329 Add the |zv| command to the mapping to get the same effect.
3330 (rationale: the mapping may want to control opening folds itself)
3331
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 item commands ~
3333 all any
3334 block "(", "{", "[[", "[{", etc.
3335 hor horizontal movements: "l", "w", "fx", etc.
3336 insert any command in Insert mode
3337 jump far jumps: "G", "gg", etc.
3338 mark jumping to a mark: "'m", CTRL-O, etc.
3339 percent "%"
3340 quickfix ":cn", ":crew", ":make", etc.
3341 search search for a pattern: "/", "n", "*", "gd", etc.
3342 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003343 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 tag jumping to a tag: ":ta", CTRL-T, etc.
3345 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346 When a movement command is used for an operator (e.g., "dl" or "y%")
3347 this option is not used. This means the operator will include the
3348 whole closed fold.
3349 Note that vertical movements are not here, because it would make it
3350 very difficult to move onto a closed fold.
3351 In insert mode the folds containing the cursor will always be open
3352 when text is inserted.
3353 To close folds you can re-apply 'foldlevel' with the |zx| command or
3354 set the 'foldclose' option to "all".
3355
3356 *'foldtext'* *'fdt'*
3357'foldtext' 'fdt' string (default: "foldtext()")
3358 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359 {not available when compiled without the |+folding|
3360 feature}
3361 An expression which is used to specify the text displayed for a closed
3362 fold. See |fold-foldtext|.
3363
Bram Moolenaar30b65812012-07-12 22:01:11 +02003364 The expression will be evaluated in the |sandbox| if set from a
3365 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003366 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003367
3368 It is not allowed to change text or jump to another window while
3369 evaluating 'foldtext' |textlock|.
3370
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003371 *'formatexpr'* *'fex'*
3372'formatexpr' 'fex' string (default "")
3373 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003374 {not available when compiled without the |+eval|
3375 feature}
3376 Expression which is evaluated to format a range of lines for the |gq|
3377 operator or automatic formatting (see 'formatoptions'). When this
3378 option is empty 'formatprg' is used.
3379
3380 The |v:lnum| variable holds the first line to be formatted.
3381 The |v:count| variable holds the number of lines to be formatted.
3382 The |v:char| variable holds the character that is going to be
3383 inserted if the expression is being evaluated due to
3384 automatic formatting. This can be empty. Don't insert
3385 it yet!
3386
3387 Example: >
3388 :set formatexpr=mylang#Format()
3389< This will invoke the mylang#Format() function in the
3390 autoload/mylang.vim file in 'runtimepath'. |autoload|
3391
3392 The expression is also evaluated when 'textwidth' is set and adding
3393 text beyond that limit. This happens under the same conditions as
3394 when internal formatting is used. Make sure the cursor is kept in the
3395 same spot relative to the text then! The |mode()| function will
3396 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003397
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003398 When the expression evaluates to non-zero Vim will fall back to using
3399 the internal format mechanism.
3400
3401 The expression will be evaluated in the |sandbox| when set from a
3402 modeline, see |sandbox-option|. That stops the option from working,
3403 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003404 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003405 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003406
Bram Moolenaar86b68352004-12-27 21:59:20 +00003407 *'formatlistpat'* *'flp'*
3408'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3409 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003410 A pattern that is used to recognize a list header. This is used for
3411 the "n" flag in 'formatoptions'.
3412 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003413 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003414 while still checking more characters. There must be a character
3415 following the pattern, when it matches the whole line it is handled
3416 like there is no match.
3417 The default recognizes a number, followed by an optional punctuation
3418 character and white space.
3419
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003420 *'formatoptions'* *'fo'*
3421'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3422 local to buffer
3423 This is a sequence of letters which describes how automatic
3424 formatting is to be done. See |fo-table|. When the 'paste' option is
3425 on, no formatting is done (like 'formatoptions' is empty). Commas can
3426 be inserted for readability.
3427 To avoid problems with flags that are added in the future, use the
3428 "+=" and "-=" feature of ":set" |add-option-flags|.
3429 NOTE: This option is set to the Vi default value when 'compatible' is
3430 set and to the Vim default value when 'compatible' is reset.
3431
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 *'formatprg'* *'fp'*
3433'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003434 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003436 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003438 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003439 If the 'formatexpr' option is not empty it will be used instead.
3440 Otherwise, if 'formatprg' option is an empty string, the internal
3441 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003442 Environment variables are expanded |:set_env|. See |option-backslash|
3443 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003444 This option cannot be set from a |modeline| or in the |sandbox|, for
3445 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446
Bram Moolenaard94464e2015-11-02 15:28:18 +01003447 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003448'fsync' 'fs' boolean (default on)
3449 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003450 When on, the library function fsync() will be called after writing a
3451 file. This will flush a file to disk, ensuring that it is safely
3452 written even on filesystems which do metadata-only journaling. This
3453 will force the harddrive to spin up on Linux systems running in laptop
3454 mode, so it may be undesirable in some situations. Be warned that
3455 turning this off increases the chances of data loss after a crash. On
3456 systems without an fsync() implementation, this variable is always
3457 off.
3458 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003459 'fsync' also applies to |writefile()|, unless a flag is used to
3460 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003461 This option cannot be set from a |modeline| or in the |sandbox|, for
3462 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003463
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3465'gdefault' 'gd' boolean (default off)
3466 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 When on, the ":substitute" flag 'g' is default on. This means that
3468 all matches in a line are substituted instead of one. When a 'g' flag
3469 is given to a ":substitute" command, this will toggle the substitution
3470 of all or one match. See |complex-change|.
3471
3472 command 'gdefault' on 'gdefault' off ~
3473 :s/// subst. all subst. one
3474 :s///g subst. one subst. all
3475 :s///gg subst. all subst. one
3476
3477 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003478 DEPRECATED: Setting this option may break plugins that are not aware
3479 of this option. Also, many users get confused that adding the /g flag
3480 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481
3482 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003483'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 Format to recognize for the ":grep" command output.
3486 This is a scanf-like string that uses the same format as the
3487 'errorformat' option: see |errorformat|.
3488
3489 *'grepprg'* *'gp'*
3490'grepprg' 'gp' string (default "grep -n ",
3491 Unix: "grep -n $* /dev/null",
3492 Win32: "findstr /n" or "grep -n",
3493 VMS: "SEARCH/NUMBERS ")
3494 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003495 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 and '#' characters, which are expanded like when used in a command-
3497 line. The placeholder "$*" is allowed to specify where the arguments
3498 will be included. Environment variables are expanded |:set_env|. See
3499 |option-backslash| about including spaces and backslashes.
3500 When your "grep" accepts the "-H" argument, use this to make ":grep"
3501 also work well with a single file: >
3502 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003503< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003504 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3505 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003506 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507 apply equally to 'grepprg'.
3508 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3509 otherwise it's "grep -n".
3510 This option cannot be set from a |modeline| or in the |sandbox|, for
3511 security reasons.
3512
3513 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3514'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3515 ve:ver35-Cursor,
3516 o:hor50-Cursor,
3517 i-ci:ver25-Cursor/lCursor,
3518 r-cr:hor20-Cursor/lCursor,
3519 sm:block-Cursor
3520 -blinkwait175-blinkoff150-blinkon175",
3521 for MS-DOS and Win32 console:
3522 "n-v-c:block,o:hor50,i-ci:hor15,
3523 r-cr:hor30,sm:block")
3524 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 {only available when compiled with GUI enabled, and
3526 for MS-DOS and Win32 console}
3527 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003528 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 the height of the cursor can be changed. This can be done by
3530 specifying a block cursor, or a percentage for a vertical or
3531 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003532 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3533 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003535 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 mode-list and an argument-list:
3537 mode-list:argument-list,mode-list:argument-list,..
3538 The mode-list is a dash separated list of these modes:
3539 n Normal mode
3540 v Visual mode
3541 ve Visual mode with 'selection' "exclusive" (same as 'v',
3542 if not specified)
3543 o Operator-pending mode
3544 i Insert mode
3545 r Replace mode
3546 c Command-line Normal (append) mode
3547 ci Command-line Insert mode
3548 cr Command-line Replace mode
3549 sm showmatch in Insert mode
3550 a all modes
3551 The argument-list is a dash separated list of these arguments:
3552 hor{N} horizontal bar, {N} percent of the character height
3553 ver{N} vertical bar, {N} percent of the character width
3554 block block cursor, fills the whole character
3555 [only one of the above three should be present]
3556 blinkwait{N} *cursor-blinking*
3557 blinkon{N}
3558 blinkoff{N}
3559 blink times for cursor: blinkwait is the delay before
3560 the cursor starts blinking, blinkon is the time that
3561 the cursor is shown and blinkoff is the time that the
3562 cursor is not shown. The times are in msec. When one
3563 of the numbers is zero, there is no blinking. The
3564 default is: "blinkwait700-blinkon400-blinkoff250".
3565 These numbers are used for a missing entry. This
3566 means that blinking is enabled by default. To switch
3567 blinking off you can use "blinkon0". The cursor only
3568 blinks when Vim is waiting for input, not while
3569 executing a command.
3570 To make the cursor blink in an xterm, see
3571 |xterm-blink|.
3572 {group-name}
3573 a highlight group name, that sets the color and font
3574 for the cursor
3575 {group-name}/{group-name}
3576 Two highlight group names, the first is used when
3577 no language mappings are used, the other when they
3578 are. |language-mapping|
3579
3580 Examples of parts:
3581 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3582 block cursor with colors from the "nCursor"
3583 highlight group
3584 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3585 In Insert and Command-line Insert mode, use a
3586 30% vertical bar cursor with colors from the
3587 "iCursor" highlight group. Blink a bit
3588 faster.
3589
3590 The 'a' mode is different. It will set the given argument-list for
3591 all modes. It does not reset anything to defaults. This can be used
3592 to do a common setting for all modes. For example, to switch off
3593 blinking: "a:blinkon0"
3594
3595 Examples of cursor highlighting: >
3596 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3597 :highlight Cursor gui=NONE guifg=bg guibg=fg
3598<
3599 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003600 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601'guifont' 'gfn' string (default "")
3602 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 {only available when compiled with GUI enabled}
3604 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003605 In its simplest form the value is just one font name.
3606 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607
3608 *'guifontset'* *'gfs'*
3609 *E250* *E252* *E234* *E597* *E598*
3610'guifontset' 'gfs' string (default "")
3611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 {only available when compiled with GUI enabled and
3613 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003614 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 When not empty, specifies two (or more) fonts to be used. The first
3616 one for normal English, the second one for your special language. See
3617 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003618
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3620'guifontwide' 'gfw' string (default "")
3621 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 {only available when compiled with GUI enabled}
3623 When not empty, specifies a comma-separated list of fonts to be used
3624 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003625 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003626
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 *'guiheadroom'* *'ghr'*
3628'guiheadroom' 'ghr' number (default 50)
3629 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003630 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 The number of pixels subtracted from the screen height when fitting
3632 the GUI window on the screen. Set this before the GUI is started,
3633 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003634 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 lines will be left for window decorations and other items on the
3636 screen. Set it to a negative value to allow windows taller than the
3637 screen.
3638
3639 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003640'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3641 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003642 "aegimrLtT" (GTK, Motif and Athena),
3643 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003646 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 sequence of letters which describes what components and options of the
3648 GUI should be used.
3649 To avoid problems with flags that are added in the future, use the
3650 "+=" and "-=" feature of ":set" |add-option-flags|.
3651
Bram Moolenaar13568252018-03-16 20:46:58 +01003652 Valid characters are as follows:
3653 *'go-!'*
3654 '!' External commands are executed in a terminal window. Without
3655 this flag the MS-Windows GUI will open a console window to
3656 execute the command. The Unix GUI will simulate a dumb
3657 terminal to list the command output.
3658 The terminal window will be positioned at the bottom, and grow
3659 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003660 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 'a' Autoselect: If present, then whenever VISUAL mode is started,
3662 or the Visual area extended, Vim tries to become the owner of
3663 the windowing system's global selection. This means that the
3664 Visually highlighted text is available for pasting into other
3665 applications as well as into Vim itself. When the Visual mode
3666 ends, possibly due to an operation on the text, or when an
3667 application wants to paste the selection, the highlighted text
3668 is automatically yanked into the "* selection register.
3669 Thus the selection is still available for pasting into other
3670 applications after the VISUAL mode has ended.
3671 If not present, then Vim won't become the owner of the
3672 windowing system's global selection unless explicitly told to
3673 by a yank or delete operation for the "* register.
3674 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003675 *'go-P'*
3676 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003677 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003678 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003679 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 applies to the modeless selection.
3681
3682 'guioptions' autoselect Visual autoselect modeless ~
3683 "" - -
3684 "a" yes yes
3685 "A" - yes
3686 "aA" yes yes
3687
Bram Moolenaar02467872007-05-06 13:22:01 +00003688 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 'c' Use console dialogs instead of popup dialogs for simple
3690 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003691 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003692 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003693 'guitablabel' can be used to change the text in the labels.
3694 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003695 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003696 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003697 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 'f' Foreground: Don't use fork() to detach the GUI from the shell
3699 where it was started. Use this for programs that wait for the
3700 editor to finish (e.g., an e-mail program). Alternatively you
3701 can use "gvim -f" or ":gui -f" to start the GUI in the
3702 foreground. |gui-fork|
3703 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003704 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003705 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3707 corner of the window. It's black&white on non-GTK, because of
3708 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003709 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003711 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003712 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003714 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003716 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003717 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718 'g' Grey menu items: Make menu items that are not active grey. If
3719 'g' is not included inactive menu items are not shown at all.
3720 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003721 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 't' Include tearoff menu items. Currently only works for Win32,
3723 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003724 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003725 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003726 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003727 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003729 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 'R' Right-hand scrollbar is present when there is a vertically
3731 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003732 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003734 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 'L' Left-hand scrollbar is present when there is a vertically
3736 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003737 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3739 the longest visible line, or on the cursor line if the 'h'
3740 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003741 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 'h' Limit horizontal scrollbar size to the length of the cursor
3743 line. Reduces computations. |gui-horiz-scroll|
3744
3745 And yes, you may even have scrollbars on the left AND the right if
3746 you really want to :-). See |gui-scrollbars| for more information.
3747
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003748 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749 'v' Use a vertical button layout for dialogs. When not included,
3750 a horizontal layout is preferred, but when it doesn't fit a
3751 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003752 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 'p' Use Pointer callbacks for X11 GUI. This is required for some
3754 window managers. If the cursor is not blinking or hollow at
3755 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003756 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003758 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003759 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003760 *'go-k'*
3761 'k' Keep the GUI window size when adding/removing a scrollbar, or
3762 toolbar, tabline, etc. Instead, the behavior is similar to
3763 when the window is maximized and will adjust 'lines' and
3764 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003765 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003766 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003767
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 *'guipty'* *'noguipty'*
3769'guipty' boolean (default on)
3770 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 {only available when compiled with GUI enabled}
3772 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3773 I/O to/from shell commands. See |gui-pty|.
3774
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003775 *'guitablabel'* *'gtl'*
3776'guitablabel' 'gtl' string (default empty)
3777 global
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003778 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003779 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003780 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003781 pages line. When empty and when the result is empty Vim will use a
3782 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003783
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003784 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003785 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003786 The expression will be evaluated in the |sandbox| when set from a
3787 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003788 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003789
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003790 Only used when the GUI tab pages line is displayed. 'e' must be
3791 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3792 used.
3793
Bram Moolenaar57657d82006-04-21 22:12:41 +00003794 *'guitabtooltip'* *'gtt'*
3795'guitabtooltip' 'gtt' string (default empty)
3796 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00003797 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003798 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003799 When nonempty describes the text to use in a tooltip for the GUI tab
3800 pages line. When empty Vim will use a default tooltip.
3801 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003802 You can include a line break. Simplest method is to use |:let|: >
3803 :let &guitabtooltip = "line one\nline two"
3804<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003805
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 *'helpfile'* *'hf'*
3807'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3808 (others) "$VIMRUNTIME/doc/help.txt")
3809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 Name of the main help file. All distributed help files should be
3811 placed together in one directory. Additionally, all "doc" directories
3812 in 'runtimepath' will be used.
3813 Environment variables are expanded |:set_env|. For example:
3814 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003815 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 spaces and backslashes.
3817 This option cannot be set from a |modeline| or in the |sandbox|, for
3818 security reasons.
3819
3820 *'helpheight'* *'hh'*
3821'helpheight' 'hh' number (default 20)
3822 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02003823 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 feature}
3825 Minimal initial height of the help window when it is opened with the
3826 ":help" command. The initial height of the help window is half of the
3827 current window, or (when the 'ea' option is on) the same as other
3828 windows. When the height is less than 'helpheight', the height is
3829 set to 'helpheight'. Set to zero to disable.
3830
3831 *'helplang'* *'hlg'*
3832'helplang' 'hlg' string (default: messages language or empty)
3833 global
3834 {only available when compiled with the |+multi_lang|
3835 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 Comma separated list of languages. Vim will use the first language
3837 for which the desired help can be found. The English help will always
3838 be used as a last resort. You can add "en" to prefer English over
3839 another language, but that will only find tags that exist in that
3840 language and not in the English help.
3841 Example: >
3842 :set helplang=de,it
3843< This will first search German, then Italian and finally English help
3844 files.
3845 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3846 try to find the tag in the current language before using this option.
3847 See |help-translated|.
3848
3849 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3850'hidden' 'hid' boolean (default off)
3851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852 When off a buffer is unloaded when it is |abandon|ed. When on a
3853 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3854 displayed in another window, it does not become hidden, of course.
3855 The commands that move through the buffer list sometimes make a buffer
3856 hidden although the 'hidden' option is off: When the buffer is
3857 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003858 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003859 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 This option is set for one command with ":hide {command}" |:hide|.
3861 WARNING: It's easy to forget that you have changes in hidden buffers.
3862 Think twice when using ":q!" or ":qa!".
3863
3864 *'highlight'* *'hl'*
3865'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003866 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3867 d:Directory,e:ErrorMsg,i:IncSearch,
3868 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
3869 N:CursorLineNr,r:Question,s:StatusLine,
3870 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003871 v:Visual,V:VisualNOS,w:WarningMsg,
3872 W:WildMenu,f:Folded,F:FoldColumn,
3873 A:DiffAdd,C:DiffChange,D:DiffDelete,
3874 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003875 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003876 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003877 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3878 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003879 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003880 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 This option can be used to set highlighting mode for various
3883 occasions. It is a comma separated list of character pairs. The
3884 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003885 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003887 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3888 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 characters from 'showbreak'
3890 |hl-Directory| d directories in CTRL-D listing and other special
3891 things in listings
3892 |hl-ErrorMsg| e error messages
3893 h (obsolete, ignored)
3894 |hl-IncSearch| i 'incsearch' highlighting
3895 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3896 |hl-MoreMsg| m |more-prompt|
3897 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003898 |hl-LineNr| n line number for ":number" and ":#" commands, and
3899 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003900 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3901 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 |hl-Question| r |hit-enter| prompt and yes/no questions
3903 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003904 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3906 |hl-VertSplit| c column used to separate vertically split windows
3907 |hl-Visual| v Visual mode
3908 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3909 Selection" Only X11 Gui's |gui-x11| and
3910 |xterm-clipboard|.
3911 |hl-WarningMsg| w warning messages
3912 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3913 |hl-Folded| f line used for closed folds
3914 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003915 |hl-DiffAdd| A added line in diff mode
3916 |hl-DiffChange| C changed line in diff mode
3917 |hl-DiffDelete| D deleted line in diff mode
3918 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003920 |hl-Conceal| - the placeholders used for concealed characters
3921 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003922 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003923 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003924 |hl-SpellRare| R rare word |spell|
3925 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003926 |hl-Pmenu| + popup menu normal line
3927 |hl-PmenuSel| = popup menu selected line
3928 |hl-PmenuSbar| x popup menu scrollbar
3929 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930
3931 The display modes are:
3932 r reverse (termcap entry "mr" and "me")
3933 i italic (termcap entry "ZH" and "ZR")
3934 b bold (termcap entry "md" and "me")
3935 s standout (termcap entry "so" and "se")
3936 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003937 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02003938 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 n no highlighting
3940 - no highlighting
3941 : use a highlight group
3942 The default is used for occasions that are not included.
3943 If you want to change what the display modes do, see |dos-colors|
3944 for an example.
3945 When using the ':' display mode, this must be followed by the name of
3946 a highlight group. A highlight group can be used to define any type
3947 of highlighting, including using color. See |:highlight| on how to
3948 define one. The default uses a different group for each occasion.
3949 See |highlight-default| for the default highlight groups.
3950
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003952'history' 'hi' number (Vim default: 50, Vi default: 0,
3953 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003956 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003958 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 NOTE: This option is set to the Vi default value when 'compatible' is
3960 set and to the Vim default value when 'compatible' is reset.
3961
3962 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3963'hkmap' 'hk' boolean (default off)
3964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 {only available when compiled with the |+rightleft|
3966 feature}
3967 When on, the keyboard is mapped for the Hebrew character set.
3968 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3969 toggle this option. See |rileft.txt|.
3970 NOTE: This option is reset when 'compatible' is set.
3971
3972 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3973'hkmapp' 'hkp' boolean (default off)
3974 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 {only available when compiled with the |+rightleft|
3976 feature}
3977 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3978 This is useful if you have a non-Hebrew keyboard.
3979 See |rileft.txt|.
3980 NOTE: This option is reset when 'compatible' is set.
3981
Bram Moolenaar036986f2017-03-16 17:41:02 +01003982 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3983'hlsearch' 'hls' boolean (default off)
3984 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01003985 {not available when compiled without the
3986 |+extra_search| feature}
3987 When there is a previous search pattern, highlight all its matches.
3988 The type of highlighting used can be set with the 'l' occasion in the
3989 'highlight' option. This uses the "Search" highlight group by
3990 default. Note that only the matching text is highlighted, any offsets
3991 are not applied.
3992 See also: 'incsearch' and |:match|.
3993 When you get bored looking at the highlighted matches, you can turn it
3994 off with |:nohlsearch|. This does not change the option value, as
3995 soon as you use a search command, the highlighting comes back.
3996 'redrawtime' specifies the maximum time spent on finding matches.
3997 When the search pattern can match an end-of-line, Vim will try to
3998 highlight all of the matched text. However, this depends on where the
3999 search starts. This will be the first line in the window or the first
4000 line below a closed fold. A match in a previous line which is not
4001 drawn may not continue in a newly drawn line.
4002 You can specify whether the highlight status is restored on startup
4003 with the 'h' flag in 'viminfo' |viminfo-h|.
4004 NOTE: This option is reset when 'compatible' is set.
4005
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 *'icon'* *'noicon'*
4007'icon' boolean (default off, on when title can be restored)
4008 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 {not available when compiled without the |+title|
4010 feature}
4011 When on, the icon text of the window will be set to the value of
4012 'iconstring' (if it is not empty), or to the name of the file
4013 currently being edited. Only the last part of the name is used.
4014 Overridden by the 'iconstring' option.
4015 Only works if the terminal supports setting window icons (currently
4016 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4017 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4018 builtin termcap).
4019 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004020 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004022 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023
4024 *'iconstring'*
4025'iconstring' string (default "")
4026 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 {not available when compiled without the |+title|
4028 feature}
4029 When this option is not empty, it will be used for the icon text of
4030 the window. This happens only when the 'icon' option is on.
4031 Only works if the terminal supports setting window icon text
4032 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4033 Does not work for MS Windows.
4034 When Vim was compiled with HAVE_X11 defined, the original icon will be
4035 restored if possible |X11|.
4036 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004037 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004039 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 {not available when compiled without the |+statusline| feature}
4041
4042 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4043'ignorecase' 'ic' boolean (default off)
4044 global
4045 Ignore case in search patterns. Also used when searching in the tags
4046 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004047 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 Can be overruled by using "\c" or "\C" in the pattern, see
4049 |/ignorecase|.
4050
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004051 *'imactivatefunc'* *'imaf'*
4052'imactivatefunc' 'imaf' string (default "")
4053 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004054 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004055 activate or deactivate the Input Method.
4056 It is not used in the GUI.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004057 The expression will be evaluated in the |sandbox| when set from a
4058 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004059
4060 Example: >
4061 function ImActivateFunc(active)
4062 if a:active
4063 ... do something
4064 else
4065 ... do something
4066 endif
4067 " return value is not used
4068 endfunction
4069 set imactivatefunc=ImActivateFunc
4070<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 *'imactivatekey'* *'imak'*
4072'imactivatekey' 'imak' string (default "")
4073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004075 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076 Specifies the key that your Input Method in X-Windows uses for
4077 activation. When this is specified correctly, vim can fully control
4078 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4079 You can't use this option to change the activation key, the option
4080 tells Vim what the key is.
4081 Format:
4082 [MODIFIER_FLAG-]KEY_STRING
4083
4084 These characters can be used for MODIFIER_FLAG (case is ignored):
4085 S Shift key
4086 L Lock key
4087 C Control key
4088 1 Mod1 key
4089 2 Mod2 key
4090 3 Mod3 key
4091 4 Mod4 key
4092 5 Mod5 key
4093 Combinations are allowed, for example "S-C-space" or "SC-space" are
4094 both shift+ctrl+space.
4095 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4096
4097 Example: >
4098 :set imactivatekey=S-space
4099< "S-space" means shift+space. This is the activation key for kinput2 +
4100 canna (Japanese), and ami (Korean).
4101
4102 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4103'imcmdline' 'imc' boolean (default off)
4104 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 When set the Input Method is always on when starting to edit a command
4106 line, unless entering a search pattern (see 'imsearch' for that).
4107 Setting this option is useful when your input method allows entering
4108 English characters directly, e.g., when it's used to type accented
4109 characters with dead keys.
4110
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004111 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4113 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 When set the Input Method is never used. This is useful to disable
4115 the IM when it doesn't work properly.
4116 Currently this option is on by default for SGI/IRIX machines. This
4117 may change in later releases.
4118
4119 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004120'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122 Specifies whether :lmap or an Input Method (IM) is to be used in
4123 Insert mode. Valid values:
4124 0 :lmap is off and IM is off
4125 1 :lmap is ON and IM is off
4126 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 To always reset the option to zero when leaving Insert mode with <Esc>
4128 this can be used: >
4129 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4130< This makes :lmap and IM turn off automatically when leaving Insert
4131 mode.
4132 Note that this option changes when using CTRL-^ in Insert mode
4133 |i_CTRL-^|.
4134 The value is set to 1 when setting 'keymap' to a valid keymap name.
4135 It is also used for the argument of commands like "r" and "f".
4136 The value 0 may not work correctly with Athena and Motif with some XIM
4137 methods. Use 'imdisable' to disable XIM then.
4138
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004139 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004140 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004141 |+multi_byte_ime| or |global-ime|.
4142
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004144'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 Specifies whether :lmap or an Input Method (IM) is to be used when
4147 entering a search pattern. Valid values:
4148 -1 the value of 'iminsert' is used, makes it look like
4149 'iminsert' is also used when typing a search pattern
4150 0 :lmap is off and IM is off
4151 1 :lmap is ON and IM is off
4152 2 :lmap is off and IM is ON
4153 Note that this option changes when using CTRL-^ in Command-line mode
4154 |c_CTRL-^|.
4155 The value is set to 1 when it is not -1 and setting the 'keymap'
4156 option to a valid keymap name.
4157 The value 0 may not work correctly with Athena and Motif with some XIM
4158 methods. Use 'imdisable' to disable XIM then.
4159
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004160 *'imstatusfunc'* *'imsf'*
4161'imstatusfunc' 'imsf' string (default "")
4162 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004163 This option specifies a function that is called to obtain the status
4164 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004165 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004166
4167 Example: >
4168 function ImStatusFunc()
4169 let is_active = ...do something
4170 return is_active ? 1 : 0
4171 endfunction
4172 set imstatusfunc=ImStatusFunc
4173<
4174 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004175 The expression will be evaluated in the |sandbox| when set from a
4176 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004177
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004178 *'imstyle'* *'imst'*
4179'imstyle' 'imst' number (default 1)
4180 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004181 {only available when compiled with |+xim| and
4182 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004183 This option specifies the input style of Input Method:
4184 0 use on-the-spot style
4185 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004186 See: |xim-input-style|
4187
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004188 For a long time on-the-spot style had been used in the GTK version of
4189 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004190 |single-repeat|, etc. Therefore over-the-spot style becomes the
4191 default now. This should work fine for most people, however if you
4192 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004193 The expression will be evaluated in the |sandbox| when set from a
4194 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004195
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196 *'include'* *'inc'*
4197'include' 'inc' string (default "^\s*#\s*include")
4198 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199 {not available when compiled without the
4200 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004201 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 pattern, just like for the "/" command (See |pattern|). The default
4203 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004204 "]I", "[d", etc.
4205 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004206 comes after the matched pattern. But if "\zs" appears in the pattern
4207 then the text matched from "\zs" to the end, or until "\ze" if it
4208 appears, is used as the file name. Use this to include characters
4209 that are not in 'isfname', such as a space. You can then use
4210 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004211 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212
4213 *'includeexpr'* *'inex'*
4214'includeexpr' 'inex' string (default "")
4215 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004217 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004219 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 :set includeexpr=substitute(v:fname,'\\.','/','g')
4221< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004222
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004224 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 Also used for |<cfile>|.
4226
Bram Moolenaar30b65812012-07-12 22:01:11 +02004227 The expression will be evaluated in the |sandbox| when set from a
4228 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004229 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004230
4231 It is not allowed to change text or jump to another window while
4232 evaluating 'includeexpr' |textlock|.
4233
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004235'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4236 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004239 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004240 While typing a search command, show where the pattern, as it was typed
4241 so far, matches. The matched string is highlighted. If the pattern
4242 is invalid or not found, nothing is shown. The screen will be updated
4243 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004244 Also applies to the pattern in commands: >
4245 :global
4246 :lvimgrep
4247 :lvimgrepadd
4248 :smagic
4249 :snomagic
4250 :sort
4251 :substitute
4252 :vglobal
4253 :vimgrep
4254 :vimgrepadd
4255< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004256 original position when no match is found and when pressing <Esc>. You
4257 still need to finish the search command with <Enter> to move the
4258 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004259 You can use the CTRL-G and CTRL-T keys to move to the next and
4260 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004261 When compiled with the |+reltime| feature Vim only searches for about
4262 half a second. With a complicated pattern and/or a lot of text the
4263 match may not be found. This is to avoid that Vim hangs while you
4264 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004265 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004266 When 'hlsearch' is on, all matched strings are highlighted too while
4267 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004268 If you don't want to turn 'hlsearch' on, but want to highlight all
4269 matches while searching, you can turn on and off 'hlsearch' with
4270 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004271 augroup vimrc-incsearch-highlight
4272 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004273 autocmd CmdlineEnter /,\? :set hlsearch
4274 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004275 augroup END
4276<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004277 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004278 to the command line. If 'ignorecase' and 'smartcase' are set and the
4279 command line has no uppercase characters, the added character is
4280 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004281 CTRL-R CTRL-W can be used to add the word at the end of the current
4282 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 NOTE: This option is reset when 'compatible' is set.
4284
4285 *'indentexpr'* *'inde'*
4286'indentexpr' 'inde' string (default "")
4287 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 {not available when compiled without the |+cindent|
4289 or |+eval| features}
4290 Expression which is evaluated to obtain the proper indent for a line.
4291 It is used when a new line is created, for the |=| operator and
4292 in Insert mode as specified with the 'indentkeys' option.
4293 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004294 'smartindent' indenting. When 'lisp' is set, this option is
4295 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 When 'paste' is set this option is not used for indenting.
4297 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004298 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 when the expression is evaluated (but it may be moved around).
4300 The expression must return the number of spaces worth of indent. It
4301 can return "-1" to keep the current indent (this means 'autoindent' is
4302 used for the indent).
4303 Functions useful for computing the indent are |indent()|, |cindent()|
4304 and |lispindent()|.
4305 The evaluation of the expression must not have side effects! It must
4306 not change the text, jump to another window, etc. Afterwards the
4307 cursor position is always restored, thus the cursor may be moved.
4308 Normally this option would be set to call a function: >
4309 :set indentexpr=GetMyIndent()
4310< Error messages will be suppressed, unless the 'debug' option contains
4311 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004312 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004313 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314
Bram Moolenaar30b65812012-07-12 22:01:11 +02004315 The expression will be evaluated in the |sandbox| when set from a
4316 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004317 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004318
4319 It is not allowed to change text or jump to another window while
4320 evaluating 'indentexpr' |textlock|.
4321
4322
Bram Moolenaar071d4272004-06-13 20:20:40 +00004323 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004324'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 {not available when compiled without the |+cindent|
4327 feature}
4328 A list of keys that, when typed in Insert mode, cause reindenting of
4329 the current line. Only happens if 'indentexpr' isn't empty.
4330 The format is identical to 'cinkeys', see |indentkeys-format|.
4331 See |C-indenting| and |indent-expression|.
4332
4333 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4334'infercase' 'inf' boolean (default off)
4335 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004337 'ignorecase' is also on, the case of the match is adjusted depending
4338 on the typed text. If the typed text contains a lowercase letter
4339 where the match has an upper case letter, the completed part is made
4340 lowercase. If the typed text has no lowercase letters and the match
4341 has a lowercase letter where the typed text has an uppercase letter,
4342 and there is a letter before it, the completed part is made uppercase.
4343 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344
4345 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4346'insertmode' 'im' boolean (default off)
4347 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004348 Makes Vim work in a way that Insert mode is the default mode. Useful
4349 if you want to use Vim as a modeless editor. Used for |evim|.
4350 These Insert mode commands will be useful:
4351 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004352 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 this is a mapping, it is executed as if 'insertmode' was off.
4354 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004356 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4357 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358
4359 These items change when 'insertmode' is set:
4360 - when starting to edit of a file, Vim goes to Insert mode.
4361 - <Esc> in Insert mode is a no-op and beeps.
4362 - <Esc> in Normal mode makes Vim go to Insert mode.
4363 - CTRL-L in Insert mode is a command, it is not inserted.
4364 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4365 However, when <Esc> is used inside a mapping, it behaves like
4366 'insertmode' was not set. This was done to be able to use the same
4367 mappings with 'insertmode' set or not set.
4368 When executing commands with |:normal| 'insertmode' is not used.
4369
4370 NOTE: This option is reset when 'compatible' is set.
4371
4372 *'isfname'* *'isf'*
4373'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4374 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4375 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4376 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4377 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4378 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4379 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 The characters specified by this option are included in file names and
4381 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004382 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383 Multi-byte characters 256 and above are always included, only the
4384 characters up to 255 are specified with this option.
4385 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004386 Think twice before adding white space to this option. Although a
4387 space may appear inside a file name, the effect will be that Vim
4388 doesn't know where a file name starts or ends when doing completion.
4389 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390
4391 Note that on systems using a backslash as path separator, Vim tries to
4392 do its best to make it work as you would expect. That is a bit
4393 tricky, since Vi originally used the backslash to escape special
4394 characters. Vim will not remove a backslash in front of a normal file
4395 name character on these systems, but it will on Unix and alikes. The
4396 '&' and '^' are not included by default, because these are special for
4397 cmd.exe.
4398
4399 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004400 Each part can be a single character number or a range. A range is two
4401 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 decimal number between 0 and 255 or the ASCII character itself (does
4403 not work for digits). Example:
4404 "_,-,128-140,#-43" (include '_' and '-' and the range
4405 128 to 140 and '#' to 43)
4406 If a part starts with '^', the following character number or range
4407 will be excluded from the option. The option is interpreted from left
4408 to right. Put the excluded character after the range where it is
4409 included. To include '^' itself use it as the last character of the
4410 option or the end of a range. Example:
4411 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4412 If the character is '@', all characters where isalpha() returns TRUE
4413 are included. Normally these are the characters a to z and A to Z,
4414 plus accented characters. To include '@' itself use "@-@". Examples:
4415 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004416 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 "a-z,A-Z,@-@" All letters plus the '@' character.
4418 A comma can be included by using it where a character number is
4419 expected. Example:
4420 "48-57,,,_" Digits, comma and underscore.
4421 A comma can be excluded by prepending a '^'. Example:
4422 " -~,^,,9" All characters from space to '~', excluding
4423 comma, plus <Tab>.
4424 See |option-backslash| about including spaces and backslashes.
4425
4426 *'isident'* *'isi'*
4427'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4428 "@,48-57,_,128-167,224-235"
4429 otherwise: "@,48-57,_,192-255")
4430 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 The characters given by this option are included in identifiers.
4432 Identifiers are used in recognizing environment variables and after a
4433 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004434 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004435 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004437 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4439
4440 *'iskeyword'* *'isk'*
4441'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4442 "@,48-57,_,128-167,224-235"
4443 otherwise: "@,48-57,_,192-255"
4444 Vi default: "@,48-57,_")
4445 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004447 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004448 'isfname' for a description of the format of this option. For '@'
4449 characters above 255 check the "word" character class.
4450 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 For a help file it is set to all non-blank printable characters except
4452 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4453 command).
4454 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004455 This option also influences syntax highlighting, unless the syntax
4456 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 NOTE: This option is set to the Vi default value when 'compatible' is
4458 set and to the Vim default value when 'compatible' is reset.
4459
4460 *'isprint'* *'isp'*
4461'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4462 "@,~-255"; otherwise: "@,161-255")
4463 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 The characters given by this option are displayed directly on the
4465 screen. It is also used for "\p" in a |pattern|. The characters from
4466 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4467 even when they are not included in 'isprint' or excluded. See
4468 'isfname' for a description of the format of this option.
4469
4470 Non-printable characters are displayed with two characters:
4471 0 - 31 "^@" - "^_"
4472 32 - 126 always single characters
4473 127 "^?"
4474 128 - 159 "~@" - "~_"
4475 160 - 254 "| " - "|~"
4476 255 "~?"
4477 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4478 displayed as <xx>, with the hexadecimal value of the byte.
4479 When 'display' contains "uhex" all unprintable characters are
4480 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004481 The SpecialKey highlighting will be used for unprintable characters.
4482 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483
4484 Multi-byte characters 256 and above are always included, only the
4485 characters up to 255 are specified with this option. When a character
4486 is printable but it is not available in the current font, a
4487 replacement character will be shown.
4488 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4489 There is no option to specify these characters.
4490
4491 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4492'joinspaces' 'js' boolean (default on)
4493 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 Insert two spaces after a '.', '?' and '!' with a join command.
4495 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4496 Otherwise only one space is inserted.
4497 NOTE: This option is set when 'compatible' is set.
4498
4499 *'key'*
4500'key' string (default "")
4501 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004502 {only available when compiled with the |+cryptv|
4503 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004505 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 Careful: Do not set the key value by hand, someone might see the typed
4507 key. Use the |:X| command. But you can make 'key' empty: >
4508 :set key=
4509< It is not possible to get the value of this option with ":set key" or
4510 "echo &key". This is to avoid showing it to someone who shouldn't
4511 know. It also means you cannot see it yourself once you have set it,
4512 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004513 You can use "&key" in an expression to detect whether encryption is
4514 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515
4516 *'keymap'* *'kmp'* *E544*
4517'keymap' 'kmp' string (default "")
4518 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519 {only available when compiled with the |+keymap|
4520 feature}
4521 Name of a keyboard mapping. See |mbyte-keymap|.
4522 Setting this option to a valid keymap name has the side effect of
4523 setting 'iminsert' to one, so that the keymap becomes effective.
4524 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004525 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526
4527 *'keymodel'* *'km'*
4528'keymodel' 'km' string (default "")
4529 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 List of comma separated words, which enable special things that keys
4531 can do. These values can be used:
4532 startsel Using a shifted special key starts selection (either
4533 Select mode or Visual mode, depending on "key" being
4534 present in 'selectmode').
4535 stopsel Using a not-shifted special key stops selection.
4536 Special keys in this context are the cursor keys, <End>, <Home>,
4537 <PageUp> and <PageDown>.
4538 The 'keymodel' option is set by the |:behave| command.
4539
4540 *'keywordprg'* *'kp'*
4541'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004542 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 Program to use for the |K| command. Environment variables are
4545 expanded |:set_env|. ":help" may be used to access the Vim internal
4546 help. (Note that previously setting the global option to the empty
4547 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004548 When the first character is ":", the command is invoked as a Vim
4549 Ex command prefixed with [count].
4550 When "man", "man -s" or an Ex command is used, Vim will automatically
4551 translate a count for the "K" command and pass it as the first
4552 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 See |option-backslash| about including spaces and backslashes.
4554 Example: >
4555 :set keywordprg=man\ -s
4556< This option cannot be set from a |modeline| or in the |sandbox|, for
4557 security reasons.
4558
4559 *'langmap'* *'lmap'* *E357* *E358*
4560'langmap' 'lmap' string (default "")
4561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 {only available when compiled with the |+langmap|
4563 feature}
4564 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004565 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004566 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 care of translating these special characters to the original meaning
4568 of the key. This means you don't have to change the keyboard mode to
4569 be able to execute Normal mode commands.
4570 This is the opposite of the 'keymap' option, where characters are
4571 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004572 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004573 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004574 This option cannot be set from a |modeline| or in the |sandbox|, for
4575 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004577 Example (for Greek, in UTF-8): *greek* >
4578 :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 +00004579< Example (exchanges meaning of z and y for commands): >
4580 :set langmap=zy,yz,ZY,YZ
4581<
4582 The 'langmap' option is a list of parts, separated with commas. Each
4583 part can be in one of two forms:
4584 1. A list of pairs. Each pair is a "from" character immediately
4585 followed by the "to" character. Examples: "aA", "aAbBcC".
4586 2. A list of "from" characters, a semi-colon and a list of "to"
4587 characters. Example: "abc;ABC"
4588 Example: "aA,fgh;FGH,cCdDeE"
4589 Special characters need to be preceded with a backslash. These are
4590 ";", ',' and backslash itself.
4591
4592 This will allow you to activate vim actions without having to switch
4593 back and forth between the languages. Your language characters will
4594 be understood as normal vim English characters (according to the
4595 langmap mappings) in the following cases:
4596 o Normal/Visual mode (commands, buffer/register names, user mappings)
4597 o Insert/Replace Mode: Register names after CTRL-R
4598 o Insert/Replace Mode: Mappings
4599 Characters entered in Command-line mode will NOT be affected by
4600 this option. Note that this option can be changed at any time
4601 allowing to switch between mappings for different languages/encodings.
4602 Use a mapping to avoid having to type it each time!
4603
4604 *'langmenu'* *'lm'*
4605'langmenu' 'lm' string (default "")
4606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 {only available when compiled with the |+menu| and
4608 |+multi_lang| features}
4609 Language to use for menu translation. Tells which file is loaded
4610 from the "lang" directory in 'runtimepath': >
4611 "lang/menu_" . &langmenu . ".vim"
4612< (without the spaces). For example, to always use the Dutch menus, no
4613 matter what $LANG is set to: >
4614 :set langmenu=nl_NL.ISO_8859-1
4615< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004616 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 If your $LANG is set to a non-English language but you do want to use
4618 the English menus: >
4619 :set langmenu=none
4620< This option must be set before loading menus, switching on filetype
4621 detection or syntax highlighting. Once the menus are defined setting
4622 this option has no effect. But you could do this: >
4623 :source $VIMRUNTIME/delmenu.vim
4624 :set langmenu=de_DE.ISO_8859-1
4625 :source $VIMRUNTIME/menu.vim
4626< Warning: This deletes all menus that you defined yourself!
4627
Bram Moolenaard94464e2015-11-02 15:28:18 +01004628 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004629'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004630 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004631 {only available when compiled with the |+langmap|
4632 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004633 This is just like 'langremap' but with the value inverted. It only
4634 exists for backwards compatibility. When setting 'langremap' then
4635 'langnoremap' is set to the inverted value, and the other way around.
4636
4637 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4638'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4639 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004640 {only available when compiled with the |+langmap|
4641 feature}
4642 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004643 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004644 'langmap' disables some of your mappings, try resetting this option.
4645 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004646 that works for you to avoid mappings to break.
4647
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 *'laststatus'* *'ls'*
4649'laststatus' 'ls' number (default 1)
4650 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 The value of this option influences when the last window will have a
4652 status line:
4653 0: never
4654 1: only if there are at least two windows
4655 2: always
4656 The screen looks nicer with a status line if you have several
4657 windows, but it takes another screen line. |status-line|
4658
4659 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4660'lazyredraw' 'lz' boolean (default off)
4661 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 When this option is set, the screen will not be redrawn while
4663 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004664 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 update use |:redraw|.
4666
4667 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4668'linebreak' 'lbr' boolean (default off)
4669 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004670 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004672 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 than at the last character that fits on the screen. Unlike
4674 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004675 it only affects the way the file is displayed, not its contents.
4676 If 'breakindent' is set, line is visually indented. Then, the value
4677 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004678 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679 Note that <Tab> characters after an <EOL> are mostly not displayed
4680 with the right amount of white space.
4681
4682 *'lines'* *E593*
4683'lines' number (default 24 or terminal height)
4684 global
4685 Number of lines of the Vim window.
4686 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004687 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 When Vim is running in the GUI or in a resizable window, setting this
4689 option will cause the window size to be changed. When you only want
4690 to use the size for the GUI, put the command in your |gvimrc| file.
4691 Vim limits the number of lines to what fits on the screen. You can
4692 use this command to get the tallest window possible: >
4693 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004694< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004695 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 When you set this option and Vim is unable to change the physical
4697 number of lines of the display, the display may be messed up.
4698
4699 *'linespace'* *'lsp'*
4700'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4701 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 {only in the GUI}
4703 Number of pixel lines inserted between characters. Useful if the font
4704 uses the full character cell height, making lines touch each other.
4705 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004706 With some fonts there can be too much room between lines (to have
4707 space for ascents and descents). Then it makes sense to set
4708 'linespace' to a negative value. This may cause display problems
4709 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710
4711 *'lisp'* *'nolisp'*
4712'lisp' boolean (default off)
4713 local to buffer
4714 {not available when compiled without the |+lispindent|
4715 feature}
4716 Lisp mode: When <Enter> is typed in insert mode set the indent for
4717 the next line to Lisp standards (well, sort of). Also happens with
4718 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4719 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4720 better. Also see 'lispwords'.
4721 The '-' character is included in keyword characters. Redefines the
4722 "=" operator to use this same indentation algorithm rather than
4723 calling an external program if 'equalprg' is empty.
4724 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725
4726 *'lispwords'* *'lw'*
4727'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004728 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 {not available when compiled without the |+lispindent|
4730 feature}
4731 Comma separated list of words that influence the Lisp indenting.
4732 |'lisp'|
4733
4734 *'list'* *'nolist'*
4735'list' boolean (default off)
4736 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004737 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4738 line. Useful to see the difference between tabs and spaces and for
4739 trailing blanks. Further changed by the 'listchars' option.
4740
4741 The cursor is displayed at the start of the space a Tab character
4742 occupies, not at the end as usual in Normal mode. To get this cursor
4743 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004744 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004745<
4746 Note that list mode will also affect formatting (set with 'textwidth'
4747 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 changing the way tabs are displayed.
4749
4750 *'listchars'* *'lcs'*
4751'listchars' 'lcs' string (default "eol:$")
4752 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004753 Strings to use in 'list' mode and for the |:list| command. It is a
4754 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004755 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 eol:c Character to show at the end of each line. When
4757 omitted, there is no extra character at the end of the
4758 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004759 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004760 tab:xy[z] Two or three characters to be used to show a tab.
4761 The third character is optional.
4762
4763 tab:xy The 'x' is always used, then 'y' as many times as will
4764 fit. Thus "tab:>-" displays:
4765 >
4766 >-
4767 >--
4768 etc.
4769
4770 tab:xyz The 'z' is always used, then 'x' is prepended, and
4771 then 'y' is used as many times as will fit. Thus
4772 "tab:<->" displays:
4773 >
4774 <>
4775 <->
4776 <-->
4777 etc.
4778
4779 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004780 *lcs-space*
4781 space:c Character to show for a space. When omitted, spaces
4782 are left blank.
4783 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004784 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004785 trailing spaces are blank. Overrides the "space"
4786 setting for trailing spaces.
4787 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 extends:c Character to show in the last column, when 'wrap' is
4789 off and the line continues beyond the right of the
4790 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004791 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 precedes:c Character to show in the first column, when 'wrap'
4793 is off and there is text preceding the character
4794 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004795 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004796 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004797 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004798 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004799 nbsp:c Character to show for a non-breakable space character
4800 (0xA0 (160 decimal) and U+202F). Left blank when
4801 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004803 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004805 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806
4807 Examples: >
4808 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004809 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 :set lcs=extends:>,precedes:<
4811< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004812 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004813 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814
4815 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4816'loadplugins' 'lpl' boolean (default on)
4817 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004818 When on the plugin scripts are loaded when starting up |load-plugins|.
4819 This option can be reset in your |vimrc| file to disable the loading
4820 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004821 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4822 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823
Bram Moolenaard94464e2015-11-02 15:28:18 +01004824 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004825'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004826 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004827 {only available when compiled with the |+lua/dyn|
4828 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004829 Specifies the name of the Lua shared library. The default is
4830 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004831 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004832 This option cannot be set from a |modeline| or in the |sandbox|, for
4833 security reasons.
4834
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004835 *'macatsui'* *'nomacatsui'*
4836'macatsui' boolean (default on)
4837 global
4838 {only available in Mac GUI version}
4839 This is a workaround for when drawing doesn't work properly. When set
4840 and compiled with multi-byte support ATSUI text drawing is used. When
4841 not set ATSUI text drawing is not used. Switch this option off when
4842 you experience drawing problems. In a future version the problems may
4843 be solved and this option becomes obsolete. Therefore use this method
4844 to unset it: >
4845 if exists('&macatsui')
4846 set nomacatsui
4847 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004848< Another option to check if you have drawing problems is
4849 'termencoding'.
4850
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 *'magic'* *'nomagic'*
4852'magic' boolean (default on)
4853 global
4854 Changes the special characters that can be used in search patterns.
4855 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004856 WARNING: Switching this option off most likely breaks plugins! That
4857 is because many patterns assume it's on and will fail when it's off.
4858 Only switch it off when working with old Vi scripts. In any other
4859 situation write patterns that work when 'magic' is on. Include "\M"
4860 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004861
4862 *'makeef'* *'mef'*
4863'makeef' 'mef' string (default: "")
4864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 {not available when compiled without the |+quickfix|
4866 feature}
4867 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4868 and the |:grep| command.
4869 When it is empty, an internally generated temp file will be used.
4870 When "##" is included, it is replaced by a number to make the name
4871 unique. This makes sure that the ":make" command doesn't overwrite an
4872 existing file.
4873 NOT used for the ":cf" command. See 'errorfile' for that.
4874 Environment variables are expanded |:set_env|.
4875 See |option-backslash| about including spaces and backslashes.
4876 This option cannot be set from a |modeline| or in the |sandbox|, for
4877 security reasons.
4878
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004879 *'makeencoding'* *'menc'*
4880'makeencoding' 'menc' string (default "")
4881 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004882 Encoding used for reading the output of external commands. When empty,
4883 encoding is not converted.
4884 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4885 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4886 and `:laddfile`.
4887
4888 This would be mostly useful when you use MS-Windows and set 'encoding'
4889 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4890 'makeencoding' to "char" has the same effect as setting to the system
4891 locale encoding. Example: >
4892 :set encoding=utf-8
4893 :set makeencoding=char " system locale is used
4894<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895 *'makeprg'* *'mp'*
4896'makeprg' 'mp' string (default "make", VMS: "MMS")
4897 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004898 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004899 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4900 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004901 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004902 Environment variables are expanded |:set_env|. See |option-backslash|
4903 about including spaces and backslashes.
4904 Note that a '|' must be escaped twice: once for ":set" and once for
4905 the interpretation of a command. When you use a filter called
4906 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907 :set makeprg=gmake\ \\\|\ myfilter
4908< The placeholder "$*" can be given (even multiple times) to specify
4909 where the arguments will be included, for example: >
4910 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4911< This option cannot be set from a |modeline| or in the |sandbox|, for
4912 security reasons.
4913
Bram Moolenaar110289e2019-05-23 15:38:06 +02004914 *'makespellmem'* *'msm'*
4915'makespellmem' 'msm' string (default "460000,2000,500")
4916 global
4917 Values relevant only when compressing a spell file, see |spell|.
4918 This option cannot be set from a |modeline| or in the |sandbox|.
4919
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920 *'matchpairs'* *'mps'*
4921'matchpairs' 'mps' string (default "(:),{:},[:]")
4922 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004924 other.
4925 Only character pairs are allowed that are different, thus you cannot
4926 jump between two double quotes.
4927 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004928 The pairs must be separated by a comma. Example for including '<' and
4929 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930 :set mps+=<:>
4931
4932< A more exotic example, to jump between the '=' and ';' in an
4933 assignment, useful for languages like C and Java: >
4934 :au FileType c,cpp,java set mps+==:;
4935
4936< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01004937 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938
4939 *'matchtime'* *'mat'*
4940'matchtime' 'mat' number (default 5)
4941 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 Tenths of a second to show the matching paren, when 'showmatch' is
4943 set. Note that this is not in milliseconds, like other options that
4944 set a time. This is to be compatible with Nvi.
4945
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004946 *'maxcombine'* *'mco'*
4947'maxcombine' 'mco' number (default 2)
4948 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004949 The maximum number of combining characters supported for displaying.
4950 Only used when 'encoding' is "utf-8".
4951 The default is OK for most languages. Hebrew may require 4.
4952 Maximum value is 6.
4953 Even when this option is set to 2 you can still edit text with more
4954 combining characters, you just can't see them. Use |g8| or |ga|.
4955 See |mbyte-combining|.
4956
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 *'maxfuncdepth'* *'mfd'*
4958'maxfuncdepth' 'mfd' number (default 100)
4959 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02004960 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004961 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962 Maximum depth of function calls for user functions. This normally
4963 catches endless recursion. When using a recursive function with
4964 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4965 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01004966 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02004967 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 See also |:function|.
4969
4970 *'maxmapdepth'* *'mmd'* *E223*
4971'maxmapdepth' 'mmd' number (default 1000)
4972 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 Maximum number of times a mapping is done without resulting in a
4974 character to be used. This normally catches endless mappings, like
4975 ":map x y" with ":map y x". It still does not catch ":map g wg",
4976 because the 'w' is used before the next mapping is done. See also
4977 |key-mapping|.
4978
4979 *'maxmem'* *'mm'*
4980'maxmem' 'mm' number (default between 256 to 5120 (system
4981 dependent) or half the amount of memory
4982 available)
4983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4985 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01004986 other memory to be freed.
4987 The maximum usable value is about 2000000. Use this to work without a
4988 limit.
4989 The value is ignored when 'swapfile' is off.
4990 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004992 *'maxmempattern'* *'mmp'*
4993'maxmempattern' 'mmp' number (default 1000)
4994 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004995 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004996 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004997 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004998 When Vim runs into the limit it gives an error message and mostly
4999 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005000 Running into the limit often means that the pattern is very
5001 inefficient or too complex. This may already happen with the pattern
5002 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005003 Might also happen on redraw, when syntax rules try to match a complex
5004 text structure.
5005 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5006 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005007
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 *'maxmemtot'* *'mmt'*
5009'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5010 dependent) or half the amount of memory
5011 available)
5012 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005013 Maximum amount of memory in Kbyte to use for all buffers together.
5014 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005015 without a limit.
5016 On 64 bit machines higher values might work. But hey, do you really
5017 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005018 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005019 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005020 Buffers with 'swapfile' off still count to the total amount of memory
5021 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005022 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023
5024 *'menuitems'* *'mis'*
5025'menuitems' 'mis' number (default 25)
5026 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027 {not available when compiled without the |+menu|
5028 feature}
5029 Maximum number of items to use in a menu. Used for menus that are
5030 generated from a list of items, e.g., the Buffers menu. Changing this
5031 option has no direct effect, the menu must be refreshed first.
5032
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005033 *'mkspellmem'* *'msm'*
5034'mkspellmem' 'msm' string (default "460000,2000,500")
5035 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005036 {not available when compiled without the |+syntax|
5037 feature}
5038 Parameters for |:mkspell|. This tunes when to start compressing the
5039 word tree. Compression can be slow when there are many words, but
5040 it's needed to avoid running out of memory. The amount of memory used
5041 per word depends very much on how similar the words are, that's why
5042 this tuning is complicated.
5043
5044 There are three numbers, separated by commas:
5045 {start},{inc},{added}
5046
5047 For most languages the uncompressed word tree fits in memory. {start}
5048 gives the amount of memory in Kbyte that can be used before any
5049 compression is done. It should be a bit smaller than the amount of
5050 memory that is available to Vim.
5051
5052 When going over the {start} limit the {inc} number specifies the
5053 amount of memory in Kbyte that can be allocated before another
5054 compression is done. A low number means compression is done after
5055 less words are added, which is slow. A high number means more memory
5056 will be allocated.
5057
5058 After doing compression, {added} times 1024 words can be added before
5059 the {inc} limit is ignored and compression is done when any extra
5060 amount of memory is needed. A low number means there is a smaller
5061 chance of hitting the {inc} limit, less memory is used but it's
5062 slower.
5063
5064 The languages for which these numbers are important are Italian and
5065 Hungarian. The default works for when you have about 512 Mbyte. If
5066 you have 1 Gbyte you could use: >
5067 :set mkspellmem=900000,3000,800
5068< If you have less than 512 Mbyte |:mkspell| may fail for some
5069 languages, no matter what you set 'mkspellmem' to.
5070
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005072'modeline' 'ml' boolean (Vim default: on (off for root),
5073 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005075 If 'modeline' is on 'modelines' gives the number of lines that is
5076 checked for set commands. If 'modeline' is off or 'modelines' is zero
5077 no lines are checked. See |modeline|.
5078
5079 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5080'modelineexpr' 'mle' boolean (default: off)
5081 global
5082 When on allow some options that are an expression to be set in the
5083 modeline. Check the option for whether it is affected by
5084 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005085 This option cannot be set from a |modeline| or in the |sandbox|, for
5086 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005087
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 *'modelines'* *'mls'*
5089'modelines' 'mls' number (default 5)
5090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 If 'modeline' is on 'modelines' gives the number of lines that is
5092 checked for set commands. If 'modeline' is off or 'modelines' is zero
5093 no lines are checked. See |modeline|.
5094 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5095 set and to the Vim default value when 'compatible' is reset.
5096
5097 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005098 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099'modifiable' 'ma' boolean (default on)
5100 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 When off the buffer contents cannot be changed. The 'fileformat' and
5102 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005103 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104
5105 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5106'modified' 'mod' boolean (default off)
5107 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108 When on, the buffer is considered to be modified. This option is set
5109 when:
5110 1. A change was made to the text since it was last written. Using the
5111 |undo| command to go back to the original text will reset the
5112 option. But undoing changes that were made before writing the
5113 buffer will set the option again, since the text is different from
5114 when it was written.
5115 2. 'fileformat' or 'fileencoding' is different from its original
5116 value. The original value is set when the buffer is read or
5117 written. A ":set nomodified" command also resets the original
5118 values to the current values and the 'modified' option will be
5119 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005120 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005121 This option is not set when a change is made to the buffer as the
5122 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5123 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5124 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5126 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005127 Note that the text may actually be the same, e.g. 'modified' is set
5128 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129
5130 *'more'* *'nomore'*
5131'more' boolean (Vim default: on, Vi default: off)
5132 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133 When on, listings pause when the whole screen is filled. You will get
5134 the |more-prompt|. When this option is off there are no pauses, the
5135 listing continues until finished.
5136 NOTE: This option is set to the Vi default value when 'compatible' is
5137 set and to the Vim default value when 'compatible' is reset.
5138
5139 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005140'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5141 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005144 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5145 sysmouse and Linux console with gpm). For using the mouse in the
5146 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005148 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005149 v Visual mode
5150 i Insert mode
5151 c Command-line mode
5152 h all previous modes when editing a help file
5153 a all previous modes
5154 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005155 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 :set mouse=a
5157< When the mouse is not enabled, the GUI will still use the mouse for
5158 modeless selection. This doesn't move the text cursor.
5159
5160 See |mouse-using|. Also see |'clipboard'|.
5161
5162 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005163 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 the mouse buttons can still be used by keeping the shift key pressed.
5165 Also see the 'clipboard' option.
5166
5167 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5168'mousefocus' 'mousef' boolean (default off)
5169 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 {only works in the GUI}
5171 The window that the mouse pointer is on is automatically activated.
5172 When changing the window layout or window focus in another way, the
5173 mouse pointer is moved to the window with keyboard focus. Off is the
5174 default because it makes using the pull down menus a little goofy, as
5175 a pointer transit may activate a window unintentionally.
5176
5177 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5178'mousehide' 'mh' boolean (default on)
5179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180 {only works in the GUI}
5181 When on, the mouse pointer is hidden when characters are typed.
5182 The mouse pointer is restored when the mouse is moved.
5183
5184 *'mousemodel'* *'mousem'*
5185'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187 Sets the model to use for the mouse. The name mostly specifies what
5188 the right mouse button is used for:
5189 extend Right mouse button extends a selection. This works
5190 like in an xterm.
5191 popup Right mouse button pops up a menu. The shifted left
5192 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005193 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194 popup_setpos Like "popup", but the cursor will be moved to the
5195 position where the mouse was clicked, and thus the
5196 selected operation will act upon the clicked object.
5197 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005198 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 course, that right clicking outside a selection will
5200 end Visual mode.
5201 Overview of what button does what for each model:
5202 mouse extend popup(_setpos) ~
5203 left click place cursor place cursor
5204 left drag start selection start selection
5205 shift-left search word extend selection
5206 right click extend selection popup menu (place cursor)
5207 right drag extend selection -
5208 middle click paste paste
5209
5210 In the "popup" model the right mouse button produces a pop-up menu.
5211 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005212 In a terminal the popup menu works if Vim is compiled with the
5213 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214
5215 Note that you can further refine the meaning of buttons with mappings.
5216 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5217 selection (because that's handled in the GUI code directly).
5218
5219 The 'mousemodel' option is set by the |:behave| command.
5220
5221 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005222'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5223 vs:leftright,vd:lrsizing,m:no,
5224 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005225 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 {only available when compiled with the |+mouseshape|
5227 feature}
5228 This option tells Vim what the mouse pointer should look like in
5229 different modes. The option is a comma separated list of parts, much
5230 like used for 'guicursor'. Each part consist of a mode/location-list
5231 and an argument-list:
5232 mode-list:shape,mode-list:shape,..
5233 The mode-list is a dash separated list of these modes/locations:
5234 In a normal window: ~
5235 n Normal mode
5236 v Visual mode
5237 ve Visual mode with 'selection' "exclusive" (same as 'v',
5238 if not specified)
5239 o Operator-pending mode
5240 i Insert mode
5241 r Replace mode
5242
5243 Others: ~
5244 c appending to the command-line
5245 ci inserting in the command-line
5246 cr replacing in the command-line
5247 m at the 'Hit ENTER' or 'More' prompts
5248 ml idem, but cursor in the last line
5249 e any mode, pointer below last window
5250 s any mode, pointer on a status line
5251 sd any mode, while dragging a status line
5252 vs any mode, pointer on a vertical separator line
5253 vd any mode, while dragging a vertical separator line
5254 a everywhere
5255
5256 The shape is one of the following:
5257 avail name looks like ~
5258 w x arrow Normal mouse pointer
5259 w x blank no pointer at all (use with care!)
5260 w x beam I-beam
5261 w x updown up-down sizing arrows
5262 w x leftright left-right sizing arrows
5263 w x busy The system's usual busy pointer
5264 w x no The system's usual 'no input' pointer
5265 x udsizing indicates up-down resizing
5266 x lrsizing indicates left-right resizing
5267 x crosshair like a big thin +
5268 x hand1 black hand
5269 x hand2 white hand
5270 x pencil what you write with
5271 x question big ?
5272 x rightup-arrow arrow pointing right-up
5273 w x up-arrow arrow pointing up
5274 x <number> any X11 pointer number (see X11/cursorfont.h)
5275
5276 The "avail" column contains a 'w' if the shape is available for Win32,
5277 x for X11.
5278 Any modes not specified or shapes not available use the normal mouse
5279 pointer.
5280
5281 Example: >
5282 :set mouseshape=s:udsizing,m:no
5283< will make the mouse turn to a sizing arrow over the status lines and
5284 indicate no input when the hit-enter prompt is displayed (since
5285 clicking the mouse has no effect in this state.)
5286
5287 *'mousetime'* *'mouset'*
5288'mousetime' 'mouset' number (default 500)
5289 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005290 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5291 time in msec between two mouse clicks for the second click to be
5292 recognized as a multi click.
5293
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005294 *'mzschemedll'*
5295'mzschemedll' string (default depends on the build)
5296 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005297 {only available when compiled with the |+mzscheme/dyn|
5298 feature}
5299 Specifies the name of the MzScheme shared library. The default is
5300 DYNAMIC_MZSCH_DLL which was specified at compile time.
5301 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005302 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005303 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005304 This option cannot be set from a |modeline| or in the |sandbox|, for
5305 security reasons.
5306
5307 *'mzschemegcdll'*
5308'mzschemegcdll' string (default depends on the build)
5309 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005310 {only available when compiled with the |+mzscheme/dyn|
5311 feature}
5312 Specifies the name of the MzScheme GC shared library. The default is
5313 DYNAMIC_MZGC_DLL which was specified at compile time.
5314 The value can be equal to 'mzschemedll' if it includes the GC code.
5315 Environment variables are expanded |:set_env|.
5316 This option cannot be set from a |modeline| or in the |sandbox|, for
5317 security reasons.
5318
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005319 *'mzquantum'* *'mzq'*
5320'mzquantum' 'mzq' number (default 100)
5321 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005322 {not available when compiled without the |+mzscheme|
5323 feature}
5324 The number of milliseconds between polls for MzScheme threads.
5325 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005326 NOTE: This option is set to the Vim default value when 'compatible'
5327 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005328
Bram Moolenaar071d4272004-06-13 20:20:40 +00005329 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005330'nrformats' 'nf' string (default "bin,octal,hex",
5331 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 This defines what bases Vim will consider for numbers when using the
5334 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5335 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005336 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005338 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005339 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005341 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342 considered to be hexadecimal. Example: Using CTRL-X on
5343 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005344 bin If included, numbers starting with "0b" or "0B" will be
5345 considered to be binary. Example: Using CTRL-X on
5346 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347 Numbers which simply begin with a digit in the range 1-9 are always
5348 considered decimal. This also happens for numbers that are not
5349 recognized as octal or hex.
5350
5351 *'number'* *'nu'* *'nonumber'* *'nonu'*
5352'number' 'nu' boolean (default off)
5353 local to window
5354 Print the line number in front of each line. When the 'n' option is
5355 excluded from 'cpoptions' a wrapped line will not use the column of
5356 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005357 The 'numberwidth' option can be used to set the room used for the line
5358 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359 When a long, wrapped line doesn't start with the first character, '-'
5360 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005361 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5362 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005363 *number_relativenumber*
5364 The 'relativenumber' option changes the displayed number to be
5365 relative to the cursor. Together with 'number' there are these
5366 four combinations (cursor in line 3):
5367
Bram Moolenaar3848e002016-03-19 18:42:29 +01005368 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005369 'nornu' 'nornu' 'rnu' 'rnu'
5370
5371 |apple | 1 apple | 2 apple | 2 apple
5372 |pear | 2 pear | 1 pear | 1 pear
5373 |nobody | 3 nobody | 0 nobody |3 nobody
5374 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005376 *'numberwidth'* *'nuw'*
5377'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5378 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005379 {only available when compiled with the |+linebreak|
5380 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005381 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005382 when the 'number' or 'relativenumber' option is set or printing lines
5383 with a line number. Since one space is always between the number and
5384 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005385 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005386 fit the highest line number in the buffer respectively the number of
5387 rows in the window, depending on whether 'number' or 'relativenumber'
5388 is set. Thus with the Vim default of 4 there is room for a line number
5389 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005390 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005391 NOTE: This option is set to the Vi default value when 'compatible' is
5392 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005393
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005394 *'omnifunc'* *'ofu'*
5395'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005396 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005397 {not available when compiled without the |+eval|
5398 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005399 This option specifies a function to be used for Insert mode omni
5400 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005401 See |complete-functions| for an explanation of how the function is
5402 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005403 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005404 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005405 This option cannot be set from a |modeline| or in the |sandbox|, for
5406 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005407
5408
Bram Moolenaar02467872007-05-06 13:22:01 +00005409 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005410'opendevice' 'odev' boolean (default off)
5411 global
Bram Moolenaar043545e2006-10-10 16:44:07 +00005412 {only for MS-DOS, MS-Windows and OS/2}
5413 Enable reading and writing from devices. This may get Vim stuck on a
5414 device that can be opened but doesn't actually do the I/O. Therefore
5415 it is off by default.
5416 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5417 result in editing a device.
5418
5419
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005420 *'operatorfunc'* *'opfunc'*
5421'operatorfunc' 'opfunc' string (default: empty)
5422 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005423 This option specifies a function to be called by the |g@| operator.
5424 See |:map-operator| for more info and an example.
5425
5426 This option cannot be set from a |modeline| or in the |sandbox|, for
5427 security reasons.
5428
5429
Bram Moolenaar251e1912011-06-19 05:09:16 +02005430 *'osfiletype'* *'oft'*
5431'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005433 This option was supported on RISC OS, which has been removed.
5434
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005436 *'packpath'* *'pp'*
5437'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005438 Directories used to find packages. See |packages|.
5439
5440
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005442'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 global
5444 Specifies the nroff macros that separate paragraphs. These are pairs
5445 of two letters (see |object-motions|).
5446
5447 *'paste'* *'nopaste'*
5448'paste' boolean (default off)
5449 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005450 Put Vim in Paste mode. This is useful if you want to cut or copy
5451 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452 unexpected effects.
5453 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005454 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455 knows about pasting and will mostly do the right thing without 'paste'
5456 being set. The same is true for a terminal where Vim handles the
5457 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005458 This option is reset when starting the GUI. Thus if you set it in
5459 your .vimrc it will work in a terminal, but not in the GUI. Setting
5460 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5461 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462 When the 'paste' option is switched on (also when it was already on):
5463 - mapping in Insert mode and Command-line mode is disabled
5464 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005466 - 'expandtab' is reset
5467 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468 - 'revins' is reset
5469 - 'ruler' is reset
5470 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005471 - 'smartindent' is reset
5472 - 'smarttab' is reset
5473 - 'softtabstop' is set to 0
5474 - 'textwidth' is set to 0
5475 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005478 - 'indentexpr'
5479 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 NOTE: When you start editing another file while the 'paste' option is
5481 on, settings from the modelines or autocommands may change the
5482 settings again, causing trouble when pasting text. You might want to
5483 set the 'paste' option again.
5484 When the 'paste' option is reset the mentioned options are restored to
5485 the value before the moment 'paste' was switched from off to on.
5486 Resetting 'paste' before ever setting it does not have any effect.
5487 Since mapping doesn't work while 'paste' is active, you need to use
5488 the 'pastetoggle' option to toggle the 'paste' option with some key.
5489
5490 *'pastetoggle'* *'pt'*
5491'pastetoggle' 'pt' string (default "")
5492 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493 When non-empty, specifies the key sequence that toggles the 'paste'
5494 option. This is like specifying a mapping: >
5495 :map {keys} :set invpaste<CR>
5496< Where {keys} is the value of 'pastetoggle'.
5497 The difference is that it will work even when 'paste' is set.
5498 'pastetoggle' works in Insert mode and Normal mode, but not in
5499 Command-line mode.
5500 Mappings are checked first, thus overrule 'pastetoggle'. However,
5501 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5502 this: >
5503 :map <F10> :set paste<CR>
5504 :map <F11> :set nopaste<CR>
5505 :imap <F10> <C-O>:set paste<CR>
5506 :imap <F11> <nop>
5507 :set pastetoggle=<F11>
5508< This will make <F10> start paste mode and <F11> stop paste mode.
5509 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5510 mode everything is inserted literally, except the 'pastetoggle' key
5511 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005512 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513
5514 *'pex'* *'patchexpr'*
5515'patchexpr' 'pex' string (default "")
5516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005517 {not available when compiled without the |+diff|
5518 feature}
5519 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005520 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521
Bram Moolenaardbc28022014-07-26 13:40:44 +02005522 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005523'patchmode' 'pm' string (default "")
5524 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525 When non-empty the oldest version of a file is kept. This can be used
5526 to keep the original version of a file if you are changing files in a
5527 source distribution. Only the first time that a file is written a
5528 copy of the original file will be kept. The name of the copy is the
5529 name of the original file with the string in the 'patchmode' option
5530 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005531 ".orig" or ".org". 'backupdir' must not be empty for this to work
5532 (Detail: The backup file is renamed to the patchmode file after the
5533 new file has been successfully written, that's why it must be possible
5534 to write a backup file). If there was no file to be backed up, an
5535 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005536 When the 'backupskip' pattern matches, a patchmode file is not made.
5537 Using 'patchmode' for compressed files appends the extension at the
5538 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5539 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005540 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005542 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543'path' 'pa' string (default on Unix: ".,/usr/include,,"
5544 on OS/2: ".,/emx/include,,"
5545 other systems: ".,,")
5546 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005548 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5549 provided that the file being searched for has a relative path (not
5550 starting with "/", "./" or "../"). The directories in the 'path'
5551 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005552 - Use commas to separate directory names: >
5553 :set path=.,/usr/local/include,/usr/include
5554< - Spaces can also be used to separate directory names (for backwards
5555 compatibility with version 3.0). To have a space in a directory
5556 name, precede it with an extra backslash, and escape the space: >
5557 :set path=.,/dir/with\\\ space
5558< - To include a comma in a directory name precede it with an extra
5559 backslash: >
5560 :set path=.,/dir/with\\,comma
5561< - To search relative to the directory of the current file, use: >
5562 :set path=.
5563< - To search in the current directory use an empty string between two
5564 commas: >
5565 :set path=,,
5566< - A directory name may end in a ':' or '/'.
5567 - Environment variables are expanded |:set_env|.
5568 - When using |netrw.vim| URLs can be used. For example, adding
5569 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005570 - Search upwards and downwards in a directory tree using "*", "**" and
5571 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572 {not available when compiled without the |+path_extra| feature}
5573 - Careful with '\' characters, type two to get one in the option: >
5574 :set path=.,c:\\include
5575< Or just use '/' instead: >
5576 :set path=.,c:/include
5577< Don't forget "." or files won't even be found in the same directory as
5578 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005579 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 it is something like 256 or 1024 characters.
5581 You can check if all the include files are found, using the value of
5582 'path', see |:checkpath|.
5583 The use of |:set+=| and |:set-=| is preferred when adding or removing
5584 directories from the list. This avoids problems when a future version
5585 uses another default. To remove the current directory use: >
5586 :set path-=
5587< To add the current directory use: >
5588 :set path+=
5589< To use an environment variable, you probably need to replace the
5590 separator. Here is an example to append $INCL, in which directory
5591 names are separated with a semi-colon: >
5592 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5593< Replace the ';' with a ':' or whatever separator is used. Note that
5594 this doesn't work when $INCL contains a comma or white space.
5595
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005596 *'perldll'*
5597'perldll' string (default depends on the build)
5598 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005599 {only available when compiled with the |+perl/dyn|
5600 feature}
5601 Specifies the name of the Perl shared library. The default is
5602 DYNAMIC_PERL_DLL, which was specified at compile time.
5603 Environment variables are expanded |:set_env|.
5604 This option cannot be set from a |modeline| or in the |sandbox|, for
5605 security reasons.
5606
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5608'preserveindent' 'pi' boolean (default off)
5609 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005610 When changing the indent of the current line, preserve as much of the
5611 indent structure as possible. Normally the indent is replaced by a
5612 series of tabs followed by spaces as required (unless |'expandtab'| is
5613 enabled, in which case only spaces are used). Enabling this option
5614 means the indent will preserve as many existing characters as possible
5615 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005616 'expandtab' does not apply to the preserved white space, a Tab remains
5617 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 NOTE: When using ">>" multiple times the resulting indent is a mix of
5619 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005620 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621 Also see 'copyindent'.
5622 Use |:retab| to clean up white space.
5623
5624 *'previewheight'* *'pvh'*
5625'previewheight' 'pvh' number (default 12)
5626 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005628 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 Default height for a preview window. Used for |:ptag| and associated
5630 commands. Used for |CTRL-W_}| when no count is given.
5631
5632 *'previewwindow'* *'nopreviewwindow'*
5633 *'pvw'* *'nopvw'* *E590*
5634'previewwindow' 'pvw' boolean (default off)
5635 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005637 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005638 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005639 set. It's normally not set directly, but by using one of the commands
5640 |:ptag|, |:pedit|, etc.
5641
5642 *'printdevice'* *'pdev'*
5643'printdevice' 'pdev' string (default empty)
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 name of the printer to be used for |:hardcopy|.
5648 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005649 This option cannot be set from a |modeline| or in the |sandbox|, for
5650 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651
Bram Moolenaar8299df92004-07-10 09:47:34 +00005652 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005653'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655 {only available when compiled with the |+printer|
5656 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005657 Sets the character encoding used when printing.
5658 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659
5660 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005661'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663 {only available when compiled with the |+printer|
5664 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005665 Expression used to print the PostScript produced with |:hardcopy|.
5666 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005667 This option cannot be set from a |modeline| or in the |sandbox|, for
5668 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669
Bram Moolenaar8299df92004-07-10 09:47:34 +00005670 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671'printfont' 'pfn' string (default "courier")
5672 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673 {only available when compiled with the |+printer|
5674 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005675 The name of the font that will be used for |:hardcopy|.
5676 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005677
5678 *'printheader'* *'pheader'*
5679'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 {only available when compiled with the |+printer|
5682 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005683 The format of the header produced in |:hardcopy| output.
5684 See |pheader-option|.
5685
5686 *'printmbcharset'* *'pmbcs'*
5687'printmbcharset' 'pmbcs' string (default "")
5688 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005689 {only available when compiled with the |+printer|
5690 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005691 The CJK character set to be used for CJK output from |:hardcopy|.
5692 See |pmbcs-option|.
5693
5694 *'printmbfont'* *'pmbfn'*
5695'printmbfont' 'pmbfn' string (default "")
5696 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005697 {only available when compiled with the |+printer|
5698 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005699 List of font names to be used for CJK output from |:hardcopy|.
5700 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701
5702 *'printoptions'* *'popt'*
5703'printoptions' 'popt' string (default "")
5704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005706 List of items that control the format of the output of |:hardcopy|.
5707 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005709 *'prompt'* *'noprompt'*
5710'prompt' boolean (default on)
5711 global
5712 When on a ":" prompt is used in Ex mode.
5713
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005714 *'pumheight'* *'ph'*
5715'pumheight' 'ph' number (default 0)
5716 global
5717 {not available when compiled without the
5718 |+insert_expand| feature}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005719 Determines the maximum number of items to show in the popup menu for
5720 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005721 |ins-completion-menu|.
5722
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005723 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005724'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005725 global
5726 {not available when compiled without the
5727 |+insert_expand| feature}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005728 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005729 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005730
Bram Moolenaard94464e2015-11-02 15:28:18 +01005731 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005732'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005733 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005734 {only available when compiled with the |+python/dyn|
5735 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005736 Specifies the name of the Python 2.x shared library. The default is
5737 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005738 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005739 This option cannot be set from a |modeline| or in the |sandbox|, for
5740 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005741
Bram Moolenaar94073162018-01-31 21:49:05 +01005742 *'pythonhome'*
5743'pythonhome' string (default "")
5744 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005745 {only available when compiled with the |+python/dyn|
5746 feature}
5747 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5748 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5749 which was specified at compile time, will be used for the Python 2.x
5750 home directory.
5751 Environment variables are expanded |:set_env|.
5752 This option cannot be set from a |modeline| or in the |sandbox|, for
5753 security reasons.
5754
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005755 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005756'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005757 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005758 {only available when compiled with the |+python3/dyn|
5759 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005760 Specifies the name of the Python 3 shared library. The default is
5761 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005762 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005763 This option cannot be set from a |modeline| or in the |sandbox|, for
5764 security reasons.
5765
Bram Moolenaar94073162018-01-31 21:49:05 +01005766 *'pythonthreehome'*
5767'pythonthreehome' string (default "")
5768 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005769 {only available when compiled with the |+python3/dyn|
5770 feature}
5771 Specifies the name of the Python 3 home directory. When
5772 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5773 PYTHON3_HOME, which was specified at compile time, will be used for
5774 the Python 3 home directory.
5775 Environment variables are expanded |:set_env|.
5776 This option cannot be set from a |modeline| or in the |sandbox|, for
5777 security reasons.
5778
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005779 *'pyxversion'* *'pyx'*
5780'pyxversion' 'pyx' number (default depends on the build)
5781 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005782 {only available when compiled with the |+python| or
5783 the |+python3| feature}
5784 Specifies the python version used for pyx* functions and commands
5785 |python_x|. The default value is as follows:
5786
5787 Compiled with Default ~
5788 |+python| and |+python3| 0
5789 only |+python| 2
5790 only |+python3| 3
5791
5792 Available values are 0, 2 and 3.
5793 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5794 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5795 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5796 to 2 if Python 2 is available.
5797 See also: |has-pythonx|
5798
5799 If Vim is compiled with only |+python| or |+python3| setting
5800 'pyxversion' has no effect. The pyx* functions and commands are
5801 always the same as the compiled version.
5802
5803 This option cannot be set from a |modeline| or in the |sandbox|, for
5804 security reasons.
5805
Bram Moolenaar677ee682005-01-27 14:41:15 +00005806 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005807'quoteescape' 'qe' string (default "\")
5808 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005809 The characters that are used to escape quotes in a string. Used for
5810 objects like a', a" and a` |a'|.
5811 When one of the characters in this option is found inside a string,
5812 the following character will be skipped. The default value makes the
5813 text "foo\"bar\\" considered to be one string.
5814
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5816'readonly' 'ro' boolean (default off)
5817 local to buffer
5818 If on, writes fail unless you use a '!'. Protects you from
5819 accidentally overwriting a file. Default on when Vim is started
5820 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005821 When using ":w!" the 'readonly' option is reset for the current
5822 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005823 When using the ":view" command the 'readonly' option is set for the
5824 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005825 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005827 *'redrawtime'* *'rdt'*
5828'redrawtime' 'rdt' number (default 2000)
5829 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005830 {only available when compiled with the |+reltime|
5831 feature}
5832 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005833 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005834 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005835 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005836 matches will be highlighted.
5837 For syntax highlighting the time applies per window. When over the
5838 limit syntax highlighting is disabled until |CTRL-L| is used.
5839 This is used to avoid that Vim hangs when using a very complicated
5840 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005841
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005842 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005843'regexpengine' 're' number (default 0)
5844 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005845 This selects the default regexp engine. |two-engines|
5846 The possible values are:
5847 0 automatic selection
5848 1 old engine
5849 2 NFA engine
5850 Note that when using the NFA engine and the pattern contains something
5851 that is not supported the pattern will not match. This is only useful
5852 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005853 Using automatic selection enables Vim to switch the engine, if the
5854 default engine becomes too costly. E.g., when the NFA engine uses too
5855 many states. This should prevent Vim from hanging on a combination of
5856 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005857
Bram Moolenaar64486672010-05-16 15:46:46 +02005858 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5859'relativenumber' 'rnu' boolean (default off)
5860 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005861 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005862 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005863 precede some vertical motion commands (e.g. j k + -) with, without
5864 having to calculate it yourself. Especially useful in combination with
5865 other commands (e.g. y d c < > gq gw =).
5866 When the 'n' option is excluded from 'cpoptions' a wrapped
5867 line will not use the column of line numbers (this is the default when
5868 'compatible' isn't set).
5869 The 'numberwidth' option can be used to set the room used for the line
5870 number.
5871 When a long, wrapped line doesn't start with the first character, '-'
5872 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005873 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5874 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005875
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005876 The number in front of the cursor line also depends on the value of
5877 'number', see |number_relativenumber| for all combinations of the two
5878 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005879
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 *'remap'* *'noremap'*
5881'remap' boolean (default on)
5882 global
5883 Allows for mappings to work recursively. If you do not want this for
5884 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005885 NOTE: To avoid portability problems with Vim scripts, always keep
5886 this option at the default "on". Only switch it off when working with
5887 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005888
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005889 *'renderoptions'* *'rop'*
5890'renderoptions' 'rop' string (default: empty)
5891 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005892 {only available when compiled with GUI and DIRECTX on
5893 MS-Windows}
5894 Select a text renderer and set its options. The options depend on the
5895 renderer.
5896
5897 Syntax: >
5898 set rop=type:{renderer}(,{name}:{value})*
5899<
5900 Currently, only one optional renderer is available.
5901
5902 render behavior ~
5903 directx Vim will draw text using DirectX (DirectWrite). It makes
5904 drawn glyphs more beautiful than default GDI.
5905 It requires 'encoding' is "utf-8", and only works on
5906 MS-Windows Vista or newer version.
5907
5908 Options:
5909 name meaning type value ~
5910 gamma gamma float 1.0 - 2.2 (maybe)
5911 contrast enhancedContrast float (unknown)
5912 level clearTypeLevel float (unknown)
5913 geom pixelGeometry int 0 - 2 (see below)
5914 renmode renderingMode int 0 - 6 (see below)
5915 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01005916 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005917
Bram Moolenaar92467d32017-12-05 13:22:16 +01005918 See this URL for detail (except for scrlines):
5919 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005920
5921 For geom: structure of a device pixel.
5922 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5923 1 - DWRITE_PIXEL_GEOMETRY_RGB
5924 2 - DWRITE_PIXEL_GEOMETRY_BGR
5925
5926 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005927 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005928
5929 For renmode: method of rendering glyphs.
5930 0 - DWRITE_RENDERING_MODE_DEFAULT
5931 1 - DWRITE_RENDERING_MODE_ALIASED
5932 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5933 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5934 4 - DWRITE_RENDERING_MODE_NATURAL
5935 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5936 6 - DWRITE_RENDERING_MODE_OUTLINE
5937
5938 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005939 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005940
5941 For taamode: antialiasing mode used for drawing text.
5942 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5943 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5944 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5945 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5946
5947 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005948 https://msdn.microsoft.com/en-us/library/dd368170.aspx
5949
Bram Moolenaara338adc2018-01-31 20:51:47 +01005950 For scrlines:
5951 This was used for optimizing scrolling behavior, however this
5952 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005953
5954 Example: >
5955 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005956 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005957 set rop=type:directx
5958<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005959 If select a raster font (Courier, Terminal or FixedSys which
5960 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01005961 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005962
5963 NOTE: It is known that some fonts and options combination
5964 causes trouble on drawing glyphs.
5965
Bram Moolenaar92467d32017-12-05 13:22:16 +01005966 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005967 special made fonts (True-Type fonts which includes only
5968 bitmap glyphs).
5969 - 'taamode:3' will not work with some vector fonts.
5970
5971 NOTE: With this option, you can display colored emoji
5972 (emoticon) in Windows 8.1 or later. To display colored emoji,
5973 there are some conditions which you should notice.
5974
5975 - If your font includes non-colored emoji already, it will
5976 be used.
5977 - If your font doesn't have emoji, the system chooses an
5978 alternative symbol font. On Windows 10, "Segoe UI Emoji"
5979 will be used.
5980 - When this alternative font didn't have fixed width glyph,
5981 emoji might be rendered beyond the bounding box of drawing
5982 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005983
5984 Other render types are currently not supported.
5985
Bram Moolenaar071d4272004-06-13 20:20:40 +00005986 *'report'*
5987'report' number (default 2)
5988 global
5989 Threshold for reporting number of lines changed. When the number of
5990 changed lines is more than 'report' a message will be given for most
5991 ":" commands. If you want it always, set 'report' to 0.
5992 For the ":substitute" command the number of substitutions is used
5993 instead of the number of lines.
5994
5995 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5996'restorescreen' 'rs' boolean (default on)
5997 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005998 {only in Windows 95/NT console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999 When set, the screen contents is restored when exiting Vim. This also
6000 happens when executing external commands.
6001
6002 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6003 options in your .vimrc. To disable restoring:
6004 set t_ti= t_te=
6005 To enable restoring (for an xterm):
6006 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6007 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6008
6009 *'revins'* *'ri'* *'norevins'* *'nori'*
6010'revins' 'ri' boolean (default off)
6011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 {only available when compiled with the |+rightleft|
6013 feature}
6014 Inserting characters in Insert mode will work backwards. See "typing
6015 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6016 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006017 NOTE: This option is reset when 'compatible' is set.
6018 This option is reset when 'paste' is set and restored when 'paste' is
6019 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020
6021 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6022'rightleft' 'rl' boolean (default off)
6023 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006024 {only available when compiled with the |+rightleft|
6025 feature}
6026 When on, display orientation becomes right-to-left, i.e., characters
6027 that are stored in the file appear from the right to the left.
6028 Using this option, it is possible to edit files for languages that
6029 are written from the right to the left such as Hebrew and Arabic.
6030 This option is per window, so it is possible to edit mixed files
6031 simultaneously, or to view the same file in both ways (this is
6032 useful whenever you have a mixed text file with both right-to-left
6033 and left-to-right strings so that both sets are displayed properly
6034 in different windows). Also see |rileft.txt|.
6035
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006036 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037'rightleftcmd' 'rlc' string (default "search")
6038 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 {only available when compiled with the |+rightleft|
6040 feature}
6041 Each word in this option enables the command line editing to work in
6042 right-to-left mode for a group of commands:
6043
6044 search "/" and "?" commands
6045
6046 This is useful for languages such as Hebrew, Arabic and Farsi.
6047 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6048
Bram Moolenaard94464e2015-11-02 15:28:18 +01006049 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006050'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006051 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006052 {only available when compiled with the |+ruby/dyn|
6053 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006054 Specifies the name of the Ruby shared library. The default is
6055 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006056 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006057 This option cannot be set from a |modeline| or in the |sandbox|, for
6058 security reasons.
6059
Bram Moolenaar071d4272004-06-13 20:20:40 +00006060 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006061'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063 {not available when compiled without the
6064 |+cmdline_info| feature}
6065 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006066 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006067 text in the file is shown on the far right:
6068 Top first line is visible
6069 Bot last line is visible
6070 All first and last line are visible
6071 45% relative position in the file
6072 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006073 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006075 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006076 this option takes precedence over 'ruler' and 'rulerformat'
6077 If the number of characters displayed is different from the number of
6078 bytes in the text (e.g., for a TAB or a multi-byte character), both
6079 the text column (byte number) and the screen column are shown,
6080 separated with a dash.
6081 For an empty line "0-1" is shown.
6082 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006083 This option is reset when 'paste' is set and restored when 'paste' is
6084 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 If you don't want to see the ruler all the time but want to know where
6086 you are, use "g CTRL-G" |g_CTRL-G|.
6087 NOTE: This option is reset when 'compatible' is set.
6088
6089 *'rulerformat'* *'ruf'*
6090'rulerformat' 'ruf' string (default empty)
6091 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092 {not available when compiled without the |+statusline|
6093 feature}
6094 When this option is not empty, it determines the content of the ruler
6095 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006096 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006097 This option cannot be set in a modeline when 'modelineexpr' is off.
6098
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099 The default ruler width is 17 characters. To make the ruler 15
6100 characters wide, put "%15(" at the start and "%)" at the end.
6101 Example: >
6102 :set rulerformat=%15(%c%V\ %p%%%)
6103<
6104 *'runtimepath'* *'rtp'* *vimfiles*
6105'runtimepath' 'rtp' string (default:
6106 Unix: "$HOME/.vim,
6107 $VIM/vimfiles,
6108 $VIMRUNTIME,
6109 $VIM/vimfiles/after,
6110 $HOME/.vim/after"
6111 Amiga: "home:vimfiles,
6112 $VIM/vimfiles,
6113 $VIMRUNTIME,
6114 $VIM/vimfiles/after,
6115 home:vimfiles/after"
6116 PC, OS/2: "$HOME/vimfiles,
6117 $VIM/vimfiles,
6118 $VIMRUNTIME,
6119 $VIM/vimfiles/after,
6120 $HOME/vimfiles/after"
6121 Macintosh: "$VIM:vimfiles,
6122 $VIMRUNTIME,
6123 $VIM:vimfiles:after"
6124 RISC-OS: "Choices:vimfiles,
6125 $VIMRUNTIME,
6126 Choices:vimfiles/after"
6127 VMS: "sys$login:vimfiles,
6128 $VIM/vimfiles,
6129 $VIMRUNTIME,
6130 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006131 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006133 This is a list of directories which will be searched for runtime
6134 files:
6135 filetype.vim filetypes by file name |new-filetype|
6136 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006137 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 colors/ color scheme files |:colorscheme|
6139 compiler/ compiler files |:compiler|
6140 doc/ documentation |write-local-help|
6141 ftplugin/ filetype plugins |write-filetype-plugin|
6142 indent/ indent scripts |indent-expression|
6143 keymap/ key mapping files |mbyte-keymap|
6144 lang/ menu translations |:menutrans|
6145 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006146 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 plugin/ plugin scripts |write-plugin|
6148 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006149 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150 syntax/ syntax files |mysyntaxfile|
6151 tutor/ files for vimtutor |tutor|
6152
6153 And any other file searched for with the |:runtime| command.
6154
6155 The defaults for most systems are setup to search five locations:
6156 1. In your home directory, for your personal preferences.
6157 2. In a system-wide Vim directory, for preferences from the system
6158 administrator.
6159 3. In $VIMRUNTIME, for files distributed with Vim.
6160 *after-directory*
6161 4. In the "after" directory in the system-wide Vim directory. This is
6162 for the system administrator to overrule or add to the distributed
6163 defaults (rarely needed)
6164 5. In the "after" directory in your home directory. This is for
6165 personal preferences to overrule or add to the distributed defaults
6166 or system-wide settings (rarely needed).
6167
Bram Moolenaard0796902016-09-16 20:02:31 +02006168 More entries are added when using |packages|. If it gets very long
6169 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6170 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006171
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6173 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006174 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006175 wildcards.
6176 See |:runtime|.
6177 Example: >
6178 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6179< This will use the directory "~/vimruntime" first (containing your
6180 personal Vim runtime files), then "/mygroup/vim" (shared between a
6181 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6182 files).
6183 You probably should always include $VIMRUNTIME somewhere, to use the
6184 distributed runtime files. You can put a directory before $VIMRUNTIME
6185 to find files which replace a distributed runtime files. You can put
6186 a directory after $VIMRUNTIME to find files which add to distributed
6187 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006188 When Vim is started with |--clean| the home directory entries are not
6189 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 This option cannot be set from a |modeline| or in the |sandbox|, for
6191 security reasons.
6192
6193 *'scroll'* *'scr'*
6194'scroll' 'scr' number (default: half the window height)
6195 local to window
6196 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6197 set to half the number of lines in the window when the window size
6198 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006199 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006200 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201
6202 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6203'scrollbind' 'scb' boolean (default off)
6204 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205 See also |scroll-binding|. When this option is set, the current
6206 window scrolls as other scrollbind windows (windows that also have
6207 this option set) scroll. This option is useful for viewing the
6208 differences between two versions of a file, see 'diff'.
6209 See |'scrollopt'| for options that determine how this option should be
6210 interpreted.
6211 This option is mostly reset when splitting a window to edit another
6212 file. This means that ":split | edit file" results in two windows
6213 with scroll-binding, but ":split file" does not.
6214
6215 *'scrolljump'* *'sj'*
6216'scrolljump' 'sj' number (default 1)
6217 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 Minimal number of lines to scroll when the cursor gets off the
6219 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6220 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006221 When set to a negative number from -1 to -100 this is used as the
6222 percentage of the window height. Thus -50 scrolls half the window
6223 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006224 NOTE: This option is set to 1 when 'compatible' is set.
6225
6226 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006227'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006228 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229 Minimal number of screen lines to keep above and below the cursor.
6230 This will make some context visible around where you are working. If
6231 you set it to a very large value (999) the cursor line will always be
6232 in the middle of the window (except at the start or end of the file or
6233 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006234 After using the local value, go back the global value with one of
6235 these two: >
6236 setlocal scrolloff<
6237 setlocal scrolloff=-1
6238< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239 NOTE: This option is set to 0 when 'compatible' is set.
6240
6241 *'scrollopt'* *'sbo'*
6242'scrollopt' 'sbo' string (default "ver,jump")
6243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006245 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6246 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 The following words are available:
6248 ver Bind vertical scrolling for 'scrollbind' windows
6249 hor Bind horizontal scrolling for 'scrollbind' windows
6250 jump Applies to the offset between two windows for vertical
6251 scrolling. This offset is the difference in the first
6252 displayed line of the bound windows. When moving
6253 around in a window, another 'scrollbind' window may
6254 reach a position before the start or after the end of
6255 the buffer. The offset is not changed though, when
6256 moving back the 'scrollbind' window will try to scroll
6257 to the desired position when possible.
6258 When now making that window the current one, two
6259 things can be done with the relative offset:
6260 1. When "jump" is not included, the relative offset is
6261 adjusted for the scroll position in the new current
6262 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006263 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264 2. When "jump" is included, the other windows are
6265 scrolled to keep the same relative offset. When
6266 going back to the other window, it still uses the
6267 same relative offset.
6268 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006269 When 'diff' mode is active there always is vertical scroll binding,
6270 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271
6272 *'sections'* *'sect'*
6273'sections' 'sect' string (default "SHNHH HUnhsh")
6274 global
6275 Specifies the nroff macros that separate sections. These are pairs of
6276 two letters (See |object-motions|). The default makes a section start
6277 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6278
6279 *'secure'* *'nosecure'* *E523*
6280'secure' boolean (default off)
6281 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282 When on, ":autocmd", shell and write commands are not allowed in
6283 ".vimrc" and ".exrc" in the current directory and map commands are
6284 displayed. Switch it off only if you know that you will not run into
6285 problems, or when the 'exrc' option is off. On Unix this option is
6286 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006287 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006288 'secure' at the end of your ~/.vimrc then.
6289 This option cannot be set from a |modeline| or in the |sandbox|, for
6290 security reasons.
6291
6292 *'selection'* *'sel'*
6293'selection' 'sel' string (default "inclusive")
6294 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006295 This option defines the behavior of the selection. It is only used
6296 in Visual and Select mode.
6297 Possible values:
6298 value past line inclusive ~
6299 old no yes
6300 inclusive yes yes
6301 exclusive yes no
6302 "past line" means that the cursor is allowed to be positioned one
6303 character past the line.
6304 "inclusive" means that the last character of the selection is included
6305 in an operation. For example, when "x" is used to delete the
6306 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006307 When "old" is used and 'virtualedit' allows the cursor to move past
6308 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309 Note that when "exclusive" is used and selecting from the end
6310 backwards, you cannot include the last character of a line, when
6311 starting in Normal mode and 'virtualedit' empty.
6312
6313 The 'selection' option is set by the |:behave| command.
6314
6315 *'selectmode'* *'slm'*
6316'selectmode' 'slm' string (default "")
6317 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318 This is a comma separated list of words, which specifies when to start
6319 Select mode instead of Visual mode, when a selection is started.
6320 Possible values:
6321 mouse when using the mouse
6322 key when using shifted special keys
6323 cmd when using "v", "V" or CTRL-V
6324 See |Select-mode|.
6325 The 'selectmode' option is set by the |:behave| command.
6326
6327 *'sessionoptions'* *'ssop'*
6328'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006329 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006330 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006331 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 feature}
6333 Changes the effect of the |:mksession| command. It is a comma
6334 separated list of words. Each word enables saving and restoring
6335 something:
6336 word save and restore ~
6337 blank empty windows
6338 buffers hidden and unloaded buffers, not just those in windows
6339 curdir the current directory
6340 folds manually created folds, opened/closed folds and local
6341 fold options
6342 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006343 and contain at least one lowercase letter. Only
6344 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 help the help window
6346 localoptions options and mappings local to a window or buffer (not
6347 global values for local options)
6348 options all options and mappings (also global values for local
6349 options)
6350 resize size of the Vim window: 'lines' and 'columns'
6351 sesdir the directory in which the session file is located
6352 will become the current directory (useful with
6353 projects accessed over a network from different
6354 systems)
6355 slash backslashes in file names replaced with forward
6356 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006357 tabpages all tab pages; without this only the current tab page
6358 is restored, so that you can make a session for each
6359 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006360 terminal include terminal windows where the command can be
6361 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 unix with Unix end-of-line format (single <NL>), even when
6363 on Windows or DOS
6364 winpos position of the whole Vim window
6365 winsize window sizes
6366
6367 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006368 When neither "curdir" nor "sesdir" is included, file names are stored
6369 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 "slash" and "unix" are useful on Windows when sharing session files
6371 with Unix. The Unix version of Vim cannot source dos format scripts,
6372 but the Windows version of Vim can source unix format scripts.
6373
6374 *'shell'* *'sh'* *E91*
6375'shell' 'sh' string (default $SHELL or "sh",
6376 MS-DOS and Win32: "command.com" or
6377 "cmd.exe", OS/2: "cmd")
6378 global
6379 Name of the shell to use for ! and :! commands. When changing the
6380 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6381 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006382 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383 See |option-backslash| about including spaces and backslashes.
6384 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006385
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006387 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6389< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006390 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006392 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006394 Example with escaped space (Vim will do this when initializing the
6395 option from $SHELL): >
6396 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006397< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006398 backslashes are consumed by `:set`.
6399
Bram Moolenaar071d4272004-06-13 20:20:40 +00006400 Under MS-Windows, when the executable ends in ".com" it must be
6401 included. Thus setting the shell to "command.com" or "4dos.com"
6402 works, but "command" and "4dos" do not work for all commands (e.g.,
6403 filtering).
6404 For unknown reasons, when using "4dos.com" the current directory is
6405 changed to "C:\". To avoid this set 'shell' like this: >
6406 :set shell=command.com\ /c\ 4dos
6407< This option cannot be set from a |modeline| or in the |sandbox|, for
6408 security reasons.
6409
6410 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006411'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006412 MS-DOS and Win32, when 'shell' does not
6413 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6416 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6417 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006418 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006419 On Unix it can have more than one flag. Each white space separated
6420 part is passed as an argument to the shell command.
6421 See |option-backslash| about including spaces and backslashes.
6422 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006423 This option cannot be set from a |modeline| or in the |sandbox|, for
6424 security reasons.
6425
6426 *'shellpipe'* *'sp'*
6427'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6428 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 {not available when compiled without the |+quickfix|
6430 feature}
6431 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006432 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 including spaces and backslashes.
6434 The name of the temporary file can be represented by "%s" if necessary
6435 (the file name is appended automatically if no %s appears in the value
6436 of this option).
6437 For the Amiga and MS-DOS the default is ">". The output is directly
6438 saved in a file and not echoed to the screen.
6439 For Unix the default it "| tee". The stdout of the compiler is saved
6440 in a file and echoed to the screen. If the 'shell' option is "csh" or
6441 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006442 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6443 default becomes "2>&1| tee". This means that stderr is also included.
6444 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6445 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006446 The initialization of this option is done after reading the ".vimrc"
6447 and the other initializations, so that when the 'shell' option is set
6448 there, the 'shellpipe' option changes automatically, unless it was
6449 explicitly set before.
6450 When 'shellpipe' is set to an empty string, no redirection of the
6451 ":make" output will be done. This is useful if you use a 'makeprg'
6452 that writes to 'makeef' by itself. If you want no piping, but do
6453 want to include the 'makeef', set 'shellpipe' to a single space.
6454 Don't forget to precede the space with a backslash: ":set sp=\ ".
6455 In the future pipes may be used for filtering and this option will
6456 become obsolete (at least for Unix).
6457 This option cannot be set from a |modeline| or in the |sandbox|, for
6458 security reasons.
6459
6460 *'shellquote'* *'shq'*
6461'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6462 contains "sh" somewhere: "\"")
6463 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464 Quoting character(s), put around the command passed to the shell, for
6465 the "!" and ":!" commands. The redirection is kept outside of the
6466 quoting. See 'shellxquote' to include the redirection. It's
6467 probably not useful to set both options.
6468 This is an empty string by default. Only known to be useful for
6469 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6470 or bash, where it should be "\"". The default is adjusted according
6471 the value of 'shell', to reduce the need to set this option by the
6472 user. See |dos-shell|.
6473 This option cannot be set from a |modeline| or in the |sandbox|, for
6474 security reasons.
6475
6476 *'shellredir'* *'srr'*
6477'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6478 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 String to be used to put the output of a filter command in a temporary
6480 file. See also |:!|. See |option-backslash| about including spaces
6481 and backslashes.
6482 The name of the temporary file can be represented by "%s" if necessary
6483 (the file name is appended automatically if no %s appears in the value
6484 of this option).
6485 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6486 or "zsh" during initializations, the default becomes ">&". If the
6487 'shell' option is "sh", "ksh" or "bash" the default becomes
6488 ">%s 2>&1". This means that stderr is also included.
6489 For Win32, the Unix checks are done and additionally "cmd" is checked
6490 for, which makes the default ">%s 2>&1". Also, the same names with
6491 ".exe" appended are checked for.
6492 The initialization of this option is done after reading the ".vimrc"
6493 and the other initializations, so that when the 'shell' option is set
6494 there, the 'shellredir' option changes automatically unless it was
6495 explicitly set before.
6496 In the future pipes may be used for filtering and this option will
6497 become obsolete (at least for Unix).
6498 This option cannot be set from a |modeline| or in the |sandbox|, for
6499 security reasons.
6500
6501 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6502'shellslash' 'ssl' boolean (default off)
6503 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006504 {only for MSDOS, MS-Windows and OS/2}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505 When set, a forward slash is used when expanding file names. This is
6506 useful when a Unix-like shell is used instead of command.com or
6507 cmd.exe. Backward slashes can still be typed, but they are changed to
6508 forward slashes by Vim.
6509 Note that setting or resetting this option has no effect for some
6510 existing file names, thus this option needs to be set before opening
6511 any file for best results. This might change in the future.
6512 'shellslash' only works when a backslash can be used as a path
6513 separator. To test if this is so use: >
6514 if exists('+shellslash')
6515<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006516 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6517'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6518 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006519 When on, use temp files for shell commands. When off use a pipe.
6520 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006521 Currently a pipe is only supported on Unix and MS-Windows 2K and
6522 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006523 :if has("filterpipe")
6524< The advantage of using a pipe is that nobody can read the temp file
6525 and the 'shell' command does not need to support redirection.
6526 The advantage of using a temp file is that the file type and encoding
6527 can be detected.
6528 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6529 |FilterWritePost| autocommands event are not triggered when
6530 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006531 The `system()` function does not respect this option and always uses
6532 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006533 NOTE: This option is set to the Vim default value when 'compatible'
6534 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006535
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 *'shelltype'* *'st'*
6537'shelltype' 'st' number (default 0)
6538 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006539 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 On the Amiga this option influences the way how the commands work
6541 which use a shell.
6542 0 and 1: always use the shell
6543 2 and 3: use the shell only to filter lines
6544 4 and 5: use shell only for ':sh' command
6545 When not using the shell, the command is executed directly.
6546
6547 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6548 1 and 3: use "shell cmd" to start external commands
6549
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006550 *'shellxescape'* *'sxe'*
6551'shellxescape' 'sxe' string (default: "";
6552 for MS-DOS and MS-Windows: "\"&|<>()@^")
6553 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006554 When 'shellxquote' is set to "(" then the characters listed in this
6555 option will be escaped with a '^' character. This makes it possible
6556 to execute most external commands with cmd.exe.
6557
Bram Moolenaar071d4272004-06-13 20:20:40 +00006558 *'shellxquote'* *'sxq'*
6559'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006560 for Win32, when 'shell' is cmd.exe: "("
6561 for Win32, when 'shell' contains "sh"
6562 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 for Unix, when using system(): "\"")
6564 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 Quoting character(s), put around the command passed to the shell, for
6566 the "!" and ":!" commands. Includes the redirection. See
6567 'shellquote' to exclude the redirection. It's probably not useful
6568 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006569 When the value is '(' then ')' is appended. When the value is '"('
6570 then ')"' is appended.
6571 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006572 This is an empty string by default on most systems, but is known to be
6573 useful for on Win32 version, either for cmd.exe which automatically
6574 strips off the first and last quote on a command, or 3rd-party shells
6575 such as the MKS Korn Shell or bash, where it should be "\"". The
6576 default is adjusted according the value of 'shell', to reduce the need
6577 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 This option cannot be set from a |modeline| or in the |sandbox|, for
6579 security reasons.
6580
6581 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6582'shiftround' 'sr' boolean (default off)
6583 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584 Round indent to multiple of 'shiftwidth'. Applies to > and <
6585 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6586 a multiple of 'shiftwidth' (this is Vi compatible).
6587 NOTE: This option is reset when 'compatible' is set.
6588
6589 *'shiftwidth'* *'sw'*
6590'shiftwidth' 'sw' number (default 8)
6591 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006592 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006593 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006594 When zero the 'ts' value will be used. Use the |shiftwidth()|
6595 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596
6597 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006598'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6599 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 This option helps to avoid all the |hit-enter| prompts caused by file
6602 messages, for example with CTRL-G, and to avoid some other messages.
6603 It is a list of flags:
6604 flag meaning when present ~
6605 f use "(3 of 5)" instead of "(file 3 of 5)"
6606 i use "[noeol]" instead of "[Incomplete last line]"
6607 l use "999L, 888C" instead of "999 lines, 888 characters"
6608 m use "[+]" instead of "[Modified]"
6609 n use "[New]" instead of "[New File]"
6610 r use "[RO]" instead of "[readonly]"
6611 w use "[w]" instead of "written" for file write message
6612 and "[a]" instead of "appended" for ':w >> file' command
6613 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6614 "[unix format]" and "[mac]" instead of "[mac format]".
6615 a all of the above abbreviations
6616
6617 o overwrite message for writing a file with subsequent message
6618 for reading a file (useful for ":wn" or when 'autowrite' on)
6619 O message for reading a file overwrites any previous message.
6620 Also for quickfix message (e.g., ":cn").
6621 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006622 hit TOP, continuing at BOTTOM" messages; when using the search
6623 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006624 t truncate file message at the start if it is too long to fit
6625 on the command-line, "<" will appear in the left most column.
6626 Ignored in Ex mode.
6627 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006628 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 Ignored in Ex mode.
6630 W don't give "written" or "[w]" when writing a file
6631 A don't give the "ATTENTION" message when an existing swap file
6632 is found.
6633 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006634 c don't give |ins-completion-menu| messages. For example,
6635 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6636 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006637 q use "recording" instead of "recording @a"
6638 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006639 was used for the command; note that this also affects messages
6640 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006641 S do not show search count message when searching, e.g.
6642 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006643
6644 This gives you the opportunity to avoid that a change between buffers
6645 requires you to hit <Enter>, but still gives as useful a message as
6646 possible for the space available. To get the whole message that you
6647 would have got with 'shm' empty, use ":file!"
6648 Useful values:
6649 shm= No abbreviation of message.
6650 shm=a Abbreviation, but no loss of information.
6651 shm=at Abbreviation, and truncate message when necessary.
6652
6653 NOTE: This option is set to the Vi default value when 'compatible' is
6654 set and to the Vim default value when 'compatible' is reset.
6655
6656 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6657'shortname' 'sn' boolean (default off)
6658 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659 Filenames are assumed to be 8 characters plus one extension of 3
6660 characters. Multiple dots in file names are not allowed. When this
6661 option is on, dots in file names are replaced with underscores when
6662 adding an extension (".~" or ".swp"). This option is not available
6663 for MS-DOS, because then it would always be on. This option is useful
6664 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6665 or crossdos. When running the Win32 GUI version under Win32s, this
6666 option is always on by default.
6667
6668 *'showbreak'* *'sbr'* *E595*
6669'showbreak' 'sbr' string (default "")
6670 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006671 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 feature}
6673 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006674 values are "> " or "+++ ": >
6675 :set showbreak=>\
6676< Note the backslash to escape the trailing space. It's easier like
6677 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006678 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006679< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 comma (in a future version the comma might be used to separate the
6681 part that is shown at the end and at the start of a line).
6682 The characters are highlighted according to the '@' flag in
6683 'highlight'.
6684 Note that tabs after the showbreak will be displayed differently.
6685 If you want the 'showbreak' to appear in between line numbers, add the
6686 "n" flag to 'cpoptions'.
6687
6688 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006689'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6690 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006691 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 {not available when compiled without the
6693 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006694 Show (partial) command in the last line of the screen. Set this
6695 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 In Visual mode the size of the selected area is shown:
6697 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006698 If the number of bytes is different it is also displayed: "2-6"
6699 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006701 - When selecting a block, the size in screen characters:
6702 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703 NOTE: This option is set to the Vi default value when 'compatible' is
6704 set and to the Vim default value when 'compatible' is reset.
6705
6706 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6707'showfulltag' 'sft' boolean (default off)
6708 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 When completing a word in insert mode (see |ins-completion|) from the
6710 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006711 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712 matched a C function, you can see a template for what arguments are
6713 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006714 Note that this doesn't work well together with having "longest" in
6715 'completeopt', because the completion from the search pattern may not
6716 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717
6718 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6719'showmatch' 'sm' boolean (default off)
6720 global
6721 When a bracket is inserted, briefly jump to the matching one. The
6722 jump is only done if the match can be seen on the screen. The time to
6723 show the match can be set with 'matchtime'.
6724 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006725 seen or not).
6726 This option is reset when 'paste' is set and restored when 'paste' is
6727 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 When the 'm' flag is not included in 'cpoptions', typing a character
6729 will immediately move the cursor back to where it belongs.
6730 See the "sm" field in 'guicursor' for setting the cursor shape and
6731 blinking when showing the match.
6732 The 'matchpairs' option can be used to specify the characters to show
6733 matches for. 'rightleft' and 'revins' are used to look for opposite
6734 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006735 Also see the matchparen plugin for highlighting the match when moving
6736 around |pi_paren.txt|.
6737 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738
6739 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6740'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6741 global
6742 If in Insert, Replace or Visual mode put a message on the last line.
6743 Use the 'M' flag in 'highlight' to set the type of highlighting for
6744 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006745 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746 doesn't mean XIM is really active, especially when 'imactivatekey' is
6747 not set.
6748 NOTE: This option is set to the Vi default value when 'compatible' is
6749 set and to the Vim default value when 'compatible' is reset.
6750
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006751 *'showtabline'* *'stal'*
6752'showtabline' 'stal' number (default 1)
6753 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006754 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006755 feature}
6756 The value of this option specifies when the line with tab page labels
6757 will be displayed:
6758 0: never
6759 1: only if there are at least two tab pages
6760 2: always
6761 This is both for the GUI and non-GUI implementation of the tab pages
6762 line.
6763 See |tab-page| for more information about tab pages.
6764
Bram Moolenaar071d4272004-06-13 20:20:40 +00006765 *'sidescroll'* *'ss'*
6766'sidescroll' 'ss' number (default 0)
6767 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768 The minimal number of columns to scroll horizontally. Used only when
6769 the 'wrap' option is off and the cursor is moved off of the screen.
6770 When it is zero the cursor will be put in the middle of the screen.
6771 When using a slow terminal set it to a large number or 0. When using
6772 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6773 commands.
6774
6775 *'sidescrolloff'* *'siso'*
6776'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006777 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006778 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006779 right of the cursor if 'nowrap' is set. Setting this option to a
6780 value greater than 0 while having |'sidescroll'| also at a non-zero
6781 value makes some context visible in the line you are scrolling in
6782 horizontally (except at beginning of the line). Setting this option
6783 to a large value (like 999) has the effect of keeping the cursor
6784 horizontally centered in the window, as long as one does not come too
6785 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006786 After using the local value, go back the global value with one of
6787 these two: >
6788 setlocal sidescrolloff<
6789 setlocal sidescrolloff=-1
6790< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791
6792 Example: Try this together with 'sidescroll' and 'listchars' as
6793 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006794 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795
6796 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6797 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006798<
6799 *'signcolumn'* *'scl'*
6800'signcolumn' 'scl' string (default "auto")
6801 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006802 {not available when compiled without the |+signs|
6803 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006804 Whether or not to draw the signcolumn. Valid values are:
6805 "auto" only when there is a sign to display
6806 "no" never
6807 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808
6809
6810 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6811'smartcase' 'scs' boolean (default off)
6812 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 Override the 'ignorecase' option if the search pattern contains upper
6814 case characters. Only used when the search pattern is typed and
6815 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006816 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6818 recalling the search pattern from history and hitting <Enter>.
6819 NOTE: This option is reset when 'compatible' is set.
6820
6821 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6822'smartindent' 'si' boolean (default off)
6823 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 {not available when compiled without the
6825 |+smartindent| feature}
6826 Do smart autoindenting when starting a new line. Works for C-like
6827 programs, but can also be used for other languages. 'cindent' does
6828 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006829 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006830 setting 'si' has no effect. 'indentexpr' is a more advanced
6831 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832 Normally 'autoindent' should also be on when using 'smartindent'.
6833 An indent is automatically inserted:
6834 - After a line ending in '{'.
6835 - After a line starting with a keyword from 'cinwords'.
6836 - Before a line starting with '}' (only with the "O" command).
6837 When typing '}' as the first character in a new line, that line is
6838 given the same indent as the matching '{'.
6839 When typing '#' as the first character in a new line, the indent for
6840 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006841 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6843 When using the ">>" command, lines starting with '#' are not shifted
6844 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006845 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006846 This option is reset when 'paste' is set and restored when 'paste' is
6847 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848
6849 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6850'smarttab' 'sta' boolean (default off)
6851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006853 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6854 <BS> will delete a 'shiftwidth' worth of space at the start of the
6855 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006856 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006857 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6858 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006859 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006861 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006862 This option is reset when 'paste' is set and restored when 'paste' is
6863 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864 NOTE: This option is reset when 'compatible' is set.
6865
6866 *'softtabstop'* *'sts'*
6867'softtabstop' 'sts' number (default 0)
6868 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 Number of spaces that a <Tab> counts for while performing editing
6870 operations, like inserting a <Tab> or using <BS>. It "feels" like
6871 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6872 used. This is useful to keep the 'ts' setting at its standard value
6873 of 8, while being able to edit like it is set to 'sts'. However,
6874 commands like "x" still work on the actual characters.
6875 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006876 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006877 'softtabstop' is set to 0 when the 'paste' option is set and restored
6878 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6880 spaces is minimized by using <Tab>s.
6881 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6882 set.
6883 NOTE: This option is set to 0 when 'compatible' is set.
6884
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006885 If Vim is compiled with the |+vartabs| feature then the value of
6886 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6887 anything other than an empty string.
6888
Bram Moolenaar217ad922005-03-20 22:37:15 +00006889 *'spell'* *'nospell'*
6890'spell' boolean (default off)
6891 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006892 {not available when compiled without the |+syntax|
6893 feature}
6894 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006895 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006896
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006897 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006898'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006899 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006900 {not available when compiled without the |+syntax|
6901 feature}
6902 Pattern to locate the end of a sentence. The following word will be
6903 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006904 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006905 When this check is not wanted make this option empty.
6906 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006907 Be careful with special characters, see |option-backslash| about
6908 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006909 To set this option automatically depending on the language, see
6910 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006911
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006912 *'spellfile'* *'spf'*
6913'spellfile' 'spf' string (default empty)
6914 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006915 {not available when compiled without the |+syntax|
6916 feature}
6917 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006918 commands. It must end in ".{encoding}.add". You need to include the
6919 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006920 *E765*
6921 It may also be a comma separated list of names. A count before the
6922 |zg| and |zw| commands can be used to access each. This allows using
6923 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006924 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006925 you: Using the first directory in 'runtimepath' that is writable. If
6926 there is no "spell" directory yet it will be created. For the file
6927 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006928 ignoring the region.
6929 The resulting ".spl" file will be used for spell checking, it does not
6930 have to appear in 'spelllang'.
6931 Normally one file is used for all regions, but you can add the region
6932 name if you want to. However, it will then only be used when
6933 'spellfile' is set to it, for entries in 'spelllang' only files
6934 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006935 This option cannot be set from a |modeline| or in the |sandbox|, for
6936 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006937
Bram Moolenaar217ad922005-03-20 22:37:15 +00006938 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006939'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006940 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00006941 {not available when compiled without the |+syntax|
6942 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006943 A comma separated list of word list names. When the 'spell' option is
6944 on spellchecking will be done for these languages. Example: >
6945 set spelllang=en_us,nl,medical
6946< This means US English, Dutch and medical words are recognized. Words
6947 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02006948 The word list name must consist of alphanumeric characters, a dash or
6949 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00006950 recommended to separate the two letter language name from a
6951 specification. Thus "en-rare" is used for rare English words.
6952 A region name must come last and have the form "_xx", where "xx" is
6953 the two-letter, lower case region name. You can use more than one
6954 region by listing them: "en_us,en_ca" supports both US and Canadian
6955 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01006956 Britain. (Note: currently en_au and en_nz dictionaries are older than
6957 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006958 If the name "cjk" is included East Asian characters are excluded from
6959 spell checking. This is useful when editing text that also has Asian
6960 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006961 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006962 As a special case the name of a .spl file can be given as-is. The
6963 first "_xx" in the name is removed and used as the region name
6964 (_xx is an underscore, two letters and followed by a non-letter).
6965 This is mainly for testing purposes. You must make sure the correct
6966 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006967 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006968 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6969 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006970 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006971
Bram Moolenaar98692072006-02-04 00:57:42 +00006972 If the |spellfile.vim| plugin is active and you use a language name
6973 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6974 will ask you if you want to download the file.
6975
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006976 After this option has been set successfully, Vim will source the files
6977 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01006978 up to the first character that is not an ASCII letter or number and
6979 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006980
6981
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006982 *'spellsuggest'* *'sps'*
6983'spellsuggest' 'sps' string (default "best")
6984 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006985 {not available when compiled without the |+syntax|
6986 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006987 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006988 the |spellsuggest()| function. This is a comma-separated list of
6989 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006990
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006991 best Internal method that works best for English. Finds
6992 changes like "fast" and uses a bit of sound-a-like
6993 scoring to improve the ordering.
6994
6995 double Internal method that uses two methods and mixes the
6996 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006997 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006998 word. That only works when the language specifies
6999 sound folding. Can be slow and doesn't always give
7000 better results.
7001
7002 fast Internal method that only checks for simple changes:
7003 character inserts/deletes/swaps. Works well for
7004 simple typing mistakes.
7005
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007006 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007007 Not used for |spellsuggest()|. The number of
7008 suggestions is never more than the value of 'lines'
7009 minus two.
7010
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007011 file:{filename} Read file {filename}, which must have two columns,
7012 separated by a slash. The first column contains the
7013 bad word, the second column the suggested good word.
7014 Example:
7015 theribal/terrible ~
7016 Use this for common mistakes that do not appear at the
7017 top of the suggestion list with the internal methods.
7018 Lines without a slash are ignored, use this for
7019 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007020 The word in the second column must be correct,
7021 otherwise it will not be used. Add the word to an
7022 ".add" file if it is currently flagged as a spelling
7023 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007024 The file is used for all languages.
7025
7026 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7027 trouble with spaces. |v:val| holds the badly spelled
7028 word. The expression must evaluate to a List of
7029 Lists, each with a suggestion and a score.
7030 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007031 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007032 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007033 internal methods use. A lower score is better.
7034 This may invoke |spellsuggest()| if you temporarily
7035 set 'spellsuggest' to exclude the "expr:" part.
7036 Errors are silently ignored, unless you set the
7037 'verbose' option to a non-zero value.
7038
7039 Only one of "best", "double" or "fast" may be used. The others may
7040 appear several times in any order. Example: >
7041 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7042<
7043 This option cannot be set from a |modeline| or in the |sandbox|, for
7044 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007045
7046
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7048'splitbelow' 'sb' boolean (default off)
7049 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007050 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007051 feature}
7052 When on, splitting a window will put the new window below the current
7053 one. |:split|
7054
7055 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7056'splitright' 'spr' boolean (default off)
7057 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007058 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 feature}
7060 When on, splitting a window will put the new window right of the
7061 current one. |:vsplit|
7062
7063 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7064'startofline' 'sol' boolean (default on)
7065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007067 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007068 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007069 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 with a linewise operator, with "%" with a count and to buffer changing
7071 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7072 only has a line number, e.g., ":25" or ":+".
7073 In case of buffer changing commands the cursor is placed at the column
7074 where it was the last time the buffer was edited.
7075 NOTE: This option is set when 'compatible' is set.
7076
Bram Moolenaar00654022011-02-25 14:42:19 +01007077 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007079 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080 {not available when compiled without the |+statusline|
7081 feature}
7082 When nonempty, this option determines the content of the status line.
7083 Also see |status-line|.
7084
7085 The option consists of printf style '%' items interspersed with
7086 normal text. Each status line item is of the form:
7087 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007088 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007089 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090
Bram Moolenaar238a5642006-02-21 22:12:05 +00007091 When the option starts with "%!" then it is used as an expression,
7092 evaluated and the result is used as the option value. Example: >
7093 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007094< The *g:statusline_winid* variable will be set to the |window-ID| of the
7095 window that the status line belongs to.
7096 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007097 Note that the "%!" expression is evaluated in the context of the
7098 current window and buffer, while %{} items are evaluated in the
7099 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007100
7101 When there is error while evaluating the option then it will be made
7102 empty to avoid further errors. Otherwise screen updating would loop.
7103
Bram Moolenaar071d4272004-06-13 20:20:40 +00007104 Note that the only effect of 'ruler' when this option is set (and
7105 'laststatus' is 2) is controlling the output of |CTRL-G|.
7106
7107 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007108 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007110 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 minwid Minimum width of the item, padding as set by '-' & '0'.
7112 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007113 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 on the left for text items. Numeric items will be
7115 shifted down to maxwid-2 digits followed by '>'number
7116 where number is the amount of missing digits, much like
7117 an exponential notation.
7118 item A one letter code as described below.
7119
7120 Following is a description of the possible statusline items. The
7121 second character in "item" is the type:
7122 N for number
7123 S for string
7124 F for flags as described below
7125 - not applicable
7126
7127 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007128 f S Path to the file in the buffer, as typed or relative to current
7129 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 F S Full path to the file in the buffer.
7131 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007132 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007134 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007136 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007138 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007140 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007142 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7144 being used: "<keymap>"
7145 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007146 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 B N As above, in hexadecimal.
7148 o N Byte number in file of byte under cursor, first byte is 1.
7149 Mnemonic: Offset from start of file (with one added)
7150 {not available when compiled without |+byte_offset| feature}
7151 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007152 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 l N Line number.
7154 L N Number of lines in buffer.
7155 c N Column number.
7156 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007157 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007158 p N Percentage through file in lines as in |CTRL-G|.
7159 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007160 percentage described for 'ruler'. Always 3 in length, unless
7161 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007162 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007164 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007165 Note that there is no '%' before the closing '}'. The
7166 expression cannot contain a '}' character, call a function to
7167 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168 ( - Start of item group. Can be used for setting the width and
7169 alignment of a section. Must be followed by %) somewhere.
7170 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007171 T N For 'tabline': start of tab page N label. Use %T after the last
7172 label. This information is used for mouse clicks.
7173 X N For 'tabline': start of close tab N label. Use %X after the
7174 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7175 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176 < - Where to truncate line if too long. Default is at the start.
7177 No width fields allowed.
7178 = - Separation point between left and right aligned items.
7179 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007180 # - Set highlight group. The name must follow and then a # again.
7181 Thus use %#HLname# for highlight group HLname. The same
7182 highlighting is used, also for the statusline of non-current
7183 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007184 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007185 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007186 The difference between User{N} and StatusLine will be applied
7187 to StatusLineNC for the statusline of non-current windows.
7188 The number N must be between 1 and 9. See |hl-User1..9|
7189
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007190 When displaying a flag, Vim removes the leading comma, if any, when
7191 that flag comes right after plaintext. This will make a nice display
7192 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193
Bram Moolenaar582fd852005-03-28 20:58:01 +00007194 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007195 not set) and a minwid is not set for the group, the whole group will
7196 become empty. This will make a group like the following disappear
7197 completely from the statusline when none of the flags are set. >
7198 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007199< Beware that an expression is evaluated each and every time the status
7200 line is displayed.
7201 *g:actual_curbuf* *g:actual_curwin*
7202 The current buffer and current window will be set temporarily to that
7203 of the window (and buffer) whose statusline is currently being drawn.
7204 The expression will evaluate in this context. The variable
7205 "g:actual_curbuf" is set to the `bufnr()` number of the real current
7206 buffer and "g:actual_curwin" to the |window-ID| of the real current
7207 window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007208
Bram Moolenaar30b65812012-07-12 22:01:11 +02007209 The 'statusline' option will be evaluated in the |sandbox| if set from
7210 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007211 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007212
7213 It is not allowed to change text or jump to another window while
7214 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215
7216 If the statusline is not updated when you want it (e.g., after setting
7217 a variable that's used in an expression), you can force an update by
7218 setting an option without changing its value. Example: >
7219 :let &ro = &ro
7220
7221< A result of all digits is regarded a number for display purposes.
7222 Otherwise the result is taken as flag text and applied to the rules
7223 described above.
7224
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007225 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007226 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007227 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228
7229 Examples:
7230 Emulate standard status line with 'ruler' set >
7231 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7232< Similar, but add ASCII value of char under the cursor (like "ga") >
7233 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7234< Display byte count and byte value, modified flag in red. >
7235 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7236 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7237< Display a ,GZ flag if a compressed file is loaded >
7238 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7239< In the |:autocmd|'s: >
7240 :let b:gzflag = 1
7241< And: >
7242 :unlet b:gzflag
7243< And define this function: >
7244 :function VarExists(var, val)
7245 : if exists(a:var) | return a:val | else | return '' | endif
7246 :endfunction
7247<
7248 *'suffixes'* *'su'*
7249'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007251 Files with these suffixes get a lower priority when multiple files
7252 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007253 suffixes. Spaces after the comma are ignored. A dot is also seen as
7254 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 separator, precede it with a backslash (see |option-backslash| about
7256 including spaces and backslashes).
7257 See 'wildignore' for completely ignoring files.
7258 The use of |:set+=| and |:set-=| is preferred when adding or removing
7259 suffixes from the list. This avoids problems when a future version
7260 uses another default.
7261
7262 *'suffixesadd'* *'sua'*
7263'suffixesadd' 'sua' string (default "")
7264 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265 {not available when compiled without the
7266 |+file_in_path| feature}
7267 Comma separated list of suffixes, which are used when searching for a
7268 file for the "gf", "[I", etc. commands. Example: >
7269 :set suffixesadd=.java
7270<
7271 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7272'swapfile' 'swf' boolean (default on)
7273 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007274 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 swapfile is not wanted for a specific buffer. For example, with
7276 confidential information that even root must not be able to access.
7277 Careful: All text will be in memory:
7278 - Don't use this for big files.
7279 - Recovery will be impossible!
7280 A swapfile will only be present when |'updatecount'| is non-zero and
7281 'swapfile' is set.
7282 When 'swapfile' is reset, the swap file for the current buffer is
7283 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7284 non-zero, a swap file is immediately created.
7285 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007286 If you want to open a new buffer without creating a swap file for it,
7287 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007288 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007289
7290 This option is used together with 'bufhidden' and 'buftype' to
7291 specify special kinds of buffers. See |special-buffers|.
7292
7293 *'swapsync'* *'sws'*
7294'swapsync' 'sws' string (default "fsync")
7295 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007297 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007298 When this option is empty parts of the swap file may be in memory and
7299 not written to disk. When the system crashes you may lose more work.
7300 On Unix the system does a sync now and then without Vim asking for it,
7301 so the disadvantage of setting this option off is small. On some
7302 systems the swap file will not be written at all. For a unix system
7303 setting it to "sync" will use the sync() call instead of the default
7304 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007305 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306
7307 *'switchbuf'* *'swb'*
7308'switchbuf' 'swb' string (default "")
7309 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310 This option controls the behavior when switching between buffers.
7311 Possible values (comma separated list):
7312 useopen If included, jump to the first open window that
7313 contains the specified buffer (if there is one).
7314 Otherwise: Do not examine other windows.
7315 This setting is checked with |quickfix| commands, when
7316 jumping to errors (":cc", ":cn", "cp", etc.). It is
7317 also used in all buffer related split commands, for
7318 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007319 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007320 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007321 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007322 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007323 Otherwise: do not split, use current window (when used
7324 in the quickfix window: the previously used window or
7325 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007326 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007327 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007328 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007330 *'synmaxcol'* *'smc'*
7331'synmaxcol' 'smc' number (default 3000)
7332 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007333 {not available when compiled without the |+syntax|
7334 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007335 Maximum column in which to search for syntax items. In long lines the
7336 text after this column is not highlighted and following lines may not
7337 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007338 This helps to avoid very slow redrawing for an XML file that is one
7339 long line.
7340 Set to zero to remove the limit.
7341
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 *'syntax'* *'syn'*
7343'syntax' 'syn' string (default empty)
7344 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345 {not available when compiled without the |+syntax|
7346 feature}
7347 When this option is set, the syntax with this name is loaded, unless
7348 syntax highlighting has been switched off with ":syntax off".
7349 Otherwise this option does not always reflect the current syntax (the
7350 b:current_syntax variable does).
7351 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007352 not automatically recognized. Example, in an IDL file:
7353 /* vim: set syntax=idl : */ ~
7354 When a dot appears in the value then this separates two filetype
7355 names. Example:
7356 /* vim: set syntax=c.doxygen : */ ~
7357 This will use the "c" syntax first, then the "doxygen" syntax.
7358 Note that the second one must be prepared to be loaded as an addition,
7359 otherwise it will be skipped. More than one dot may appear.
7360 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361 :set syntax=OFF
7362< To switch syntax highlighting on according to the current value of the
7363 'filetype' option: >
7364 :set syntax=ON
7365< What actually happens when setting the 'syntax' option is that the
7366 Syntax autocommand event is triggered with the value as argument.
7367 This option is not copied to another buffer, independent of the 's' or
7368 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007369 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007371 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007372'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007373 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007374 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007375 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007376 When nonempty, this option determines the content of the tab pages
7377 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007378 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007379
7380 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007381 option and only when there is no GUI tab line. When 'e' is in
7382 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007383 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007384
7385 The value is evaluated like with 'statusline'. You can use
7386 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007387 the text to be displayed. Use "%1T" for the first label, "%2T" for
7388 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007389
Bram Moolenaare12bab32019-01-08 22:02:56 +01007390 When changing something that is used in 'tabline' that does not
7391 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007392 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007393
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007394 Keep in mind that only one of the tab pages is the current one, others
7395 are invisible and you can't jump to their windows.
7396
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007397
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007398 *'tabpagemax'* *'tpm'*
7399'tabpagemax' 'tpm' number (default 10)
7400 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007401 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007402 feature}
7403 Maximum number of tab pages to be opened by the |-p| command line
7404 argument or the ":tab all" command. |tabpage|
7405
7406
7407 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007408'tabstop' 'ts' number (default 8)
7409 local to buffer
7410 Number of spaces that a <Tab> in the file counts for. Also see
7411 |:retab| command, and 'softtabstop' option.
7412
7413 Note: Setting 'tabstop' to any other value than 8 can make your file
7414 appear wrong in many places (e.g., when printing it).
7415
7416 There are four main ways to use tabs in Vim:
7417 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7418 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007419 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420 behave like a tab appears every 4 (or 3) characters.
7421 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7422 'expandtab'. This way you will always insert spaces. The
7423 formatting will never be messed up when 'tabstop' is changed.
7424 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007425 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007426 works when using Vim to edit the file.
7427 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7428 'noexpandtab'. This should then work (for initial indents only)
7429 for any tabstop setting that people use. It might be nice to have
7430 tabs after the first non-blank inserted as spaces if you do this
7431 though. Otherwise aligned comments will be wrong when 'tabstop' is
7432 changed.
7433
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007434 If Vim is compiled with the |+vartabs| feature then the value of
7435 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7436 than an empty string.
7437
Bram Moolenaar071d4272004-06-13 20:20:40 +00007438 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7439'tagbsearch' 'tbs' boolean (default on)
7440 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007441 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007442 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 searching makes searching for a tag a LOT faster, but a linear search
7444 will find more tags if the tags file wasn't properly sorted.
7445 Vim normally assumes that your tags files are sorted, or indicate that
7446 they are not sorted. Only when this is not the case does the
7447 'tagbsearch' option need to be switched off.
7448
7449 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007450 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007451 certain files, or retry all files with a linear search. When
7452 'tagbsearch' is off, only a linear search is done.
7453
7454 Linear searching is done anyway, for one file, when Vim finds a line
7455 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007456 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457< [The whitespace before and after the '0' must be a single <Tab>]
7458
7459 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007460 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461 instead of a normal tag name, a retry is done with a linear search.
7462 Tags in unsorted tags files, and matches with different case will only
7463 be found in the retry.
7464
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007465 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007466 linear search can be avoided when case is ignored. Use a value of '2'
7467 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7468 sorted with the -f switch to "sort" in most unices, as in the command:
7469 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7470 (at least 5.5) the --sort=foldcase switch can be used for this as
7471 well. Note that case must be folded to uppercase for this to work.
7472
7473 By default, tag searches are case-sensitive. Case is ignored when
7474 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7475 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007476 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7477 'tagcase' is "smart", and the pattern contains only lowercase
7478 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007479
7480 When 'tagbsearch' is off, tags searching is slower when a full match
7481 exists, but faster when no full match exists. Tags in unsorted tags
7482 files may only be found with 'tagbsearch' off.
7483 When the tags file is not sorted, or sorted in a wrong way (not on
7484 ASCII byte value), 'tagbsearch' should be off, or the line given above
7485 must be included in the tags file.
7486 This option doesn't affect commands that find all matching tags (e.g.,
7487 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007489 *'tagcase'* *'tc'*
7490'tagcase' 'tc' string (default "followic")
7491 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007492 This option specifies how case is handled when searching the tags
7493 file:
7494 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007495 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007496 ignore Ignore case
7497 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007498 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007499 NOTE: This option is set to the Vi default value when 'compatible' is
7500 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007501
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007502 *'tagfunc'* *'tfu'*
7503'tagfunc' 'tfu' string (default: empty)
7504 local to buffer
7505 {not available when compiled without the |+eval|
7506 feature}
7507 This option specifies a function to be used to perform tag searches.
7508 The function gets the tag pattern and should return a List of matching
7509 tags. See |tag-function| for an explanation of how to write the
7510 function and an example.
7511
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512 *'taglength'* *'tl'*
7513'taglength' 'tl' number (default 0)
7514 global
7515 If non-zero, tags are significant up to this number of characters.
7516
7517 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7518'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7519 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007520 If on and using a tags file in another directory, file names in that
7521 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 NOTE: This option is set to the Vi default value when 'compatible' is
7523 set and to the Vim default value when 'compatible' is reset.
7524
7525 *'tags'* *'tag'* *E433*
7526'tags' 'tag' string (default "./tags,tags", when compiled with
7527 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7528 global or local to buffer |global-local|
7529 Filenames for the tag command, separated by spaces or commas. To
7530 include a space or comma in a file name, precede it with a backslash
7531 (see |option-backslash| about including spaces and backslashes).
7532 When a file name starts with "./", the '.' is replaced with the path
7533 of the current file. But only when the 'd' flag is not included in
7534 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7535 |tags-option|.
7536 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007537 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7538 find all files named "tags" below "/lib". The filename itself cannot
7539 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7540 files called "tags?". {not available when compiled without the
7541 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007542 The |tagfiles()| function can be used to get a list of the file names
7543 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7545 files are also supported. They are automatically recognized. The
7546 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7547 differences are ignored (MS-Windows). |emacs-tags|
7548 The use of |:set+=| and |:set-=| is preferred when adding or removing
7549 file names from the list. This avoids problems when a future version
7550 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551
7552 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7553'tagstack' 'tgst' boolean (default on)
7554 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007555 When on, the |tagstack| is used normally. When off, a ":tag" or
7556 ":tselect" command with an argument will not push the tag onto the
7557 tagstack. A following ":tag" without an argument, a ":pop" command or
7558 any other command that uses the tagstack will use the unmodified
7559 tagstack, but does change the pointer to the active entry.
7560 Resetting this option is useful when using a ":tag" command in a
7561 mapping which should not change the tagstack.
7562
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007563 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007564'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007565 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007566 {only available when compiled with the |+tcl/dyn|
7567 feature}
7568 Specifies the name of the Tcl shared library. The default is
7569 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007570 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007571 This option cannot be set from a |modeline| or in the |sandbox|, for
7572 security reasons.
7573
Bram Moolenaar071d4272004-06-13 20:20:40 +00007574 *'term'* *E529* *E530* *E531*
7575'term' string (default is $TERM, if that fails:
7576 in the GUI: "builtin_gui"
7577 on Amiga: "amiga"
7578 on BeOS: "beos-ansi"
7579 on Mac: "mac-ansi"
7580 on MiNT: "vt52"
7581 on MS-DOS: "pcterm"
7582 on OS/2: "os2ansi"
7583 on Unix: "ansi"
7584 on VMS: "ansi"
7585 on Win 32: "win32")
7586 global
7587 Name of the terminal. Used for choosing the terminal control
7588 characters. Environment variables are expanded |:set_env|.
7589 For example: >
7590 :set term=$TERM
7591< See |termcap|.
7592
7593 *'termbidi'* *'tbidi'*
7594 *'notermbidi'* *'notbidi'*
7595'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7596 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597 {only available when compiled with the |+arabic|
7598 feature}
7599 The terminal is in charge of Bi-directionality of text (as specified
7600 by Unicode). The terminal is also expected to do the required shaping
7601 that some languages (such as Arabic) require.
7602 Setting this option implies that 'rightleft' will not be set when
7603 'arabic' is set and the value of 'arabicshape' will be ignored.
7604 Note that setting 'termbidi' has the immediate effect that
7605 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7606 This option is reset when the GUI is started.
7607 For further details see |arabic.txt|.
7608
7609 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007610'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611 Macintosh GUI: "macroman")
7612 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007613 Encoding used for the terminal. This specifies what character
7614 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007615 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007616 display). Except for the Mac when 'macatsui' is off, then
7617 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007618 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007619 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7621 Any attempts to set a different value will be rejected, and an error
7622 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007623 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007624 because the Win32 system always passes Unicode characters.
7625 When empty, the same encoding is used as for the 'encoding' option.
7626 This is the normal value.
7627 Not all combinations for 'termencoding' and 'encoding' are valid. See
7628 |encoding-table|.
7629 The value for this option must be supported by internal conversions or
7630 iconv(). When this is not possible no conversion will be done and you
7631 will probably experience problems with non-ASCII characters.
7632 Example: You are working with the locale set to euc-jp (Japanese) and
7633 want to edit a UTF-8 file: >
7634 :let &termencoding = &encoding
7635 :set encoding=utf-8
7636< You need to do this when your system has no locale support for UTF-8.
7637
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007638 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007639'termguicolors' 'tgc' boolean (default off)
7640 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007641 {not available when compiled without the
7642 |+termguicolors| feature}
7643 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007644 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007645
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007646 Requires a ISO-8613-3 compatible terminal. If setting this option
7647 does not work (produces a colorless UI) reading |xterm-true-color|
7648 might help.
7649
7650 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7651 is required. Use this check to find out: >
7652 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007653< This requires Vim to be built with the |+vtp| feature.
7654
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007655 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007656 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007657
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007658 *'termwinkey'* *'twk'*
7659'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007660 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007661 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007662 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007663 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007664 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007665< The string must be one key stroke but can be multiple bytes.
7666 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007667 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007668 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007669
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007670 *'termwinscroll'* *'twsl'*
7671'termwinscroll' 'twsl' number (default 10000)
7672 local to buffer
7673 {not available when compiled without the
7674 |+terminal| feature}
7675 Number of scrollback lines to keep. When going over this limit the
7676 first 10% of the scrollback lines are deleted. This is just to reduce
7677 the memory usage. See |Terminal-Normal|.
7678
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007679 *'termwinsize'* *'tws'*
7680'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007681 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007682 Size of the |terminal| window. Format: {rows}x{columns} or
7683 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007684 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007685 - When set with a "x" (e.g., "24x80") the terminal size is not
7686 adjusted to the window size. If the window is smaller only the
7687 top-left part is displayed.
7688 - When set with a "*" (e.g., "10*50") the terminal size follows the
7689 window size, but will not be smaller than the specified rows and/or
7690 columns.
7691 - When rows is zero then use the height of the window.
7692 - When columns is zero then use the width of the window.
7693 - Using "0x0" or "0*0" is the same as empty.
7694
7695 Examples:
7696 "30x0" uses 30 rows and the current window width.
7697 "20*0" uses at least 20 rows and the current window width.
7698 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007699 Note that the command running in the terminal window may still change
7700 the size of the terminal. In that case the Vim window will be
7701 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007702
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007703 *'termwintype'* *'twt'*
7704'termwintype' 'twt' string (default "")
7705 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007706 {only available when compiled with the |terminal|
7707 feature on MS-Windows}
7708 Specify the virtual console (pty) used when opening the terminal
7709 window.
7710
7711 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007712 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007713 "winpty" use winpty, fail if not supported
7714 "conpty" use |ConPTY|, fail if not supported
7715
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007716 |ConPTY| support depends on the platform. Windows 10 October 2018
7717 Update is the first version that supports ConPTY, however it is still
7718 considered unstable. ConPTY might become stable in the next release
7719 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007720 supported then you cannot open a terminal window.
7721
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 *'terse'* *'noterse'*
7723'terse' boolean (default off)
7724 global
7725 When set: Add 's' flag to 'shortmess' option (this makes the message
7726 for a search that hits the start or end of the file not being
7727 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7728 shortens a lot of messages}
7729
7730 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7731'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7732 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 This option is obsolete. Use 'fileformats'.
7734 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7735 set to the default value for the current system. When 'textauto' is
7736 reset, 'fileformats' is made empty.
7737 NOTE: This option is set to the Vi default value when 'compatible' is
7738 set and to the Vim default value when 'compatible' is reset.
7739
7740 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7741'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7742 others: default off)
7743 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007744 This option is obsolete. Use 'fileformat'.
7745 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7746 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7747 "unix".
7748
7749 *'textwidth'* *'tw'*
7750'textwidth' 'tw' number (default 0)
7751 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752 Maximum width of text that is being inserted. A longer line will be
7753 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007754 this.
7755 'textwidth' is set to 0 when the 'paste' option is set and restored
7756 when 'paste' is reset.
7757 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007759 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760 NOTE: This option is set to 0 when 'compatible' is set.
7761
7762 *'thesaurus'* *'tsr'*
7763'thesaurus' 'tsr' string (default "")
7764 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007766 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7767
7768 Each line in the file should contain words with similar meaning,
7769 separated by non-keyword characters (white space is preferred).
7770 Maximum line length is 510 bytes.
7771
Bram Moolenaard47d5222018-12-09 20:43:55 +01007772 An English word list was added to this github issue:
7773 https://github.com/vim/vim/issues/629#issuecomment-443293282
7774 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7775 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7776 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007777
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007778 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779 after a comma are ignored, otherwise spaces are included in the file
7780 name. See |option-backslash| about using backslashes.
7781 The use of |:set+=| and |:set-=| is preferred when adding or removing
7782 directories from the list. This avoids problems when a future version
7783 uses another default.
7784 Backticks cannot be used in this option for security reasons.
7785
7786 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7787'tildeop' 'top' boolean (default off)
7788 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789 When on: The tilde command "~" behaves like an operator.
7790 NOTE: This option is reset when 'compatible' is set.
7791
7792 *'timeout'* *'to'* *'notimeout'* *'noto'*
7793'timeout' 'to' boolean (default on)
7794 global
7795 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007796'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007798 These two options together determine the behavior when part of a
7799 mapped key sequence or keyboard code has been received:
7800
7801 'timeout' 'ttimeout' action ~
7802 off off do not time out
7803 on on or off time out on :mappings and key codes
7804 off on time out on key codes
7805
7806 If both options are off, Vim will wait until either the complete
7807 mapping or key sequence has been received, or it is clear that there
7808 is no mapping or key sequence for the received characters. For
7809 example: if you have mapped "vl" and Vim has received 'v', the next
7810 character is needed to see if the 'v' is followed by an 'l'.
7811 When one of the options is on, Vim will wait for about 1 second for
7812 the next character to arrive. After that the already received
7813 characters are interpreted as single characters. The waiting time can
7814 be changed with the 'timeoutlen' option.
7815 On slow terminals or very busy systems timing out may cause
7816 malfunctioning cursor keys. If both options are off, Vim waits
7817 forever after an entered <Esc> if there are key codes that start
7818 with <Esc>. You will have to type <Esc> twice. If you do not have
7819 problems with key codes, but would like to have :mapped key
7820 sequences not timing out in 1 second, set the 'ttimeout' option and
7821 reset the 'timeout' option.
7822
7823 NOTE: 'ttimeout' is reset when 'compatible' is set.
7824
7825 *'timeoutlen'* *'tm'*
7826'timeoutlen' 'tm' number (default 1000)
7827 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007828
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007830'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007831 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007832 The time in milliseconds that is waited for a key code or mapped key
7833 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7834 when part of a command has been typed.
7835 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7836 different timeout value for key codes is desired set 'ttimeoutlen' to
7837 a non-negative number.
7838
7839 ttimeoutlen mapping delay key code delay ~
7840 < 0 'timeoutlen' 'timeoutlen'
7841 >= 0 'timeoutlen' 'ttimeoutlen'
7842
7843 The timeout only happens when the 'timeout' and 'ttimeout' options
7844 tell so. A useful setting would be >
7845 :set timeout timeoutlen=3000 ttimeoutlen=100
7846< (time out on mapping after three seconds, time out on key codes after
7847 a tenth of a second).
7848
7849 *'title'* *'notitle'*
7850'title' boolean (default off, on when title can be restored)
7851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007852 {not available when compiled without the |+title|
7853 feature}
7854 When on, the title of the window will be set to the value of
7855 'titlestring' (if it is not empty), or to:
7856 filename [+=-] (path) - VIM
7857 Where:
7858 filename the name of the file being edited
7859 - indicates the file cannot be modified, 'ma' off
7860 + indicates the file was modified
7861 = indicates the file is read-only
7862 =+ indicates the file is read-only and modified
7863 (path) is the path of the file being edited
7864 - VIM the server name |v:servername| or "VIM"
7865 Only works if the terminal supports setting window titles
7866 (currently Amiga console, Win32 console, all GUI versions and
7867 terminals with a non- empty 't_ts' option - these are Unix xterm and
7868 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7869 *X11*
7870 When Vim was compiled with HAVE_X11 defined, the original title will
7871 be restored if possible. The output of ":version" will include "+X11"
7872 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7873 works for the icon name |'icon'|.
7874 But: When Vim was started with the |-X| argument, restoring the title
7875 will not work (except in the GUI).
7876 If the title cannot be restored, it is set to the value of 'titleold'.
7877 You might want to restore the title outside of Vim then.
7878 When using an xterm from a remote machine you can use this command:
7879 rsh machine_name xterm -display $DISPLAY &
7880 then the WINDOWID environment variable should be inherited and the
7881 title of the window should change back to what it should be after
7882 exiting Vim.
7883
7884 *'titlelen'*
7885'titlelen' number (default 85)
7886 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 {not available when compiled without the |+title|
7888 feature}
7889 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007890 title. When the title is longer, only the end of the path name is
7891 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 Using a percentage makes this adapt to the width of the window. But
7893 it won't work perfectly, because the actual number of characters
7894 available also depends on the font used and other things in the title
7895 bar. When 'titlelen' is zero the full path is used. Otherwise,
7896 values from 1 to 30000 percent can be used.
7897 'titlelen' is also used for the 'titlestring' option.
7898
7899 *'titleold'*
7900'titleold' string (default "Thanks for flying Vim")
7901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 {only available when compiled with the |+title|
7903 feature}
7904 This option will be used for the window title when exiting Vim if the
7905 original title cannot be restored. Only happens if 'title' is on or
7906 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007907 This option cannot be set from a |modeline| or in the |sandbox|, for
7908 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909 *'titlestring'*
7910'titlestring' string (default "")
7911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007912 {not available when compiled without the |+title|
7913 feature}
7914 When this option is not empty, it will be used for the title of the
7915 window. This happens only when the 'title' option is on.
7916 Only works if the terminal supports setting window titles (currently
7917 Amiga console, Win32 console, all GUI versions and terminals with a
7918 non-empty 't_ts' option).
7919 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007920 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007921
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922 When this option contains printf-style '%' items, they will be
7923 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007924 This option cannot be set in a modeline when 'modelineexpr' is off.
7925
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926 Example: >
7927 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7928 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7929< The value of 'titlelen' is used to align items in the middle or right
7930 of the available space.
7931 Some people prefer to have the file name first: >
7932 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7933< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007934 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 separating space only when needed.
7936 NOTE: Use of special characters in 'titlestring' may cause the display
7937 to be garbled (e.g., when it contains a CR or NL character).
7938 {not available when compiled without the |+statusline| feature}
7939
7940 *'toolbar'* *'tb'*
7941'toolbar' 'tb' string (default "icons,tooltips")
7942 global
7943 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7944 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007945 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946 possible values are:
7947 icons Toolbar buttons are shown with icons.
7948 text Toolbar buttons shown with text.
7949 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007950 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007951 tooltips Tooltips are active for toolbar buttons.
7952 Tooltips refer to the popup help text which appears after the mouse
7953 cursor is placed over a toolbar button for a brief moment.
7954
7955 If you want the toolbar to be shown with icons as well as text, do the
7956 following: >
7957 :set tb=icons,text
7958< Motif and Athena cannot display icons and text at the same time. They
7959 will show icons if both are requested.
7960
7961 If none of the strings specified in 'toolbar' are valid or if
7962 'toolbar' is empty, this option is ignored. If you want to disable
7963 the toolbar, you need to set the 'guioptions' option. For example: >
7964 :set guioptions-=T
7965< Also see |gui-toolbar|.
7966
7967 *'toolbariconsize'* *'tbis'*
7968'toolbariconsize' 'tbis' string (default "small")
7969 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01007970 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007972 tiny Use tiny icons.
7973 small Use small icons (default).
7974 medium Use medium-sized icons.
7975 large Use large icons.
7976 huge Use even larger icons.
7977 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007978 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007979 the current theme. Common dimensions are giant=48x48, huge=32x32,
7980 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981
7982 If 'toolbariconsize' is empty, the global default size as determined
7983 by user preferences or the current theme is used.
7984
7985 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7986'ttybuiltin' 'tbi' boolean (default on)
7987 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 When on, the builtin termcaps are searched before the external ones.
7989 When off the builtin termcaps are searched after the external ones.
7990 When this option is changed, you should set the 'term' option next for
7991 the change to take effect, for example: >
7992 :set notbi term=$TERM
7993< See also |termcap|.
7994 Rationale: The default for this option is "on", because the builtin
7995 termcap entries are generally better (many systems contain faulty
7996 xterm entries...).
7997
7998 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7999'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8000 sun-cmd, screen, rxvt, dtterm or
8001 iris-ansi; also on when running Vim in
8002 a DOS console)
8003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008004 Indicates a fast terminal connection. More characters will be sent to
8005 the screen for redrawing, instead of using insert/delete line
8006 commands. Improves smoothness of redrawing when there are multiple
8007 windows and the terminal does not support a scrolling region.
8008 Also enables the extra writing of characters at the end of each screen
8009 line for lines that wrap. This helps when using copy/paste with the
8010 mouse in an xterm and other terminals.
8011
8012 *'ttymouse'* *'ttym'*
8013'ttymouse' 'ttym' string (default depends on 'term')
8014 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 {only in Unix and VMS, doesn't work in the GUI; not
8016 available when compiled without |+mouse|}
8017 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008018 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019 *xterm-mouse*
8020 xterm xterm-like mouse handling. The mouse generates
8021 "<Esc>[Mscr", where "scr" is three bytes:
8022 "s" = button state
8023 "c" = column plus 33
8024 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008025 This only works up to 223 columns! See "dec",
8026 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027 xterm2 Works like "xterm", but with the xterm reporting the
8028 mouse position while the mouse is dragged. This works
8029 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008030 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008031 work. See below for how Vim detects this
8032 automatically.
8033 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008034 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008036 for the row and column. No other mouse events are
8037 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008038 *dec-mouse*
8039 dec DEC terminal mouse handling. The mouse generates a
8040 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008041 This is also available for an Xterm, if it was
8042 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043 *jsbterm-mouse*
8044 jsbterm JSB term mouse handling.
8045 *pterm-mouse*
8046 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008047 *urxvt-mouse*
8048 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008049 The mouse works only if the terminal supports this
8050 encoding style, but it does not have 223 columns limit
8051 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008052 *sgr-mouse*
8053 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008054 mouse reporting. The mouse works even in columns
8055 beyond 223. This option is backward compatible with
8056 "xterm2" because it can also decode "xterm2" style
8057 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058
8059 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008060 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8061 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8063 recognized, if enabled at compile time. DEC terminal mouse codes
8064 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008065 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8066 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008067 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008068 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8069 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8070 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008071 Additionally, if vim is compiled with the |+termresponse| feature and
8072 |t_RV| is set to the escape sequence to request the xterm version
8073 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008075 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8076 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8077 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008078 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8079 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008080 :set t_RV=
8081<
8082 *'ttyscroll'* *'tsl'*
8083'ttyscroll' 'tsl' number (default 999)
8084 global
8085 Maximum number of lines to scroll the screen. If there are more lines
8086 to scroll the window is redrawn. For terminals where scrolling is
8087 very slow and redrawing is not slow this can be set to a small number,
8088 e.g., 3, to speed up displaying.
8089
8090 *'ttytype'* *'tty'*
8091'ttytype' 'tty' string (default from $TERM)
8092 global
8093 Alias for 'term', see above.
8094
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008095 *'undodir'* *'udir'*
8096'undodir' 'udir' string (default ".")
8097 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008098 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008099 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008100 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008101 "." means using the directory of the file. The undo file name for
8102 "file.txt" is ".file.txt.un~".
8103 For other directories the file name is the full path of the edited
8104 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008105 When writing: The first directory that exists is used. "." always
8106 works, no directories after "." will be used for writing.
8107 When reading all entries are tried to find an undo file. The first
8108 undo file that exists is used. When it cannot be read an error is
8109 given, no further entry is used.
8110 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008111 This option cannot be set from a |modeline| or in the |sandbox|, for
8112 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008113
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008114 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008115'undofile' 'udf' boolean (default off)
8116 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008117 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008118 When on, Vim automatically saves undo history to an undo file when
8119 writing a buffer to a file, and restores undo history from the same
8120 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008121 The directory where the undo file is stored is specified by 'undodir'.
8122 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008123 The undo file is not read when 'undoreload' causes the buffer from
8124 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008125 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008126 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008127
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 *'undolevels'* *'ul'*
8129'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8130 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008131 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008132 Maximum number of changes that can be undone. Since undo information
8133 is kept in memory, higher numbers will cause more memory to be used
8134 (nevertheless, a single change can use an unlimited amount of memory).
8135 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8136 itself: >
8137 set ul=0
8138< But you can also get Vi compatibility by including the 'u' flag in
8139 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008140 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008141 Set to -1 for no undo at all. You might want to do this only for the
8142 current buffer: >
8143 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008144< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008145
8146 The local value is set to -123456 when the global value is to be used.
8147
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008148 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008149
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008150 *'undoreload'* *'ur'*
8151'undoreload' 'ur' number (default 10000)
8152 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008153 Save the whole buffer for undo when reloading it. This applies to the
8154 ":e!" command and reloading for when the buffer changed outside of
8155 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008156 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008157 of lines is smaller than the value of this option.
8158 Set this option to zero to disable undo for a reload.
8159
8160 When saving undo for a reload, any undo file is not read.
8161
8162 Note that this causes the whole buffer to be stored in memory. Set
8163 this option to a lower value if you run out of memory.
8164
Bram Moolenaar071d4272004-06-13 20:20:40 +00008165 *'updatecount'* *'uc'*
8166'updatecount' 'uc' number (default: 200)
8167 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008168 After typing this many characters the swap file will be written to
8169 disk. When zero, no swap file will be created at all (see chapter on
8170 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8171 Vim with the "-n" option, see |startup|. When editing in readonly
8172 mode this option will be initialized to 10000.
8173 The swapfile can be disabled per buffer with |'swapfile'|.
8174 When 'updatecount' is set from zero to non-zero, swap files are
8175 created for all buffers that have 'swapfile' set. When 'updatecount'
8176 is set to zero, existing swap files are not deleted.
8177 Also see |'swapsync'|.
8178 This option has no meaning in buffers where |'buftype'| is "nofile"
8179 or "nowrite".
8180
8181 *'updatetime'* *'ut'*
8182'updatetime' 'ut' number (default 4000)
8183 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008184 If this many milliseconds nothing is typed the swap file will be
8185 written to disk (see |crash-recovery|). Also used for the
8186 |CursorHold| autocommand event.
8187
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008188 *'varsofttabstop'* *'vsts'*
8189'varsofttabstop' 'vsts' string (default "")
8190 local to buffer
8191 {only available when compiled with the |+vartabs|
8192 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008193 A list of the number of spaces that a <Tab> counts for while editing,
8194 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8195 width <Tab>s are being inserted, while in fact a mixture of spaces
8196 and <Tab>s is used. Tab widths are separated with commas, with the
8197 final value applying to all subsequent tabs.
8198
8199 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008200 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008201 to use the following: >
8202 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008203< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8204 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008205
8206 Note that the value of |'softtabstop'| will be ignored while
8207 'varsofttabstop' is set.
8208
8209 *'vartabstop'* *'vts'*
8210'vartabstop' 'vts' string (default "")
8211 local to buffer
8212 {only available when compiled with the |+vartabs|
8213 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008214 A list of the number of spaces that a <Tab> in the file counts for,
8215 separated by commas. Each value corresponds to one tab, with the
8216 final value applying to all subsequent tabs. For example: >
8217 :set vartabstop=4,20,10,8
8218< This will make the first tab 4 spaces wide, the second 20 spaces,
8219 the third 10 spaces, and all following tabs 8 spaces.
8220
8221 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8222 is set.
8223
Bram Moolenaar071d4272004-06-13 20:20:40 +00008224 *'verbose'* *'vbs'*
8225'verbose' 'vbs' number (default 0)
8226 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227 When bigger than zero, Vim will give messages about what it is doing.
8228 Currently, these messages are given:
8229 >= 1 When the viminfo file is read or written.
8230 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008231 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 >= 8 Files for which a group of autocommands is executed.
8233 >= 9 Every executed autocommand.
8234 >= 12 Every executed function.
8235 >= 13 When an exception is thrown, caught, finished, or discarded.
8236 >= 14 Anything pending in a ":finally" clause.
8237 >= 15 Every executed Ex command (truncated at 200 characters).
8238
8239 This option can also be set with the "-V" argument. See |-V|.
8240 This option is also set by the |:verbose| command.
8241
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008242 When the 'verbosefile' option is set then the verbose messages are not
8243 displayed.
8244
8245 *'verbosefile'* *'vfile'*
8246'verbosefile' 'vfile' string (default empty)
8247 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008248 When not empty all messages are written in a file with this name.
8249 When the file exists messages are appended.
8250 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008251 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008252 Setting 'verbosefile' to a new value is like making it empty first.
8253 The difference with |:redir| is that verbose messages are not
8254 displayed when 'verbosefile' is set.
8255
Bram Moolenaar071d4272004-06-13 20:20:40 +00008256 *'viewdir'* *'vdir'*
8257'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8258 "$VIM/vimfiles/view",
8259 for Unix: "~/.vim/view",
8260 for Macintosh: "$VIM:vimfiles:view"
8261 for VMS: "sys$login:vimfiles/view"
8262 for RiscOS: "Choices:vimfiles/view")
8263 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008264 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008265 feature}
8266 Name of the directory where to store files for |:mkview|.
8267 This option cannot be set from a |modeline| or in the |sandbox|, for
8268 security reasons.
8269
8270 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008271'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008272 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008273 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008274 feature}
8275 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008276 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008277 word save and restore ~
8278 cursor cursor position in file and in window
8279 folds manually created folds, opened/closed folds and local
8280 fold options
8281 options options and mappings local to a window or buffer (not
8282 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008283 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284 slash backslashes in file names replaced with forward
8285 slashes
8286 unix with Unix end-of-line format (single <NL>), even when
8287 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008288 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008289
8290 "slash" and "unix" are useful on Windows when sharing view files
8291 with Unix. The Unix version of Vim cannot source dos format scripts,
8292 but the Windows version of Vim can source unix format scripts.
8293
8294 *'viminfo'* *'vi'* *E526* *E527* *E528*
8295'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008296 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8297 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8298 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008299 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008300 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008301 feature}
8302 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008303 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8304 "NONE".
8305 The string should be a comma separated list of parameters, each
8306 consisting of a single character identifying the particular parameter,
8307 followed by a number or string which specifies the value of that
8308 parameter. If a particular character is left out, then the default
8309 value is used for that parameter. The following is a list of the
8310 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008312 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 ! When included, save and restore global variables that start
8314 with an uppercase letter, and don't contain a lowercase
8315 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008316 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008317 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008318 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 " Maximum number of lines saved for each register. Old name of
8320 the '<' item, with the disadvantage that you need to put a
8321 backslash before the ", otherwise it will be recognized as the
8322 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008323 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008324 % When included, save and restore the buffer list. If Vim is
8325 started with a file name argument, the buffer list is not
8326 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008327 buffer list is restored from the viminfo file. Quickfix
8328 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8329 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008330 When followed by a number, the number specifies the maximum
8331 number of buffers that are stored. Without a number all
8332 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008333 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008334 ' Maximum number of previously edited files for which the marks
8335 are remembered. This parameter must always be included when
8336 'viminfo' is non-empty.
8337 Including this item also means that the |jumplist| and the
8338 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008339 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008340 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008341 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342 patterns are also saved. When not included, the value of
8343 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008344 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008345 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008346 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008347 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008348 < Maximum number of lines saved for each register. If zero then
8349 registers are not saved. When not included, all lines are
8350 saved. '"' is the old name for this item.
8351 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008352 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008353 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008354 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008355 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008356 c When included, convert the text in the viminfo file from the
8357 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008358 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008359 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 f Whether file marks need to be stored. If zero, file marks ('0
8361 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008362 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008364 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365 h Disable the effect of 'hlsearch' when loading the viminfo
8366 file. When not included, it depends on whether ":nohlsearch"
8367 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008368 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008370 the 'n'. Must be at the end of the option! If the
8371 'viminfofile' option is set, that file name overrides the one
8372 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008373 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008374 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 r Removable media. The argument is a string (up to the next
8376 ','). This parameter can be given several times. Each
8377 specifies the start of a path for which no marks will be
8378 stored. This is to avoid removable media. For MS-DOS you
8379 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8380 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8381 ignored. Maximum length of each 'r' argument is 50
8382 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008383 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 s Maximum size of an item in Kbyte. If zero then registers are
8385 not saved. Currently only applies to registers. The default
8386 "s10" will exclude registers with more than 10 Kbyte of text.
8387 Also see the '<' item above: line count limit.
8388
8389 Example: >
8390 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8391<
8392 '50 Marks will be remembered for the last 50 files you
8393 edited.
8394 <1000 Contents of registers (up to 1000 lines each) will be
8395 remembered.
8396 s100 Registers with more than 100 Kbyte text are skipped.
8397 :0 Command-line history will not be saved.
8398 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8399 no / Since '/' is not specified, the default will be used,
8400 that is, save all of the search history, and also the
8401 previous search and substitute patterns.
8402 no % The buffer list will not be saved nor read back.
8403 no h 'hlsearch' highlighting will be restored.
8404
8405 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8406 load the contents of the file, this is not done automatically.
8407
8408 This option cannot be set from a |modeline| or in the |sandbox|, for
8409 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008410 NOTE: This option is set to the Vim default value when 'compatible'
8411 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008412
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008413 *'viminfofile'* *'vif'*
8414'viminfofile' 'vif' string (default: "")
8415 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008416 {not available when compiled without the |+viminfo|
8417 feature}
8418 When non-empty, overrides the file name used for viminfo.
8419 When equal to "NONE" no viminfo file will be read or written.
8420 This option can be set with the |-i| command line flag. The |--clean|
8421 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008422 This option cannot be set from a |modeline| or in the |sandbox|, for
8423 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008424
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425 *'virtualedit'* *'ve'*
8426'virtualedit' 've' string (default "")
8427 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428 {not available when compiled without the
8429 |+virtualedit| feature}
8430 A comma separated list of these words:
8431 block Allow virtual editing in Visual block mode.
8432 insert Allow virtual editing in Insert mode.
8433 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008434 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008435
Bram Moolenaar071d4272004-06-13 20:20:40 +00008436 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008437 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008438 of the line. Useful for selecting a rectangle in Visual mode and
8439 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008440 "onemore" is not the same, it will only allow moving the cursor just
8441 after the last character of the line. This makes some commands more
8442 consistent. Previously the cursor was always past the end of the line
8443 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008444 break some plugins or Vim scripts. For example because |l| can move
8445 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008446 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008447 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008448 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008449 It doesn't make sense to combine "all" with "onemore", but you will
8450 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008451 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452
8453 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8454'visualbell' 'vb' boolean (default off)
8455 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008456 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008457 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008458 use: >
8459 :set vb t_vb=
8460< If you want a short flash, you can use this on many terminals: >
8461 :set vb t_vb=[?5h$<100>[?5l
8462< Here $<100> specifies the time, you can use a smaller or bigger value
8463 to get a shorter or longer flash.
8464
8465 Note: Vim will limit the bell to once per half a second. This avoids
8466 having to wait for the flashing to finish when there are lots of
8467 bells, e.g. on key repeat. This also happens without 'visualbell'
8468 set.
8469
Bram Moolenaar071d4272004-06-13 20:20:40 +00008470 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8471 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8472 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008473
8474 Note: When the GUI starts, 't_vb' is reset to its default value. You
8475 might want to set it again in your |gvimrc|.
8476
Bram Moolenaar071d4272004-06-13 20:20:40 +00008477 Does not work on the Amiga, you always get a screen flash.
8478 Also see 'errorbells'.
8479
8480 *'warn'* *'nowarn'*
8481'warn' boolean (default on)
8482 global
8483 Give a warning message when a shell command is used while the buffer
8484 has been changed.
8485
8486 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8487'weirdinvert' 'wiv' boolean (default off)
8488 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008489 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008490 It is provided for backwards compatibility with version 4.x.
8491 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8492 vice versa. Has no effect when the GUI is running.
8493
8494 *'whichwrap'* *'ww'*
8495'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8496 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497 Allow specified keys that move the cursor left/right to move to the
8498 previous/next line when the cursor is on the first/last character in
8499 the line. Concatenate characters to allow this for these keys:
8500 char key mode ~
8501 b <BS> Normal and Visual
8502 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008503 h "h" Normal and Visual (not recommended)
8504 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008505 < <Left> Normal and Visual
8506 > <Right> Normal and Visual
8507 ~ "~" Normal
8508 [ <Left> Insert and Replace
8509 ] <Right> Insert and Replace
8510 For example: >
8511 :set ww=<,>,[,]
8512< allows wrap only when cursor keys are used.
8513 When the movement keys are used in combination with a delete or change
8514 operator, the <EOL> also counts for a character. This makes "3h"
8515 different from "3dh" when the cursor crosses the end of a line. This
8516 is also true for "x" and "X", because they do the same as "dl" and
8517 "dh". If you use this, you may also want to use the mapping
8518 ":map <BS> X" to make backspace delete the character in front of the
8519 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008520 When 'l' is included and it is used after an operator at the end of a
8521 line then it will not move to the next line. This makes "dl", "cl",
8522 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008523 NOTE: This option is set to the Vi default value when 'compatible' is
8524 set and to the Vim default value when 'compatible' is reset.
8525
8526 *'wildchar'* *'wc'*
8527'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8528 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529 Character you have to type to start wildcard expansion in the
8530 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008531 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008532 The character is not recognized when used inside a macro. See
8533 'wildcharm' for that.
8534 Although 'wc' is a number option, you can set it to a special key: >
8535 :set wc=<Esc>
8536< NOTE: This option is set to the Vi default value when 'compatible' is
8537 set and to the Vim default value when 'compatible' is reset.
8538
8539 *'wildcharm'* *'wcm'*
8540'wildcharm' 'wcm' number (default: none (0))
8541 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008542 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008543 recognized when used inside a macro. You can find "spare" command-line
8544 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 you'll never actually type 'wildcharm', just use it in mappings that
8546 automatically invoke completion mode, e.g.: >
8547 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008548 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008549< Then after typing :ss you can use CTRL-P & CTRL-N.
8550
8551 *'wildignore'* *'wig'*
8552'wildignore' 'wig' string (default "")
8553 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008554 {not available when compiled without the |+wildignore|
8555 feature}
8556 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008557 patterns is ignored when expanding |wildcards|, completing file or
8558 directory names, and influences the result of |expand()|, |glob()| and
8559 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008560 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8561 Also see 'suffixes'.
8562 Example: >
8563 :set wildignore=*.o,*.obj
8564< The use of |:set+=| and |:set-=| is preferred when adding or removing
8565 a pattern from the list. This avoids problems when a future version
8566 uses another default.
8567
Bram Moolenaar94950a92010-12-02 16:01:29 +01008568
Bram Moolenaar81af9252010-12-10 20:35:50 +01008569 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008570'wildignorecase' 'wic' boolean (default off)
8571 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008572 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008573 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008574 Does not apply when the shell is used to expand wildcards, which
8575 happens when there are special characters.
8576
8577
Bram Moolenaar071d4272004-06-13 20:20:40 +00008578 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008579'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008580 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581 {not available if compiled without the |+wildmenu|
8582 feature}
8583 When 'wildmenu' is on, command-line completion operates in an enhanced
8584 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8585 the possible matches are shown just above the command line, with the
8586 first match highlighted (overwriting the status line, if there is
8587 one). Keys that show the previous/next match, such as <Tab> or
8588 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8589 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8590 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008591 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008592 If there are more matches than can fit in the line, a ">" is shown on
8593 the right and/or a "<" is shown on the left. The status line scrolls
8594 as needed.
8595 The "wildmenu" mode is abandoned when a key is hit that is not used
8596 for selecting a completion.
8597 While the "wildmenu" is active the following keys have special
8598 meanings:
8599
8600 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8601 <Down> - in filename/menu name completion: move into a
8602 subdirectory or submenu.
8603 <CR> - in menu completion, when the cursor is just after a
8604 dot: move into a submenu.
8605 <Up> - in filename/menu name completion: move up into
8606 parent directory or parent menu.
8607
8608 This makes the menus accessible from the console |console-menus|.
8609
8610 If you prefer the <Left> and <Right> keys to move the cursor instead
8611 of selecting a different match, use this: >
8612 :cnoremap <Left> <Space><BS><Left>
8613 :cnoremap <Right> <Space><BS><Right>
8614<
8615 The "WildMenu" highlighting is used for displaying the current match
8616 |hl-WildMenu|.
8617
8618 *'wildmode'* *'wim'*
8619'wildmode' 'wim' string (Vim default: "full")
8620 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008621 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008622 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008623 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008624 first part specifies the behavior for the first use of 'wildchar',
8625 The second part for the second use, etc.
8626 These are the possible values for each part:
8627 "" Complete only the first match.
8628 "full" Complete the next full match. After the last match,
8629 the original string is used and then the first match
8630 again.
8631 "longest" Complete till longest common string. If this doesn't
8632 result in a longer string, use the next part.
8633 "longest:full" Like "longest", but also start 'wildmenu' if it is
8634 enabled.
8635 "list" When more than one match, list all matches.
8636 "list:full" When more than one match, list all matches and
8637 complete first match.
8638 "list:longest" When more than one match, list all matches and
8639 complete till longest common string.
8640 When there is only a single match, it is fully completed in all cases.
8641
8642 Examples: >
8643 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008644< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645 :set wildmode=longest,full
8646< Complete longest common string, then each full match >
8647 :set wildmode=list:full
8648< List all matches and complete each full match >
8649 :set wildmode=list,full
8650< List all matches without completing, then each full match >
8651 :set wildmode=longest,list
8652< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008653 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008655 *'wildoptions'* *'wop'*
8656'wildoptions' 'wop' string (default "")
8657 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008658 {not available when compiled without the |+wildignore|
8659 feature}
8660 A list of words that change how command line completion is done.
8661 Currently only one word is allowed:
8662 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008663 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008664 is displayed per line. Often used tag kinds are:
8665 d #define
8666 f function
8667 Also see |cmdline-completion|.
8668
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 *'winaltkeys'* *'wak'*
8670'winaltkeys' 'wak' string (default "menu")
8671 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008672 {only used in Win32, Motif, GTK and Photon GUI}
8673 Some GUI versions allow the access to menu entries by using the ALT
8674 key in combination with a character that appears underlined in the
8675 menu. This conflicts with the use of the ALT key for mappings and
8676 entering special characters. This option tells what to do:
8677 no Don't use ALT keys for menus. ALT key combinations can be
8678 mapped, but there is no automatic handling. This can then be
8679 done with the |:simalt| command.
8680 yes ALT key handling is done by the windowing system. ALT key
8681 combinations cannot be mapped.
8682 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008683 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008684 keys can be mapped.
8685 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8686 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008687 This option is not used for <F10>; on Win32 and with GTK <F10> will
8688 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008689
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008690 *'window'* *'wi'*
8691'window' 'wi' number (default screen height - 1)
8692 global
8693 Window height. Do not confuse this with the height of the Vim window,
8694 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008695 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8696 value is smaller than 'lines' minus one. The screen will scroll
8697 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008698 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8699 in a much smarter way, taking care of wrapping lines.
8700 When resizing the Vim window, the value is smaller than 1 or more than
8701 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008702
Bram Moolenaar071d4272004-06-13 20:20:40 +00008703 *'winheight'* *'wh'* *E591*
8704'winheight' 'wh' number (default 1)
8705 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008706 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008707 feature}
8708 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008709 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008710 focus goes to a window that is smaller, its size is increased, at the
8711 cost of the height of other windows.
8712 Set 'winheight' to a small number for normal editing.
8713 Set it to 999 to make the current window fill most of the screen.
8714 Other windows will be only 'winminheight' high. This has the drawback
8715 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8716 to create only two windows, set the option after startup is done,
8717 using the |VimEnter| event: >
8718 au VimEnter * set winheight=999
8719< Minimum value is 1.
8720 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008721 height of the current window.
8722 'winheight' applies to the current window. Use 'winminheight' to set
8723 the minimal height for other windows.
8724
8725 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8726'winfixheight' 'wfh' boolean (default off)
8727 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02008728 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008729 feature}
8730 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008731 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8732 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733 The height may be changed anyway when running out of room.
8734
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008735 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8736'winfixwidth' 'wfw' boolean (default off)
8737 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02008738 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008739 feature}
8740 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008741 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008742 The width may be changed anyway when running out of room.
8743
Bram Moolenaar071d4272004-06-13 20:20:40 +00008744 *'winminheight'* *'wmh'*
8745'winminheight' 'wmh' number (default 1)
8746 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008747 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008748 feature}
8749 The minimal height of a window, when it's not the current window.
8750 This is a hard minimum, windows will never become smaller.
8751 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8752 status bar) if necessary. They will return to at least one line when
8753 they become active (since the cursor has to have somewhere to go.)
8754 Use 'winheight' to set the minimal height of the current window.
8755 This option is only checked when making a window smaller. Don't use a
8756 large number, it will cause errors when opening more than a few
8757 windows. A value of 0 to 3 is reasonable.
8758
8759 *'winminwidth'* *'wmw'*
8760'winminwidth' 'wmw' number (default 1)
8761 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008762 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763 feature}
8764 The minimal width of a window, when it's not the current window.
8765 This is a hard minimum, windows will never become smaller.
8766 When set to zero, windows may be "squashed" to zero columns (i.e. just
8767 a vertical separator) if necessary. They will return to at least one
8768 line when they become active (since the cursor has to have somewhere
8769 to go.)
8770 Use 'winwidth' to set the minimal width of the current window.
8771 This option is only checked when making a window smaller. Don't use a
8772 large number, it will cause errors when opening more than a few
8773 windows. A value of 0 to 12 is reasonable.
8774
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008775 *'winptydll'*
8776'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8777 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008778 {only available when compiled with the |terminal|
8779 feature on MS-Windows}
8780 Specifies the name of the winpty shared library, used for the
8781 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008782 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008783 a fallback.
8784 Environment variables are expanded |:set_env|.
8785 This option cannot be set from a |modeline| or in the |sandbox|, for
8786 security reasons.
8787
Bram Moolenaar071d4272004-06-13 20:20:40 +00008788 *'winwidth'* *'wiw'* *E592*
8789'winwidth' 'wiw' number (default 20)
8790 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008791 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008792 feature}
8793 Minimal number of columns for the current window. This is not a hard
8794 minimum, Vim will use fewer columns if there is not enough room. If
8795 the current window is smaller, its size is increased, at the cost of
8796 the width of other windows. Set it to 999 to make the current window
8797 always fill the screen. Set it to a small number for normal editing.
8798 The width is not adjusted after one of the commands to change the
8799 width of the current window.
8800 'winwidth' applies to the current window. Use 'winminwidth' to set
8801 the minimal width for other windows.
8802
8803 *'wrap'* *'nowrap'*
8804'wrap' boolean (default on)
8805 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008806 This option changes how text is displayed. It doesn't change the text
8807 in the buffer, see 'textwidth' for that.
8808 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008809 displaying continues on the next line. When off lines will not wrap
8810 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008811 moved to a part that is not shown, the screen will scroll
8812 horizontally.
8813 The line will be broken in the middle of a word if necessary. See
8814 'linebreak' to get the break at a word boundary.
8815 To make scrolling horizontally a bit more useful, try this: >
8816 :set sidescroll=5
8817 :set listchars+=precedes:<,extends:>
8818< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008819 This option can't be set from a |modeline| when the 'diff' option is
8820 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008821
8822 *'wrapmargin'* *'wm'*
8823'wrapmargin' 'wm' number (default 0)
8824 local to buffer
8825 Number of characters from the right window border where wrapping
8826 starts. When typing text beyond this limit, an <EOL> will be inserted
8827 and inserting continues on the next line.
8828 Options that add a margin, such as 'number' and 'foldcolumn', cause
8829 the text width to be further reduced. This is Vi compatible.
8830 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008831 This option is set to 0 when 'paste' is set and restored when 'paste'
8832 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008833 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008834
8835 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8836'wrapscan' 'ws' boolean (default on) *E384* *E385*
8837 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008838 Searches wrap around the end of the file. Also applies to |]s| and
8839 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008840
8841 *'write'* *'nowrite'*
8842'write' boolean (default on)
8843 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008844 Allows writing files. When not set, writing a file is not allowed.
8845 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008846 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008847 argument. Filtering text is still possible, even though this requires
8848 writing a temporary file.
8849
8850 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8851'writeany' 'wa' boolean (default off)
8852 global
8853 Allows writing to any file with no need for "!" override.
8854
8855 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8856'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8857 otherwise)
8858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008859 Make a backup before overwriting a file. The backup is removed after
8860 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008861 also on.
8862 WARNING: Switching this option off means that when Vim fails to write
8863 your buffer correctly and then, for whatever reason, Vim exits, you
8864 lose both the original file and what you were writing. Only reset
8865 this option if your file system is almost full and it makes the write
8866 fail (and make sure not to exit Vim until the write was successful).
8867 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008868 When the 'backupskip' pattern matches, a backup is not made anyway.
8869 NOTE: This option is set to the default value when 'compatible' is
8870 set.
8871
8872 *'writedelay'* *'wd'*
8873'writedelay' 'wd' number (default 0)
8874 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008875 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008876 screen. When non-zero, characters are sent to the terminal one by
8877 one. For MS-DOS pcterm this does not work. For debugging purposes.
8878
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008879 vim:tw=78:ts=8:noet:ft=help:norl: