blob: 0d5586357d8b62ceb89e2563e0a8ea1714ae7c3a [file] [log] [blame]
Bram Moolenaar85850f32019-07-19 22:05:51 +02001*options.txt* For Vim version 8.1. Last change: 2019 Jul 18
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020045:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000046
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049 current value of 'compatible'.
50:se[t] {option}&vi Reset option to its Vi default value.
51:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000052
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010053:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020054 these options are not changed:
55 all terminal options, starting with t_
56 'columns'
57 'cryptmethod'
58 'encoding'
59 'key'
60 'lines'
61 'term'
62 'ttymouse'
63 'ttytype'
64 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000065
66 *:set-args* *E487* *E521*
67:se[t] {option}={value} or
68:se[t] {option}:{value}
69 Set string or number option to {value}.
70 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010071 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000072 The old value can be inserted by typing 'wildchar' (by
73 default this is a <Tab> or CTRL-E if 'compatible' is
74 set). See |cmdline-completion|.
75 White space between {option} and '=' is allowed and
76 will be ignored. White space between '=' and {value}
77 is not allowed.
78 See |option-backslash| for using white space and
79 backslashes in {value}.
80
81:se[t] {option}+={value} *:set+=*
82 Add the {value} to a number option, or append the
83 {value} to a string option. When the option is a
84 comma separated list, a comma is added, unless the
85 value was empty.
86 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000087 are removed. When adding a flag that was already
88 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000089 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000090
91:se[t] {option}^={value} *:set^=*
92 Multiply the {value} to a number option, or prepend
93 the {value} to a string option. When the option is a
94 comma separated list, a comma is added, unless the
95 value was empty.
96 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000097
98:se[t] {option}-={value} *:set-=*
99 Subtract the {value} from a number option, or remove
100 the {value} from a string option, if it is there.
101 If the {value} is not found in a string option, there
102 is no error or warning. When the option is a comma
103 separated list, a comma is deleted, unless the option
104 becomes empty.
105 When the option is a list of flags, {value} must be
106 exactly as they appear in the option. Remove flags
107 one by one to avoid problems.
108 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109
110The {option} arguments to ":set" may be repeated. For example: >
111 :set ai nosi sw=3 ts=3
112If you make an error in one of the arguments, an error message will be given
113and the following arguments will be ignored.
114
115 *:set-verbose*
116When 'verbose' is non-zero, displaying an option value will also tell where it
117was last set. Example: >
118 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200119< shiftwidth=4 ~
120 Last set from modeline line 1 ~
121 cindent ~
122 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123This is only done when specific option values are requested, not for ":verbose
124set all" or ":verbose set" without an argument.
125When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000126When the option was set while executing a function, user command or
127autocommand, the script in which it was defined is reported.
128Note that an option may also have been set as a side effect of setting
129'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000130A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200131 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000132 Option was set in a |modeline|.
133 Last set from --cmd argument ~
134 Option was set with command line argument |--cmd| or +.
135 Last set from -c argument ~
136 Option was set with command line argument |-c|, +, |-S| or
137 |-q|.
138 Last set from environment variable ~
139 Option was set from an environment variable, $VIMINIT,
140 $GVIMINIT or $EXINIT.
141 Last set from error handler ~
142 Option was cleared when evaluating it resulted in an error.
143
Bram Moolenaardb84e452010-08-15 13:50:43 +0200144{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145
146 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000147For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148override the value from the termcap. You can then use it in a mapping. If
149the "xx" part contains special characters, use the <t_xx> form: >
150 :set <t_#4>=^[Ot
151This can also be used to translate a special code for a normal key. For
152example, if Alt-b produces <Esc>b, use this: >
153 :set <M-b>=^[b
154(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
155The advantage over a mapping is that it works in all situations.
156
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100157You can define any key codes, e.g.: >
158 :set t_xy=^[foo;
159There is no warning for using a name that isn't recognized. You can map these
160codes as you like: >
161 :map <t_xy> something
162< *E846*
163When a key code is not set, it's like it does not exist. Trying to get its
164value will result in an error: >
165 :set t_kb=
166 :set t_kb
167 E846: Key code not set: t_kb
168
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000169The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
170security reasons.
171
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000173at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174"set all" probably does not fit on the screen, causing Vim to give the
175|more-prompt|.
176
177 *option-backslash*
178To include white space in a string option value it has to be preceded with a
179backslash. To include a backslash you have to use two. Effectively this
180means that the number of backslashes in an option value is halved (rounded
181down).
182A few examples: >
183 :set tags=tags\ /usr/tags results in "tags /usr/tags"
184 :set tags=tags\\,file results in "tags\,file"
185 :set tags=tags\\\ file results in "tags\ file"
186
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000187The "|" character separates a ":set" command from a following command. To
188include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189'titlestring' option to "hi|there": >
190 :set titlestring=hi\|there
191This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
192 :set titlestring=hi|set iconstring=there
193
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000194Similarly, the double quote character starts a comment. To include the '"' in
195the option value, use '\"' instead. This example sets the 'titlestring'
196option to 'hi "there"': >
197 :set titlestring=hi\ \"there\"
198
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000199For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200precise: For options that expect a file name (those where environment
201variables are expanded) a backslash before a normal file name character is not
202removed. But a backslash before a special character (space, backslash, comma,
203etc.) is used like explained above.
204There is one special situation, when the value starts with "\\": >
205 :set dir=\\machine\path results in "\\machine\path"
206 :set dir=\\\\machine\\path results in "\\machine\path"
207 :set dir=\\path\\file results in "\\path\file" (wrong!)
208For the first one the start is kept, but for the second one the backslashes
209are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000210halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211result which is probably not what you want. Avoid it.
212
213 *add-option-flags* *remove-option-flags*
214 *E539* *E550* *E551* *E552*
215Some options are a list of flags. When you want to add a flag to such an
216option, without changing the existing ones, you can do it like this: >
217 :set guioptions+=a
218Remove a flag from an option like this: >
219 :set guioptions-=a
220This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000221Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
223doesn't appear.
224
225 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000226Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227environment variable exists the '$' and the following environment variable
228name is replaced with its value. If it does not exist the '$' and the name
229are not modified. Any non-id character (not a letter, digit or '_') may
230follow the environment variable name. That character and what follows is
231appended to the value of the environment variable. Examples: >
232 :set term=$TERM.new
233 :set path=/usr/$INCLUDE,$HOME/include,.
234When adding or removing a string from an option with ":set opt-=val" or ":set
235opt+=val" the expansion is done before the adding or removing.
236
237
238Handling of local options *local-options*
239
240Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100241has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242allows you to set 'list' in one window but not in another. And set
243'shiftwidth' to 3 in one buffer and 4 in another.
244
245The following explains what happens to these local options in specific
246situations. You don't really need to know all of this, since Vim mostly uses
247the option values you would expect. Unfortunately, doing what the user
248expects is a bit complicated...
249
250When splitting a window, the local options are copied to the new window. Thus
251right after the split the contents of the two windows look the same.
252
253When editing a new buffer, its local option values must be initialized. Since
254the local options of the current buffer might be specifically for that buffer,
255these are not used. Instead, for each buffer-local option there also is a
256global value, which is used for new buffers. With ":set" both the local and
257global value is changed. With "setlocal" only the local value is changed,
258thus this value is not used when editing a new buffer.
259
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200260When editing a buffer that has been edited before, the options from the window
261that was last closed are used again. If this buffer has been edited in this
262window, the values from back then are used. Otherwise the values from the
263last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264
265It's possible to set a local window option specifically for a type of buffer.
266When you edit another buffer in the same window, you don't want to keep
267using these local window options. Therefore Vim keeps a global value of the
268local window options, which is used when editing another buffer. Each window
269has its own copy of these values. Thus these are local to the window, but
270global to all buffers in the window. With this you can do: >
271 :e one
272 :set list
273 :e two
274Now the 'list' option will also be set in "two", since with the ":set list"
275command you have also set the global value. >
276 :set nolist
277 :e one
278 :setlocal list
279 :e two
280Now the 'list' option is not set, because ":set nolist" resets the global
281value, ":setlocal list" only changes the local value and ":e two" gets the
282global value. Note that if you do this next: >
283 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200284You will get back the 'list' value as it was the last time you edited "one".
285The options local to a window are remembered for each buffer. This also
286happens when the buffer is not loaded, but they are lost when the buffer is
287wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000288
289 *:setl* *:setlocal*
290:setl[ocal] ... Like ":set" but set only the value local to the
291 current buffer or window. Not all options have a
292 local value. If the option does not have a local
293 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200294 With the "all" argument: display local values for all
295 local options.
296 Without argument: Display local values for all local
297 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000299 local value. For a global/local boolean option, when
300 the global value is being used, "--" is displayed
301 before the option name.
302 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000305:setl[ocal] {option}< Set the local value of {option} to its global value by
306 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000307
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100308:se[t] {option}< For |global-local| options: Remove the local value of
309 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310
311 *:setg* *:setglobal*
312:setg[lobal] ... Like ":set" but set only the global value for a local
313 option without changing the local value.
314 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200315 With the "all" argument: display global values for all
316 local options.
317 Without argument: display global values for all local
318 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319
320For buffer-local and window-local options:
321 Command global value local value ~
322 :set option=value set set
323 :setlocal option=value - set
324:setglobal option=value set -
325 :set option? - display
326 :setlocal option? - display
327:setglobal option? display -
328
329
330Global options with a local value *global-local*
331
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000332Options are global when you mostly use one value for all buffers and windows.
333For some global options it's useful to sometimes have a different local value.
334You can set the local value with ":setlocal". That buffer or window will then
335use the local value, while other buffers and windows continue using the global
336value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337
338For example, you have two windows, both on C source code. They use the global
339'makeprg' option. If you do this in one of the two windows: >
340 :set makeprg=gmake
341then the other window will switch to the same value. There is no need to set
342the 'makeprg' option in the other C source window too.
343However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000344another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000345files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346 :setlocal makeprg=perlmake
347You can switch back to using the global value by making the local value empty: >
348 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100349This only works for a string option. For a number or boolean option you need
350to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100352Note that for non-boolean and non-number options using "<" copies the global
353value to the local value, it doesn't switch back to using the global value
354(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000355 :set path<
356This will make the local value of 'path' empty, so that the global value is
357used. Thus it does the same as: >
358 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359Note: In the future more global options can be made global-local. Using
360":setlocal" on a global option might work differently then.
361
362
363Setting the filetype
364
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200365:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366 Set the 'filetype' option to {filetype}, but only if
367 not done yet in a sequence of (nested) autocommands.
368 This is short for: >
369 :if !did_filetype()
370 : setlocal filetype={filetype}
371 :endif
372< This command is used in a filetype.vim file to avoid
373 setting the 'filetype' option twice, causing different
374 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200375
376 When the optional FALLBACK argument is present, a
377 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100378 'filetype'. This is to be used for filetype
379 detections that are just a guess. |did_filetype()|
380 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200381
Bram Moolenaard58e9292011-02-09 17:07:58 +0100382 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
384:opt[ions] Open a window for viewing and setting all options.
385 Options are grouped by function.
386 Offers short help for each option. Hit <CR> on the
387 short help to open a help window with more help for
388 the option.
389 Modify the value of the option and hit <CR> on the
390 "set" line to set the new value. For window and
391 buffer specific options, the last accessed window is
392 used to set the option value in, unless this is a help
393 window, in which case the window below help window is
394 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100395 {not available when compiled without the |+eval|
396 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397
398 *$HOME*
399Using "~" is like using "$HOME", but it is only recognized at the start of an
400option and after a space or comma.
401
402On Unix systems "~user" can be used too. It is replaced by the home directory
403of user "user". Example: >
404 :set path=~mool/include,/usr/include,.
405
406On Unix systems the form "${HOME}" can be used too. The name between {} can
407contain non-id characters then. Note that if you want to use this for the
408"gf" command, you need to add the '{' and '}' characters to 'isfname'.
409
410NOTE: expanding environment variables and "~/" is only done with the ":set"
411command, not when assigning a value to an option with ":let".
412
Bram Moolenaarc572da52017-08-27 16:52:01 +0200413 *$HOME-windows*
414On MS-Windows, if $HOME is not defined as an environment variable, then
415at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200416If $HOMEDRIVE is not set then $USERPROFILE is used.
417
418This expanded value is not exported to the environment, this matters when
419running an external command: >
420 :echo system('set | findstr ^HOME=')
421and >
422 :echo luaeval('os.getenv("HOME")')
423should echo nothing (an empty string) despite exists('$HOME') being true.
424When setting $HOME to a non-empty string it will be exported to the
425subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200426
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427
428Note the maximum length of an expanded option is limited. How much depends on
429the system, mostly it is something like 256 or 1024 characters.
430
431 *:fix* *:fixdel*
432:fix[del] Set the value of 't_kD':
433 't_kb' is 't_kD' becomes ~
434 CTRL-? CTRL-H
435 not CTRL-? CTRL-?
436
Bram Moolenaar6c60f472019-04-28 16:00:35 +0200437 (CTRL-? is 0177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438
439 If your delete key terminal code is wrong, but the
440 code for backspace is alright, you can put this in
441 your .vimrc: >
442 :fixdel
443< This works no matter what the actual code for
444 backspace is.
445
446 If the backspace key terminal code is wrong you can
447 use this: >
448 :if &term == "termname"
449 : set t_kb=^V<BS>
450 : fixdel
451 :endif
452< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000453 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454 with your terminal name.
455
456 If your <Delete> key sends a strange key sequence (not
457 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
458 :if &term == "termname"
459 : set t_kD=^V<Delete>
460 :endif
461< Where "^V" is CTRL-V and "<Delete>" is the delete key
462 (don't type eight characters!). Replace "termname"
463 with your terminal name.
464
465 *Linux-backspace*
466 Note about Linux: By default the backspace key
467 produces CTRL-?, which is wrong. You can fix it by
468 putting this line in your rc.local: >
469 echo "keycode 14 = BackSpace" | loadkeys
470<
471 *NetBSD-backspace*
472 Note about NetBSD: If your backspace doesn't produce
473 the right code, try this: >
474 xmodmap -e "keycode 22 = BackSpace"
475< If this works, add this in your .Xmodmap file: >
476 keysym 22 = BackSpace
477< You need to restart for this to take effect.
478
479==============================================================================
4802. Automatically setting options *auto-setting*
481
482Besides changing options with the ":set" command, there are three alternatives
483to set options automatically for one or more files:
484
4851. When starting Vim initializations are read from various places. See
486 |initialization|. Most of them are performed for all editing sessions,
487 and some of them depend on the directory where Vim is started.
488 You can create an initialization file with |:mkvimrc|, |:mkview| and
489 |:mksession|.
4902. If you start editing a new file, the automatic commands are executed.
491 This can be used to set options for files matching a particular pattern and
492 many other things. See |autocommand|.
4933. If you start editing a new file, and the 'modeline' option is on, a
494 number of lines at the beginning and end of the file are checked for
495 modelines. This is explained here.
496
497 *modeline* *vim:* *vi:* *ex:* *E520*
498There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200499 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200501[text] any text or empty
502{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200504[white] optional white space
505{options} a list of option settings, separated with white space
506 or ':', where each part between ':' is the argument
507 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar14b69452013-06-29 23:05:20 +0200509Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000510 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200511 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000512
513The second form (this is compatible with some versions of Vi):
514
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200515 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000516
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200517[text] any text or empty
518{white} at least one blank character (<Space> or <Tab>)
519{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
520[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200521se[t] the string "set " or "se " (note the space); When
522 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200523{options} a list of options, separated with white space, which
524 is the argument for a ":set" command
525: a colon
526[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527
Bram Moolenaar14b69452013-06-29 23:05:20 +0200528Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000529 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200530 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000531
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200532The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
533chance that a normal word like "lex:" is caught. There is one exception:
534"vi:" and "vim:" can also be at the start of the line (for compatibility with
535version 3.0). Using "ex:" at the start of the line will be ignored (this
536could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538 *modeline-local*
539The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000540buffer and window that contain the file. Although it's possible to set global
541options from a modeline, this is unusual. If you have two windows open and
542the files in it set the same global option to a different value, the result
543depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000545When editing a file that was already loaded, only the window-local options
546from the modeline are used. Thus if you manually changed a buffer-local
547option after opening the file, it won't be changed if you edit the same buffer
548in another window. But window-local options will be set.
549
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 *modeline-version*
551If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200552number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553 vim{vers}: version {vers} or later
554 vim<{vers}: version before {vers}
555 vim={vers}: version {vers}
556 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100557{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
558For example, to use a modeline only for Vim 7.0:
559 /* vim700: set foldmethod=marker */ ~
560To use a modeline for Vim after version 7.2:
561 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562There can be no blanks between "vim" and the ":".
563
564
565The number of lines that are checked can be set with the 'modelines' option.
566If 'modeline' is off or 'modelines' is 0 no lines are checked.
567
568Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000569like:
570 /* vi:ts=4: */ ~
571will give an error message for the trailing "*/". This line is OK:
572 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573
574If an error is detected the rest of the line is skipped.
575
576If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000577backslash in front of the ':' will be removed. Example:
578 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579This sets the 'dir' option to "c:\tmp". Only a single backslash before the
580':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200581 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000583might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200584can be set. For some options a flag is set, so that when the value is used
585the |sandbox| is effective. Some options can only be set from the modeline
586when 'modelineexpr' is set (the default is off).
587
588Still, there is always a small risk that a modeline causes trouble. E.g.,
589when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
590So disable modelines before editing untrusted text. The mail ftplugin does
591this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592
593Hint: If you would like to do something else than setting an option, you could
594define an autocommand that checks the file for a specific string. For
595example: >
596 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
597And define a function SetVar() that does something with the line containing
598"VAR".
599
600==============================================================================
6013. Options summary *option-summary*
602
603In the list below all the options are mentioned with their full name and with
604an abbreviation if there is one. Both forms may be used.
605
606In this document when a boolean option is "set" that means that ":set option"
607is entered. When an option is "reset", ":set nooption" is used.
608
609For some options there are two default values: The "Vim default", which is
610used when 'compatible' is not set, and the "Vi default", which is used when
611'compatible' is set.
612
613Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000614are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615different value in each window. For example the 'list' option can be set in
616one window and reset in another for the same text, giving both types of view
617at the same time. There are a few options that are specific to a certain
618file. These can have a different value for each file or buffer. For example
619the 'textwidth' option can be 78 for a normal text file and 0 for a C
620program.
621
622 global one option for all buffers and windows
623 local to window each window has its own copy of this option
624 local to buffer each buffer has its own copy of this option
625
626When creating a new window the option values from the currently active window
627are used as a default value for the window-specific options. For the
628buffer-specific options this depends on the 's' and 'S' flags in the
629'cpoptions' option. If 's' is included (which is the default) the values for
630buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000631first entered. If 'S' is present the options are copied each time the buffer
632is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633present, the options are copied from the currently active buffer when the
634buffer is created.
635
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000636Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000637
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000638Not all options are supported in all versions. This depends on the supported
639features and sometimes on the system. A remark about this is in curly braces
640below. When an option is not supported it may still be set without getting an
641error, this is called a hidden option. You can't get the value of a hidden
642option though, it is not stored.
643
644To test if option "foo" can be used with ":set" use something like this: >
645 if exists('&foo')
646This also returns true for a hidden option. To test if option "foo" is really
647supported use something like this: >
648 if exists('+foo')
649<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 *E355*
651A jump table for the options with a short description can be found at |Q_op|.
652
653 *'aleph'* *'al'* *aleph* *Aleph*
654'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 {only available when compiled with the |+rightleft|
657 feature}
658 The ASCII code for the first letter of the Hebrew alphabet. The
659 routine that maps the keyboard in Hebrew mode, both in Insert mode
660 (when hkmap is set) and on the command-line (when hitting CTRL-_)
661 outputs the Hebrew characters in the range [aleph..aleph+26].
662 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
663 See |rileft.txt|.
664
665 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
666'allowrevins' 'ari' boolean (default off)
667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668 {only available when compiled with the |+rightleft|
669 feature}
670 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
671 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
672 into reverse Insert mode, and don't know how to get out. See
673 'revins'.
674 NOTE: This option is reset when 'compatible' is set.
675
676 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
677'altkeymap' 'akm' boolean (default off)
678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679 {only available when compiled with the |+farsi|
680 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100681 This option was for using Farsi, which has been removed. See
682 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683
684 *'ambiwidth'* *'ambw'*
685'ambiwidth' 'ambw' string (default: "single")
686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
688 Tells Vim what to do with characters with East Asian Width Class
689 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
690 letters, Cyrillic letters).
691
692 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 expected by most users.
695 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200696 *E834* *E835*
697 The value "double" cannot be used if 'listchars' or 'fillchars'
698 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700 There are a number of CJK fonts for which the width of glyphs for
701 those characters are solely based on how many octets they take in
702 legacy/traditional CJK encodings. In those encodings, Euro,
703 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000704 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000706 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 Vim is running inside a terminal (emulators) that uses a CJK font
708 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
709 this option should be set to "double" to match the width perceived
710 by Vim with the width of glyphs in the font. Perhaps it also has
711 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
712 when the system locale is set to one of CJK locales. See Unicode
713 Standard Annex #11 (http://www.unicode.org/reports/tr11).
714
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100715 Vim may set this option automatically at startup time when Vim is
716 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200717 escape sequence to request cursor position report. The response can
718 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100719
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
721'antialias' 'anti' boolean (default: off)
722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 {only available when compiled with GUI enabled
724 on Mac OS X}
725 This option only has an effect in the GUI version of Vim on Mac OS X
726 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
727 which can be easier to read at certain sizes on certain displays.
728 Setting this option can sometimes cause problems if 'guifont' is set
729 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100730 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731
732 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
733'autochdir' 'acd' boolean (default off)
734 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200735 {only available when compiled with it, use
736 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000737 When on, Vim will change the current working directory whenever you
738 open a file, switch buffers, delete a buffer or open/close a window.
739 It will change to the directory containing the file which was opened
740 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000741 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742
743 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
744'arabic' 'arab' boolean (default off)
745 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 {only available when compiled with the |+arabic|
747 feature}
748 This option can be set to start editing Arabic text.
749 Setting this option will:
750 - Set the 'rightleft' option, unless 'termbidi' is set.
751 - Set the 'arabicshape' option, unless 'termbidi' is set.
752 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
753 between typing English and Arabic key mapping.
754 - Set the 'delcombine' option
755 Note that 'encoding' must be "utf-8" for working with Arabic text.
756
757 Resetting this option will:
758 - Reset the 'rightleft' option.
759 - Disable the use of 'keymap' (without changing its value).
760 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200761 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100762 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 Also see |arabic.txt|.
764
765 *'arabicshape'* *'arshape'*
766 *'noarabicshape'* *'noarshape'*
767'arabicshape' 'arshape' boolean (default on)
768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 {only available when compiled with the |+arabic|
770 feature}
771 When on and 'termbidi' is off, the required visual character
772 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200773 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 one which encompasses:
775 a) the changing/morphing of characters based on their location
776 within a word (initial, medial, final and stand-alone).
777 b) the enabling of the ability to compose characters
778 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100779 When disabled the display shows each character's true stand-alone
780 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 Arabic is a complex language which requires other settings, for
782 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100783 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784
785 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
786'autoindent' 'ai' boolean (default off)
787 local to buffer
788 Copy indent from current line when starting a new line (typing <CR>
789 in Insert mode or when using the "o" or "O" command). If you do not
790 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000791 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
792 to another line has the same effect, unless the 'I' flag is included
793 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000794 When autoindent is on, formatting (with the "gq" command or when you
795 reach 'textwidth' in Insert mode) uses the indentation of the first
796 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 When 'smartindent' or 'cindent' is on the indent is changed in
798 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200799 The 'autoindent' option is reset when the 'paste' option is set and
800 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801
802 *'autoread'* *'ar'* *'noautoread'* *'noar'*
803'autoread' 'ar' boolean (default off)
804 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805 When a file has been detected to have been changed outside of Vim and
806 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200807 When the file has been deleted this is not done, so you have the text
808 from before it was deleted. When it appears again then it is read.
809 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 If this option has a local value, use this command to switch back to
811 using the global value: >
812 :set autoread<
813<
814 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
815'autowrite' 'aw' boolean (default off)
816 global
817 Write the contents of the file, if it has been modified, on each
818 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000819 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
821 Note that for some commands the 'autowrite' option is not used, see
822 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200823 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200824 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
826 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
827'autowriteall' 'awa' boolean (default off)
828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
830 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
831 Setting this option also implies that Vim behaves like 'autowrite' has
832 been set.
833
834 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200835'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 When set to "dark", Vim will try to use colors that look good on a
838 dark background. When set to "light", Vim will try to use colors that
839 look good on a light background. Any other value is illegal.
840 Vim tries to set the default value according to the terminal used.
841 This will not always be correct.
842 Setting this option does not change the background color, it tells Vim
843 what the background color looks like. For changing the background
844 color, see |:hi-normal|.
845
846 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000847 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000848 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100849 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 setting 'background' will cause the color scheme to be reloaded. If
851 the color scheme adjusts to the value of 'background' this will work.
852 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100853 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854
855 When setting 'background' to the default value with: >
856 :set background&
857< Vim will guess the value. In the GUI this should work correctly,
858 in other cases Vim might not be able to guess the right value.
859
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200860 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200861 color from the terminal. If the returned RGB value is dark/light and
862 'background' is not dark/light, 'background' will be set and the
863 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200864 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100865 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200866
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 When starting the GUI, the default value for 'background' will be
868 "light". When the value is not set in the .gvimrc, and Vim detects
869 that the background is actually quite dark, 'background' is set to
870 "dark". But this happens only AFTER the .gvimrc file has been read
871 (because the window needs to be opened to find the actual background
872 color). To get around this, force the GUI window to be opened by
873 putting a ":gui" command in the .gvimrc file, before where the value
874 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200875
876 For MS-DOS, Windows and OS/2 the default is "dark".
877 For other systems "dark" is used when 'term' is "linux",
878 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
879 background. Otherwise the default is "light".
880
Bram Moolenaarc572da52017-08-27 16:52:01 +0200881 The |:terminal| command and the |term_start()| function use the
882 'background' value to decide whether the terminal window will start
883 with a white or black background.
884
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 Normally this option would be set in the .vimrc file. Possibly
886 depending on the terminal name. Example: >
887 :if &term == "pcterm"
888 : set background=dark
889 :endif
890< When this option is set, the default settings for the highlight groups
891 will change. To use other settings, place ":highlight" commands AFTER
892 the setting of the 'background' option.
893 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
894 to select the colors for syntax highlighting. After changing this
895 option, you must load syntax.vim again to see the result. This can be
896 done with ":syntax on".
897
898 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200899'backspace' 'bs' string (default "", set to "indent,eol,start"
900 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
903 mode. This is a list of items, separated by commas. Each item allows
904 a way to backspace over something:
905 value effect ~
906 indent allow backspacing over autoindent
907 eol allow backspacing over line breaks (join lines)
908 start allow backspacing over the start of insert; CTRL-W and CTRL-U
909 stop once at the start of insert.
910
911 When the value is empty, Vi compatible backspacing is used.
912
913 For backwards compatibility with version 5.4 and earlier:
914 value effect ~
915 0 same as ":set backspace=" (Vi compatible)
916 1 same as ":set backspace=indent,eol"
917 2 same as ":set backspace=indent,eol,start"
918
919 See |:fixdel| if your <BS> or <Del> key does not do what you want.
920 NOTE: This option is set to "" when 'compatible' is set.
921
922 *'backup'* *'bk'* *'nobackup'* *'nobk'*
923'backup' 'bk' boolean (default off)
924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 Make a backup before overwriting a file. Leave it around after the
926 file has been successfully written. If you do not want to keep the
927 backup file, but you do want a backup while the file is being
928 written, reset this option and set the 'writebackup' option (this is
929 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000930 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931 |backup-table| for more explanations.
932 When the 'backupskip' pattern matches, a backup is not made anyway.
933 When 'patchmode' is set, the backup may be renamed to become the
934 oldest version of a file.
935 NOTE: This option is reset when 'compatible' is set.
936
937 *'backupcopy'* *'bkc'*
938'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200939 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 When writing a file and a backup is made, this option tells how it's
941 done. This is a comma separated list of words.
942
943 The main values are:
944 "yes" make a copy of the file and overwrite the original one
945 "no" rename the file and write a new one
946 "auto" one of the previous, what works best
947
948 Extra values that can be combined with the ones above are:
949 "breaksymlink" always break symlinks when writing
950 "breakhardlink" always break hardlinks when writing
951
952 Making a copy and overwriting the original file:
953 - Takes extra time to copy the file.
954 + When the file has special attributes, is a (hard/symbolic) link or
955 has a resource fork, all this is preserved.
956 - When the file is a link the backup will have the name of the link,
957 not of the real file.
958
959 Renaming the file and writing a new one:
960 + It's fast.
961 - Sometimes not all attributes of the file can be copied to the new
962 file.
963 - When the file is a link the new file will not be a link.
964
965 The "auto" value is the middle way: When Vim sees that renaming file
966 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000967 the file is not a link) that is used. When problems are expected, a
968 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969
970 The "breaksymlink" and "breakhardlink" values can be used in
971 combination with any of "yes", "no" and "auto". When included, they
972 force Vim to always break either symbolic or hard links by doing
973 exactly what the "no" option does, renaming the original file to
974 become the backup and writing a new file in its place. This can be
975 useful for example in source trees where all the files are symbolic or
976 hard links and any changes should stay in the local source tree, not
977 be propagated back to the original source.
978 *crontab*
979 One situation where "no" and "auto" will cause problems: A program
980 that opens a file, invokes Vim to edit that file, and then tests if
981 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000982 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983 example.
984
985 When a copy is made, the original file is truncated and then filled
986 with the new text. This means that protection bits, owner and
987 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000988 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 group of the backup is set to the group of the original file. If this
990 fails, the protection bits for the group are made the same as for
991 others.
992
993 When the file is renamed this is the other way around: The backup has
994 the same attributes of the original file, and the newly written file
995 is owned by the current user. When the file was a (hard/symbolic)
996 link, the new file will not! That's why the "auto" value doesn't
997 rename when the file is a link. The owner and group of the newly
998 written file will be set to the same ones as the original file, but
999 the system may refuse to do this. In that case the "auto" value will
1000 again not rename the file.
1001
Bram Moolenaar036986f2017-03-16 17:41:02 +01001002 NOTE: This option is set to the Vi default value when 'compatible' is
1003 set and to the Vim default value when 'compatible' is reset.
1004
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 *'backupdir'* *'bdir'*
1006'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001007 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 for Unix: ".,~/tmp,~/")
1009 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 List of directories for the backup file, separated with commas.
1011 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001012 where this is possible. The directory must exist, Vim will not
1013 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001014 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015 impossible!). Writing may fail because of this.
1016 - A directory "." means to put the backup file in the same directory
1017 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001018 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019 put the backup file relative to where the edited file is. The
1020 leading "." is replaced with the path name of the edited file.
1021 ("." inside a directory name has no special meaning).
1022 - Spaces after the comma are ignored, other spaces are considered part
1023 of the directory name. To have a space at the start of a directory
1024 name, precede it with a backslash.
1025 - To include a comma in a directory name precede it with a backslash.
1026 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001027 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001028 the backup file name will be built from the complete path to the
1029 file with all path separators changed to percent '%' signs. This
1030 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001031 On Win32, it is also possible to end with "\\". However, When a
1032 separating comma is following, you must use "//", since "\\" will
1033 include the comma in the file name. Therefore it is recommended to
1034 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035 - Environment variables are expanded |:set_env|.
1036 - Careful with '\' characters, type one before a space, type two to
1037 get one in the option (see |option-backslash|), for example: >
1038 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1039< - For backwards compatibility with Vim version 3.0 a '>' at the start
1040 of the option is removed.
1041 See also 'backup' and 'writebackup' options.
1042 If you want to hide your backup files on Unix, consider this value: >
1043 :set backupdir=./.backup,~/.backup,.,/tmp
1044< You must create a ".backup" directory in each directory and in your
1045 home directory for this to work properly.
1046 The use of |:set+=| and |:set-=| is preferred when adding or removing
1047 directories from the list. This avoids problems when a future version
1048 uses another default.
1049 This option cannot be set from a |modeline| or in the |sandbox|, for
1050 security reasons.
1051
1052 *'backupext'* *'bex'* *E589*
1053'backupext' 'bex' string (default "~", for VMS: "_")
1054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001055 String which is appended to a file name to make the name of the
1056 backup file. The default is quite unusual, because this avoids
1057 accidentally overwriting existing files with a backup file. You might
1058 prefer using ".bak", but make sure that you don't have files with
1059 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001060 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001062 If you like to keep a lot of backups, you could use a BufWritePre
1063 autocommand to change 'backupext' just before writing the file to
1064 include a timestamp. >
1065 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1066< Use 'backupdir' to put the backup in a different directory.
1067
Bram Moolenaar071d4272004-06-13 20:20:40 +00001068 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001069'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1070 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1071 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 {not available when compiled without the |+wildignore|
1074 feature}
1075 A list of file patterns. When one of the patterns matches with the
1076 name of the file which is written, no backup file is created. Both
1077 the specified file name and the full path name of the file are used.
1078 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1079 Watch out for special characters, see |option-backslash|.
1080 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001081 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001082
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001083 WARNING: Not having a backup file means that when Vim fails to write
1084 your buffer correctly and then, for whatever reason, Vim exits, you
1085 lose both the original file and what you were writing. Only disable
1086 backups if you don't care about losing the file.
1087
Bram Moolenaar02467872007-05-06 13:22:01 +00001088 Note that environment variables are not expanded. If you want to use
1089 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001090 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001091
1092< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001093 backup would be made by renaming the original file crontab won't see
1094 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
1096 *'balloondelay'* *'bdlay'*
1097'balloondelay' 'bdlay' number (default: 600)
1098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 {only available when compiled with the |+balloon_eval|
1100 feature}
1101 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1102
1103 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1104'ballooneval' 'beval' boolean (default off)
1105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001107 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001108 Switch on the |balloon-eval| functionality for the GUI.
1109
1110 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1111 *'nobevalterm'*
1112'balloonevalterm' 'bevalterm' boolean (default off)
1113 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001114 {only available when compiled with the
1115 |+balloon_eval_term| feature}
1116 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001118 *'balloonexpr'* *'bexpr'*
1119'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001120 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001121 {only available when compiled with the |+balloon_eval|
1122 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001123 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001124 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1125 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001126
1127 v:beval_bufnr number of the buffer in which balloon is going to show
1128 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001129 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001130 v:beval_lnum line number
1131 v:beval_col column number (byte index)
1132 v:beval_text word under or after the mouse pointer
1133
1134 The evaluation of the expression must not have side effects!
1135 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001136 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001137 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001138 \', column ' . v:beval_col .
1139 \ ' of file ' . bufname(v:beval_bufnr) .
1140 \ ' on word "' . v:beval_text . '"'
1141 endfunction
1142 set bexpr=MyBalloonExpr()
1143 set ballooneval
1144<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001145 Also see |balloon_show()|, it can be used if the content of the balloon
1146 is to be fetched asynchronously. In that case evaluating
1147 'balloonexpr' should result in an empty string. If you get a balloon
1148 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001149
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001150 NOTE: The balloon is displayed only if the cursor is on a text
1151 character. If the result of evaluating 'balloonexpr' is not empty,
1152 Vim does not try to send a message to an external debugger (Netbeans
1153 or Sun Workshop).
1154
Bram Moolenaar30b65812012-07-12 22:01:11 +02001155 The expression will be evaluated in the |sandbox| when set from a
1156 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001157 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001158
1159 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001160 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001161
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001162 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001163 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001164< When they are supported "\n" characters will start a new line. If the
1165 expression evaluates to a |List| this is equal to using each List item
1166 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001167 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001168
Bram Moolenaar165bc692015-07-21 17:53:25 +02001169 *'belloff'* *'bo'*
1170'belloff' 'bo' string (default "")
1171 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001172 Specifies for which events the bell will not be rung. It is a comma
1173 separated list of items. For each item that is present, the bell
1174 will be silenced. This is most useful to specify specific events in
1175 insert mode to be silenced.
1176
1177 item meaning when present ~
1178 all All events.
1179 backspace When hitting <BS> or <Del> and deleting results in an
1180 error.
1181 cursor Fail to move around using the cursor keys or
1182 <PageUp>/<PageDown> in |Insert-mode|.
1183 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1184 |i_CTRL-X_CTRL-T|.
1185 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1186 |i_CTRL-E|.
1187 ctrlg Unknown Char after <C-G> in Insert mode.
1188 error Other Error occurred (e.g. try to join last line)
1189 (mostly used in |Normal-mode| or |Cmdline-mode|).
1190 esc hitting <Esc> in |Normal-mode|.
1191 ex In |Visual-mode|, hitting |Q| results in an error.
1192 hangul Error occurred when using hangul input.
1193 insertmode Pressing <Esc> in 'insertmode'.
1194 lang Calling the beep module for Lua/Mzscheme/TCL.
1195 mess No output available for |g<|.
1196 showmatch Error occurred for 'showmatch' function.
1197 operator Empty region error |cpo-E|.
1198 register Unknown register after <C-R> in |Insert-mode|.
1199 shell Bell from shell output |:!|.
1200 spell Error happened on spell suggest.
1201 wildmode More matches in |cmdline-completion| available
1202 (depends on the 'wildmode' setting).
1203
Bram Moolenaar036986f2017-03-16 17:41:02 +01001204 This is most useful to fine tune when in Insert mode the bell should
1205 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001206 indicate that an error occurred. It can be silenced by adding the
1207 "error" keyword.
1208
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1210'binary' 'bin' boolean (default off)
1211 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001212 This option should be set before editing a binary file. You can also
1213 use the |-b| Vim argument. When this option is switched on a few
1214 options will be changed (also when it already was on):
1215 'textwidth' will be set to 0
1216 'wrapmargin' will be set to 0
1217 'modeline' will be off
1218 'expandtab' will be off
1219 Also, 'fileformat' and 'fileformats' options will not be used, the
1220 file is read and written like 'fileformat' was "unix" (a single <NL>
1221 separates lines).
1222 The 'fileencoding' and 'fileencodings' options will not be used, the
1223 file is read without conversion.
1224 NOTE: When you start editing a(nother) file while the 'bin' option is
1225 on, settings from autocommands may change the settings again (e.g.,
1226 'textwidth'), causing trouble when editing. You might want to set
1227 'bin' again when the file has been loaded.
1228 The previous values of these options are remembered and restored when
1229 'bin' is switched from on to off. Each buffer has its own set of
1230 saved option values.
1231 To edit a file with 'binary' set you can use the |++bin| argument.
1232 This avoids you have to do ":set bin", which would have effect for all
1233 files you edit.
1234 When writing a file the <EOL> for the last line is only written if
1235 there was one in the original file (normally Vim appends an <EOL> to
1236 the last line if there is none; this would make the file longer). See
1237 the 'endofline' option.
1238
1239 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1240'bioskey' 'biosk' boolean (default on)
1241 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001242 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001243 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244
1245 *'bomb'* *'nobomb'*
1246'bomb' boolean (default off)
1247 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248 When writing a file and the following conditions are met, a BOM (Byte
1249 Order Mark) is prepended to the file:
1250 - this option is on
1251 - the 'binary' option is off
1252 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1253 endian variants.
1254 Some applications use the BOM to recognize the encoding of the file.
1255 Often used for UCS-2 files on MS-Windows. For other applications it
1256 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001257 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1259 check for the presence of the BOM is done and 'bomb' set accordingly.
1260 Unless 'binary' is set, it is removed from the first line, so that you
1261 don't see it when editing. When you don't change the options, the BOM
1262 will be restored when writing the file.
1263
1264 *'breakat'* *'brk'*
1265'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1266 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001267 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268 feature}
1269 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001270 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1271 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001273 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001274'breakindent' 'bri' boolean (default off)
1275 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001276 {not available when compiled without the |+linebreak|
1277 feature}
1278 Every wrapped line will continue visually indented (same amount of
1279 space as the beginning of that line), thus preserving horizontal blocks
1280 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001281 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001282
1283 *'breakindentopt'* *'briopt'*
1284'breakindentopt' 'briopt' string (default empty)
1285 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001286 {not available when compiled without the |+linebreak|
1287 feature}
1288 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001289 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001290 min:{n} Minimum text width that will be kept after
1291 applying 'breakindent', even if the resulting
1292 text should normally be narrower. This prevents
1293 text indented almost to the right window border
1294 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001295 shift:{n} After applying 'breakindent', the wrapped line's
1296 beginning will be shifted by the given number of
1297 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001298 indentation (negative) or emphasizing the line
1299 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001300 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001301 additional indent.
1302 The default value for min is 20 and shift is 0.
1303
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001305'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001307 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001309 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001310 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001311 buffer Use the directory of the related buffer.
1312 current Use the current directory.
1313 {path} Use the specified directory
1314
1315 *'bufhidden'* *'bh'*
1316'bufhidden' 'bh' string (default: "")
1317 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318 This option specifies what happens when a buffer is no longer
1319 displayed in a window:
1320 <empty> follow the global 'hidden' option
1321 hide hide the buffer (don't unload it), also when 'hidden'
1322 is not set
1323 unload unload the buffer, also when 'hidden' is set or using
1324 |:hide|
1325 delete delete the buffer from the buffer list, also when
1326 'hidden' is set or using |:hide|, like using
1327 |:bdelete|
1328 wipe wipe out the buffer from the buffer list, also when
1329 'hidden' is set or using |:hide|, like using
1330 |:bwipeout|
1331
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001332 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001333 are lost without a warning. Also, these values may break autocommands
1334 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335 This option is used together with 'buftype' and 'swapfile' to specify
1336 special kinds of buffers. See |special-buffers|.
1337
1338 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1339'buflisted' 'bl' boolean (default: on)
1340 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341 When this option is set, the buffer shows up in the buffer list. If
1342 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1343 This option is reset by Vim for buffers that are only used to remember
1344 a file name or marks. Vim sets it when starting to edit a buffer.
1345 But not when moving to a buffer with ":buffer".
1346
1347 *'buftype'* *'bt'* *E382*
1348'buftype' 'bt' string (default: "")
1349 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 The value of this option specifies the type of a buffer:
1351 <empty> normal buffer
1352 nofile buffer which is not related to a file and will not be
1353 written
1354 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001355 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001356 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001358 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001359 help help buffer (you are not supposed to set this
1360 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001361 terminal buffer for a |terminal| (you are not supposed to set
1362 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001363 prompt buffer where only the last line can be edited, meant
1364 to be used by a plugin, see |prompt-buffer|
1365 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001366 popup buffer used in a popup window, see |popup|.
1367 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001368
1369 This option is used together with 'bufhidden' and 'swapfile' to
1370 specify special kinds of buffers. See |special-buffers|.
1371
1372 Be careful with changing this option, it can have many side effects!
1373
Bram Moolenaar280f1262006-01-30 00:14:18 +00001374 A "quickfix" buffer is only used for the error list and the location
1375 list. This value is set by the |:cwindow| and |:lwindow| commands and
1376 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377
1378 "nofile" and "nowrite" buffers are similar:
1379 both: The buffer is not to be written to disk, ":w" doesn't
1380 work (":w filename" does work though).
1381 both: The buffer is never considered to be |'modified'|.
1382 There is no warning when the changes will be lost, for
1383 example when you quit Vim.
1384 both: A swap file is only created when using too much memory
1385 (when 'swapfile' has been reset there is never a swap
1386 file).
1387 nofile only: The buffer name is fixed, it is not handled like a
1388 file name. It is not modified in response to a |:cd|
1389 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001390 both: When using ":e bufname" and already editing "bufname"
1391 the buffer is made empty and autocommands are
1392 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001393 *E676*
1394 "acwrite" implies that the buffer name is not related to a file, like
1395 "nofile", but it will be written. Thus, in contrast to "nofile" and
1396 "nowrite", ":w" does work and a modified buffer can't be abandoned
1397 without saving. For writing there must be matching |BufWriteCmd|,
1398 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399
1400 *'casemap'* *'cmp'*
1401'casemap' 'cmp' string (default: "internal,keepascii")
1402 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403 Specifies details about changing the case of letters. It may contain
1404 these words, separated by a comma:
1405 internal Use internal case mapping functions, the current
1406 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001407 matters when 'encoding' is a Unicode encoding,
1408 "latin1" or "iso-8859-15". When "internal" is
1409 omitted, the towupper() and towlower() system library
1410 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001411 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1412 case mapping, the current locale is not effective.
1413 This probably only matters for Turkish.
1414
1415 *'cdpath'* *'cd'* *E344* *E346*
1416'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1417 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001418 {not available when compiled without the
1419 |+file_in_path| feature}
1420 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001421 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1422 searched for has a relative path, not an absolute part starting with
1423 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 The 'cdpath' option's value has the same form and semantics as
1425 |'path'|. Also see |file-searching|.
1426 The default value is taken from $CDPATH, with a "," prepended to look
1427 in the current directory first.
1428 If the default value taken from $CDPATH is not what you want, include
1429 a modified version of the following command in your vimrc file to
1430 override it: >
1431 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1432< This option cannot be set from a |modeline| or in the |sandbox|, for
1433 security reasons.
1434 (parts of 'cdpath' can be passed to the shell to expand file names).
1435
1436 *'cedit'*
1437'cedit' string (Vi default: "", Vim default: CTRL-F)
1438 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001439 {not available when compiled without the |+vertsplit|
1440 feature}
1441 The key used in Command-line Mode to open the command-line window.
1442 The default is CTRL-F when 'compatible' is off.
1443 Only non-printable keys are allowed.
1444 The key can be specified as a single character, but it is difficult to
1445 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001446 :exe "set cedit=\<C-Y>"
1447 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448< |Nvi| also has this option, but it only uses the first character.
1449 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001450 NOTE: This option is set to the Vim default value when 'compatible'
1451 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452
1453 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1454'charconvert' 'ccv' string (default "")
1455 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001456 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457 An expression that is used for character encoding conversion. It is
1458 evaluated when a file that is to be read or has been written has a
1459 different encoding from what is desired.
1460 'charconvert' is not used when the internal iconv() function is
1461 supported and is able to do the conversion. Using iconv() is
1462 preferred, because it is much faster.
1463 'charconvert' is not used when reading stdin |--|, because there is no
1464 file to convert from. You will have to save the text in a file first.
1465 The expression must return zero or an empty string for success,
1466 non-zero for failure.
1467 The possible encoding names encountered are in 'encoding'.
1468 Additionally, names given in 'fileencodings' and 'fileencoding' are
1469 used.
1470 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1471 is done internally by Vim, 'charconvert' is not used for this.
1472 'charconvert' is also used to convert the viminfo file, if the 'c'
1473 flag is present in 'viminfo'. Also used for Unicode conversion.
1474 Example: >
1475 set charconvert=CharConvert()
1476 fun CharConvert()
1477 system("recode "
1478 \ . v:charconvert_from . ".." . v:charconvert_to
1479 \ . " <" . v:fname_in . " >" v:fname_out)
1480 return v:shell_error
1481 endfun
1482< The related Vim variables are:
1483 v:charconvert_from name of the current encoding
1484 v:charconvert_to name of the desired encoding
1485 v:fname_in name of the input file
1486 v:fname_out name of the output file
1487 Note that v:fname_in and v:fname_out will never be the same.
1488 Note that v:charconvert_from and v:charconvert_to may be different
1489 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1490 Encryption is not done by Vim when using 'charconvert'. If you want
1491 to encrypt the file after conversion, 'charconvert' should take care
1492 of this.
1493 This option cannot be set from a |modeline| or in the |sandbox|, for
1494 security reasons.
1495
1496 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1497'cindent' 'cin' boolean (default off)
1498 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499 {not available when compiled without the |+cindent|
1500 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001501 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502 that trigger reindenting in insert mode and 'cinoptions' to set your
1503 preferred indent style.
1504 If 'indentexpr' is not empty, it overrules 'cindent'.
1505 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1506 the "=" operator indents using this algorithm rather than calling an
1507 external program.
1508 See |C-indenting|.
1509 When you don't like the way 'cindent' works, try the 'smartindent'
1510 option or 'indentexpr'.
1511 This option is not used when 'paste' is set.
1512 NOTE: This option is reset when 'compatible' is set.
1513
1514 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001515'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001517 {not available when compiled without the |+cindent|
1518 feature}
1519 A list of keys that, when typed in Insert mode, cause reindenting of
1520 the current line. Only used if 'cindent' is on and 'indentexpr' is
1521 empty.
1522 For the format of this option see |cinkeys-format|.
1523 See |C-indenting|.
1524
1525 *'cinoptions'* *'cino'*
1526'cinoptions' 'cino' string (default "")
1527 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528 {not available when compiled without the |+cindent|
1529 feature}
1530 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1531 program. See |cinoptions-values| for the values of this option, and
1532 |C-indenting| for info on C indenting in general.
1533
1534
1535 *'cinwords'* *'cinw'*
1536'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1537 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 {not available when compiled without both the
1539 |+cindent| and the |+smartindent| features}
1540 These keywords start an extra indent in the next line when
1541 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1542 an appropriate place (inside {}).
1543 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1544 matter, include the keyword both the uppercase and lowercase:
1545 "if,If,IF".
1546
1547 *'clipboard'* *'cb'*
1548'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1549 for X-windows, "" otherwise)
1550 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551 {only in GUI versions or when the |+xterm_clipboard|
1552 feature is included}
1553 This option is a list of comma separated names.
1554 These names are recognized:
1555
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001556 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 unnamed When included, Vim will use the clipboard register '*'
1558 for all yank, delete, change and put operations which
1559 would normally go to the unnamed register. When a
1560 register is explicitly specified, it will always be
1561 used regardless of whether "unnamed" is in 'clipboard'
1562 or not. The clipboard register can always be
1563 explicitly accessed using the "* notation. Also see
1564 |gui-clipboard|.
1565
Bram Moolenaar30b65812012-07-12 22:01:11 +02001566 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001567 unnamedplus A variant of the "unnamed" flag which uses the
1568 clipboard register '+' (|quoteplus|) instead of
1569 register '*' for all yank, delete, change and put
1570 operations which would normally go to the unnamed
1571 register. When "unnamed" is also included to the
1572 option, yank operations (but not delete, change or
1573 put) will additionally copy the text into register
1574 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001575 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001576 Availability can be checked with: >
1577 if has('unnamedplus')
1578<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001579 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580 autoselect Works like the 'a' flag in 'guioptions': If present,
1581 then whenever Visual mode is started, or the Visual
1582 area extended, Vim tries to become the owner of the
1583 windowing system's global selection or put the
1584 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001585 register "*. See |'go-a'| and |quotestar| for details.
1586 When the GUI is active, the 'a' flag in 'guioptions'
1587 is used, when the GUI is not active, this "autoselect"
1588 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589 Also applies to the modeless selection.
1590
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001591 *clipboard-autoselectplus*
1592 autoselectplus Like "autoselect" but using the + register instead of
1593 the * register. Compare to the 'P' flag in
1594 'guioptions'.
1595
1596 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597 autoselectml Like "autoselect", but for the modeless selection
1598 only. Compare to the 'A' flag in 'guioptions'.
1599
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001600 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001601 html When the clipboard contains HTML, use this when
1602 pasting. When putting text on the clipboard, mark it
1603 as HTML. This works to copy rendered HTML from
1604 Firefox, paste it as raw HTML in Vim, select the HTML
1605 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001606 You probably want to add this only temporarily,
1607 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001608 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001609
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001610 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611 exclude:{pattern}
1612 Defines a pattern that is matched against the name of
1613 the terminal 'term'. If there is a match, no
1614 connection will be made to the X server. This is
1615 useful in this situation:
1616 - Running Vim in a console.
1617 - $DISPLAY is set to start applications on another
1618 display.
1619 - You do not want to connect to the X server in the
1620 console, but do want this in a terminal emulator.
1621 To never connect to the X server use: >
1622 exclude:.*
1623< This has the same effect as using the |-X| argument.
1624 Note that when there is no connection to the X server
1625 the window title won't be restored and the clipboard
1626 cannot be accessed.
1627 The value of 'magic' is ignored, {pattern} is
1628 interpreted as if 'magic' was on.
1629 The rest of the option value will be used for
1630 {pattern}, this must be the last entry.
1631
1632 *'cmdheight'* *'ch'*
1633'cmdheight' 'ch' number (default 1)
1634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635 Number of screen lines to use for the command-line. Helps avoiding
1636 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001637 The value of this option is stored with the tab page, so that each tab
1638 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639
1640 *'cmdwinheight'* *'cwh'*
1641'cmdwinheight' 'cwh' number (default 7)
1642 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643 {not available when compiled without the |+vertsplit|
1644 feature}
1645 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 Moolenaardb84e452010-08-15 13:50:43 +02002723 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 feature}
2725 Tells when the 'equalalways' option applies:
2726 ver vertically, width of windows is not affected
2727 hor horizontally, height of windows is not affected
2728 both width and height of windows is affected
2729
2730 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2731'edcompatible' 'ed' boolean (default off)
2732 global
2733 Makes the 'g' and 'c' flags of the ":substitute" command to be
2734 toggled each time the flag is given. See |complex-change|. See
2735 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002736 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737
Bram Moolenaar03413f42016-04-12 21:07:15 +02002738 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002739'emoji' 'emo' boolean (default: on)
2740 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002741 When on all Unicode emoji characters are considered to be full width.
2742
2743
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744 *'encoding'* *'enc'* *E543*
2745'encoding' 'enc' string (default: "latin1" or value from $LANG)
2746 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002747 Sets the character encoding used inside Vim. It applies to text in
2748 the buffers, registers, Strings in expressions, text stored in the
2749 viminfo file, etc. It sets the kind of characters which Vim can work
2750 with. See |encoding-names| for the possible values.
2751
2752 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002753 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002755 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756
Bram Moolenaar865242e2010-07-14 21:12:05 +02002757 This option cannot be set from a |modeline|. It would most likely
2758 corrupt the text.
2759
Bram Moolenaar3df01732017-02-17 22:47:16 +01002760 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2761 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 'encoding', "utf-8" is the natural choice for the environment and
2763 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002764 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 versions, and to avoid changing the encoding of newly created files
2766 without your knowledge (in case 'fileencodings' is empty).
2767
2768 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002769 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 iconv() or as specified with 'charconvert'.
2771
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002772 If you need to know whether 'encoding' is a multi-byte encoding, you
2773 can use: >
2774 if has("multi_byte_encoding")
2775<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776 Normally 'encoding' will be equal to your current locale. This will
2777 be the default if Vim recognizes your environment settings. If
2778 'encoding' is not set to the current locale, 'termencoding' must be
2779 set to convert typed and displayed text. See |encoding-table|.
2780
2781 When you set this option, it fires the |EncodingChanged| autocommand
2782 event so that you can set up fonts if necessary.
2783
2784 When the option is set, the value is converted to lowercase. Thus
2785 you can set it with uppercase values too. Underscores are translated
2786 to '-' signs.
2787 When the encoding is recognized, it is changed to the standard name.
2788 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2789 "iso-8859-2" and "utf8" becomes "utf-8".
2790
2791 Note: "latin1" is also used when the encoding could not be detected.
2792 This only works when editing files in the same encoding! When the
2793 actual character set is not latin1, make sure 'fileencoding' and
2794 'fileencodings' are empty. When conversion is needed, switch to using
2795 utf-8.
2796
2797 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2798 You don't notice this while editing, but it does matter for the
2799 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2800 setting 'encoding' to one of these values instead of utf-8 only has
2801 effect for encoding used for files when 'fileencoding' is empty.
2802
Bram Moolenaar661b1822005-07-28 22:36:45 +00002803 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2804 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805
2806 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2807'endofline' 'eol' boolean (default on)
2808 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002810 is on, or 'fixeol' option is off, no <EOL> will be written for the
2811 last line in the file. This option is automatically set or reset when
2812 starting to edit a new file, depending on whether file has an <EOL>
2813 for the last line in the file. Normally you don't have to set or
2814 reset this option.
2815 When 'binary' is off and 'fixeol' is on the value is not used when
2816 writing the file. When 'binary' is on or 'fixeol' is off it is used
2817 to remember the presence of a <EOL> for the last line in the file, so
2818 that when you write the file the situation from the original file can
2819 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820
2821 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2822'equalalways' 'ea' boolean (default on)
2823 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002825 splitting or closing a window. This also happens the moment the
2826 option is switched on. When off, splitting a window will reduce the
2827 size of the current window and leave the other windows the same. When
2828 closing a window the extra lines are given to the window next to it
2829 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 When mixing vertically and horizontally split windows, a minimal size
2831 is computed and some windows may be larger if there is room. The
2832 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002833 Changing the height and width of a window can be avoided by setting
2834 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002835 If a window size is specified when creating a new window sizes are
2836 currently not equalized (it's complicated, but may be implemented in
2837 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838
2839 *'equalprg'* *'ep'*
2840'equalprg' 'ep' string (default "")
2841 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002843 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002844 or 'indentexpr'. When Vim was compiled without internal formatting,
2845 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002846 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847 about including spaces and backslashes.
2848 This option cannot be set from a |modeline| or in the |sandbox|, for
2849 security reasons.
2850
2851 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2852'errorbells' 'eb' boolean (default off)
2853 global
2854 Ring the bell (beep or screen flash) for error messages. This only
2855 makes a difference for error messages, the bell will be used always
2856 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002857 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002858 screen flash or do nothing. See 'belloff' to finetune when to ring the
2859 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860
2861 *'errorfile'* *'ef'*
2862'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2863 others: "errors.err")
2864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865 {not available when compiled without the |+quickfix|
2866 feature}
2867 Name of the errorfile for the QuickFix mode (see |:cf|).
2868 When the "-q" command-line argument is used, 'errorfile' is set to the
2869 following argument. See |-q|.
2870 NOT used for the ":make" command. See 'makeef' for that.
2871 Environment variables are expanded |:set_env|.
2872 See |option-backslash| about including spaces and backslashes.
2873 This option cannot be set from a |modeline| or in the |sandbox|, for
2874 security reasons.
2875
2876 *'errorformat'* *'efm'*
2877'errorformat' 'efm' string (default is very long)
2878 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879 {not available when compiled without the |+quickfix|
2880 feature}
2881 Scanf-like description of the format for the lines in the error file
2882 (see |errorformat|).
2883
2884 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2885'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2886 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 Function keys that start with an <Esc> are recognized in Insert
2888 mode. When this option is off, the cursor and function keys cannot be
2889 used in Insert mode if they start with an <Esc>. The advantage of
2890 this is that the single <Esc> is recognized immediately, instead of
2891 after one second. Instead of resetting this option, you might want to
2892 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2893 when 'esckeys' is off, you can still map anything, but the cursor keys
2894 won't work by default.
2895 NOTE: This option is set to the Vi default value when 'compatible' is
2896 set and to the Vim default value when 'compatible' is reset.
2897
2898 *'eventignore'* *'ei'*
2899'eventignore' 'ei' string (default "")
2900 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002902 When set to "all" or when "all" is one of the items, all autocommand
2903 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 Otherwise this is a comma separated list of event names. Example: >
2905 :set ei=WinEnter,WinLeave
2906<
2907 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2908'expandtab' 'et' boolean (default off)
2909 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002911 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2913 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002914 This option is reset when the 'paste' option is set and restored when
2915 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 NOTE: This option is reset when 'compatible' is set.
2917
2918 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2919'exrc' 'ex' boolean (default off)
2920 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002922 directory.
2923
2924 Setting this option is a potential security leak. E.g., consider
2925 unpacking a package or fetching files from github, a .vimrc in there
2926 might be a trojan horse. BETTER NOT SET THIS OPTION!
2927 Instead, define an autocommand in your .vimrc to set options for a
2928 matching directory.
2929
2930 If you do switch this option on you should also consider setting the
2931 'secure' option (see |initialization|).
2932 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 This option cannot be set from a |modeline| or in the |sandbox|, for
2934 security reasons.
2935
2936 *'fileencoding'* *'fenc'* *E213*
2937'fileencoding' 'fenc' string (default: "")
2938 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002940
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002942 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 When 'fileencoding' is empty, the same value as 'encoding' will be
2944 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002945 No error will be given when the value is set, only when it is used,
2946 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002947 Conversion will also be done when 'encoding' and 'fileencoding' are
2948 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2949 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002951 'encoding' is "utf-8" or another Unicode encoding, conversion
2952 is most likely done in a way that the reverse conversion
2953 results in the same text. When 'encoding' is not "utf-8" some
2954 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002955
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 See 'encoding' for the possible values. Additionally, values may be
2957 specified that can be handled by the converter, see
2958 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002959
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 When reading a file 'fileencoding' will be set from 'fileencodings'.
2961 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002962 'fileencoding', use the |++enc| argument. One exception: when
2963 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002964 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002965
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2967 When the option is set, the value is converted to lowercase. Thus
2968 you can set it with uppercase values too. '_' characters are
2969 replaced with '-'. If a name is recognized from the list for
2970 'encoding', it is replaced by the standard name. For example
2971 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002972
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 When this option is set, after starting to edit a file, the 'modified'
2974 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002975
2976 Keep in mind that changing 'fenc' from a modeline happens
2977 AFTER the text has been read, thus it applies to when the file will be
2978 written. If you do set 'fenc' in a modeline, you might want to set
2979 'nomodified' to avoid not being able to ":q".
2980
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 This option can not be changed when 'modifiable' is off.
2982
2983 *'fe'*
2984 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002985 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 old short name was 'fe', which is no longer used.
2987
2988 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002989'fileencodings' 'fencs' string (default: "ucs-bom",
2990 "ucs-bom,utf-8,default,latin1" when
2991 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 This is a list of character encodings considered when starting to edit
2994 an existing file. When a file is read, Vim tries to use the first
2995 mentioned character encoding. If an error is detected, the next one
2996 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002997 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998 an empty string, which means the value of 'encoding' is used.
2999 WARNING: Conversion can cause loss of information! When
3000 'encoding' is "utf-8" (or one of the other Unicode variants)
3001 conversion is most likely done in a way that the reverse
3002 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003003 "utf-8" some non-ASCII characters may be lost! You can use
3004 the |++bad| argument to specify what is done with characters
3005 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006 For an empty file or a file with only ASCII characters most encodings
3007 will work and the first entry of 'fileencodings' will be used (except
3008 "ucs-bom", which requires the BOM to be present). If you prefer
3009 another encoding use an BufReadPost autocommand event to test if your
3010 preferred encoding is to be used. Example: >
3011 au BufReadPost * if search('\S', 'w') == 0 |
3012 \ set fenc=iso-2022-jp | endif
3013< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3014 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003015 When the |++enc| argument is used then the value of 'fileencodings' is
3016 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003017 Note that 'fileencodings' is not used for a new file, the global value
3018 of 'fileencoding' is used instead. You can set it with: >
3019 :setglobal fenc=iso-8859-2
3020< This means that a non-existing file may get a different encoding than
3021 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 The special value "ucs-bom" can be used to check for a Unicode BOM
3023 (Byte Order Mark) at the start of the file. It must not be preceded
3024 by "utf-8" or another Unicode encoding for this to work properly.
3025 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3026 because Vim cannot detect an error, thus the encoding is always
3027 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003028 The special value "default" can be used for the encoding from the
3029 environment. This is the default value for 'encoding'. It is useful
3030 when 'encoding' is set to "utf-8" and your environment uses a
3031 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003032 When 'encoding' is "utf-8" and a file contains an illegal byte
3033 sequence it won't be recognized as UTF-8. You can use the |8g8|
3034 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035 WRONG VALUES: WHAT'S WRONG:
3036 latin1,utf-8 "latin1" will always be used
3037 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3038 file
3039 cp1250,latin1 "cp1250" will always be used
3040 If 'fileencodings' is empty, 'fileencoding' is not modified.
3041 See 'fileencoding' for the possible values.
3042 Setting this option does not have an effect until the next time a file
3043 is read.
3044
3045 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003046'fileformat' 'ff' string (MS-Windows default: "dos",
3047 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 This gives the <EOL> of the current buffer, which is used for
3050 reading/writing the buffer from/to a file:
3051 dos <CR> <NL>
3052 unix <NL>
3053 mac <CR>
3054 When "dos" is used, CTRL-Z at the end of a file is ignored.
3055 See |file-formats| and |file-read|.
3056 For the character encoding of the file see 'fileencoding'.
3057 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003058 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059 This option is set automatically when starting to edit a file and
3060 'fileformats' is not empty and 'binary' is off.
3061 When this option is set, after starting to edit a file, the 'modified'
3062 option is set, because the file would be different when written.
3063 This option can not be changed when 'modifiable' is off.
3064 For backwards compatibility: When this option is set to "dos",
3065 'textmode' is set, otherwise 'textmode' is reset.
3066
3067 *'fileformats'* *'ffs'*
3068'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003069 Vim+Vi MS-Windows: "dos,unix",
3070 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 Vi Cygwin: "unix,dos",
3072 Vi others: "")
3073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 This gives the end-of-line (<EOL>) formats that will be tried when
3075 starting to edit a new buffer and when reading a file into an existing
3076 buffer:
3077 - When empty, the format defined with 'fileformat' will be used
3078 always. It is not set automatically.
3079 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003080 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 'fileformats' name will be used when a file is read into an existing
3082 buffer, no matter what 'fileformat' for that buffer is set to.
3083 - When more than one name is present, separated by commas, automatic
3084 <EOL> detection will be done when reading a file. When starting to
3085 edit a file, a check is done for the <EOL>:
3086 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3087 'fileformat' is set to "dos".
3088 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003089 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003091 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3092 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003093 This means that "mac" is only chosen when:
3094 "unix" is not present or no <NL> is found in the file, and
3095 "dos" is not present or no <CR><NL> is found in the file.
3096 Except: if "unix" was chosen, but there is a <CR> before
3097 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003098 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099 4. If 'fileformat' is still not set, the first name from
3100 'fileformats' is used.
3101 When reading a file into an existing buffer, the same is done, but
3102 this happens like 'fileformat' has been set appropriately for that
3103 file only, the option is not changed.
3104 When 'binary' is set, the value of 'fileformats' is not used.
3105
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003106 When Vim starts up with an empty buffer the first item is used. You
3107 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003108
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3110 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3111 done:
3112 - When 'fileformats' is empty, there is no automatic detection. Dos
3113 format will be used.
3114 - When 'fileformats' is set to one or more names, automatic detection
3115 is done. This is based on the first <NL> in the file: If there is a
3116 <CR> in front of it, Dos format is used, otherwise Unix format is
3117 used.
3118 Also see |file-formats|.
3119 For backwards compatibility: When this option is set to an empty
3120 string or one format (no comma is included), 'textauto' is reset,
3121 otherwise 'textauto' is set.
3122 NOTE: This option is set to the Vi default value when 'compatible' is
3123 set and to the Vim default value when 'compatible' is reset.
3124
Bram Moolenaarbf884932013-04-05 22:26:15 +02003125 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3126'fileignorecase' 'fic' boolean (default on for systems where case in file
3127 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003128 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003129 When set case is ignored when using file names and directories.
3130 See 'wildignorecase' for only ignoring case when doing completion.
3131
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 *'filetype'* *'ft'*
3133'filetype' 'ft' string (default: "")
3134 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 When this option is set, the FileType autocommand event is triggered.
3136 All autocommands that match with the value of this option will be
3137 executed. Thus the value of 'filetype' is used in place of the file
3138 name.
3139 Otherwise this option does not always reflect the current file type.
3140 This option is normally set when the file type is detected. To enable
3141 this use the ":filetype on" command. |:filetype|
3142 Setting this option to a different value is most useful in a modeline,
3143 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003144 Example, for in an IDL file:
3145 /* vim: set filetype=idl : */ ~
3146 |FileType| |filetypes|
3147 When a dot appears in the value then this separates two filetype
3148 names. Example:
3149 /* vim: set filetype=c.doxygen : */ ~
3150 This will use the "c" filetype first, then the "doxygen" filetype.
3151 This works both for filetype plugins and for syntax files. More than
3152 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 This option is not copied to another buffer, independent of the 's' or
3154 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003155 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156
3157 *'fillchars'* *'fcs'*
3158'fillchars' 'fcs' string (default "vert:|,fold:-")
3159 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 {not available when compiled without the |+windows|
3161 and |+folding| features}
3162 Characters to fill the statuslines and vertical separators.
3163 It is a comma separated list of items:
3164
3165 item default Used for ~
3166 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003167 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003168 vert:c '|' vertical separators |:vsplit|
3169 fold:c '-' filling 'foldtext'
3170 diff:c '-' deleted lines of the 'diff' option
3171
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003172 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003173 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 otherwise.
3175
3176 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003177 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178< This is similar to the default, except that these characters will also
3179 be used when there is highlighting.
3180
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003181 for "stl" and "stlnc" only single-byte values are supported.
3182
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 The highlighting used for these items:
3184 item highlight group ~
3185 stl:c StatusLine |hl-StatusLine|
3186 stlnc:c StatusLineNC |hl-StatusLineNC|
3187 vert:c VertSplit |hl-VertSplit|
3188 fold:c Folded |hl-Folded|
3189 diff:c DiffDelete |hl-DiffDelete|
3190
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003191 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3192'fixendofline' 'fixeol' boolean (default on)
3193 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003194 When writing a file and this option is on, <EOL> at the end of file
3195 will be restored if missing. Turn this option off if you want to
3196 preserve the situation from the original file.
3197 When the 'binary' option is set the value of this option doesn't
3198 matter.
3199 See the 'endofline' option.
3200
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3202'fkmap' 'fk' boolean (default off) *E198*
3203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 {only available when compiled with the |+rightleft|
3205 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003206 This option was for using Farsi, which has been removed. See
3207 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208
3209 *'foldclose'* *'fcl'*
3210'foldclose' 'fcl' string (default "")
3211 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 {not available when compiled without the |+folding|
3213 feature}
3214 When set to "all", a fold is closed when the cursor isn't in it and
3215 its level is higher than 'foldlevel'. Useful if you want folds to
3216 automatically close when moving out of them.
3217
3218 *'foldcolumn'* *'fdc'*
3219'foldcolumn' 'fdc' number (default 0)
3220 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 {not available when compiled without the |+folding|
3222 feature}
3223 When non-zero, a column with the specified width is shown at the side
3224 of the window which indicates open and closed folds. The maximum
3225 value is 12.
3226 See |folding|.
3227
3228 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3229'foldenable' 'fen' boolean (default on)
3230 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231 {not available when compiled without the |+folding|
3232 feature}
3233 When off, all folds are open. This option can be used to quickly
3234 switch between showing all text unfolded and viewing the text with
3235 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003236 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 'foldenable' is off.
3238 This option is set by commands that create a new fold or close a fold.
3239 See |folding|.
3240
3241 *'foldexpr'* *'fde'*
3242'foldexpr' 'fde' string (default: "0")
3243 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003245 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003247 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003248
Bram Moolenaar30b65812012-07-12 22:01:11 +02003249 The expression will be evaluated in the |sandbox| if set from a
3250 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003251 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003252 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003253
3254 It is not allowed to change text or jump to another window while
3255 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256
3257 *'foldignore'* *'fdi'*
3258'foldignore' 'fdi' string (default: "#")
3259 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 {not available when compiled without the |+folding|
3261 feature}
3262 Used only when 'foldmethod' is "indent". Lines starting with
3263 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003264 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 The default "#" works well for C programs. See |fold-indent|.
3266
3267 *'foldlevel'* *'fdl'*
3268'foldlevel' 'fdl' number (default: 0)
3269 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 {not available when compiled without the |+folding|
3271 feature}
3272 Sets the fold level: Folds with a higher level will be closed.
3273 Setting this option to zero will close all folds. Higher numbers will
3274 close fewer folds.
3275 This option is set by commands like |zm|, |zM| and |zR|.
3276 See |fold-foldlevel|.
3277
3278 *'foldlevelstart'* *'fdls'*
3279'foldlevelstart' 'fdls' number (default: -1)
3280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 {not available when compiled without the |+folding|
3282 feature}
3283 Sets 'foldlevel' when starting to edit another buffer in a window.
3284 Useful to always start editing with all folds closed (value zero),
3285 some folds closed (one) or no folds closed (99).
3286 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003287 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 ignores this option and closes all folds.
3289 It is also done before BufReadPre autocommands, to allow an autocmd to
3290 overrule the 'foldlevel' value for specific files.
3291 When the value is negative, it is not used.
3292
3293 *'foldmarker'* *'fmr'* *E536*
3294'foldmarker' 'fmr' string (default: "{{{,}}}")
3295 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 {not available when compiled without the |+folding|
3297 feature}
3298 The start and end marker used when 'foldmethod' is "marker". There
3299 must be one comma, which separates the start and end marker. The
3300 marker is a literal string (a regular expression would be too slow).
3301 See |fold-marker|.
3302
3303 *'foldmethod'* *'fdm'*
3304'foldmethod' 'fdm' string (default: "manual")
3305 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 {not available when compiled without the |+folding|
3307 feature}
3308 The kind of folding used for the current window. Possible values:
3309 |fold-manual| manual Folds are created manually.
3310 |fold-indent| indent Lines with equal indent form a fold.
3311 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3312 |fold-marker| marker Markers are used to specify folds.
3313 |fold-syntax| syntax Syntax highlighting items specify folds.
3314 |fold-diff| diff Fold text that is not changed.
3315
3316 *'foldminlines'* *'fml'*
3317'foldminlines' 'fml' number (default: 1)
3318 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 {not available when compiled without the |+folding|
3320 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003321 Sets the number of screen lines above which a fold can be displayed
3322 closed. Also for manually closed folds. With the default value of
3323 one a fold can only be closed if it takes up two or more screen lines.
3324 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003325 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 "zc" to close a fold, which is displayed open because it's smaller
3327 than 'foldminlines', a following "zc" may close a containing fold.
3328
3329 *'foldnestmax'* *'fdn'*
3330'foldnestmax' 'fdn' number (default: 20)
3331 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 {not available when compiled without the |+folding|
3333 feature}
3334 Sets the maximum nesting of folds for the "indent" and "syntax"
3335 methods. This avoids that too many folds will be created. Using more
3336 than 20 doesn't work, because the internal limit is 20.
3337
3338 *'foldopen'* *'fdo'*
3339'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3340 search,tag,undo")
3341 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 {not available when compiled without the |+folding|
3343 feature}
3344 Specifies for which type of commands folds will be opened, if the
3345 command moves the cursor into a closed fold. It is a comma separated
3346 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003347 NOTE: When the command is part of a mapping this option is not used.
3348 Add the |zv| command to the mapping to get the same effect.
3349 (rationale: the mapping may want to control opening folds itself)
3350
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 item commands ~
3352 all any
3353 block "(", "{", "[[", "[{", etc.
3354 hor horizontal movements: "l", "w", "fx", etc.
3355 insert any command in Insert mode
3356 jump far jumps: "G", "gg", etc.
3357 mark jumping to a mark: "'m", CTRL-O, etc.
3358 percent "%"
3359 quickfix ":cn", ":crew", ":make", etc.
3360 search search for a pattern: "/", "n", "*", "gd", etc.
3361 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003362 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 tag jumping to a tag: ":ta", CTRL-T, etc.
3364 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 When a movement command is used for an operator (e.g., "dl" or "y%")
3366 this option is not used. This means the operator will include the
3367 whole closed fold.
3368 Note that vertical movements are not here, because it would make it
3369 very difficult to move onto a closed fold.
3370 In insert mode the folds containing the cursor will always be open
3371 when text is inserted.
3372 To close folds you can re-apply 'foldlevel' with the |zx| command or
3373 set the 'foldclose' option to "all".
3374
3375 *'foldtext'* *'fdt'*
3376'foldtext' 'fdt' string (default: "foldtext()")
3377 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 {not available when compiled without the |+folding|
3379 feature}
3380 An expression which is used to specify the text displayed for a closed
3381 fold. See |fold-foldtext|.
3382
Bram Moolenaar30b65812012-07-12 22:01:11 +02003383 The expression will be evaluated in the |sandbox| if set from a
3384 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003385 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003386
3387 It is not allowed to change text or jump to another window while
3388 evaluating 'foldtext' |textlock|.
3389
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003390 *'formatexpr'* *'fex'*
3391'formatexpr' 'fex' string (default "")
3392 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003393 {not available when compiled without the |+eval|
3394 feature}
3395 Expression which is evaluated to format a range of lines for the |gq|
3396 operator or automatic formatting (see 'formatoptions'). When this
3397 option is empty 'formatprg' is used.
3398
3399 The |v:lnum| variable holds the first line to be formatted.
3400 The |v:count| variable holds the number of lines to be formatted.
3401 The |v:char| variable holds the character that is going to be
3402 inserted if the expression is being evaluated due to
3403 automatic formatting. This can be empty. Don't insert
3404 it yet!
3405
3406 Example: >
3407 :set formatexpr=mylang#Format()
3408< This will invoke the mylang#Format() function in the
3409 autoload/mylang.vim file in 'runtimepath'. |autoload|
3410
3411 The expression is also evaluated when 'textwidth' is set and adding
3412 text beyond that limit. This happens under the same conditions as
3413 when internal formatting is used. Make sure the cursor is kept in the
3414 same spot relative to the text then! The |mode()| function will
3415 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003416
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003417 When the expression evaluates to non-zero Vim will fall back to using
3418 the internal format mechanism.
3419
3420 The expression will be evaluated in the |sandbox| when set from a
3421 modeline, see |sandbox-option|. That stops the option from working,
3422 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003423 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003424 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003425
Bram Moolenaar86b68352004-12-27 21:59:20 +00003426 *'formatlistpat'* *'flp'*
3427'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3428 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003429 A pattern that is used to recognize a list header. This is used for
3430 the "n" flag in 'formatoptions'.
3431 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003432 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003433 while still checking more characters. There must be a character
3434 following the pattern, when it matches the whole line it is handled
3435 like there is no match.
3436 The default recognizes a number, followed by an optional punctuation
3437 character and white space.
3438
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003439 *'formatoptions'* *'fo'*
3440'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3441 local to buffer
3442 This is a sequence of letters which describes how automatic
3443 formatting is to be done. See |fo-table|. When the 'paste' option is
3444 on, no formatting is done (like 'formatoptions' is empty). Commas can
3445 be inserted for readability.
3446 To avoid problems with flags that are added in the future, use the
3447 "+=" and "-=" feature of ":set" |add-option-flags|.
3448 NOTE: This option is set to the Vi default value when 'compatible' is
3449 set and to the Vim default value when 'compatible' is reset.
3450
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 *'formatprg'* *'fp'*
3452'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003453 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003455 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003457 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003458 If the 'formatexpr' option is not empty it will be used instead.
3459 Otherwise, if 'formatprg' option is an empty string, the internal
3460 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003461 Environment variables are expanded |:set_env|. See |option-backslash|
3462 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003463 This option cannot be set from a |modeline| or in the |sandbox|, for
3464 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465
Bram Moolenaard94464e2015-11-02 15:28:18 +01003466 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003467'fsync' 'fs' boolean (default on)
3468 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003469 When on, the library function fsync() will be called after writing a
3470 file. This will flush a file to disk, ensuring that it is safely
3471 written even on filesystems which do metadata-only journaling. This
3472 will force the harddrive to spin up on Linux systems running in laptop
3473 mode, so it may be undesirable in some situations. Be warned that
3474 turning this off increases the chances of data loss after a crash. On
3475 systems without an fsync() implementation, this variable is always
3476 off.
3477 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003478 'fsync' also applies to |writefile()|, unless a flag is used to
3479 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003480 This option cannot be set from a |modeline| or in the |sandbox|, for
3481 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003482
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3484'gdefault' 'gd' boolean (default off)
3485 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 When on, the ":substitute" flag 'g' is default on. This means that
3487 all matches in a line are substituted instead of one. When a 'g' flag
3488 is given to a ":substitute" command, this will toggle the substitution
3489 of all or one match. See |complex-change|.
3490
3491 command 'gdefault' on 'gdefault' off ~
3492 :s/// subst. all subst. one
3493 :s///g subst. one subst. all
3494 :s///gg subst. all subst. one
3495
3496 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003497 DEPRECATED: Setting this option may break plugins that are not aware
3498 of this option. Also, many users get confused that adding the /g flag
3499 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500
3501 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003502'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 Format to recognize for the ":grep" command output.
3505 This is a scanf-like string that uses the same format as the
3506 'errorformat' option: see |errorformat|.
3507
3508 *'grepprg'* *'gp'*
3509'grepprg' 'gp' string (default "grep -n ",
3510 Unix: "grep -n $* /dev/null",
3511 Win32: "findstr /n" or "grep -n",
3512 VMS: "SEARCH/NUMBERS ")
3513 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003514 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 and '#' characters, which are expanded like when used in a command-
3516 line. The placeholder "$*" is allowed to specify where the arguments
3517 will be included. Environment variables are expanded |:set_env|. See
3518 |option-backslash| about including spaces and backslashes.
3519 When your "grep" accepts the "-H" argument, use this to make ":grep"
3520 also work well with a single file: >
3521 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003522< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003523 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3524 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003525 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 apply equally to 'grepprg'.
3527 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3528 otherwise it's "grep -n".
3529 This option cannot be set from a |modeline| or in the |sandbox|, for
3530 security reasons.
3531
3532 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3533'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3534 ve:ver35-Cursor,
3535 o:hor50-Cursor,
3536 i-ci:ver25-Cursor/lCursor,
3537 r-cr:hor20-Cursor/lCursor,
3538 sm:block-Cursor
3539 -blinkwait175-blinkoff150-blinkon175",
3540 for MS-DOS and Win32 console:
3541 "n-v-c:block,o:hor50,i-ci:hor15,
3542 r-cr:hor30,sm:block")
3543 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 {only available when compiled with GUI enabled, and
3545 for MS-DOS and Win32 console}
3546 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003547 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 the height of the cursor can be changed. This can be done by
3549 specifying a block cursor, or a percentage for a vertical or
3550 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003551 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3552 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003554 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 mode-list and an argument-list:
3556 mode-list:argument-list,mode-list:argument-list,..
3557 The mode-list is a dash separated list of these modes:
3558 n Normal mode
3559 v Visual mode
3560 ve Visual mode with 'selection' "exclusive" (same as 'v',
3561 if not specified)
3562 o Operator-pending mode
3563 i Insert mode
3564 r Replace mode
3565 c Command-line Normal (append) mode
3566 ci Command-line Insert mode
3567 cr Command-line Replace mode
3568 sm showmatch in Insert mode
3569 a all modes
3570 The argument-list is a dash separated list of these arguments:
3571 hor{N} horizontal bar, {N} percent of the character height
3572 ver{N} vertical bar, {N} percent of the character width
3573 block block cursor, fills the whole character
3574 [only one of the above three should be present]
3575 blinkwait{N} *cursor-blinking*
3576 blinkon{N}
3577 blinkoff{N}
3578 blink times for cursor: blinkwait is the delay before
3579 the cursor starts blinking, blinkon is the time that
3580 the cursor is shown and blinkoff is the time that the
3581 cursor is not shown. The times are in msec. When one
3582 of the numbers is zero, there is no blinking. The
3583 default is: "blinkwait700-blinkon400-blinkoff250".
3584 These numbers are used for a missing entry. This
3585 means that blinking is enabled by default. To switch
3586 blinking off you can use "blinkon0". The cursor only
3587 blinks when Vim is waiting for input, not while
3588 executing a command.
3589 To make the cursor blink in an xterm, see
3590 |xterm-blink|.
3591 {group-name}
3592 a highlight group name, that sets the color and font
3593 for the cursor
3594 {group-name}/{group-name}
3595 Two highlight group names, the first is used when
3596 no language mappings are used, the other when they
3597 are. |language-mapping|
3598
3599 Examples of parts:
3600 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3601 block cursor with colors from the "nCursor"
3602 highlight group
3603 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3604 In Insert and Command-line Insert mode, use a
3605 30% vertical bar cursor with colors from the
3606 "iCursor" highlight group. Blink a bit
3607 faster.
3608
3609 The 'a' mode is different. It will set the given argument-list for
3610 all modes. It does not reset anything to defaults. This can be used
3611 to do a common setting for all modes. For example, to switch off
3612 blinking: "a:blinkon0"
3613
3614 Examples of cursor highlighting: >
3615 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3616 :highlight Cursor gui=NONE guifg=bg guibg=fg
3617<
3618 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003619 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620'guifont' 'gfn' string (default "")
3621 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 {only available when compiled with GUI enabled}
3623 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003624 In its simplest form the value is just one font name.
3625 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003626
3627 *'guifontset'* *'gfs'*
3628 *E250* *E252* *E234* *E597* *E598*
3629'guifontset' 'gfs' string (default "")
3630 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 {only available when compiled with GUI enabled and
3632 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003633 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 When not empty, specifies two (or more) fonts to be used. The first
3635 one for normal English, the second one for your special language. See
3636 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003637
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3639'guifontwide' 'gfw' string (default "")
3640 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 {only available when compiled with GUI enabled}
3642 When not empty, specifies a comma-separated list of fonts to be used
3643 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003644 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003645
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646 *'guiheadroom'* *'ghr'*
3647'guiheadroom' 'ghr' number (default 50)
3648 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003649 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 The number of pixels subtracted from the screen height when fitting
3651 the GUI window on the screen. Set this before the GUI is started,
3652 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003653 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 lines will be left for window decorations and other items on the
3655 screen. Set it to a negative value to allow windows taller than the
3656 screen.
3657
3658 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003659'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3660 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003661 "aegimrLtT" (GTK, Motif and Athena),
3662 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003665 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 sequence of letters which describes what components and options of the
3667 GUI should be used.
3668 To avoid problems with flags that are added in the future, use the
3669 "+=" and "-=" feature of ":set" |add-option-flags|.
3670
Bram Moolenaar13568252018-03-16 20:46:58 +01003671 Valid characters are as follows:
3672 *'go-!'*
3673 '!' External commands are executed in a terminal window. Without
3674 this flag the MS-Windows GUI will open a console window to
3675 execute the command. The Unix GUI will simulate a dumb
3676 terminal to list the command output.
3677 The terminal window will be positioned at the bottom, and grow
3678 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003679 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 'a' Autoselect: If present, then whenever VISUAL mode is started,
3681 or the Visual area extended, Vim tries to become the owner of
3682 the windowing system's global selection. This means that the
3683 Visually highlighted text is available for pasting into other
3684 applications as well as into Vim itself. When the Visual mode
3685 ends, possibly due to an operation on the text, or when an
3686 application wants to paste the selection, the highlighted text
3687 is automatically yanked into the "* selection register.
3688 Thus the selection is still available for pasting into other
3689 applications after the VISUAL mode has ended.
3690 If not present, then Vim won't become the owner of the
3691 windowing system's global selection unless explicitly told to
3692 by a yank or delete operation for the "* register.
3693 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003694 *'go-P'*
3695 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003696 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003697 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003698 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 applies to the modeless selection.
3700
3701 'guioptions' autoselect Visual autoselect modeless ~
3702 "" - -
3703 "a" yes yes
3704 "A" - yes
3705 "aA" yes yes
3706
Bram Moolenaar02467872007-05-06 13:22:01 +00003707 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 'c' Use console dialogs instead of popup dialogs for simple
3709 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003710 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003711 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003712 'guitablabel' can be used to change the text in the labels.
3713 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003714 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003715 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003716 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 'f' Foreground: Don't use fork() to detach the GUI from the shell
3718 where it was started. Use this for programs that wait for the
3719 editor to finish (e.g., an e-mail program). Alternatively you
3720 can use "gvim -f" or ":gui -f" to start the GUI in the
3721 foreground. |gui-fork|
3722 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003723 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003724 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3726 corner of the window. It's black&white on non-GTK, because of
3727 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003728 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003730 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003731 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003733 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003735 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003736 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 'g' Grey menu items: Make menu items that are not active grey. If
3738 'g' is not included inactive menu items are not shown at all.
3739 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003740 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741 't' Include tearoff menu items. Currently only works for Win32,
3742 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003743 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003744 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003745 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003746 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003748 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749 'R' Right-hand scrollbar is present when there is a vertically
3750 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003751 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003753 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754 'L' Left-hand scrollbar is present when there is a vertically
3755 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003756 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3758 the longest visible line, or on the cursor line if the 'h'
3759 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003760 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003761 'h' Limit horizontal scrollbar size to the length of the cursor
3762 line. Reduces computations. |gui-horiz-scroll|
3763
3764 And yes, you may even have scrollbars on the left AND the right if
3765 you really want to :-). See |gui-scrollbars| for more information.
3766
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003767 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 'v' Use a vertical button layout for dialogs. When not included,
3769 a horizontal layout is preferred, but when it doesn't fit a
3770 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003771 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 'p' Use Pointer callbacks for X11 GUI. This is required for some
3773 window managers. If the cursor is not blinking or hollow at
3774 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003775 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003777 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003778 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003779 *'go-k'*
3780 'k' Keep the GUI window size when adding/removing a scrollbar, or
3781 toolbar, tabline, etc. Instead, the behavior is similar to
3782 when the window is maximized and will adjust 'lines' and
3783 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003784 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003785 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003786
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 *'guipty'* *'noguipty'*
3788'guipty' boolean (default on)
3789 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 {only available when compiled with GUI enabled}
3791 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3792 I/O to/from shell commands. See |gui-pty|.
3793
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003794 *'guitablabel'* *'gtl'*
3795'guitablabel' 'gtl' string (default empty)
3796 global
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003797 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003798 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003799 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003800 pages line. When empty and when the result is empty Vim will use a
3801 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003802
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003803 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003804 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003805 The expression will be evaluated in the |sandbox| when set from a
3806 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003807 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003808
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003809 Only used when the GUI tab pages line is displayed. 'e' must be
3810 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3811 used.
3812
Bram Moolenaar57657d82006-04-21 22:12:41 +00003813 *'guitabtooltip'* *'gtt'*
3814'guitabtooltip' 'gtt' string (default empty)
3815 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00003816 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003817 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003818 When nonempty describes the text to use in a tooltip for the GUI tab
3819 pages line. When empty Vim will use a default tooltip.
3820 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003821 You can include a line break. Simplest method is to use |:let|: >
3822 :let &guitabtooltip = "line one\nline two"
3823<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003824
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 *'helpfile'* *'hf'*
3826'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3827 (others) "$VIMRUNTIME/doc/help.txt")
3828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 Name of the main help file. All distributed help files should be
3830 placed together in one directory. Additionally, all "doc" directories
3831 in 'runtimepath' will be used.
3832 Environment variables are expanded |:set_env|. For example:
3833 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003834 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 spaces and backslashes.
3836 This option cannot be set from a |modeline| or in the |sandbox|, for
3837 security reasons.
3838
3839 *'helpheight'* *'hh'*
3840'helpheight' 'hh' number (default 20)
3841 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02003842 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843 feature}
3844 Minimal initial height of the help window when it is opened with the
3845 ":help" command. The initial height of the help window is half of the
3846 current window, or (when the 'ea' option is on) the same as other
3847 windows. When the height is less than 'helpheight', the height is
3848 set to 'helpheight'. Set to zero to disable.
3849
3850 *'helplang'* *'hlg'*
3851'helplang' 'hlg' string (default: messages language or empty)
3852 global
3853 {only available when compiled with the |+multi_lang|
3854 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 Comma separated list of languages. Vim will use the first language
3856 for which the desired help can be found. The English help will always
3857 be used as a last resort. You can add "en" to prefer English over
3858 another language, but that will only find tags that exist in that
3859 language and not in the English help.
3860 Example: >
3861 :set helplang=de,it
3862< This will first search German, then Italian and finally English help
3863 files.
3864 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3865 try to find the tag in the current language before using this option.
3866 See |help-translated|.
3867
3868 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3869'hidden' 'hid' boolean (default off)
3870 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 When off a buffer is unloaded when it is |abandon|ed. When on a
3872 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3873 displayed in another window, it does not become hidden, of course.
3874 The commands that move through the buffer list sometimes make a buffer
3875 hidden although the 'hidden' option is off: When the buffer is
3876 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003877 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003878 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 This option is set for one command with ":hide {command}" |:hide|.
3880 WARNING: It's easy to forget that you have changes in hidden buffers.
3881 Think twice when using ":q!" or ":qa!".
3882
3883 *'highlight'* *'hl'*
3884'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003885 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3886 d:Directory,e:ErrorMsg,i:IncSearch,
3887 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
3888 N:CursorLineNr,r:Question,s:StatusLine,
3889 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003890 v:Visual,V:VisualNOS,w:WarningMsg,
3891 W:WildMenu,f:Folded,F:FoldColumn,
3892 A:DiffAdd,C:DiffChange,D:DiffDelete,
3893 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003894 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003895 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003896 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3897 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003898 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003899 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 This option can be used to set highlighting mode for various
3902 occasions. It is a comma separated list of character pairs. The
3903 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003904 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003906 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3907 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 characters from 'showbreak'
3909 |hl-Directory| d directories in CTRL-D listing and other special
3910 things in listings
3911 |hl-ErrorMsg| e error messages
3912 h (obsolete, ignored)
3913 |hl-IncSearch| i 'incsearch' highlighting
3914 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3915 |hl-MoreMsg| m |more-prompt|
3916 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003917 |hl-LineNr| n line number for ":number" and ":#" commands, and
3918 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003919 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3920 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 |hl-Question| r |hit-enter| prompt and yes/no questions
3922 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003923 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3925 |hl-VertSplit| c column used to separate vertically split windows
3926 |hl-Visual| v Visual mode
3927 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3928 Selection" Only X11 Gui's |gui-x11| and
3929 |xterm-clipboard|.
3930 |hl-WarningMsg| w warning messages
3931 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3932 |hl-Folded| f line used for closed folds
3933 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003934 |hl-DiffAdd| A added line in diff mode
3935 |hl-DiffChange| C changed line in diff mode
3936 |hl-DiffDelete| D deleted line in diff mode
3937 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003939 |hl-Conceal| - the placeholders used for concealed characters
3940 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003941 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003942 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003943 |hl-SpellRare| R rare word |spell|
3944 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003945 |hl-Pmenu| + popup menu normal line
3946 |hl-PmenuSel| = popup menu selected line
3947 |hl-PmenuSbar| x popup menu scrollbar
3948 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949
3950 The display modes are:
3951 r reverse (termcap entry "mr" and "me")
3952 i italic (termcap entry "ZH" and "ZR")
3953 b bold (termcap entry "md" and "me")
3954 s standout (termcap entry "so" and "se")
3955 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003956 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02003957 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 n no highlighting
3959 - no highlighting
3960 : use a highlight group
3961 The default is used for occasions that are not included.
3962 If you want to change what the display modes do, see |dos-colors|
3963 for an example.
3964 When using the ':' display mode, this must be followed by the name of
3965 a highlight group. A highlight group can be used to define any type
3966 of highlighting, including using color. See |:highlight| on how to
3967 define one. The default uses a different group for each occasion.
3968 See |highlight-default| for the default highlight groups.
3969
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003971'history' 'hi' number (Vim default: 50, Vi default: 0,
3972 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003975 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003977 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 NOTE: This option is set to the Vi default value when 'compatible' is
3979 set and to the Vim default value when 'compatible' is reset.
3980
3981 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3982'hkmap' 'hk' boolean (default off)
3983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 {only available when compiled with the |+rightleft|
3985 feature}
3986 When on, the keyboard is mapped for the Hebrew character set.
3987 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3988 toggle this option. See |rileft.txt|.
3989 NOTE: This option is reset when 'compatible' is set.
3990
3991 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3992'hkmapp' 'hkp' boolean (default off)
3993 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994 {only available when compiled with the |+rightleft|
3995 feature}
3996 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3997 This is useful if you have a non-Hebrew keyboard.
3998 See |rileft.txt|.
3999 NOTE: This option is reset when 'compatible' is set.
4000
Bram Moolenaar036986f2017-03-16 17:41:02 +01004001 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4002'hlsearch' 'hls' boolean (default off)
4003 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004004 {not available when compiled without the
4005 |+extra_search| feature}
4006 When there is a previous search pattern, highlight all its matches.
4007 The type of highlighting used can be set with the 'l' occasion in the
4008 'highlight' option. This uses the "Search" highlight group by
4009 default. Note that only the matching text is highlighted, any offsets
4010 are not applied.
4011 See also: 'incsearch' and |:match|.
4012 When you get bored looking at the highlighted matches, you can turn it
4013 off with |:nohlsearch|. This does not change the option value, as
4014 soon as you use a search command, the highlighting comes back.
4015 'redrawtime' specifies the maximum time spent on finding matches.
4016 When the search pattern can match an end-of-line, Vim will try to
4017 highlight all of the matched text. However, this depends on where the
4018 search starts. This will be the first line in the window or the first
4019 line below a closed fold. A match in a previous line which is not
4020 drawn may not continue in a newly drawn line.
4021 You can specify whether the highlight status is restored on startup
4022 with the 'h' flag in 'viminfo' |viminfo-h|.
4023 NOTE: This option is reset when 'compatible' is set.
4024
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 *'icon'* *'noicon'*
4026'icon' boolean (default off, on when title can be restored)
4027 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 {not available when compiled without the |+title|
4029 feature}
4030 When on, the icon text of the window will be set to the value of
4031 'iconstring' (if it is not empty), or to the name of the file
4032 currently being edited. Only the last part of the name is used.
4033 Overridden by the 'iconstring' option.
4034 Only works if the terminal supports setting window icons (currently
4035 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4036 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4037 builtin termcap).
4038 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004039 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004041 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042
4043 *'iconstring'*
4044'iconstring' string (default "")
4045 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 {not available when compiled without the |+title|
4047 feature}
4048 When this option is not empty, it will be used for the icon text of
4049 the window. This happens only when the 'icon' option is on.
4050 Only works if the terminal supports setting window icon text
4051 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4052 Does not work for MS Windows.
4053 When Vim was compiled with HAVE_X11 defined, the original icon will be
4054 restored if possible |X11|.
4055 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004056 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004058 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059 {not available when compiled without the |+statusline| feature}
4060
4061 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4062'ignorecase' 'ic' boolean (default off)
4063 global
4064 Ignore case in search patterns. Also used when searching in the tags
4065 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004066 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 Can be overruled by using "\c" or "\C" in the pattern, see
4068 |/ignorecase|.
4069
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004070 *'imactivatefunc'* *'imaf'*
4071'imactivatefunc' 'imaf' string (default "")
4072 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004073 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004074 activate or deactivate the Input Method.
4075 It is not used in the GUI.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004076 The expression will be evaluated in the |sandbox| when set from a
4077 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004078
4079 Example: >
4080 function ImActivateFunc(active)
4081 if a:active
4082 ... do something
4083 else
4084 ... do something
4085 endif
4086 " return value is not used
4087 endfunction
4088 set imactivatefunc=ImActivateFunc
4089<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 *'imactivatekey'* *'imak'*
4091'imactivatekey' 'imak' string (default "")
4092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004094 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095 Specifies the key that your Input Method in X-Windows uses for
4096 activation. When this is specified correctly, vim can fully control
4097 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4098 You can't use this option to change the activation key, the option
4099 tells Vim what the key is.
4100 Format:
4101 [MODIFIER_FLAG-]KEY_STRING
4102
4103 These characters can be used for MODIFIER_FLAG (case is ignored):
4104 S Shift key
4105 L Lock key
4106 C Control key
4107 1 Mod1 key
4108 2 Mod2 key
4109 3 Mod3 key
4110 4 Mod4 key
4111 5 Mod5 key
4112 Combinations are allowed, for example "S-C-space" or "SC-space" are
4113 both shift+ctrl+space.
4114 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4115
4116 Example: >
4117 :set imactivatekey=S-space
4118< "S-space" means shift+space. This is the activation key for kinput2 +
4119 canna (Japanese), and ami (Korean).
4120
4121 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4122'imcmdline' 'imc' boolean (default off)
4123 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 When set the Input Method is always on when starting to edit a command
4125 line, unless entering a search pattern (see 'imsearch' for that).
4126 Setting this option is useful when your input method allows entering
4127 English characters directly, e.g., when it's used to type accented
4128 characters with dead keys.
4129
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004130 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4132 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 When set the Input Method is never used. This is useful to disable
4134 the IM when it doesn't work properly.
4135 Currently this option is on by default for SGI/IRIX machines. This
4136 may change in later releases.
4137
4138 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004139'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141 Specifies whether :lmap or an Input Method (IM) is to be used in
4142 Insert mode. Valid values:
4143 0 :lmap is off and IM is off
4144 1 :lmap is ON and IM is off
4145 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 To always reset the option to zero when leaving Insert mode with <Esc>
4147 this can be used: >
4148 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4149< This makes :lmap and IM turn off automatically when leaving Insert
4150 mode.
4151 Note that this option changes when using CTRL-^ in Insert mode
4152 |i_CTRL-^|.
4153 The value is set to 1 when setting 'keymap' to a valid keymap name.
4154 It is also used for the argument of commands like "r" and "f".
4155 The value 0 may not work correctly with Athena and Motif with some XIM
4156 methods. Use 'imdisable' to disable XIM then.
4157
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004158 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004159 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004160 |+multi_byte_ime| or |global-ime|.
4161
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004163'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004165 Specifies whether :lmap or an Input Method (IM) is to be used when
4166 entering a search pattern. Valid values:
4167 -1 the value of 'iminsert' is used, makes it look like
4168 'iminsert' is also used when typing a search pattern
4169 0 :lmap is off and IM is off
4170 1 :lmap is ON and IM is off
4171 2 :lmap is off and IM is ON
4172 Note that this option changes when using CTRL-^ in Command-line mode
4173 |c_CTRL-^|.
4174 The value is set to 1 when it is not -1 and setting the 'keymap'
4175 option to a valid keymap name.
4176 The value 0 may not work correctly with Athena and Motif with some XIM
4177 methods. Use 'imdisable' to disable XIM then.
4178
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004179 *'imstatusfunc'* *'imsf'*
4180'imstatusfunc' 'imsf' string (default "")
4181 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004182 This option specifies a function that is called to obtain the status
4183 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004184 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004185
4186 Example: >
4187 function ImStatusFunc()
4188 let is_active = ...do something
4189 return is_active ? 1 : 0
4190 endfunction
4191 set imstatusfunc=ImStatusFunc
4192<
4193 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004194 The expression will be evaluated in the |sandbox| when set from a
4195 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004196
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004197 *'imstyle'* *'imst'*
4198'imstyle' 'imst' number (default 1)
4199 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004200 {only available when compiled with |+xim| and
4201 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004202 This option specifies the input style of Input Method:
4203 0 use on-the-spot style
4204 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004205 See: |xim-input-style|
4206
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004207 For a long time on-the-spot style had been used in the GTK version of
4208 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004209 |single-repeat|, etc. Therefore over-the-spot style becomes the
4210 default now. This should work fine for most people, however if you
4211 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004212 The expression will be evaluated in the |sandbox| when set from a
4213 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004214
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 *'include'* *'inc'*
4216'include' 'inc' string (default "^\s*#\s*include")
4217 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 {not available when compiled without the
4219 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004220 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 pattern, just like for the "/" command (See |pattern|). The default
4222 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004223 "]I", "[d", etc.
4224 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004225 comes after the matched pattern. But if "\zs" appears in the pattern
4226 then the text matched from "\zs" to the end, or until "\ze" if it
4227 appears, is used as the file name. Use this to include characters
4228 that are not in 'isfname', such as a space. You can then use
4229 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004230 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231
4232 *'includeexpr'* *'inex'*
4233'includeexpr' 'inex' string (default "")
4234 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004236 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004238 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 :set includeexpr=substitute(v:fname,'\\.','/','g')
4240< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004241
Bram Moolenaar071d4272004-06-13 20:20:40 +00004242 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004243 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 Also used for |<cfile>|.
4245
Bram Moolenaar30b65812012-07-12 22:01:11 +02004246 The expression will be evaluated in the |sandbox| when set from a
4247 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004248 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004249
4250 It is not allowed to change text or jump to another window while
4251 evaluating 'includeexpr' |textlock|.
4252
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004254'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4255 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004257 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004258 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004259 While typing a search command, show where the pattern, as it was typed
4260 so far, matches. The matched string is highlighted. If the pattern
4261 is invalid or not found, nothing is shown. The screen will be updated
4262 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004263 Also applies to the pattern in commands: >
4264 :global
4265 :lvimgrep
4266 :lvimgrepadd
4267 :smagic
4268 :snomagic
4269 :sort
4270 :substitute
4271 :vglobal
4272 :vimgrep
4273 :vimgrepadd
4274< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004275 original position when no match is found and when pressing <Esc>. You
4276 still need to finish the search command with <Enter> to move the
4277 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004278 You can use the CTRL-G and CTRL-T keys to move to the next and
4279 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004280 When compiled with the |+reltime| feature Vim only searches for about
4281 half a second. With a complicated pattern and/or a lot of text the
4282 match may not be found. This is to avoid that Vim hangs while you
4283 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004284 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004285 When 'hlsearch' is on, all matched strings are highlighted too while
4286 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004287 If you don't want to turn 'hlsearch' on, but want to highlight all
4288 matches while searching, you can turn on and off 'hlsearch' with
4289 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004290 augroup vimrc-incsearch-highlight
4291 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004292 autocmd CmdlineEnter /,\? :set hlsearch
4293 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004294 augroup END
4295<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004296 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004297 to the command line. If 'ignorecase' and 'smartcase' are set and the
4298 command line has no uppercase characters, the added character is
4299 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004300 CTRL-R CTRL-W can be used to add the word at the end of the current
4301 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 NOTE: This option is reset when 'compatible' is set.
4303
4304 *'indentexpr'* *'inde'*
4305'indentexpr' 'inde' string (default "")
4306 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307 {not available when compiled without the |+cindent|
4308 or |+eval| features}
4309 Expression which is evaluated to obtain the proper indent for a line.
4310 It is used when a new line is created, for the |=| operator and
4311 in Insert mode as specified with the 'indentkeys' option.
4312 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004313 'smartindent' indenting. When 'lisp' is set, this option is
4314 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 When 'paste' is set this option is not used for indenting.
4316 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004317 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 when the expression is evaluated (but it may be moved around).
4319 The expression must return the number of spaces worth of indent. It
4320 can return "-1" to keep the current indent (this means 'autoindent' is
4321 used for the indent).
4322 Functions useful for computing the indent are |indent()|, |cindent()|
4323 and |lispindent()|.
4324 The evaluation of the expression must not have side effects! It must
4325 not change the text, jump to another window, etc. Afterwards the
4326 cursor position is always restored, thus the cursor may be moved.
4327 Normally this option would be set to call a function: >
4328 :set indentexpr=GetMyIndent()
4329< Error messages will be suppressed, unless the 'debug' option contains
4330 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004331 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004332 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333
Bram Moolenaar30b65812012-07-12 22:01:11 +02004334 The expression will be evaluated in the |sandbox| when set from a
4335 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004336 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004337
4338 It is not allowed to change text or jump to another window while
4339 evaluating 'indentexpr' |textlock|.
4340
4341
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004343'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004345 {not available when compiled without the |+cindent|
4346 feature}
4347 A list of keys that, when typed in Insert mode, cause reindenting of
4348 the current line. Only happens if 'indentexpr' isn't empty.
4349 The format is identical to 'cinkeys', see |indentkeys-format|.
4350 See |C-indenting| and |indent-expression|.
4351
4352 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4353'infercase' 'inf' boolean (default off)
4354 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004356 'ignorecase' is also on, the case of the match is adjusted depending
4357 on the typed text. If the typed text contains a lowercase letter
4358 where the match has an upper case letter, the completed part is made
4359 lowercase. If the typed text has no lowercase letters and the match
4360 has a lowercase letter where the typed text has an uppercase letter,
4361 and there is a letter before it, the completed part is made uppercase.
4362 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363
4364 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4365'insertmode' 'im' boolean (default off)
4366 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 Makes Vim work in a way that Insert mode is the default mode. Useful
4368 if you want to use Vim as a modeless editor. Used for |evim|.
4369 These Insert mode commands will be useful:
4370 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004371 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372 this is a mapping, it is executed as if 'insertmode' was off.
4373 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004375 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4376 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377
4378 These items change when 'insertmode' is set:
4379 - when starting to edit of a file, Vim goes to Insert mode.
4380 - <Esc> in Insert mode is a no-op and beeps.
4381 - <Esc> in Normal mode makes Vim go to Insert mode.
4382 - CTRL-L in Insert mode is a command, it is not inserted.
4383 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4384 However, when <Esc> is used inside a mapping, it behaves like
4385 'insertmode' was not set. This was done to be able to use the same
4386 mappings with 'insertmode' set or not set.
4387 When executing commands with |:normal| 'insertmode' is not used.
4388
4389 NOTE: This option is reset when 'compatible' is set.
4390
4391 *'isfname'* *'isf'*
4392'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4393 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4394 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4395 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4396 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4397 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4398 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 The characters specified by this option are included in file names and
4400 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004401 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 Multi-byte characters 256 and above are always included, only the
4403 characters up to 255 are specified with this option.
4404 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004405 Think twice before adding white space to this option. Although a
4406 space may appear inside a file name, the effect will be that Vim
4407 doesn't know where a file name starts or ends when doing completion.
4408 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409
4410 Note that on systems using a backslash as path separator, Vim tries to
4411 do its best to make it work as you would expect. That is a bit
4412 tricky, since Vi originally used the backslash to escape special
4413 characters. Vim will not remove a backslash in front of a normal file
4414 name character on these systems, but it will on Unix and alikes. The
4415 '&' and '^' are not included by default, because these are special for
4416 cmd.exe.
4417
4418 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004419 Each part can be a single character number or a range. A range is two
4420 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 decimal number between 0 and 255 or the ASCII character itself (does
4422 not work for digits). Example:
4423 "_,-,128-140,#-43" (include '_' and '-' and the range
4424 128 to 140 and '#' to 43)
4425 If a part starts with '^', the following character number or range
4426 will be excluded from the option. The option is interpreted from left
4427 to right. Put the excluded character after the range where it is
4428 included. To include '^' itself use it as the last character of the
4429 option or the end of a range. Example:
4430 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4431 If the character is '@', all characters where isalpha() returns TRUE
4432 are included. Normally these are the characters a to z and A to Z,
4433 plus accented characters. To include '@' itself use "@-@". Examples:
4434 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004435 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 "a-z,A-Z,@-@" All letters plus the '@' character.
4437 A comma can be included by using it where a character number is
4438 expected. Example:
4439 "48-57,,,_" Digits, comma and underscore.
4440 A comma can be excluded by prepending a '^'. Example:
4441 " -~,^,,9" All characters from space to '~', excluding
4442 comma, plus <Tab>.
4443 See |option-backslash| about including spaces and backslashes.
4444
4445 *'isident'* *'isi'*
4446'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4447 "@,48-57,_,128-167,224-235"
4448 otherwise: "@,48-57,_,192-255")
4449 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 The characters given by this option are included in identifiers.
4451 Identifiers are used in recognizing environment variables and after a
4452 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004453 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004454 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004456 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4458
4459 *'iskeyword'* *'isk'*
4460'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4461 "@,48-57,_,128-167,224-235"
4462 otherwise: "@,48-57,_,192-255"
4463 Vi default: "@,48-57,_")
4464 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004466 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004467 'isfname' for a description of the format of this option. For '@'
4468 characters above 255 check the "word" character class.
4469 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470 For a help file it is set to all non-blank printable characters except
4471 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4472 command).
4473 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004474 This option also influences syntax highlighting, unless the syntax
4475 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 NOTE: This option is set to the Vi default value when 'compatible' is
4477 set and to the Vim default value when 'compatible' is reset.
4478
4479 *'isprint'* *'isp'*
4480'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4481 "@,~-255"; otherwise: "@,161-255")
4482 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483 The characters given by this option are displayed directly on the
4484 screen. It is also used for "\p" in a |pattern|. The characters from
4485 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4486 even when they are not included in 'isprint' or excluded. See
4487 'isfname' for a description of the format of this option.
4488
4489 Non-printable characters are displayed with two characters:
4490 0 - 31 "^@" - "^_"
4491 32 - 126 always single characters
4492 127 "^?"
4493 128 - 159 "~@" - "~_"
4494 160 - 254 "| " - "|~"
4495 255 "~?"
4496 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4497 displayed as <xx>, with the hexadecimal value of the byte.
4498 When 'display' contains "uhex" all unprintable characters are
4499 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004500 The SpecialKey highlighting will be used for unprintable characters.
4501 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502
4503 Multi-byte characters 256 and above are always included, only the
4504 characters up to 255 are specified with this option. When a character
4505 is printable but it is not available in the current font, a
4506 replacement character will be shown.
4507 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4508 There is no option to specify these characters.
4509
4510 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4511'joinspaces' 'js' boolean (default on)
4512 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 Insert two spaces after a '.', '?' and '!' with a join command.
4514 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4515 Otherwise only one space is inserted.
4516 NOTE: This option is set when 'compatible' is set.
4517
4518 *'key'*
4519'key' string (default "")
4520 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004521 {only available when compiled with the |+cryptv|
4522 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004524 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 Careful: Do not set the key value by hand, someone might see the typed
4526 key. Use the |:X| command. But you can make 'key' empty: >
4527 :set key=
4528< It is not possible to get the value of this option with ":set key" or
4529 "echo &key". This is to avoid showing it to someone who shouldn't
4530 know. It also means you cannot see it yourself once you have set it,
4531 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004532 You can use "&key" in an expression to detect whether encryption is
4533 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534
4535 *'keymap'* *'kmp'* *E544*
4536'keymap' 'kmp' string (default "")
4537 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 {only available when compiled with the |+keymap|
4539 feature}
4540 Name of a keyboard mapping. See |mbyte-keymap|.
4541 Setting this option to a valid keymap name has the side effect of
4542 setting 'iminsert' to one, so that the keymap becomes effective.
4543 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004544 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545
4546 *'keymodel'* *'km'*
4547'keymodel' 'km' string (default "")
4548 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 List of comma separated words, which enable special things that keys
4550 can do. These values can be used:
4551 startsel Using a shifted special key starts selection (either
4552 Select mode or Visual mode, depending on "key" being
4553 present in 'selectmode').
4554 stopsel Using a not-shifted special key stops selection.
4555 Special keys in this context are the cursor keys, <End>, <Home>,
4556 <PageUp> and <PageDown>.
4557 The 'keymodel' option is set by the |:behave| command.
4558
4559 *'keywordprg'* *'kp'*
4560'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004561 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563 Program to use for the |K| command. Environment variables are
4564 expanded |:set_env|. ":help" may be used to access the Vim internal
4565 help. (Note that previously setting the global option to the empty
4566 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004567 When the first character is ":", the command is invoked as a Vim
4568 Ex command prefixed with [count].
4569 When "man", "man -s" or an Ex command is used, Vim will automatically
4570 translate a count for the "K" command and pass it as the first
4571 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 See |option-backslash| about including spaces and backslashes.
4573 Example: >
4574 :set keywordprg=man\ -s
4575< This option cannot be set from a |modeline| or in the |sandbox|, for
4576 security reasons.
4577
4578 *'langmap'* *'lmap'* *E357* *E358*
4579'langmap' 'lmap' string (default "")
4580 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 {only available when compiled with the |+langmap|
4582 feature}
4583 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004584 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004585 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586 care of translating these special characters to the original meaning
4587 of the key. This means you don't have to change the keyboard mode to
4588 be able to execute Normal mode commands.
4589 This is the opposite of the 'keymap' option, where characters are
4590 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004591 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004592 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004593 This option cannot be set from a |modeline| or in the |sandbox|, for
4594 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004596 Example (for Greek, in UTF-8): *greek* >
4597 :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 +00004598< Example (exchanges meaning of z and y for commands): >
4599 :set langmap=zy,yz,ZY,YZ
4600<
4601 The 'langmap' option is a list of parts, separated with commas. Each
4602 part can be in one of two forms:
4603 1. A list of pairs. Each pair is a "from" character immediately
4604 followed by the "to" character. Examples: "aA", "aAbBcC".
4605 2. A list of "from" characters, a semi-colon and a list of "to"
4606 characters. Example: "abc;ABC"
4607 Example: "aA,fgh;FGH,cCdDeE"
4608 Special characters need to be preceded with a backslash. These are
4609 ";", ',' and backslash itself.
4610
4611 This will allow you to activate vim actions without having to switch
4612 back and forth between the languages. Your language characters will
4613 be understood as normal vim English characters (according to the
4614 langmap mappings) in the following cases:
4615 o Normal/Visual mode (commands, buffer/register names, user mappings)
4616 o Insert/Replace Mode: Register names after CTRL-R
4617 o Insert/Replace Mode: Mappings
4618 Characters entered in Command-line mode will NOT be affected by
4619 this option. Note that this option can be changed at any time
4620 allowing to switch between mappings for different languages/encodings.
4621 Use a mapping to avoid having to type it each time!
4622
4623 *'langmenu'* *'lm'*
4624'langmenu' 'lm' string (default "")
4625 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 {only available when compiled with the |+menu| and
4627 |+multi_lang| features}
4628 Language to use for menu translation. Tells which file is loaded
4629 from the "lang" directory in 'runtimepath': >
4630 "lang/menu_" . &langmenu . ".vim"
4631< (without the spaces). For example, to always use the Dutch menus, no
4632 matter what $LANG is set to: >
4633 :set langmenu=nl_NL.ISO_8859-1
4634< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004635 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 If your $LANG is set to a non-English language but you do want to use
4637 the English menus: >
4638 :set langmenu=none
4639< This option must be set before loading menus, switching on filetype
4640 detection or syntax highlighting. Once the menus are defined setting
4641 this option has no effect. But you could do this: >
4642 :source $VIMRUNTIME/delmenu.vim
4643 :set langmenu=de_DE.ISO_8859-1
4644 :source $VIMRUNTIME/menu.vim
4645< Warning: This deletes all menus that you defined yourself!
4646
Bram Moolenaard94464e2015-11-02 15:28:18 +01004647 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004648'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004649 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004650 {only available when compiled with the |+langmap|
4651 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004652 This is just like 'langremap' but with the value inverted. It only
4653 exists for backwards compatibility. When setting 'langremap' then
4654 'langnoremap' is set to the inverted value, and the other way around.
4655
4656 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4657'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4658 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004659 {only available when compiled with the |+langmap|
4660 feature}
4661 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004662 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004663 'langmap' disables some of your mappings, try resetting this option.
4664 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004665 that works for you to avoid mappings to break.
4666
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667 *'laststatus'* *'ls'*
4668'laststatus' 'ls' number (default 1)
4669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 The value of this option influences when the last window will have a
4671 status line:
4672 0: never
4673 1: only if there are at least two windows
4674 2: always
4675 The screen looks nicer with a status line if you have several
4676 windows, but it takes another screen line. |status-line|
4677
4678 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4679'lazyredraw' 'lz' boolean (default off)
4680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 When this option is set, the screen will not be redrawn while
4682 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004683 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 update use |:redraw|.
4685
4686 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4687'linebreak' 'lbr' boolean (default off)
4688 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004689 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004691 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 than at the last character that fits on the screen. Unlike
4693 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004694 it only affects the way the file is displayed, not its contents.
4695 If 'breakindent' is set, line is visually indented. Then, the value
4696 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004697 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698 Note that <Tab> characters after an <EOL> are mostly not displayed
4699 with the right amount of white space.
4700
4701 *'lines'* *E593*
4702'lines' number (default 24 or terminal height)
4703 global
4704 Number of lines of the Vim window.
4705 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004706 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 When Vim is running in the GUI or in a resizable window, setting this
4708 option will cause the window size to be changed. When you only want
4709 to use the size for the GUI, put the command in your |gvimrc| file.
4710 Vim limits the number of lines to what fits on the screen. You can
4711 use this command to get the tallest window possible: >
4712 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004713< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004714 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 When you set this option and Vim is unable to change the physical
4716 number of lines of the display, the display may be messed up.
4717
4718 *'linespace'* *'lsp'*
4719'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4720 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 {only in the GUI}
4722 Number of pixel lines inserted between characters. Useful if the font
4723 uses the full character cell height, making lines touch each other.
4724 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004725 With some fonts there can be too much room between lines (to have
4726 space for ascents and descents). Then it makes sense to set
4727 'linespace' to a negative value. This may cause display problems
4728 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729
4730 *'lisp'* *'nolisp'*
4731'lisp' boolean (default off)
4732 local to buffer
4733 {not available when compiled without the |+lispindent|
4734 feature}
4735 Lisp mode: When <Enter> is typed in insert mode set the indent for
4736 the next line to Lisp standards (well, sort of). Also happens with
4737 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4738 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4739 better. Also see 'lispwords'.
4740 The '-' character is included in keyword characters. Redefines the
4741 "=" operator to use this same indentation algorithm rather than
4742 calling an external program if 'equalprg' is empty.
4743 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744
4745 *'lispwords'* *'lw'*
4746'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004747 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 {not available when compiled without the |+lispindent|
4749 feature}
4750 Comma separated list of words that influence the Lisp indenting.
4751 |'lisp'|
4752
4753 *'list'* *'nolist'*
4754'list' boolean (default off)
4755 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004756 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4757 line. Useful to see the difference between tabs and spaces and for
4758 trailing blanks. Further changed by the 'listchars' option.
4759
4760 The cursor is displayed at the start of the space a Tab character
4761 occupies, not at the end as usual in Normal mode. To get this cursor
4762 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004763 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004764<
4765 Note that list mode will also affect formatting (set with 'textwidth'
4766 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 changing the way tabs are displayed.
4768
4769 *'listchars'* *'lcs'*
4770'listchars' 'lcs' string (default "eol:$")
4771 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004772 Strings to use in 'list' mode and for the |:list| command. It is a
4773 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004774 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 eol:c Character to show at the end of each line. When
4776 omitted, there is no extra character at the end of the
4777 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004778 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004779 tab:xy[z] Two or three characters to be used to show a tab.
4780 The third character is optional.
4781
4782 tab:xy The 'x' is always used, then 'y' as many times as will
4783 fit. Thus "tab:>-" displays:
4784 >
4785 >-
4786 >--
4787 etc.
4788
4789 tab:xyz The 'z' is always used, then 'x' is prepended, and
4790 then 'y' is used as many times as will fit. Thus
4791 "tab:<->" displays:
4792 >
4793 <>
4794 <->
4795 <-->
4796 etc.
4797
4798 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004799 *lcs-space*
4800 space:c Character to show for a space. When omitted, spaces
4801 are left blank.
4802 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004803 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004804 trailing spaces are blank. Overrides the "space"
4805 setting for trailing spaces.
4806 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004807 extends:c Character to show in the last column, when 'wrap' is
4808 off and the line continues beyond the right of the
4809 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004810 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 precedes:c Character to show in the first column, when 'wrap'
4812 is off and there is text preceding the character
4813 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004814 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004815 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004816 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004817 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004818 nbsp:c Character to show for a non-breakable space character
4819 (0xA0 (160 decimal) and U+202F). Left blank when
4820 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004822 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004824 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825
4826 Examples: >
4827 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004828 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 :set lcs=extends:>,precedes:<
4830< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004831 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004832 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833
4834 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4835'loadplugins' 'lpl' boolean (default on)
4836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 When on the plugin scripts are loaded when starting up |load-plugins|.
4838 This option can be reset in your |vimrc| file to disable the loading
4839 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004840 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4841 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842
Bram Moolenaard94464e2015-11-02 15:28:18 +01004843 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004844'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004845 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004846 {only available when compiled with the |+lua/dyn|
4847 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004848 Specifies the name of the Lua shared library. The default is
4849 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004850 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004851 This option cannot be set from a |modeline| or in the |sandbox|, for
4852 security reasons.
4853
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004854 *'macatsui'* *'nomacatsui'*
4855'macatsui' boolean (default on)
4856 global
4857 {only available in Mac GUI version}
4858 This is a workaround for when drawing doesn't work properly. When set
4859 and compiled with multi-byte support ATSUI text drawing is used. When
4860 not set ATSUI text drawing is not used. Switch this option off when
4861 you experience drawing problems. In a future version the problems may
4862 be solved and this option becomes obsolete. Therefore use this method
4863 to unset it: >
4864 if exists('&macatsui')
4865 set nomacatsui
4866 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004867< Another option to check if you have drawing problems is
4868 'termencoding'.
4869
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 *'magic'* *'nomagic'*
4871'magic' boolean (default on)
4872 global
4873 Changes the special characters that can be used in search patterns.
4874 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004875 WARNING: Switching this option off most likely breaks plugins! That
4876 is because many patterns assume it's on and will fail when it's off.
4877 Only switch it off when working with old Vi scripts. In any other
4878 situation write patterns that work when 'magic' is on. Include "\M"
4879 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004880
4881 *'makeef'* *'mef'*
4882'makeef' 'mef' string (default: "")
4883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884 {not available when compiled without the |+quickfix|
4885 feature}
4886 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4887 and the |:grep| command.
4888 When it is empty, an internally generated temp file will be used.
4889 When "##" is included, it is replaced by a number to make the name
4890 unique. This makes sure that the ":make" command doesn't overwrite an
4891 existing file.
4892 NOT used for the ":cf" command. See 'errorfile' for that.
4893 Environment variables are expanded |:set_env|.
4894 See |option-backslash| about including spaces and backslashes.
4895 This option cannot be set from a |modeline| or in the |sandbox|, for
4896 security reasons.
4897
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004898 *'makeencoding'* *'menc'*
4899'makeencoding' 'menc' string (default "")
4900 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004901 Encoding used for reading the output of external commands. When empty,
4902 encoding is not converted.
4903 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4904 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4905 and `:laddfile`.
4906
4907 This would be mostly useful when you use MS-Windows and set 'encoding'
4908 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4909 'makeencoding' to "char" has the same effect as setting to the system
4910 locale encoding. Example: >
4911 :set encoding=utf-8
4912 :set makeencoding=char " system locale is used
4913<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914 *'makeprg'* *'mp'*
4915'makeprg' 'mp' string (default "make", VMS: "MMS")
4916 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004917 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004918 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4919 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004920 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004921 Environment variables are expanded |:set_env|. See |option-backslash|
4922 about including spaces and backslashes.
4923 Note that a '|' must be escaped twice: once for ":set" and once for
4924 the interpretation of a command. When you use a filter called
4925 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926 :set makeprg=gmake\ \\\|\ myfilter
4927< The placeholder "$*" can be given (even multiple times) to specify
4928 where the arguments will be included, for example: >
4929 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4930< This option cannot be set from a |modeline| or in the |sandbox|, for
4931 security reasons.
4932
4933 *'matchpairs'* *'mps'*
4934'matchpairs' 'mps' string (default "(:),{:},[:]")
4935 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004936 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004937 other.
4938 Only character pairs are allowed that are different, thus you cannot
4939 jump between two double quotes.
4940 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004941 The pairs must be separated by a comma. Example for including '<' and
4942 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943 :set mps+=<:>
4944
4945< A more exotic example, to jump between the '=' and ';' in an
4946 assignment, useful for languages like C and Java: >
4947 :au FileType c,cpp,java set mps+==:;
4948
4949< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01004950 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004951
4952 *'matchtime'* *'mat'*
4953'matchtime' 'mat' number (default 5)
4954 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004955 Tenths of a second to show the matching paren, when 'showmatch' is
4956 set. Note that this is not in milliseconds, like other options that
4957 set a time. This is to be compatible with Nvi.
4958
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004959 *'maxcombine'* *'mco'*
4960'maxcombine' 'mco' number (default 2)
4961 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004962 The maximum number of combining characters supported for displaying.
4963 Only used when 'encoding' is "utf-8".
4964 The default is OK for most languages. Hebrew may require 4.
4965 Maximum value is 6.
4966 Even when this option is set to 2 you can still edit text with more
4967 combining characters, you just can't see them. Use |g8| or |ga|.
4968 See |mbyte-combining|.
4969
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 *'maxfuncdepth'* *'mfd'*
4971'maxfuncdepth' 'mfd' number (default 100)
4972 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02004973 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004974 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 Maximum depth of function calls for user functions. This normally
4976 catches endless recursion. When using a recursive function with
4977 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4978 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01004979 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02004980 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 See also |:function|.
4982
4983 *'maxmapdepth'* *'mmd'* *E223*
4984'maxmapdepth' 'mmd' number (default 1000)
4985 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986 Maximum number of times a mapping is done without resulting in a
4987 character to be used. This normally catches endless mappings, like
4988 ":map x y" with ":map y x". It still does not catch ":map g wg",
4989 because the 'w' is used before the next mapping is done. See also
4990 |key-mapping|.
4991
4992 *'maxmem'* *'mm'*
4993'maxmem' 'mm' number (default between 256 to 5120 (system
4994 dependent) or half the amount of memory
4995 available)
4996 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4998 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01004999 other memory to be freed.
5000 The maximum usable value is about 2000000. Use this to work without a
5001 limit.
5002 The value is ignored when 'swapfile' is off.
5003 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005005 *'maxmempattern'* *'mmp'*
5006'maxmempattern' 'mmp' number (default 1000)
5007 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005008 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005009 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005010 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005011 When Vim runs into the limit it gives an error message and mostly
5012 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005013 Running into the limit often means that the pattern is very
5014 inefficient or too complex. This may already happen with the pattern
5015 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005016 Might also happen on redraw, when syntax rules try to match a complex
5017 text structure.
5018 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5019 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005020
Bram Moolenaar071d4272004-06-13 20:20:40 +00005021 *'maxmemtot'* *'mmt'*
5022'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5023 dependent) or half the amount of memory
5024 available)
5025 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005026 Maximum amount of memory in Kbyte to use for all buffers together.
5027 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005028 without a limit.
5029 On 64 bit machines higher values might work. But hey, do you really
5030 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005031 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005032 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005033 Buffers with 'swapfile' off still count to the total amount of memory
5034 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005035 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036
5037 *'menuitems'* *'mis'*
5038'menuitems' 'mis' number (default 25)
5039 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040 {not available when compiled without the |+menu|
5041 feature}
5042 Maximum number of items to use in a menu. Used for menus that are
5043 generated from a list of items, e.g., the Buffers menu. Changing this
5044 option has no direct effect, the menu must be refreshed first.
5045
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005046 *'mkspellmem'* *'msm'*
5047'mkspellmem' 'msm' string (default "460000,2000,500")
5048 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005049 {not available when compiled without the |+syntax|
5050 feature}
5051 Parameters for |:mkspell|. This tunes when to start compressing the
5052 word tree. Compression can be slow when there are many words, but
5053 it's needed to avoid running out of memory. The amount of memory used
5054 per word depends very much on how similar the words are, that's why
5055 this tuning is complicated.
5056
5057 There are three numbers, separated by commas:
5058 {start},{inc},{added}
5059
5060 For most languages the uncompressed word tree fits in memory. {start}
5061 gives the amount of memory in Kbyte that can be used before any
5062 compression is done. It should be a bit smaller than the amount of
5063 memory that is available to Vim.
5064
5065 When going over the {start} limit the {inc} number specifies the
5066 amount of memory in Kbyte that can be allocated before another
5067 compression is done. A low number means compression is done after
5068 less words are added, which is slow. A high number means more memory
5069 will be allocated.
5070
5071 After doing compression, {added} times 1024 words can be added before
5072 the {inc} limit is ignored and compression is done when any extra
5073 amount of memory is needed. A low number means there is a smaller
5074 chance of hitting the {inc} limit, less memory is used but it's
5075 slower.
5076
5077 The languages for which these numbers are important are Italian and
5078 Hungarian. The default works for when you have about 512 Mbyte. If
5079 you have 1 Gbyte you could use: >
5080 :set mkspellmem=900000,3000,800
5081< If you have less than 512 Mbyte |:mkspell| may fail for some
5082 languages, no matter what you set 'mkspellmem' to.
5083
Bram Moolenaar07607392019-05-26 19:20:43 +02005084 This option cannot be set from a |modeline| or in the |sandbox|.
5085
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005087'modeline' 'ml' boolean (Vim default: on (off for root),
5088 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005090 If 'modeline' is on 'modelines' gives the number of lines that is
5091 checked for set commands. If 'modeline' is off or 'modelines' is zero
5092 no lines are checked. See |modeline|.
5093
5094 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5095'modelineexpr' 'mle' boolean (default: off)
5096 global
5097 When on allow some options that are an expression to be set in the
5098 modeline. Check the option for whether it is affected by
5099 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005100 This option cannot be set from a |modeline| or in the |sandbox|, for
5101 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005102
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103 *'modelines'* *'mls'*
5104'modelines' 'mls' number (default 5)
5105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 If 'modeline' is on 'modelines' gives the number of lines that is
5107 checked for set commands. If 'modeline' is off or 'modelines' is zero
5108 no lines are checked. See |modeline|.
5109 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5110 set and to the Vim default value when 'compatible' is reset.
5111
5112 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005113 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114'modifiable' 'ma' boolean (default on)
5115 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116 When off the buffer contents cannot be changed. The 'fileformat' and
5117 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005118 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119
5120 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5121'modified' 'mod' boolean (default off)
5122 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123 When on, the buffer is considered to be modified. This option is set
5124 when:
5125 1. A change was made to the text since it was last written. Using the
5126 |undo| command to go back to the original text will reset the
5127 option. But undoing changes that were made before writing the
5128 buffer will set the option again, since the text is different from
5129 when it was written.
5130 2. 'fileformat' or 'fileencoding' is different from its original
5131 value. The original value is set when the buffer is read or
5132 written. A ":set nomodified" command also resets the original
5133 values to the current values and the 'modified' option will be
5134 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005135 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005136 This option is not set when a change is made to the buffer as the
5137 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5138 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5139 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5141 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005142 Note that the text may actually be the same, e.g. 'modified' is set
5143 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144
5145 *'more'* *'nomore'*
5146'more' boolean (Vim default: on, Vi default: off)
5147 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 When on, listings pause when the whole screen is filled. You will get
5149 the |more-prompt|. When this option is off there are no pauses, the
5150 listing continues until finished.
5151 NOTE: This option is set to the Vi default value when 'compatible' is
5152 set and to the Vim default value when 'compatible' is reset.
5153
5154 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005155'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5156 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005159 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5160 sysmouse and Linux console with gpm). For using the mouse in the
5161 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005163 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 v Visual mode
5165 i Insert mode
5166 c Command-line mode
5167 h all previous modes when editing a help file
5168 a all previous modes
5169 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005170 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 :set mouse=a
5172< When the mouse is not enabled, the GUI will still use the mouse for
5173 modeless selection. This doesn't move the text cursor.
5174
5175 See |mouse-using|. Also see |'clipboard'|.
5176
5177 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005178 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 the mouse buttons can still be used by keeping the shift key pressed.
5180 Also see the 'clipboard' option.
5181
5182 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5183'mousefocus' 'mousef' boolean (default off)
5184 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 {only works in the GUI}
5186 The window that the mouse pointer is on is automatically activated.
5187 When changing the window layout or window focus in another way, the
5188 mouse pointer is moved to the window with keyboard focus. Off is the
5189 default because it makes using the pull down menus a little goofy, as
5190 a pointer transit may activate a window unintentionally.
5191
5192 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5193'mousehide' 'mh' boolean (default on)
5194 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005195 {only works in the GUI}
5196 When on, the mouse pointer is hidden when characters are typed.
5197 The mouse pointer is restored when the mouse is moved.
5198
5199 *'mousemodel'* *'mousem'*
5200'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5201 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 Sets the model to use for the mouse. The name mostly specifies what
5203 the right mouse button is used for:
5204 extend Right mouse button extends a selection. This works
5205 like in an xterm.
5206 popup Right mouse button pops up a menu. The shifted left
5207 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005208 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 popup_setpos Like "popup", but the cursor will be moved to the
5210 position where the mouse was clicked, and thus the
5211 selected operation will act upon the clicked object.
5212 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005213 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 course, that right clicking outside a selection will
5215 end Visual mode.
5216 Overview of what button does what for each model:
5217 mouse extend popup(_setpos) ~
5218 left click place cursor place cursor
5219 left drag start selection start selection
5220 shift-left search word extend selection
5221 right click extend selection popup menu (place cursor)
5222 right drag extend selection -
5223 middle click paste paste
5224
5225 In the "popup" model the right mouse button produces a pop-up menu.
5226 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005227 In a terminal the popup menu works if Vim is compiled with the
5228 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229
5230 Note that you can further refine the meaning of buttons with mappings.
5231 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5232 selection (because that's handled in the GUI code directly).
5233
5234 The 'mousemodel' option is set by the |:behave| command.
5235
5236 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005237'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5238 vs:leftright,vd:lrsizing,m:no,
5239 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241 {only available when compiled with the |+mouseshape|
5242 feature}
5243 This option tells Vim what the mouse pointer should look like in
5244 different modes. The option is a comma separated list of parts, much
5245 like used for 'guicursor'. Each part consist of a mode/location-list
5246 and an argument-list:
5247 mode-list:shape,mode-list:shape,..
5248 The mode-list is a dash separated list of these modes/locations:
5249 In a normal window: ~
5250 n Normal mode
5251 v Visual mode
5252 ve Visual mode with 'selection' "exclusive" (same as 'v',
5253 if not specified)
5254 o Operator-pending mode
5255 i Insert mode
5256 r Replace mode
5257
5258 Others: ~
5259 c appending to the command-line
5260 ci inserting in the command-line
5261 cr replacing in the command-line
5262 m at the 'Hit ENTER' or 'More' prompts
5263 ml idem, but cursor in the last line
5264 e any mode, pointer below last window
5265 s any mode, pointer on a status line
5266 sd any mode, while dragging a status line
5267 vs any mode, pointer on a vertical separator line
5268 vd any mode, while dragging a vertical separator line
5269 a everywhere
5270
5271 The shape is one of the following:
5272 avail name looks like ~
5273 w x arrow Normal mouse pointer
5274 w x blank no pointer at all (use with care!)
5275 w x beam I-beam
5276 w x updown up-down sizing arrows
5277 w x leftright left-right sizing arrows
5278 w x busy The system's usual busy pointer
5279 w x no The system's usual 'no input' pointer
5280 x udsizing indicates up-down resizing
5281 x lrsizing indicates left-right resizing
5282 x crosshair like a big thin +
5283 x hand1 black hand
5284 x hand2 white hand
5285 x pencil what you write with
5286 x question big ?
5287 x rightup-arrow arrow pointing right-up
5288 w x up-arrow arrow pointing up
5289 x <number> any X11 pointer number (see X11/cursorfont.h)
5290
5291 The "avail" column contains a 'w' if the shape is available for Win32,
5292 x for X11.
5293 Any modes not specified or shapes not available use the normal mouse
5294 pointer.
5295
5296 Example: >
5297 :set mouseshape=s:udsizing,m:no
5298< will make the mouse turn to a sizing arrow over the status lines and
5299 indicate no input when the hit-enter prompt is displayed (since
5300 clicking the mouse has no effect in this state.)
5301
5302 *'mousetime'* *'mouset'*
5303'mousetime' 'mouset' number (default 500)
5304 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5306 time in msec between two mouse clicks for the second click to be
5307 recognized as a multi click.
5308
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005309 *'mzschemedll'*
5310'mzschemedll' string (default depends on the build)
5311 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005312 {only available when compiled with the |+mzscheme/dyn|
5313 feature}
5314 Specifies the name of the MzScheme shared library. The default is
5315 DYNAMIC_MZSCH_DLL which was specified at compile time.
5316 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005317 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005318 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005319 This option cannot be set from a |modeline| or in the |sandbox|, for
5320 security reasons.
5321
5322 *'mzschemegcdll'*
5323'mzschemegcdll' string (default depends on the build)
5324 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005325 {only available when compiled with the |+mzscheme/dyn|
5326 feature}
5327 Specifies the name of the MzScheme GC shared library. The default is
5328 DYNAMIC_MZGC_DLL which was specified at compile time.
5329 The value can be equal to 'mzschemedll' if it includes the GC code.
5330 Environment variables are expanded |:set_env|.
5331 This option cannot be set from a |modeline| or in the |sandbox|, for
5332 security reasons.
5333
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005334 *'mzquantum'* *'mzq'*
5335'mzquantum' 'mzq' number (default 100)
5336 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005337 {not available when compiled without the |+mzscheme|
5338 feature}
5339 The number of milliseconds between polls for MzScheme threads.
5340 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005341 NOTE: This option is set to the Vim default value when 'compatible'
5342 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005343
Bram Moolenaar071d4272004-06-13 20:20:40 +00005344 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005345'nrformats' 'nf' string (default "bin,octal,hex",
5346 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005348 This defines what bases Vim will consider for numbers when using the
5349 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5350 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005351 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005352 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005353 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005354 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005356 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357 considered to be hexadecimal. Example: Using CTRL-X on
5358 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005359 bin If included, numbers starting with "0b" or "0B" will be
5360 considered to be binary. Example: Using CTRL-X on
5361 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362 Numbers which simply begin with a digit in the range 1-9 are always
5363 considered decimal. This also happens for numbers that are not
5364 recognized as octal or hex.
5365
5366 *'number'* *'nu'* *'nonumber'* *'nonu'*
5367'number' 'nu' boolean (default off)
5368 local to window
5369 Print the line number in front of each line. When the 'n' option is
5370 excluded from 'cpoptions' a wrapped line will not use the column of
5371 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005372 The 'numberwidth' option can be used to set the room used for the line
5373 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374 When a long, wrapped line doesn't start with the first character, '-'
5375 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005376 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5377 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005378 *number_relativenumber*
5379 The 'relativenumber' option changes the displayed number to be
5380 relative to the cursor. Together with 'number' there are these
5381 four combinations (cursor in line 3):
5382
Bram Moolenaar3848e002016-03-19 18:42:29 +01005383 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005384 'nornu' 'nornu' 'rnu' 'rnu'
5385
5386 |apple | 1 apple | 2 apple | 2 apple
5387 |pear | 2 pear | 1 pear | 1 pear
5388 |nobody | 3 nobody | 0 nobody |3 nobody
5389 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005391 *'numberwidth'* *'nuw'*
5392'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5393 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005394 {only available when compiled with the |+linebreak|
5395 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005396 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005397 when the 'number' or 'relativenumber' option is set or printing lines
5398 with a line number. Since one space is always between the number and
5399 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005400 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005401 fit the highest line number in the buffer respectively the number of
5402 rows in the window, depending on whether 'number' or 'relativenumber'
5403 is set. Thus with the Vim default of 4 there is room for a line number
5404 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005405 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005406 NOTE: This option is set to the Vi default value when 'compatible' is
5407 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005408
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005409 *'omnifunc'* *'ofu'*
5410'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005411 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005412 {not available when compiled without the |+eval|
5413 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005414 This option specifies a function to be used for Insert mode omni
5415 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005416 See |complete-functions| for an explanation of how the function is
5417 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005418 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005419 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005420 This option cannot be set from a |modeline| or in the |sandbox|, for
5421 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005422
5423
Bram Moolenaar02467872007-05-06 13:22:01 +00005424 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005425'opendevice' 'odev' boolean (default off)
5426 global
Bram Moolenaar043545e2006-10-10 16:44:07 +00005427 {only for MS-DOS, MS-Windows and OS/2}
5428 Enable reading and writing from devices. This may get Vim stuck on a
5429 device that can be opened but doesn't actually do the I/O. Therefore
5430 it is off by default.
5431 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5432 result in editing a device.
5433
5434
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005435 *'operatorfunc'* *'opfunc'*
5436'operatorfunc' 'opfunc' string (default: empty)
5437 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005438 This option specifies a function to be called by the |g@| operator.
5439 See |:map-operator| for more info and an example.
5440
5441 This option cannot be set from a |modeline| or in the |sandbox|, for
5442 security reasons.
5443
5444
Bram Moolenaar251e1912011-06-19 05:09:16 +02005445 *'osfiletype'* *'oft'*
5446'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005448 This option was supported on RISC OS, which has been removed.
5449
Bram Moolenaar071d4272004-06-13 20:20:40 +00005450
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005451 *'packpath'* *'pp'*
5452'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005453 Directories used to find packages. See |packages|.
5454
5455
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005457'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005458 global
5459 Specifies the nroff macros that separate paragraphs. These are pairs
5460 of two letters (see |object-motions|).
5461
5462 *'paste'* *'nopaste'*
5463'paste' boolean (default off)
5464 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005465 Put Vim in Paste mode. This is useful if you want to cut or copy
5466 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467 unexpected effects.
5468 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005469 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470 knows about pasting and will mostly do the right thing without 'paste'
5471 being set. The same is true for a terminal where Vim handles the
5472 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005473 This option is reset when starting the GUI. Thus if you set it in
5474 your .vimrc it will work in a terminal, but not in the GUI. Setting
5475 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5476 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477 When the 'paste' option is switched on (also when it was already on):
5478 - mapping in Insert mode and Command-line mode is disabled
5479 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005481 - 'expandtab' is reset
5482 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 - 'revins' is reset
5484 - 'ruler' is reset
5485 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005486 - 'smartindent' is reset
5487 - 'smarttab' is reset
5488 - 'softtabstop' is set to 0
5489 - 'textwidth' is set to 0
5490 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005493 - 'indentexpr'
5494 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 NOTE: When you start editing another file while the 'paste' option is
5496 on, settings from the modelines or autocommands may change the
5497 settings again, causing trouble when pasting text. You might want to
5498 set the 'paste' option again.
5499 When the 'paste' option is reset the mentioned options are restored to
5500 the value before the moment 'paste' was switched from off to on.
5501 Resetting 'paste' before ever setting it does not have any effect.
5502 Since mapping doesn't work while 'paste' is active, you need to use
5503 the 'pastetoggle' option to toggle the 'paste' option with some key.
5504
5505 *'pastetoggle'* *'pt'*
5506'pastetoggle' 'pt' string (default "")
5507 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 When non-empty, specifies the key sequence that toggles the 'paste'
5509 option. This is like specifying a mapping: >
5510 :map {keys} :set invpaste<CR>
5511< Where {keys} is the value of 'pastetoggle'.
5512 The difference is that it will work even when 'paste' is set.
5513 'pastetoggle' works in Insert mode and Normal mode, but not in
5514 Command-line mode.
5515 Mappings are checked first, thus overrule 'pastetoggle'. However,
5516 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5517 this: >
5518 :map <F10> :set paste<CR>
5519 :map <F11> :set nopaste<CR>
5520 :imap <F10> <C-O>:set paste<CR>
5521 :imap <F11> <nop>
5522 :set pastetoggle=<F11>
5523< This will make <F10> start paste mode and <F11> stop paste mode.
5524 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5525 mode everything is inserted literally, except the 'pastetoggle' key
5526 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005527 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528
5529 *'pex'* *'patchexpr'*
5530'patchexpr' 'pex' string (default "")
5531 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 {not available when compiled without the |+diff|
5533 feature}
5534 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005535 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005536
Bram Moolenaardbc28022014-07-26 13:40:44 +02005537 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005538'patchmode' 'pm' string (default "")
5539 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 When non-empty the oldest version of a file is kept. This can be used
5541 to keep the original version of a file if you are changing files in a
5542 source distribution. Only the first time that a file is written a
5543 copy of the original file will be kept. The name of the copy is the
5544 name of the original file with the string in the 'patchmode' option
5545 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005546 ".orig" or ".org". 'backupdir' must not be empty for this to work
5547 (Detail: The backup file is renamed to the patchmode file after the
5548 new file has been successfully written, that's why it must be possible
5549 to write a backup file). If there was no file to be backed up, an
5550 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 When the 'backupskip' pattern matches, a patchmode file is not made.
5552 Using 'patchmode' for compressed files appends the extension at the
5553 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5554 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005555 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005557 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558'path' 'pa' string (default on Unix: ".,/usr/include,,"
5559 on OS/2: ".,/emx/include,,"
5560 other systems: ".,,")
5561 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005563 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5564 provided that the file being searched for has a relative path (not
5565 starting with "/", "./" or "../"). The directories in the 'path'
5566 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567 - Use commas to separate directory names: >
5568 :set path=.,/usr/local/include,/usr/include
5569< - Spaces can also be used to separate directory names (for backwards
5570 compatibility with version 3.0). To have a space in a directory
5571 name, precede it with an extra backslash, and escape the space: >
5572 :set path=.,/dir/with\\\ space
5573< - To include a comma in a directory name precede it with an extra
5574 backslash: >
5575 :set path=.,/dir/with\\,comma
5576< - To search relative to the directory of the current file, use: >
5577 :set path=.
5578< - To search in the current directory use an empty string between two
5579 commas: >
5580 :set path=,,
5581< - A directory name may end in a ':' or '/'.
5582 - Environment variables are expanded |:set_env|.
5583 - When using |netrw.vim| URLs can be used. For example, adding
5584 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005585 - Search upwards and downwards in a directory tree using "*", "**" and
5586 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 {not available when compiled without the |+path_extra| feature}
5588 - Careful with '\' characters, type two to get one in the option: >
5589 :set path=.,c:\\include
5590< Or just use '/' instead: >
5591 :set path=.,c:/include
5592< Don't forget "." or files won't even be found in the same directory as
5593 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005594 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595 it is something like 256 or 1024 characters.
5596 You can check if all the include files are found, using the value of
5597 'path', see |:checkpath|.
5598 The use of |:set+=| and |:set-=| is preferred when adding or removing
5599 directories from the list. This avoids problems when a future version
5600 uses another default. To remove the current directory use: >
5601 :set path-=
5602< To add the current directory use: >
5603 :set path+=
5604< To use an environment variable, you probably need to replace the
5605 separator. Here is an example to append $INCL, in which directory
5606 names are separated with a semi-colon: >
5607 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5608< Replace the ';' with a ':' or whatever separator is used. Note that
5609 this doesn't work when $INCL contains a comma or white space.
5610
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005611 *'perldll'*
5612'perldll' string (default depends on the build)
5613 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005614 {only available when compiled with the |+perl/dyn|
5615 feature}
5616 Specifies the name of the Perl shared library. The default is
5617 DYNAMIC_PERL_DLL, which was specified at compile time.
5618 Environment variables are expanded |:set_env|.
5619 This option cannot be set from a |modeline| or in the |sandbox|, for
5620 security reasons.
5621
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5623'preserveindent' 'pi' boolean (default off)
5624 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 When changing the indent of the current line, preserve as much of the
5626 indent structure as possible. Normally the indent is replaced by a
5627 series of tabs followed by spaces as required (unless |'expandtab'| is
5628 enabled, in which case only spaces are used). Enabling this option
5629 means the indent will preserve as many existing characters as possible
5630 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005631 'expandtab' does not apply to the preserved white space, a Tab remains
5632 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 NOTE: When using ">>" multiple times the resulting indent is a mix of
5634 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005635 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 Also see 'copyindent'.
5637 Use |:retab| to clean up white space.
5638
5639 *'previewheight'* *'pvh'*
5640'previewheight' 'pvh' number (default 12)
5641 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005643 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005645 commands. Used for |CTRL-W_}| when no count is given. Not used when
5646 'previewpopup' is set.
5647
5648 *'previewpopup'* *'pvp'*
5649'previewpopup' 'pvp' string (default empty)
5650 global
5651 {not available when compiled without the |+windows|,
5652 |+textprop| or |+quickfix| feature}
5653 When not empty a popup window is used for commands that would open a
5654 preview window. See |preview-popup|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655
5656 *'previewwindow'* *'nopreviewwindow'*
5657 *'pvw'* *'nopvw'* *E590*
5658'previewwindow' 'pvw' boolean (default off)
5659 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005660 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005661 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005662 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663 set. It's normally not set directly, but by using one of the commands
5664 |:ptag|, |:pedit|, etc.
5665
5666 *'printdevice'* *'pdev'*
5667'printdevice' 'pdev' string (default empty)
5668 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 {only available when compiled with the |+printer|
5670 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005671 The name of the printer to be used for |:hardcopy|.
5672 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005673 This option cannot be set from a |modeline| or in the |sandbox|, for
5674 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675
Bram Moolenaar8299df92004-07-10 09:47:34 +00005676 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005677'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 {only available when compiled with the |+printer|
5680 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005681 Sets the character encoding used when printing.
5682 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005683
5684 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005685'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 {only available when compiled with the |+printer|
5688 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005689 Expression used to print the PostScript produced with |:hardcopy|.
5690 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005691 This option cannot be set from a |modeline| or in the |sandbox|, for
5692 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693
Bram Moolenaar8299df92004-07-10 09:47:34 +00005694 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695'printfont' 'pfn' string (default "courier")
5696 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 {only available when compiled with the |+printer|
5698 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005699 The name of the font that will be used for |:hardcopy|.
5700 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701
5702 *'printheader'* *'pheader'*
5703'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705 {only available when compiled with the |+printer|
5706 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005707 The format of the header produced in |:hardcopy| output.
5708 See |pheader-option|.
5709
5710 *'printmbcharset'* *'pmbcs'*
5711'printmbcharset' 'pmbcs' string (default "")
5712 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005713 {only available when compiled with the |+printer|
5714 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005715 The CJK character set to be used for CJK output from |:hardcopy|.
5716 See |pmbcs-option|.
5717
5718 *'printmbfont'* *'pmbfn'*
5719'printmbfont' 'pmbfn' string (default "")
5720 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005721 {only available when compiled with the |+printer|
5722 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005723 List of font names to be used for CJK output from |:hardcopy|.
5724 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725
5726 *'printoptions'* *'popt'*
5727'printoptions' 'popt' string (default "")
5728 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005730 List of items that control the format of the output of |:hardcopy|.
5731 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005733 *'prompt'* *'noprompt'*
5734'prompt' boolean (default on)
5735 global
5736 When on a ":" prompt is used in Ex mode.
5737
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005738 *'pumheight'* *'ph'*
5739'pumheight' 'ph' number (default 0)
5740 global
5741 {not available when compiled without the
5742 |+insert_expand| feature}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005743 Determines the maximum number of items to show in the popup menu for
5744 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005745 |ins-completion-menu|.
5746
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005747 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005748'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005749 global
5750 {not available when compiled without the
5751 |+insert_expand| feature}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005752 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005753 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005754
Bram Moolenaard94464e2015-11-02 15:28:18 +01005755 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005756'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005757 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005758 {only available when compiled with the |+python/dyn|
5759 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005760 Specifies the name of the Python 2.x shared library. The default is
5761 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005762 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005763 This option cannot be set from a |modeline| or in the |sandbox|, for
5764 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005765
Bram Moolenaar94073162018-01-31 21:49:05 +01005766 *'pythonhome'*
5767'pythonhome' string (default "")
5768 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005769 {only available when compiled with the |+python/dyn|
5770 feature}
5771 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5772 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5773 which was specified at compile time, will be used for the Python 2.x
5774 home directory.
5775 Environment variables are expanded |:set_env|.
5776 This option cannot be set from a |modeline| or in the |sandbox|, for
5777 security reasons.
5778
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005779 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005780'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005781 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005782 {only available when compiled with the |+python3/dyn|
5783 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005784 Specifies the name of the Python 3 shared library. The default is
5785 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005786 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005787 This option cannot be set from a |modeline| or in the |sandbox|, for
5788 security reasons.
5789
Bram Moolenaar94073162018-01-31 21:49:05 +01005790 *'pythonthreehome'*
5791'pythonthreehome' string (default "")
5792 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005793 {only available when compiled with the |+python3/dyn|
5794 feature}
5795 Specifies the name of the Python 3 home directory. When
5796 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5797 PYTHON3_HOME, which was specified at compile time, will be used for
5798 the Python 3 home directory.
5799 Environment variables are expanded |:set_env|.
5800 This option cannot be set from a |modeline| or in the |sandbox|, for
5801 security reasons.
5802
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005803 *'pyxversion'* *'pyx'*
5804'pyxversion' 'pyx' number (default depends on the build)
5805 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005806 {only available when compiled with the |+python| or
5807 the |+python3| feature}
5808 Specifies the python version used for pyx* functions and commands
5809 |python_x|. The default value is as follows:
5810
5811 Compiled with Default ~
5812 |+python| and |+python3| 0
5813 only |+python| 2
5814 only |+python3| 3
5815
5816 Available values are 0, 2 and 3.
5817 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5818 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5819 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5820 to 2 if Python 2 is available.
5821 See also: |has-pythonx|
5822
5823 If Vim is compiled with only |+python| or |+python3| setting
5824 'pyxversion' has no effect. The pyx* functions and commands are
5825 always the same as the compiled version.
5826
5827 This option cannot be set from a |modeline| or in the |sandbox|, for
5828 security reasons.
5829
Bram Moolenaar677ee682005-01-27 14:41:15 +00005830 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005831'quoteescape' 'qe' string (default "\")
5832 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005833 The characters that are used to escape quotes in a string. Used for
5834 objects like a', a" and a` |a'|.
5835 When one of the characters in this option is found inside a string,
5836 the following character will be skipped. The default value makes the
5837 text "foo\"bar\\" considered to be one string.
5838
Bram Moolenaar071d4272004-06-13 20:20:40 +00005839 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5840'readonly' 'ro' boolean (default off)
5841 local to buffer
5842 If on, writes fail unless you use a '!'. Protects you from
5843 accidentally overwriting a file. Default on when Vim is started
5844 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005845 When using ":w!" the 'readonly' option is reset for the current
5846 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005847 When using the ":view" command the 'readonly' option is set for the
5848 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005849 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005851 *'redrawtime'* *'rdt'*
5852'redrawtime' 'rdt' number (default 2000)
5853 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005854 {only available when compiled with the |+reltime|
5855 feature}
5856 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005857 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005858 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005859 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005860 matches will be highlighted.
5861 For syntax highlighting the time applies per window. When over the
5862 limit syntax highlighting is disabled until |CTRL-L| is used.
5863 This is used to avoid that Vim hangs when using a very complicated
5864 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005865
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005866 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005867'regexpengine' 're' number (default 0)
5868 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005869 This selects the default regexp engine. |two-engines|
5870 The possible values are:
5871 0 automatic selection
5872 1 old engine
5873 2 NFA engine
5874 Note that when using the NFA engine and the pattern contains something
5875 that is not supported the pattern will not match. This is only useful
5876 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005877 Using automatic selection enables Vim to switch the engine, if the
5878 default engine becomes too costly. E.g., when the NFA engine uses too
5879 many states. This should prevent Vim from hanging on a combination of
5880 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005881
Bram Moolenaar64486672010-05-16 15:46:46 +02005882 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5883'relativenumber' 'rnu' boolean (default off)
5884 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005885 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005886 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005887 precede some vertical motion commands (e.g. j k + -) with, without
5888 having to calculate it yourself. Especially useful in combination with
5889 other commands (e.g. y d c < > gq gw =).
5890 When the 'n' option is excluded from 'cpoptions' a wrapped
5891 line will not use the column of line numbers (this is the default when
5892 'compatible' isn't set).
5893 The 'numberwidth' option can be used to set the room used for the line
5894 number.
5895 When a long, wrapped line doesn't start with the first character, '-'
5896 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005897 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5898 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005899
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005900 The number in front of the cursor line also depends on the value of
5901 'number', see |number_relativenumber| for all combinations of the two
5902 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005903
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 *'remap'* *'noremap'*
5905'remap' boolean (default on)
5906 global
5907 Allows for mappings to work recursively. If you do not want this for
5908 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005909 NOTE: To avoid portability problems with Vim scripts, always keep
5910 this option at the default "on". Only switch it off when working with
5911 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005913 *'renderoptions'* *'rop'*
5914'renderoptions' 'rop' string (default: empty)
5915 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005916 {only available when compiled with GUI and DIRECTX on
5917 MS-Windows}
5918 Select a text renderer and set its options. The options depend on the
5919 renderer.
5920
5921 Syntax: >
5922 set rop=type:{renderer}(,{name}:{value})*
5923<
5924 Currently, only one optional renderer is available.
5925
5926 render behavior ~
5927 directx Vim will draw text using DirectX (DirectWrite). It makes
5928 drawn glyphs more beautiful than default GDI.
5929 It requires 'encoding' is "utf-8", and only works on
5930 MS-Windows Vista or newer version.
5931
5932 Options:
5933 name meaning type value ~
5934 gamma gamma float 1.0 - 2.2 (maybe)
5935 contrast enhancedContrast float (unknown)
5936 level clearTypeLevel float (unknown)
5937 geom pixelGeometry int 0 - 2 (see below)
5938 renmode renderingMode int 0 - 6 (see below)
5939 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01005940 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005941
Bram Moolenaar92467d32017-12-05 13:22:16 +01005942 See this URL for detail (except for scrlines):
5943 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005944
5945 For geom: structure of a device pixel.
5946 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5947 1 - DWRITE_PIXEL_GEOMETRY_RGB
5948 2 - DWRITE_PIXEL_GEOMETRY_BGR
5949
5950 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005951 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005952
5953 For renmode: method of rendering glyphs.
5954 0 - DWRITE_RENDERING_MODE_DEFAULT
5955 1 - DWRITE_RENDERING_MODE_ALIASED
5956 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5957 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5958 4 - DWRITE_RENDERING_MODE_NATURAL
5959 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5960 6 - DWRITE_RENDERING_MODE_OUTLINE
5961
5962 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005963 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005964
5965 For taamode: antialiasing mode used for drawing text.
5966 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5967 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5968 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5969 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5970
5971 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005972 https://msdn.microsoft.com/en-us/library/dd368170.aspx
5973
Bram Moolenaara338adc2018-01-31 20:51:47 +01005974 For scrlines:
5975 This was used for optimizing scrolling behavior, however this
5976 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005977
5978 Example: >
5979 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005980 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005981 set rop=type:directx
5982<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005983 If select a raster font (Courier, Terminal or FixedSys which
5984 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01005985 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005986
5987 NOTE: It is known that some fonts and options combination
5988 causes trouble on drawing glyphs.
5989
Bram Moolenaar92467d32017-12-05 13:22:16 +01005990 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005991 special made fonts (True-Type fonts which includes only
5992 bitmap glyphs).
5993 - 'taamode:3' will not work with some vector fonts.
5994
5995 NOTE: With this option, you can display colored emoji
5996 (emoticon) in Windows 8.1 or later. To display colored emoji,
5997 there are some conditions which you should notice.
5998
5999 - If your font includes non-colored emoji already, it will
6000 be used.
6001 - If your font doesn't have emoji, the system chooses an
6002 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6003 will be used.
6004 - When this alternative font didn't have fixed width glyph,
6005 emoji might be rendered beyond the bounding box of drawing
6006 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006007
6008 Other render types are currently not supported.
6009
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 *'report'*
6011'report' number (default 2)
6012 global
6013 Threshold for reporting number of lines changed. When the number of
6014 changed lines is more than 'report' a message will be given for most
6015 ":" commands. If you want it always, set 'report' to 0.
6016 For the ":substitute" command the number of substitutions is used
6017 instead of the number of lines.
6018
6019 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6020'restorescreen' 'rs' boolean (default on)
6021 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006022 {only in Windows 95/NT console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 When set, the screen contents is restored when exiting Vim. This also
6024 happens when executing external commands.
6025
6026 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6027 options in your .vimrc. To disable restoring:
6028 set t_ti= t_te=
6029 To enable restoring (for an xterm):
6030 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6031 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6032
6033 *'revins'* *'ri'* *'norevins'* *'nori'*
6034'revins' 'ri' boolean (default off)
6035 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036 {only available when compiled with the |+rightleft|
6037 feature}
6038 Inserting characters in Insert mode will work backwards. See "typing
6039 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6040 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006041 NOTE: This option is reset when 'compatible' is set.
6042 This option is reset when 'paste' is set and restored when 'paste' is
6043 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044
6045 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6046'rightleft' 'rl' boolean (default off)
6047 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048 {only available when compiled with the |+rightleft|
6049 feature}
6050 When on, display orientation becomes right-to-left, i.e., characters
6051 that are stored in the file appear from the right to the left.
6052 Using this option, it is possible to edit files for languages that
6053 are written from the right to the left such as Hebrew and Arabic.
6054 This option is per window, so it is possible to edit mixed files
6055 simultaneously, or to view the same file in both ways (this is
6056 useful whenever you have a mixed text file with both right-to-left
6057 and left-to-right strings so that both sets are displayed properly
6058 in different windows). Also see |rileft.txt|.
6059
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006060 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061'rightleftcmd' 'rlc' string (default "search")
6062 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063 {only available when compiled with the |+rightleft|
6064 feature}
6065 Each word in this option enables the command line editing to work in
6066 right-to-left mode for a group of commands:
6067
6068 search "/" and "?" commands
6069
6070 This is useful for languages such as Hebrew, Arabic and Farsi.
6071 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6072
Bram Moolenaard94464e2015-11-02 15:28:18 +01006073 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006074'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006075 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006076 {only available when compiled with the |+ruby/dyn|
6077 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006078 Specifies the name of the Ruby shared library. The default is
6079 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006080 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006081 This option cannot be set from a |modeline| or in the |sandbox|, for
6082 security reasons.
6083
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006085'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006086 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006087 {not available when compiled without the
6088 |+cmdline_info| feature}
6089 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006090 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091 text in the file is shown on the far right:
6092 Top first line is visible
6093 Bot last line is visible
6094 All first and last line are visible
6095 45% relative position in the file
6096 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006097 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006099 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 this option takes precedence over 'ruler' and 'rulerformat'
6101 If the number of characters displayed is different from the number of
6102 bytes in the text (e.g., for a TAB or a multi-byte character), both
6103 the text column (byte number) and the screen column are shown,
6104 separated with a dash.
6105 For an empty line "0-1" is shown.
6106 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006107 This option is reset when 'paste' is set and restored when 'paste' is
6108 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006109 If you don't want to see the ruler all the time but want to know where
6110 you are, use "g CTRL-G" |g_CTRL-G|.
6111 NOTE: This option is reset when 'compatible' is set.
6112
6113 *'rulerformat'* *'ruf'*
6114'rulerformat' 'ruf' string (default empty)
6115 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006116 {not available when compiled without the |+statusline|
6117 feature}
6118 When this option is not empty, it determines the content of the ruler
6119 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006120 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006121 This option cannot be set in a modeline when 'modelineexpr' is off.
6122
Bram Moolenaar071d4272004-06-13 20:20:40 +00006123 The default ruler width is 17 characters. To make the ruler 15
6124 characters wide, put "%15(" at the start and "%)" at the end.
6125 Example: >
6126 :set rulerformat=%15(%c%V\ %p%%%)
6127<
6128 *'runtimepath'* *'rtp'* *vimfiles*
6129'runtimepath' 'rtp' string (default:
6130 Unix: "$HOME/.vim,
6131 $VIM/vimfiles,
6132 $VIMRUNTIME,
6133 $VIM/vimfiles/after,
6134 $HOME/.vim/after"
6135 Amiga: "home:vimfiles,
6136 $VIM/vimfiles,
6137 $VIMRUNTIME,
6138 $VIM/vimfiles/after,
6139 home:vimfiles/after"
6140 PC, OS/2: "$HOME/vimfiles,
6141 $VIM/vimfiles,
6142 $VIMRUNTIME,
6143 $VIM/vimfiles/after,
6144 $HOME/vimfiles/after"
6145 Macintosh: "$VIM:vimfiles,
6146 $VIMRUNTIME,
6147 $VIM:vimfiles:after"
6148 RISC-OS: "Choices:vimfiles,
6149 $VIMRUNTIME,
6150 Choices:vimfiles/after"
6151 VMS: "sys$login:vimfiles,
6152 $VIM/vimfiles,
6153 $VIMRUNTIME,
6154 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006155 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006157 This is a list of directories which will be searched for runtime
6158 files:
6159 filetype.vim filetypes by file name |new-filetype|
6160 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006161 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162 colors/ color scheme files |:colorscheme|
6163 compiler/ compiler files |:compiler|
6164 doc/ documentation |write-local-help|
6165 ftplugin/ filetype plugins |write-filetype-plugin|
6166 indent/ indent scripts |indent-expression|
6167 keymap/ key mapping files |mbyte-keymap|
6168 lang/ menu translations |:menutrans|
6169 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006170 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 plugin/ plugin scripts |write-plugin|
6172 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006173 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 syntax/ syntax files |mysyntaxfile|
6175 tutor/ files for vimtutor |tutor|
6176
6177 And any other file searched for with the |:runtime| command.
6178
6179 The defaults for most systems are setup to search five locations:
6180 1. In your home directory, for your personal preferences.
6181 2. In a system-wide Vim directory, for preferences from the system
6182 administrator.
6183 3. In $VIMRUNTIME, for files distributed with Vim.
6184 *after-directory*
6185 4. In the "after" directory in the system-wide Vim directory. This is
6186 for the system administrator to overrule or add to the distributed
6187 defaults (rarely needed)
6188 5. In the "after" directory in your home directory. This is for
6189 personal preferences to overrule or add to the distributed defaults
6190 or system-wide settings (rarely needed).
6191
Bram Moolenaard0796902016-09-16 20:02:31 +02006192 More entries are added when using |packages|. If it gets very long
6193 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6194 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006195
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6197 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006198 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 wildcards.
6200 See |:runtime|.
6201 Example: >
6202 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6203< This will use the directory "~/vimruntime" first (containing your
6204 personal Vim runtime files), then "/mygroup/vim" (shared between a
6205 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6206 files).
6207 You probably should always include $VIMRUNTIME somewhere, to use the
6208 distributed runtime files. You can put a directory before $VIMRUNTIME
6209 to find files which replace a distributed runtime files. You can put
6210 a directory after $VIMRUNTIME to find files which add to distributed
6211 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006212 When Vim is started with |--clean| the home directory entries are not
6213 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 This option cannot be set from a |modeline| or in the |sandbox|, for
6215 security reasons.
6216
6217 *'scroll'* *'scr'*
6218'scroll' 'scr' number (default: half the window height)
6219 local to window
6220 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6221 set to half the number of lines in the window when the window size
6222 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006223 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006224 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225
6226 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6227'scrollbind' 'scb' boolean (default off)
6228 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229 See also |scroll-binding|. When this option is set, the current
6230 window scrolls as other scrollbind windows (windows that also have
6231 this option set) scroll. This option is useful for viewing the
6232 differences between two versions of a file, see 'diff'.
6233 See |'scrollopt'| for options that determine how this option should be
6234 interpreted.
6235 This option is mostly reset when splitting a window to edit another
6236 file. This means that ":split | edit file" results in two windows
6237 with scroll-binding, but ":split file" does not.
6238
6239 *'scrolljump'* *'sj'*
6240'scrolljump' 'sj' number (default 1)
6241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 Minimal number of lines to scroll when the cursor gets off the
6243 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6244 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006245 When set to a negative number from -1 to -100 this is used as the
6246 percentage of the window height. Thus -50 scrolls half the window
6247 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 NOTE: This option is set to 1 when 'compatible' is set.
6249
6250 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006251'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006252 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 Minimal number of screen lines to keep above and below the cursor.
6254 This will make some context visible around where you are working. If
6255 you set it to a very large value (999) the cursor line will always be
6256 in the middle of the window (except at the start or end of the file or
6257 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006258 After using the local value, go back the global value with one of
6259 these two: >
6260 setlocal scrolloff<
6261 setlocal scrolloff=-1
6262< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263 NOTE: This option is set to 0 when 'compatible' is set.
6264
6265 *'scrollopt'* *'sbo'*
6266'scrollopt' 'sbo' string (default "ver,jump")
6267 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006269 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6270 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271 The following words are available:
6272 ver Bind vertical scrolling for 'scrollbind' windows
6273 hor Bind horizontal scrolling for 'scrollbind' windows
6274 jump Applies to the offset between two windows for vertical
6275 scrolling. This offset is the difference in the first
6276 displayed line of the bound windows. When moving
6277 around in a window, another 'scrollbind' window may
6278 reach a position before the start or after the end of
6279 the buffer. The offset is not changed though, when
6280 moving back the 'scrollbind' window will try to scroll
6281 to the desired position when possible.
6282 When now making that window the current one, two
6283 things can be done with the relative offset:
6284 1. When "jump" is not included, the relative offset is
6285 adjusted for the scroll position in the new current
6286 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006287 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006288 2. When "jump" is included, the other windows are
6289 scrolled to keep the same relative offset. When
6290 going back to the other window, it still uses the
6291 same relative offset.
6292 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006293 When 'diff' mode is active there always is vertical scroll binding,
6294 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006295
6296 *'sections'* *'sect'*
6297'sections' 'sect' string (default "SHNHH HUnhsh")
6298 global
6299 Specifies the nroff macros that separate sections. These are pairs of
6300 two letters (See |object-motions|). The default makes a section start
6301 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6302
6303 *'secure'* *'nosecure'* *E523*
6304'secure' boolean (default off)
6305 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306 When on, ":autocmd", shell and write commands are not allowed in
6307 ".vimrc" and ".exrc" in the current directory and map commands are
6308 displayed. Switch it off only if you know that you will not run into
6309 problems, or when the 'exrc' option is off. On Unix this option is
6310 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006311 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 'secure' at the end of your ~/.vimrc then.
6313 This option cannot be set from a |modeline| or in the |sandbox|, for
6314 security reasons.
6315
6316 *'selection'* *'sel'*
6317'selection' 'sel' string (default "inclusive")
6318 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319 This option defines the behavior of the selection. It is only used
6320 in Visual and Select mode.
6321 Possible values:
6322 value past line inclusive ~
6323 old no yes
6324 inclusive yes yes
6325 exclusive yes no
6326 "past line" means that the cursor is allowed to be positioned one
6327 character past the line.
6328 "inclusive" means that the last character of the selection is included
6329 in an operation. For example, when "x" is used to delete the
6330 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006331 When "old" is used and 'virtualedit' allows the cursor to move past
6332 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 Note that when "exclusive" is used and selecting from the end
6334 backwards, you cannot include the last character of a line, when
6335 starting in Normal mode and 'virtualedit' empty.
6336
6337 The 'selection' option is set by the |:behave| command.
6338
6339 *'selectmode'* *'slm'*
6340'selectmode' 'slm' string (default "")
6341 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 This is a comma separated list of words, which specifies when to start
6343 Select mode instead of Visual mode, when a selection is started.
6344 Possible values:
6345 mouse when using the mouse
6346 key when using shifted special keys
6347 cmd when using "v", "V" or CTRL-V
6348 See |Select-mode|.
6349 The 'selectmode' option is set by the |:behave| command.
6350
6351 *'sessionoptions'* *'ssop'*
6352'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006353 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006355 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006356 feature}
6357 Changes the effect of the |:mksession| command. It is a comma
6358 separated list of words. Each word enables saving and restoring
6359 something:
6360 word save and restore ~
6361 blank empty windows
6362 buffers hidden and unloaded buffers, not just those in windows
6363 curdir the current directory
6364 folds manually created folds, opened/closed folds and local
6365 fold options
6366 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006367 and contain at least one lowercase letter. Only
6368 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006369 help the help window
6370 localoptions options and mappings local to a window or buffer (not
6371 global values for local options)
6372 options all options and mappings (also global values for local
6373 options)
6374 resize size of the Vim window: 'lines' and 'columns'
6375 sesdir the directory in which the session file is located
6376 will become the current directory (useful with
6377 projects accessed over a network from different
6378 systems)
6379 slash backslashes in file names replaced with forward
6380 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006381 tabpages all tab pages; without this only the current tab page
6382 is restored, so that you can make a session for each
6383 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006384 terminal include terminal windows where the command can be
6385 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 unix with Unix end-of-line format (single <NL>), even when
6387 on Windows or DOS
6388 winpos position of the whole Vim window
6389 winsize window sizes
6390
6391 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006392 When neither "curdir" nor "sesdir" is included, file names are stored
6393 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006394 "slash" and "unix" are useful on Windows when sharing session files
6395 with Unix. The Unix version of Vim cannot source dos format scripts,
6396 but the Windows version of Vim can source unix format scripts.
6397
6398 *'shell'* *'sh'* *E91*
6399'shell' 'sh' string (default $SHELL or "sh",
6400 MS-DOS and Win32: "command.com" or
6401 "cmd.exe", OS/2: "cmd")
6402 global
6403 Name of the shell to use for ! and :! commands. When changing the
6404 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6405 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006406 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006407 See |option-backslash| about including spaces and backslashes.
6408 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006409
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006411 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6413< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006414 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006416 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006417 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006418 Example with escaped space (Vim will do this when initializing the
6419 option from $SHELL): >
6420 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006421< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006422 backslashes are consumed by `:set`.
6423
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424 Under MS-Windows, when the executable ends in ".com" it must be
6425 included. Thus setting the shell to "command.com" or "4dos.com"
6426 works, but "command" and "4dos" do not work for all commands (e.g.,
6427 filtering).
6428 For unknown reasons, when using "4dos.com" the current directory is
6429 changed to "C:\". To avoid this set 'shell' like this: >
6430 :set shell=command.com\ /c\ 4dos
6431< This option cannot be set from a |modeline| or in the |sandbox|, for
6432 security reasons.
6433
6434 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006435'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006436 MS-DOS and Win32, when 'shell' does not
6437 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006438 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006439 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6440 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6441 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006442 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006443 On Unix it can have more than one flag. Each white space separated
6444 part is passed as an argument to the shell command.
6445 See |option-backslash| about including spaces and backslashes.
6446 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 This option cannot be set from a |modeline| or in the |sandbox|, for
6448 security reasons.
6449
6450 *'shellpipe'* *'sp'*
6451'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6452 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006453 {not available when compiled without the |+quickfix|
6454 feature}
6455 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006456 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457 including spaces and backslashes.
6458 The name of the temporary file can be represented by "%s" if necessary
6459 (the file name is appended automatically if no %s appears in the value
6460 of this option).
6461 For the Amiga and MS-DOS the default is ">". The output is directly
6462 saved in a file and not echoed to the screen.
6463 For Unix the default it "| tee". The stdout of the compiler is saved
6464 in a file and echoed to the screen. If the 'shell' option is "csh" or
6465 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006466 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6467 default becomes "2>&1| tee". This means that stderr is also included.
6468 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6469 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 The initialization of this option is done after reading the ".vimrc"
6471 and the other initializations, so that when the 'shell' option is set
6472 there, the 'shellpipe' option changes automatically, unless it was
6473 explicitly set before.
6474 When 'shellpipe' is set to an empty string, no redirection of the
6475 ":make" output will be done. This is useful if you use a 'makeprg'
6476 that writes to 'makeef' by itself. If you want no piping, but do
6477 want to include the 'makeef', set 'shellpipe' to a single space.
6478 Don't forget to precede the space with a backslash: ":set sp=\ ".
6479 In the future pipes may be used for filtering and this option will
6480 become obsolete (at least for Unix).
6481 This option cannot be set from a |modeline| or in the |sandbox|, for
6482 security reasons.
6483
6484 *'shellquote'* *'shq'*
6485'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6486 contains "sh" somewhere: "\"")
6487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 Quoting character(s), put around the command passed to the shell, for
6489 the "!" and ":!" commands. The redirection is kept outside of the
6490 quoting. See 'shellxquote' to include the redirection. It's
6491 probably not useful to set both options.
6492 This is an empty string by default. Only known to be useful for
6493 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6494 or bash, where it should be "\"". The default is adjusted according
6495 the value of 'shell', to reduce the need to set this option by the
6496 user. See |dos-shell|.
6497 This option cannot be set from a |modeline| or in the |sandbox|, for
6498 security reasons.
6499
6500 *'shellredir'* *'srr'*
6501'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6502 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 String to be used to put the output of a filter command in a temporary
6504 file. See also |:!|. See |option-backslash| about including spaces
6505 and backslashes.
6506 The name of the temporary file can be represented by "%s" if necessary
6507 (the file name is appended automatically if no %s appears in the value
6508 of this option).
6509 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6510 or "zsh" during initializations, the default becomes ">&". If the
6511 'shell' option is "sh", "ksh" or "bash" the default becomes
6512 ">%s 2>&1". This means that stderr is also included.
6513 For Win32, the Unix checks are done and additionally "cmd" is checked
6514 for, which makes the default ">%s 2>&1". Also, the same names with
6515 ".exe" appended are checked for.
6516 The initialization of this option is done after reading the ".vimrc"
6517 and the other initializations, so that when the 'shell' option is set
6518 there, the 'shellredir' option changes automatically unless it was
6519 explicitly set before.
6520 In the future pipes may be used for filtering and this option will
6521 become obsolete (at least for Unix).
6522 This option cannot be set from a |modeline| or in the |sandbox|, for
6523 security reasons.
6524
6525 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6526'shellslash' 'ssl' boolean (default off)
6527 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006528 {only for MSDOS, MS-Windows and OS/2}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 When set, a forward slash is used when expanding file names. This is
6530 useful when a Unix-like shell is used instead of command.com or
6531 cmd.exe. Backward slashes can still be typed, but they are changed to
6532 forward slashes by Vim.
6533 Note that setting or resetting this option has no effect for some
6534 existing file names, thus this option needs to be set before opening
6535 any file for best results. This might change in the future.
6536 'shellslash' only works when a backslash can be used as a path
6537 separator. To test if this is so use: >
6538 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006539< Also see 'completeslash'.
6540
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006541 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6542'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6543 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006544 When on, use temp files for shell commands. When off use a pipe.
6545 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006546 Currently a pipe is only supported on Unix and MS-Windows 2K and
6547 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006548 :if has("filterpipe")
6549< The advantage of using a pipe is that nobody can read the temp file
6550 and the 'shell' command does not need to support redirection.
6551 The advantage of using a temp file is that the file type and encoding
6552 can be detected.
6553 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6554 |FilterWritePost| autocommands event are not triggered when
6555 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006556 The `system()` function does not respect this option and always uses
6557 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006558 NOTE: This option is set to the Vim default value when 'compatible'
6559 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006560
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 *'shelltype'* *'st'*
6562'shelltype' 'st' number (default 0)
6563 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006564 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 On the Amiga this option influences the way how the commands work
6566 which use a shell.
6567 0 and 1: always use the shell
6568 2 and 3: use the shell only to filter lines
6569 4 and 5: use shell only for ':sh' command
6570 When not using the shell, the command is executed directly.
6571
6572 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6573 1 and 3: use "shell cmd" to start external commands
6574
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006575 *'shellxescape'* *'sxe'*
6576'shellxescape' 'sxe' string (default: "";
6577 for MS-DOS and MS-Windows: "\"&|<>()@^")
6578 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006579 When 'shellxquote' is set to "(" then the characters listed in this
6580 option will be escaped with a '^' character. This makes it possible
6581 to execute most external commands with cmd.exe.
6582
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583 *'shellxquote'* *'sxq'*
6584'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006585 for Win32, when 'shell' is cmd.exe: "("
6586 for Win32, when 'shell' contains "sh"
6587 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 for Unix, when using system(): "\"")
6589 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590 Quoting character(s), put around the command passed to the shell, for
6591 the "!" and ":!" commands. Includes the redirection. See
6592 'shellquote' to exclude the redirection. It's probably not useful
6593 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006594 When the value is '(' then ')' is appended. When the value is '"('
6595 then ')"' is appended.
6596 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006597 This is an empty string by default on most systems, but is known to be
6598 useful for on Win32 version, either for cmd.exe which automatically
6599 strips off the first and last quote on a command, or 3rd-party shells
6600 such as the MKS Korn Shell or bash, where it should be "\"". The
6601 default is adjusted according the value of 'shell', to reduce the need
6602 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 This option cannot be set from a |modeline| or in the |sandbox|, for
6604 security reasons.
6605
6606 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6607'shiftround' 'sr' boolean (default off)
6608 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006609 Round indent to multiple of 'shiftwidth'. Applies to > and <
6610 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6611 a multiple of 'shiftwidth' (this is Vi compatible).
6612 NOTE: This option is reset when 'compatible' is set.
6613
6614 *'shiftwidth'* *'sw'*
6615'shiftwidth' 'sw' number (default 8)
6616 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006617 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006619 When zero the 'ts' value will be used. Use the |shiftwidth()|
6620 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006621
6622 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006623'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6624 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006625 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 This option helps to avoid all the |hit-enter| prompts caused by file
6627 messages, for example with CTRL-G, and to avoid some other messages.
6628 It is a list of flags:
6629 flag meaning when present ~
6630 f use "(3 of 5)" instead of "(file 3 of 5)"
6631 i use "[noeol]" instead of "[Incomplete last line]"
6632 l use "999L, 888C" instead of "999 lines, 888 characters"
6633 m use "[+]" instead of "[Modified]"
6634 n use "[New]" instead of "[New File]"
6635 r use "[RO]" instead of "[readonly]"
6636 w use "[w]" instead of "written" for file write message
6637 and "[a]" instead of "appended" for ':w >> file' command
6638 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6639 "[unix format]" and "[mac]" instead of "[mac format]".
6640 a all of the above abbreviations
6641
6642 o overwrite message for writing a file with subsequent message
6643 for reading a file (useful for ":wn" or when 'autowrite' on)
6644 O message for reading a file overwrites any previous message.
6645 Also for quickfix message (e.g., ":cn").
6646 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006647 hit TOP, continuing at BOTTOM" messages; when using the search
6648 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 t truncate file message at the start if it is too long to fit
6650 on the command-line, "<" will appear in the left most column.
6651 Ignored in Ex mode.
6652 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006653 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 Ignored in Ex mode.
6655 W don't give "written" or "[w]" when writing a file
6656 A don't give the "ATTENTION" message when an existing swap file
6657 is found.
6658 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006659 c don't give |ins-completion-menu| messages. For example,
6660 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6661 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006662 q use "recording" instead of "recording @a"
6663 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006664 was used for the command; note that this also affects messages
6665 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006666 S do not show search count message when searching, e.g.
6667 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668
6669 This gives you the opportunity to avoid that a change between buffers
6670 requires you to hit <Enter>, but still gives as useful a message as
6671 possible for the space available. To get the whole message that you
6672 would have got with 'shm' empty, use ":file!"
6673 Useful values:
6674 shm= No abbreviation of message.
6675 shm=a Abbreviation, but no loss of information.
6676 shm=at Abbreviation, and truncate message when necessary.
6677
6678 NOTE: This option is set to the Vi default value when 'compatible' is
6679 set and to the Vim default value when 'compatible' is reset.
6680
6681 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6682'shortname' 'sn' boolean (default off)
6683 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 Filenames are assumed to be 8 characters plus one extension of 3
6685 characters. Multiple dots in file names are not allowed. When this
6686 option is on, dots in file names are replaced with underscores when
6687 adding an extension (".~" or ".swp"). This option is not available
6688 for MS-DOS, because then it would always be on. This option is useful
6689 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6690 or crossdos. When running the Win32 GUI version under Win32s, this
6691 option is always on by default.
6692
6693 *'showbreak'* *'sbr'* *E595*
6694'showbreak' 'sbr' string (default "")
6695 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006696 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006697 feature}
6698 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006699 values are "> " or "+++ ": >
6700 :set showbreak=>\
6701< Note the backslash to escape the trailing space. It's easier like
6702 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006703 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006704< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 comma (in a future version the comma might be used to separate the
6706 part that is shown at the end and at the start of a line).
6707 The characters are highlighted according to the '@' flag in
6708 'highlight'.
6709 Note that tabs after the showbreak will be displayed differently.
6710 If you want the 'showbreak' to appear in between line numbers, add the
6711 "n" flag to 'cpoptions'.
6712
6713 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006714'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6715 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 {not available when compiled without the
6718 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006719 Show (partial) command in the last line of the screen. Set this
6720 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721 In Visual mode the size of the selected area is shown:
6722 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006723 If the number of bytes is different it is also displayed: "2-6"
6724 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006725 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006726 - When selecting a block, the size in screen characters:
6727 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 NOTE: This option is set to the Vi default value when 'compatible' is
6729 set and to the Vim default value when 'compatible' is reset.
6730
6731 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6732'showfulltag' 'sft' boolean (default off)
6733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 When completing a word in insert mode (see |ins-completion|) from the
6735 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006736 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006737 matched a C function, you can see a template for what arguments are
6738 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006739 Note that this doesn't work well together with having "longest" in
6740 'completeopt', because the completion from the search pattern may not
6741 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742
6743 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6744'showmatch' 'sm' boolean (default off)
6745 global
6746 When a bracket is inserted, briefly jump to the matching one. The
6747 jump is only done if the match can be seen on the screen. The time to
6748 show the match can be set with 'matchtime'.
6749 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006750 seen or not).
6751 This option is reset when 'paste' is set and restored when 'paste' is
6752 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 When the 'm' flag is not included in 'cpoptions', typing a character
6754 will immediately move the cursor back to where it belongs.
6755 See the "sm" field in 'guicursor' for setting the cursor shape and
6756 blinking when showing the match.
6757 The 'matchpairs' option can be used to specify the characters to show
6758 matches for. 'rightleft' and 'revins' are used to look for opposite
6759 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006760 Also see the matchparen plugin for highlighting the match when moving
6761 around |pi_paren.txt|.
6762 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763
6764 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6765'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6766 global
6767 If in Insert, Replace or Visual mode put a message on the last line.
6768 Use the 'M' flag in 'highlight' to set the type of highlighting for
6769 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006770 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771 doesn't mean XIM is really active, especially when 'imactivatekey' is
6772 not set.
6773 NOTE: This option is set to the Vi default value when 'compatible' is
6774 set and to the Vim default value when 'compatible' is reset.
6775
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006776 *'showtabline'* *'stal'*
6777'showtabline' 'stal' number (default 1)
6778 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006779 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006780 feature}
6781 The value of this option specifies when the line with tab page labels
6782 will be displayed:
6783 0: never
6784 1: only if there are at least two tab pages
6785 2: always
6786 This is both for the GUI and non-GUI implementation of the tab pages
6787 line.
6788 See |tab-page| for more information about tab pages.
6789
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790 *'sidescroll'* *'ss'*
6791'sidescroll' 'ss' number (default 0)
6792 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793 The minimal number of columns to scroll horizontally. Used only when
6794 the 'wrap' option is off and the cursor is moved off of the screen.
6795 When it is zero the cursor will be put in the middle of the screen.
6796 When using a slow terminal set it to a large number or 0. When using
6797 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6798 commands.
6799
6800 *'sidescrolloff'* *'siso'*
6801'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006802 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006804 right of the cursor if 'nowrap' is set. Setting this option to a
6805 value greater than 0 while having |'sidescroll'| also at a non-zero
6806 value makes some context visible in the line you are scrolling in
6807 horizontally (except at beginning of the line). Setting this option
6808 to a large value (like 999) has the effect of keeping the cursor
6809 horizontally centered in the window, as long as one does not come too
6810 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006811 After using the local value, go back the global value with one of
6812 these two: >
6813 setlocal sidescrolloff<
6814 setlocal sidescrolloff=-1
6815< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816
6817 Example: Try this together with 'sidescroll' and 'listchars' as
6818 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006819 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820
6821 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6822 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006823<
6824 *'signcolumn'* *'scl'*
6825'signcolumn' 'scl' string (default "auto")
6826 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006827 {not available when compiled without the |+signs|
6828 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006829 Whether or not to draw the signcolumn. Valid values are:
6830 "auto" only when there is a sign to display
6831 "no" never
6832 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006833 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006834 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835
6836
6837 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6838'smartcase' 'scs' boolean (default off)
6839 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 Override the 'ignorecase' option if the search pattern contains upper
6841 case characters. Only used when the search pattern is typed and
6842 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006843 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6845 recalling the search pattern from history and hitting <Enter>.
6846 NOTE: This option is reset when 'compatible' is set.
6847
6848 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6849'smartindent' 'si' boolean (default off)
6850 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 {not available when compiled without the
6852 |+smartindent| feature}
6853 Do smart autoindenting when starting a new line. Works for C-like
6854 programs, but can also be used for other languages. 'cindent' does
6855 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006856 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006857 setting 'si' has no effect. 'indentexpr' is a more advanced
6858 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 Normally 'autoindent' should also be on when using 'smartindent'.
6860 An indent is automatically inserted:
6861 - After a line ending in '{'.
6862 - After a line starting with a keyword from 'cinwords'.
6863 - Before a line starting with '}' (only with the "O" command).
6864 When typing '}' as the first character in a new line, that line is
6865 given the same indent as the matching '{'.
6866 When typing '#' as the first character in a new line, the indent for
6867 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006868 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6870 When using the ">>" command, lines starting with '#' are not shifted
6871 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006872 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006873 This option is reset when 'paste' is set and restored when 'paste' is
6874 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875
6876 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6877'smarttab' 'sta' boolean (default off)
6878 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006880 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6881 <BS> will delete a 'shiftwidth' worth of space at the start of the
6882 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006883 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006884 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6885 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006886 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006888 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006889 This option is reset when 'paste' is set and restored when 'paste' is
6890 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 NOTE: This option is reset when 'compatible' is set.
6892
6893 *'softtabstop'* *'sts'*
6894'softtabstop' 'sts' number (default 0)
6895 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896 Number of spaces that a <Tab> counts for while performing editing
6897 operations, like inserting a <Tab> or using <BS>. It "feels" like
6898 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6899 used. This is useful to keep the 'ts' setting at its standard value
6900 of 8, while being able to edit like it is set to 'sts'. However,
6901 commands like "x" still work on the actual characters.
6902 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006903 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006904 'softtabstop' is set to 0 when the 'paste' option is set and restored
6905 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6907 spaces is minimized by using <Tab>s.
6908 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6909 set.
6910 NOTE: This option is set to 0 when 'compatible' is set.
6911
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006912 If Vim is compiled with the |+vartabs| feature then the value of
6913 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6914 anything other than an empty string.
6915
Bram Moolenaar217ad922005-03-20 22:37:15 +00006916 *'spell'* *'nospell'*
6917'spell' boolean (default off)
6918 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006919 {not available when compiled without the |+syntax|
6920 feature}
6921 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006922 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006923
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006924 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006925'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006926 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006927 {not available when compiled without the |+syntax|
6928 feature}
6929 Pattern to locate the end of a sentence. The following word will be
6930 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006931 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006932 When this check is not wanted make this option empty.
6933 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006934 Be careful with special characters, see |option-backslash| about
6935 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006936 To set this option automatically depending on the language, see
6937 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006938
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006939 *'spellfile'* *'spf'*
6940'spellfile' 'spf' string (default empty)
6941 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006942 {not available when compiled without the |+syntax|
6943 feature}
6944 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006945 commands. It must end in ".{encoding}.add". You need to include the
6946 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006947 *E765*
6948 It may also be a comma separated list of names. A count before the
6949 |zg| and |zw| commands can be used to access each. This allows using
6950 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006951 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006952 you: Using the first directory in 'runtimepath' that is writable. If
6953 there is no "spell" directory yet it will be created. For the file
6954 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006955 ignoring the region.
6956 The resulting ".spl" file will be used for spell checking, it does not
6957 have to appear in 'spelllang'.
6958 Normally one file is used for all regions, but you can add the region
6959 name if you want to. However, it will then only be used when
6960 'spellfile' is set to it, for entries in 'spelllang' only files
6961 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006962 This option cannot be set from a |modeline| or in the |sandbox|, for
6963 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006964
Bram Moolenaar217ad922005-03-20 22:37:15 +00006965 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006966'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006967 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00006968 {not available when compiled without the |+syntax|
6969 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006970 A comma separated list of word list names. When the 'spell' option is
6971 on spellchecking will be done for these languages. Example: >
6972 set spelllang=en_us,nl,medical
6973< This means US English, Dutch and medical words are recognized. Words
6974 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02006975 The word list name must consist of alphanumeric characters, a dash or
6976 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00006977 recommended to separate the two letter language name from a
6978 specification. Thus "en-rare" is used for rare English words.
6979 A region name must come last and have the form "_xx", where "xx" is
6980 the two-letter, lower case region name. You can use more than one
6981 region by listing them: "en_us,en_ca" supports both US and Canadian
6982 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01006983 Britain. (Note: currently en_au and en_nz dictionaries are older than
6984 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006985 If the name "cjk" is included East Asian characters are excluded from
6986 spell checking. This is useful when editing text that also has Asian
6987 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006988 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006989 As a special case the name of a .spl file can be given as-is. The
6990 first "_xx" in the name is removed and used as the region name
6991 (_xx is an underscore, two letters and followed by a non-letter).
6992 This is mainly for testing purposes. You must make sure the correct
6993 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006994 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006995 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6996 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006997 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006998
Bram Moolenaar98692072006-02-04 00:57:42 +00006999 If the |spellfile.vim| plugin is active and you use a language name
7000 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7001 will ask you if you want to download the file.
7002
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007003 After this option has been set successfully, Vim will source the files
7004 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007005 up to the first character that is not an ASCII letter or number and
7006 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007007
7008
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007009 *'spellsuggest'* *'sps'*
7010'spellsuggest' 'sps' string (default "best")
7011 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007012 {not available when compiled without the |+syntax|
7013 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007014 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007015 the |spellsuggest()| function. This is a comma-separated list of
7016 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007017
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007018 best Internal method that works best for English. Finds
7019 changes like "fast" and uses a bit of sound-a-like
7020 scoring to improve the ordering.
7021
7022 double Internal method that uses two methods and mixes the
7023 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007024 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007025 word. That only works when the language specifies
7026 sound folding. Can be slow and doesn't always give
7027 better results.
7028
7029 fast Internal method that only checks for simple changes:
7030 character inserts/deletes/swaps. Works well for
7031 simple typing mistakes.
7032
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007033 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007034 Not used for |spellsuggest()|. The number of
7035 suggestions is never more than the value of 'lines'
7036 minus two.
7037
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007038 file:{filename} Read file {filename}, which must have two columns,
7039 separated by a slash. The first column contains the
7040 bad word, the second column the suggested good word.
7041 Example:
7042 theribal/terrible ~
7043 Use this for common mistakes that do not appear at the
7044 top of the suggestion list with the internal methods.
7045 Lines without a slash are ignored, use this for
7046 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007047 The word in the second column must be correct,
7048 otherwise it will not be used. Add the word to an
7049 ".add" file if it is currently flagged as a spelling
7050 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007051 The file is used for all languages.
7052
7053 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7054 trouble with spaces. |v:val| holds the badly spelled
7055 word. The expression must evaluate to a List of
7056 Lists, each with a suggestion and a score.
7057 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007058 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007059 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007060 internal methods use. A lower score is better.
7061 This may invoke |spellsuggest()| if you temporarily
7062 set 'spellsuggest' to exclude the "expr:" part.
7063 Errors are silently ignored, unless you set the
7064 'verbose' option to a non-zero value.
7065
7066 Only one of "best", "double" or "fast" may be used. The others may
7067 appear several times in any order. Example: >
7068 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7069<
7070 This option cannot be set from a |modeline| or in the |sandbox|, for
7071 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007072
7073
Bram Moolenaar071d4272004-06-13 20:20:40 +00007074 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7075'splitbelow' 'sb' boolean (default off)
7076 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007077 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 feature}
7079 When on, splitting a window will put the new window below the current
7080 one. |:split|
7081
7082 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7083'splitright' 'spr' boolean (default off)
7084 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007085 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007086 feature}
7087 When on, splitting a window will put the new window right of the
7088 current one. |:vsplit|
7089
7090 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7091'startofline' 'sol' boolean (default on)
7092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007094 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007095 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007096 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097 with a linewise operator, with "%" with a count and to buffer changing
7098 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7099 only has a line number, e.g., ":25" or ":+".
7100 In case of buffer changing commands the cursor is placed at the column
7101 where it was the last time the buffer was edited.
7102 NOTE: This option is set when 'compatible' is set.
7103
Bram Moolenaar00654022011-02-25 14:42:19 +01007104 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007106 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 {not available when compiled without the |+statusline|
7108 feature}
7109 When nonempty, this option determines the content of the status line.
7110 Also see |status-line|.
7111
7112 The option consists of printf style '%' items interspersed with
7113 normal text. Each status line item is of the form:
7114 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007115 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007116 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117
Bram Moolenaar238a5642006-02-21 22:12:05 +00007118 When the option starts with "%!" then it is used as an expression,
7119 evaluated and the result is used as the option value. Example: >
7120 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007121< The *g:statusline_winid* variable will be set to the |window-ID| of the
7122 window that the status line belongs to.
7123 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007124 Note that the "%!" expression is evaluated in the context of the
7125 current window and buffer, while %{} items are evaluated in the
7126 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007127
7128 When there is error while evaluating the option then it will be made
7129 empty to avoid further errors. Otherwise screen updating would loop.
7130
Bram Moolenaar071d4272004-06-13 20:20:40 +00007131 Note that the only effect of 'ruler' when this option is set (and
7132 'laststatus' is 2) is controlling the output of |CTRL-G|.
7133
7134 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007135 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007136 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007137 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 minwid Minimum width of the item, padding as set by '-' & '0'.
7139 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007140 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 on the left for text items. Numeric items will be
7142 shifted down to maxwid-2 digits followed by '>'number
7143 where number is the amount of missing digits, much like
7144 an exponential notation.
7145 item A one letter code as described below.
7146
7147 Following is a description of the possible statusline items. The
7148 second character in "item" is the type:
7149 N for number
7150 S for string
7151 F for flags as described below
7152 - not applicable
7153
7154 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007155 f S Path to the file in the buffer, as typed or relative to current
7156 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 F S Full path to the file in the buffer.
7158 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007159 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007161 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007163 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007165 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007167 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007169 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007170 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7171 being used: "<keymap>"
7172 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007173 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174 B N As above, in hexadecimal.
7175 o N Byte number in file of byte under cursor, first byte is 1.
7176 Mnemonic: Offset from start of file (with one added)
7177 {not available when compiled without |+byte_offset| feature}
7178 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007179 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 l N Line number.
7181 L N Number of lines in buffer.
7182 c N Column number.
7183 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007184 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 p N Percentage through file in lines as in |CTRL-G|.
7186 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007187 percentage described for 'ruler'. Always 3 in length, unless
7188 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007189 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007191 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007192 Note that there is no '%' before the closing '}'. The
7193 expression cannot contain a '}' character, call a function to
7194 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007195 ( - Start of item group. Can be used for setting the width and
7196 alignment of a section. Must be followed by %) somewhere.
7197 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007198 T N For 'tabline': start of tab page N label. Use %T after the last
7199 label. This information is used for mouse clicks.
7200 X N For 'tabline': start of close tab N label. Use %X after the
7201 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7202 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 < - Where to truncate line if too long. Default is at the start.
7204 No width fields allowed.
7205 = - Separation point between left and right aligned items.
7206 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007207 # - Set highlight group. The name must follow and then a # again.
7208 Thus use %#HLname# for highlight group HLname. The same
7209 highlighting is used, also for the statusline of non-current
7210 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007212 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007213 The difference between User{N} and StatusLine will be applied
7214 to StatusLineNC for the statusline of non-current windows.
7215 The number N must be between 1 and 9. See |hl-User1..9|
7216
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007217 When displaying a flag, Vim removes the leading comma, if any, when
7218 that flag comes right after plaintext. This will make a nice display
7219 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220
Bram Moolenaar582fd852005-03-28 20:58:01 +00007221 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 not set) and a minwid is not set for the group, the whole group will
7223 become empty. This will make a group like the following disappear
7224 completely from the statusline when none of the flags are set. >
7225 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007226< Beware that an expression is evaluated each and every time the status
7227 line is displayed.
7228 *g:actual_curbuf* *g:actual_curwin*
7229 The current buffer and current window will be set temporarily to that
7230 of the window (and buffer) whose statusline is currently being drawn.
7231 The expression will evaluate in this context. The variable
7232 "g:actual_curbuf" is set to the `bufnr()` number of the real current
7233 buffer and "g:actual_curwin" to the |window-ID| of the real current
7234 window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007235
Bram Moolenaar30b65812012-07-12 22:01:11 +02007236 The 'statusline' option will be evaluated in the |sandbox| if set from
7237 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007238 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007239
7240 It is not allowed to change text or jump to another window while
7241 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242
7243 If the statusline is not updated when you want it (e.g., after setting
7244 a variable that's used in an expression), you can force an update by
7245 setting an option without changing its value. Example: >
7246 :let &ro = &ro
7247
7248< A result of all digits is regarded a number for display purposes.
7249 Otherwise the result is taken as flag text and applied to the rules
7250 described above.
7251
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007252 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007254 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255
7256 Examples:
7257 Emulate standard status line with 'ruler' set >
7258 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7259< Similar, but add ASCII value of char under the cursor (like "ga") >
7260 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7261< Display byte count and byte value, modified flag in red. >
7262 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7263 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7264< Display a ,GZ flag if a compressed file is loaded >
7265 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7266< In the |:autocmd|'s: >
7267 :let b:gzflag = 1
7268< And: >
7269 :unlet b:gzflag
7270< And define this function: >
7271 :function VarExists(var, val)
7272 : if exists(a:var) | return a:val | else | return '' | endif
7273 :endfunction
7274<
7275 *'suffixes'* *'su'*
7276'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7277 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 Files with these suffixes get a lower priority when multiple files
7279 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007280 suffixes. Spaces after the comma are ignored. A dot is also seen as
7281 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282 separator, precede it with a backslash (see |option-backslash| about
7283 including spaces and backslashes).
7284 See 'wildignore' for completely ignoring files.
7285 The use of |:set+=| and |:set-=| is preferred when adding or removing
7286 suffixes from the list. This avoids problems when a future version
7287 uses another default.
7288
7289 *'suffixesadd'* *'sua'*
7290'suffixesadd' 'sua' string (default "")
7291 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 {not available when compiled without the
7293 |+file_in_path| feature}
7294 Comma separated list of suffixes, which are used when searching for a
7295 file for the "gf", "[I", etc. commands. Example: >
7296 :set suffixesadd=.java
7297<
7298 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7299'swapfile' 'swf' boolean (default on)
7300 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007301 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007302 swapfile is not wanted for a specific buffer. For example, with
7303 confidential information that even root must not be able to access.
7304 Careful: All text will be in memory:
7305 - Don't use this for big files.
7306 - Recovery will be impossible!
7307 A swapfile will only be present when |'updatecount'| is non-zero and
7308 'swapfile' is set.
7309 When 'swapfile' is reset, the swap file for the current buffer is
7310 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7311 non-zero, a swap file is immediately created.
7312 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007313 If you want to open a new buffer without creating a swap file for it,
7314 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007315 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316
7317 This option is used together with 'bufhidden' and 'buftype' to
7318 specify special kinds of buffers. See |special-buffers|.
7319
7320 *'swapsync'* *'sws'*
7321'swapsync' 'sws' string (default "fsync")
7322 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007323 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007324 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007325 When this option is empty parts of the swap file may be in memory and
7326 not written to disk. When the system crashes you may lose more work.
7327 On Unix the system does a sync now and then without Vim asking for it,
7328 so the disadvantage of setting this option off is small. On some
7329 systems the swap file will not be written at all. For a unix system
7330 setting it to "sync" will use the sync() call instead of the default
7331 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007332 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007333
7334 *'switchbuf'* *'swb'*
7335'switchbuf' 'swb' string (default "")
7336 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007337 This option controls the behavior when switching between buffers.
7338 Possible values (comma separated list):
7339 useopen If included, jump to the first open window that
7340 contains the specified buffer (if there is one).
7341 Otherwise: Do not examine other windows.
7342 This setting is checked with |quickfix| commands, when
7343 jumping to errors (":cc", ":cn", "cp", etc.). It is
7344 also used in all buffer related split commands, for
7345 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007346 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007347 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007348 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007349 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007350 Otherwise: do not split, use current window (when used
7351 in the quickfix window: the previously used window or
7352 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007353 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007354 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007355 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007357 *'synmaxcol'* *'smc'*
7358'synmaxcol' 'smc' number (default 3000)
7359 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007360 {not available when compiled without the |+syntax|
7361 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007362 Maximum column in which to search for syntax items. In long lines the
7363 text after this column is not highlighted and following lines may not
7364 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007365 This helps to avoid very slow redrawing for an XML file that is one
7366 long line.
7367 Set to zero to remove the limit.
7368
Bram Moolenaar071d4272004-06-13 20:20:40 +00007369 *'syntax'* *'syn'*
7370'syntax' 'syn' string (default empty)
7371 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372 {not available when compiled without the |+syntax|
7373 feature}
7374 When this option is set, the syntax with this name is loaded, unless
7375 syntax highlighting has been switched off with ":syntax off".
7376 Otherwise this option does not always reflect the current syntax (the
7377 b:current_syntax variable does).
7378 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007379 not automatically recognized. Example, in an IDL file:
7380 /* vim: set syntax=idl : */ ~
7381 When a dot appears in the value then this separates two filetype
7382 names. Example:
7383 /* vim: set syntax=c.doxygen : */ ~
7384 This will use the "c" syntax first, then the "doxygen" syntax.
7385 Note that the second one must be prepared to be loaded as an addition,
7386 otherwise it will be skipped. More than one dot may appear.
7387 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388 :set syntax=OFF
7389< To switch syntax highlighting on according to the current value of the
7390 'filetype' option: >
7391 :set syntax=ON
7392< What actually happens when setting the 'syntax' option is that the
7393 Syntax autocommand event is triggered with the value as argument.
7394 This option is not copied to another buffer, independent of the 's' or
7395 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007396 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007398 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007399'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007400 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007401 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007402 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007403 When nonempty, this option determines the content of the tab pages
7404 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007405 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007406
7407 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007408 option and only when there is no GUI tab line. When 'e' is in
7409 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007410 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007411
7412 The value is evaluated like with 'statusline'. You can use
7413 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007414 the text to be displayed. Use "%1T" for the first label, "%2T" for
7415 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007416
Bram Moolenaare12bab32019-01-08 22:02:56 +01007417 When changing something that is used in 'tabline' that does not
7418 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007419 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007420
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007421 Keep in mind that only one of the tab pages is the current one, others
7422 are invisible and you can't jump to their windows.
7423
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007424
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007425 *'tabpagemax'* *'tpm'*
7426'tabpagemax' 'tpm' number (default 10)
7427 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007428 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007429 feature}
7430 Maximum number of tab pages to be opened by the |-p| command line
7431 argument or the ":tab all" command. |tabpage|
7432
7433
7434 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435'tabstop' 'ts' number (default 8)
7436 local to buffer
7437 Number of spaces that a <Tab> in the file counts for. Also see
7438 |:retab| command, and 'softtabstop' option.
7439
7440 Note: Setting 'tabstop' to any other value than 8 can make your file
7441 appear wrong in many places (e.g., when printing it).
7442
7443 There are four main ways to use tabs in Vim:
7444 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7445 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007446 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447 behave like a tab appears every 4 (or 3) characters.
7448 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7449 'expandtab'. This way you will always insert spaces. The
7450 formatting will never be messed up when 'tabstop' is changed.
7451 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007452 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007453 works when using Vim to edit the file.
7454 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7455 'noexpandtab'. This should then work (for initial indents only)
7456 for any tabstop setting that people use. It might be nice to have
7457 tabs after the first non-blank inserted as spaces if you do this
7458 though. Otherwise aligned comments will be wrong when 'tabstop' is
7459 changed.
7460
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007461 If Vim is compiled with the |+vartabs| feature then the value of
7462 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7463 than an empty string.
7464
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7466'tagbsearch' 'tbs' boolean (default on)
7467 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007469 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007470 searching makes searching for a tag a LOT faster, but a linear search
7471 will find more tags if the tags file wasn't properly sorted.
7472 Vim normally assumes that your tags files are sorted, or indicate that
7473 they are not sorted. Only when this is not the case does the
7474 'tagbsearch' option need to be switched off.
7475
7476 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007477 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 certain files, or retry all files with a linear search. When
7479 'tagbsearch' is off, only a linear search is done.
7480
7481 Linear searching is done anyway, for one file, when Vim finds a line
7482 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007483 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484< [The whitespace before and after the '0' must be a single <Tab>]
7485
7486 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007487 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 instead of a normal tag name, a retry is done with a linear search.
7489 Tags in unsorted tags files, and matches with different case will only
7490 be found in the retry.
7491
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007492 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007493 linear search can be avoided when case is ignored. Use a value of '2'
7494 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7495 sorted with the -f switch to "sort" in most unices, as in the command:
7496 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7497 (at least 5.5) the --sort=foldcase switch can be used for this as
7498 well. Note that case must be folded to uppercase for this to work.
7499
7500 By default, tag searches are case-sensitive. Case is ignored when
7501 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7502 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007503 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7504 'tagcase' is "smart", and the pattern contains only lowercase
7505 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007506
7507 When 'tagbsearch' is off, tags searching is slower when a full match
7508 exists, but faster when no full match exists. Tags in unsorted tags
7509 files may only be found with 'tagbsearch' off.
7510 When the tags file is not sorted, or sorted in a wrong way (not on
7511 ASCII byte value), 'tagbsearch' should be off, or the line given above
7512 must be included in the tags file.
7513 This option doesn't affect commands that find all matching tags (e.g.,
7514 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007516 *'tagcase'* *'tc'*
7517'tagcase' 'tc' string (default "followic")
7518 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007519 This option specifies how case is handled when searching the tags
7520 file:
7521 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007522 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007523 ignore Ignore case
7524 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007525 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007526 NOTE: This option is set to the Vi default value when 'compatible' is
7527 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007528
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007529 *'tagfunc'* *'tfu'*
7530'tagfunc' 'tfu' string (default: empty)
7531 local to buffer
7532 {not available when compiled without the |+eval|
7533 feature}
7534 This option specifies a function to be used to perform tag searches.
7535 The function gets the tag pattern and should return a List of matching
7536 tags. See |tag-function| for an explanation of how to write the
7537 function and an example.
7538
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539 *'taglength'* *'tl'*
7540'taglength' 'tl' number (default 0)
7541 global
7542 If non-zero, tags are significant up to this number of characters.
7543
7544 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7545'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7546 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007547 If on and using a tags file in another directory, file names in that
7548 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007549 NOTE: This option is set to the Vi default value when 'compatible' is
7550 set and to the Vim default value when 'compatible' is reset.
7551
7552 *'tags'* *'tag'* *E433*
7553'tags' 'tag' string (default "./tags,tags", when compiled with
7554 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7555 global or local to buffer |global-local|
7556 Filenames for the tag command, separated by spaces or commas. To
7557 include a space or comma in a file name, precede it with a backslash
7558 (see |option-backslash| about including spaces and backslashes).
7559 When a file name starts with "./", the '.' is replaced with the path
7560 of the current file. But only when the 'd' flag is not included in
7561 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7562 |tags-option|.
7563 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007564 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7565 find all files named "tags" below "/lib". The filename itself cannot
7566 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7567 files called "tags?". {not available when compiled without the
7568 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007569 The |tagfiles()| function can be used to get a list of the file names
7570 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007571 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7572 files are also supported. They are automatically recognized. The
7573 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7574 differences are ignored (MS-Windows). |emacs-tags|
7575 The use of |:set+=| and |:set-=| is preferred when adding or removing
7576 file names from the list. This avoids problems when a future version
7577 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578
7579 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7580'tagstack' 'tgst' boolean (default on)
7581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 When on, the |tagstack| is used normally. When off, a ":tag" or
7583 ":tselect" command with an argument will not push the tag onto the
7584 tagstack. A following ":tag" without an argument, a ":pop" command or
7585 any other command that uses the tagstack will use the unmodified
7586 tagstack, but does change the pointer to the active entry.
7587 Resetting this option is useful when using a ":tag" command in a
7588 mapping which should not change the tagstack.
7589
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007590 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007591'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007592 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007593 {only available when compiled with the |+tcl/dyn|
7594 feature}
7595 Specifies the name of the Tcl shared library. The default is
7596 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007597 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007598 This option cannot be set from a |modeline| or in the |sandbox|, for
7599 security reasons.
7600
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601 *'term'* *E529* *E530* *E531*
7602'term' string (default is $TERM, if that fails:
7603 in the GUI: "builtin_gui"
7604 on Amiga: "amiga"
7605 on BeOS: "beos-ansi"
7606 on Mac: "mac-ansi"
7607 on MiNT: "vt52"
7608 on MS-DOS: "pcterm"
7609 on OS/2: "os2ansi"
7610 on Unix: "ansi"
7611 on VMS: "ansi"
7612 on Win 32: "win32")
7613 global
7614 Name of the terminal. Used for choosing the terminal control
7615 characters. Environment variables are expanded |:set_env|.
7616 For example: >
7617 :set term=$TERM
7618< See |termcap|.
7619
7620 *'termbidi'* *'tbidi'*
7621 *'notermbidi'* *'notbidi'*
7622'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7623 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007624 {only available when compiled with the |+arabic|
7625 feature}
7626 The terminal is in charge of Bi-directionality of text (as specified
7627 by Unicode). The terminal is also expected to do the required shaping
7628 that some languages (such as Arabic) require.
7629 Setting this option implies that 'rightleft' will not be set when
7630 'arabic' is set and the value of 'arabicshape' will be ignored.
7631 Note that setting 'termbidi' has the immediate effect that
7632 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7633 This option is reset when the GUI is started.
7634 For further details see |arabic.txt|.
7635
7636 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007637'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007638 Macintosh GUI: "macroman")
7639 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640 Encoding used for the terminal. This specifies what character
7641 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007642 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007643 display). Except for the Mac when 'macatsui' is off, then
7644 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007645 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007646 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7648 Any attempts to set a different value will be rejected, and an error
7649 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007650 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007651 because the Win32 system always passes Unicode characters.
7652 When empty, the same encoding is used as for the 'encoding' option.
7653 This is the normal value.
7654 Not all combinations for 'termencoding' and 'encoding' are valid. See
7655 |encoding-table|.
7656 The value for this option must be supported by internal conversions or
7657 iconv(). When this is not possible no conversion will be done and you
7658 will probably experience problems with non-ASCII characters.
7659 Example: You are working with the locale set to euc-jp (Japanese) and
7660 want to edit a UTF-8 file: >
7661 :let &termencoding = &encoding
7662 :set encoding=utf-8
7663< You need to do this when your system has no locale support for UTF-8.
7664
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007665 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007666'termguicolors' 'tgc' boolean (default off)
7667 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007668 {not available when compiled without the
7669 |+termguicolors| feature}
7670 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007671 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007672
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007673 Requires a ISO-8613-3 compatible terminal. If setting this option
7674 does not work (produces a colorless UI) reading |xterm-true-color|
7675 might help.
7676
7677 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7678 is required. Use this check to find out: >
7679 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007680< This requires Vim to be built with the |+vtp| feature.
7681
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007682 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007683 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007684
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007685 *'termwinkey'* *'twk'*
7686'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007687 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007688 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007689 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007690 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007691 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007692< The string must be one key stroke but can be multiple bytes.
7693 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007694 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007695 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007696
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007697 *'termwinscroll'* *'twsl'*
7698'termwinscroll' 'twsl' number (default 10000)
7699 local to buffer
7700 {not available when compiled without the
7701 |+terminal| feature}
7702 Number of scrollback lines to keep. When going over this limit the
7703 first 10% of the scrollback lines are deleted. This is just to reduce
7704 the memory usage. See |Terminal-Normal|.
7705
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007706 *'termwinsize'* *'tws'*
7707'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007708 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007709 Size of the |terminal| window. Format: {rows}x{columns} or
7710 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007711 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007712 - When set with a "x" (e.g., "24x80") the terminal size is not
7713 adjusted to the window size. If the window is smaller only the
7714 top-left part is displayed.
7715 - When set with a "*" (e.g., "10*50") the terminal size follows the
7716 window size, but will not be smaller than the specified rows and/or
7717 columns.
7718 - When rows is zero then use the height of the window.
7719 - When columns is zero then use the width of the window.
7720 - Using "0x0" or "0*0" is the same as empty.
7721
7722 Examples:
7723 "30x0" uses 30 rows and the current window width.
7724 "20*0" uses at least 20 rows and the current window width.
7725 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007726 Note that the command running in the terminal window may still change
7727 the size of the terminal. In that case the Vim window will be
7728 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007729
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007730 *'termwintype'* *'twt'*
7731'termwintype' 'twt' string (default "")
7732 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007733 {only available when compiled with the |terminal|
7734 feature on MS-Windows}
7735 Specify the virtual console (pty) used when opening the terminal
7736 window.
7737
7738 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007739 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007740 "winpty" use winpty, fail if not supported
7741 "conpty" use |ConPTY|, fail if not supported
7742
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007743 |ConPTY| support depends on the platform. Windows 10 October 2018
7744 Update is the first version that supports ConPTY, however it is still
7745 considered unstable. ConPTY might become stable in the next release
7746 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007747 supported then you cannot open a terminal window.
7748
Bram Moolenaar071d4272004-06-13 20:20:40 +00007749 *'terse'* *'noterse'*
7750'terse' boolean (default off)
7751 global
7752 When set: Add 's' flag to 'shortmess' option (this makes the message
7753 for a search that hits the start or end of the file not being
7754 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7755 shortens a lot of messages}
7756
7757 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7758'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7759 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760 This option is obsolete. Use 'fileformats'.
7761 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7762 set to the default value for the current system. When 'textauto' is
7763 reset, 'fileformats' is made empty.
7764 NOTE: This option is set to the Vi default value when 'compatible' is
7765 set and to the Vim default value when 'compatible' is reset.
7766
7767 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7768'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7769 others: default off)
7770 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007771 This option is obsolete. Use 'fileformat'.
7772 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7773 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7774 "unix".
7775
7776 *'textwidth'* *'tw'*
7777'textwidth' 'tw' number (default 0)
7778 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779 Maximum width of text that is being inserted. A longer line will be
7780 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007781 this.
7782 'textwidth' is set to 0 when the 'paste' option is set and restored
7783 when 'paste' is reset.
7784 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007785 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007786 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787 NOTE: This option is set to 0 when 'compatible' is set.
7788
7789 *'thesaurus'* *'tsr'*
7790'thesaurus' 'tsr' string (default "")
7791 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007792 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007793 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7794
7795 Each line in the file should contain words with similar meaning,
7796 separated by non-keyword characters (white space is preferred).
7797 Maximum line length is 510 bytes.
7798
Bram Moolenaard47d5222018-12-09 20:43:55 +01007799 An English word list was added to this github issue:
7800 https://github.com/vim/vim/issues/629#issuecomment-443293282
7801 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7802 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7803 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007804
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007805 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007806 after a comma are ignored, otherwise spaces are included in the file
7807 name. See |option-backslash| about using backslashes.
7808 The use of |:set+=| and |:set-=| is preferred when adding or removing
7809 directories from the list. This avoids problems when a future version
7810 uses another default.
7811 Backticks cannot be used in this option for security reasons.
7812
7813 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7814'tildeop' 'top' boolean (default off)
7815 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007816 When on: The tilde command "~" behaves like an operator.
7817 NOTE: This option is reset when 'compatible' is set.
7818
7819 *'timeout'* *'to'* *'notimeout'* *'noto'*
7820'timeout' 'to' boolean (default on)
7821 global
7822 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007823'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007824 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007825 These two options together determine the behavior when part of a
7826 mapped key sequence or keyboard code has been received:
7827
7828 'timeout' 'ttimeout' action ~
7829 off off do not time out
7830 on on or off time out on :mappings and key codes
7831 off on time out on key codes
7832
7833 If both options are off, Vim will wait until either the complete
7834 mapping or key sequence has been received, or it is clear that there
7835 is no mapping or key sequence for the received characters. For
7836 example: if you have mapped "vl" and Vim has received 'v', the next
7837 character is needed to see if the 'v' is followed by an 'l'.
7838 When one of the options is on, Vim will wait for about 1 second for
7839 the next character to arrive. After that the already received
7840 characters are interpreted as single characters. The waiting time can
7841 be changed with the 'timeoutlen' option.
7842 On slow terminals or very busy systems timing out may cause
7843 malfunctioning cursor keys. If both options are off, Vim waits
7844 forever after an entered <Esc> if there are key codes that start
7845 with <Esc>. You will have to type <Esc> twice. If you do not have
7846 problems with key codes, but would like to have :mapped key
7847 sequences not timing out in 1 second, set the 'ttimeout' option and
7848 reset the 'timeout' option.
7849
7850 NOTE: 'ttimeout' is reset when 'compatible' is set.
7851
7852 *'timeoutlen'* *'tm'*
7853'timeoutlen' 'tm' number (default 1000)
7854 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007855
Bram Moolenaar071d4272004-06-13 20:20:40 +00007856 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007857'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859 The time in milliseconds that is waited for a key code or mapped key
7860 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7861 when part of a command has been typed.
7862 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7863 different timeout value for key codes is desired set 'ttimeoutlen' to
7864 a non-negative number.
7865
7866 ttimeoutlen mapping delay key code delay ~
7867 < 0 'timeoutlen' 'timeoutlen'
7868 >= 0 'timeoutlen' 'ttimeoutlen'
7869
7870 The timeout only happens when the 'timeout' and 'ttimeout' options
7871 tell so. A useful setting would be >
7872 :set timeout timeoutlen=3000 ttimeoutlen=100
7873< (time out on mapping after three seconds, time out on key codes after
7874 a tenth of a second).
7875
7876 *'title'* *'notitle'*
7877'title' boolean (default off, on when title can be restored)
7878 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 {not available when compiled without the |+title|
7880 feature}
7881 When on, the title of the window will be set to the value of
7882 'titlestring' (if it is not empty), or to:
7883 filename [+=-] (path) - VIM
7884 Where:
7885 filename the name of the file being edited
7886 - indicates the file cannot be modified, 'ma' off
7887 + indicates the file was modified
7888 = indicates the file is read-only
7889 =+ indicates the file is read-only and modified
7890 (path) is the path of the file being edited
7891 - VIM the server name |v:servername| or "VIM"
7892 Only works if the terminal supports setting window titles
7893 (currently Amiga console, Win32 console, all GUI versions and
7894 terminals with a non- empty 't_ts' option - these are Unix xterm and
7895 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7896 *X11*
7897 When Vim was compiled with HAVE_X11 defined, the original title will
7898 be restored if possible. The output of ":version" will include "+X11"
7899 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7900 works for the icon name |'icon'|.
7901 But: When Vim was started with the |-X| argument, restoring the title
7902 will not work (except in the GUI).
7903 If the title cannot be restored, it is set to the value of 'titleold'.
7904 You might want to restore the title outside of Vim then.
7905 When using an xterm from a remote machine you can use this command:
7906 rsh machine_name xterm -display $DISPLAY &
7907 then the WINDOWID environment variable should be inherited and the
7908 title of the window should change back to what it should be after
7909 exiting Vim.
7910
7911 *'titlelen'*
7912'titlelen' number (default 85)
7913 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 {not available when compiled without the |+title|
7915 feature}
7916 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007917 title. When the title is longer, only the end of the path name is
7918 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007919 Using a percentage makes this adapt to the width of the window. But
7920 it won't work perfectly, because the actual number of characters
7921 available also depends on the font used and other things in the title
7922 bar. When 'titlelen' is zero the full path is used. Otherwise,
7923 values from 1 to 30000 percent can be used.
7924 'titlelen' is also used for the 'titlestring' option.
7925
7926 *'titleold'*
7927'titleold' string (default "Thanks for flying Vim")
7928 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929 {only available when compiled with the |+title|
7930 feature}
7931 This option will be used for the window title when exiting Vim if the
7932 original title cannot be restored. Only happens if 'title' is on or
7933 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007934 This option cannot be set from a |modeline| or in the |sandbox|, for
7935 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007936 *'titlestring'*
7937'titlestring' string (default "")
7938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939 {not available when compiled without the |+title|
7940 feature}
7941 When this option is not empty, it will be used for the title of the
7942 window. This happens only when the 'title' option is on.
7943 Only works if the terminal supports setting window titles (currently
7944 Amiga console, Win32 console, all GUI versions and terminals with a
7945 non-empty 't_ts' option).
7946 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007947 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007948
Bram Moolenaar071d4272004-06-13 20:20:40 +00007949 When this option contains printf-style '%' items, they will be
7950 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007951 This option cannot be set in a modeline when 'modelineexpr' is off.
7952
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953 Example: >
7954 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7955 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7956< The value of 'titlelen' is used to align items in the middle or right
7957 of the available space.
7958 Some people prefer to have the file name first: >
7959 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7960< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007961 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007962 separating space only when needed.
7963 NOTE: Use of special characters in 'titlestring' may cause the display
7964 to be garbled (e.g., when it contains a CR or NL character).
7965 {not available when compiled without the |+statusline| feature}
7966
7967 *'toolbar'* *'tb'*
7968'toolbar' 'tb' string (default "icons,tooltips")
7969 global
7970 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7971 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007972 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007973 possible values are:
7974 icons Toolbar buttons are shown with icons.
7975 text Toolbar buttons shown with text.
7976 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007977 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007978 tooltips Tooltips are active for toolbar buttons.
7979 Tooltips refer to the popup help text which appears after the mouse
7980 cursor is placed over a toolbar button for a brief moment.
7981
7982 If you want the toolbar to be shown with icons as well as text, do the
7983 following: >
7984 :set tb=icons,text
7985< Motif and Athena cannot display icons and text at the same time. They
7986 will show icons if both are requested.
7987
7988 If none of the strings specified in 'toolbar' are valid or if
7989 'toolbar' is empty, this option is ignored. If you want to disable
7990 the toolbar, you need to set the 'guioptions' option. For example: >
7991 :set guioptions-=T
7992< Also see |gui-toolbar|.
7993
7994 *'toolbariconsize'* *'tbis'*
7995'toolbariconsize' 'tbis' string (default "small")
7996 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01007997 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007998 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007999 tiny Use tiny icons.
8000 small Use small icons (default).
8001 medium Use medium-sized icons.
8002 large Use large icons.
8003 huge Use even larger icons.
8004 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008006 the current theme. Common dimensions are giant=48x48, huge=32x32,
8007 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008
8009 If 'toolbariconsize' is empty, the global default size as determined
8010 by user preferences or the current theme is used.
8011
8012 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8013'ttybuiltin' 'tbi' boolean (default on)
8014 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 When on, the builtin termcaps are searched before the external ones.
8016 When off the builtin termcaps are searched after the external ones.
8017 When this option is changed, you should set the 'term' option next for
8018 the change to take effect, for example: >
8019 :set notbi term=$TERM
8020< See also |termcap|.
8021 Rationale: The default for this option is "on", because the builtin
8022 termcap entries are generally better (many systems contain faulty
8023 xterm entries...).
8024
8025 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8026'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8027 sun-cmd, screen, rxvt, dtterm or
8028 iris-ansi; also on when running Vim in
8029 a DOS console)
8030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008031 Indicates a fast terminal connection. More characters will be sent to
8032 the screen for redrawing, instead of using insert/delete line
8033 commands. Improves smoothness of redrawing when there are multiple
8034 windows and the terminal does not support a scrolling region.
8035 Also enables the extra writing of characters at the end of each screen
8036 line for lines that wrap. This helps when using copy/paste with the
8037 mouse in an xterm and other terminals.
8038
8039 *'ttymouse'* *'ttym'*
8040'ttymouse' 'ttym' string (default depends on 'term')
8041 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008042 {only in Unix and VMS, doesn't work in the GUI; not
8043 available when compiled without |+mouse|}
8044 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008045 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008046 *xterm-mouse*
8047 xterm xterm-like mouse handling. The mouse generates
8048 "<Esc>[Mscr", where "scr" is three bytes:
8049 "s" = button state
8050 "c" = column plus 33
8051 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008052 This only works up to 223 columns! See "dec",
8053 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054 xterm2 Works like "xterm", but with the xterm reporting the
8055 mouse position while the mouse is dragged. This works
8056 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008057 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058 work. See below for how Vim detects this
8059 automatically.
8060 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008061 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008063 for the row and column. No other mouse events are
8064 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008065 *dec-mouse*
8066 dec DEC terminal mouse handling. The mouse generates a
8067 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008068 This is also available for an Xterm, if it was
8069 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008070 *jsbterm-mouse*
8071 jsbterm JSB term mouse handling.
8072 *pterm-mouse*
8073 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008074 *urxvt-mouse*
8075 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008076 The mouse works only if the terminal supports this
8077 encoding style, but it does not have 223 columns limit
8078 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008079 *sgr-mouse*
8080 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008081 mouse reporting. The mouse works even in columns
8082 beyond 223. This option is backward compatible with
8083 "xterm2" because it can also decode "xterm2" style
8084 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085
8086 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008087 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8088 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008089 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8090 recognized, if enabled at compile time. DEC terminal mouse codes
8091 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008092 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8093 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008094 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008095 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8096 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8097 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008098 Additionally, if vim is compiled with the |+termresponse| feature and
8099 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008100 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008101 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008102 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8103 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8104 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008105 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8106 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008107 :set t_RV=
8108<
8109 *'ttyscroll'* *'tsl'*
8110'ttyscroll' 'tsl' number (default 999)
8111 global
8112 Maximum number of lines to scroll the screen. If there are more lines
8113 to scroll the window is redrawn. For terminals where scrolling is
8114 very slow and redrawing is not slow this can be set to a small number,
8115 e.g., 3, to speed up displaying.
8116
8117 *'ttytype'* *'tty'*
8118'ttytype' 'tty' string (default from $TERM)
8119 global
8120 Alias for 'term', see above.
8121
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008122 *'undodir'* *'udir'*
8123'undodir' 'udir' string (default ".")
8124 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008125 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008126 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008127 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008128 "." means using the directory of the file. The undo file name for
8129 "file.txt" is ".file.txt.un~".
8130 For other directories the file name is the full path of the edited
8131 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008132 When writing: The first directory that exists is used. "." always
8133 works, no directories after "." will be used for writing.
8134 When reading all entries are tried to find an undo file. The first
8135 undo file that exists is used. When it cannot be read an error is
8136 given, no further entry is used.
8137 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008138 This option cannot be set from a |modeline| or in the |sandbox|, for
8139 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008140
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008141 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008142'undofile' 'udf' boolean (default off)
8143 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008144 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008145 When on, Vim automatically saves undo history to an undo file when
8146 writing a buffer to a file, and restores undo history from the same
8147 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008148 The directory where the undo file is stored is specified by 'undodir'.
8149 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008150 The undo file is not read when 'undoreload' causes the buffer from
8151 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008152 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008153 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008154
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 *'undolevels'* *'ul'*
8156'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8157 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008158 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008159 Maximum number of changes that can be undone. Since undo information
8160 is kept in memory, higher numbers will cause more memory to be used
8161 (nevertheless, a single change can use an unlimited amount of memory).
8162 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8163 itself: >
8164 set ul=0
8165< But you can also get Vi compatibility by including the 'u' flag in
8166 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008167 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008168 Set to -1 for no undo at all. You might want to do this only for the
8169 current buffer: >
8170 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008171< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008172
8173 The local value is set to -123456 when the global value is to be used.
8174
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008175 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008176
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008177 *'undoreload'* *'ur'*
8178'undoreload' 'ur' number (default 10000)
8179 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008180 Save the whole buffer for undo when reloading it. This applies to the
8181 ":e!" command and reloading for when the buffer changed outside of
8182 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008183 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008184 of lines is smaller than the value of this option.
8185 Set this option to zero to disable undo for a reload.
8186
8187 When saving undo for a reload, any undo file is not read.
8188
8189 Note that this causes the whole buffer to be stored in memory. Set
8190 this option to a lower value if you run out of memory.
8191
Bram Moolenaar071d4272004-06-13 20:20:40 +00008192 *'updatecount'* *'uc'*
8193'updatecount' 'uc' number (default: 200)
8194 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195 After typing this many characters the swap file will be written to
8196 disk. When zero, no swap file will be created at all (see chapter on
8197 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8198 Vim with the "-n" option, see |startup|. When editing in readonly
8199 mode this option will be initialized to 10000.
8200 The swapfile can be disabled per buffer with |'swapfile'|.
8201 When 'updatecount' is set from zero to non-zero, swap files are
8202 created for all buffers that have 'swapfile' set. When 'updatecount'
8203 is set to zero, existing swap files are not deleted.
8204 Also see |'swapsync'|.
8205 This option has no meaning in buffers where |'buftype'| is "nofile"
8206 or "nowrite".
8207
8208 *'updatetime'* *'ut'*
8209'updatetime' 'ut' number (default 4000)
8210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211 If this many milliseconds nothing is typed the swap file will be
8212 written to disk (see |crash-recovery|). Also used for the
8213 |CursorHold| autocommand event.
8214
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008215 *'varsofttabstop'* *'vsts'*
8216'varsofttabstop' 'vsts' string (default "")
8217 local to buffer
8218 {only available when compiled with the |+vartabs|
8219 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008220 A list of the number of spaces that a <Tab> counts for while editing,
8221 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8222 width <Tab>s are being inserted, while in fact a mixture of spaces
8223 and <Tab>s is used. Tab widths are separated with commas, with the
8224 final value applying to all subsequent tabs.
8225
8226 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008227 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008228 to use the following: >
8229 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008230< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8231 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008232
8233 Note that the value of |'softtabstop'| will be ignored while
8234 'varsofttabstop' is set.
8235
8236 *'vartabstop'* *'vts'*
8237'vartabstop' 'vts' string (default "")
8238 local to buffer
8239 {only available when compiled with the |+vartabs|
8240 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008241 A list of the number of spaces that a <Tab> in the file counts for,
8242 separated by commas. Each value corresponds to one tab, with the
8243 final value applying to all subsequent tabs. For example: >
8244 :set vartabstop=4,20,10,8
8245< This will make the first tab 4 spaces wide, the second 20 spaces,
8246 the third 10 spaces, and all following tabs 8 spaces.
8247
8248 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8249 is set.
8250
Bram Moolenaar071d4272004-06-13 20:20:40 +00008251 *'verbose'* *'vbs'*
8252'verbose' 'vbs' number (default 0)
8253 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008254 When bigger than zero, Vim will give messages about what it is doing.
8255 Currently, these messages are given:
8256 >= 1 When the viminfo file is read or written.
8257 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008258 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008259 >= 8 Files for which a group of autocommands is executed.
8260 >= 9 Every executed autocommand.
8261 >= 12 Every executed function.
8262 >= 13 When an exception is thrown, caught, finished, or discarded.
8263 >= 14 Anything pending in a ":finally" clause.
8264 >= 15 Every executed Ex command (truncated at 200 characters).
8265
8266 This option can also be set with the "-V" argument. See |-V|.
8267 This option is also set by the |:verbose| command.
8268
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008269 When the 'verbosefile' option is set then the verbose messages are not
8270 displayed.
8271
8272 *'verbosefile'* *'vfile'*
8273'verbosefile' 'vfile' string (default empty)
8274 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008275 When not empty all messages are written in a file with this name.
8276 When the file exists messages are appended.
8277 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008278 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008279 Setting 'verbosefile' to a new value is like making it empty first.
8280 The difference with |:redir| is that verbose messages are not
8281 displayed when 'verbosefile' is set.
8282
Bram Moolenaar071d4272004-06-13 20:20:40 +00008283 *'viewdir'* *'vdir'*
8284'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8285 "$VIM/vimfiles/view",
8286 for Unix: "~/.vim/view",
8287 for Macintosh: "$VIM:vimfiles:view"
8288 for VMS: "sys$login:vimfiles/view"
8289 for RiscOS: "Choices:vimfiles/view")
8290 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008291 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008292 feature}
8293 Name of the directory where to store files for |:mkview|.
8294 This option cannot be set from a |modeline| or in the |sandbox|, for
8295 security reasons.
8296
8297 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008298'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008299 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008300 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008301 feature}
8302 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008303 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008304 word save and restore ~
8305 cursor cursor position in file and in window
8306 folds manually created folds, opened/closed folds and local
8307 fold options
8308 options options and mappings local to a window or buffer (not
8309 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008310 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311 slash backslashes in file names replaced with forward
8312 slashes
8313 unix with Unix end-of-line format (single <NL>), even when
8314 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008315 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316
8317 "slash" and "unix" are useful on Windows when sharing view files
8318 with Unix. The Unix version of Vim cannot source dos format scripts,
8319 but the Windows version of Vim can source unix format scripts.
8320
8321 *'viminfo'* *'vi'* *E526* *E527* *E528*
8322'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008323 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8324 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8325 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008326 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008327 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008328 feature}
8329 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008330 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8331 "NONE".
8332 The string should be a comma separated list of parameters, each
8333 consisting of a single character identifying the particular parameter,
8334 followed by a number or string which specifies the value of that
8335 parameter. If a particular character is left out, then the default
8336 value is used for that parameter. The following is a list of the
8337 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008338 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008339 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008340 ! When included, save and restore global variables that start
8341 with an uppercase letter, and don't contain a lowercase
8342 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008343 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008344 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008345 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346 " Maximum number of lines saved for each register. Old name of
8347 the '<' item, with the disadvantage that you need to put a
8348 backslash before the ", otherwise it will be recognized as the
8349 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008350 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351 % When included, save and restore the buffer list. If Vim is
8352 started with a file name argument, the buffer list is not
8353 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008354 buffer list is restored from the viminfo file. Quickfix
8355 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8356 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008357 When followed by a number, the number specifies the maximum
8358 number of buffers that are stored. Without a number all
8359 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008360 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008361 ' Maximum number of previously edited files for which the marks
8362 are remembered. This parameter must always be included when
8363 'viminfo' is non-empty.
8364 Including this item also means that the |jumplist| and the
8365 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008366 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008367 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008368 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369 patterns are also saved. When not included, the value of
8370 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008371 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008373 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008374 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 < Maximum number of lines saved for each register. If zero then
8376 registers are not saved. When not included, all lines are
8377 saved. '"' is the old name for this item.
8378 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008379 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008381 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008382 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383 c When included, convert the text in the viminfo file from the
8384 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008385 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008386 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008387 f Whether file marks need to be stored. If zero, file marks ('0
8388 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008389 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008390 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008391 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008392 h Disable the effect of 'hlsearch' when loading the viminfo
8393 file. When not included, it depends on whether ":nohlsearch"
8394 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008395 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008397 the 'n'. Must be at the end of the option! If the
8398 'viminfofile' option is set, that file name overrides the one
8399 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008400 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008401 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008402 r Removable media. The argument is a string (up to the next
8403 ','). This parameter can be given several times. Each
8404 specifies the start of a path for which no marks will be
8405 stored. This is to avoid removable media. For MS-DOS you
8406 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8407 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8408 ignored. Maximum length of each 'r' argument is 50
8409 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008410 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 s Maximum size of an item in Kbyte. If zero then registers are
8412 not saved. Currently only applies to registers. The default
8413 "s10" will exclude registers with more than 10 Kbyte of text.
8414 Also see the '<' item above: line count limit.
8415
8416 Example: >
8417 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8418<
8419 '50 Marks will be remembered for the last 50 files you
8420 edited.
8421 <1000 Contents of registers (up to 1000 lines each) will be
8422 remembered.
8423 s100 Registers with more than 100 Kbyte text are skipped.
8424 :0 Command-line history will not be saved.
8425 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8426 no / Since '/' is not specified, the default will be used,
8427 that is, save all of the search history, and also the
8428 previous search and substitute patterns.
8429 no % The buffer list will not be saved nor read back.
8430 no h 'hlsearch' highlighting will be restored.
8431
8432 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8433 load the contents of the file, this is not done automatically.
8434
8435 This option cannot be set from a |modeline| or in the |sandbox|, for
8436 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008437 NOTE: This option is set to the Vim default value when 'compatible'
8438 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008439
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008440 *'viminfofile'* *'vif'*
8441'viminfofile' 'vif' string (default: "")
8442 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008443 {not available when compiled without the |+viminfo|
8444 feature}
8445 When non-empty, overrides the file name used for viminfo.
8446 When equal to "NONE" no viminfo file will be read or written.
8447 This option can be set with the |-i| command line flag. The |--clean|
8448 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008449 This option cannot be set from a |modeline| or in the |sandbox|, for
8450 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008451
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452 *'virtualedit'* *'ve'*
8453'virtualedit' 've' string (default "")
8454 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008455 {not available when compiled without the
8456 |+virtualedit| feature}
8457 A comma separated list of these words:
8458 block Allow virtual editing in Visual block mode.
8459 insert Allow virtual editing in Insert mode.
8460 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008461 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008462
Bram Moolenaar071d4272004-06-13 20:20:40 +00008463 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008464 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008465 of the line. Useful for selecting a rectangle in Visual mode and
8466 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008467 "onemore" is not the same, it will only allow moving the cursor just
8468 after the last character of the line. This makes some commands more
8469 consistent. Previously the cursor was always past the end of the line
8470 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008471 break some plugins or Vim scripts. For example because |l| can move
8472 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008473 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008474 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008475 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008476 It doesn't make sense to combine "all" with "onemore", but you will
8477 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008478 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008479
8480 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8481'visualbell' 'vb' boolean (default off)
8482 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008483 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008484 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008485 use: >
8486 :set vb t_vb=
8487< If you want a short flash, you can use this on many terminals: >
8488 :set vb t_vb=[?5h$<100>[?5l
8489< Here $<100> specifies the time, you can use a smaller or bigger value
8490 to get a shorter or longer flash.
8491
8492 Note: Vim will limit the bell to once per half a second. This avoids
8493 having to wait for the flashing to finish when there are lots of
8494 bells, e.g. on key repeat. This also happens without 'visualbell'
8495 set.
8496
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8498 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8499 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008500
8501 Note: When the GUI starts, 't_vb' is reset to its default value. You
8502 might want to set it again in your |gvimrc|.
8503
Bram Moolenaar071d4272004-06-13 20:20:40 +00008504 Does not work on the Amiga, you always get a screen flash.
8505 Also see 'errorbells'.
8506
8507 *'warn'* *'nowarn'*
8508'warn' boolean (default on)
8509 global
8510 Give a warning message when a shell command is used while the buffer
8511 has been changed.
8512
8513 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8514'weirdinvert' 'wiv' boolean (default off)
8515 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008516 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008517 It is provided for backwards compatibility with version 4.x.
8518 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8519 vice versa. Has no effect when the GUI is running.
8520
8521 *'whichwrap'* *'ww'*
8522'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8523 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008524 Allow specified keys that move the cursor left/right to move to the
8525 previous/next line when the cursor is on the first/last character in
8526 the line. Concatenate characters to allow this for these keys:
8527 char key mode ~
8528 b <BS> Normal and Visual
8529 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008530 h "h" Normal and Visual (not recommended)
8531 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008532 < <Left> Normal and Visual
8533 > <Right> Normal and Visual
8534 ~ "~" Normal
8535 [ <Left> Insert and Replace
8536 ] <Right> Insert and Replace
8537 For example: >
8538 :set ww=<,>,[,]
8539< allows wrap only when cursor keys are used.
8540 When the movement keys are used in combination with a delete or change
8541 operator, the <EOL> also counts for a character. This makes "3h"
8542 different from "3dh" when the cursor crosses the end of a line. This
8543 is also true for "x" and "X", because they do the same as "dl" and
8544 "dh". If you use this, you may also want to use the mapping
8545 ":map <BS> X" to make backspace delete the character in front of the
8546 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008547 When 'l' is included and it is used after an operator at the end of a
8548 line then it will not move to the next line. This makes "dl", "cl",
8549 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008550 NOTE: This option is set to the Vi default value when 'compatible' is
8551 set and to the Vim default value when 'compatible' is reset.
8552
8553 *'wildchar'* *'wc'*
8554'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8555 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008556 Character you have to type to start wildcard expansion in the
8557 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008558 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559 The character is not recognized when used inside a macro. See
8560 'wildcharm' for that.
8561 Although 'wc' is a number option, you can set it to a special key: >
8562 :set wc=<Esc>
8563< NOTE: This option is set to the Vi default value when 'compatible' is
8564 set and to the Vim default value when 'compatible' is reset.
8565
8566 *'wildcharm'* *'wcm'*
8567'wildcharm' 'wcm' number (default: none (0))
8568 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008569 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008570 recognized when used inside a macro. You can find "spare" command-line
8571 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008572 you'll never actually type 'wildcharm', just use it in mappings that
8573 automatically invoke completion mode, e.g.: >
8574 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008575 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008576< Then after typing :ss you can use CTRL-P & CTRL-N.
8577
8578 *'wildignore'* *'wig'*
8579'wildignore' 'wig' string (default "")
8580 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581 {not available when compiled without the |+wildignore|
8582 feature}
8583 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008584 patterns is ignored when expanding |wildcards|, completing file or
8585 directory names, and influences the result of |expand()|, |glob()| and
8586 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008587 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8588 Also see 'suffixes'.
8589 Example: >
8590 :set wildignore=*.o,*.obj
8591< The use of |:set+=| and |:set-=| is preferred when adding or removing
8592 a pattern from the list. This avoids problems when a future version
8593 uses another default.
8594
Bram Moolenaar94950a92010-12-02 16:01:29 +01008595
Bram Moolenaar81af9252010-12-10 20:35:50 +01008596 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008597'wildignorecase' 'wic' boolean (default off)
8598 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008599 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008600 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008601 Does not apply when the shell is used to expand wildcards, which
8602 happens when there are special characters.
8603
8604
Bram Moolenaar071d4272004-06-13 20:20:40 +00008605 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008606'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008607 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008608 {not available if compiled without the |+wildmenu|
8609 feature}
8610 When 'wildmenu' is on, command-line completion operates in an enhanced
8611 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8612 the possible matches are shown just above the command line, with the
8613 first match highlighted (overwriting the status line, if there is
8614 one). Keys that show the previous/next match, such as <Tab> or
8615 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8616 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8617 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008618 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 If there are more matches than can fit in the line, a ">" is shown on
8620 the right and/or a "<" is shown on the left. The status line scrolls
8621 as needed.
8622 The "wildmenu" mode is abandoned when a key is hit that is not used
8623 for selecting a completion.
8624 While the "wildmenu" is active the following keys have special
8625 meanings:
8626
8627 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8628 <Down> - in filename/menu name completion: move into a
8629 subdirectory or submenu.
8630 <CR> - in menu completion, when the cursor is just after a
8631 dot: move into a submenu.
8632 <Up> - in filename/menu name completion: move up into
8633 parent directory or parent menu.
8634
8635 This makes the menus accessible from the console |console-menus|.
8636
8637 If you prefer the <Left> and <Right> keys to move the cursor instead
8638 of selecting a different match, use this: >
8639 :cnoremap <Left> <Space><BS><Left>
8640 :cnoremap <Right> <Space><BS><Right>
8641<
8642 The "WildMenu" highlighting is used for displaying the current match
8643 |hl-WildMenu|.
8644
8645 *'wildmode'* *'wim'*
8646'wildmode' 'wim' string (Vim default: "full")
8647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008648 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008649 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008650 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008651 first part specifies the behavior for the first use of 'wildchar',
8652 The second part for the second use, etc.
8653 These are the possible values for each part:
8654 "" Complete only the first match.
8655 "full" Complete the next full match. After the last match,
8656 the original string is used and then the first match
8657 again.
8658 "longest" Complete till longest common string. If this doesn't
8659 result in a longer string, use the next part.
8660 "longest:full" Like "longest", but also start 'wildmenu' if it is
8661 enabled.
8662 "list" When more than one match, list all matches.
8663 "list:full" When more than one match, list all matches and
8664 complete first match.
8665 "list:longest" When more than one match, list all matches and
8666 complete till longest common string.
8667 When there is only a single match, it is fully completed in all cases.
8668
8669 Examples: >
8670 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008671< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008672 :set wildmode=longest,full
8673< Complete longest common string, then each full match >
8674 :set wildmode=list:full
8675< List all matches and complete each full match >
8676 :set wildmode=list,full
8677< List all matches without completing, then each full match >
8678 :set wildmode=longest,list
8679< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008680 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008682 *'wildoptions'* *'wop'*
8683'wildoptions' 'wop' string (default "")
8684 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008685 {not available when compiled without the |+wildignore|
8686 feature}
8687 A list of words that change how command line completion is done.
8688 Currently only one word is allowed:
8689 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008690 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008691 is displayed per line. Often used tag kinds are:
8692 d #define
8693 f function
8694 Also see |cmdline-completion|.
8695
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 *'winaltkeys'* *'wak'*
8697'winaltkeys' 'wak' string (default "menu")
8698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699 {only used in Win32, Motif, GTK and Photon GUI}
8700 Some GUI versions allow the access to menu entries by using the ALT
8701 key in combination with a character that appears underlined in the
8702 menu. This conflicts with the use of the ALT key for mappings and
8703 entering special characters. This option tells what to do:
8704 no Don't use ALT keys for menus. ALT key combinations can be
8705 mapped, but there is no automatic handling. This can then be
8706 done with the |:simalt| command.
8707 yes ALT key handling is done by the windowing system. ALT key
8708 combinations cannot be mapped.
8709 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008710 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008711 keys can be mapped.
8712 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8713 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008714 This option is not used for <F10>; on Win32 and with GTK <F10> will
8715 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008716
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008717 *'wincolor'* *'wcr'*
8718'wincolor' 'wcr' string (default empty)
8719 local to window
8720 Highlight group name to use for this window instead of the Normal
8721 color |hl-Normal|.
8722
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008723 *'window'* *'wi'*
8724'window' 'wi' number (default screen height - 1)
8725 global
8726 Window height. Do not confuse this with the height of the Vim window,
8727 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008728 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8729 value is smaller than 'lines' minus one. The screen will scroll
8730 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008731 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8732 in a much smarter way, taking care of wrapping lines.
8733 When resizing the Vim window, the value is smaller than 1 or more than
8734 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008735
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 *'winheight'* *'wh'* *E591*
8737'winheight' 'wh' number (default 1)
8738 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008739 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008740 feature}
8741 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008742 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008743 focus goes to a window that is smaller, its size is increased, at the
8744 cost of the height of other windows.
8745 Set 'winheight' to a small number for normal editing.
8746 Set it to 999 to make the current window fill most of the screen.
8747 Other windows will be only 'winminheight' high. This has the drawback
8748 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8749 to create only two windows, set the option after startup is done,
8750 using the |VimEnter| event: >
8751 au VimEnter * set winheight=999
8752< Minimum value is 1.
8753 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 height of the current window.
8755 'winheight' applies to the current window. Use 'winminheight' to set
8756 the minimal height for other windows.
8757
8758 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8759'winfixheight' 'wfh' boolean (default off)
8760 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02008761 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008762 feature}
8763 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008764 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8765 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008766 The height may be changed anyway when running out of room.
8767
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008768 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8769'winfixwidth' 'wfw' boolean (default off)
8770 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02008771 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008772 feature}
8773 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008774 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008775 The width may be changed anyway when running out of room.
8776
Bram Moolenaar071d4272004-06-13 20:20:40 +00008777 *'winminheight'* *'wmh'*
8778'winminheight' 'wmh' number (default 1)
8779 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008780 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008781 feature}
8782 The minimal height of a window, when it's not the current window.
8783 This is a hard minimum, windows will never become smaller.
8784 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8785 status bar) if necessary. They will return to at least one line when
8786 they become active (since the cursor has to have somewhere to go.)
8787 Use 'winheight' to set the minimal height of the current window.
8788 This option is only checked when making a window smaller. Don't use a
8789 large number, it will cause errors when opening more than a few
8790 windows. A value of 0 to 3 is reasonable.
8791
8792 *'winminwidth'* *'wmw'*
8793'winminwidth' 'wmw' number (default 1)
8794 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008795 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008796 feature}
8797 The minimal width of a window, when it's not the current window.
8798 This is a hard minimum, windows will never become smaller.
8799 When set to zero, windows may be "squashed" to zero columns (i.e. just
8800 a vertical separator) if necessary. They will return to at least one
8801 line when they become active (since the cursor has to have somewhere
8802 to go.)
8803 Use 'winwidth' to set the minimal width of the current window.
8804 This option is only checked when making a window smaller. Don't use a
8805 large number, it will cause errors when opening more than a few
8806 windows. A value of 0 to 12 is reasonable.
8807
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008808 *'winptydll'*
8809'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8810 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008811 {only available when compiled with the |terminal|
8812 feature on MS-Windows}
8813 Specifies the name of the winpty shared library, used for the
8814 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008815 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008816 a fallback.
8817 Environment variables are expanded |:set_env|.
8818 This option cannot be set from a |modeline| or in the |sandbox|, for
8819 security reasons.
8820
Bram Moolenaar071d4272004-06-13 20:20:40 +00008821 *'winwidth'* *'wiw'* *E592*
8822'winwidth' 'wiw' number (default 20)
8823 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008824 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008825 feature}
8826 Minimal number of columns for the current window. This is not a hard
8827 minimum, Vim will use fewer columns if there is not enough room. If
8828 the current window is smaller, its size is increased, at the cost of
8829 the width of other windows. Set it to 999 to make the current window
8830 always fill the screen. Set it to a small number for normal editing.
8831 The width is not adjusted after one of the commands to change the
8832 width of the current window.
8833 'winwidth' applies to the current window. Use 'winminwidth' to set
8834 the minimal width for other windows.
8835
8836 *'wrap'* *'nowrap'*
8837'wrap' boolean (default on)
8838 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008839 This option changes how text is displayed. It doesn't change the text
8840 in the buffer, see 'textwidth' for that.
8841 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008842 displaying continues on the next line. When off lines will not wrap
8843 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008844 moved to a part that is not shown, the screen will scroll
8845 horizontally.
8846 The line will be broken in the middle of a word if necessary. See
8847 'linebreak' to get the break at a word boundary.
8848 To make scrolling horizontally a bit more useful, try this: >
8849 :set sidescroll=5
8850 :set listchars+=precedes:<,extends:>
8851< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008852 This option can't be set from a |modeline| when the 'diff' option is
8853 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854
8855 *'wrapmargin'* *'wm'*
8856'wrapmargin' 'wm' number (default 0)
8857 local to buffer
8858 Number of characters from the right window border where wrapping
8859 starts. When typing text beyond this limit, an <EOL> will be inserted
8860 and inserting continues on the next line.
8861 Options that add a margin, such as 'number' and 'foldcolumn', cause
8862 the text width to be further reduced. This is Vi compatible.
8863 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008864 This option is set to 0 when 'paste' is set and restored when 'paste'
8865 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008866 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008867
8868 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8869'wrapscan' 'ws' boolean (default on) *E384* *E385*
8870 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008871 Searches wrap around the end of the file. Also applies to |]s| and
8872 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008873
8874 *'write'* *'nowrite'*
8875'write' boolean (default on)
8876 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008877 Allows writing files. When not set, writing a file is not allowed.
8878 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008879 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008880 argument. Filtering text is still possible, even though this requires
8881 writing a temporary file.
8882
8883 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8884'writeany' 'wa' boolean (default off)
8885 global
8886 Allows writing to any file with no need for "!" override.
8887
8888 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8889'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8890 otherwise)
8891 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008892 Make a backup before overwriting a file. The backup is removed after
8893 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008894 also on.
8895 WARNING: Switching this option off means that when Vim fails to write
8896 your buffer correctly and then, for whatever reason, Vim exits, you
8897 lose both the original file and what you were writing. Only reset
8898 this option if your file system is almost full and it makes the write
8899 fail (and make sure not to exit Vim until the write was successful).
8900 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008901 When the 'backupskip' pattern matches, a backup is not made anyway.
8902 NOTE: This option is set to the default value when 'compatible' is
8903 set.
8904
8905 *'writedelay'* *'wd'*
8906'writedelay' 'wd' number (default 0)
8907 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008908 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008909 screen. When non-zero, characters are sent to the terminal one by
8910 one. For MS-DOS pcterm this does not work. For debugging purposes.
8911
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008912 vim:tw=78:ts=8:noet:ft=help:norl: