blob: 5557f636b62a3b471bf9f12d1fdc73cc90d2f8a8 [file] [log] [blame]
Bram Moolenaar54775062019-07-31 21:07:14 +02001*options.txt* For Vim version 8.1. Last change: 2019 Jul 31
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
Bram Moolenaar54775062019-07-31 21:07:14 +02001134 Instead of showing a balloon, which is limited to plain text, consider
1135 using a popup window, see |popup_beval_example|. A popup window can
1136 use highlighting and show a border.
1137
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001138 The evaluation of the expression must not have side effects!
1139 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001140 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001141 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001142 \', column ' . v:beval_col .
1143 \ ' of file ' . bufname(v:beval_bufnr) .
1144 \ ' on word "' . v:beval_text . '"'
1145 endfunction
1146 set bexpr=MyBalloonExpr()
1147 set ballooneval
1148<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001149 Also see |balloon_show()|, it can be used if the content of the balloon
1150 is to be fetched asynchronously. In that case evaluating
1151 'balloonexpr' should result in an empty string. If you get a balloon
1152 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001153
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001154 NOTE: The balloon is displayed only if the cursor is on a text
1155 character. If the result of evaluating 'balloonexpr' is not empty,
1156 Vim does not try to send a message to an external debugger (Netbeans
1157 or Sun Workshop).
1158
Bram Moolenaar30b65812012-07-12 22:01:11 +02001159 The expression will be evaluated in the |sandbox| when set from a
1160 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001161 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001162
1163 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001164 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001165
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001166 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001167 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001168< When they are supported "\n" characters will start a new line. If the
1169 expression evaluates to a |List| this is equal to using each List item
1170 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001171 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001172
Bram Moolenaar165bc692015-07-21 17:53:25 +02001173 *'belloff'* *'bo'*
1174'belloff' 'bo' string (default "")
1175 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001176 Specifies for which events the bell will not be rung. It is a comma
1177 separated list of items. For each item that is present, the bell
1178 will be silenced. This is most useful to specify specific events in
1179 insert mode to be silenced.
1180
1181 item meaning when present ~
1182 all All events.
1183 backspace When hitting <BS> or <Del> and deleting results in an
1184 error.
1185 cursor Fail to move around using the cursor keys or
1186 <PageUp>/<PageDown> in |Insert-mode|.
1187 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1188 |i_CTRL-X_CTRL-T|.
1189 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1190 |i_CTRL-E|.
1191 ctrlg Unknown Char after <C-G> in Insert mode.
1192 error Other Error occurred (e.g. try to join last line)
1193 (mostly used in |Normal-mode| or |Cmdline-mode|).
1194 esc hitting <Esc> in |Normal-mode|.
1195 ex In |Visual-mode|, hitting |Q| results in an error.
1196 hangul Error occurred when using hangul input.
1197 insertmode Pressing <Esc> in 'insertmode'.
1198 lang Calling the beep module for Lua/Mzscheme/TCL.
1199 mess No output available for |g<|.
1200 showmatch Error occurred for 'showmatch' function.
1201 operator Empty region error |cpo-E|.
1202 register Unknown register after <C-R> in |Insert-mode|.
1203 shell Bell from shell output |:!|.
1204 spell Error happened on spell suggest.
1205 wildmode More matches in |cmdline-completion| available
1206 (depends on the 'wildmode' setting).
1207
Bram Moolenaar036986f2017-03-16 17:41:02 +01001208 This is most useful to fine tune when in Insert mode the bell should
1209 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001210 indicate that an error occurred. It can be silenced by adding the
1211 "error" keyword.
1212
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1214'binary' 'bin' boolean (default off)
1215 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216 This option should be set before editing a binary file. You can also
1217 use the |-b| Vim argument. When this option is switched on a few
1218 options will be changed (also when it already was on):
1219 'textwidth' will be set to 0
1220 'wrapmargin' will be set to 0
1221 'modeline' will be off
1222 'expandtab' will be off
1223 Also, 'fileformat' and 'fileformats' options will not be used, the
1224 file is read and written like 'fileformat' was "unix" (a single <NL>
1225 separates lines).
1226 The 'fileencoding' and 'fileencodings' options will not be used, the
1227 file is read without conversion.
1228 NOTE: When you start editing a(nother) file while the 'bin' option is
1229 on, settings from autocommands may change the settings again (e.g.,
1230 'textwidth'), causing trouble when editing. You might want to set
1231 'bin' again when the file has been loaded.
1232 The previous values of these options are remembered and restored when
1233 'bin' is switched from on to off. Each buffer has its own set of
1234 saved option values.
1235 To edit a file with 'binary' set you can use the |++bin| argument.
1236 This avoids you have to do ":set bin", which would have effect for all
1237 files you edit.
1238 When writing a file the <EOL> for the last line is only written if
1239 there was one in the original file (normally Vim appends an <EOL> to
1240 the last line if there is none; this would make the file longer). See
1241 the 'endofline' option.
1242
1243 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1244'bioskey' 'biosk' boolean (default on)
1245 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001246 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001247 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248
1249 *'bomb'* *'nobomb'*
1250'bomb' boolean (default off)
1251 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252 When writing a file and the following conditions are met, a BOM (Byte
1253 Order Mark) is prepended to the file:
1254 - this option is on
1255 - the 'binary' option is off
1256 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1257 endian variants.
1258 Some applications use the BOM to recognize the encoding of the file.
1259 Often used for UCS-2 files on MS-Windows. For other applications it
1260 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001261 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1263 check for the presence of the BOM is done and 'bomb' set accordingly.
1264 Unless 'binary' is set, it is removed from the first line, so that you
1265 don't see it when editing. When you don't change the options, the BOM
1266 will be restored when writing the file.
1267
1268 *'breakat'* *'brk'*
1269'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1270 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001271 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272 feature}
1273 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001274 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1275 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001277 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001278'breakindent' 'bri' boolean (default off)
1279 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001280 {not available when compiled without the |+linebreak|
1281 feature}
1282 Every wrapped line will continue visually indented (same amount of
1283 space as the beginning of that line), thus preserving horizontal blocks
1284 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001285 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001286
1287 *'breakindentopt'* *'briopt'*
1288'breakindentopt' 'briopt' string (default empty)
1289 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001290 {not available when compiled without the |+linebreak|
1291 feature}
1292 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001293 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001294 min:{n} Minimum text width that will be kept after
1295 applying 'breakindent', even if the resulting
1296 text should normally be narrower. This prevents
1297 text indented almost to the right window border
1298 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001299 shift:{n} After applying 'breakindent', the wrapped line's
1300 beginning will be shifted by the given number of
1301 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001302 indentation (negative) or emphasizing the line
1303 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001304 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001305 additional indent.
1306 The default value for min is 20 and shift is 0.
1307
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001309'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001310 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001311 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001313 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001314 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315 buffer Use the directory of the related buffer.
1316 current Use the current directory.
1317 {path} Use the specified directory
1318
1319 *'bufhidden'* *'bh'*
1320'bufhidden' 'bh' string (default: "")
1321 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322 This option specifies what happens when a buffer is no longer
1323 displayed in a window:
1324 <empty> follow the global 'hidden' option
1325 hide hide the buffer (don't unload it), also when 'hidden'
1326 is not set
1327 unload unload the buffer, also when 'hidden' is set or using
1328 |:hide|
1329 delete delete the buffer from the buffer list, also when
1330 'hidden' is set or using |:hide|, like using
1331 |:bdelete|
1332 wipe wipe out the buffer from the buffer list, also when
1333 'hidden' is set or using |:hide|, like using
1334 |:bwipeout|
1335
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001336 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001337 are lost without a warning. Also, these values may break autocommands
1338 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 This option is used together with 'buftype' and 'swapfile' to specify
1340 special kinds of buffers. See |special-buffers|.
1341
1342 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1343'buflisted' 'bl' boolean (default: on)
1344 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345 When this option is set, the buffer shows up in the buffer list. If
1346 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1347 This option is reset by Vim for buffers that are only used to remember
1348 a file name or marks. Vim sets it when starting to edit a buffer.
1349 But not when moving to a buffer with ":buffer".
1350
1351 *'buftype'* *'bt'* *E382*
1352'buftype' 'bt' string (default: "")
1353 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 The value of this option specifies the type of a buffer:
1355 <empty> normal buffer
1356 nofile buffer which is not related to a file and will not be
1357 written
1358 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001359 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001360 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001361 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001362 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001363 help help buffer (you are not supposed to set this
1364 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001365 terminal buffer for a |terminal| (you are not supposed to set
1366 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001367 prompt buffer where only the last line can be edited, meant
1368 to be used by a plugin, see |prompt-buffer|
1369 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001370 popup buffer used in a popup window, see |popup|.
1371 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001372
1373 This option is used together with 'bufhidden' and 'swapfile' to
1374 specify special kinds of buffers. See |special-buffers|.
1375
1376 Be careful with changing this option, it can have many side effects!
1377
Bram Moolenaar280f1262006-01-30 00:14:18 +00001378 A "quickfix" buffer is only used for the error list and the location
1379 list. This value is set by the |:cwindow| and |:lwindow| commands and
1380 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381
1382 "nofile" and "nowrite" buffers are similar:
1383 both: The buffer is not to be written to disk, ":w" doesn't
1384 work (":w filename" does work though).
1385 both: The buffer is never considered to be |'modified'|.
1386 There is no warning when the changes will be lost, for
1387 example when you quit Vim.
1388 both: A swap file is only created when using too much memory
1389 (when 'swapfile' has been reset there is never a swap
1390 file).
1391 nofile only: The buffer name is fixed, it is not handled like a
1392 file name. It is not modified in response to a |:cd|
1393 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001394 both: When using ":e bufname" and already editing "bufname"
1395 the buffer is made empty and autocommands are
1396 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001397 *E676*
1398 "acwrite" implies that the buffer name is not related to a file, like
1399 "nofile", but it will be written. Thus, in contrast to "nofile" and
1400 "nowrite", ":w" does work and a modified buffer can't be abandoned
1401 without saving. For writing there must be matching |BufWriteCmd|,
1402 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403
1404 *'casemap'* *'cmp'*
1405'casemap' 'cmp' string (default: "internal,keepascii")
1406 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407 Specifies details about changing the case of letters. It may contain
1408 these words, separated by a comma:
1409 internal Use internal case mapping functions, the current
1410 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001411 matters when 'encoding' is a Unicode encoding,
1412 "latin1" or "iso-8859-15". When "internal" is
1413 omitted, the towupper() and towlower() system library
1414 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1416 case mapping, the current locale is not effective.
1417 This probably only matters for Turkish.
1418
1419 *'cdpath'* *'cd'* *E344* *E346*
1420'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1421 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001422 {not available when compiled without the
1423 |+file_in_path| feature}
1424 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001425 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1426 searched for has a relative path, not an absolute part starting with
1427 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428 The 'cdpath' option's value has the same form and semantics as
1429 |'path'|. Also see |file-searching|.
1430 The default value is taken from $CDPATH, with a "," prepended to look
1431 in the current directory first.
1432 If the default value taken from $CDPATH is not what you want, include
1433 a modified version of the following command in your vimrc file to
1434 override it: >
1435 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1436< This option cannot be set from a |modeline| or in the |sandbox|, for
1437 security reasons.
1438 (parts of 'cdpath' can be passed to the shell to expand file names).
1439
1440 *'cedit'*
1441'cedit' string (Vi default: "", Vim default: CTRL-F)
1442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 The key used in Command-line Mode to open the command-line window.
1444 The default is CTRL-F when 'compatible' is off.
1445 Only non-printable keys are allowed.
1446 The key can be specified as a single character, but it is difficult to
1447 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001448 :exe "set cedit=\<C-Y>"
1449 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450< |Nvi| also has this option, but it only uses the first character.
1451 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001452 NOTE: This option is set to the Vim default value when 'compatible'
1453 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454
1455 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1456'charconvert' 'ccv' string (default "")
1457 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001458 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459 An expression that is used for character encoding conversion. It is
1460 evaluated when a file that is to be read or has been written has a
1461 different encoding from what is desired.
1462 'charconvert' is not used when the internal iconv() function is
1463 supported and is able to do the conversion. Using iconv() is
1464 preferred, because it is much faster.
1465 'charconvert' is not used when reading stdin |--|, because there is no
1466 file to convert from. You will have to save the text in a file first.
1467 The expression must return zero or an empty string for success,
1468 non-zero for failure.
1469 The possible encoding names encountered are in 'encoding'.
1470 Additionally, names given in 'fileencodings' and 'fileencoding' are
1471 used.
1472 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1473 is done internally by Vim, 'charconvert' is not used for this.
1474 'charconvert' is also used to convert the viminfo file, if the 'c'
1475 flag is present in 'viminfo'. Also used for Unicode conversion.
1476 Example: >
1477 set charconvert=CharConvert()
1478 fun CharConvert()
1479 system("recode "
1480 \ . v:charconvert_from . ".." . v:charconvert_to
1481 \ . " <" . v:fname_in . " >" v:fname_out)
1482 return v:shell_error
1483 endfun
1484< The related Vim variables are:
1485 v:charconvert_from name of the current encoding
1486 v:charconvert_to name of the desired encoding
1487 v:fname_in name of the input file
1488 v:fname_out name of the output file
1489 Note that v:fname_in and v:fname_out will never be the same.
1490 Note that v:charconvert_from and v:charconvert_to may be different
1491 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1492 Encryption is not done by Vim when using 'charconvert'. If you want
1493 to encrypt the file after conversion, 'charconvert' should take care
1494 of this.
1495 This option cannot be set from a |modeline| or in the |sandbox|, for
1496 security reasons.
1497
1498 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1499'cindent' 'cin' boolean (default off)
1500 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 {not available when compiled without the |+cindent|
1502 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001503 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 that trigger reindenting in insert mode and 'cinoptions' to set your
1505 preferred indent style.
1506 If 'indentexpr' is not empty, it overrules 'cindent'.
1507 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1508 the "=" operator indents using this algorithm rather than calling an
1509 external program.
1510 See |C-indenting|.
1511 When you don't like the way 'cindent' works, try the 'smartindent'
1512 option or 'indentexpr'.
1513 This option is not used when 'paste' is set.
1514 NOTE: This option is reset when 'compatible' is set.
1515
1516 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001517'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001518 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 {not available when compiled without the |+cindent|
1520 feature}
1521 A list of keys that, when typed in Insert mode, cause reindenting of
1522 the current line. Only used if 'cindent' is on and 'indentexpr' is
1523 empty.
1524 For the format of this option see |cinkeys-format|.
1525 See |C-indenting|.
1526
1527 *'cinoptions'* *'cino'*
1528'cinoptions' 'cino' string (default "")
1529 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530 {not available when compiled without the |+cindent|
1531 feature}
1532 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1533 program. See |cinoptions-values| for the values of this option, and
1534 |C-indenting| for info on C indenting in general.
1535
1536
1537 *'cinwords'* *'cinw'*
1538'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1539 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540 {not available when compiled without both the
1541 |+cindent| and the |+smartindent| features}
1542 These keywords start an extra indent in the next line when
1543 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1544 an appropriate place (inside {}).
1545 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1546 matter, include the keyword both the uppercase and lowercase:
1547 "if,If,IF".
1548
1549 *'clipboard'* *'cb'*
1550'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1551 for X-windows, "" otherwise)
1552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553 {only in GUI versions or when the |+xterm_clipboard|
1554 feature is included}
1555 This option is a list of comma separated names.
1556 These names are recognized:
1557
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001558 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 unnamed When included, Vim will use the clipboard register '*'
1560 for all yank, delete, change and put operations which
1561 would normally go to the unnamed register. When a
1562 register is explicitly specified, it will always be
1563 used regardless of whether "unnamed" is in 'clipboard'
1564 or not. The clipboard register can always be
1565 explicitly accessed using the "* notation. Also see
1566 |gui-clipboard|.
1567
Bram Moolenaar30b65812012-07-12 22:01:11 +02001568 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001569 unnamedplus A variant of the "unnamed" flag which uses the
1570 clipboard register '+' (|quoteplus|) instead of
1571 register '*' for all yank, delete, change and put
1572 operations which would normally go to the unnamed
1573 register. When "unnamed" is also included to the
1574 option, yank operations (but not delete, change or
1575 put) will additionally copy the text into register
1576 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001577 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001578 Availability can be checked with: >
1579 if has('unnamedplus')
1580<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001581 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 autoselect Works like the 'a' flag in 'guioptions': If present,
1583 then whenever Visual mode is started, or the Visual
1584 area extended, Vim tries to become the owner of the
1585 windowing system's global selection or put the
1586 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001587 register "*. See |'go-a'| and |quotestar| for details.
1588 When the GUI is active, the 'a' flag in 'guioptions'
1589 is used, when the GUI is not active, this "autoselect"
1590 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591 Also applies to the modeless selection.
1592
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001593 *clipboard-autoselectplus*
1594 autoselectplus Like "autoselect" but using the + register instead of
1595 the * register. Compare to the 'P' flag in
1596 'guioptions'.
1597
1598 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 autoselectml Like "autoselect", but for the modeless selection
1600 only. Compare to the 'A' flag in 'guioptions'.
1601
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001602 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001603 html When the clipboard contains HTML, use this when
1604 pasting. When putting text on the clipboard, mark it
1605 as HTML. This works to copy rendered HTML from
1606 Firefox, paste it as raw HTML in Vim, select the HTML
1607 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001608 You probably want to add this only temporarily,
1609 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001610 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001611
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001612 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 exclude:{pattern}
1614 Defines a pattern that is matched against the name of
1615 the terminal 'term'. If there is a match, no
1616 connection will be made to the X server. This is
1617 useful in this situation:
1618 - Running Vim in a console.
1619 - $DISPLAY is set to start applications on another
1620 display.
1621 - You do not want to connect to the X server in the
1622 console, but do want this in a terminal emulator.
1623 To never connect to the X server use: >
1624 exclude:.*
1625< This has the same effect as using the |-X| argument.
1626 Note that when there is no connection to the X server
1627 the window title won't be restored and the clipboard
1628 cannot be accessed.
1629 The value of 'magic' is ignored, {pattern} is
1630 interpreted as if 'magic' was on.
1631 The rest of the option value will be used for
1632 {pattern}, this must be the last entry.
1633
1634 *'cmdheight'* *'ch'*
1635'cmdheight' 'ch' number (default 1)
1636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 Number of screen lines to use for the command-line. Helps avoiding
1638 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001639 The value of this option is stored with the tab page, so that each tab
1640 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641
1642 *'cmdwinheight'* *'cwh'*
1643'cmdwinheight' 'cwh' number (default 7)
1644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645 Number of screen lines to use for the command-line window. |cmdwin|
1646
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001647 *'colorcolumn'* *'cc'*
1648'colorcolumn' 'cc' string (default "")
1649 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001650 {not available when compiled without the |+syntax|
1651 feature}
1652 'colorcolumn' is a comma separated list of screen columns that are
1653 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1654 text. Will make screen redrawing slower.
1655 The screen column can be an absolute number, or a number preceded with
1656 '+' or '-', which is added to or subtracted from 'textwidth'. >
1657
1658 :set cc=+1 " highlight column after 'textwidth'
1659 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1660 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1661<
1662 When 'textwidth' is zero then the items with '-' and '+' are not used.
1663 A maximum of 256 columns are highlighted.
1664
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 *'columns'* *'co'* *E594*
1666'columns' 'co' number (default 80 or terminal width)
1667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001669 initialization and does not have to be set by hand. Also see
1670 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 When Vim is running in the GUI or in a resizable window, setting this
1672 option will cause the window size to be changed. When you only want
1673 to use the size for the GUI, put the command in your |gvimrc| file.
1674 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001675 number of columns of the display, the display may be messed up. For
1676 the GUI it is always possible and Vim limits the number of columns to
1677 what fits on the screen. You can use this command to get the widest
1678 window possible: >
1679 :set columns=9999
1680< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681
1682 *'comments'* *'com'* *E524* *E525*
1683'comments' 'com' string (default
1684 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1685 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 {not available when compiled without the |+comments|
1687 feature}
1688 A comma separated list of strings that can start a comment line. See
1689 |format-comments|. See |option-backslash| about using backslashes to
1690 insert a space.
1691
1692 *'commentstring'* *'cms'* *E537*
1693'commentstring' 'cms' string (default "/*%s*/")
1694 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695 {not available when compiled without the |+folding|
1696 feature}
1697 A template for a comment. The "%s" in the value is replaced with the
1698 comment text. Currently only used to add markers for folding, see
1699 |fold-marker|.
1700
1701 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001702'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001703 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 This option has the effect of making Vim either more Vi-compatible, or
1706 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001707
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001709 other options are also changed as a side effect.
1710 NOTE: Setting or resetting this option can have a lot of unexpected
1711 effects: Mappings are interpreted in another way, undo behaves
1712 differently, etc. If you set this option in your vimrc file, you
1713 should probably put it at the very start.
1714
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715 By default this option is on and the Vi defaults are used for the
1716 options. This default was chosen for those people who want to use Vim
1717 just like Vi, and don't even (want to) know about the 'compatible'
1718 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001719 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001720 this option is switched off, and all options that have not been
1721 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001722 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001723 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001724 happen for the system-wide vimrc or gvimrc file, nor for a file given
1725 with the |-u| argument). Also see |compatible-default| and
1726 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 You can also set this option with the "-C" argument, and reset it with
1728 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001729 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730
Bram Moolenaar214641f2017-03-05 17:04:09 +01001731 When this option is set, numerous other options are set to make Vim as
1732 Vi-compatible as possible. When this option is unset, various options
1733 are set to make Vim more useful. The table below lists all the
1734 options affected.
1735 The {?} column indicates when the options are affected:
1736 + Means that the option is set to the value given in {set value} when
1737 'compatible' is set.
1738 & Means that the option is set to the value given in {set value} when
1739 'compatible' is set AND is set to its Vim default value when
1740 'compatible' is unset.
1741 - Means the option is NOT changed when setting 'compatible' but IS
1742 set to its Vim default when 'compatible' is unset.
1743 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744
Bram Moolenaar036986f2017-03-16 17:41:02 +01001745 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001746
1747 'allowrevins' + off no CTRL-_ command
1748 'antialias' + off don't use antialiased fonts
1749 'arabic' + off reset arabic-related options
1750 'arabicshape' + on correct character shapes
1751 'backspace' + "" normal backspace
1752 'backup' + off no backup file
1753 'backupcopy' & Unix: "yes" backup file is a copy
1754 else: "auto" copy or rename backup file
1755 'balloonexpr' + "" text to show in evaluation balloon
1756 'breakindent' + off don't indent when wrapping lines
1757 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1758 'cindent' + off no C code indentation
1759 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1760 'copyindent' + off don't copy indent structure
1761 'cpoptions' & (all flags) Vi-compatible flags
1762 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001763 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001764 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001765 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001766 'cscopeverbose' + off see |cscopeverbose|
1767 'delcombine' + off unicode: delete whole char combination
1768 'digraph' + off no digraphs
1769 'esckeys' & off no <Esc>-keys in Insert mode
1770 'expandtab' + off tabs not expanded to spaces
1771 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001773 'formatexpr' + "" use 'formatprg' for auto-formatting
1774 'formatoptions' & "vt" Vi compatible formatting
1775 'gdefault' + off no default 'g' flag for ":s"
1776 'history' & 0 no commandline history
1777 'hkmap' + off no Hebrew keyboard mapping
1778 'hkmapp' + off no phonetic Hebrew keyboard mapping
1779 'hlsearch' + off no highlighting of search matches
1780 'incsearch' + off no incremental searching
1781 'indentexpr' + "" no indenting by expression
1782 'insertmode' + off do not start in Insert mode
1783 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001785 'joinspaces' + on insert 2 spaces after period
1786 'modeline' & off no modelines
1787 'more' & off no pauses in listings
1788 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1789 'numberwidth' & 8 min number of columns for line number
1790 'preserveindent'+ off don't preserve current indent structure
1791 when changing it
1792 'revins' + off no reverse insert
1793 'ruler' + off no ruler
1794 'scrolljump' + 1 no jump scroll
1795 'scrolloff' + 0 no scroll offset
1796 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1797 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001798 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001799 'showcmd' & off command characters not shown
1800 'showmode' & off current mode not shown
1801 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1802 'smartcase' + off no automatic ignore case switch
1803 'smartindent' + off no smart indentation
1804 'smarttab' + off no smart tab size
1805 'softtabstop' + 0 tabs are always 'tabstop' positions
1806 'startofline' + on goto startofline with some commands
1807 'tagcase' & "followic" 'ignorecase' when searching tags file
1808 'tagrelative' & off tag file names are not relative
1809 'termguicolors' + off don't use highlight-(guifg|guibg)
1810 'textauto' & off no automatic textmode detection
1811 'textwidth' + 0 no automatic line wrap
1812 'tildeop' + off tilde is not an operator
1813 'ttimeout' + off no terminal timeout
1814 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001815 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001816 'virtualedit' + "" cursor can only be placed on characters
1817 'whichwrap' & "" left-right movements don't wrap
1818 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001820 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821
1822 *'complete'* *'cpt'* *E535*
1823'complete' 'cpt' string (default: ".,w,b,u,t,i")
1824 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 This option specifies how keyword completion |ins-completion| works
1826 when CTRL-P or CTRL-N are used. It is also used for whole-line
1827 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1828 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001829 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 w scan buffers from other windows
1831 b scan other loaded buffers that are in the buffer list
1832 u scan the unloaded buffers that are in the buffer list
1833 U scan the buffers that are not in the buffer list
1834 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001835 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 k{dict} scan the file {dict}. Several "k" flags can be given,
1837 patterns are valid too. For example: >
1838 :set cpt=k/usr/dict/*,k~/spanish
1839< s scan the files given with the 'thesaurus' option
1840 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1841 are valid too.
1842 i scan current and included files
1843 d scan current and included files for defined name or macro
1844 |i_CTRL-X_CTRL-D|
1845 ] tag completion
1846 t same as "]"
1847
1848 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1849 not executed, this may lead to unexpected completions from some files
1850 (gzipped files for example). Unloaded buffers are not scanned for
1851 whole-line completion.
1852
1853 The default is ".,w,b,u,t,i", which means to scan:
1854 1. the current buffer
1855 2. buffers in other windows
1856 3. other loaded buffers
1857 4. unloaded buffers
1858 5. tags
1859 6. included files
1860
1861 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001862 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1863 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001865 *'completefunc'* *'cfu'*
1866'completefunc' 'cfu' string (default: empty)
1867 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001868 {not available when compiled without the |+eval|
1869 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001870 This option specifies a function to be used for Insert mode completion
1871 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001872 See |complete-functions| for an explanation of how the function is
1873 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001874 This option cannot be set from a |modeline| or in the |sandbox|, for
1875 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001876
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001877 *'completeslash'* *'csl'*
1878'completeslash' 'csl' string (default: "")
1879 local to buffer
1880 {not in Vi} {only for MS-Windows}
1881 When this option is set it overrules 'shellslash' for completion:
1882 - When this option is set to "slash", a forward slash is used for path
1883 completion in insert mode. This is useful when editing HTML tag, or
1884 Makefile with 'noshellslash' on Windows.
1885 - When this option is set to "backslash", backslash is used. This is
1886 useful when editing a batch file with 'shellslash' set on Windows.
1887 - When this option is empty, same character is used as for
1888 'shellslash'.
1889 For Insert mode completion the buffer-local value is used. For
1890 command line completion the global value is used.
1891
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001892 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001893'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001894 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001895 {not available when compiled without the
1896 |+insert_expand| feature}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001897 A comma separated list of options for Insert mode completion
1898 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001899
1900 menu Use a popup menu to show the possible completions. The
1901 menu is only shown when there is more than one match and
1902 sufficient colors are available. |ins-completion-menu|
1903
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001904 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001905 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001906 match, e.g., what file it comes from.
1907
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001908 longest Only insert the longest common text of the matches. If
1909 the menu is displayed you can use CTRL-L to add more
1910 characters. Whether case is ignored depends on the kind
1911 of completion. For buffer text the 'ignorecase' option is
1912 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001913
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001914 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001915 completion in the preview window. Only works in
1916 combination with "menu" or "menuone".
1917
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001918 noinsert Do not insert any text for a match until the user selects
1919 a match from the menu. Only works in combination with
1920 "menu" or "menuone". No effect if "longest" is present.
1921
1922 noselect Do not select a match in the menu, force the user to
1923 select one from the menu. Only works in combination with
1924 "menu" or "menuone".
1925
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001926
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001927 *'concealcursor'* *'cocu'*
1928'concealcursor' 'cocu' string (default: "")
1929 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001930 {not available when compiled without the |+conceal|
1931 feature}
1932 Sets the modes in which text in the cursor line can also be concealed.
1933 When the current mode is listed then concealing happens just like in
1934 other lines.
1935 n Normal mode
1936 v Visual mode
1937 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001938 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001939
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001940 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001941 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001942 are moving around text is concealed, but when starting to insert text
1943 or selecting a Visual area the concealed text is displayed, so that
1944 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001945 Keep in mind that the cursor position is not always where it's
1946 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001947
1948
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001949 *'conceallevel'* *'cole'*
1950'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001951 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001952 {not available when compiled without the |+conceal|
1953 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001954 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1955 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001956
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001957 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001958 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001959 1 Each block of concealed text is replaced with one
1960 character. If the syntax item does not have a custom
1961 replacement character defined (see |:syn-cchar|) the
1962 character defined in 'listchars' is used (default is a
1963 space).
1964 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001965 2 Concealed text is completely hidden unless it has a
1966 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001967 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001968 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001969
Bram Moolenaara7781e02010-07-19 20:13:22 +02001970 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001971 edit and copy the text. This can be changed with the 'concealcursor'
1972 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001973
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1975'confirm' 'cf' boolean (default off)
1976 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001977 When 'confirm' is on, certain operations that would normally
1978 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1979 instead raise a |dialog| asking if you wish to save the current
1980 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1981 If 'confirm' is off you can still activate confirmation for one
1982 command only (this is most useful in mappings) with the |:confirm|
1983 command.
1984 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1985
1986 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1987'conskey' 'consk' boolean (default off)
1988 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01001989 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990
1991 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1992'copyindent' 'ci' boolean (default off)
1993 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001994 Copy the structure of the existing lines indent when autoindenting a
1995 new line. Normally the new indent is reconstructed by a series of
1996 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1997 in which case only spaces are used). Enabling this option makes the
1998 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001999 existing line. 'expandtab' has no effect on these characters, a Tab
2000 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002002 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003 Also see 'preserveindent'.
2004
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002005 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006'cpoptions' 'cpo' string (Vim default: "aABceFs",
2007 Vi default: all flags)
2008 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002010 this indicates Vi-compatible behavior. This is used for things where
2011 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 'cpoptions' stands for "compatible-options".
2013 Commas can be added for readability.
2014 To avoid problems with flags that are added in the future, use the
2015 "+=" and "-=" feature of ":set" |add-option-flags|.
2016 NOTE: This option is set to the Vi default value when 'compatible' is
2017 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002018 NOTE: This option is set to the POSIX default value at startup when
2019 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002020 variable exists |posix|. This means Vim tries to behave like the
2021 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022
2023 contains behavior ~
2024 *cpo-a*
2025 a When included, a ":read" command with a file name
2026 argument will set the alternate file name for the
2027 current window.
2028 *cpo-A*
2029 A When included, a ":write" command with a file name
2030 argument will set the alternate file name for the
2031 current window.
2032 *cpo-b*
2033 b "\|" in a ":map" command is recognized as the end of
2034 the map command. The '\' is included in the mapping,
2035 the text after the '|' is interpreted as the next
2036 command. Use a CTRL-V instead of a backslash to
2037 include the '|' in the mapping. Applies to all
2038 mapping, abbreviation, menu and autocmd commands.
2039 See also |map_bar|.
2040 *cpo-B*
2041 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002042 abbreviations, user commands and the "to" part of the
2043 menu commands. Remove this flag to be able to use a
2044 backslash like a CTRL-V. For example, the command
2045 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 'B' included: "\^[" (^[ is a real <Esc>)
2047 'B' excluded: "<Esc>" (5 characters)
2048 ('<' excluded in both cases)
2049 *cpo-c*
2050 c Searching continues at the end of any match at the
2051 cursor position, but not further than the start of the
2052 next line. When not present searching continues
2053 one character from the cursor position. With 'c'
2054 "abababababab" only gets three matches when repeating
2055 "/abab", without 'c' there are five matches.
2056 *cpo-C*
2057 C Do not concatenate sourced lines that start with a
2058 backslash. See |line-continuation|.
2059 *cpo-d*
2060 d Using "./" in the 'tags' option doesn't mean to use
2061 the tags file relative to the current file, but the
2062 tags file in the current directory.
2063 *cpo-D*
2064 D Can't use CTRL-K to enter a digraph after Normal mode
2065 commands with a character argument, like |r|, |f| and
2066 |t|.
2067 *cpo-e*
2068 e When executing a register with ":@r", always add a
2069 <CR> to the last line, also when the register is not
2070 linewise. If this flag is not present, the register
2071 is not linewise and the last line does not end in a
2072 <CR>, then the last line is put on the command-line
2073 and can be edited before hitting <CR>.
2074 *cpo-E*
2075 E It is an error when using "y", "d", "c", "g~", "gu" or
2076 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002077 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078 This makes "y0" fail in the first column.
2079 *cpo-f*
2080 f When included, a ":read" command with a file name
2081 argument will set the file name for the current buffer,
2082 if the current buffer doesn't have a file name yet.
2083 *cpo-F*
2084 F When included, a ":write" command with a file name
2085 argument will set the file name for the current
2086 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002087 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002088 *cpo-g*
2089 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002090 *cpo-H*
2091 H When using "I" on a line with only blanks, insert
2092 before the last blank. Without this flag insert after
2093 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 *cpo-i*
2095 i When included, interrupting the reading of a file will
2096 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002097 *cpo-I*
2098 I When moving the cursor up or down just after inserting
2099 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100 *cpo-j*
2101 j When joining lines, only add two spaces after a '.',
2102 not after '!' or '?'. Also see 'joinspaces'.
2103 *cpo-J*
2104 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002105 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106 white space.
2107 *cpo-k*
2108 k Disable the recognition of raw key codes in
2109 mappings, abbreviations, and the "to" part of menu
2110 commands. For example, if <Key> sends ^[OA (where ^[
2111 is <Esc>), the command ":map X ^[OA" results in X
2112 being mapped to:
2113 'k' included: "^[OA" (3 characters)
2114 'k' excluded: "<Key>" (one key code)
2115 Also see the '<' flag below.
2116 *cpo-K*
2117 K Don't wait for a key code to complete when it is
2118 halfway a mapping. This breaks mapping <F1><F1> when
2119 only part of the second <F1> has been read. It
2120 enables cancelling the mapping by typing <F1><Esc>.
2121 *cpo-l*
2122 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002123 literally, only "\]", "\^", "\-" and "\\" are special.
2124 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2126 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002127 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 *cpo-L*
2129 L When the 'list' option is set, 'wrapmargin',
2130 'textwidth', 'softtabstop' and Virtual Replace mode
2131 (see |gR|) count a <Tab> as two characters, instead of
2132 the normal behavior of a <Tab>.
2133 *cpo-m*
2134 m When included, a showmatch will always wait half a
2135 second. When not included, a showmatch will wait half
2136 a second or until a character is typed. |'showmatch'|
2137 *cpo-M*
2138 M When excluded, "%" matching will take backslashes into
2139 account. Thus in "( \( )" and "\( ( \)" the outer
2140 parenthesis match. When included "%" ignores
2141 backslashes, which is Vi compatible.
2142 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002143 n When included, the column used for 'number' and
2144 'relativenumber' will also be used for text of wrapped
2145 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 *cpo-o*
2147 o Line offset to search command is not remembered for
2148 next search.
2149 *cpo-O*
2150 O Don't complain if a file is being overwritten, even
2151 when it didn't exist when editing it. This is a
2152 protection against a file unexpectedly created by
2153 someone else. Vi didn't complain about this.
2154 *cpo-p*
2155 p Vi compatible Lisp indenting. When not present, a
2156 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002157 *cpo-P*
2158 P When included, a ":write" command that appends to a
2159 file will set the file name for the current buffer, if
2160 the current buffer doesn't have a file name yet and
2161 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002162 *cpo-q*
2163 q When joining multiple lines leave the cursor at the
2164 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165 *cpo-r*
2166 r Redo ("." command) uses "/" to repeat a search
2167 command, instead of the actually used search string.
2168 *cpo-R*
2169 R Remove marks from filtered lines. Without this flag
2170 marks are kept like |:keepmarks| was used.
2171 *cpo-s*
2172 s Set buffer options when entering the buffer for the
2173 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002174 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175 set when the buffer is created.
2176 *cpo-S*
2177 S Set buffer options always when entering a buffer
2178 (except 'readonly', 'fileformat', 'filetype' and
2179 'syntax'). This is the (most) Vi compatible setting.
2180 The options are set to the values in the current
2181 buffer. When you change an option and go to another
2182 buffer, the value is copied. Effectively makes the
2183 buffer options global to all buffers.
2184
2185 's' 'S' copy buffer options
2186 no no when buffer created
2187 yes no when buffer first entered (default)
2188 X yes each time when buffer entered (vi comp.)
2189 *cpo-t*
2190 t Search pattern for the tag command is remembered for
2191 "n" command. Otherwise Vim only puts the pattern in
2192 the history for search pattern, but doesn't change the
2193 last used search pattern.
2194 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002195 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196 *cpo-v*
2197 v Backspaced characters remain visible on the screen in
2198 Insert mode. Without this flag the characters are
2199 erased from the screen right away. With this flag the
2200 screen newly typed text overwrites backspaced
2201 characters.
2202 *cpo-w*
2203 w When using "cw" on a blank character, only change one
2204 character and not all blanks until the start of the
2205 next word.
2206 *cpo-W*
2207 W Don't overwrite a readonly file. When omitted, ":w!"
2208 overwrites a readonly file, if possible.
2209 *cpo-x*
2210 x <Esc> on the command-line executes the command-line.
2211 The default in Vim is to abandon the command-line,
2212 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002213 *cpo-X*
2214 X When using a count with "R" the replaced text is
2215 deleted only once. Also when repeating "R" with "."
2216 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002218 y A yank command can be redone with ".". Think twice if
2219 you really want to use this, it may break some
2220 plugins, since most people expect "." to only repeat a
2221 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002222 *cpo-Z*
2223 Z When using "w!" while the 'readonly' option is set,
2224 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225 *cpo-!*
2226 ! When redoing a filter command, use the last used
2227 external command, whatever it was. Otherwise the last
2228 used -filter- command is used.
2229 *cpo-$*
2230 $ When making a change to one line, don't redisplay the
2231 line, but put a '$' at the end of the changed text.
2232 The changed text will be overwritten when you type the
2233 new text. The line is redisplayed if you type any
2234 command that moves the cursor from the insertion
2235 point.
2236 *cpo-%*
2237 % Vi-compatible matching is done for the "%" command.
2238 Does not recognize "#if", "#endif", etc.
2239 Does not recognize "/*" and "*/".
2240 Parens inside single and double quotes are also
2241 counted, causing a string that contains a paren to
2242 disturb the matching. For example, in a line like
2243 "if (strcmp("foo(", s))" the first paren does not
2244 match the last one. When this flag is not included,
2245 parens inside single and double quotes are treated
2246 specially. When matching a paren outside of quotes,
2247 everything inside quotes is ignored. When matching a
2248 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002249 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002250 This flag is also used for other features, such as
2251 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002252 *cpo--*
2253 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002254 it would go above the first line or below the last
2255 line. Without it the cursor moves to the first or
2256 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002257 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002258 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002259 *cpo-+*
2260 + When included, a ":write file" command will reset the
2261 'modified' flag of the buffer, even though the buffer
2262 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002263 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 * Use ":*" in the same way as ":@". When not included,
2265 ":*" is an alias for ":'<,'>", select the Visual area.
2266 *cpo-<*
2267 < Disable the recognition of special key codes in |<>|
2268 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002269 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 ":map X <Tab>" results in X being mapped to:
2271 '<' included: "<Tab>" (5 characters)
2272 '<' excluded: "^I" (^I is a real <Tab>)
2273 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002274 *cpo->*
2275 > When appending to a register, put a line break before
2276 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002277 *cpo-;*
2278 ; When using |,| or |;| to repeat the last |t| search
2279 and the cursor is right in front of the searched
2280 character, the cursor won't move. When not included,
2281 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002282 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002283
2284 POSIX flags. These are not included in the Vi default value, except
2285 when $VIM_POSIX was set on startup. |posix|
2286
2287 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002288 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002289 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002290 *cpo-&*
2291 & When ":preserve" was used keep the swap file when
2292 exiting normally while this buffer is still loaded.
2293 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002294 *cpo-\*
2295 \ Backslash in a [] range in a search pattern is taken
2296 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002297 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2298 '\' excluded: "/[ \-]" finds <Space> and '-'
2299 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002300 *cpo-/*
2301 / When "%" is used as the replacement string in a |:s|
2302 command, use the previous replacement string. |:s%|
2303 *cpo-{*
2304 { The |{| and |}| commands also stop at a "{" character
2305 at the start of a line.
2306 *cpo-.*
2307 . The ":chdir" and ":cd" commands fail if the current
2308 buffer is modified, unless ! is used. Vim doesn't
2309 need this, since it remembers the full path of an
2310 opened file.
2311 *cpo-bar*
2312 | The value of the $LINES and $COLUMNS environment
2313 variables overrule the terminal size values obtained
2314 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002315
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002317 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002318'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002319 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002320 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002321 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002322 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002323 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002324 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002325 blowfish Blowfish method. Medium strong encryption but it has
2326 an implementation flaw. Requires Vim 7.3 or later,
2327 files can NOT be read by Vim 7.2 and older. This adds
2328 a "seed" to the file, every time you write the file
2329 the encrypted bytes will be different.
2330 *blowfish2*
2331 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002332 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002333 and older. This adds a "seed" to the file, every time
2334 you write the file the encrypted bytes will be
2335 different. The whole undo file is encrypted, not just
2336 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002337
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002338 You should use "blowfish2", also to re-encrypt older files.
2339
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002340 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002341 to the detected method of the file being read. Thus if you write it
2342 without changing 'cryptmethod' the same method will be used.
2343 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002344 explicitly write it, you don't get a warning unless there are other
2345 modifications. Also see |:X|.
2346
2347 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002348 the value "blowfish2". When setting the local value to an empty
2349 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002350
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002351 When a new encryption method is added in a later version of Vim, and
2352 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002353 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002354
2355
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356 *'cscopepathcomp'* *'cspc'*
2357'cscopepathcomp' 'cspc' number (default 0)
2358 global
2359 {not available when compiled without the |+cscope|
2360 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361 Determines how many components of the path to show in a list of tags.
2362 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002363 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364
2365 *'cscopeprg'* *'csprg'*
2366'cscopeprg' 'csprg' string (default "cscope")
2367 global
2368 {not available when compiled without the |+cscope|
2369 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370 Specifies the command to execute cscope. See |cscopeprg|.
2371 This option cannot be set from a |modeline| or in the |sandbox|, for
2372 security reasons.
2373
2374 *'cscopequickfix'* *'csqf'*
2375'cscopequickfix' 'csqf' string (default "")
2376 global
2377 {not available when compiled without the |+cscope|
2378 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 Specifies whether to use quickfix window to show cscope results.
2380 See |cscopequickfix|.
2381
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002382 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002383'cscoperelative' 'csre' boolean (default off)
2384 global
2385 {not available when compiled without the |+cscope|
2386 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002387 In the absence of a prefix (-P) for cscope. setting this option enables
2388 to use the basename of cscope.out path as the prefix.
2389 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002390 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002391
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2393'cscopetag' 'cst' boolean (default off)
2394 global
2395 {not available when compiled without the |+cscope|
2396 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 Use cscope for tag commands. See |cscope-options|.
2398 NOTE: This option is reset when 'compatible' is set.
2399
2400 *'cscopetagorder'* *'csto'*
2401'cscopetagorder' 'csto' number (default 0)
2402 global
2403 {not available when compiled without the |+cscope|
2404 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405 Determines the order in which ":cstag" performs a search. See
2406 |cscopetagorder|.
2407 NOTE: This option is set to 0 when 'compatible' is set.
2408
2409 *'cscopeverbose'* *'csverb'*
2410 *'nocscopeverbose'* *'nocsverb'*
2411'cscopeverbose' 'csverb' boolean (default off)
2412 global
2413 {not available when compiled without the |+cscope|
2414 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415 Give messages when adding a cscope database. See |cscopeverbose|.
2416 NOTE: This option is reset when 'compatible' is set.
2417
Bram Moolenaar860cae12010-06-05 23:22:07 +02002418 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2419'cursorbind' 'crb' boolean (default off)
2420 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002421 When this option is set, as the cursor in the current
2422 window moves other cursorbound windows (windows that also have
2423 this option set) move their cursors to the corresponding line and
2424 column. This option is useful for viewing the
2425 differences between two versions of a file (see 'diff'); in diff mode,
2426 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002427 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002428
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002429
2430 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2431'cursorcolumn' 'cuc' boolean (default off)
2432 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002433 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002434 feature}
2435 Highlight the screen column of the cursor with CursorColumn
2436 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2437 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002438 If you only want the highlighting in the current window you can use
2439 these autocommands: >
2440 au WinLeave * set nocursorline nocursorcolumn
2441 au WinEnter * set cursorline cursorcolumn
2442<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002443
2444 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2445'cursorline' 'cul' boolean (default off)
2446 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002447 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002448 feature}
2449 Highlight the screen line of the cursor with CursorLine
2450 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2451 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002452 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002453 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002454
2455
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456 *'debug'*
2457'debug' string (default "")
2458 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002459 These values can be used:
2460 msg Error messages that would otherwise be omitted will be given
2461 anyway.
2462 throw Error messages that would otherwise be omitted will be given
2463 anyway and also throw an exception and set |v:errmsg|.
2464 beep A message will be given when otherwise only a beep would be
2465 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002466 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002467 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2468 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002469
2470 *'define'* *'def'*
2471'define' 'def' string (default "^\s*#\s*define")
2472 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002473 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474 pattern, just like for the "/" command. This option is used for the
2475 commands like "[i" and "[d" |include-search|. The 'isident' option is
2476 used to recognize the defined name after the match:
2477 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2478 See |option-backslash| about inserting backslashes to include a space
2479 or backslash.
2480 The default value is for C programs. For C++ this value would be
2481 useful, to include const type declarations: >
2482 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002483< You can also use "\ze" just before the name and continue the pattern
2484 to check what is following. E.g. for Javascript, if a function is
2485 defined with "func_name = function(args)": >
2486 ^\s*\ze\i\+\s*=\s*function(
2487< If the function is defined with "func_name : function() {...": >
2488 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002490 To avoid that use `:let` with a single quote string: >
2491 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002492<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493
2494 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2495'delcombine' 'deco' boolean (default off)
2496 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497 If editing Unicode and this option is set, backspace and Normal mode
2498 "x" delete each combining character on its own. When it is off (the
2499 default) the character along with its combining characters are
2500 deleted.
2501 Note: When 'delcombine' is set "xx" may work different from "2x"!
2502
2503 This is useful for Arabic, Hebrew and many other languages where one
2504 may have combining characters overtop of base characters, and want
2505 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002506 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507
2508 *'dictionary'* *'dict'*
2509'dictionary' 'dict' string (default "")
2510 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511 List of file names, separated by commas, that are used to lookup words
2512 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2513 contain a list of words. This can be one word per line, or several
2514 words per line, separated by non-keyword characters (white space is
2515 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002516
2517 When this option is empty or an entry "spell" is present, and spell
2518 checking is enabled, words in the word lists for the currently active
2519 'spelllang' are used. See |spell|.
2520
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002521 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 after a comma are ignored, otherwise spaces are included in the file
2523 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002524 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 Where to find a list of words?
2526 - On FreeBSD, there is the file "/usr/share/dict/words".
2527 - In the Simtel archive, look in the "msdos/linguist" directory.
2528 - In "miscfiles" of the GNU collection.
2529 The use of |:set+=| and |:set-=| is preferred when adding or removing
2530 directories from the list. This avoids problems when a future version
2531 uses another default.
2532 Backticks cannot be used in this option for security reasons.
2533
2534 *'diff'* *'nodiff'*
2535'diff' boolean (default off)
2536 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002537 {not available when compiled without the |+diff|
2538 feature}
2539 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002540 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002541
2542 *'dex'* *'diffexpr'*
2543'diffexpr' 'dex' string (default "")
2544 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545 {not available when compiled without the |+diff|
2546 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002547 Expression which is evaluated to obtain a diff file (either ed-style
2548 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 This option cannot be set from a |modeline| or in the |sandbox|, for
2550 security reasons.
2551
2552 *'dip'* *'diffopt'*
Bram Moolenaarc93262b2018-09-10 21:15:40 +02002553'diffopt' 'dip' string (default "internal,filler")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002554 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555 {not available when compiled without the |+diff|
2556 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002557 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558 All are optional. Items must be separated by a comma.
2559
2560 filler Show filler lines, to keep the text
2561 synchronized with a window that has inserted
2562 lines at the same position. Mostly useful
2563 when windows are side-by-side and 'scrollbind'
2564 is set.
2565
2566 context:{n} Use a context of {n} lines between a change
2567 and a fold that contains unchanged lines.
2568 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002569 When using zero the context is actually one,
2570 since folds require a line in between, also
2571 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572 See |fold-diff|.
2573
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002574 iblank Ignore changes where lines are all blank. Adds
2575 the "-B" flag to the "diff" command if
2576 'diffexpr' is empty. Check the documentation
2577 of the "diff" command for what this does
2578 exactly.
2579 NOTE: the diff windows will get out of sync,
2580 because no differences between blank lines are
2581 taken into account.
2582
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 icase Ignore changes in case of text. "a" and "A"
2584 are considered the same. Adds the "-i" flag
2585 to the "diff" command if 'diffexpr' is empty.
2586
2587 iwhite Ignore changes in amount of white space. Adds
2588 the "-b" flag to the "diff" command if
2589 'diffexpr' is empty. Check the documentation
2590 of the "diff" command for what this does
2591 exactly. It should ignore adding trailing
2592 white space, but not leading white space.
2593
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002594 iwhiteall Ignore all white space changes. Adds
2595 the "-w" flag to the "diff" command if
2596 'diffexpr' is empty. Check the documentation
2597 of the "diff" command for what this does
2598 exactly.
2599
2600 iwhiteeol Ignore white space changes at end of line.
2601 Adds the "-Z" flag to the "diff" command if
2602 'diffexpr' is empty. Check the documentation
2603 of the "diff" command for what this does
2604 exactly.
2605
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002606 horizontal Start diff mode with horizontal splits (unless
2607 explicitly specified otherwise).
2608
2609 vertical Start diff mode with vertical splits (unless
2610 explicitly specified otherwise).
2611
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002612 hiddenoff Do not use diff mode for a buffer when it
2613 becomes hidden.
2614
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002615 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2616 starting diff mode. Without this 2 is used.
2617
Bram Moolenaare828b762018-09-10 17:51:58 +02002618 internal Use the internal diff library. This is
2619 ignored when 'diffexpr' is set. *E960*
2620 When running out of memory when writing a
2621 buffer this item will be ignored for diffs
2622 involving that buffer. Set the 'verbose'
2623 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624
Bram Moolenaare828b762018-09-10 17:51:58 +02002625 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002626 Use the indent heuristic for the internal
2627 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002628
2629 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002630 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002631 algorithms are:
2632 myers the default algorithm
2633 minimal spend extra time to generate the
2634 smallest possible diff
2635 patience patience diff algorithm
2636 histogram histogram diff algorithm
2637
2638 Examples: >
2639 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002641 :set diffopt=internal,filler,foldcolumn:3
2642 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643<
2644 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2645'digraph' 'dg' boolean (default off)
2646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002647 {not available when compiled without the |+digraphs|
2648 feature}
2649 Enable the entering of digraphs in Insert mode with {char1} <BS>
2650 {char2}. See |digraphs|.
2651 NOTE: This option is reset when 'compatible' is set.
2652
2653 *'directory'* *'dir'*
2654'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002655 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 for Unix: ".,~/tmp,/var/tmp,/tmp")
2657 global
2658 List of directory names for the swap file, separated with commas.
2659 - The swap file will be created in the first directory where this is
2660 possible.
2661 - Empty means that no swap file will be used (recovery is
2662 impossible!).
2663 - A directory "." means to put the swap file in the same directory as
2664 the edited file. On Unix, a dot is prepended to the file name, so
2665 it doesn't show in a directory listing. On MS-Windows the "hidden"
2666 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002667 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668 put the swap file relative to where the edited file is. The leading
2669 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002670 - For Unix and Win32, if a directory ends in two path separators "//",
2671 the swap file name will be built from the complete path to the file
2672 with all path separators substituted to percent '%' signs. This will
2673 ensure file name uniqueness in the preserve directory.
2674 On Win32, it is also possible to end with "\\". However, When a
2675 separating comma is following, you must use "//", since "\\" will
2676 include the comma in the file name. Therefore it is recommended to
2677 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 - Spaces after the comma are ignored, other spaces are considered part
2679 of the directory name. To have a space at the start of a directory
2680 name, precede it with a backslash.
2681 - To include a comma in a directory name precede it with a backslash.
2682 - A directory name may end in an ':' or '/'.
2683 - Environment variables are expanded |:set_env|.
2684 - Careful with '\' characters, type one before a space, type two to
2685 get one in the option (see |option-backslash|), for example: >
2686 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2687< - For backwards compatibility with Vim version 3.0 a '>' at the start
2688 of the option is removed.
2689 Using "." first in the list is recommended. This means that editing
2690 the same file twice will result in a warning. Using "/tmp" on Unix is
2691 discouraged: When the system crashes you lose the swap file.
2692 "/var/tmp" is often not cleared when rebooting, thus is a better
2693 choice than "/tmp". But it can contain a lot of files, your swap
2694 files get lost in the crowd. That is why a "tmp" directory in your
2695 home directory is tried first.
2696 The use of |:set+=| and |:set-=| is preferred when adding or removing
2697 directories from the list. This avoids problems when a future version
2698 uses another default.
2699 This option cannot be set from a |modeline| or in the |sandbox|, for
2700 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701
2702 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002703'display' 'dy' string (default "", set to "truncate" in
2704 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706 Change the way text is displayed. This is comma separated list of
2707 flags:
2708 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002709 in a window will be displayed. "@@@" is put in the
2710 last columns of the last screen line to indicate the
2711 rest of the line is not displayed.
2712 truncate Like "lastline", but "@@@" is displayed in the first
2713 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 uhex Show unprintable characters hexadecimal as <xx>
2715 instead of using ^C and ~C.
2716
Bram Moolenaard0796902016-09-16 20:02:31 +02002717 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002718 doesn't fit is replaced with "@" lines.
2719
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720 *'eadirection'* *'ead'*
2721'eadirection' 'ead' string (default "both")
2722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 Tells when the 'equalalways' option applies:
2724 ver vertically, width of windows is not affected
2725 hor horizontally, height of windows is not affected
2726 both width and height of windows is affected
2727
2728 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2729'edcompatible' 'ed' boolean (default off)
2730 global
2731 Makes the 'g' and 'c' flags of the ":substitute" command to be
2732 toggled each time the flag is given. See |complex-change|. See
2733 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002734 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735
Bram Moolenaar03413f42016-04-12 21:07:15 +02002736 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002737'emoji' 'emo' boolean (default: on)
2738 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002739 When on all Unicode emoji characters are considered to be full width.
2740
2741
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 *'encoding'* *'enc'* *E543*
2743'encoding' 'enc' string (default: "latin1" or value from $LANG)
2744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 Sets the character encoding used inside Vim. It applies to text in
2746 the buffers, registers, Strings in expressions, text stored in the
2747 viminfo file, etc. It sets the kind of characters which Vim can work
2748 with. See |encoding-names| for the possible values.
2749
2750 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002751 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002753 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754
Bram Moolenaar865242e2010-07-14 21:12:05 +02002755 This option cannot be set from a |modeline|. It would most likely
2756 corrupt the text.
2757
Bram Moolenaar3df01732017-02-17 22:47:16 +01002758 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2759 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760 'encoding', "utf-8" is the natural choice for the environment and
2761 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002762 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 versions, and to avoid changing the encoding of newly created files
2764 without your knowledge (in case 'fileencodings' is empty).
2765
2766 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002767 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 iconv() or as specified with 'charconvert'.
2769
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002770 If you need to know whether 'encoding' is a multi-byte encoding, you
2771 can use: >
2772 if has("multi_byte_encoding")
2773<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 Normally 'encoding' will be equal to your current locale. This will
2775 be the default if Vim recognizes your environment settings. If
2776 'encoding' is not set to the current locale, 'termencoding' must be
2777 set to convert typed and displayed text. See |encoding-table|.
2778
2779 When you set this option, it fires the |EncodingChanged| autocommand
2780 event so that you can set up fonts if necessary.
2781
2782 When the option is set, the value is converted to lowercase. Thus
2783 you can set it with uppercase values too. Underscores are translated
2784 to '-' signs.
2785 When the encoding is recognized, it is changed to the standard name.
2786 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2787 "iso-8859-2" and "utf8" becomes "utf-8".
2788
2789 Note: "latin1" is also used when the encoding could not be detected.
2790 This only works when editing files in the same encoding! When the
2791 actual character set is not latin1, make sure 'fileencoding' and
2792 'fileencodings' are empty. When conversion is needed, switch to using
2793 utf-8.
2794
2795 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2796 You don't notice this while editing, but it does matter for the
2797 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2798 setting 'encoding' to one of these values instead of utf-8 only has
2799 effect for encoding used for files when 'fileencoding' is empty.
2800
Bram Moolenaar661b1822005-07-28 22:36:45 +00002801 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2802 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002803
2804 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2805'endofline' 'eol' boolean (default on)
2806 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002808 is on, or 'fixeol' option is off, no <EOL> will be written for the
2809 last line in the file. This option is automatically set or reset when
2810 starting to edit a new file, depending on whether file has an <EOL>
2811 for the last line in the file. Normally you don't have to set or
2812 reset this option.
2813 When 'binary' is off and 'fixeol' is on the value is not used when
2814 writing the file. When 'binary' is on or 'fixeol' is off it is used
2815 to remember the presence of a <EOL> for the last line in the file, so
2816 that when you write the file the situation from the original file can
2817 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818
2819 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2820'equalalways' 'ea' boolean (default on)
2821 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002823 splitting or closing a window. This also happens the moment the
2824 option is switched on. When off, splitting a window will reduce the
2825 size of the current window and leave the other windows the same. When
2826 closing a window the extra lines are given to the window next to it
2827 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 When mixing vertically and horizontally split windows, a minimal size
2829 is computed and some windows may be larger if there is room. The
2830 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002831 Changing the height and width of a window can be avoided by setting
2832 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002833 If a window size is specified when creating a new window sizes are
2834 currently not equalized (it's complicated, but may be implemented in
2835 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836
2837 *'equalprg'* *'ep'*
2838'equalprg' 'ep' string (default "")
2839 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002841 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002842 or 'indentexpr'. When Vim was compiled without internal formatting,
2843 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002844 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845 about including spaces and backslashes.
2846 This option cannot be set from a |modeline| or in the |sandbox|, for
2847 security reasons.
2848
2849 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2850'errorbells' 'eb' boolean (default off)
2851 global
2852 Ring the bell (beep or screen flash) for error messages. This only
2853 makes a difference for error messages, the bell will be used always
2854 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002855 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002856 screen flash or do nothing. See 'belloff' to finetune when to ring the
2857 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858
2859 *'errorfile'* *'ef'*
2860'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2861 others: "errors.err")
2862 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002863 {not available when compiled without the |+quickfix|
2864 feature}
2865 Name of the errorfile for the QuickFix mode (see |:cf|).
2866 When the "-q" command-line argument is used, 'errorfile' is set to the
2867 following argument. See |-q|.
2868 NOT used for the ":make" command. See 'makeef' for that.
2869 Environment variables are expanded |:set_env|.
2870 See |option-backslash| about including spaces and backslashes.
2871 This option cannot be set from a |modeline| or in the |sandbox|, for
2872 security reasons.
2873
2874 *'errorformat'* *'efm'*
2875'errorformat' 'efm' string (default is very long)
2876 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 {not available when compiled without the |+quickfix|
2878 feature}
2879 Scanf-like description of the format for the lines in the error file
2880 (see |errorformat|).
2881
2882 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2883'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2884 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 Function keys that start with an <Esc> are recognized in Insert
2886 mode. When this option is off, the cursor and function keys cannot be
2887 used in Insert mode if they start with an <Esc>. The advantage of
2888 this is that the single <Esc> is recognized immediately, instead of
2889 after one second. Instead of resetting this option, you might want to
2890 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2891 when 'esckeys' is off, you can still map anything, but the cursor keys
2892 won't work by default.
2893 NOTE: This option is set to the Vi default value when 'compatible' is
2894 set and to the Vim default value when 'compatible' is reset.
2895
2896 *'eventignore'* *'ei'*
2897'eventignore' 'ei' string (default "")
2898 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002900 When set to "all" or when "all" is one of the items, all autocommand
2901 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 Otherwise this is a comma separated list of event names. Example: >
2903 :set ei=WinEnter,WinLeave
2904<
2905 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2906'expandtab' 'et' boolean (default off)
2907 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002909 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2911 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002912 This option is reset when the 'paste' option is set and restored when
2913 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 NOTE: This option is reset when 'compatible' is set.
2915
2916 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2917'exrc' 'ex' boolean (default off)
2918 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002920 directory.
2921
2922 Setting this option is a potential security leak. E.g., consider
2923 unpacking a package or fetching files from github, a .vimrc in there
2924 might be a trojan horse. BETTER NOT SET THIS OPTION!
2925 Instead, define an autocommand in your .vimrc to set options for a
2926 matching directory.
2927
2928 If you do switch this option on you should also consider setting the
2929 'secure' option (see |initialization|).
2930 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 This option cannot be set from a |modeline| or in the |sandbox|, for
2932 security reasons.
2933
2934 *'fileencoding'* *'fenc'* *E213*
2935'fileencoding' 'fenc' string (default: "")
2936 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002938
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002940 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 When 'fileencoding' is empty, the same value as 'encoding' will be
2942 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002943 No error will be given when the value is set, only when it is used,
2944 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002945 Conversion will also be done when 'encoding' and 'fileencoding' are
2946 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2947 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002949 'encoding' is "utf-8" or another Unicode encoding, conversion
2950 is most likely done in a way that the reverse conversion
2951 results in the same text. When 'encoding' is not "utf-8" some
2952 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002953
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 See 'encoding' for the possible values. Additionally, values may be
2955 specified that can be handled by the converter, see
2956 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002957
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 When reading a file 'fileencoding' will be set from 'fileencodings'.
2959 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002960 'fileencoding', use the |++enc| argument. One exception: when
2961 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002962 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002963
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2965 When the option is set, the value is converted to lowercase. Thus
2966 you can set it with uppercase values too. '_' characters are
2967 replaced with '-'. If a name is recognized from the list for
2968 'encoding', it is replaced by the standard name. For example
2969 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002970
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 When this option is set, after starting to edit a file, the 'modified'
2972 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002973
2974 Keep in mind that changing 'fenc' from a modeline happens
2975 AFTER the text has been read, thus it applies to when the file will be
2976 written. If you do set 'fenc' in a modeline, you might want to set
2977 'nomodified' to avoid not being able to ":q".
2978
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 This option can not be changed when 'modifiable' is off.
2980
2981 *'fe'*
2982 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002983 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 old short name was 'fe', which is no longer used.
2985
2986 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002987'fileencodings' 'fencs' string (default: "ucs-bom",
2988 "ucs-bom,utf-8,default,latin1" when
2989 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 This is a list of character encodings considered when starting to edit
2992 an existing file. When a file is read, Vim tries to use the first
2993 mentioned character encoding. If an error is detected, the next one
2994 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002995 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 an empty string, which means the value of 'encoding' is used.
2997 WARNING: Conversion can cause loss of information! When
2998 'encoding' is "utf-8" (or one of the other Unicode variants)
2999 conversion is most likely done in a way that the reverse
3000 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003001 "utf-8" some non-ASCII characters may be lost! You can use
3002 the |++bad| argument to specify what is done with characters
3003 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 For an empty file or a file with only ASCII characters most encodings
3005 will work and the first entry of 'fileencodings' will be used (except
3006 "ucs-bom", which requires the BOM to be present). If you prefer
3007 another encoding use an BufReadPost autocommand event to test if your
3008 preferred encoding is to be used. Example: >
3009 au BufReadPost * if search('\S', 'w') == 0 |
3010 \ set fenc=iso-2022-jp | endif
3011< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3012 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003013 When the |++enc| argument is used then the value of 'fileencodings' is
3014 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003015 Note that 'fileencodings' is not used for a new file, the global value
3016 of 'fileencoding' is used instead. You can set it with: >
3017 :setglobal fenc=iso-8859-2
3018< This means that a non-existing file may get a different encoding than
3019 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 The special value "ucs-bom" can be used to check for a Unicode BOM
3021 (Byte Order Mark) at the start of the file. It must not be preceded
3022 by "utf-8" or another Unicode encoding for this to work properly.
3023 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3024 because Vim cannot detect an error, thus the encoding is always
3025 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003026 The special value "default" can be used for the encoding from the
3027 environment. This is the default value for 'encoding'. It is useful
3028 when 'encoding' is set to "utf-8" and your environment uses a
3029 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003030 When 'encoding' is "utf-8" and a file contains an illegal byte
3031 sequence it won't be recognized as UTF-8. You can use the |8g8|
3032 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 WRONG VALUES: WHAT'S WRONG:
3034 latin1,utf-8 "latin1" will always be used
3035 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3036 file
3037 cp1250,latin1 "cp1250" will always be used
3038 If 'fileencodings' is empty, 'fileencoding' is not modified.
3039 See 'fileencoding' for the possible values.
3040 Setting this option does not have an effect until the next time a file
3041 is read.
3042
3043 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003044'fileformat' 'ff' string (MS-Windows default: "dos",
3045 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 This gives the <EOL> of the current buffer, which is used for
3048 reading/writing the buffer from/to a file:
3049 dos <CR> <NL>
3050 unix <NL>
3051 mac <CR>
3052 When "dos" is used, CTRL-Z at the end of a file is ignored.
3053 See |file-formats| and |file-read|.
3054 For the character encoding of the file see 'fileencoding'.
3055 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003056 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 This option is set automatically when starting to edit a file and
3058 'fileformats' is not empty and 'binary' is off.
3059 When this option is set, after starting to edit a file, the 'modified'
3060 option is set, because the file would be different when written.
3061 This option can not be changed when 'modifiable' is off.
3062 For backwards compatibility: When this option is set to "dos",
3063 'textmode' is set, otherwise 'textmode' is reset.
3064
3065 *'fileformats'* *'ffs'*
3066'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003067 Vim+Vi MS-Windows: "dos,unix",
3068 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069 Vi Cygwin: "unix,dos",
3070 Vi others: "")
3071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 This gives the end-of-line (<EOL>) formats that will be tried when
3073 starting to edit a new buffer and when reading a file into an existing
3074 buffer:
3075 - When empty, the format defined with 'fileformat' will be used
3076 always. It is not set automatically.
3077 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003078 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 'fileformats' name will be used when a file is read into an existing
3080 buffer, no matter what 'fileformat' for that buffer is set to.
3081 - When more than one name is present, separated by commas, automatic
3082 <EOL> detection will be done when reading a file. When starting to
3083 edit a file, a check is done for the <EOL>:
3084 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3085 'fileformat' is set to "dos".
3086 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003087 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003089 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3090 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003091 This means that "mac" is only chosen when:
3092 "unix" is not present or no <NL> is found in the file, and
3093 "dos" is not present or no <CR><NL> is found in the file.
3094 Except: if "unix" was chosen, but there is a <CR> before
3095 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003096 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 4. If 'fileformat' is still not set, the first name from
3098 'fileformats' is used.
3099 When reading a file into an existing buffer, the same is done, but
3100 this happens like 'fileformat' has been set appropriately for that
3101 file only, the option is not changed.
3102 When 'binary' is set, the value of 'fileformats' is not used.
3103
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003104 When Vim starts up with an empty buffer the first item is used. You
3105 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003106
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3108 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3109 done:
3110 - When 'fileformats' is empty, there is no automatic detection. Dos
3111 format will be used.
3112 - When 'fileformats' is set to one or more names, automatic detection
3113 is done. This is based on the first <NL> in the file: If there is a
3114 <CR> in front of it, Dos format is used, otherwise Unix format is
3115 used.
3116 Also see |file-formats|.
3117 For backwards compatibility: When this option is set to an empty
3118 string or one format (no comma is included), 'textauto' is reset,
3119 otherwise 'textauto' is set.
3120 NOTE: This option is set to the Vi default value when 'compatible' is
3121 set and to the Vim default value when 'compatible' is reset.
3122
Bram Moolenaarbf884932013-04-05 22:26:15 +02003123 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3124'fileignorecase' 'fic' boolean (default on for systems where case in file
3125 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003126 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003127 When set case is ignored when using file names and directories.
3128 See 'wildignorecase' for only ignoring case when doing completion.
3129
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 *'filetype'* *'ft'*
3131'filetype' 'ft' string (default: "")
3132 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 When this option is set, the FileType autocommand event is triggered.
3134 All autocommands that match with the value of this option will be
3135 executed. Thus the value of 'filetype' is used in place of the file
3136 name.
3137 Otherwise this option does not always reflect the current file type.
3138 This option is normally set when the file type is detected. To enable
3139 this use the ":filetype on" command. |:filetype|
3140 Setting this option to a different value is most useful in a modeline,
3141 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003142 Example, for in an IDL file:
3143 /* vim: set filetype=idl : */ ~
3144 |FileType| |filetypes|
3145 When a dot appears in the value then this separates two filetype
3146 names. Example:
3147 /* vim: set filetype=c.doxygen : */ ~
3148 This will use the "c" filetype first, then the "doxygen" filetype.
3149 This works both for filetype plugins and for syntax files. More than
3150 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 This option is not copied to another buffer, independent of the 's' or
3152 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003153 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154
3155 *'fillchars'* *'fcs'*
3156'fillchars' 'fcs' string (default "vert:|,fold:-")
3157 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 {not available when compiled without the |+windows|
3159 and |+folding| features}
3160 Characters to fill the statuslines and vertical separators.
3161 It is a comma separated list of items:
3162
3163 item default Used for ~
3164 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003165 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166 vert:c '|' vertical separators |:vsplit|
3167 fold:c '-' filling 'foldtext'
3168 diff:c '-' deleted lines of the 'diff' option
3169
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003170 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003171 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 otherwise.
3173
3174 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003175 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176< This is similar to the default, except that these characters will also
3177 be used when there is highlighting.
3178
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003179 for "stl" and "stlnc" only single-byte values are supported.
3180
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 The highlighting used for these items:
3182 item highlight group ~
3183 stl:c StatusLine |hl-StatusLine|
3184 stlnc:c StatusLineNC |hl-StatusLineNC|
3185 vert:c VertSplit |hl-VertSplit|
3186 fold:c Folded |hl-Folded|
3187 diff:c DiffDelete |hl-DiffDelete|
3188
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003189 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3190'fixendofline' 'fixeol' boolean (default on)
3191 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003192 When writing a file and this option is on, <EOL> at the end of file
3193 will be restored if missing. Turn this option off if you want to
3194 preserve the situation from the original file.
3195 When the 'binary' option is set the value of this option doesn't
3196 matter.
3197 See the 'endofline' option.
3198
Bram Moolenaar071d4272004-06-13 20:20:40 +00003199 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3200'fkmap' 'fk' boolean (default off) *E198*
3201 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 {only available when compiled with the |+rightleft|
3203 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003204 This option was for using Farsi, which has been removed. See
3205 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206
3207 *'foldclose'* *'fcl'*
3208'foldclose' 'fcl' string (default "")
3209 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 {not available when compiled without the |+folding|
3211 feature}
3212 When set to "all", a fold is closed when the cursor isn't in it and
3213 its level is higher than 'foldlevel'. Useful if you want folds to
3214 automatically close when moving out of them.
3215
3216 *'foldcolumn'* *'fdc'*
3217'foldcolumn' 'fdc' number (default 0)
3218 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 {not available when compiled without the |+folding|
3220 feature}
3221 When non-zero, a column with the specified width is shown at the side
3222 of the window which indicates open and closed folds. The maximum
3223 value is 12.
3224 See |folding|.
3225
3226 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3227'foldenable' 'fen' boolean (default on)
3228 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 {not available when compiled without the |+folding|
3230 feature}
3231 When off, all folds are open. This option can be used to quickly
3232 switch between showing all text unfolded and viewing the text with
3233 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003234 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 'foldenable' is off.
3236 This option is set by commands that create a new fold or close a fold.
3237 See |folding|.
3238
3239 *'foldexpr'* *'fde'*
3240'foldexpr' 'fde' string (default: "0")
3241 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003243 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003245 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003246
Bram Moolenaar30b65812012-07-12 22:01:11 +02003247 The expression will be evaluated in the |sandbox| if set from a
3248 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003249 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003250 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003251
3252 It is not allowed to change text or jump to another window while
3253 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254
3255 *'foldignore'* *'fdi'*
3256'foldignore' 'fdi' string (default: "#")
3257 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 {not available when compiled without the |+folding|
3259 feature}
3260 Used only when 'foldmethod' is "indent". Lines starting with
3261 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003262 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 The default "#" works well for C programs. See |fold-indent|.
3264
3265 *'foldlevel'* *'fdl'*
3266'foldlevel' 'fdl' number (default: 0)
3267 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 {not available when compiled without the |+folding|
3269 feature}
3270 Sets the fold level: Folds with a higher level will be closed.
3271 Setting this option to zero will close all folds. Higher numbers will
3272 close fewer folds.
3273 This option is set by commands like |zm|, |zM| and |zR|.
3274 See |fold-foldlevel|.
3275
3276 *'foldlevelstart'* *'fdls'*
3277'foldlevelstart' 'fdls' number (default: -1)
3278 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 {not available when compiled without the |+folding|
3280 feature}
3281 Sets 'foldlevel' when starting to edit another buffer in a window.
3282 Useful to always start editing with all folds closed (value zero),
3283 some folds closed (one) or no folds closed (99).
3284 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003285 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 ignores this option and closes all folds.
3287 It is also done before BufReadPre autocommands, to allow an autocmd to
3288 overrule the 'foldlevel' value for specific files.
3289 When the value is negative, it is not used.
3290
3291 *'foldmarker'* *'fmr'* *E536*
3292'foldmarker' 'fmr' string (default: "{{{,}}}")
3293 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 {not available when compiled without the |+folding|
3295 feature}
3296 The start and end marker used when 'foldmethod' is "marker". There
3297 must be one comma, which separates the start and end marker. The
3298 marker is a literal string (a regular expression would be too slow).
3299 See |fold-marker|.
3300
3301 *'foldmethod'* *'fdm'*
3302'foldmethod' 'fdm' string (default: "manual")
3303 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304 {not available when compiled without the |+folding|
3305 feature}
3306 The kind of folding used for the current window. Possible values:
3307 |fold-manual| manual Folds are created manually.
3308 |fold-indent| indent Lines with equal indent form a fold.
3309 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3310 |fold-marker| marker Markers are used to specify folds.
3311 |fold-syntax| syntax Syntax highlighting items specify folds.
3312 |fold-diff| diff Fold text that is not changed.
3313
3314 *'foldminlines'* *'fml'*
3315'foldminlines' 'fml' number (default: 1)
3316 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 {not available when compiled without the |+folding|
3318 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003319 Sets the number of screen lines above which a fold can be displayed
3320 closed. Also for manually closed folds. With the default value of
3321 one a fold can only be closed if it takes up two or more screen lines.
3322 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003323 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 "zc" to close a fold, which is displayed open because it's smaller
3325 than 'foldminlines', a following "zc" may close a containing fold.
3326
3327 *'foldnestmax'* *'fdn'*
3328'foldnestmax' 'fdn' number (default: 20)
3329 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 {not available when compiled without the |+folding|
3331 feature}
3332 Sets the maximum nesting of folds for the "indent" and "syntax"
3333 methods. This avoids that too many folds will be created. Using more
3334 than 20 doesn't work, because the internal limit is 20.
3335
3336 *'foldopen'* *'fdo'*
3337'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3338 search,tag,undo")
3339 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 {not available when compiled without the |+folding|
3341 feature}
3342 Specifies for which type of commands folds will be opened, if the
3343 command moves the cursor into a closed fold. It is a comma separated
3344 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003345 NOTE: When the command is part of a mapping this option is not used.
3346 Add the |zv| command to the mapping to get the same effect.
3347 (rationale: the mapping may want to control opening folds itself)
3348
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 item commands ~
3350 all any
3351 block "(", "{", "[[", "[{", etc.
3352 hor horizontal movements: "l", "w", "fx", etc.
3353 insert any command in Insert mode
3354 jump far jumps: "G", "gg", etc.
3355 mark jumping to a mark: "'m", CTRL-O, etc.
3356 percent "%"
3357 quickfix ":cn", ":crew", ":make", etc.
3358 search search for a pattern: "/", "n", "*", "gd", etc.
3359 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003360 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 tag jumping to a tag: ":ta", CTRL-T, etc.
3362 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 When a movement command is used for an operator (e.g., "dl" or "y%")
3364 this option is not used. This means the operator will include the
3365 whole closed fold.
3366 Note that vertical movements are not here, because it would make it
3367 very difficult to move onto a closed fold.
3368 In insert mode the folds containing the cursor will always be open
3369 when text is inserted.
3370 To close folds you can re-apply 'foldlevel' with the |zx| command or
3371 set the 'foldclose' option to "all".
3372
3373 *'foldtext'* *'fdt'*
3374'foldtext' 'fdt' string (default: "foldtext()")
3375 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 {not available when compiled without the |+folding|
3377 feature}
3378 An expression which is used to specify the text displayed for a closed
3379 fold. See |fold-foldtext|.
3380
Bram Moolenaar30b65812012-07-12 22:01:11 +02003381 The expression will be evaluated in the |sandbox| if set from a
3382 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003383 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003384
3385 It is not allowed to change text or jump to another window while
3386 evaluating 'foldtext' |textlock|.
3387
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003388 *'formatexpr'* *'fex'*
3389'formatexpr' 'fex' string (default "")
3390 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003391 {not available when compiled without the |+eval|
3392 feature}
3393 Expression which is evaluated to format a range of lines for the |gq|
3394 operator or automatic formatting (see 'formatoptions'). When this
3395 option is empty 'formatprg' is used.
3396
3397 The |v:lnum| variable holds the first line to be formatted.
3398 The |v:count| variable holds the number of lines to be formatted.
3399 The |v:char| variable holds the character that is going to be
3400 inserted if the expression is being evaluated due to
3401 automatic formatting. This can be empty. Don't insert
3402 it yet!
3403
3404 Example: >
3405 :set formatexpr=mylang#Format()
3406< This will invoke the mylang#Format() function in the
3407 autoload/mylang.vim file in 'runtimepath'. |autoload|
3408
3409 The expression is also evaluated when 'textwidth' is set and adding
3410 text beyond that limit. This happens under the same conditions as
3411 when internal formatting is used. Make sure the cursor is kept in the
3412 same spot relative to the text then! The |mode()| function will
3413 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003414
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003415 When the expression evaluates to non-zero Vim will fall back to using
3416 the internal format mechanism.
3417
3418 The expression will be evaluated in the |sandbox| when set from a
3419 modeline, see |sandbox-option|. That stops the option from working,
3420 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003421 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003422 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003423
Bram Moolenaar86b68352004-12-27 21:59:20 +00003424 *'formatlistpat'* *'flp'*
3425'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3426 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003427 A pattern that is used to recognize a list header. This is used for
3428 the "n" flag in 'formatoptions'.
3429 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003430 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003431 while still checking more characters. There must be a character
3432 following the pattern, when it matches the whole line it is handled
3433 like there is no match.
3434 The default recognizes a number, followed by an optional punctuation
3435 character and white space.
3436
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003437 *'formatoptions'* *'fo'*
3438'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3439 local to buffer
3440 This is a sequence of letters which describes how automatic
3441 formatting is to be done. See |fo-table|. When the 'paste' option is
3442 on, no formatting is done (like 'formatoptions' is empty). Commas can
3443 be inserted for readability.
3444 To avoid problems with flags that are added in the future, use the
3445 "+=" and "-=" feature of ":set" |add-option-flags|.
3446 NOTE: This option is set to the Vi default value when 'compatible' is
3447 set and to the Vim default value when 'compatible' is reset.
3448
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 *'formatprg'* *'fp'*
3450'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003451 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003453 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003455 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003456 If the 'formatexpr' option is not empty it will be used instead.
3457 Otherwise, if 'formatprg' option is an empty string, the internal
3458 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003459 Environment variables are expanded |:set_env|. See |option-backslash|
3460 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003461 This option cannot be set from a |modeline| or in the |sandbox|, for
3462 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463
Bram Moolenaard94464e2015-11-02 15:28:18 +01003464 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003465'fsync' 'fs' boolean (default on)
3466 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003467 When on, the library function fsync() will be called after writing a
3468 file. This will flush a file to disk, ensuring that it is safely
3469 written even on filesystems which do metadata-only journaling. This
3470 will force the harddrive to spin up on Linux systems running in laptop
3471 mode, so it may be undesirable in some situations. Be warned that
3472 turning this off increases the chances of data loss after a crash. On
3473 systems without an fsync() implementation, this variable is always
3474 off.
3475 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003476 'fsync' also applies to |writefile()|, unless a flag is used to
3477 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003478 This option cannot be set from a |modeline| or in the |sandbox|, for
3479 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003480
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3482'gdefault' 'gd' boolean (default off)
3483 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 When on, the ":substitute" flag 'g' is default on. This means that
3485 all matches in a line are substituted instead of one. When a 'g' flag
3486 is given to a ":substitute" command, this will toggle the substitution
3487 of all or one match. See |complex-change|.
3488
3489 command 'gdefault' on 'gdefault' off ~
3490 :s/// subst. all subst. one
3491 :s///g subst. one subst. all
3492 :s///gg subst. all subst. one
3493
3494 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003495 DEPRECATED: Setting this option may break plugins that are not aware
3496 of this option. Also, many users get confused that adding the /g flag
3497 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498
3499 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003500'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 Format to recognize for the ":grep" command output.
3503 This is a scanf-like string that uses the same format as the
3504 'errorformat' option: see |errorformat|.
3505
3506 *'grepprg'* *'gp'*
3507'grepprg' 'gp' string (default "grep -n ",
3508 Unix: "grep -n $* /dev/null",
3509 Win32: "findstr /n" or "grep -n",
3510 VMS: "SEARCH/NUMBERS ")
3511 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003512 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 and '#' characters, which are expanded like when used in a command-
3514 line. The placeholder "$*" is allowed to specify where the arguments
3515 will be included. Environment variables are expanded |:set_env|. See
3516 |option-backslash| about including spaces and backslashes.
3517 When your "grep" accepts the "-H" argument, use this to make ":grep"
3518 also work well with a single file: >
3519 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003520< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003521 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3522 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003523 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524 apply equally to 'grepprg'.
3525 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3526 otherwise it's "grep -n".
3527 This option cannot be set from a |modeline| or in the |sandbox|, for
3528 security reasons.
3529
3530 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3531'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3532 ve:ver35-Cursor,
3533 o:hor50-Cursor,
3534 i-ci:ver25-Cursor/lCursor,
3535 r-cr:hor20-Cursor/lCursor,
3536 sm:block-Cursor
3537 -blinkwait175-blinkoff150-blinkon175",
3538 for MS-DOS and Win32 console:
3539 "n-v-c:block,o:hor50,i-ci:hor15,
3540 r-cr:hor30,sm:block")
3541 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 {only available when compiled with GUI enabled, and
3543 for MS-DOS and Win32 console}
3544 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003545 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 the height of the cursor can be changed. This can be done by
3547 specifying a block cursor, or a percentage for a vertical or
3548 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003549 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3550 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003552 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 mode-list and an argument-list:
3554 mode-list:argument-list,mode-list:argument-list,..
3555 The mode-list is a dash separated list of these modes:
3556 n Normal mode
3557 v Visual mode
3558 ve Visual mode with 'selection' "exclusive" (same as 'v',
3559 if not specified)
3560 o Operator-pending mode
3561 i Insert mode
3562 r Replace mode
3563 c Command-line Normal (append) mode
3564 ci Command-line Insert mode
3565 cr Command-line Replace mode
3566 sm showmatch in Insert mode
3567 a all modes
3568 The argument-list is a dash separated list of these arguments:
3569 hor{N} horizontal bar, {N} percent of the character height
3570 ver{N} vertical bar, {N} percent of the character width
3571 block block cursor, fills the whole character
3572 [only one of the above three should be present]
3573 blinkwait{N} *cursor-blinking*
3574 blinkon{N}
3575 blinkoff{N}
3576 blink times for cursor: blinkwait is the delay before
3577 the cursor starts blinking, blinkon is the time that
3578 the cursor is shown and blinkoff is the time that the
3579 cursor is not shown. The times are in msec. When one
3580 of the numbers is zero, there is no blinking. The
3581 default is: "blinkwait700-blinkon400-blinkoff250".
3582 These numbers are used for a missing entry. This
3583 means that blinking is enabled by default. To switch
3584 blinking off you can use "blinkon0". The cursor only
3585 blinks when Vim is waiting for input, not while
3586 executing a command.
3587 To make the cursor blink in an xterm, see
3588 |xterm-blink|.
3589 {group-name}
3590 a highlight group name, that sets the color and font
3591 for the cursor
3592 {group-name}/{group-name}
3593 Two highlight group names, the first is used when
3594 no language mappings are used, the other when they
3595 are. |language-mapping|
3596
3597 Examples of parts:
3598 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3599 block cursor with colors from the "nCursor"
3600 highlight group
3601 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3602 In Insert and Command-line Insert mode, use a
3603 30% vertical bar cursor with colors from the
3604 "iCursor" highlight group. Blink a bit
3605 faster.
3606
3607 The 'a' mode is different. It will set the given argument-list for
3608 all modes. It does not reset anything to defaults. This can be used
3609 to do a common setting for all modes. For example, to switch off
3610 blinking: "a:blinkon0"
3611
3612 Examples of cursor highlighting: >
3613 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3614 :highlight Cursor gui=NONE guifg=bg guibg=fg
3615<
3616 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003617 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618'guifont' 'gfn' string (default "")
3619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620 {only available when compiled with GUI enabled}
3621 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003622 In its simplest form the value is just one font name.
3623 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624
3625 *'guifontset'* *'gfs'*
3626 *E250* *E252* *E234* *E597* *E598*
3627'guifontset' 'gfs' string (default "")
3628 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629 {only available when compiled with GUI enabled and
3630 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003631 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 When not empty, specifies two (or more) fonts to be used. The first
3633 one for normal English, the second one for your special language. See
3634 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003635
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3637'guifontwide' 'gfw' string (default "")
3638 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 {only available when compiled with GUI enabled}
3640 When not empty, specifies a comma-separated list of fonts to be used
3641 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003642 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003643
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 *'guiheadroom'* *'ghr'*
3645'guiheadroom' 'ghr' number (default 50)
3646 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003647 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 The number of pixels subtracted from the screen height when fitting
3649 the GUI window on the screen. Set this before the GUI is started,
3650 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003651 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 lines will be left for window decorations and other items on the
3653 screen. Set it to a negative value to allow windows taller than the
3654 screen.
3655
3656 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003657'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3658 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003659 "aegimrLtT" (GTK, Motif and Athena),
3660 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003663 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 sequence of letters which describes what components and options of the
3665 GUI should be used.
3666 To avoid problems with flags that are added in the future, use the
3667 "+=" and "-=" feature of ":set" |add-option-flags|.
3668
Bram Moolenaar13568252018-03-16 20:46:58 +01003669 Valid characters are as follows:
3670 *'go-!'*
3671 '!' External commands are executed in a terminal window. Without
3672 this flag the MS-Windows GUI will open a console window to
3673 execute the command. The Unix GUI will simulate a dumb
3674 terminal to list the command output.
3675 The terminal window will be positioned at the bottom, and grow
3676 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003677 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678 'a' Autoselect: If present, then whenever VISUAL mode is started,
3679 or the Visual area extended, Vim tries to become the owner of
3680 the windowing system's global selection. This means that the
3681 Visually highlighted text is available for pasting into other
3682 applications as well as into Vim itself. When the Visual mode
3683 ends, possibly due to an operation on the text, or when an
3684 application wants to paste the selection, the highlighted text
3685 is automatically yanked into the "* selection register.
3686 Thus the selection is still available for pasting into other
3687 applications after the VISUAL mode has ended.
3688 If not present, then Vim won't become the owner of the
3689 windowing system's global selection unless explicitly told to
3690 by a yank or delete operation for the "* register.
3691 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003692 *'go-P'*
3693 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003694 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003695 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003696 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 applies to the modeless selection.
3698
3699 'guioptions' autoselect Visual autoselect modeless ~
3700 "" - -
3701 "a" yes yes
3702 "A" - yes
3703 "aA" yes yes
3704
Bram Moolenaar02467872007-05-06 13:22:01 +00003705 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 'c' Use console dialogs instead of popup dialogs for simple
3707 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003708 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003709 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003710 'guitablabel' can be used to change the text in the labels.
3711 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003712 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003713 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003714 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 'f' Foreground: Don't use fork() to detach the GUI from the shell
3716 where it was started. Use this for programs that wait for the
3717 editor to finish (e.g., an e-mail program). Alternatively you
3718 can use "gvim -f" or ":gui -f" to start the GUI in the
3719 foreground. |gui-fork|
3720 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003721 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003722 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3724 corner of the window. It's black&white on non-GTK, because of
3725 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003726 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003728 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003729 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003731 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003733 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003734 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 'g' Grey menu items: Make menu items that are not active grey. If
3736 'g' is not included inactive menu items are not shown at all.
3737 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003738 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739 't' Include tearoff menu items. Currently only works for Win32,
3740 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003741 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003742 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003743 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003744 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003746 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 'R' Right-hand scrollbar is present when there is a vertically
3748 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003749 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003751 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 'L' Left-hand scrollbar is present when there is a vertically
3753 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003754 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3756 the longest visible line, or on the cursor line if the 'h'
3757 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003758 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 'h' Limit horizontal scrollbar size to the length of the cursor
3760 line. Reduces computations. |gui-horiz-scroll|
3761
3762 And yes, you may even have scrollbars on the left AND the right if
3763 you really want to :-). See |gui-scrollbars| for more information.
3764
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003765 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 'v' Use a vertical button layout for dialogs. When not included,
3767 a horizontal layout is preferred, but when it doesn't fit a
3768 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003769 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 'p' Use Pointer callbacks for X11 GUI. This is required for some
3771 window managers. If the cursor is not blinking or hollow at
3772 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003773 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003775 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003776 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003777 *'go-k'*
3778 'k' Keep the GUI window size when adding/removing a scrollbar, or
3779 toolbar, tabline, etc. Instead, the behavior is similar to
3780 when the window is maximized and will adjust 'lines' and
3781 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003782 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003783 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003784
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 *'guipty'* *'noguipty'*
3786'guipty' boolean (default on)
3787 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 {only available when compiled with GUI enabled}
3789 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3790 I/O to/from shell commands. See |gui-pty|.
3791
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003792 *'guitablabel'* *'gtl'*
3793'guitablabel' 'gtl' string (default empty)
3794 global
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003795 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003796 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003797 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003798 pages line. When empty and when the result is empty Vim will use a
3799 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003800
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003801 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003802 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003803 The expression will be evaluated in the |sandbox| when set from a
3804 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003805 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003806
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003807 Only used when the GUI tab pages line is displayed. 'e' must be
3808 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3809 used.
3810
Bram Moolenaar57657d82006-04-21 22:12:41 +00003811 *'guitabtooltip'* *'gtt'*
3812'guitabtooltip' 'gtt' string (default empty)
3813 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00003814 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003815 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003816 When nonempty describes the text to use in a tooltip for the GUI tab
3817 pages line. When empty Vim will use a default tooltip.
3818 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003819 You can include a line break. Simplest method is to use |:let|: >
3820 :let &guitabtooltip = "line one\nline two"
3821<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003822
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 *'helpfile'* *'hf'*
3824'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3825 (others) "$VIMRUNTIME/doc/help.txt")
3826 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 Name of the main help file. All distributed help files should be
3828 placed together in one directory. Additionally, all "doc" directories
3829 in 'runtimepath' will be used.
3830 Environment variables are expanded |:set_env|. For example:
3831 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003832 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833 spaces and backslashes.
3834 This option cannot be set from a |modeline| or in the |sandbox|, for
3835 security reasons.
3836
3837 *'helpheight'* *'hh'*
3838'helpheight' 'hh' number (default 20)
3839 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02003840 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 feature}
3842 Minimal initial height of the help window when it is opened with the
3843 ":help" command. The initial height of the help window is half of the
3844 current window, or (when the 'ea' option is on) the same as other
3845 windows. When the height is less than 'helpheight', the height is
3846 set to 'helpheight'. Set to zero to disable.
3847
3848 *'helplang'* *'hlg'*
3849'helplang' 'hlg' string (default: messages language or empty)
3850 global
3851 {only available when compiled with the |+multi_lang|
3852 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 Comma separated list of languages. Vim will use the first language
3854 for which the desired help can be found. The English help will always
3855 be used as a last resort. You can add "en" to prefer English over
3856 another language, but that will only find tags that exist in that
3857 language and not in the English help.
3858 Example: >
3859 :set helplang=de,it
3860< This will first search German, then Italian and finally English help
3861 files.
3862 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3863 try to find the tag in the current language before using this option.
3864 See |help-translated|.
3865
3866 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3867'hidden' 'hid' boolean (default off)
3868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 When off a buffer is unloaded when it is |abandon|ed. When on a
3870 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3871 displayed in another window, it does not become hidden, of course.
3872 The commands that move through the buffer list sometimes make a buffer
3873 hidden although the 'hidden' option is off: When the buffer is
3874 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003875 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003876 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 This option is set for one command with ":hide {command}" |:hide|.
3878 WARNING: It's easy to forget that you have changes in hidden buffers.
3879 Think twice when using ":q!" or ":qa!".
3880
3881 *'highlight'* *'hl'*
3882'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003883 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3884 d:Directory,e:ErrorMsg,i:IncSearch,
3885 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
3886 N:CursorLineNr,r:Question,s:StatusLine,
3887 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003888 v:Visual,V:VisualNOS,w:WarningMsg,
3889 W:WildMenu,f:Folded,F:FoldColumn,
3890 A:DiffAdd,C:DiffChange,D:DiffDelete,
3891 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003892 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003893 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003894 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3895 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003896 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003897 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 This option can be used to set highlighting mode for various
3900 occasions. It is a comma separated list of character pairs. The
3901 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003902 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003904 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3905 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 characters from 'showbreak'
3907 |hl-Directory| d directories in CTRL-D listing and other special
3908 things in listings
3909 |hl-ErrorMsg| e error messages
3910 h (obsolete, ignored)
3911 |hl-IncSearch| i 'incsearch' highlighting
3912 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3913 |hl-MoreMsg| m |more-prompt|
3914 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003915 |hl-LineNr| n line number for ":number" and ":#" commands, and
3916 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003917 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3918 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 |hl-Question| r |hit-enter| prompt and yes/no questions
3920 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003921 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3923 |hl-VertSplit| c column used to separate vertically split windows
3924 |hl-Visual| v Visual mode
3925 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3926 Selection" Only X11 Gui's |gui-x11| and
3927 |xterm-clipboard|.
3928 |hl-WarningMsg| w warning messages
3929 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3930 |hl-Folded| f line used for closed folds
3931 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003932 |hl-DiffAdd| A added line in diff mode
3933 |hl-DiffChange| C changed line in diff mode
3934 |hl-DiffDelete| D deleted line in diff mode
3935 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003937 |hl-Conceal| - the placeholders used for concealed characters
3938 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003939 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003940 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003941 |hl-SpellRare| R rare word |spell|
3942 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003943 |hl-Pmenu| + popup menu normal line
3944 |hl-PmenuSel| = popup menu selected line
3945 |hl-PmenuSbar| x popup menu scrollbar
3946 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947
3948 The display modes are:
3949 r reverse (termcap entry "mr" and "me")
3950 i italic (termcap entry "ZH" and "ZR")
3951 b bold (termcap entry "md" and "me")
3952 s standout (termcap entry "so" and "se")
3953 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003954 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02003955 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 n no highlighting
3957 - no highlighting
3958 : use a highlight group
3959 The default is used for occasions that are not included.
3960 If you want to change what the display modes do, see |dos-colors|
3961 for an example.
3962 When using the ':' display mode, this must be followed by the name of
3963 a highlight group. A highlight group can be used to define any type
3964 of highlighting, including using color. See |:highlight| on how to
3965 define one. The default uses a different group for each occasion.
3966 See |highlight-default| for the default highlight groups.
3967
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003969'history' 'hi' number (Vim default: 50, Vi default: 0,
3970 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003973 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003975 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 NOTE: This option is set to the Vi default value when 'compatible' is
3977 set and to the Vim default value when 'compatible' is reset.
3978
3979 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3980'hkmap' 'hk' boolean (default off)
3981 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 {only available when compiled with the |+rightleft|
3983 feature}
3984 When on, the keyboard is mapped for the Hebrew character set.
3985 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3986 toggle this option. See |rileft.txt|.
3987 NOTE: This option is reset when 'compatible' is set.
3988
3989 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3990'hkmapp' 'hkp' boolean (default off)
3991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 {only available when compiled with the |+rightleft|
3993 feature}
3994 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3995 This is useful if you have a non-Hebrew keyboard.
3996 See |rileft.txt|.
3997 NOTE: This option is reset when 'compatible' is set.
3998
Bram Moolenaar036986f2017-03-16 17:41:02 +01003999 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4000'hlsearch' 'hls' boolean (default off)
4001 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004002 {not available when compiled without the
4003 |+extra_search| feature}
4004 When there is a previous search pattern, highlight all its matches.
4005 The type of highlighting used can be set with the 'l' occasion in the
4006 'highlight' option. This uses the "Search" highlight group by
4007 default. Note that only the matching text is highlighted, any offsets
4008 are not applied.
4009 See also: 'incsearch' and |:match|.
4010 When you get bored looking at the highlighted matches, you can turn it
4011 off with |:nohlsearch|. This does not change the option value, as
4012 soon as you use a search command, the highlighting comes back.
4013 'redrawtime' specifies the maximum time spent on finding matches.
4014 When the search pattern can match an end-of-line, Vim will try to
4015 highlight all of the matched text. However, this depends on where the
4016 search starts. This will be the first line in the window or the first
4017 line below a closed fold. A match in a previous line which is not
4018 drawn may not continue in a newly drawn line.
4019 You can specify whether the highlight status is restored on startup
4020 with the 'h' flag in 'viminfo' |viminfo-h|.
4021 NOTE: This option is reset when 'compatible' is set.
4022
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023 *'icon'* *'noicon'*
4024'icon' boolean (default off, on when title can be restored)
4025 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 {not available when compiled without the |+title|
4027 feature}
4028 When on, the icon text of the window will be set to the value of
4029 'iconstring' (if it is not empty), or to the name of the file
4030 currently being edited. Only the last part of the name is used.
4031 Overridden by the 'iconstring' option.
4032 Only works if the terminal supports setting window icons (currently
4033 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4034 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4035 builtin termcap).
4036 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004037 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004039 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040
4041 *'iconstring'*
4042'iconstring' string (default "")
4043 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 {not available when compiled without the |+title|
4045 feature}
4046 When this option is not empty, it will be used for the icon text of
4047 the window. This happens only when the 'icon' option is on.
4048 Only works if the terminal supports setting window icon text
4049 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4050 Does not work for MS Windows.
4051 When Vim was compiled with HAVE_X11 defined, the original icon will be
4052 restored if possible |X11|.
4053 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004054 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004056 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 {not available when compiled without the |+statusline| feature}
4058
4059 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4060'ignorecase' 'ic' boolean (default off)
4061 global
4062 Ignore case in search patterns. Also used when searching in the tags
4063 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004064 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065 Can be overruled by using "\c" or "\C" in the pattern, see
4066 |/ignorecase|.
4067
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004068 *'imactivatefunc'* *'imaf'*
4069'imactivatefunc' 'imaf' string (default "")
4070 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004071 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004072 activate or deactivate the Input Method.
4073 It is not used in the GUI.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004074 The expression will be evaluated in the |sandbox| when set from a
4075 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004076
4077 Example: >
4078 function ImActivateFunc(active)
4079 if a:active
4080 ... do something
4081 else
4082 ... do something
4083 endif
4084 " return value is not used
4085 endfunction
4086 set imactivatefunc=ImActivateFunc
4087<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 *'imactivatekey'* *'imak'*
4089'imactivatekey' 'imak' string (default "")
4090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004092 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 Specifies the key that your Input Method in X-Windows uses for
4094 activation. When this is specified correctly, vim can fully control
4095 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4096 You can't use this option to change the activation key, the option
4097 tells Vim what the key is.
4098 Format:
4099 [MODIFIER_FLAG-]KEY_STRING
4100
4101 These characters can be used for MODIFIER_FLAG (case is ignored):
4102 S Shift key
4103 L Lock key
4104 C Control key
4105 1 Mod1 key
4106 2 Mod2 key
4107 3 Mod3 key
4108 4 Mod4 key
4109 5 Mod5 key
4110 Combinations are allowed, for example "S-C-space" or "SC-space" are
4111 both shift+ctrl+space.
4112 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4113
4114 Example: >
4115 :set imactivatekey=S-space
4116< "S-space" means shift+space. This is the activation key for kinput2 +
4117 canna (Japanese), and ami (Korean).
4118
4119 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4120'imcmdline' 'imc' boolean (default off)
4121 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122 When set the Input Method is always on when starting to edit a command
4123 line, unless entering a search pattern (see 'imsearch' for that).
4124 Setting this option is useful when your input method allows entering
4125 English characters directly, e.g., when it's used to type accented
4126 characters with dead keys.
4127
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004128 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4130 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 When set the Input Method is never used. This is useful to disable
4132 the IM when it doesn't work properly.
4133 Currently this option is on by default for SGI/IRIX machines. This
4134 may change in later releases.
4135
4136 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004137'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 Specifies whether :lmap or an Input Method (IM) is to be used in
4140 Insert mode. Valid values:
4141 0 :lmap is off and IM is off
4142 1 :lmap is ON and IM is off
4143 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144 To always reset the option to zero when leaving Insert mode with <Esc>
4145 this can be used: >
4146 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4147< This makes :lmap and IM turn off automatically when leaving Insert
4148 mode.
4149 Note that this option changes when using CTRL-^ in Insert mode
4150 |i_CTRL-^|.
4151 The value is set to 1 when setting 'keymap' to a valid keymap name.
4152 It is also used for the argument of commands like "r" and "f".
4153 The value 0 may not work correctly with Athena and Motif with some XIM
4154 methods. Use 'imdisable' to disable XIM then.
4155
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004156 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004157 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004158 |+multi_byte_ime| or |global-ime|.
4159
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004161'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 Specifies whether :lmap or an Input Method (IM) is to be used when
4164 entering a search pattern. Valid values:
4165 -1 the value of 'iminsert' is used, makes it look like
4166 'iminsert' is also used when typing a search pattern
4167 0 :lmap is off and IM is off
4168 1 :lmap is ON and IM is off
4169 2 :lmap is off and IM is ON
4170 Note that this option changes when using CTRL-^ in Command-line mode
4171 |c_CTRL-^|.
4172 The value is set to 1 when it is not -1 and setting the 'keymap'
4173 option to a valid keymap name.
4174 The value 0 may not work correctly with Athena and Motif with some XIM
4175 methods. Use 'imdisable' to disable XIM then.
4176
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004177 *'imstatusfunc'* *'imsf'*
4178'imstatusfunc' 'imsf' string (default "")
4179 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004180 This option specifies a function that is called to obtain the status
4181 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004182 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004183
4184 Example: >
4185 function ImStatusFunc()
4186 let is_active = ...do something
4187 return is_active ? 1 : 0
4188 endfunction
4189 set imstatusfunc=ImStatusFunc
4190<
4191 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004192 The expression will be evaluated in the |sandbox| when set from a
4193 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004194
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004195 *'imstyle'* *'imst'*
4196'imstyle' 'imst' number (default 1)
4197 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004198 {only available when compiled with |+xim| and
4199 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004200 This option specifies the input style of Input Method:
4201 0 use on-the-spot style
4202 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004203 See: |xim-input-style|
4204
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004205 For a long time on-the-spot style had been used in the GTK version of
4206 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004207 |single-repeat|, etc. Therefore over-the-spot style becomes the
4208 default now. This should work fine for most people, however if you
4209 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004210 The expression will be evaluated in the |sandbox| when set from a
4211 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004212
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 *'include'* *'inc'*
4214'include' 'inc' string (default "^\s*#\s*include")
4215 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 {not available when compiled without the
4217 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004218 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 pattern, just like for the "/" command (See |pattern|). The default
4220 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004221 "]I", "[d", etc.
4222 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004223 comes after the matched pattern. But if "\zs" appears in the pattern
4224 then the text matched from "\zs" to the end, or until "\ze" if it
4225 appears, is used as the file name. Use this to include characters
4226 that are not in 'isfname', such as a space. You can then use
4227 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004228 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229
4230 *'includeexpr'* *'inex'*
4231'includeexpr' 'inex' string (default "")
4232 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004234 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004236 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 :set includeexpr=substitute(v:fname,'\\.','/','g')
4238< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004239
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004241 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004242 Also used for |<cfile>|.
4243
Bram Moolenaar30b65812012-07-12 22:01:11 +02004244 The expression will be evaluated in the |sandbox| when set from a
4245 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004246 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004247
4248 It is not allowed to change text or jump to another window while
4249 evaluating 'includeexpr' |textlock|.
4250
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004252'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4253 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004255 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004256 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004257 While typing a search command, show where the pattern, as it was typed
4258 so far, matches. The matched string is highlighted. If the pattern
4259 is invalid or not found, nothing is shown. The screen will be updated
4260 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004261 Also applies to the pattern in commands: >
4262 :global
4263 :lvimgrep
4264 :lvimgrepadd
4265 :smagic
4266 :snomagic
4267 :sort
4268 :substitute
4269 :vglobal
4270 :vimgrep
4271 :vimgrepadd
4272< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004273 original position when no match is found and when pressing <Esc>. You
4274 still need to finish the search command with <Enter> to move the
4275 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004276 You can use the CTRL-G and CTRL-T keys to move to the next and
4277 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004278 When compiled with the |+reltime| feature Vim only searches for about
4279 half a second. With a complicated pattern and/or a lot of text the
4280 match may not be found. This is to avoid that Vim hangs while you
4281 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004282 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004283 When 'hlsearch' is on, all matched strings are highlighted too while
4284 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004285 If you don't want to turn 'hlsearch' on, but want to highlight all
4286 matches while searching, you can turn on and off 'hlsearch' with
4287 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004288 augroup vimrc-incsearch-highlight
4289 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004290 autocmd CmdlineEnter /,\? :set hlsearch
4291 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004292 augroup END
4293<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004294 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004295 to the command line. If 'ignorecase' and 'smartcase' are set and the
4296 command line has no uppercase characters, the added character is
4297 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004298 CTRL-R CTRL-W can be used to add the word at the end of the current
4299 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 NOTE: This option is reset when 'compatible' is set.
4301
4302 *'indentexpr'* *'inde'*
4303'indentexpr' 'inde' string (default "")
4304 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 {not available when compiled without the |+cindent|
4306 or |+eval| features}
4307 Expression which is evaluated to obtain the proper indent for a line.
4308 It is used when a new line is created, for the |=| operator and
4309 in Insert mode as specified with the 'indentkeys' option.
4310 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004311 'smartindent' indenting. When 'lisp' is set, this option is
4312 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 When 'paste' is set this option is not used for indenting.
4314 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004315 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 when the expression is evaluated (but it may be moved around).
4317 The expression must return the number of spaces worth of indent. It
4318 can return "-1" to keep the current indent (this means 'autoindent' is
4319 used for the indent).
4320 Functions useful for computing the indent are |indent()|, |cindent()|
4321 and |lispindent()|.
4322 The evaluation of the expression must not have side effects! It must
4323 not change the text, jump to another window, etc. Afterwards the
4324 cursor position is always restored, thus the cursor may be moved.
4325 Normally this option would be set to call a function: >
4326 :set indentexpr=GetMyIndent()
4327< Error messages will be suppressed, unless the 'debug' option contains
4328 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004329 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004330 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004331
Bram Moolenaar30b65812012-07-12 22:01:11 +02004332 The expression will be evaluated in the |sandbox| when set from a
4333 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004334 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004335
4336 It is not allowed to change text or jump to another window while
4337 evaluating 'indentexpr' |textlock|.
4338
4339
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004341'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 {not available when compiled without the |+cindent|
4344 feature}
4345 A list of keys that, when typed in Insert mode, cause reindenting of
4346 the current line. Only happens if 'indentexpr' isn't empty.
4347 The format is identical to 'cinkeys', see |indentkeys-format|.
4348 See |C-indenting| and |indent-expression|.
4349
4350 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4351'infercase' 'inf' boolean (default off)
4352 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004354 'ignorecase' is also on, the case of the match is adjusted depending
4355 on the typed text. If the typed text contains a lowercase letter
4356 where the match has an upper case letter, the completed part is made
4357 lowercase. If the typed text has no lowercase letters and the match
4358 has a lowercase letter where the typed text has an uppercase letter,
4359 and there is a letter before it, the completed part is made uppercase.
4360 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004361
4362 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4363'insertmode' 'im' boolean (default off)
4364 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 Makes Vim work in a way that Insert mode is the default mode. Useful
4366 if you want to use Vim as a modeless editor. Used for |evim|.
4367 These Insert mode commands will be useful:
4368 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004369 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370 this is a mapping, it is executed as if 'insertmode' was off.
4371 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004373 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4374 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375
4376 These items change when 'insertmode' is set:
4377 - when starting to edit of a file, Vim goes to Insert mode.
4378 - <Esc> in Insert mode is a no-op and beeps.
4379 - <Esc> in Normal mode makes Vim go to Insert mode.
4380 - CTRL-L in Insert mode is a command, it is not inserted.
4381 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4382 However, when <Esc> is used inside a mapping, it behaves like
4383 'insertmode' was not set. This was done to be able to use the same
4384 mappings with 'insertmode' set or not set.
4385 When executing commands with |:normal| 'insertmode' is not used.
4386
4387 NOTE: This option is reset when 'compatible' is set.
4388
4389 *'isfname'* *'isf'*
4390'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4391 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4392 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4393 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4394 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4395 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4396 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 The characters specified by this option are included in file names and
4398 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004399 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 Multi-byte characters 256 and above are always included, only the
4401 characters up to 255 are specified with this option.
4402 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004403 Think twice before adding white space to this option. Although a
4404 space may appear inside a file name, the effect will be that Vim
4405 doesn't know where a file name starts or ends when doing completion.
4406 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407
4408 Note that on systems using a backslash as path separator, Vim tries to
4409 do its best to make it work as you would expect. That is a bit
4410 tricky, since Vi originally used the backslash to escape special
4411 characters. Vim will not remove a backslash in front of a normal file
4412 name character on these systems, but it will on Unix and alikes. The
4413 '&' and '^' are not included by default, because these are special for
4414 cmd.exe.
4415
4416 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004417 Each part can be a single character number or a range. A range is two
4418 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 decimal number between 0 and 255 or the ASCII character itself (does
4420 not work for digits). Example:
4421 "_,-,128-140,#-43" (include '_' and '-' and the range
4422 128 to 140 and '#' to 43)
4423 If a part starts with '^', the following character number or range
4424 will be excluded from the option. The option is interpreted from left
4425 to right. Put the excluded character after the range where it is
4426 included. To include '^' itself use it as the last character of the
4427 option or the end of a range. Example:
4428 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4429 If the character is '@', all characters where isalpha() returns TRUE
4430 are included. Normally these are the characters a to z and A to Z,
4431 plus accented characters. To include '@' itself use "@-@". Examples:
4432 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004433 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 "a-z,A-Z,@-@" All letters plus the '@' character.
4435 A comma can be included by using it where a character number is
4436 expected. Example:
4437 "48-57,,,_" Digits, comma and underscore.
4438 A comma can be excluded by prepending a '^'. Example:
4439 " -~,^,,9" All characters from space to '~', excluding
4440 comma, plus <Tab>.
4441 See |option-backslash| about including spaces and backslashes.
4442
4443 *'isident'* *'isi'*
4444'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4445 "@,48-57,_,128-167,224-235"
4446 otherwise: "@,48-57,_,192-255")
4447 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 The characters given by this option are included in identifiers.
4449 Identifiers are used in recognizing environment variables and after a
4450 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004451 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004452 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004454 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4456
4457 *'iskeyword'* *'isk'*
4458'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4459 "@,48-57,_,128-167,224-235"
4460 otherwise: "@,48-57,_,192-255"
4461 Vi default: "@,48-57,_")
4462 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004464 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004465 'isfname' for a description of the format of this option. For '@'
4466 characters above 255 check the "word" character class.
4467 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 For a help file it is set to all non-blank printable characters except
4469 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4470 command).
4471 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004472 This option also influences syntax highlighting, unless the syntax
4473 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 NOTE: This option is set to the Vi default value when 'compatible' is
4475 set and to the Vim default value when 'compatible' is reset.
4476
4477 *'isprint'* *'isp'*
4478'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4479 "@,~-255"; otherwise: "@,161-255")
4480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481 The characters given by this option are displayed directly on the
4482 screen. It is also used for "\p" in a |pattern|. The characters from
4483 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4484 even when they are not included in 'isprint' or excluded. See
4485 'isfname' for a description of the format of this option.
4486
4487 Non-printable characters are displayed with two characters:
4488 0 - 31 "^@" - "^_"
4489 32 - 126 always single characters
4490 127 "^?"
4491 128 - 159 "~@" - "~_"
4492 160 - 254 "| " - "|~"
4493 255 "~?"
4494 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4495 displayed as <xx>, with the hexadecimal value of the byte.
4496 When 'display' contains "uhex" all unprintable characters are
4497 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004498 The SpecialKey highlighting will be used for unprintable characters.
4499 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500
4501 Multi-byte characters 256 and above are always included, only the
4502 characters up to 255 are specified with this option. When a character
4503 is printable but it is not available in the current font, a
4504 replacement character will be shown.
4505 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4506 There is no option to specify these characters.
4507
4508 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4509'joinspaces' 'js' boolean (default on)
4510 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511 Insert two spaces after a '.', '?' and '!' with a join command.
4512 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4513 Otherwise only one space is inserted.
4514 NOTE: This option is set when 'compatible' is set.
4515
4516 *'key'*
4517'key' string (default "")
4518 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004519 {only available when compiled with the |+cryptv|
4520 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004522 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 Careful: Do not set the key value by hand, someone might see the typed
4524 key. Use the |:X| command. But you can make 'key' empty: >
4525 :set key=
4526< It is not possible to get the value of this option with ":set key" or
4527 "echo &key". This is to avoid showing it to someone who shouldn't
4528 know. It also means you cannot see it yourself once you have set it,
4529 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004530 You can use "&key" in an expression to detect whether encryption is
4531 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532
4533 *'keymap'* *'kmp'* *E544*
4534'keymap' 'kmp' string (default "")
4535 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 {only available when compiled with the |+keymap|
4537 feature}
4538 Name of a keyboard mapping. See |mbyte-keymap|.
4539 Setting this option to a valid keymap name has the side effect of
4540 setting 'iminsert' to one, so that the keymap becomes effective.
4541 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004542 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543
4544 *'keymodel'* *'km'*
4545'keymodel' 'km' string (default "")
4546 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 List of comma separated words, which enable special things that keys
4548 can do. These values can be used:
4549 startsel Using a shifted special key starts selection (either
4550 Select mode or Visual mode, depending on "key" being
4551 present in 'selectmode').
4552 stopsel Using a not-shifted special key stops selection.
4553 Special keys in this context are the cursor keys, <End>, <Home>,
4554 <PageUp> and <PageDown>.
4555 The 'keymodel' option is set by the |:behave| command.
4556
4557 *'keywordprg'* *'kp'*
4558'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004559 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 Program to use for the |K| command. Environment variables are
4562 expanded |:set_env|. ":help" may be used to access the Vim internal
4563 help. (Note that previously setting the global option to the empty
4564 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004565 When the first character is ":", the command is invoked as a Vim
4566 Ex command prefixed with [count].
4567 When "man", "man -s" or an Ex command is used, Vim will automatically
4568 translate a count for the "K" command and pass it as the first
4569 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 See |option-backslash| about including spaces and backslashes.
4571 Example: >
4572 :set keywordprg=man\ -s
4573< This option cannot be set from a |modeline| or in the |sandbox|, for
4574 security reasons.
4575
4576 *'langmap'* *'lmap'* *E357* *E358*
4577'langmap' 'lmap' string (default "")
4578 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 {only available when compiled with the |+langmap|
4580 feature}
4581 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004582 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004583 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 care of translating these special characters to the original meaning
4585 of the key. This means you don't have to change the keyboard mode to
4586 be able to execute Normal mode commands.
4587 This is the opposite of the 'keymap' option, where characters are
4588 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004589 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004590 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004591 This option cannot be set from a |modeline| or in the |sandbox|, for
4592 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004594 Example (for Greek, in UTF-8): *greek* >
4595 :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 +00004596< Example (exchanges meaning of z and y for commands): >
4597 :set langmap=zy,yz,ZY,YZ
4598<
4599 The 'langmap' option is a list of parts, separated with commas. Each
4600 part can be in one of two forms:
4601 1. A list of pairs. Each pair is a "from" character immediately
4602 followed by the "to" character. Examples: "aA", "aAbBcC".
4603 2. A list of "from" characters, a semi-colon and a list of "to"
4604 characters. Example: "abc;ABC"
4605 Example: "aA,fgh;FGH,cCdDeE"
4606 Special characters need to be preceded with a backslash. These are
4607 ";", ',' and backslash itself.
4608
4609 This will allow you to activate vim actions without having to switch
4610 back and forth between the languages. Your language characters will
4611 be understood as normal vim English characters (according to the
4612 langmap mappings) in the following cases:
4613 o Normal/Visual mode (commands, buffer/register names, user mappings)
4614 o Insert/Replace Mode: Register names after CTRL-R
4615 o Insert/Replace Mode: Mappings
4616 Characters entered in Command-line mode will NOT be affected by
4617 this option. Note that this option can be changed at any time
4618 allowing to switch between mappings for different languages/encodings.
4619 Use a mapping to avoid having to type it each time!
4620
4621 *'langmenu'* *'lm'*
4622'langmenu' 'lm' string (default "")
4623 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 {only available when compiled with the |+menu| and
4625 |+multi_lang| features}
4626 Language to use for menu translation. Tells which file is loaded
4627 from the "lang" directory in 'runtimepath': >
4628 "lang/menu_" . &langmenu . ".vim"
4629< (without the spaces). For example, to always use the Dutch menus, no
4630 matter what $LANG is set to: >
4631 :set langmenu=nl_NL.ISO_8859-1
4632< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004633 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 If your $LANG is set to a non-English language but you do want to use
4635 the English menus: >
4636 :set langmenu=none
4637< This option must be set before loading menus, switching on filetype
4638 detection or syntax highlighting. Once the menus are defined setting
4639 this option has no effect. But you could do this: >
4640 :source $VIMRUNTIME/delmenu.vim
4641 :set langmenu=de_DE.ISO_8859-1
4642 :source $VIMRUNTIME/menu.vim
4643< Warning: This deletes all menus that you defined yourself!
4644
Bram Moolenaard94464e2015-11-02 15:28:18 +01004645 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004646'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004647 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004648 {only available when compiled with the |+langmap|
4649 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004650 This is just like 'langremap' but with the value inverted. It only
4651 exists for backwards compatibility. When setting 'langremap' then
4652 'langnoremap' is set to the inverted value, and the other way around.
4653
4654 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4655'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4656 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004657 {only available when compiled with the |+langmap|
4658 feature}
4659 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004660 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004661 'langmap' disables some of your mappings, try resetting this option.
4662 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004663 that works for you to avoid mappings to break.
4664
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 *'laststatus'* *'ls'*
4666'laststatus' 'ls' number (default 1)
4667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668 The value of this option influences when the last window will have a
4669 status line:
4670 0: never
4671 1: only if there are at least two windows
4672 2: always
4673 The screen looks nicer with a status line if you have several
4674 windows, but it takes another screen line. |status-line|
4675
4676 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4677'lazyredraw' 'lz' boolean (default off)
4678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679 When this option is set, the screen will not be redrawn while
4680 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004681 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 update use |:redraw|.
4683
4684 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4685'linebreak' 'lbr' boolean (default off)
4686 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004687 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004689 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690 than at the last character that fits on the screen. Unlike
4691 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004692 it only affects the way the file is displayed, not its contents.
4693 If 'breakindent' is set, line is visually indented. Then, the value
4694 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004695 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 Note that <Tab> characters after an <EOL> are mostly not displayed
4697 with the right amount of white space.
4698
4699 *'lines'* *E593*
4700'lines' number (default 24 or terminal height)
4701 global
4702 Number of lines of the Vim window.
4703 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004704 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 When Vim is running in the GUI or in a resizable window, setting this
4706 option will cause the window size to be changed. When you only want
4707 to use the size for the GUI, put the command in your |gvimrc| file.
4708 Vim limits the number of lines to what fits on the screen. You can
4709 use this command to get the tallest window possible: >
4710 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004711< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004712 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004713 When you set this option and Vim is unable to change the physical
4714 number of lines of the display, the display may be messed up.
4715
4716 *'linespace'* *'lsp'*
4717'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 {only in the GUI}
4720 Number of pixel lines inserted between characters. Useful if the font
4721 uses the full character cell height, making lines touch each other.
4722 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004723 With some fonts there can be too much room between lines (to have
4724 space for ascents and descents). Then it makes sense to set
4725 'linespace' to a negative value. This may cause display problems
4726 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727
4728 *'lisp'* *'nolisp'*
4729'lisp' boolean (default off)
4730 local to buffer
4731 {not available when compiled without the |+lispindent|
4732 feature}
4733 Lisp mode: When <Enter> is typed in insert mode set the indent for
4734 the next line to Lisp standards (well, sort of). Also happens with
4735 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4736 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4737 better. Also see 'lispwords'.
4738 The '-' character is included in keyword characters. Redefines the
4739 "=" operator to use this same indentation algorithm rather than
4740 calling an external program if 'equalprg' is empty.
4741 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742
4743 *'lispwords'* *'lw'*
4744'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004745 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746 {not available when compiled without the |+lispindent|
4747 feature}
4748 Comma separated list of words that influence the Lisp indenting.
4749 |'lisp'|
4750
4751 *'list'* *'nolist'*
4752'list' boolean (default off)
4753 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004754 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4755 line. Useful to see the difference between tabs and spaces and for
4756 trailing blanks. Further changed by the 'listchars' option.
4757
4758 The cursor is displayed at the start of the space a Tab character
4759 occupies, not at the end as usual in Normal mode. To get this cursor
4760 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004761 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004762<
4763 Note that list mode will also affect formatting (set with 'textwidth'
4764 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 changing the way tabs are displayed.
4766
4767 *'listchars'* *'lcs'*
4768'listchars' 'lcs' string (default "eol:$")
4769 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004770 Strings to use in 'list' mode and for the |:list| command. It is a
4771 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004772 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 eol:c Character to show at the end of each line. When
4774 omitted, there is no extra character at the end of the
4775 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004776 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004777 tab:xy[z] Two or three characters to be used to show a tab.
4778 The third character is optional.
4779
4780 tab:xy The 'x' is always used, then 'y' as many times as will
4781 fit. Thus "tab:>-" displays:
4782 >
4783 >-
4784 >--
4785 etc.
4786
4787 tab:xyz The 'z' is always used, then 'x' is prepended, and
4788 then 'y' is used as many times as will fit. Thus
4789 "tab:<->" displays:
4790 >
4791 <>
4792 <->
4793 <-->
4794 etc.
4795
4796 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004797 *lcs-space*
4798 space:c Character to show for a space. When omitted, spaces
4799 are left blank.
4800 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004801 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004802 trailing spaces are blank. Overrides the "space"
4803 setting for trailing spaces.
4804 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 extends:c Character to show in the last column, when 'wrap' is
4806 off and the line continues beyond the right of the
4807 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004808 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809 precedes:c Character to show in the first column, when 'wrap'
4810 is off and there is text preceding the character
4811 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004812 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004813 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004814 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004815 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004816 nbsp:c Character to show for a non-breakable space character
4817 (0xA0 (160 decimal) and U+202F). Left blank when
4818 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004820 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004822 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823
4824 Examples: >
4825 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004826 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004827 :set lcs=extends:>,precedes:<
4828< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004829 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004830 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831
4832 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4833'loadplugins' 'lpl' boolean (default on)
4834 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 When on the plugin scripts are loaded when starting up |load-plugins|.
4836 This option can be reset in your |vimrc| file to disable the loading
4837 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004838 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4839 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840
Bram Moolenaard94464e2015-11-02 15:28:18 +01004841 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004842'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004843 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004844 {only available when compiled with the |+lua/dyn|
4845 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004846 Specifies the name of the Lua shared library. The default is
4847 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004848 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004849 This option cannot be set from a |modeline| or in the |sandbox|, for
4850 security reasons.
4851
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004852 *'macatsui'* *'nomacatsui'*
4853'macatsui' boolean (default on)
4854 global
4855 {only available in Mac GUI version}
4856 This is a workaround for when drawing doesn't work properly. When set
4857 and compiled with multi-byte support ATSUI text drawing is used. When
4858 not set ATSUI text drawing is not used. Switch this option off when
4859 you experience drawing problems. In a future version the problems may
4860 be solved and this option becomes obsolete. Therefore use this method
4861 to unset it: >
4862 if exists('&macatsui')
4863 set nomacatsui
4864 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004865< Another option to check if you have drawing problems is
4866 'termencoding'.
4867
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868 *'magic'* *'nomagic'*
4869'magic' boolean (default on)
4870 global
4871 Changes the special characters that can be used in search patterns.
4872 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004873 WARNING: Switching this option off most likely breaks plugins! That
4874 is because many patterns assume it's on and will fail when it's off.
4875 Only switch it off when working with old Vi scripts. In any other
4876 situation write patterns that work when 'magic' is on. Include "\M"
4877 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878
4879 *'makeef'* *'mef'*
4880'makeef' 'mef' string (default: "")
4881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882 {not available when compiled without the |+quickfix|
4883 feature}
4884 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4885 and the |:grep| command.
4886 When it is empty, an internally generated temp file will be used.
4887 When "##" is included, it is replaced by a number to make the name
4888 unique. This makes sure that the ":make" command doesn't overwrite an
4889 existing file.
4890 NOT used for the ":cf" command. See 'errorfile' for that.
4891 Environment variables are expanded |:set_env|.
4892 See |option-backslash| about including spaces and backslashes.
4893 This option cannot be set from a |modeline| or in the |sandbox|, for
4894 security reasons.
4895
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004896 *'makeencoding'* *'menc'*
4897'makeencoding' 'menc' string (default "")
4898 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004899 Encoding used for reading the output of external commands. When empty,
4900 encoding is not converted.
4901 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4902 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4903 and `:laddfile`.
4904
4905 This would be mostly useful when you use MS-Windows and set 'encoding'
4906 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4907 'makeencoding' to "char" has the same effect as setting to the system
4908 locale encoding. Example: >
4909 :set encoding=utf-8
4910 :set makeencoding=char " system locale is used
4911<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912 *'makeprg'* *'mp'*
4913'makeprg' 'mp' string (default "make", VMS: "MMS")
4914 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004915 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004916 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4917 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004918 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004919 Environment variables are expanded |:set_env|. See |option-backslash|
4920 about including spaces and backslashes.
4921 Note that a '|' must be escaped twice: once for ":set" and once for
4922 the interpretation of a command. When you use a filter called
4923 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004924 :set makeprg=gmake\ \\\|\ myfilter
4925< The placeholder "$*" can be given (even multiple times) to specify
4926 where the arguments will be included, for example: >
4927 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4928< This option cannot be set from a |modeline| or in the |sandbox|, for
4929 security reasons.
4930
4931 *'matchpairs'* *'mps'*
4932'matchpairs' 'mps' string (default "(:),{:},[:]")
4933 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004935 other.
4936 Only character pairs are allowed that are different, thus you cannot
4937 jump between two double quotes.
4938 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004939 The pairs must be separated by a comma. Example for including '<' and
4940 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941 :set mps+=<:>
4942
4943< A more exotic example, to jump between the '=' and ';' in an
4944 assignment, useful for languages like C and Java: >
4945 :au FileType c,cpp,java set mps+==:;
4946
4947< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01004948 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949
4950 *'matchtime'* *'mat'*
4951'matchtime' 'mat' number (default 5)
4952 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 Tenths of a second to show the matching paren, when 'showmatch' is
4954 set. Note that this is not in milliseconds, like other options that
4955 set a time. This is to be compatible with Nvi.
4956
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004957 *'maxcombine'* *'mco'*
4958'maxcombine' 'mco' number (default 2)
4959 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004960 The maximum number of combining characters supported for displaying.
4961 Only used when 'encoding' is "utf-8".
4962 The default is OK for most languages. Hebrew may require 4.
4963 Maximum value is 6.
4964 Even when this option is set to 2 you can still edit text with more
4965 combining characters, you just can't see them. Use |g8| or |ga|.
4966 See |mbyte-combining|.
4967
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 *'maxfuncdepth'* *'mfd'*
4969'maxfuncdepth' 'mfd' number (default 100)
4970 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02004971 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004972 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 Maximum depth of function calls for user functions. This normally
4974 catches endless recursion. When using a recursive function with
4975 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4976 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01004977 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02004978 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 See also |:function|.
4980
4981 *'maxmapdepth'* *'mmd'* *E223*
4982'maxmapdepth' 'mmd' number (default 1000)
4983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 Maximum number of times a mapping is done without resulting in a
4985 character to be used. This normally catches endless mappings, like
4986 ":map x y" with ":map y x". It still does not catch ":map g wg",
4987 because the 'w' is used before the next mapping is done. See also
4988 |key-mapping|.
4989
4990 *'maxmem'* *'mm'*
4991'maxmem' 'mm' number (default between 256 to 5120 (system
4992 dependent) or half the amount of memory
4993 available)
4994 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4996 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01004997 other memory to be freed.
4998 The maximum usable value is about 2000000. Use this to work without a
4999 limit.
5000 The value is ignored when 'swapfile' is off.
5001 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005002
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005003 *'maxmempattern'* *'mmp'*
5004'maxmempattern' 'mmp' number (default 1000)
5005 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005006 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005007 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005008 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005009 When Vim runs into the limit it gives an error message and mostly
5010 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005011 Running into the limit often means that the pattern is very
5012 inefficient or too complex. This may already happen with the pattern
5013 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005014 Might also happen on redraw, when syntax rules try to match a complex
5015 text structure.
5016 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5017 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005018
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 *'maxmemtot'* *'mmt'*
5020'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5021 dependent) or half the amount of memory
5022 available)
5023 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005024 Maximum amount of memory in Kbyte to use for all buffers together.
5025 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005026 without a limit.
5027 On 64 bit machines higher values might work. But hey, do you really
5028 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005029 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005030 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005031 Buffers with 'swapfile' off still count to the total amount of memory
5032 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005033 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005034
5035 *'menuitems'* *'mis'*
5036'menuitems' 'mis' number (default 25)
5037 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038 {not available when compiled without the |+menu|
5039 feature}
5040 Maximum number of items to use in a menu. Used for menus that are
5041 generated from a list of items, e.g., the Buffers menu. Changing this
5042 option has no direct effect, the menu must be refreshed first.
5043
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005044 *'mkspellmem'* *'msm'*
5045'mkspellmem' 'msm' string (default "460000,2000,500")
5046 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005047 {not available when compiled without the |+syntax|
5048 feature}
5049 Parameters for |:mkspell|. This tunes when to start compressing the
5050 word tree. Compression can be slow when there are many words, but
5051 it's needed to avoid running out of memory. The amount of memory used
5052 per word depends very much on how similar the words are, that's why
5053 this tuning is complicated.
5054
5055 There are three numbers, separated by commas:
5056 {start},{inc},{added}
5057
5058 For most languages the uncompressed word tree fits in memory. {start}
5059 gives the amount of memory in Kbyte that can be used before any
5060 compression is done. It should be a bit smaller than the amount of
5061 memory that is available to Vim.
5062
5063 When going over the {start} limit the {inc} number specifies the
5064 amount of memory in Kbyte that can be allocated before another
5065 compression is done. A low number means compression is done after
5066 less words are added, which is slow. A high number means more memory
5067 will be allocated.
5068
5069 After doing compression, {added} times 1024 words can be added before
5070 the {inc} limit is ignored and compression is done when any extra
5071 amount of memory is needed. A low number means there is a smaller
5072 chance of hitting the {inc} limit, less memory is used but it's
5073 slower.
5074
5075 The languages for which these numbers are important are Italian and
5076 Hungarian. The default works for when you have about 512 Mbyte. If
5077 you have 1 Gbyte you could use: >
5078 :set mkspellmem=900000,3000,800
5079< If you have less than 512 Mbyte |:mkspell| may fail for some
5080 languages, no matter what you set 'mkspellmem' to.
5081
Bram Moolenaar07607392019-05-26 19:20:43 +02005082 This option cannot be set from a |modeline| or in the |sandbox|.
5083
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005085'modeline' 'ml' boolean (Vim default: on (off for root),
5086 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005087 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005088 If 'modeline' is on 'modelines' gives the number of lines that is
5089 checked for set commands. If 'modeline' is off or 'modelines' is zero
5090 no lines are checked. See |modeline|.
5091
5092 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5093'modelineexpr' 'mle' boolean (default: off)
5094 global
5095 When on allow some options that are an expression to be set in the
5096 modeline. Check the option for whether it is affected by
5097 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005098 This option cannot be set from a |modeline| or in the |sandbox|, for
5099 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005100
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 *'modelines'* *'mls'*
5102'modelines' 'mls' number (default 5)
5103 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104 If 'modeline' is on 'modelines' gives the number of lines that is
5105 checked for set commands. If 'modeline' is off or 'modelines' is zero
5106 no lines are checked. See |modeline|.
5107 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5108 set and to the Vim default value when 'compatible' is reset.
5109
5110 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005111 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112'modifiable' 'ma' boolean (default on)
5113 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114 When off the buffer contents cannot be changed. The 'fileformat' and
5115 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005116 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117
5118 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5119'modified' 'mod' boolean (default off)
5120 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121 When on, the buffer is considered to be modified. This option is set
5122 when:
5123 1. A change was made to the text since it was last written. Using the
5124 |undo| command to go back to the original text will reset the
5125 option. But undoing changes that were made before writing the
5126 buffer will set the option again, since the text is different from
5127 when it was written.
5128 2. 'fileformat' or 'fileencoding' is different from its original
5129 value. The original value is set when the buffer is read or
5130 written. A ":set nomodified" command also resets the original
5131 values to the current values and the 'modified' option will be
5132 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005133 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005134 This option is not set when a change is made to the buffer as the
5135 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5136 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5137 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5139 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005140 Note that the text may actually be the same, e.g. 'modified' is set
5141 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142
5143 *'more'* *'nomore'*
5144'more' boolean (Vim default: on, Vi default: off)
5145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005146 When on, listings pause when the whole screen is filled. You will get
5147 the |more-prompt|. When this option is off there are no pauses, the
5148 listing continues until finished.
5149 NOTE: This option is set to the Vi default value when 'compatible' is
5150 set and to the Vim default value when 'compatible' is reset.
5151
5152 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005153'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5154 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005157 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5158 sysmouse and Linux console with gpm). For using the mouse in the
5159 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005160 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005161 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 v Visual mode
5163 i Insert mode
5164 c Command-line mode
5165 h all previous modes when editing a help file
5166 a all previous modes
5167 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005168 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 :set mouse=a
5170< When the mouse is not enabled, the GUI will still use the mouse for
5171 modeless selection. This doesn't move the text cursor.
5172
5173 See |mouse-using|. Also see |'clipboard'|.
5174
5175 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005176 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177 the mouse buttons can still be used by keeping the shift key pressed.
5178 Also see the 'clipboard' option.
5179
5180 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5181'mousefocus' 'mousef' boolean (default off)
5182 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 {only works in the GUI}
5184 The window that the mouse pointer is on is automatically activated.
5185 When changing the window layout or window focus in another way, the
5186 mouse pointer is moved to the window with keyboard focus. Off is the
5187 default because it makes using the pull down menus a little goofy, as
5188 a pointer transit may activate a window unintentionally.
5189
5190 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5191'mousehide' 'mh' boolean (default on)
5192 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 {only works in the GUI}
5194 When on, the mouse pointer is hidden when characters are typed.
5195 The mouse pointer is restored when the mouse is moved.
5196
5197 *'mousemodel'* *'mousem'*
5198'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5199 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 Sets the model to use for the mouse. The name mostly specifies what
5201 the right mouse button is used for:
5202 extend Right mouse button extends a selection. This works
5203 like in an xterm.
5204 popup Right mouse button pops up a menu. The shifted left
5205 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005206 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207 popup_setpos Like "popup", but the cursor will be moved to the
5208 position where the mouse was clicked, and thus the
5209 selected operation will act upon the clicked object.
5210 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005211 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212 course, that right clicking outside a selection will
5213 end Visual mode.
5214 Overview of what button does what for each model:
5215 mouse extend popup(_setpos) ~
5216 left click place cursor place cursor
5217 left drag start selection start selection
5218 shift-left search word extend selection
5219 right click extend selection popup menu (place cursor)
5220 right drag extend selection -
5221 middle click paste paste
5222
5223 In the "popup" model the right mouse button produces a pop-up menu.
5224 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005225 In a terminal the popup menu works if Vim is compiled with the
5226 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227
5228 Note that you can further refine the meaning of buttons with mappings.
5229 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5230 selection (because that's handled in the GUI code directly).
5231
5232 The 'mousemodel' option is set by the |:behave| command.
5233
5234 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005235'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5236 vs:leftright,vd:lrsizing,m:no,
5237 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005239 {only available when compiled with the |+mouseshape|
5240 feature}
5241 This option tells Vim what the mouse pointer should look like in
5242 different modes. The option is a comma separated list of parts, much
5243 like used for 'guicursor'. Each part consist of a mode/location-list
5244 and an argument-list:
5245 mode-list:shape,mode-list:shape,..
5246 The mode-list is a dash separated list of these modes/locations:
5247 In a normal window: ~
5248 n Normal mode
5249 v Visual mode
5250 ve Visual mode with 'selection' "exclusive" (same as 'v',
5251 if not specified)
5252 o Operator-pending mode
5253 i Insert mode
5254 r Replace mode
5255
5256 Others: ~
5257 c appending to the command-line
5258 ci inserting in the command-line
5259 cr replacing in the command-line
5260 m at the 'Hit ENTER' or 'More' prompts
5261 ml idem, but cursor in the last line
5262 e any mode, pointer below last window
5263 s any mode, pointer on a status line
5264 sd any mode, while dragging a status line
5265 vs any mode, pointer on a vertical separator line
5266 vd any mode, while dragging a vertical separator line
5267 a everywhere
5268
5269 The shape is one of the following:
5270 avail name looks like ~
5271 w x arrow Normal mouse pointer
5272 w x blank no pointer at all (use with care!)
5273 w x beam I-beam
5274 w x updown up-down sizing arrows
5275 w x leftright left-right sizing arrows
5276 w x busy The system's usual busy pointer
5277 w x no The system's usual 'no input' pointer
5278 x udsizing indicates up-down resizing
5279 x lrsizing indicates left-right resizing
5280 x crosshair like a big thin +
5281 x hand1 black hand
5282 x hand2 white hand
5283 x pencil what you write with
5284 x question big ?
5285 x rightup-arrow arrow pointing right-up
5286 w x up-arrow arrow pointing up
5287 x <number> any X11 pointer number (see X11/cursorfont.h)
5288
5289 The "avail" column contains a 'w' if the shape is available for Win32,
5290 x for X11.
5291 Any modes not specified or shapes not available use the normal mouse
5292 pointer.
5293
5294 Example: >
5295 :set mouseshape=s:udsizing,m:no
5296< will make the mouse turn to a sizing arrow over the status lines and
5297 indicate no input when the hit-enter prompt is displayed (since
5298 clicking the mouse has no effect in this state.)
5299
5300 *'mousetime'* *'mouset'*
5301'mousetime' 'mouset' number (default 500)
5302 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5304 time in msec between two mouse clicks for the second click to be
5305 recognized as a multi click.
5306
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005307 *'mzschemedll'*
5308'mzschemedll' 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 shared library. The default is
5313 DYNAMIC_MZSCH_DLL which was specified at compile time.
5314 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005315 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005316 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005317 This option cannot be set from a |modeline| or in the |sandbox|, for
5318 security reasons.
5319
5320 *'mzschemegcdll'*
5321'mzschemegcdll' string (default depends on the build)
5322 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005323 {only available when compiled with the |+mzscheme/dyn|
5324 feature}
5325 Specifies the name of the MzScheme GC shared library. The default is
5326 DYNAMIC_MZGC_DLL which was specified at compile time.
5327 The value can be equal to 'mzschemedll' if it includes the GC code.
5328 Environment variables are expanded |:set_env|.
5329 This option cannot be set from a |modeline| or in the |sandbox|, for
5330 security reasons.
5331
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005332 *'mzquantum'* *'mzq'*
5333'mzquantum' 'mzq' number (default 100)
5334 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005335 {not available when compiled without the |+mzscheme|
5336 feature}
5337 The number of milliseconds between polls for MzScheme threads.
5338 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005339 NOTE: This option is set to the Vim default value when 'compatible'
5340 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005341
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005343'nrformats' 'nf' string (default "bin,octal,hex",
5344 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005345 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346 This defines what bases Vim will consider for numbers when using the
5347 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5348 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005349 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005351 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005352 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005354 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 considered to be hexadecimal. Example: Using CTRL-X on
5356 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005357 bin If included, numbers starting with "0b" or "0B" will be
5358 considered to be binary. Example: Using CTRL-X on
5359 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360 Numbers which simply begin with a digit in the range 1-9 are always
5361 considered decimal. This also happens for numbers that are not
5362 recognized as octal or hex.
5363
5364 *'number'* *'nu'* *'nonumber'* *'nonu'*
5365'number' 'nu' boolean (default off)
5366 local to window
5367 Print the line number in front of each line. When the 'n' option is
5368 excluded from 'cpoptions' a wrapped line will not use the column of
5369 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005370 The 'numberwidth' option can be used to set the room used for the line
5371 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 When a long, wrapped line doesn't start with the first character, '-'
5373 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005374 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5375 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005376 *number_relativenumber*
5377 The 'relativenumber' option changes the displayed number to be
5378 relative to the cursor. Together with 'number' there are these
5379 four combinations (cursor in line 3):
5380
Bram Moolenaar3848e002016-03-19 18:42:29 +01005381 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005382 'nornu' 'nornu' 'rnu' 'rnu'
5383
5384 |apple | 1 apple | 2 apple | 2 apple
5385 |pear | 2 pear | 1 pear | 1 pear
5386 |nobody | 3 nobody | 0 nobody |3 nobody
5387 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005389 *'numberwidth'* *'nuw'*
5390'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5391 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005392 {only available when compiled with the |+linebreak|
5393 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005394 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005395 when the 'number' or 'relativenumber' option is set or printing lines
5396 with a line number. Since one space is always between the number and
5397 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005398 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005399 fit the highest line number in the buffer respectively the number of
5400 rows in the window, depending on whether 'number' or 'relativenumber'
5401 is set. Thus with the Vim default of 4 there is room for a line number
5402 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005403 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005404 NOTE: This option is set to the Vi default value when 'compatible' is
5405 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005406
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005407 *'omnifunc'* *'ofu'*
5408'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005409 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005410 {not available when compiled without the |+eval|
5411 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005412 This option specifies a function to be used for Insert mode omni
5413 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005414 See |complete-functions| for an explanation of how the function is
5415 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005416 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005417 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005418 This option cannot be set from a |modeline| or in the |sandbox|, for
5419 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005420
5421
Bram Moolenaar02467872007-05-06 13:22:01 +00005422 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005423'opendevice' 'odev' boolean (default off)
5424 global
Bram Moolenaar043545e2006-10-10 16:44:07 +00005425 {only for MS-DOS, MS-Windows and OS/2}
5426 Enable reading and writing from devices. This may get Vim stuck on a
5427 device that can be opened but doesn't actually do the I/O. Therefore
5428 it is off by default.
5429 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5430 result in editing a device.
5431
5432
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005433 *'operatorfunc'* *'opfunc'*
5434'operatorfunc' 'opfunc' string (default: empty)
5435 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005436 This option specifies a function to be called by the |g@| operator.
5437 See |:map-operator| for more info and an example.
5438
5439 This option cannot be set from a |modeline| or in the |sandbox|, for
5440 security reasons.
5441
5442
Bram Moolenaar251e1912011-06-19 05:09:16 +02005443 *'osfiletype'* *'oft'*
5444'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005446 This option was supported on RISC OS, which has been removed.
5447
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005449 *'packpath'* *'pp'*
5450'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005451 Directories used to find packages. See |packages|.
5452
5453
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005455'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456 global
5457 Specifies the nroff macros that separate paragraphs. These are pairs
5458 of two letters (see |object-motions|).
5459
5460 *'paste'* *'nopaste'*
5461'paste' boolean (default off)
5462 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005463 Put Vim in Paste mode. This is useful if you want to cut or copy
5464 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 unexpected effects.
5466 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005467 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468 knows about pasting and will mostly do the right thing without 'paste'
5469 being set. The same is true for a terminal where Vim handles the
5470 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005471 This option is reset when starting the GUI. Thus if you set it in
5472 your .vimrc it will work in a terminal, but not in the GUI. Setting
5473 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5474 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475 When the 'paste' option is switched on (also when it was already on):
5476 - mapping in Insert mode and Command-line mode is disabled
5477 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005478 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005479 - 'expandtab' is reset
5480 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 - 'revins' is reset
5482 - 'ruler' is reset
5483 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005484 - 'smartindent' is reset
5485 - 'smarttab' is reset
5486 - 'softtabstop' is set to 0
5487 - 'textwidth' is set to 0
5488 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005491 - 'indentexpr'
5492 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493 NOTE: When you start editing another file while the 'paste' option is
5494 on, settings from the modelines or autocommands may change the
5495 settings again, causing trouble when pasting text. You might want to
5496 set the 'paste' option again.
5497 When the 'paste' option is reset the mentioned options are restored to
5498 the value before the moment 'paste' was switched from off to on.
5499 Resetting 'paste' before ever setting it does not have any effect.
5500 Since mapping doesn't work while 'paste' is active, you need to use
5501 the 'pastetoggle' option to toggle the 'paste' option with some key.
5502
5503 *'pastetoggle'* *'pt'*
5504'pastetoggle' 'pt' string (default "")
5505 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506 When non-empty, specifies the key sequence that toggles the 'paste'
5507 option. This is like specifying a mapping: >
5508 :map {keys} :set invpaste<CR>
5509< Where {keys} is the value of 'pastetoggle'.
5510 The difference is that it will work even when 'paste' is set.
5511 'pastetoggle' works in Insert mode and Normal mode, but not in
5512 Command-line mode.
5513 Mappings are checked first, thus overrule 'pastetoggle'. However,
5514 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5515 this: >
5516 :map <F10> :set paste<CR>
5517 :map <F11> :set nopaste<CR>
5518 :imap <F10> <C-O>:set paste<CR>
5519 :imap <F11> <nop>
5520 :set pastetoggle=<F11>
5521< This will make <F10> start paste mode and <F11> stop paste mode.
5522 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5523 mode everything is inserted literally, except the 'pastetoggle' key
5524 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005525 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526
5527 *'pex'* *'patchexpr'*
5528'patchexpr' 'pex' string (default "")
5529 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530 {not available when compiled without the |+diff|
5531 feature}
5532 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005533 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534
Bram Moolenaardbc28022014-07-26 13:40:44 +02005535 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005536'patchmode' 'pm' string (default "")
5537 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005538 When non-empty the oldest version of a file is kept. This can be used
5539 to keep the original version of a file if you are changing files in a
5540 source distribution. Only the first time that a file is written a
5541 copy of the original file will be kept. The name of the copy is the
5542 name of the original file with the string in the 'patchmode' option
5543 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005544 ".orig" or ".org". 'backupdir' must not be empty for this to work
5545 (Detail: The backup file is renamed to the patchmode file after the
5546 new file has been successfully written, that's why it must be possible
5547 to write a backup file). If there was no file to be backed up, an
5548 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 When the 'backupskip' pattern matches, a patchmode file is not made.
5550 Using 'patchmode' for compressed files appends the extension at the
5551 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5552 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005553 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005554
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005555 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556'path' 'pa' string (default on Unix: ".,/usr/include,,"
5557 on OS/2: ".,/emx/include,,"
5558 other systems: ".,,")
5559 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005561 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5562 provided that the file being searched for has a relative path (not
5563 starting with "/", "./" or "../"). The directories in the 'path'
5564 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 - Use commas to separate directory names: >
5566 :set path=.,/usr/local/include,/usr/include
5567< - Spaces can also be used to separate directory names (for backwards
5568 compatibility with version 3.0). To have a space in a directory
5569 name, precede it with an extra backslash, and escape the space: >
5570 :set path=.,/dir/with\\\ space
5571< - To include a comma in a directory name precede it with an extra
5572 backslash: >
5573 :set path=.,/dir/with\\,comma
5574< - To search relative to the directory of the current file, use: >
5575 :set path=.
5576< - To search in the current directory use an empty string between two
5577 commas: >
5578 :set path=,,
5579< - A directory name may end in a ':' or '/'.
5580 - Environment variables are expanded |:set_env|.
5581 - When using |netrw.vim| URLs can be used. For example, adding
5582 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005583 - Search upwards and downwards in a directory tree using "*", "**" and
5584 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 {not available when compiled without the |+path_extra| feature}
5586 - Careful with '\' characters, type two to get one in the option: >
5587 :set path=.,c:\\include
5588< Or just use '/' instead: >
5589 :set path=.,c:/include
5590< Don't forget "." or files won't even be found in the same directory as
5591 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005592 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593 it is something like 256 or 1024 characters.
5594 You can check if all the include files are found, using the value of
5595 'path', see |:checkpath|.
5596 The use of |:set+=| and |:set-=| is preferred when adding or removing
5597 directories from the list. This avoids problems when a future version
5598 uses another default. To remove the current directory use: >
5599 :set path-=
5600< To add the current directory use: >
5601 :set path+=
5602< To use an environment variable, you probably need to replace the
5603 separator. Here is an example to append $INCL, in which directory
5604 names are separated with a semi-colon: >
5605 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5606< Replace the ';' with a ':' or whatever separator is used. Note that
5607 this doesn't work when $INCL contains a comma or white space.
5608
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005609 *'perldll'*
5610'perldll' string (default depends on the build)
5611 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005612 {only available when compiled with the |+perl/dyn|
5613 feature}
5614 Specifies the name of the Perl shared library. The default is
5615 DYNAMIC_PERL_DLL, which was specified at compile time.
5616 Environment variables are expanded |:set_env|.
5617 This option cannot be set from a |modeline| or in the |sandbox|, for
5618 security reasons.
5619
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5621'preserveindent' 'pi' boolean (default off)
5622 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623 When changing the indent of the current line, preserve as much of the
5624 indent structure as possible. Normally the indent is replaced by a
5625 series of tabs followed by spaces as required (unless |'expandtab'| is
5626 enabled, in which case only spaces are used). Enabling this option
5627 means the indent will preserve as many existing characters as possible
5628 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005629 'expandtab' does not apply to the preserved white space, a Tab remains
5630 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 NOTE: When using ">>" multiple times the resulting indent is a mix of
5632 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005633 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634 Also see 'copyindent'.
5635 Use |:retab| to clean up white space.
5636
5637 *'previewheight'* *'pvh'*
5638'previewheight' 'pvh' number (default 12)
5639 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005640 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005641 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005643 commands. Used for |CTRL-W_}| when no count is given. Not used when
5644 'previewpopup' is set.
5645
5646 *'previewpopup'* *'pvp'*
5647'previewpopup' 'pvp' string (default empty)
5648 global
5649 {not available when compiled without the |+windows|,
5650 |+textprop| or |+quickfix| feature}
5651 When not empty a popup window is used for commands that would open a
5652 preview window. See |preview-popup|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653
5654 *'previewwindow'* *'nopreviewwindow'*
5655 *'pvw'* *'nopvw'* *E590*
5656'previewwindow' 'pvw' boolean (default off)
5657 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005659 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005660 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661 set. It's normally not set directly, but by using one of the commands
5662 |:ptag|, |:pedit|, etc.
5663
5664 *'printdevice'* *'pdev'*
5665'printdevice' 'pdev' string (default empty)
5666 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 {only available when compiled with the |+printer|
5668 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005669 The name of the printer to be used for |:hardcopy|.
5670 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005671 This option cannot be set from a |modeline| or in the |sandbox|, for
5672 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673
Bram Moolenaar8299df92004-07-10 09:47:34 +00005674 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005675'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005677 {only available when compiled with the |+printer|
5678 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005679 Sets the character encoding used when printing.
5680 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681
5682 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005683'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 {only available when compiled with the |+printer|
5686 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005687 Expression used to print the PostScript produced with |:hardcopy|.
5688 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005689 This option cannot be set from a |modeline| or in the |sandbox|, for
5690 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691
Bram Moolenaar8299df92004-07-10 09:47:34 +00005692 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693'printfont' 'pfn' string (default "courier")
5694 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 {only available when compiled with the |+printer|
5696 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005697 The name of the font that will be used for |:hardcopy|.
5698 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699
5700 *'printheader'* *'pheader'*
5701'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5702 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 {only available when compiled with the |+printer|
5704 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005705 The format of the header produced in |:hardcopy| output.
5706 See |pheader-option|.
5707
5708 *'printmbcharset'* *'pmbcs'*
5709'printmbcharset' 'pmbcs' string (default "")
5710 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005711 {only available when compiled with the |+printer|
5712 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005713 The CJK character set to be used for CJK output from |:hardcopy|.
5714 See |pmbcs-option|.
5715
5716 *'printmbfont'* *'pmbfn'*
5717'printmbfont' 'pmbfn' string (default "")
5718 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005719 {only available when compiled with the |+printer|
5720 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005721 List of font names to be used for CJK output from |:hardcopy|.
5722 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723
5724 *'printoptions'* *'popt'*
5725'printoptions' 'popt' string (default "")
5726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005728 List of items that control the format of the output of |:hardcopy|.
5729 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005731 *'prompt'* *'noprompt'*
5732'prompt' boolean (default on)
5733 global
5734 When on a ":" prompt is used in Ex mode.
5735
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005736 *'pumheight'* *'ph'*
5737'pumheight' 'ph' number (default 0)
5738 global
5739 {not available when compiled without the
5740 |+insert_expand| feature}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005741 Determines the maximum number of items to show in the popup menu for
5742 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005743 |ins-completion-menu|.
5744
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005745 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005746'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005747 global
5748 {not available when compiled without the
5749 |+insert_expand| feature}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005750 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005751 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005752
Bram Moolenaard94464e2015-11-02 15:28:18 +01005753 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005754'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005755 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005756 {only available when compiled with the |+python/dyn|
5757 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005758 Specifies the name of the Python 2.x shared library. The default is
5759 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005760 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005761 This option cannot be set from a |modeline| or in the |sandbox|, for
5762 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005763
Bram Moolenaar94073162018-01-31 21:49:05 +01005764 *'pythonhome'*
5765'pythonhome' string (default "")
5766 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005767 {only available when compiled with the |+python/dyn|
5768 feature}
5769 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5770 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5771 which was specified at compile time, will be used for the Python 2.x
5772 home directory.
5773 Environment variables are expanded |:set_env|.
5774 This option cannot be set from a |modeline| or in the |sandbox|, for
5775 security reasons.
5776
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005777 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005778'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005779 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005780 {only available when compiled with the |+python3/dyn|
5781 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005782 Specifies the name of the Python 3 shared library. The default is
5783 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005784 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005785 This option cannot be set from a |modeline| or in the |sandbox|, for
5786 security reasons.
5787
Bram Moolenaar94073162018-01-31 21:49:05 +01005788 *'pythonthreehome'*
5789'pythonthreehome' string (default "")
5790 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005791 {only available when compiled with the |+python3/dyn|
5792 feature}
5793 Specifies the name of the Python 3 home directory. When
5794 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5795 PYTHON3_HOME, which was specified at compile time, will be used for
5796 the Python 3 home directory.
5797 Environment variables are expanded |:set_env|.
5798 This option cannot be set from a |modeline| or in the |sandbox|, for
5799 security reasons.
5800
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005801 *'pyxversion'* *'pyx'*
5802'pyxversion' 'pyx' number (default depends on the build)
5803 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005804 {only available when compiled with the |+python| or
5805 the |+python3| feature}
5806 Specifies the python version used for pyx* functions and commands
5807 |python_x|. The default value is as follows:
5808
5809 Compiled with Default ~
5810 |+python| and |+python3| 0
5811 only |+python| 2
5812 only |+python3| 3
5813
5814 Available values are 0, 2 and 3.
5815 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5816 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5817 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5818 to 2 if Python 2 is available.
5819 See also: |has-pythonx|
5820
5821 If Vim is compiled with only |+python| or |+python3| setting
5822 'pyxversion' has no effect. The pyx* functions and commands are
5823 always the same as the compiled version.
5824
5825 This option cannot be set from a |modeline| or in the |sandbox|, for
5826 security reasons.
5827
Bram Moolenaar677ee682005-01-27 14:41:15 +00005828 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005829'quoteescape' 'qe' string (default "\")
5830 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005831 The characters that are used to escape quotes in a string. Used for
5832 objects like a', a" and a` |a'|.
5833 When one of the characters in this option is found inside a string,
5834 the following character will be skipped. The default value makes the
5835 text "foo\"bar\\" considered to be one string.
5836
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5838'readonly' 'ro' boolean (default off)
5839 local to buffer
5840 If on, writes fail unless you use a '!'. Protects you from
5841 accidentally overwriting a file. Default on when Vim is started
5842 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005843 When using ":w!" the 'readonly' option is reset for the current
5844 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005845 When using the ":view" command the 'readonly' option is set for the
5846 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005847 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005848
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005849 *'redrawtime'* *'rdt'*
5850'redrawtime' 'rdt' number (default 2000)
5851 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005852 {only available when compiled with the |+reltime|
5853 feature}
5854 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005855 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005856 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005857 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005858 matches will be highlighted.
5859 For syntax highlighting the time applies per window. When over the
5860 limit syntax highlighting is disabled until |CTRL-L| is used.
5861 This is used to avoid that Vim hangs when using a very complicated
5862 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005863
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005864 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005865'regexpengine' 're' number (default 0)
5866 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005867 This selects the default regexp engine. |two-engines|
5868 The possible values are:
5869 0 automatic selection
5870 1 old engine
5871 2 NFA engine
5872 Note that when using the NFA engine and the pattern contains something
5873 that is not supported the pattern will not match. This is only useful
5874 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005875 Using automatic selection enables Vim to switch the engine, if the
5876 default engine becomes too costly. E.g., when the NFA engine uses too
5877 many states. This should prevent Vim from hanging on a combination of
5878 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005879
Bram Moolenaar64486672010-05-16 15:46:46 +02005880 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5881'relativenumber' 'rnu' boolean (default off)
5882 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005883 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005884 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005885 precede some vertical motion commands (e.g. j k + -) with, without
5886 having to calculate it yourself. Especially useful in combination with
5887 other commands (e.g. y d c < > gq gw =).
5888 When the 'n' option is excluded from 'cpoptions' a wrapped
5889 line will not use the column of line numbers (this is the default when
5890 'compatible' isn't set).
5891 The 'numberwidth' option can be used to set the room used for the line
5892 number.
5893 When a long, wrapped line doesn't start with the first character, '-'
5894 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005895 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5896 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005897
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005898 The number in front of the cursor line also depends on the value of
5899 'number', see |number_relativenumber| for all combinations of the two
5900 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005901
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902 *'remap'* *'noremap'*
5903'remap' boolean (default on)
5904 global
5905 Allows for mappings to work recursively. If you do not want this for
5906 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005907 NOTE: To avoid portability problems with Vim scripts, always keep
5908 this option at the default "on". Only switch it off when working with
5909 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005911 *'renderoptions'* *'rop'*
5912'renderoptions' 'rop' string (default: empty)
5913 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005914 {only available when compiled with GUI and DIRECTX on
5915 MS-Windows}
5916 Select a text renderer and set its options. The options depend on the
5917 renderer.
5918
5919 Syntax: >
5920 set rop=type:{renderer}(,{name}:{value})*
5921<
5922 Currently, only one optional renderer is available.
5923
5924 render behavior ~
5925 directx Vim will draw text using DirectX (DirectWrite). It makes
5926 drawn glyphs more beautiful than default GDI.
5927 It requires 'encoding' is "utf-8", and only works on
5928 MS-Windows Vista or newer version.
5929
5930 Options:
5931 name meaning type value ~
5932 gamma gamma float 1.0 - 2.2 (maybe)
5933 contrast enhancedContrast float (unknown)
5934 level clearTypeLevel float (unknown)
5935 geom pixelGeometry int 0 - 2 (see below)
5936 renmode renderingMode int 0 - 6 (see below)
5937 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01005938 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005939
Bram Moolenaar92467d32017-12-05 13:22:16 +01005940 See this URL for detail (except for scrlines):
5941 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005942
5943 For geom: structure of a device pixel.
5944 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5945 1 - DWRITE_PIXEL_GEOMETRY_RGB
5946 2 - DWRITE_PIXEL_GEOMETRY_BGR
5947
5948 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005949 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005950
5951 For renmode: method of rendering glyphs.
5952 0 - DWRITE_RENDERING_MODE_DEFAULT
5953 1 - DWRITE_RENDERING_MODE_ALIASED
5954 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5955 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5956 4 - DWRITE_RENDERING_MODE_NATURAL
5957 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5958 6 - DWRITE_RENDERING_MODE_OUTLINE
5959
5960 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005961 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005962
5963 For taamode: antialiasing mode used for drawing text.
5964 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5965 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5966 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5967 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5968
5969 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005970 https://msdn.microsoft.com/en-us/library/dd368170.aspx
5971
Bram Moolenaara338adc2018-01-31 20:51:47 +01005972 For scrlines:
5973 This was used for optimizing scrolling behavior, however this
5974 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005975
5976 Example: >
5977 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005978 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005979 set rop=type:directx
5980<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005981 If select a raster font (Courier, Terminal or FixedSys which
5982 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01005983 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005984
5985 NOTE: It is known that some fonts and options combination
5986 causes trouble on drawing glyphs.
5987
Bram Moolenaar92467d32017-12-05 13:22:16 +01005988 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005989 special made fonts (True-Type fonts which includes only
5990 bitmap glyphs).
5991 - 'taamode:3' will not work with some vector fonts.
5992
5993 NOTE: With this option, you can display colored emoji
5994 (emoticon) in Windows 8.1 or later. To display colored emoji,
5995 there are some conditions which you should notice.
5996
5997 - If your font includes non-colored emoji already, it will
5998 be used.
5999 - If your font doesn't have emoji, the system chooses an
6000 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6001 will be used.
6002 - When this alternative font didn't have fixed width glyph,
6003 emoji might be rendered beyond the bounding box of drawing
6004 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006005
6006 Other render types are currently not supported.
6007
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 *'report'*
6009'report' number (default 2)
6010 global
6011 Threshold for reporting number of lines changed. When the number of
6012 changed lines is more than 'report' a message will be given for most
6013 ":" commands. If you want it always, set 'report' to 0.
6014 For the ":substitute" command the number of substitutions is used
6015 instead of the number of lines.
6016
6017 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6018'restorescreen' 'rs' boolean (default on)
6019 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006020 {only in Windows 95/NT console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006021 When set, the screen contents is restored when exiting Vim. This also
6022 happens when executing external commands.
6023
6024 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6025 options in your .vimrc. To disable restoring:
6026 set t_ti= t_te=
6027 To enable restoring (for an xterm):
6028 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6029 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6030
6031 *'revins'* *'ri'* *'norevins'* *'nori'*
6032'revins' 'ri' boolean (default off)
6033 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006034 {only available when compiled with the |+rightleft|
6035 feature}
6036 Inserting characters in Insert mode will work backwards. See "typing
6037 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6038 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006039 NOTE: This option is reset when 'compatible' is set.
6040 This option is reset when 'paste' is set and restored when 'paste' is
6041 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042
6043 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6044'rightleft' 'rl' boolean (default off)
6045 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 {only available when compiled with the |+rightleft|
6047 feature}
6048 When on, display orientation becomes right-to-left, i.e., characters
6049 that are stored in the file appear from the right to the left.
6050 Using this option, it is possible to edit files for languages that
6051 are written from the right to the left such as Hebrew and Arabic.
6052 This option is per window, so it is possible to edit mixed files
6053 simultaneously, or to view the same file in both ways (this is
6054 useful whenever you have a mixed text file with both right-to-left
6055 and left-to-right strings so that both sets are displayed properly
6056 in different windows). Also see |rileft.txt|.
6057
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006058 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059'rightleftcmd' 'rlc' string (default "search")
6060 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061 {only available when compiled with the |+rightleft|
6062 feature}
6063 Each word in this option enables the command line editing to work in
6064 right-to-left mode for a group of commands:
6065
6066 search "/" and "?" commands
6067
6068 This is useful for languages such as Hebrew, Arabic and Farsi.
6069 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6070
Bram Moolenaard94464e2015-11-02 15:28:18 +01006071 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006072'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006073 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006074 {only available when compiled with the |+ruby/dyn|
6075 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006076 Specifies the name of the Ruby shared library. The default is
6077 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006078 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006079 This option cannot be set from a |modeline| or in the |sandbox|, for
6080 security reasons.
6081
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006083'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 {not available when compiled without the
6086 |+cmdline_info| feature}
6087 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006088 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089 text in the file is shown on the far right:
6090 Top first line is visible
6091 Bot last line is visible
6092 All first and last line are visible
6093 45% relative position in the file
6094 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006095 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006097 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 this option takes precedence over 'ruler' and 'rulerformat'
6099 If the number of characters displayed is different from the number of
6100 bytes in the text (e.g., for a TAB or a multi-byte character), both
6101 the text column (byte number) and the screen column are shown,
6102 separated with a dash.
6103 For an empty line "0-1" is shown.
6104 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006105 This option is reset when 'paste' is set and restored when 'paste' is
6106 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006107 If you don't want to see the ruler all the time but want to know where
6108 you are, use "g CTRL-G" |g_CTRL-G|.
6109 NOTE: This option is reset when 'compatible' is set.
6110
6111 *'rulerformat'* *'ruf'*
6112'rulerformat' 'ruf' string (default empty)
6113 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 {not available when compiled without the |+statusline|
6115 feature}
6116 When this option is not empty, it determines the content of the ruler
6117 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006118 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006119 This option cannot be set in a modeline when 'modelineexpr' is off.
6120
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 The default ruler width is 17 characters. To make the ruler 15
6122 characters wide, put "%15(" at the start and "%)" at the end.
6123 Example: >
6124 :set rulerformat=%15(%c%V\ %p%%%)
6125<
6126 *'runtimepath'* *'rtp'* *vimfiles*
6127'runtimepath' 'rtp' string (default:
6128 Unix: "$HOME/.vim,
6129 $VIM/vimfiles,
6130 $VIMRUNTIME,
6131 $VIM/vimfiles/after,
6132 $HOME/.vim/after"
6133 Amiga: "home:vimfiles,
6134 $VIM/vimfiles,
6135 $VIMRUNTIME,
6136 $VIM/vimfiles/after,
6137 home:vimfiles/after"
6138 PC, OS/2: "$HOME/vimfiles,
6139 $VIM/vimfiles,
6140 $VIMRUNTIME,
6141 $VIM/vimfiles/after,
6142 $HOME/vimfiles/after"
6143 Macintosh: "$VIM:vimfiles,
6144 $VIMRUNTIME,
6145 $VIM:vimfiles:after"
6146 RISC-OS: "Choices:vimfiles,
6147 $VIMRUNTIME,
6148 Choices:vimfiles/after"
6149 VMS: "sys$login:vimfiles,
6150 $VIM/vimfiles,
6151 $VIMRUNTIME,
6152 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006153 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006155 This is a list of directories which will be searched for runtime
6156 files:
6157 filetype.vim filetypes by file name |new-filetype|
6158 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006159 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006160 colors/ color scheme files |:colorscheme|
6161 compiler/ compiler files |:compiler|
6162 doc/ documentation |write-local-help|
6163 ftplugin/ filetype plugins |write-filetype-plugin|
6164 indent/ indent scripts |indent-expression|
6165 keymap/ key mapping files |mbyte-keymap|
6166 lang/ menu translations |:menutrans|
6167 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006168 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006169 plugin/ plugin scripts |write-plugin|
6170 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006171 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 syntax/ syntax files |mysyntaxfile|
6173 tutor/ files for vimtutor |tutor|
6174
6175 And any other file searched for with the |:runtime| command.
6176
6177 The defaults for most systems are setup to search five locations:
6178 1. In your home directory, for your personal preferences.
6179 2. In a system-wide Vim directory, for preferences from the system
6180 administrator.
6181 3. In $VIMRUNTIME, for files distributed with Vim.
6182 *after-directory*
6183 4. In the "after" directory in the system-wide Vim directory. This is
6184 for the system administrator to overrule or add to the distributed
6185 defaults (rarely needed)
6186 5. In the "after" directory in your home directory. This is for
6187 personal preferences to overrule or add to the distributed defaults
6188 or system-wide settings (rarely needed).
6189
Bram Moolenaard0796902016-09-16 20:02:31 +02006190 More entries are added when using |packages|. If it gets very long
6191 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6192 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006193
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6195 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006196 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 wildcards.
6198 See |:runtime|.
6199 Example: >
6200 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6201< This will use the directory "~/vimruntime" first (containing your
6202 personal Vim runtime files), then "/mygroup/vim" (shared between a
6203 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6204 files).
6205 You probably should always include $VIMRUNTIME somewhere, to use the
6206 distributed runtime files. You can put a directory before $VIMRUNTIME
6207 to find files which replace a distributed runtime files. You can put
6208 a directory after $VIMRUNTIME to find files which add to distributed
6209 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006210 When Vim is started with |--clean| the home directory entries are not
6211 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212 This option cannot be set from a |modeline| or in the |sandbox|, for
6213 security reasons.
6214
6215 *'scroll'* *'scr'*
6216'scroll' 'scr' number (default: half the window height)
6217 local to window
6218 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6219 set to half the number of lines in the window when the window size
6220 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006221 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006222 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223
6224 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6225'scrollbind' 'scb' boolean (default off)
6226 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227 See also |scroll-binding|. When this option is set, the current
6228 window scrolls as other scrollbind windows (windows that also have
6229 this option set) scroll. This option is useful for viewing the
6230 differences between two versions of a file, see 'diff'.
6231 See |'scrollopt'| for options that determine how this option should be
6232 interpreted.
6233 This option is mostly reset when splitting a window to edit another
6234 file. This means that ":split | edit file" results in two windows
6235 with scroll-binding, but ":split file" does not.
6236
6237 *'scrolljump'* *'sj'*
6238'scrolljump' 'sj' number (default 1)
6239 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006240 Minimal number of lines to scroll when the cursor gets off the
6241 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6242 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006243 When set to a negative number from -1 to -100 this is used as the
6244 percentage of the window height. Thus -50 scrolls half the window
6245 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246 NOTE: This option is set to 1 when 'compatible' is set.
6247
6248 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006249'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006250 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 Minimal number of screen lines to keep above and below the cursor.
6252 This will make some context visible around where you are working. If
6253 you set it to a very large value (999) the cursor line will always be
6254 in the middle of the window (except at the start or end of the file or
6255 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006256 After using the local value, go back the global value with one of
6257 these two: >
6258 setlocal scrolloff<
6259 setlocal scrolloff=-1
6260< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 NOTE: This option is set to 0 when 'compatible' is set.
6262
6263 *'scrollopt'* *'sbo'*
6264'scrollopt' 'sbo' string (default "ver,jump")
6265 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006267 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6268 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269 The following words are available:
6270 ver Bind vertical scrolling for 'scrollbind' windows
6271 hor Bind horizontal scrolling for 'scrollbind' windows
6272 jump Applies to the offset between two windows for vertical
6273 scrolling. This offset is the difference in the first
6274 displayed line of the bound windows. When moving
6275 around in a window, another 'scrollbind' window may
6276 reach a position before the start or after the end of
6277 the buffer. The offset is not changed though, when
6278 moving back the 'scrollbind' window will try to scroll
6279 to the desired position when possible.
6280 When now making that window the current one, two
6281 things can be done with the relative offset:
6282 1. When "jump" is not included, the relative offset is
6283 adjusted for the scroll position in the new current
6284 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006285 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006286 2. When "jump" is included, the other windows are
6287 scrolled to keep the same relative offset. When
6288 going back to the other window, it still uses the
6289 same relative offset.
6290 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006291 When 'diff' mode is active there always is vertical scroll binding,
6292 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293
6294 *'sections'* *'sect'*
6295'sections' 'sect' string (default "SHNHH HUnhsh")
6296 global
6297 Specifies the nroff macros that separate sections. These are pairs of
6298 two letters (See |object-motions|). The default makes a section start
6299 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6300
6301 *'secure'* *'nosecure'* *E523*
6302'secure' boolean (default off)
6303 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 When on, ":autocmd", shell and write commands are not allowed in
6305 ".vimrc" and ".exrc" in the current directory and map commands are
6306 displayed. Switch it off only if you know that you will not run into
6307 problems, or when the 'exrc' option is off. On Unix this option is
6308 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006309 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310 'secure' at the end of your ~/.vimrc then.
6311 This option cannot be set from a |modeline| or in the |sandbox|, for
6312 security reasons.
6313
6314 *'selection'* *'sel'*
6315'selection' 'sel' string (default "inclusive")
6316 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 This option defines the behavior of the selection. It is only used
6318 in Visual and Select mode.
6319 Possible values:
6320 value past line inclusive ~
6321 old no yes
6322 inclusive yes yes
6323 exclusive yes no
6324 "past line" means that the cursor is allowed to be positioned one
6325 character past the line.
6326 "inclusive" means that the last character of the selection is included
6327 in an operation. For example, when "x" is used to delete the
6328 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006329 When "old" is used and 'virtualedit' allows the cursor to move past
6330 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331 Note that when "exclusive" is used and selecting from the end
6332 backwards, you cannot include the last character of a line, when
6333 starting in Normal mode and 'virtualedit' empty.
6334
6335 The 'selection' option is set by the |:behave| command.
6336
6337 *'selectmode'* *'slm'*
6338'selectmode' 'slm' string (default "")
6339 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340 This is a comma separated list of words, which specifies when to start
6341 Select mode instead of Visual mode, when a selection is started.
6342 Possible values:
6343 mouse when using the mouse
6344 key when using shifted special keys
6345 cmd when using "v", "V" or CTRL-V
6346 See |Select-mode|.
6347 The 'selectmode' option is set by the |:behave| command.
6348
6349 *'sessionoptions'* *'ssop'*
6350'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006351 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006353 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354 feature}
6355 Changes the effect of the |:mksession| command. It is a comma
6356 separated list of words. Each word enables saving and restoring
6357 something:
6358 word save and restore ~
6359 blank empty windows
6360 buffers hidden and unloaded buffers, not just those in windows
6361 curdir the current directory
6362 folds manually created folds, opened/closed folds and local
6363 fold options
6364 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006365 and contain at least one lowercase letter. Only
6366 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367 help the help window
6368 localoptions options and mappings local to a window or buffer (not
6369 global values for local options)
6370 options all options and mappings (also global values for local
6371 options)
6372 resize size of the Vim window: 'lines' and 'columns'
6373 sesdir the directory in which the session file is located
6374 will become the current directory (useful with
6375 projects accessed over a network from different
6376 systems)
6377 slash backslashes in file names replaced with forward
6378 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006379 tabpages all tab pages; without this only the current tab page
6380 is restored, so that you can make a session for each
6381 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006382 terminal include terminal windows where the command can be
6383 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006384 unix with Unix end-of-line format (single <NL>), even when
6385 on Windows or DOS
6386 winpos position of the whole Vim window
6387 winsize window sizes
6388
6389 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006390 When neither "curdir" nor "sesdir" is included, file names are stored
6391 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 "slash" and "unix" are useful on Windows when sharing session files
6393 with Unix. The Unix version of Vim cannot source dos format scripts,
6394 but the Windows version of Vim can source unix format scripts.
6395
6396 *'shell'* *'sh'* *E91*
6397'shell' 'sh' string (default $SHELL or "sh",
6398 MS-DOS and Win32: "command.com" or
6399 "cmd.exe", OS/2: "cmd")
6400 global
6401 Name of the shell to use for ! and :! commands. When changing the
6402 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6403 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006404 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405 See |option-backslash| about including spaces and backslashes.
6406 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006407
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006409 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6411< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006412 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006413 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006414 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006416 Example with escaped space (Vim will do this when initializing the
6417 option from $SHELL): >
6418 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006419< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006420 backslashes are consumed by `:set`.
6421
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 Under MS-Windows, when the executable ends in ".com" it must be
6423 included. Thus setting the shell to "command.com" or "4dos.com"
6424 works, but "command" and "4dos" do not work for all commands (e.g.,
6425 filtering).
6426 For unknown reasons, when using "4dos.com" the current directory is
6427 changed to "C:\". To avoid this set 'shell' like this: >
6428 :set shell=command.com\ /c\ 4dos
6429< This option cannot be set from a |modeline| or in the |sandbox|, for
6430 security reasons.
6431
6432 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006433'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006434 MS-DOS and Win32, when 'shell' does not
6435 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6438 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6439 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006440 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006441 On Unix it can have more than one flag. Each white space separated
6442 part is passed as an argument to the shell command.
6443 See |option-backslash| about including spaces and backslashes.
6444 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 This option cannot be set from a |modeline| or in the |sandbox|, for
6446 security reasons.
6447
6448 *'shellpipe'* *'sp'*
6449'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6450 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 {not available when compiled without the |+quickfix|
6452 feature}
6453 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006454 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 including spaces and backslashes.
6456 The name of the temporary file can be represented by "%s" if necessary
6457 (the file name is appended automatically if no %s appears in the value
6458 of this option).
6459 For the Amiga and MS-DOS the default is ">". The output is directly
6460 saved in a file and not echoed to the screen.
6461 For Unix the default it "| tee". The stdout of the compiler is saved
6462 in a file and echoed to the screen. If the 'shell' option is "csh" or
6463 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006464 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6465 default becomes "2>&1| tee". This means that stderr is also included.
6466 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6467 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 The initialization of this option is done after reading the ".vimrc"
6469 and the other initializations, so that when the 'shell' option is set
6470 there, the 'shellpipe' option changes automatically, unless it was
6471 explicitly set before.
6472 When 'shellpipe' is set to an empty string, no redirection of the
6473 ":make" output will be done. This is useful if you use a 'makeprg'
6474 that writes to 'makeef' by itself. If you want no piping, but do
6475 want to include the 'makeef', set 'shellpipe' to a single space.
6476 Don't forget to precede the space with a backslash: ":set sp=\ ".
6477 In the future pipes may be used for filtering and this option will
6478 become obsolete (at least for Unix).
6479 This option cannot be set from a |modeline| or in the |sandbox|, for
6480 security reasons.
6481
6482 *'shellquote'* *'shq'*
6483'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6484 contains "sh" somewhere: "\"")
6485 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486 Quoting character(s), put around the command passed to the shell, for
6487 the "!" and ":!" commands. The redirection is kept outside of the
6488 quoting. See 'shellxquote' to include the redirection. It's
6489 probably not useful to set both options.
6490 This is an empty string by default. Only known to be useful for
6491 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6492 or bash, where it should be "\"". The default is adjusted according
6493 the value of 'shell', to reduce the need to set this option by the
6494 user. See |dos-shell|.
6495 This option cannot be set from a |modeline| or in the |sandbox|, for
6496 security reasons.
6497
6498 *'shellredir'* *'srr'*
6499'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6500 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 String to be used to put the output of a filter command in a temporary
6502 file. See also |:!|. See |option-backslash| about including spaces
6503 and backslashes.
6504 The name of the temporary file can be represented by "%s" if necessary
6505 (the file name is appended automatically if no %s appears in the value
6506 of this option).
6507 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6508 or "zsh" during initializations, the default becomes ">&". If the
6509 'shell' option is "sh", "ksh" or "bash" the default becomes
6510 ">%s 2>&1". This means that stderr is also included.
6511 For Win32, the Unix checks are done and additionally "cmd" is checked
6512 for, which makes the default ">%s 2>&1". Also, the same names with
6513 ".exe" appended are checked for.
6514 The initialization of this option is done after reading the ".vimrc"
6515 and the other initializations, so that when the 'shell' option is set
6516 there, the 'shellredir' option changes automatically unless it was
6517 explicitly set before.
6518 In the future pipes may be used for filtering and this option will
6519 become obsolete (at least for Unix).
6520 This option cannot be set from a |modeline| or in the |sandbox|, for
6521 security reasons.
6522
6523 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6524'shellslash' 'ssl' boolean (default off)
6525 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006526 {only for MSDOS, MS-Windows and OS/2}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 When set, a forward slash is used when expanding file names. This is
6528 useful when a Unix-like shell is used instead of command.com or
6529 cmd.exe. Backward slashes can still be typed, but they are changed to
6530 forward slashes by Vim.
6531 Note that setting or resetting this option has no effect for some
6532 existing file names, thus this option needs to be set before opening
6533 any file for best results. This might change in the future.
6534 'shellslash' only works when a backslash can be used as a path
6535 separator. To test if this is so use: >
6536 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006537< Also see 'completeslash'.
6538
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006539 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6540'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6541 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006542 When on, use temp files for shell commands. When off use a pipe.
6543 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006544 Currently a pipe is only supported on Unix and MS-Windows 2K and
6545 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006546 :if has("filterpipe")
6547< The advantage of using a pipe is that nobody can read the temp file
6548 and the 'shell' command does not need to support redirection.
6549 The advantage of using a temp file is that the file type and encoding
6550 can be detected.
6551 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6552 |FilterWritePost| autocommands event are not triggered when
6553 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006554 The `system()` function does not respect this option and always uses
6555 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006556 NOTE: This option is set to the Vim default value when 'compatible'
6557 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006558
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 *'shelltype'* *'st'*
6560'shelltype' 'st' number (default 0)
6561 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006562 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 On the Amiga this option influences the way how the commands work
6564 which use a shell.
6565 0 and 1: always use the shell
6566 2 and 3: use the shell only to filter lines
6567 4 and 5: use shell only for ':sh' command
6568 When not using the shell, the command is executed directly.
6569
6570 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6571 1 and 3: use "shell cmd" to start external commands
6572
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006573 *'shellxescape'* *'sxe'*
6574'shellxescape' 'sxe' string (default: "";
6575 for MS-DOS and MS-Windows: "\"&|<>()@^")
6576 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006577 When 'shellxquote' is set to "(" then the characters listed in this
6578 option will be escaped with a '^' character. This makes it possible
6579 to execute most external commands with cmd.exe.
6580
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 *'shellxquote'* *'sxq'*
6582'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006583 for Win32, when 'shell' is cmd.exe: "("
6584 for Win32, when 'shell' contains "sh"
6585 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 for Unix, when using system(): "\"")
6587 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 Quoting character(s), put around the command passed to the shell, for
6589 the "!" and ":!" commands. Includes the redirection. See
6590 'shellquote' to exclude the redirection. It's probably not useful
6591 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006592 When the value is '(' then ')' is appended. When the value is '"('
6593 then ')"' is appended.
6594 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006595 This is an empty string by default on most systems, but is known to be
6596 useful for on Win32 version, either for cmd.exe which automatically
6597 strips off the first and last quote on a command, or 3rd-party shells
6598 such as the MKS Korn Shell or bash, where it should be "\"". The
6599 default is adjusted according the value of 'shell', to reduce the need
6600 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 This option cannot be set from a |modeline| or in the |sandbox|, for
6602 security reasons.
6603
6604 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6605'shiftround' 'sr' boolean (default off)
6606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 Round indent to multiple of 'shiftwidth'. Applies to > and <
6608 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6609 a multiple of 'shiftwidth' (this is Vi compatible).
6610 NOTE: This option is reset when 'compatible' is set.
6611
6612 *'shiftwidth'* *'sw'*
6613'shiftwidth' 'sw' number (default 8)
6614 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006615 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006617 When zero the 'ts' value will be used. Use the |shiftwidth()|
6618 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006619
6620 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006621'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6622 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006624 This option helps to avoid all the |hit-enter| prompts caused by file
6625 messages, for example with CTRL-G, and to avoid some other messages.
6626 It is a list of flags:
6627 flag meaning when present ~
6628 f use "(3 of 5)" instead of "(file 3 of 5)"
6629 i use "[noeol]" instead of "[Incomplete last line]"
6630 l use "999L, 888C" instead of "999 lines, 888 characters"
6631 m use "[+]" instead of "[Modified]"
6632 n use "[New]" instead of "[New File]"
6633 r use "[RO]" instead of "[readonly]"
6634 w use "[w]" instead of "written" for file write message
6635 and "[a]" instead of "appended" for ':w >> file' command
6636 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6637 "[unix format]" and "[mac]" instead of "[mac format]".
6638 a all of the above abbreviations
6639
6640 o overwrite message for writing a file with subsequent message
6641 for reading a file (useful for ":wn" or when 'autowrite' on)
6642 O message for reading a file overwrites any previous message.
6643 Also for quickfix message (e.g., ":cn").
6644 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006645 hit TOP, continuing at BOTTOM" messages; when using the search
6646 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006647 t truncate file message at the start if it is too long to fit
6648 on the command-line, "<" will appear in the left most column.
6649 Ignored in Ex mode.
6650 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006651 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 Ignored in Ex mode.
6653 W don't give "written" or "[w]" when writing a file
6654 A don't give the "ATTENTION" message when an existing swap file
6655 is found.
6656 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006657 c don't give |ins-completion-menu| messages. For example,
6658 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6659 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006660 q use "recording" instead of "recording @a"
6661 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006662 was used for the command; note that this also affects messages
6663 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006664 S do not show search count message when searching, e.g.
6665 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006666
6667 This gives you the opportunity to avoid that a change between buffers
6668 requires you to hit <Enter>, but still gives as useful a message as
6669 possible for the space available. To get the whole message that you
6670 would have got with 'shm' empty, use ":file!"
6671 Useful values:
6672 shm= No abbreviation of message.
6673 shm=a Abbreviation, but no loss of information.
6674 shm=at Abbreviation, and truncate message when necessary.
6675
6676 NOTE: This option is set to the Vi default value when 'compatible' is
6677 set and to the Vim default value when 'compatible' is reset.
6678
6679 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6680'shortname' 'sn' boolean (default off)
6681 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682 Filenames are assumed to be 8 characters plus one extension of 3
6683 characters. Multiple dots in file names are not allowed. When this
6684 option is on, dots in file names are replaced with underscores when
6685 adding an extension (".~" or ".swp"). This option is not available
6686 for MS-DOS, because then it would always be on. This option is useful
6687 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6688 or crossdos. When running the Win32 GUI version under Win32s, this
6689 option is always on by default.
6690
6691 *'showbreak'* *'sbr'* *E595*
6692'showbreak' 'sbr' string (default "")
6693 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006694 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695 feature}
6696 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006697 values are "> " or "+++ ": >
6698 :set showbreak=>\
6699< Note the backslash to escape the trailing space. It's easier like
6700 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006701 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006702< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703 comma (in a future version the comma might be used to separate the
6704 part that is shown at the end and at the start of a line).
6705 The characters are highlighted according to the '@' flag in
6706 'highlight'.
6707 Note that tabs after the showbreak will be displayed differently.
6708 If you want the 'showbreak' to appear in between line numbers, add the
6709 "n" flag to 'cpoptions'.
6710
6711 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006712'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6713 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 {not available when compiled without the
6716 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006717 Show (partial) command in the last line of the screen. Set this
6718 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 In Visual mode the size of the selected area is shown:
6720 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006721 If the number of bytes is different it is also displayed: "2-6"
6722 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006724 - When selecting a block, the size in screen characters:
6725 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726 NOTE: This option is set to the Vi default value when 'compatible' is
6727 set and to the Vim default value when 'compatible' is reset.
6728
6729 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6730'showfulltag' 'sft' boolean (default off)
6731 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 When completing a word in insert mode (see |ins-completion|) from the
6733 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006734 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 matched a C function, you can see a template for what arguments are
6736 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006737 Note that this doesn't work well together with having "longest" in
6738 'completeopt', because the completion from the search pattern may not
6739 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740
6741 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6742'showmatch' 'sm' boolean (default off)
6743 global
6744 When a bracket is inserted, briefly jump to the matching one. The
6745 jump is only done if the match can be seen on the screen. The time to
6746 show the match can be set with 'matchtime'.
6747 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006748 seen or not).
6749 This option is reset when 'paste' is set and restored when 'paste' is
6750 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 When the 'm' flag is not included in 'cpoptions', typing a character
6752 will immediately move the cursor back to where it belongs.
6753 See the "sm" field in 'guicursor' for setting the cursor shape and
6754 blinking when showing the match.
6755 The 'matchpairs' option can be used to specify the characters to show
6756 matches for. 'rightleft' and 'revins' are used to look for opposite
6757 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006758 Also see the matchparen plugin for highlighting the match when moving
6759 around |pi_paren.txt|.
6760 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761
6762 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6763'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6764 global
6765 If in Insert, Replace or Visual mode put a message on the last line.
6766 Use the 'M' flag in 'highlight' to set the type of highlighting for
6767 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006768 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769 doesn't mean XIM is really active, especially when 'imactivatekey' is
6770 not set.
6771 NOTE: This option is set to the Vi default value when 'compatible' is
6772 set and to the Vim default value when 'compatible' is reset.
6773
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006774 *'showtabline'* *'stal'*
6775'showtabline' 'stal' number (default 1)
6776 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006777 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006778 feature}
6779 The value of this option specifies when the line with tab page labels
6780 will be displayed:
6781 0: never
6782 1: only if there are at least two tab pages
6783 2: always
6784 This is both for the GUI and non-GUI implementation of the tab pages
6785 line.
6786 See |tab-page| for more information about tab pages.
6787
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 *'sidescroll'* *'ss'*
6789'sidescroll' 'ss' number (default 0)
6790 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791 The minimal number of columns to scroll horizontally. Used only when
6792 the 'wrap' option is off and the cursor is moved off of the screen.
6793 When it is zero the cursor will be put in the middle of the screen.
6794 When using a slow terminal set it to a large number or 0. When using
6795 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6796 commands.
6797
6798 *'sidescrolloff'* *'siso'*
6799'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006800 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006802 right of the cursor if 'nowrap' is set. Setting this option to a
6803 value greater than 0 while having |'sidescroll'| also at a non-zero
6804 value makes some context visible in the line you are scrolling in
6805 horizontally (except at beginning of the line). Setting this option
6806 to a large value (like 999) has the effect of keeping the cursor
6807 horizontally centered in the window, as long as one does not come too
6808 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006809 After using the local value, go back the global value with one of
6810 these two: >
6811 setlocal sidescrolloff<
6812 setlocal sidescrolloff=-1
6813< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814
6815 Example: Try this together with 'sidescroll' and 'listchars' as
6816 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006817 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818
6819 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6820 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006821<
6822 *'signcolumn'* *'scl'*
6823'signcolumn' 'scl' string (default "auto")
6824 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006825 {not available when compiled without the |+signs|
6826 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006827 Whether or not to draw the signcolumn. Valid values are:
6828 "auto" only when there is a sign to display
6829 "no" never
6830 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006831 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006832 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833
6834
6835 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6836'smartcase' 'scs' boolean (default off)
6837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 Override the 'ignorecase' option if the search pattern contains upper
6839 case characters. Only used when the search pattern is typed and
6840 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006841 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6843 recalling the search pattern from history and hitting <Enter>.
6844 NOTE: This option is reset when 'compatible' is set.
6845
6846 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6847'smartindent' 'si' boolean (default off)
6848 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006849 {not available when compiled without the
6850 |+smartindent| feature}
6851 Do smart autoindenting when starting a new line. Works for C-like
6852 programs, but can also be used for other languages. 'cindent' does
6853 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006854 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006855 setting 'si' has no effect. 'indentexpr' is a more advanced
6856 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006857 Normally 'autoindent' should also be on when using 'smartindent'.
6858 An indent is automatically inserted:
6859 - After a line ending in '{'.
6860 - After a line starting with a keyword from 'cinwords'.
6861 - Before a line starting with '}' (only with the "O" command).
6862 When typing '}' as the first character in a new line, that line is
6863 given the same indent as the matching '{'.
6864 When typing '#' as the first character in a new line, the indent for
6865 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006866 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6868 When using the ">>" command, lines starting with '#' are not shifted
6869 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006870 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006871 This option is reset when 'paste' is set and restored when 'paste' is
6872 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006873
6874 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6875'smarttab' 'sta' boolean (default off)
6876 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006878 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6879 <BS> will delete a 'shiftwidth' worth of space at the start of the
6880 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006881 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006882 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6883 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006884 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006886 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006887 This option is reset when 'paste' is set and restored when 'paste' is
6888 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 NOTE: This option is reset when 'compatible' is set.
6890
6891 *'softtabstop'* *'sts'*
6892'softtabstop' 'sts' number (default 0)
6893 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 Number of spaces that a <Tab> counts for while performing editing
6895 operations, like inserting a <Tab> or using <BS>. It "feels" like
6896 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6897 used. This is useful to keep the 'ts' setting at its standard value
6898 of 8, while being able to edit like it is set to 'sts'. However,
6899 commands like "x" still work on the actual characters.
6900 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006901 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006902 'softtabstop' is set to 0 when the 'paste' option is set and restored
6903 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6905 spaces is minimized by using <Tab>s.
6906 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6907 set.
6908 NOTE: This option is set to 0 when 'compatible' is set.
6909
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006910 If Vim is compiled with the |+vartabs| feature then the value of
6911 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6912 anything other than an empty string.
6913
Bram Moolenaar217ad922005-03-20 22:37:15 +00006914 *'spell'* *'nospell'*
6915'spell' boolean (default off)
6916 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006917 {not available when compiled without the |+syntax|
6918 feature}
6919 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006920 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006921
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006922 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006923'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006924 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006925 {not available when compiled without the |+syntax|
6926 feature}
6927 Pattern to locate the end of a sentence. The following word will be
6928 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006929 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006930 When this check is not wanted make this option empty.
6931 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006932 Be careful with special characters, see |option-backslash| about
6933 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006934 To set this option automatically depending on the language, see
6935 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006936
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006937 *'spellfile'* *'spf'*
6938'spellfile' 'spf' string (default empty)
6939 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006940 {not available when compiled without the |+syntax|
6941 feature}
6942 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006943 commands. It must end in ".{encoding}.add". You need to include the
6944 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006945 *E765*
6946 It may also be a comma separated list of names. A count before the
6947 |zg| and |zw| commands can be used to access each. This allows using
6948 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006949 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006950 you: Using the first directory in 'runtimepath' that is writable. If
6951 there is no "spell" directory yet it will be created. For the file
6952 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006953 ignoring the region.
6954 The resulting ".spl" file will be used for spell checking, it does not
6955 have to appear in 'spelllang'.
6956 Normally one file is used for all regions, but you can add the region
6957 name if you want to. However, it will then only be used when
6958 'spellfile' is set to it, for entries in 'spelllang' only files
6959 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006960 This option cannot be set from a |modeline| or in the |sandbox|, for
6961 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006962
Bram Moolenaar217ad922005-03-20 22:37:15 +00006963 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006964'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006965 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00006966 {not available when compiled without the |+syntax|
6967 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006968 A comma separated list of word list names. When the 'spell' option is
6969 on spellchecking will be done for these languages. Example: >
6970 set spelllang=en_us,nl,medical
6971< This means US English, Dutch and medical words are recognized. Words
6972 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02006973 The word list name must consist of alphanumeric characters, a dash or
6974 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00006975 recommended to separate the two letter language name from a
6976 specification. Thus "en-rare" is used for rare English words.
6977 A region name must come last and have the form "_xx", where "xx" is
6978 the two-letter, lower case region name. You can use more than one
6979 region by listing them: "en_us,en_ca" supports both US and Canadian
6980 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01006981 Britain. (Note: currently en_au and en_nz dictionaries are older than
6982 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006983 If the name "cjk" is included East Asian characters are excluded from
6984 spell checking. This is useful when editing text that also has Asian
6985 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006986 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006987 As a special case the name of a .spl file can be given as-is. The
6988 first "_xx" in the name is removed and used as the region name
6989 (_xx is an underscore, two letters and followed by a non-letter).
6990 This is mainly for testing purposes. You must make sure the correct
6991 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006992 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006993 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6994 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006995 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006996
Bram Moolenaar98692072006-02-04 00:57:42 +00006997 If the |spellfile.vim| plugin is active and you use a language name
6998 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6999 will ask you if you want to download the file.
7000
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007001 After this option has been set successfully, Vim will source the files
7002 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007003 up to the first character that is not an ASCII letter or number and
7004 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007005
7006
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007007 *'spellsuggest'* *'sps'*
7008'spellsuggest' 'sps' string (default "best")
7009 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007010 {not available when compiled without the |+syntax|
7011 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007012 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007013 the |spellsuggest()| function. This is a comma-separated list of
7014 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007015
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007016 best Internal method that works best for English. Finds
7017 changes like "fast" and uses a bit of sound-a-like
7018 scoring to improve the ordering.
7019
7020 double Internal method that uses two methods and mixes the
7021 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007022 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007023 word. That only works when the language specifies
7024 sound folding. Can be slow and doesn't always give
7025 better results.
7026
7027 fast Internal method that only checks for simple changes:
7028 character inserts/deletes/swaps. Works well for
7029 simple typing mistakes.
7030
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007031 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007032 Not used for |spellsuggest()|. The number of
7033 suggestions is never more than the value of 'lines'
7034 minus two.
7035
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007036 file:{filename} Read file {filename}, which must have two columns,
7037 separated by a slash. The first column contains the
7038 bad word, the second column the suggested good word.
7039 Example:
7040 theribal/terrible ~
7041 Use this for common mistakes that do not appear at the
7042 top of the suggestion list with the internal methods.
7043 Lines without a slash are ignored, use this for
7044 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007045 The word in the second column must be correct,
7046 otherwise it will not be used. Add the word to an
7047 ".add" file if it is currently flagged as a spelling
7048 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007049 The file is used for all languages.
7050
7051 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7052 trouble with spaces. |v:val| holds the badly spelled
7053 word. The expression must evaluate to a List of
7054 Lists, each with a suggestion and a score.
7055 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007056 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007057 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007058 internal methods use. A lower score is better.
7059 This may invoke |spellsuggest()| if you temporarily
7060 set 'spellsuggest' to exclude the "expr:" part.
7061 Errors are silently ignored, unless you set the
7062 'verbose' option to a non-zero value.
7063
7064 Only one of "best", "double" or "fast" may be used. The others may
7065 appear several times in any order. Example: >
7066 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7067<
7068 This option cannot be set from a |modeline| or in the |sandbox|, for
7069 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007070
7071
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7073'splitbelow' 'sb' boolean (default off)
7074 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007075 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076 feature}
7077 When on, splitting a window will put the new window below the current
7078 one. |:split|
7079
7080 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7081'splitright' 'spr' boolean (default off)
7082 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007083 When on, splitting a window will put the new window right of the
7084 current one. |:vsplit|
7085
7086 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7087'startofline' 'sol' boolean (default on)
7088 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007090 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007091 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007092 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 with a linewise operator, with "%" with a count and to buffer changing
7094 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7095 only has a line number, e.g., ":25" or ":+".
7096 In case of buffer changing commands the cursor is placed at the column
7097 where it was the last time the buffer was edited.
7098 NOTE: This option is set when 'compatible' is set.
7099
Bram Moolenaar00654022011-02-25 14:42:19 +01007100 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007101'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007102 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 {not available when compiled without the |+statusline|
7104 feature}
7105 When nonempty, this option determines the content of the status line.
7106 Also see |status-line|.
7107
7108 The option consists of printf style '%' items interspersed with
7109 normal text. Each status line item is of the form:
7110 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007111 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007112 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113
Bram Moolenaar238a5642006-02-21 22:12:05 +00007114 When the option starts with "%!" then it is used as an expression,
7115 evaluated and the result is used as the option value. Example: >
7116 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007117< The *g:statusline_winid* variable will be set to the |window-ID| of the
7118 window that the status line belongs to.
7119 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007120 Note that the "%!" expression is evaluated in the context of the
7121 current window and buffer, while %{} items are evaluated in the
7122 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007123
7124 When there is error while evaluating the option then it will be made
7125 empty to avoid further errors. Otherwise screen updating would loop.
7126
Bram Moolenaar071d4272004-06-13 20:20:40 +00007127 Note that the only effect of 'ruler' when this option is set (and
7128 'laststatus' is 2) is controlling the output of |CTRL-G|.
7129
7130 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007131 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007132 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007133 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 minwid Minimum width of the item, padding as set by '-' & '0'.
7135 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007136 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137 on the left for text items. Numeric items will be
7138 shifted down to maxwid-2 digits followed by '>'number
7139 where number is the amount of missing digits, much like
7140 an exponential notation.
7141 item A one letter code as described below.
7142
7143 Following is a description of the possible statusline items. The
7144 second character in "item" is the type:
7145 N for number
7146 S for string
7147 F for flags as described below
7148 - not applicable
7149
7150 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007151 f S Path to the file in the buffer, as typed or relative to current
7152 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 F S Full path to the file in the buffer.
7154 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007155 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007157 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007158 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007159 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007161 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007163 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007165 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7167 being used: "<keymap>"
7168 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007169 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007170 B N As above, in hexadecimal.
7171 o N Byte number in file of byte under cursor, first byte is 1.
7172 Mnemonic: Offset from start of file (with one added)
7173 {not available when compiled without |+byte_offset| feature}
7174 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007175 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176 l N Line number.
7177 L N Number of lines in buffer.
7178 c N Column number.
7179 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007180 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007181 p N Percentage through file in lines as in |CTRL-G|.
7182 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007183 percentage described for 'ruler'. Always 3 in length, unless
7184 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007185 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007186 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007187 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007188 Note that there is no '%' before the closing '}'. The
7189 expression cannot contain a '}' character, call a function to
7190 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191 ( - Start of item group. Can be used for setting the width and
7192 alignment of a section. Must be followed by %) somewhere.
7193 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007194 T N For 'tabline': start of tab page N label. Use %T after the last
7195 label. This information is used for mouse clicks.
7196 X N For 'tabline': start of close tab N label. Use %X after the
7197 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7198 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007199 < - Where to truncate line if too long. Default is at the start.
7200 No width fields allowed.
7201 = - Separation point between left and right aligned items.
7202 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007203 # - Set highlight group. The name must follow and then a # again.
7204 Thus use %#HLname# for highlight group HLname. The same
7205 highlighting is used, also for the statusline of non-current
7206 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007207 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007208 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007209 The difference between User{N} and StatusLine will be applied
7210 to StatusLineNC for the statusline of non-current windows.
7211 The number N must be between 1 and 9. See |hl-User1..9|
7212
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007213 When displaying a flag, Vim removes the leading comma, if any, when
7214 that flag comes right after plaintext. This will make a nice display
7215 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216
Bram Moolenaar582fd852005-03-28 20:58:01 +00007217 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007218 not set) and a minwid is not set for the group, the whole group will
7219 become empty. This will make a group like the following disappear
7220 completely from the statusline when none of the flags are set. >
7221 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007222< Beware that an expression is evaluated each and every time the status
7223 line is displayed.
7224 *g:actual_curbuf* *g:actual_curwin*
7225 The current buffer and current window will be set temporarily to that
7226 of the window (and buffer) whose statusline is currently being drawn.
7227 The expression will evaluate in this context. The variable
7228 "g:actual_curbuf" is set to the `bufnr()` number of the real current
7229 buffer and "g:actual_curwin" to the |window-ID| of the real current
7230 window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007231
Bram Moolenaar30b65812012-07-12 22:01:11 +02007232 The 'statusline' option will be evaluated in the |sandbox| if set from
7233 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007234 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007235
7236 It is not allowed to change text or jump to another window while
7237 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238
7239 If the statusline is not updated when you want it (e.g., after setting
7240 a variable that's used in an expression), you can force an update by
7241 setting an option without changing its value. Example: >
7242 :let &ro = &ro
7243
7244< A result of all digits is regarded a number for display purposes.
7245 Otherwise the result is taken as flag text and applied to the rules
7246 described above.
7247
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007248 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007250 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007251
7252 Examples:
7253 Emulate standard status line with 'ruler' set >
7254 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7255< Similar, but add ASCII value of char under the cursor (like "ga") >
7256 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7257< Display byte count and byte value, modified flag in red. >
7258 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7259 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7260< Display a ,GZ flag if a compressed file is loaded >
7261 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7262< In the |:autocmd|'s: >
7263 :let b:gzflag = 1
7264< And: >
7265 :unlet b:gzflag
7266< And define this function: >
7267 :function VarExists(var, val)
7268 : if exists(a:var) | return a:val | else | return '' | endif
7269 :endfunction
7270<
7271 *'suffixes'* *'su'*
7272'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274 Files with these suffixes get a lower priority when multiple files
7275 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007276 suffixes. Spaces after the comma are ignored. A dot is also seen as
7277 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 separator, precede it with a backslash (see |option-backslash| about
7279 including spaces and backslashes).
7280 See 'wildignore' for completely ignoring files.
7281 The use of |:set+=| and |:set-=| is preferred when adding or removing
7282 suffixes from the list. This avoids problems when a future version
7283 uses another default.
7284
7285 *'suffixesadd'* *'sua'*
7286'suffixesadd' 'sua' string (default "")
7287 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 {not available when compiled without the
7289 |+file_in_path| feature}
7290 Comma separated list of suffixes, which are used when searching for a
7291 file for the "gf", "[I", etc. commands. Example: >
7292 :set suffixesadd=.java
7293<
7294 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7295'swapfile' 'swf' boolean (default on)
7296 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007297 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007298 swapfile is not wanted for a specific buffer. For example, with
7299 confidential information that even root must not be able to access.
7300 Careful: All text will be in memory:
7301 - Don't use this for big files.
7302 - Recovery will be impossible!
7303 A swapfile will only be present when |'updatecount'| is non-zero and
7304 'swapfile' is set.
7305 When 'swapfile' is reset, the swap file for the current buffer is
7306 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7307 non-zero, a swap file is immediately created.
7308 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007309 If you want to open a new buffer without creating a swap file for it,
7310 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007311 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312
7313 This option is used together with 'bufhidden' and 'buftype' to
7314 specify special kinds of buffers. See |special-buffers|.
7315
7316 *'swapsync'* *'sws'*
7317'swapsync' 'sws' string (default "fsync")
7318 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007320 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007321 When this option is empty parts of the swap file may be in memory and
7322 not written to disk. When the system crashes you may lose more work.
7323 On Unix the system does a sync now and then without Vim asking for it,
7324 so the disadvantage of setting this option off is small. On some
7325 systems the swap file will not be written at all. For a unix system
7326 setting it to "sync" will use the sync() call instead of the default
7327 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007328 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329
7330 *'switchbuf'* *'swb'*
7331'switchbuf' 'swb' string (default "")
7332 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007333 This option controls the behavior when switching between buffers.
7334 Possible values (comma separated list):
7335 useopen If included, jump to the first open window that
7336 contains the specified buffer (if there is one).
7337 Otherwise: Do not examine other windows.
7338 This setting is checked with |quickfix| commands, when
7339 jumping to errors (":cc", ":cn", "cp", etc.). It is
7340 also used in all buffer related split commands, for
7341 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007342 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007343 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007345 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007346 Otherwise: do not split, use current window (when used
7347 in the quickfix window: the previously used window or
7348 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007349 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007350 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007351 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007352
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007353 *'synmaxcol'* *'smc'*
7354'synmaxcol' 'smc' number (default 3000)
7355 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007356 {not available when compiled without the |+syntax|
7357 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007358 Maximum column in which to search for syntax items. In long lines the
7359 text after this column is not highlighted and following lines may not
7360 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007361 This helps to avoid very slow redrawing for an XML file that is one
7362 long line.
7363 Set to zero to remove the limit.
7364
Bram Moolenaar071d4272004-06-13 20:20:40 +00007365 *'syntax'* *'syn'*
7366'syntax' 'syn' string (default empty)
7367 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368 {not available when compiled without the |+syntax|
7369 feature}
7370 When this option is set, the syntax with this name is loaded, unless
7371 syntax highlighting has been switched off with ":syntax off".
7372 Otherwise this option does not always reflect the current syntax (the
7373 b:current_syntax variable does).
7374 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007375 not automatically recognized. Example, in an IDL file:
7376 /* vim: set syntax=idl : */ ~
7377 When a dot appears in the value then this separates two filetype
7378 names. Example:
7379 /* vim: set syntax=c.doxygen : */ ~
7380 This will use the "c" syntax first, then the "doxygen" syntax.
7381 Note that the second one must be prepared to be loaded as an addition,
7382 otherwise it will be skipped. More than one dot may appear.
7383 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 :set syntax=OFF
7385< To switch syntax highlighting on according to the current value of the
7386 'filetype' option: >
7387 :set syntax=ON
7388< What actually happens when setting the 'syntax' option is that the
7389 Syntax autocommand event is triggered with the value as argument.
7390 This option is not copied to another buffer, independent of the 's' or
7391 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007392 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007394 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007395'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007396 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007397 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007398 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007399 When nonempty, this option determines the content of the tab pages
7400 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007401 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007402
7403 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007404 option and only when there is no GUI tab line. When 'e' is in
7405 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007406 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007407
7408 The value is evaluated like with 'statusline'. You can use
7409 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007410 the text to be displayed. Use "%1T" for the first label, "%2T" for
7411 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007412
Bram Moolenaare12bab32019-01-08 22:02:56 +01007413 When changing something that is used in 'tabline' that does not
7414 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007415 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007416
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007417 Keep in mind that only one of the tab pages is the current one, others
7418 are invisible and you can't jump to their windows.
7419
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007420
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007421 *'tabpagemax'* *'tpm'*
7422'tabpagemax' 'tpm' number (default 10)
7423 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007424 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007425 feature}
7426 Maximum number of tab pages to be opened by the |-p| command line
7427 argument or the ":tab all" command. |tabpage|
7428
7429
7430 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431'tabstop' 'ts' number (default 8)
7432 local to buffer
7433 Number of spaces that a <Tab> in the file counts for. Also see
7434 |:retab| command, and 'softtabstop' option.
7435
7436 Note: Setting 'tabstop' to any other value than 8 can make your file
7437 appear wrong in many places (e.g., when printing it).
7438
7439 There are four main ways to use tabs in Vim:
7440 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7441 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007442 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 behave like a tab appears every 4 (or 3) characters.
7444 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7445 'expandtab'. This way you will always insert spaces. The
7446 formatting will never be messed up when 'tabstop' is changed.
7447 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007448 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 works when using Vim to edit the file.
7450 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7451 'noexpandtab'. This should then work (for initial indents only)
7452 for any tabstop setting that people use. It might be nice to have
7453 tabs after the first non-blank inserted as spaces if you do this
7454 though. Otherwise aligned comments will be wrong when 'tabstop' is
7455 changed.
7456
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007457 If Vim is compiled with the |+vartabs| feature then the value of
7458 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7459 than an empty string.
7460
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7462'tagbsearch' 'tbs' boolean (default on)
7463 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007465 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466 searching makes searching for a tag a LOT faster, but a linear search
7467 will find more tags if the tags file wasn't properly sorted.
7468 Vim normally assumes that your tags files are sorted, or indicate that
7469 they are not sorted. Only when this is not the case does the
7470 'tagbsearch' option need to be switched off.
7471
7472 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007473 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474 certain files, or retry all files with a linear search. When
7475 'tagbsearch' is off, only a linear search is done.
7476
7477 Linear searching is done anyway, for one file, when Vim finds a line
7478 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007479 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007480< [The whitespace before and after the '0' must be a single <Tab>]
7481
7482 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007483 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484 instead of a normal tag name, a retry is done with a linear search.
7485 Tags in unsorted tags files, and matches with different case will only
7486 be found in the retry.
7487
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007488 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007489 linear search can be avoided when case is ignored. Use a value of '2'
7490 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7491 sorted with the -f switch to "sort" in most unices, as in the command:
7492 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7493 (at least 5.5) the --sort=foldcase switch can be used for this as
7494 well. Note that case must be folded to uppercase for this to work.
7495
7496 By default, tag searches are case-sensitive. Case is ignored when
7497 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7498 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007499 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7500 'tagcase' is "smart", and the pattern contains only lowercase
7501 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502
7503 When 'tagbsearch' is off, tags searching is slower when a full match
7504 exists, but faster when no full match exists. Tags in unsorted tags
7505 files may only be found with 'tagbsearch' off.
7506 When the tags file is not sorted, or sorted in a wrong way (not on
7507 ASCII byte value), 'tagbsearch' should be off, or the line given above
7508 must be included in the tags file.
7509 This option doesn't affect commands that find all matching tags (e.g.,
7510 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007512 *'tagcase'* *'tc'*
7513'tagcase' 'tc' string (default "followic")
7514 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007515 This option specifies how case is handled when searching the tags
7516 file:
7517 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007518 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007519 ignore Ignore case
7520 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007521 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007522 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.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007524
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007525 *'tagfunc'* *'tfu'*
7526'tagfunc' 'tfu' string (default: empty)
7527 local to buffer
7528 {not available when compiled without the |+eval|
7529 feature}
7530 This option specifies a function to be used to perform tag searches.
7531 The function gets the tag pattern and should return a List of matching
7532 tags. See |tag-function| for an explanation of how to write the
7533 function and an example.
7534
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535 *'taglength'* *'tl'*
7536'taglength' 'tl' number (default 0)
7537 global
7538 If non-zero, tags are significant up to this number of characters.
7539
7540 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7541'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7542 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007543 If on and using a tags file in another directory, file names in that
7544 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 NOTE: This option is set to the Vi default value when 'compatible' is
7546 set and to the Vim default value when 'compatible' is reset.
7547
7548 *'tags'* *'tag'* *E433*
7549'tags' 'tag' string (default "./tags,tags", when compiled with
7550 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7551 global or local to buffer |global-local|
7552 Filenames for the tag command, separated by spaces or commas. To
7553 include a space or comma in a file name, precede it with a backslash
7554 (see |option-backslash| about including spaces and backslashes).
7555 When a file name starts with "./", the '.' is replaced with the path
7556 of the current file. But only when the 'd' flag is not included in
7557 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7558 |tags-option|.
7559 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007560 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7561 find all files named "tags" below "/lib". The filename itself cannot
7562 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7563 files called "tags?". {not available when compiled without the
7564 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007565 The |tagfiles()| function can be used to get a list of the file names
7566 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7568 files are also supported. They are automatically recognized. The
7569 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7570 differences are ignored (MS-Windows). |emacs-tags|
7571 The use of |:set+=| and |:set-=| is preferred when adding or removing
7572 file names from the list. This avoids problems when a future version
7573 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007574
7575 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7576'tagstack' 'tgst' boolean (default on)
7577 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 When on, the |tagstack| is used normally. When off, a ":tag" or
7579 ":tselect" command with an argument will not push the tag onto the
7580 tagstack. A following ":tag" without an argument, a ":pop" command or
7581 any other command that uses the tagstack will use the unmodified
7582 tagstack, but does change the pointer to the active entry.
7583 Resetting this option is useful when using a ":tag" command in a
7584 mapping which should not change the tagstack.
7585
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007586 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007587'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007588 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007589 {only available when compiled with the |+tcl/dyn|
7590 feature}
7591 Specifies the name of the Tcl shared library. The default is
7592 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007593 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007594 This option cannot be set from a |modeline| or in the |sandbox|, for
7595 security reasons.
7596
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597 *'term'* *E529* *E530* *E531*
7598'term' string (default is $TERM, if that fails:
7599 in the GUI: "builtin_gui"
7600 on Amiga: "amiga"
7601 on BeOS: "beos-ansi"
7602 on Mac: "mac-ansi"
7603 on MiNT: "vt52"
7604 on MS-DOS: "pcterm"
7605 on OS/2: "os2ansi"
7606 on Unix: "ansi"
7607 on VMS: "ansi"
7608 on Win 32: "win32")
7609 global
7610 Name of the terminal. Used for choosing the terminal control
7611 characters. Environment variables are expanded |:set_env|.
7612 For example: >
7613 :set term=$TERM
7614< See |termcap|.
7615
7616 *'termbidi'* *'tbidi'*
7617 *'notermbidi'* *'notbidi'*
7618'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 {only available when compiled with the |+arabic|
7621 feature}
7622 The terminal is in charge of Bi-directionality of text (as specified
7623 by Unicode). The terminal is also expected to do the required shaping
7624 that some languages (such as Arabic) require.
7625 Setting this option implies that 'rightleft' will not be set when
7626 'arabic' is set and the value of 'arabicshape' will be ignored.
7627 Note that setting 'termbidi' has the immediate effect that
7628 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7629 This option is reset when the GUI is started.
7630 For further details see |arabic.txt|.
7631
7632 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007633'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634 Macintosh GUI: "macroman")
7635 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636 Encoding used for the terminal. This specifies what character
7637 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007638 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007639 display). Except for the Mac when 'macatsui' is off, then
7640 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007641 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007642 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7644 Any attempts to set a different value will be rejected, and an error
7645 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007646 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647 because the Win32 system always passes Unicode characters.
7648 When empty, the same encoding is used as for the 'encoding' option.
7649 This is the normal value.
7650 Not all combinations for 'termencoding' and 'encoding' are valid. See
7651 |encoding-table|.
7652 The value for this option must be supported by internal conversions or
7653 iconv(). When this is not possible no conversion will be done and you
7654 will probably experience problems with non-ASCII characters.
7655 Example: You are working with the locale set to euc-jp (Japanese) and
7656 want to edit a UTF-8 file: >
7657 :let &termencoding = &encoding
7658 :set encoding=utf-8
7659< You need to do this when your system has no locale support for UTF-8.
7660
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007661 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007662'termguicolors' 'tgc' boolean (default off)
7663 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007664 {not available when compiled without the
7665 |+termguicolors| feature}
7666 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007667 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007668
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007669 Requires a ISO-8613-3 compatible terminal. If setting this option
7670 does not work (produces a colorless UI) reading |xterm-true-color|
7671 might help.
7672
7673 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7674 is required. Use this check to find out: >
7675 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007676< This requires Vim to be built with the |+vtp| feature.
7677
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007678 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007679 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007680
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007681 *'termwinkey'* *'twk'*
7682'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007683 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007684 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007685 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007686 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007687 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007688< The string must be one key stroke but can be multiple bytes.
7689 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007690 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007691 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007692
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007693 *'termwinscroll'* *'twsl'*
7694'termwinscroll' 'twsl' number (default 10000)
7695 local to buffer
7696 {not available when compiled without the
7697 |+terminal| feature}
7698 Number of scrollback lines to keep. When going over this limit the
7699 first 10% of the scrollback lines are deleted. This is just to reduce
7700 the memory usage. See |Terminal-Normal|.
7701
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007702 *'termwinsize'* *'tws'*
7703'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007704 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007705 Size of the |terminal| window. Format: {rows}x{columns} or
7706 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007707 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007708 - When set with a "x" (e.g., "24x80") the terminal size is not
7709 adjusted to the window size. If the window is smaller only the
7710 top-left part is displayed.
7711 - When set with a "*" (e.g., "10*50") the terminal size follows the
7712 window size, but will not be smaller than the specified rows and/or
7713 columns.
7714 - When rows is zero then use the height of the window.
7715 - When columns is zero then use the width of the window.
7716 - Using "0x0" or "0*0" is the same as empty.
7717
7718 Examples:
7719 "30x0" uses 30 rows and the current window width.
7720 "20*0" uses at least 20 rows and the current window width.
7721 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007722 Note that the command running in the terminal window may still change
7723 the size of the terminal. In that case the Vim window will be
7724 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007725
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007726 *'termwintype'* *'twt'*
7727'termwintype' 'twt' string (default "")
7728 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007729 {only available when compiled with the |terminal|
7730 feature on MS-Windows}
7731 Specify the virtual console (pty) used when opening the terminal
7732 window.
7733
7734 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007735 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007736 "winpty" use winpty, fail if not supported
7737 "conpty" use |ConPTY|, fail if not supported
7738
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007739 |ConPTY| support depends on the platform. Windows 10 October 2018
7740 Update is the first version that supports ConPTY, however it is still
7741 considered unstable. ConPTY might become stable in the next release
7742 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007743 supported then you cannot open a terminal window.
7744
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 *'terse'* *'noterse'*
7746'terse' boolean (default off)
7747 global
7748 When set: Add 's' flag to 'shortmess' option (this makes the message
7749 for a search that hits the start or end of the file not being
7750 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7751 shortens a lot of messages}
7752
7753 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7754'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7755 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007756 This option is obsolete. Use 'fileformats'.
7757 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7758 set to the default value for the current system. When 'textauto' is
7759 reset, 'fileformats' is made empty.
7760 NOTE: This option is set to the Vi default value when 'compatible' is
7761 set and to the Vim default value when 'compatible' is reset.
7762
7763 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7764'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7765 others: default off)
7766 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007767 This option is obsolete. Use 'fileformat'.
7768 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7769 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7770 "unix".
7771
7772 *'textwidth'* *'tw'*
7773'textwidth' 'tw' number (default 0)
7774 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007775 Maximum width of text that is being inserted. A longer line will be
7776 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007777 this.
7778 'textwidth' is set to 0 when the 'paste' option is set and restored
7779 when 'paste' is reset.
7780 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007781 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007782 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007783 NOTE: This option is set to 0 when 'compatible' is set.
7784
7785 *'thesaurus'* *'tsr'*
7786'thesaurus' 'tsr' string (default "")
7787 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007789 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7790
7791 Each line in the file should contain words with similar meaning,
7792 separated by non-keyword characters (white space is preferred).
7793 Maximum line length is 510 bytes.
7794
Bram Moolenaard47d5222018-12-09 20:43:55 +01007795 An English word list was added to this github issue:
7796 https://github.com/vim/vim/issues/629#issuecomment-443293282
7797 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7798 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7799 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007800
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007801 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007802 after a comma are ignored, otherwise spaces are included in the file
7803 name. See |option-backslash| about using backslashes.
7804 The use of |:set+=| and |:set-=| is preferred when adding or removing
7805 directories from the list. This avoids problems when a future version
7806 uses another default.
7807 Backticks cannot be used in this option for security reasons.
7808
7809 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7810'tildeop' 'top' boolean (default off)
7811 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 When on: The tilde command "~" behaves like an operator.
7813 NOTE: This option is reset when 'compatible' is set.
7814
7815 *'timeout'* *'to'* *'notimeout'* *'noto'*
7816'timeout' 'to' boolean (default on)
7817 global
7818 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007819'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007820 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 These two options together determine the behavior when part of a
7822 mapped key sequence or keyboard code has been received:
7823
7824 'timeout' 'ttimeout' action ~
7825 off off do not time out
7826 on on or off time out on :mappings and key codes
7827 off on time out on key codes
7828
7829 If both options are off, Vim will wait until either the complete
7830 mapping or key sequence has been received, or it is clear that there
7831 is no mapping or key sequence for the received characters. For
7832 example: if you have mapped "vl" and Vim has received 'v', the next
7833 character is needed to see if the 'v' is followed by an 'l'.
7834 When one of the options is on, Vim will wait for about 1 second for
7835 the next character to arrive. After that the already received
7836 characters are interpreted as single characters. The waiting time can
7837 be changed with the 'timeoutlen' option.
7838 On slow terminals or very busy systems timing out may cause
7839 malfunctioning cursor keys. If both options are off, Vim waits
7840 forever after an entered <Esc> if there are key codes that start
7841 with <Esc>. You will have to type <Esc> twice. If you do not have
7842 problems with key codes, but would like to have :mapped key
7843 sequences not timing out in 1 second, set the 'ttimeout' option and
7844 reset the 'timeout' option.
7845
7846 NOTE: 'ttimeout' is reset when 'compatible' is set.
7847
7848 *'timeoutlen'* *'tm'*
7849'timeoutlen' 'tm' number (default 1000)
7850 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007851
Bram Moolenaar071d4272004-06-13 20:20:40 +00007852 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007853'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855 The time in milliseconds that is waited for a key code or mapped key
7856 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7857 when part of a command has been typed.
7858 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7859 different timeout value for key codes is desired set 'ttimeoutlen' to
7860 a non-negative number.
7861
7862 ttimeoutlen mapping delay key code delay ~
7863 < 0 'timeoutlen' 'timeoutlen'
7864 >= 0 'timeoutlen' 'ttimeoutlen'
7865
7866 The timeout only happens when the 'timeout' and 'ttimeout' options
7867 tell so. A useful setting would be >
7868 :set timeout timeoutlen=3000 ttimeoutlen=100
7869< (time out on mapping after three seconds, time out on key codes after
7870 a tenth of a second).
7871
7872 *'title'* *'notitle'*
7873'title' boolean (default off, on when title can be restored)
7874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875 {not available when compiled without the |+title|
7876 feature}
7877 When on, the title of the window will be set to the value of
7878 'titlestring' (if it is not empty), or to:
7879 filename [+=-] (path) - VIM
7880 Where:
7881 filename the name of the file being edited
7882 - indicates the file cannot be modified, 'ma' off
7883 + indicates the file was modified
7884 = indicates the file is read-only
7885 =+ indicates the file is read-only and modified
7886 (path) is the path of the file being edited
7887 - VIM the server name |v:servername| or "VIM"
7888 Only works if the terminal supports setting window titles
7889 (currently Amiga console, Win32 console, all GUI versions and
7890 terminals with a non- empty 't_ts' option - these are Unix xterm and
7891 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7892 *X11*
7893 When Vim was compiled with HAVE_X11 defined, the original title will
7894 be restored if possible. The output of ":version" will include "+X11"
7895 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7896 works for the icon name |'icon'|.
7897 But: When Vim was started with the |-X| argument, restoring the title
7898 will not work (except in the GUI).
7899 If the title cannot be restored, it is set to the value of 'titleold'.
7900 You might want to restore the title outside of Vim then.
7901 When using an xterm from a remote machine you can use this command:
7902 rsh machine_name xterm -display $DISPLAY &
7903 then the WINDOWID environment variable should be inherited and the
7904 title of the window should change back to what it should be after
7905 exiting Vim.
7906
7907 *'titlelen'*
7908'titlelen' number (default 85)
7909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007910 {not available when compiled without the |+title|
7911 feature}
7912 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007913 title. When the title is longer, only the end of the path name is
7914 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915 Using a percentage makes this adapt to the width of the window. But
7916 it won't work perfectly, because the actual number of characters
7917 available also depends on the font used and other things in the title
7918 bar. When 'titlelen' is zero the full path is used. Otherwise,
7919 values from 1 to 30000 percent can be used.
7920 'titlelen' is also used for the 'titlestring' option.
7921
7922 *'titleold'*
7923'titleold' string (default "Thanks for flying Vim")
7924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 {only available when compiled with the |+title|
7926 feature}
7927 This option will be used for the window title when exiting Vim if the
7928 original title cannot be restored. Only happens if 'title' is on or
7929 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007930 This option cannot be set from a |modeline| or in the |sandbox|, for
7931 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007932 *'titlestring'*
7933'titlestring' string (default "")
7934 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 {not available when compiled without the |+title|
7936 feature}
7937 When this option is not empty, it will be used for the title of the
7938 window. This happens only when the 'title' option is on.
7939 Only works if the terminal supports setting window titles (currently
7940 Amiga console, Win32 console, all GUI versions and terminals with a
7941 non-empty 't_ts' option).
7942 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007943 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007944
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945 When this option contains printf-style '%' items, they will be
7946 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007947 This option cannot be set in a modeline when 'modelineexpr' is off.
7948
Bram Moolenaar071d4272004-06-13 20:20:40 +00007949 Example: >
7950 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7951 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7952< The value of 'titlelen' is used to align items in the middle or right
7953 of the available space.
7954 Some people prefer to have the file name first: >
7955 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7956< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007957 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007958 separating space only when needed.
7959 NOTE: Use of special characters in 'titlestring' may cause the display
7960 to be garbled (e.g., when it contains a CR or NL character).
7961 {not available when compiled without the |+statusline| feature}
7962
7963 *'toolbar'* *'tb'*
7964'toolbar' 'tb' string (default "icons,tooltips")
7965 global
7966 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7967 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007968 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969 possible values are:
7970 icons Toolbar buttons are shown with icons.
7971 text Toolbar buttons shown with text.
7972 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007973 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974 tooltips Tooltips are active for toolbar buttons.
7975 Tooltips refer to the popup help text which appears after the mouse
7976 cursor is placed over a toolbar button for a brief moment.
7977
7978 If you want the toolbar to be shown with icons as well as text, do the
7979 following: >
7980 :set tb=icons,text
7981< Motif and Athena cannot display icons and text at the same time. They
7982 will show icons if both are requested.
7983
7984 If none of the strings specified in 'toolbar' are valid or if
7985 'toolbar' is empty, this option is ignored. If you want to disable
7986 the toolbar, you need to set the 'guioptions' option. For example: >
7987 :set guioptions-=T
7988< Also see |gui-toolbar|.
7989
7990 *'toolbariconsize'* *'tbis'*
7991'toolbariconsize' 'tbis' string (default "small")
7992 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01007993 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007994 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007995 tiny Use tiny icons.
7996 small Use small icons (default).
7997 medium Use medium-sized icons.
7998 large Use large icons.
7999 huge Use even larger icons.
8000 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008002 the current theme. Common dimensions are giant=48x48, huge=32x32,
8003 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008004
8005 If 'toolbariconsize' is empty, the global default size as determined
8006 by user preferences or the current theme is used.
8007
8008 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8009'ttybuiltin' 'tbi' boolean (default on)
8010 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011 When on, the builtin termcaps are searched before the external ones.
8012 When off the builtin termcaps are searched after the external ones.
8013 When this option is changed, you should set the 'term' option next for
8014 the change to take effect, for example: >
8015 :set notbi term=$TERM
8016< See also |termcap|.
8017 Rationale: The default for this option is "on", because the builtin
8018 termcap entries are generally better (many systems contain faulty
8019 xterm entries...).
8020
8021 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8022'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8023 sun-cmd, screen, rxvt, dtterm or
8024 iris-ansi; also on when running Vim in
8025 a DOS console)
8026 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027 Indicates a fast terminal connection. More characters will be sent to
8028 the screen for redrawing, instead of using insert/delete line
8029 commands. Improves smoothness of redrawing when there are multiple
8030 windows and the terminal does not support a scrolling region.
8031 Also enables the extra writing of characters at the end of each screen
8032 line for lines that wrap. This helps when using copy/paste with the
8033 mouse in an xterm and other terminals.
8034
8035 *'ttymouse'* *'ttym'*
8036'ttymouse' 'ttym' string (default depends on 'term')
8037 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008038 {only in Unix and VMS, doesn't work in the GUI; not
8039 available when compiled without |+mouse|}
8040 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008041 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008042 *xterm-mouse*
8043 xterm xterm-like mouse handling. The mouse generates
8044 "<Esc>[Mscr", where "scr" is three bytes:
8045 "s" = button state
8046 "c" = column plus 33
8047 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008048 This only works up to 223 columns! See "dec",
8049 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008050 xterm2 Works like "xterm", but with the xterm reporting the
8051 mouse position while the mouse is dragged. This works
8052 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008053 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054 work. See below for how Vim detects this
8055 automatically.
8056 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008057 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008059 for the row and column. No other mouse events are
8060 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008061 *dec-mouse*
8062 dec DEC terminal mouse handling. The mouse generates a
8063 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008064 This is also available for an Xterm, if it was
8065 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008066 *jsbterm-mouse*
8067 jsbterm JSB term mouse handling.
8068 *pterm-mouse*
8069 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008070 *urxvt-mouse*
8071 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008072 The mouse works only if the terminal supports this
8073 encoding style, but it does not have 223 columns limit
8074 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008075 *sgr-mouse*
8076 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008077 mouse reporting. The mouse works even in columns
8078 beyond 223. This option is backward compatible with
8079 "xterm2" because it can also decode "xterm2" style
8080 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008081
8082 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008083 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8084 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8086 recognized, if enabled at compile time. DEC terminal mouse codes
8087 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008088 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8089 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008090 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008091 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8092 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8093 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008094 Additionally, if vim is compiled with the |+termresponse| feature and
8095 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008096 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008098 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8099 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8100 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008101 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8102 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008103 :set t_RV=
8104<
8105 *'ttyscroll'* *'tsl'*
8106'ttyscroll' 'tsl' number (default 999)
8107 global
8108 Maximum number of lines to scroll the screen. If there are more lines
8109 to scroll the window is redrawn. For terminals where scrolling is
8110 very slow and redrawing is not slow this can be set to a small number,
8111 e.g., 3, to speed up displaying.
8112
8113 *'ttytype'* *'tty'*
8114'ttytype' 'tty' string (default from $TERM)
8115 global
8116 Alias for 'term', see above.
8117
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008118 *'undodir'* *'udir'*
8119'undodir' 'udir' string (default ".")
8120 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008121 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008122 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008123 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008124 "." means using the directory of the file. The undo file name for
8125 "file.txt" is ".file.txt.un~".
8126 For other directories the file name is the full path of the edited
8127 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008128 When writing: The first directory that exists is used. "." always
8129 works, no directories after "." will be used for writing.
8130 When reading all entries are tried to find an undo file. The first
8131 undo file that exists is used. When it cannot be read an error is
8132 given, no further entry is used.
8133 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008134 This option cannot be set from a |modeline| or in the |sandbox|, for
8135 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008136
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008137 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008138'undofile' 'udf' boolean (default off)
8139 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008140 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008141 When on, Vim automatically saves undo history to an undo file when
8142 writing a buffer to a file, and restores undo history from the same
8143 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008144 The directory where the undo file is stored is specified by 'undodir'.
8145 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008146 The undo file is not read when 'undoreload' causes the buffer from
8147 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008148 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008149 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008150
Bram Moolenaar071d4272004-06-13 20:20:40 +00008151 *'undolevels'* *'ul'*
8152'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8153 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008154 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 Maximum number of changes that can be undone. Since undo information
8156 is kept in memory, higher numbers will cause more memory to be used
8157 (nevertheless, a single change can use an unlimited amount of memory).
8158 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8159 itself: >
8160 set ul=0
8161< But you can also get Vi compatibility by including the 'u' flag in
8162 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008163 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008164 Set to -1 for no undo at all. You might want to do this only for the
8165 current buffer: >
8166 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008168
8169 The local value is set to -123456 when the global value is to be used.
8170
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008171 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008172
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008173 *'undoreload'* *'ur'*
8174'undoreload' 'ur' number (default 10000)
8175 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008176 Save the whole buffer for undo when reloading it. This applies to the
8177 ":e!" command and reloading for when the buffer changed outside of
8178 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008179 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008180 of lines is smaller than the value of this option.
8181 Set this option to zero to disable undo for a reload.
8182
8183 When saving undo for a reload, any undo file is not read.
8184
8185 Note that this causes the whole buffer to be stored in memory. Set
8186 this option to a lower value if you run out of memory.
8187
Bram Moolenaar071d4272004-06-13 20:20:40 +00008188 *'updatecount'* *'uc'*
8189'updatecount' 'uc' number (default: 200)
8190 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008191 After typing this many characters the swap file will be written to
8192 disk. When zero, no swap file will be created at all (see chapter on
8193 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8194 Vim with the "-n" option, see |startup|. When editing in readonly
8195 mode this option will be initialized to 10000.
8196 The swapfile can be disabled per buffer with |'swapfile'|.
8197 When 'updatecount' is set from zero to non-zero, swap files are
8198 created for all buffers that have 'swapfile' set. When 'updatecount'
8199 is set to zero, existing swap files are not deleted.
8200 Also see |'swapsync'|.
8201 This option has no meaning in buffers where |'buftype'| is "nofile"
8202 or "nowrite".
8203
8204 *'updatetime'* *'ut'*
8205'updatetime' 'ut' number (default 4000)
8206 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008207 If this many milliseconds nothing is typed the swap file will be
8208 written to disk (see |crash-recovery|). Also used for the
8209 |CursorHold| autocommand event.
8210
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008211 *'varsofttabstop'* *'vsts'*
8212'varsofttabstop' 'vsts' string (default "")
8213 local to buffer
8214 {only available when compiled with the |+vartabs|
8215 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008216 A list of the number of spaces that a <Tab> counts for while editing,
8217 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8218 width <Tab>s are being inserted, while in fact a mixture of spaces
8219 and <Tab>s is used. Tab widths are separated with commas, with the
8220 final value applying to all subsequent tabs.
8221
8222 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008223 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008224 to use the following: >
8225 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008226< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8227 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008228
8229 Note that the value of |'softtabstop'| will be ignored while
8230 'varsofttabstop' is set.
8231
8232 *'vartabstop'* *'vts'*
8233'vartabstop' 'vts' string (default "")
8234 local to buffer
8235 {only available when compiled with the |+vartabs|
8236 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008237 A list of the number of spaces that a <Tab> in the file counts for,
8238 separated by commas. Each value corresponds to one tab, with the
8239 final value applying to all subsequent tabs. For example: >
8240 :set vartabstop=4,20,10,8
8241< This will make the first tab 4 spaces wide, the second 20 spaces,
8242 the third 10 spaces, and all following tabs 8 spaces.
8243
8244 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8245 is set.
8246
Bram Moolenaar071d4272004-06-13 20:20:40 +00008247 *'verbose'* *'vbs'*
8248'verbose' 'vbs' number (default 0)
8249 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008250 When bigger than zero, Vim will give messages about what it is doing.
8251 Currently, these messages are given:
8252 >= 1 When the viminfo file is read or written.
8253 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008254 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008255 >= 8 Files for which a group of autocommands is executed.
8256 >= 9 Every executed autocommand.
8257 >= 12 Every executed function.
8258 >= 13 When an exception is thrown, caught, finished, or discarded.
8259 >= 14 Anything pending in a ":finally" clause.
8260 >= 15 Every executed Ex command (truncated at 200 characters).
8261
8262 This option can also be set with the "-V" argument. See |-V|.
8263 This option is also set by the |:verbose| command.
8264
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008265 When the 'verbosefile' option is set then the verbose messages are not
8266 displayed.
8267
8268 *'verbosefile'* *'vfile'*
8269'verbosefile' 'vfile' string (default empty)
8270 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008271 When not empty all messages are written in a file with this name.
8272 When the file exists messages are appended.
8273 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008274 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008275 Setting 'verbosefile' to a new value is like making it empty first.
8276 The difference with |:redir| is that verbose messages are not
8277 displayed when 'verbosefile' is set.
8278
Bram Moolenaar071d4272004-06-13 20:20:40 +00008279 *'viewdir'* *'vdir'*
8280'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8281 "$VIM/vimfiles/view",
8282 for Unix: "~/.vim/view",
8283 for Macintosh: "$VIM:vimfiles:view"
8284 for VMS: "sys$login:vimfiles/view"
8285 for RiscOS: "Choices:vimfiles/view")
8286 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008287 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008288 feature}
8289 Name of the directory where to store files for |:mkview|.
8290 This option cannot be set from a |modeline| or in the |sandbox|, for
8291 security reasons.
8292
8293 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008294'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008296 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008297 feature}
8298 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008299 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008300 word save and restore ~
8301 cursor cursor position in file and in window
8302 folds manually created folds, opened/closed folds and local
8303 fold options
8304 options options and mappings local to a window or buffer (not
8305 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008306 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307 slash backslashes in file names replaced with forward
8308 slashes
8309 unix with Unix end-of-line format (single <NL>), even when
8310 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008311 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312
8313 "slash" and "unix" are useful on Windows when sharing view files
8314 with Unix. The Unix version of Vim cannot source dos format scripts,
8315 but the Windows version of Vim can source unix format scripts.
8316
8317 *'viminfo'* *'vi'* *E526* *E527* *E528*
8318'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008319 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8320 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8321 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008323 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008324 feature}
8325 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008326 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8327 "NONE".
8328 The string should be a comma separated list of parameters, each
8329 consisting of a single character identifying the particular parameter,
8330 followed by a number or string which specifies the value of that
8331 parameter. If a particular character is left out, then the default
8332 value is used for that parameter. The following is a list of the
8333 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008334 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008335 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008336 ! When included, save and restore global variables that start
8337 with an uppercase letter, and don't contain a lowercase
8338 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008339 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008340 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008341 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342 " Maximum number of lines saved for each register. Old name of
8343 the '<' item, with the disadvantage that you need to put a
8344 backslash before the ", otherwise it will be recognized as the
8345 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008346 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347 % When included, save and restore the buffer list. If Vim is
8348 started with a file name argument, the buffer list is not
8349 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008350 buffer list is restored from the viminfo file. Quickfix
8351 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8352 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008353 When followed by a number, the number specifies the maximum
8354 number of buffers that are stored. Without a number all
8355 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008356 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357 ' Maximum number of previously edited files for which the marks
8358 are remembered. This parameter must always be included when
8359 'viminfo' is non-empty.
8360 Including this item also means that the |jumplist| and the
8361 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008362 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008364 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365 patterns are also saved. When not included, the value of
8366 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008367 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008369 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008370 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008371 < Maximum number of lines saved for each register. If zero then
8372 registers are not saved. When not included, all lines are
8373 saved. '"' is the old name for this item.
8374 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008375 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008376 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008377 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008378 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008379 c When included, convert the text in the viminfo file from the
8380 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008381 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008382 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383 f Whether file marks need to be stored. If zero, file marks ('0
8384 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008385 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008387 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388 h Disable the effect of 'hlsearch' when loading the viminfo
8389 file. When not included, it depends on whether ":nohlsearch"
8390 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008391 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008392 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008393 the 'n'. Must be at the end of the option! If the
8394 'viminfofile' option is set, that file name overrides the one
8395 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008396 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008397 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008398 r Removable media. The argument is a string (up to the next
8399 ','). This parameter can be given several times. Each
8400 specifies the start of a path for which no marks will be
8401 stored. This is to avoid removable media. For MS-DOS you
8402 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8403 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8404 ignored. Maximum length of each 'r' argument is 50
8405 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008406 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407 s Maximum size of an item in Kbyte. If zero then registers are
8408 not saved. Currently only applies to registers. The default
8409 "s10" will exclude registers with more than 10 Kbyte of text.
8410 Also see the '<' item above: line count limit.
8411
8412 Example: >
8413 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8414<
8415 '50 Marks will be remembered for the last 50 files you
8416 edited.
8417 <1000 Contents of registers (up to 1000 lines each) will be
8418 remembered.
8419 s100 Registers with more than 100 Kbyte text are skipped.
8420 :0 Command-line history will not be saved.
8421 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8422 no / Since '/' is not specified, the default will be used,
8423 that is, save all of the search history, and also the
8424 previous search and substitute patterns.
8425 no % The buffer list will not be saved nor read back.
8426 no h 'hlsearch' highlighting will be restored.
8427
8428 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8429 load the contents of the file, this is not done automatically.
8430
8431 This option cannot be set from a |modeline| or in the |sandbox|, for
8432 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008433 NOTE: This option is set to the Vim default value when 'compatible'
8434 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008435
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008436 *'viminfofile'* *'vif'*
8437'viminfofile' 'vif' string (default: "")
8438 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008439 {not available when compiled without the |+viminfo|
8440 feature}
8441 When non-empty, overrides the file name used for viminfo.
8442 When equal to "NONE" no viminfo file will be read or written.
8443 This option can be set with the |-i| command line flag. The |--clean|
8444 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008445 This option cannot be set from a |modeline| or in the |sandbox|, for
8446 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008447
Bram Moolenaar071d4272004-06-13 20:20:40 +00008448 *'virtualedit'* *'ve'*
8449'virtualedit' 've' string (default "")
8450 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008451 {not available when compiled without the
8452 |+virtualedit| feature}
8453 A comma separated list of these words:
8454 block Allow virtual editing in Visual block mode.
8455 insert Allow virtual editing in Insert mode.
8456 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008457 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008458
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008460 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008461 of the line. Useful for selecting a rectangle in Visual mode and
8462 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008463 "onemore" is not the same, it will only allow moving the cursor just
8464 after the last character of the line. This makes some commands more
8465 consistent. Previously the cursor was always past the end of the line
8466 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008467 break some plugins or Vim scripts. For example because |l| can move
8468 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008469 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008470 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008471 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008472 It doesn't make sense to combine "all" with "onemore", but you will
8473 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008474 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008475
8476 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8477'visualbell' 'vb' boolean (default off)
8478 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008479 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008480 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008481 use: >
8482 :set vb t_vb=
8483< If you want a short flash, you can use this on many terminals: >
8484 :set vb t_vb=[?5h$<100>[?5l
8485< Here $<100> specifies the time, you can use a smaller or bigger value
8486 to get a shorter or longer flash.
8487
8488 Note: Vim will limit the bell to once per half a second. This avoids
8489 having to wait for the flashing to finish when there are lots of
8490 bells, e.g. on key repeat. This also happens without 'visualbell'
8491 set.
8492
Bram Moolenaar071d4272004-06-13 20:20:40 +00008493 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8494 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8495 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008496
8497 Note: When the GUI starts, 't_vb' is reset to its default value. You
8498 might want to set it again in your |gvimrc|.
8499
Bram Moolenaar071d4272004-06-13 20:20:40 +00008500 Does not work on the Amiga, you always get a screen flash.
8501 Also see 'errorbells'.
8502
8503 *'warn'* *'nowarn'*
8504'warn' boolean (default on)
8505 global
8506 Give a warning message when a shell command is used while the buffer
8507 has been changed.
8508
8509 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8510'weirdinvert' 'wiv' boolean (default off)
8511 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008512 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008513 It is provided for backwards compatibility with version 4.x.
8514 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8515 vice versa. Has no effect when the GUI is running.
8516
8517 *'whichwrap'* *'ww'*
8518'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8519 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008520 Allow specified keys that move the cursor left/right to move to the
8521 previous/next line when the cursor is on the first/last character in
8522 the line. Concatenate characters to allow this for these keys:
8523 char key mode ~
8524 b <BS> Normal and Visual
8525 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008526 h "h" Normal and Visual (not recommended)
8527 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008528 < <Left> Normal and Visual
8529 > <Right> Normal and Visual
8530 ~ "~" Normal
8531 [ <Left> Insert and Replace
8532 ] <Right> Insert and Replace
8533 For example: >
8534 :set ww=<,>,[,]
8535< allows wrap only when cursor keys are used.
8536 When the movement keys are used in combination with a delete or change
8537 operator, the <EOL> also counts for a character. This makes "3h"
8538 different from "3dh" when the cursor crosses the end of a line. This
8539 is also true for "x" and "X", because they do the same as "dl" and
8540 "dh". If you use this, you may also want to use the mapping
8541 ":map <BS> X" to make backspace delete the character in front of the
8542 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008543 When 'l' is included and it is used after an operator at the end of a
8544 line then it will not move to the next line. This makes "dl", "cl",
8545 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008546 NOTE: This option is set to the Vi default value when 'compatible' is
8547 set and to the Vim default value when 'compatible' is reset.
8548
8549 *'wildchar'* *'wc'*
8550'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8551 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008552 Character you have to type to start wildcard expansion in the
8553 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008554 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008555 The character is not recognized when used inside a macro. See
8556 'wildcharm' for that.
8557 Although 'wc' is a number option, you can set it to a special key: >
8558 :set wc=<Esc>
8559< NOTE: This option is set to the Vi default value when 'compatible' is
8560 set and to the Vim default value when 'compatible' is reset.
8561
8562 *'wildcharm'* *'wcm'*
8563'wildcharm' 'wcm' number (default: none (0))
8564 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008565 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008566 recognized when used inside a macro. You can find "spare" command-line
8567 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008568 you'll never actually type 'wildcharm', just use it in mappings that
8569 automatically invoke completion mode, e.g.: >
8570 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008571 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008572< Then after typing :ss you can use CTRL-P & CTRL-N.
8573
8574 *'wildignore'* *'wig'*
8575'wildignore' 'wig' string (default "")
8576 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008577 {not available when compiled without the |+wildignore|
8578 feature}
8579 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008580 patterns is ignored when expanding |wildcards|, completing file or
8581 directory names, and influences the result of |expand()|, |glob()| and
8582 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008583 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8584 Also see 'suffixes'.
8585 Example: >
8586 :set wildignore=*.o,*.obj
8587< The use of |:set+=| and |:set-=| is preferred when adding or removing
8588 a pattern from the list. This avoids problems when a future version
8589 uses another default.
8590
Bram Moolenaar94950a92010-12-02 16:01:29 +01008591
Bram Moolenaar81af9252010-12-10 20:35:50 +01008592 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008593'wildignorecase' 'wic' boolean (default off)
8594 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008595 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008596 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008597 Does not apply when the shell is used to expand wildcards, which
8598 happens when there are special characters.
8599
8600
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008602'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604 {not available if compiled without the |+wildmenu|
8605 feature}
8606 When 'wildmenu' is on, command-line completion operates in an enhanced
8607 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8608 the possible matches are shown just above the command line, with the
8609 first match highlighted (overwriting the status line, if there is
8610 one). Keys that show the previous/next match, such as <Tab> or
8611 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8612 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8613 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008614 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008615 If there are more matches than can fit in the line, a ">" is shown on
8616 the right and/or a "<" is shown on the left. The status line scrolls
8617 as needed.
8618 The "wildmenu" mode is abandoned when a key is hit that is not used
8619 for selecting a completion.
8620 While the "wildmenu" is active the following keys have special
8621 meanings:
8622
8623 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8624 <Down> - in filename/menu name completion: move into a
8625 subdirectory or submenu.
8626 <CR> - in menu completion, when the cursor is just after a
8627 dot: move into a submenu.
8628 <Up> - in filename/menu name completion: move up into
8629 parent directory or parent menu.
8630
8631 This makes the menus accessible from the console |console-menus|.
8632
8633 If you prefer the <Left> and <Right> keys to move the cursor instead
8634 of selecting a different match, use this: >
8635 :cnoremap <Left> <Space><BS><Left>
8636 :cnoremap <Right> <Space><BS><Right>
8637<
8638 The "WildMenu" highlighting is used for displaying the current match
8639 |hl-WildMenu|.
8640
8641 *'wildmode'* *'wim'*
8642'wildmode' 'wim' string (Vim default: "full")
8643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008644 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008645 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008646 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008647 first part specifies the behavior for the first use of 'wildchar',
8648 The second part for the second use, etc.
8649 These are the possible values for each part:
8650 "" Complete only the first match.
8651 "full" Complete the next full match. After the last match,
8652 the original string is used and then the first match
8653 again.
8654 "longest" Complete till longest common string. If this doesn't
8655 result in a longer string, use the next part.
8656 "longest:full" Like "longest", but also start 'wildmenu' if it is
8657 enabled.
8658 "list" When more than one match, list all matches.
8659 "list:full" When more than one match, list all matches and
8660 complete first match.
8661 "list:longest" When more than one match, list all matches and
8662 complete till longest common string.
8663 When there is only a single match, it is fully completed in all cases.
8664
8665 Examples: >
8666 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008667< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008668 :set wildmode=longest,full
8669< Complete longest common string, then each full match >
8670 :set wildmode=list:full
8671< List all matches and complete each full match >
8672 :set wildmode=list,full
8673< List all matches without completing, then each full match >
8674 :set wildmode=longest,list
8675< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008676 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008677
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008678 *'wildoptions'* *'wop'*
8679'wildoptions' 'wop' string (default "")
8680 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008681 {not available when compiled without the |+wildignore|
8682 feature}
8683 A list of words that change how command line completion is done.
8684 Currently only one word is allowed:
8685 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008686 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008687 is displayed per line. Often used tag kinds are:
8688 d #define
8689 f function
8690 Also see |cmdline-completion|.
8691
Bram Moolenaar071d4272004-06-13 20:20:40 +00008692 *'winaltkeys'* *'wak'*
8693'winaltkeys' 'wak' string (default "menu")
8694 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008695 {only used in Win32, Motif, GTK and Photon GUI}
8696 Some GUI versions allow the access to menu entries by using the ALT
8697 key in combination with a character that appears underlined in the
8698 menu. This conflicts with the use of the ALT key for mappings and
8699 entering special characters. This option tells what to do:
8700 no Don't use ALT keys for menus. ALT key combinations can be
8701 mapped, but there is no automatic handling. This can then be
8702 done with the |:simalt| command.
8703 yes ALT key handling is done by the windowing system. ALT key
8704 combinations cannot be mapped.
8705 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008706 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008707 keys can be mapped.
8708 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8709 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008710 This option is not used for <F10>; on Win32 and with GTK <F10> will
8711 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008712
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008713 *'wincolor'* *'wcr'*
8714'wincolor' 'wcr' string (default empty)
8715 local to window
8716 Highlight group name to use for this window instead of the Normal
8717 color |hl-Normal|.
8718
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008719 *'window'* *'wi'*
8720'window' 'wi' number (default screen height - 1)
8721 global
8722 Window height. Do not confuse this with the height of the Vim window,
8723 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008724 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8725 value is smaller than 'lines' minus one. The screen will scroll
8726 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008727 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8728 in a much smarter way, taking care of wrapping lines.
8729 When resizing the Vim window, the value is smaller than 1 or more than
8730 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008731
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 *'winheight'* *'wh'* *E591*
8733'winheight' 'wh' number (default 1)
8734 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008735 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 feature}
8737 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008738 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008739 focus goes to a window that is smaller, its size is increased, at the
8740 cost of the height of other windows.
8741 Set 'winheight' to a small number for normal editing.
8742 Set it to 999 to make the current window fill most of the screen.
8743 Other windows will be only 'winminheight' high. This has the drawback
8744 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8745 to create only two windows, set the option after startup is done,
8746 using the |VimEnter| event: >
8747 au VimEnter * set winheight=999
8748< Minimum value is 1.
8749 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008750 height of the current window.
8751 'winheight' applies to the current window. Use 'winminheight' to set
8752 the minimal height for other windows.
8753
8754 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8755'winfixheight' 'wfh' boolean (default off)
8756 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02008757 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008758 feature}
8759 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008760 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8761 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008762 The height may be changed anyway when running out of room.
8763
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008764 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8765'winfixwidth' 'wfw' boolean (default off)
8766 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02008767 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008768 feature}
8769 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008770 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008771 The width may be changed anyway when running out of room.
8772
Bram Moolenaar071d4272004-06-13 20:20:40 +00008773 *'winminheight'* *'wmh'*
8774'winminheight' 'wmh' number (default 1)
8775 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008776 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008777 feature}
8778 The minimal height of a window, when it's not the current window.
8779 This is a hard minimum, windows will never become smaller.
8780 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8781 status bar) if necessary. They will return to at least one line when
8782 they become active (since the cursor has to have somewhere to go.)
8783 Use 'winheight' to set the minimal height of the current window.
8784 This option is only checked when making a window smaller. Don't use a
8785 large number, it will cause errors when opening more than a few
8786 windows. A value of 0 to 3 is reasonable.
8787
8788 *'winminwidth'* *'wmw'*
8789'winminwidth' 'wmw' number (default 1)
8790 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008791 The minimal width of a window, when it's not the current window.
8792 This is a hard minimum, windows will never become smaller.
8793 When set to zero, windows may be "squashed" to zero columns (i.e. just
8794 a vertical separator) if necessary. They will return to at least one
8795 line when they become active (since the cursor has to have somewhere
8796 to go.)
8797 Use 'winwidth' to set the minimal width of the current window.
8798 This option is only checked when making a window smaller. Don't use a
8799 large number, it will cause errors when opening more than a few
8800 windows. A value of 0 to 12 is reasonable.
8801
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008802 *'winptydll'*
8803'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8804 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008805 {only available when compiled with the |terminal|
8806 feature on MS-Windows}
8807 Specifies the name of the winpty shared library, used for the
8808 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008809 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008810 a fallback.
8811 Environment variables are expanded |:set_env|.
8812 This option cannot be set from a |modeline| or in the |sandbox|, for
8813 security reasons.
8814
Bram Moolenaar071d4272004-06-13 20:20:40 +00008815 *'winwidth'* *'wiw'* *E592*
8816'winwidth' 'wiw' number (default 20)
8817 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818 Minimal number of columns for the current window. This is not a hard
8819 minimum, Vim will use fewer columns if there is not enough room. If
8820 the current window is smaller, its size is increased, at the cost of
8821 the width of other windows. Set it to 999 to make the current window
8822 always fill the screen. Set it to a small number for normal editing.
8823 The width is not adjusted after one of the commands to change the
8824 width of the current window.
8825 'winwidth' applies to the current window. Use 'winminwidth' to set
8826 the minimal width for other windows.
8827
8828 *'wrap'* *'nowrap'*
8829'wrap' boolean (default on)
8830 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008831 This option changes how text is displayed. It doesn't change the text
8832 in the buffer, see 'textwidth' for that.
8833 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008834 displaying continues on the next line. When off lines will not wrap
8835 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008836 moved to a part that is not shown, the screen will scroll
8837 horizontally.
8838 The line will be broken in the middle of a word if necessary. See
8839 'linebreak' to get the break at a word boundary.
8840 To make scrolling horizontally a bit more useful, try this: >
8841 :set sidescroll=5
8842 :set listchars+=precedes:<,extends:>
8843< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008844 This option can't be set from a |modeline| when the 'diff' option is
8845 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846
8847 *'wrapmargin'* *'wm'*
8848'wrapmargin' 'wm' number (default 0)
8849 local to buffer
8850 Number of characters from the right window border where wrapping
8851 starts. When typing text beyond this limit, an <EOL> will be inserted
8852 and inserting continues on the next line.
8853 Options that add a margin, such as 'number' and 'foldcolumn', cause
8854 the text width to be further reduced. This is Vi compatible.
8855 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008856 This option is set to 0 when 'paste' is set and restored when 'paste'
8857 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008858 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008859
8860 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8861'wrapscan' 'ws' boolean (default on) *E384* *E385*
8862 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008863 Searches wrap around the end of the file. Also applies to |]s| and
8864 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008865
8866 *'write'* *'nowrite'*
8867'write' boolean (default on)
8868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008869 Allows writing files. When not set, writing a file is not allowed.
8870 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008871 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008872 argument. Filtering text is still possible, even though this requires
8873 writing a temporary file.
8874
8875 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8876'writeany' 'wa' boolean (default off)
8877 global
8878 Allows writing to any file with no need for "!" override.
8879
8880 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8881'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8882 otherwise)
8883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008884 Make a backup before overwriting a file. The backup is removed after
8885 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008886 also on.
8887 WARNING: Switching this option off means that when Vim fails to write
8888 your buffer correctly and then, for whatever reason, Vim exits, you
8889 lose both the original file and what you were writing. Only reset
8890 this option if your file system is almost full and it makes the write
8891 fail (and make sure not to exit Vim until the write was successful).
8892 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008893 When the 'backupskip' pattern matches, a backup is not made anyway.
8894 NOTE: This option is set to the default value when 'compatible' is
8895 set.
8896
8897 *'writedelay'* *'wd'*
8898'writedelay' 'wd' number (default 0)
8899 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008900 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008901 screen. When non-zero, characters are sent to the terminal one by
8902 one. For MS-DOS pcterm this does not work. For debugging purposes.
8903
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008904 vim:tw=78:ts=8:noet:ft=help:norl: