blob: 79e0d0b72f525f336ace0ef8b4d7351c0d222130 [file] [log] [blame]
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001*options.txt* For Vim version 8.1. Last change: 2019 Aug 17
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020045:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000046
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049 current value of 'compatible'.
50:se[t] {option}&vi Reset option to its Vi default value.
51:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000052
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010053:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020054 these options are not changed:
55 all terminal options, starting with t_
56 'columns'
57 'cryptmethod'
58 'encoding'
59 'key'
60 'lines'
61 'term'
62 'ttymouse'
63 'ttytype'
64 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000065
66 *:set-args* *E487* *E521*
67:se[t] {option}={value} or
68:se[t] {option}:{value}
69 Set string or number option to {value}.
70 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010071 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000072 The old value can be inserted by typing 'wildchar' (by
73 default this is a <Tab> or CTRL-E if 'compatible' is
74 set). See |cmdline-completion|.
75 White space between {option} and '=' is allowed and
76 will be ignored. White space between '=' and {value}
77 is not allowed.
78 See |option-backslash| for using white space and
79 backslashes in {value}.
80
81:se[t] {option}+={value} *:set+=*
82 Add the {value} to a number option, or append the
83 {value} to a string option. When the option is a
84 comma separated list, a comma is added, unless the
85 value was empty.
86 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000087 are removed. When adding a flag that was already
88 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000089 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000090
91:se[t] {option}^={value} *:set^=*
92 Multiply the {value} to a number option, or prepend
93 the {value} to a string option. When the option is a
94 comma separated list, a comma is added, unless the
95 value was empty.
96 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000097
98:se[t] {option}-={value} *:set-=*
99 Subtract the {value} from a number option, or remove
100 the {value} from a string option, if it is there.
101 If the {value} is not found in a string option, there
102 is no error or warning. When the option is a comma
103 separated list, a comma is deleted, unless the option
104 becomes empty.
105 When the option is a list of flags, {value} must be
106 exactly as they appear in the option. Remove flags
107 one by one to avoid problems.
108 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109
110The {option} arguments to ":set" may be repeated. For example: >
111 :set ai nosi sw=3 ts=3
112If you make an error in one of the arguments, an error message will be given
113and the following arguments will be ignored.
114
115 *:set-verbose*
116When 'verbose' is non-zero, displaying an option value will also tell where it
117was last set. Example: >
118 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200119< shiftwidth=4 ~
120 Last set from modeline line 1 ~
121 cindent ~
122 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123This is only done when specific option values are requested, not for ":verbose
124set all" or ":verbose set" without an argument.
125When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000126When the option was set while executing a function, user command or
127autocommand, the script in which it was defined is reported.
128Note that an option may also have been set as a side effect of setting
129'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000130A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200131 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000132 Option was set in a |modeline|.
133 Last set from --cmd argument ~
134 Option was set with command line argument |--cmd| or +.
135 Last set from -c argument ~
136 Option was set with command line argument |-c|, +, |-S| or
137 |-q|.
138 Last set from environment variable ~
139 Option was set from an environment variable, $VIMINIT,
140 $GVIMINIT or $EXINIT.
141 Last set from error handler ~
142 Option was cleared when evaluating it resulted in an error.
143
Bram Moolenaardb84e452010-08-15 13:50:43 +0200144{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145
146 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000147For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148override the value from the termcap. You can then use it in a mapping. If
149the "xx" part contains special characters, use the <t_xx> form: >
150 :set <t_#4>=^[Ot
151This can also be used to translate a special code for a normal key. For
152example, if Alt-b produces <Esc>b, use this: >
153 :set <M-b>=^[b
154(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
155The advantage over a mapping is that it works in all situations.
156
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100157You can define any key codes, e.g.: >
158 :set t_xy=^[foo;
159There is no warning for using a name that isn't recognized. You can map these
160codes as you like: >
161 :map <t_xy> something
162< *E846*
163When a key code is not set, it's like it does not exist. Trying to get its
164value will result in an error: >
165 :set t_kb=
166 :set t_kb
167 E846: Key code not set: t_kb
168
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000169The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
170security reasons.
171
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000173at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174"set all" probably does not fit on the screen, causing Vim to give the
175|more-prompt|.
176
177 *option-backslash*
178To include white space in a string option value it has to be preceded with a
179backslash. To include a backslash you have to use two. Effectively this
180means that the number of backslashes in an option value is halved (rounded
181down).
182A few examples: >
183 :set tags=tags\ /usr/tags results in "tags /usr/tags"
184 :set tags=tags\\,file results in "tags\,file"
185 :set tags=tags\\\ file results in "tags\ file"
186
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000187The "|" character separates a ":set" command from a following command. To
188include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189'titlestring' option to "hi|there": >
190 :set titlestring=hi\|there
191This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
192 :set titlestring=hi|set iconstring=there
193
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000194Similarly, the double quote character starts a comment. To include the '"' in
195the option value, use '\"' instead. This example sets the 'titlestring'
196option to 'hi "there"': >
197 :set titlestring=hi\ \"there\"
198
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000199For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200precise: For options that expect a file name (those where environment
201variables are expanded) a backslash before a normal file name character is not
202removed. But a backslash before a special character (space, backslash, comma,
203etc.) is used like explained above.
204There is one special situation, when the value starts with "\\": >
205 :set dir=\\machine\path results in "\\machine\path"
206 :set dir=\\\\machine\\path results in "\\machine\path"
207 :set dir=\\path\\file results in "\\path\file" (wrong!)
208For the first one the start is kept, but for the second one the backslashes
209are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000210halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211result which is probably not what you want. Avoid it.
212
213 *add-option-flags* *remove-option-flags*
214 *E539* *E550* *E551* *E552*
215Some options are a list of flags. When you want to add a flag to such an
216option, without changing the existing ones, you can do it like this: >
217 :set guioptions+=a
218Remove a flag from an option like this: >
219 :set guioptions-=a
220This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000221Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
223doesn't appear.
224
225 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000226Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227environment variable exists the '$' and the following environment variable
228name is replaced with its value. If it does not exist the '$' and the name
229are not modified. Any non-id character (not a letter, digit or '_') may
230follow the environment variable name. That character and what follows is
231appended to the value of the environment variable. Examples: >
232 :set term=$TERM.new
233 :set path=/usr/$INCLUDE,$HOME/include,.
234When adding or removing a string from an option with ":set opt-=val" or ":set
235opt+=val" the expansion is done before the adding or removing.
236
237
238Handling of local options *local-options*
239
240Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100241has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242allows you to set 'list' in one window but not in another. And set
243'shiftwidth' to 3 in one buffer and 4 in another.
244
245The following explains what happens to these local options in specific
246situations. You don't really need to know all of this, since Vim mostly uses
247the option values you would expect. Unfortunately, doing what the user
248expects is a bit complicated...
249
250When splitting a window, the local options are copied to the new window. Thus
251right after the split the contents of the two windows look the same.
252
253When editing a new buffer, its local option values must be initialized. Since
254the local options of the current buffer might be specifically for that buffer,
255these are not used. Instead, for each buffer-local option there also is a
256global value, which is used for new buffers. With ":set" both the local and
257global value is changed. With "setlocal" only the local value is changed,
258thus this value is not used when editing a new buffer.
259
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200260When editing a buffer that has been edited before, the options from the window
261that was last closed are used again. If this buffer has been edited in this
262window, the values from back then are used. Otherwise the values from the
263last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264
265It's possible to set a local window option specifically for a type of buffer.
266When you edit another buffer in the same window, you don't want to keep
267using these local window options. Therefore Vim keeps a global value of the
268local window options, which is used when editing another buffer. Each window
269has its own copy of these values. Thus these are local to the window, but
270global to all buffers in the window. With this you can do: >
271 :e one
272 :set list
273 :e two
274Now the 'list' option will also be set in "two", since with the ":set list"
275command you have also set the global value. >
276 :set nolist
277 :e one
278 :setlocal list
279 :e two
280Now the 'list' option is not set, because ":set nolist" resets the global
281value, ":setlocal list" only changes the local value and ":e two" gets the
282global value. Note that if you do this next: >
283 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200284You will get back the 'list' value as it was the last time you edited "one".
285The options local to a window are remembered for each buffer. This also
286happens when the buffer is not loaded, but they are lost when the buffer is
287wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000288
289 *:setl* *:setlocal*
290:setl[ocal] ... Like ":set" but set only the value local to the
291 current buffer or window. Not all options have a
292 local value. If the option does not have a local
293 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200294 With the "all" argument: display local values for all
295 local options.
296 Without argument: Display local values for all local
297 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000299 local value. For a global/local boolean option, when
300 the global value is being used, "--" is displayed
301 before the option name.
302 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000305:setl[ocal] {option}< Set the local value of {option} to its global value by
306 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000307
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100308:se[t] {option}< For |global-local| options: Remove the local value of
309 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310
311 *:setg* *:setglobal*
312:setg[lobal] ... Like ":set" but set only the global value for a local
313 option without changing the local value.
314 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200315 With the "all" argument: display global values for all
316 local options.
317 Without argument: display global values for all local
318 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319
320For buffer-local and window-local options:
321 Command global value local value ~
322 :set option=value set set
323 :setlocal option=value - set
324:setglobal option=value set -
325 :set option? - display
326 :setlocal option? - display
327:setglobal option? display -
328
329
330Global options with a local value *global-local*
331
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000332Options are global when you mostly use one value for all buffers and windows.
333For some global options it's useful to sometimes have a different local value.
334You can set the local value with ":setlocal". That buffer or window will then
335use the local value, while other buffers and windows continue using the global
336value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337
338For example, you have two windows, both on C source code. They use the global
339'makeprg' option. If you do this in one of the two windows: >
340 :set makeprg=gmake
341then the other window will switch to the same value. There is no need to set
342the 'makeprg' option in the other C source window too.
343However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000344another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000345files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346 :setlocal makeprg=perlmake
347You can switch back to using the global value by making the local value empty: >
348 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100349This only works for a string option. For a number or boolean option you need
350to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100352Note that for non-boolean and non-number options using "<" copies the global
353value to the local value, it doesn't switch back to using the global value
354(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000355 :set path<
356This will make the local value of 'path' empty, so that the global value is
357used. Thus it does the same as: >
358 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359Note: In the future more global options can be made global-local. Using
360":setlocal" on a global option might work differently then.
361
362
363Setting the filetype
364
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200365:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366 Set the 'filetype' option to {filetype}, but only if
367 not done yet in a sequence of (nested) autocommands.
368 This is short for: >
369 :if !did_filetype()
370 : setlocal filetype={filetype}
371 :endif
372< This command is used in a filetype.vim file to avoid
373 setting the 'filetype' option twice, causing different
374 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200375
376 When the optional FALLBACK argument is present, a
377 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100378 'filetype'. This is to be used for filetype
379 detections that are just a guess. |did_filetype()|
380 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200381
Bram Moolenaard58e9292011-02-09 17:07:58 +0100382 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
384:opt[ions] Open a window for viewing and setting all options.
385 Options are grouped by function.
386 Offers short help for each option. Hit <CR> on the
387 short help to open a help window with more help for
388 the option.
389 Modify the value of the option and hit <CR> on the
390 "set" line to set the new value. For window and
391 buffer specific options, the last accessed window is
392 used to set the option value in, unless this is a help
393 window, in which case the window below help window is
394 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100395 {not available when compiled without the |+eval|
396 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397
398 *$HOME*
399Using "~" is like using "$HOME", but it is only recognized at the start of an
400option and after a space or comma.
401
402On Unix systems "~user" can be used too. It is replaced by the home directory
403of user "user". Example: >
404 :set path=~mool/include,/usr/include,.
405
406On Unix systems the form "${HOME}" can be used too. The name between {} can
407contain non-id characters then. Note that if you want to use this for the
408"gf" command, you need to add the '{' and '}' characters to 'isfname'.
409
410NOTE: expanding environment variables and "~/" is only done with the ":set"
411command, not when assigning a value to an option with ":let".
412
Bram Moolenaarc572da52017-08-27 16:52:01 +0200413 *$HOME-windows*
414On MS-Windows, if $HOME is not defined as an environment variable, then
415at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200416If $HOMEDRIVE is not set then $USERPROFILE is used.
417
418This expanded value is not exported to the environment, this matters when
419running an external command: >
420 :echo system('set | findstr ^HOME=')
421and >
422 :echo luaeval('os.getenv("HOME")')
423should echo nothing (an empty string) despite exists('$HOME') being true.
424When setting $HOME to a non-empty string it will be exported to the
425subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200426
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427
428Note the maximum length of an expanded option is limited. How much depends on
429the system, mostly it is something like 256 or 1024 characters.
430
431 *:fix* *:fixdel*
432:fix[del] Set the value of 't_kD':
433 't_kb' is 't_kD' becomes ~
434 CTRL-? CTRL-H
435 not CTRL-? CTRL-?
436
Bram Moolenaar6c60f472019-04-28 16:00:35 +0200437 (CTRL-? is 0177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438
439 If your delete key terminal code is wrong, but the
440 code for backspace is alright, you can put this in
441 your .vimrc: >
442 :fixdel
443< This works no matter what the actual code for
444 backspace is.
445
446 If the backspace key terminal code is wrong you can
447 use this: >
448 :if &term == "termname"
449 : set t_kb=^V<BS>
450 : fixdel
451 :endif
452< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000453 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454 with your terminal name.
455
456 If your <Delete> key sends a strange key sequence (not
457 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
458 :if &term == "termname"
459 : set t_kD=^V<Delete>
460 :endif
461< Where "^V" is CTRL-V and "<Delete>" is the delete key
462 (don't type eight characters!). Replace "termname"
463 with your terminal name.
464
465 *Linux-backspace*
466 Note about Linux: By default the backspace key
467 produces CTRL-?, which is wrong. You can fix it by
468 putting this line in your rc.local: >
469 echo "keycode 14 = BackSpace" | loadkeys
470<
471 *NetBSD-backspace*
472 Note about NetBSD: If your backspace doesn't produce
473 the right code, try this: >
474 xmodmap -e "keycode 22 = BackSpace"
475< If this works, add this in your .Xmodmap file: >
476 keysym 22 = BackSpace
477< You need to restart for this to take effect.
478
479==============================================================================
4802. Automatically setting options *auto-setting*
481
482Besides changing options with the ":set" command, there are three alternatives
483to set options automatically for one or more files:
484
4851. When starting Vim initializations are read from various places. See
486 |initialization|. Most of them are performed for all editing sessions,
487 and some of them depend on the directory where Vim is started.
488 You can create an initialization file with |:mkvimrc|, |:mkview| and
489 |:mksession|.
4902. If you start editing a new file, the automatic commands are executed.
491 This can be used to set options for files matching a particular pattern and
492 many other things. See |autocommand|.
4933. If you start editing a new file, and the 'modeline' option is on, a
494 number of lines at the beginning and end of the file are checked for
495 modelines. This is explained here.
496
497 *modeline* *vim:* *vi:* *ex:* *E520*
498There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200499 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200501[text] any text or empty
502{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200504[white] optional white space
505{options} a list of option settings, separated with white space
506 or ':', where each part between ':' is the argument
507 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar14b69452013-06-29 23:05:20 +0200509Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000510 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200511 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000512
513The second form (this is compatible with some versions of Vi):
514
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200515 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000516
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200517[text] any text or empty
518{white} at least one blank character (<Space> or <Tab>)
519{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
520[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200521se[t] the string "set " or "se " (note the space); When
522 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200523{options} a list of options, separated with white space, which
524 is the argument for a ":set" command
525: a colon
526[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527
Bram Moolenaar14b69452013-06-29 23:05:20 +0200528Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000529 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200530 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000531
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200532The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
533chance that a normal word like "lex:" is caught. There is one exception:
534"vi:" and "vim:" can also be at the start of the line (for compatibility with
535version 3.0). Using "ex:" at the start of the line will be ignored (this
536could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538 *modeline-local*
539The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000540buffer and window that contain the file. Although it's possible to set global
541options from a modeline, this is unusual. If you have two windows open and
542the files in it set the same global option to a different value, the result
543depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000545When editing a file that was already loaded, only the window-local options
546from the modeline are used. Thus if you manually changed a buffer-local
547option after opening the file, it won't be changed if you edit the same buffer
548in another window. But window-local options will be set.
549
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 *modeline-version*
551If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200552number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553 vim{vers}: version {vers} or later
554 vim<{vers}: version before {vers}
555 vim={vers}: version {vers}
556 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100557{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
558For example, to use a modeline only for Vim 7.0:
559 /* vim700: set foldmethod=marker */ ~
560To use a modeline for Vim after version 7.2:
561 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562There can be no blanks between "vim" and the ":".
563
564
565The number of lines that are checked can be set with the 'modelines' option.
566If 'modeline' is off or 'modelines' is 0 no lines are checked.
567
568Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000569like:
570 /* vi:ts=4: */ ~
571will give an error message for the trailing "*/". This line is OK:
572 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573
574If an error is detected the rest of the line is skipped.
575
576If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000577backslash in front of the ':' will be removed. Example:
578 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579This sets the 'dir' option to "c:\tmp". Only a single backslash before the
580':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200581 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000583might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200584can be set. For some options a flag is set, so that when the value is used
585the |sandbox| is effective. Some options can only be set from the modeline
586when 'modelineexpr' is set (the default is off).
587
588Still, there is always a small risk that a modeline causes trouble. E.g.,
589when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
590So disable modelines before editing untrusted text. The mail ftplugin does
591this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592
593Hint: If you would like to do something else than setting an option, you could
594define an autocommand that checks the file for a specific string. For
595example: >
596 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
597And define a function SetVar() that does something with the line containing
598"VAR".
599
600==============================================================================
6013. Options summary *option-summary*
602
603In the list below all the options are mentioned with their full name and with
604an abbreviation if there is one. Both forms may be used.
605
606In this document when a boolean option is "set" that means that ":set option"
607is entered. When an option is "reset", ":set nooption" is used.
608
609For some options there are two default values: The "Vim default", which is
610used when 'compatible' is not set, and the "Vi default", which is used when
611'compatible' is set.
612
613Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000614are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615different value in each window. For example the 'list' option can be set in
616one window and reset in another for the same text, giving both types of view
617at the same time. There are a few options that are specific to a certain
618file. These can have a different value for each file or buffer. For example
619the 'textwidth' option can be 78 for a normal text file and 0 for a C
620program.
621
622 global one option for all buffers and windows
623 local to window each window has its own copy of this option
624 local to buffer each buffer has its own copy of this option
625
626When creating a new window the option values from the currently active window
627are used as a default value for the window-specific options. For the
628buffer-specific options this depends on the 's' and 'S' flags in the
629'cpoptions' option. If 's' is included (which is the default) the values for
630buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000631first entered. If 'S' is present the options are copied each time the buffer
632is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633present, the options are copied from the currently active buffer when the
634buffer is created.
635
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000636Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000637
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000638Not all options are supported in all versions. This depends on the supported
639features and sometimes on the system. A remark about this is in curly braces
640below. When an option is not supported it may still be set without getting an
641error, this is called a hidden option. You can't get the value of a hidden
642option though, it is not stored.
643
644To test if option "foo" can be used with ":set" use something like this: >
645 if exists('&foo')
646This also returns true for a hidden option. To test if option "foo" is really
647supported use something like this: >
648 if exists('+foo')
649<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 *E355*
651A jump table for the options with a short description can be found at |Q_op|.
652
653 *'aleph'* *'al'* *aleph* *Aleph*
654'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 {only available when compiled with the |+rightleft|
657 feature}
658 The ASCII code for the first letter of the Hebrew alphabet. The
659 routine that maps the keyboard in Hebrew mode, both in Insert mode
660 (when hkmap is set) and on the command-line (when hitting CTRL-_)
661 outputs the Hebrew characters in the range [aleph..aleph+26].
662 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
663 See |rileft.txt|.
664
665 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
666'allowrevins' 'ari' boolean (default off)
667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668 {only available when compiled with the |+rightleft|
669 feature}
670 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
671 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
672 into reverse Insert mode, and don't know how to get out. See
673 'revins'.
674 NOTE: This option is reset when 'compatible' is set.
675
676 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
677'altkeymap' 'akm' boolean (default off)
678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679 {only available when compiled with the |+farsi|
680 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100681 This option was for using Farsi, which has been removed. See
682 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683
684 *'ambiwidth'* *'ambw'*
685'ambiwidth' 'ambw' string (default: "single")
686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
688 Tells Vim what to do with characters with East Asian Width Class
689 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
690 letters, Cyrillic letters).
691
692 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 expected by most users.
695 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200696 *E834* *E835*
697 The value "double" cannot be used if 'listchars' or 'fillchars'
698 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700 There are a number of CJK fonts for which the width of glyphs for
701 those characters are solely based on how many octets they take in
702 legacy/traditional CJK encodings. In those encodings, Euro,
703 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000704 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000706 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 Vim is running inside a terminal (emulators) that uses a CJK font
708 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
709 this option should be set to "double" to match the width perceived
710 by Vim with the width of glyphs in the font. Perhaps it also has
711 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
712 when the system locale is set to one of CJK locales. See Unicode
713 Standard Annex #11 (http://www.unicode.org/reports/tr11).
714
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100715 Vim may set this option automatically at startup time when Vim is
716 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200717 escape sequence to request cursor position report. The response can
718 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100719
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
721'antialias' 'anti' boolean (default: off)
722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 {only available when compiled with GUI enabled
724 on Mac OS X}
725 This option only has an effect in the GUI version of Vim on Mac OS X
726 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
727 which can be easier to read at certain sizes on certain displays.
728 Setting this option can sometimes cause problems if 'guifont' is set
729 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100730 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731
732 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
733'autochdir' 'acd' boolean (default off)
734 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200735 {only available when compiled with it, use
736 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000737 When on, Vim will change the current working directory whenever you
738 open a file, switch buffers, delete a buffer or open/close a window.
739 It will change to the directory containing the file which was opened
740 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000741 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742
743 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
744'arabic' 'arab' boolean (default off)
745 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 {only available when compiled with the |+arabic|
747 feature}
748 This option can be set to start editing Arabic text.
749 Setting this option will:
750 - Set the 'rightleft' option, unless 'termbidi' is set.
751 - Set the 'arabicshape' option, unless 'termbidi' is set.
752 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
753 between typing English and Arabic key mapping.
754 - Set the 'delcombine' option
755 Note that 'encoding' must be "utf-8" for working with Arabic text.
756
757 Resetting this option will:
758 - Reset the 'rightleft' option.
759 - Disable the use of 'keymap' (without changing its value).
760 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200761 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100762 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 Also see |arabic.txt|.
764
765 *'arabicshape'* *'arshape'*
766 *'noarabicshape'* *'noarshape'*
767'arabicshape' 'arshape' boolean (default on)
768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 {only available when compiled with the |+arabic|
770 feature}
771 When on and 'termbidi' is off, the required visual character
772 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200773 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 one which encompasses:
775 a) the changing/morphing of characters based on their location
776 within a word (initial, medial, final and stand-alone).
777 b) the enabling of the ability to compose characters
778 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100779 When disabled the display shows each character's true stand-alone
780 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 Arabic is a complex language which requires other settings, for
782 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100783 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784
785 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
786'autoindent' 'ai' boolean (default off)
787 local to buffer
788 Copy indent from current line when starting a new line (typing <CR>
789 in Insert mode or when using the "o" or "O" command). If you do not
790 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000791 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
792 to another line has the same effect, unless the 'I' flag is included
793 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000794 When autoindent is on, formatting (with the "gq" command or when you
795 reach 'textwidth' in Insert mode) uses the indentation of the first
796 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 When 'smartindent' or 'cindent' is on the indent is changed in
798 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200799 The 'autoindent' option is reset when the 'paste' option is set and
800 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801
802 *'autoread'* *'ar'* *'noautoread'* *'noar'*
803'autoread' 'ar' boolean (default off)
804 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805 When a file has been detected to have been changed outside of Vim and
806 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200807 When the file has been deleted this is not done, so you have the text
808 from before it was deleted. When it appears again then it is read.
809 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 If this option has a local value, use this command to switch back to
811 using the global value: >
812 :set autoread<
813<
814 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
815'autowrite' 'aw' boolean (default off)
816 global
817 Write the contents of the file, if it has been modified, on each
818 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000819 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
821 Note that for some commands the 'autowrite' option is not used, see
822 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200823 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200824 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
826 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
827'autowriteall' 'awa' boolean (default off)
828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
830 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
831 Setting this option also implies that Vim behaves like 'autowrite' has
832 been set.
833
834 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200835'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 When set to "dark", Vim will try to use colors that look good on a
838 dark background. When set to "light", Vim will try to use colors that
839 look good on a light background. Any other value is illegal.
840 Vim tries to set the default value according to the terminal used.
841 This will not always be correct.
842 Setting this option does not change the background color, it tells Vim
843 what the background color looks like. For changing the background
844 color, see |:hi-normal|.
845
846 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000847 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000848 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100849 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 setting 'background' will cause the color scheme to be reloaded. If
851 the color scheme adjusts to the value of 'background' this will work.
852 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100853 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854
855 When setting 'background' to the default value with: >
856 :set background&
857< Vim will guess the value. In the GUI this should work correctly,
858 in other cases Vim might not be able to guess the right value.
859
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200860 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200861 color from the terminal. If the returned RGB value is dark/light and
862 'background' is not dark/light, 'background' will be set and the
863 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200864 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100865 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200866
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 When starting the GUI, the default value for 'background' will be
868 "light". When the value is not set in the .gvimrc, and Vim detects
869 that the background is actually quite dark, 'background' is set to
870 "dark". But this happens only AFTER the .gvimrc file has been read
871 (because the window needs to be opened to find the actual background
872 color). To get around this, force the GUI window to be opened by
873 putting a ":gui" command in the .gvimrc file, before where the value
874 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200875
876 For MS-DOS, Windows and OS/2 the default is "dark".
877 For other systems "dark" is used when 'term' is "linux",
878 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
879 background. Otherwise the default is "light".
880
Bram Moolenaarc572da52017-08-27 16:52:01 +0200881 The |:terminal| command and the |term_start()| function use the
882 'background' value to decide whether the terminal window will start
883 with a white or black background.
884
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 Normally this option would be set in the .vimrc file. Possibly
886 depending on the terminal name. Example: >
887 :if &term == "pcterm"
888 : set background=dark
889 :endif
890< When this option is set, the default settings for the highlight groups
891 will change. To use other settings, place ":highlight" commands AFTER
892 the setting of the 'background' option.
893 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
894 to select the colors for syntax highlighting. After changing this
895 option, you must load syntax.vim again to see the result. This can be
896 done with ":syntax on".
897
898 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200899'backspace' 'bs' string (default "", set to "indent,eol,start"
900 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
903 mode. This is a list of items, separated by commas. Each item allows
904 a way to backspace over something:
905 value effect ~
906 indent allow backspacing over autoindent
907 eol allow backspacing over line breaks (join lines)
908 start allow backspacing over the start of insert; CTRL-W and CTRL-U
909 stop once at the start of insert.
910
911 When the value is empty, Vi compatible backspacing is used.
912
913 For backwards compatibility with version 5.4 and earlier:
914 value effect ~
915 0 same as ":set backspace=" (Vi compatible)
916 1 same as ":set backspace=indent,eol"
917 2 same as ":set backspace=indent,eol,start"
918
919 See |:fixdel| if your <BS> or <Del> key does not do what you want.
920 NOTE: This option is set to "" when 'compatible' is set.
921
922 *'backup'* *'bk'* *'nobackup'* *'nobk'*
923'backup' 'bk' boolean (default off)
924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 Make a backup before overwriting a file. Leave it around after the
926 file has been successfully written. If you do not want to keep the
927 backup file, but you do want a backup while the file is being
928 written, reset this option and set the 'writebackup' option (this is
929 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000930 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931 |backup-table| for more explanations.
932 When the 'backupskip' pattern matches, a backup is not made anyway.
933 When 'patchmode' is set, the backup may be renamed to become the
934 oldest version of a file.
935 NOTE: This option is reset when 'compatible' is set.
936
937 *'backupcopy'* *'bkc'*
938'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200939 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 When writing a file and a backup is made, this option tells how it's
941 done. This is a comma separated list of words.
942
943 The main values are:
944 "yes" make a copy of the file and overwrite the original one
945 "no" rename the file and write a new one
946 "auto" one of the previous, what works best
947
948 Extra values that can be combined with the ones above are:
949 "breaksymlink" always break symlinks when writing
950 "breakhardlink" always break hardlinks when writing
951
952 Making a copy and overwriting the original file:
953 - Takes extra time to copy the file.
954 + When the file has special attributes, is a (hard/symbolic) link or
955 has a resource fork, all this is preserved.
956 - When the file is a link the backup will have the name of the link,
957 not of the real file.
958
959 Renaming the file and writing a new one:
960 + It's fast.
961 - Sometimes not all attributes of the file can be copied to the new
962 file.
963 - When the file is a link the new file will not be a link.
964
965 The "auto" value is the middle way: When Vim sees that renaming file
966 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000967 the file is not a link) that is used. When problems are expected, a
968 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969
970 The "breaksymlink" and "breakhardlink" values can be used in
971 combination with any of "yes", "no" and "auto". When included, they
972 force Vim to always break either symbolic or hard links by doing
973 exactly what the "no" option does, renaming the original file to
974 become the backup and writing a new file in its place. This can be
975 useful for example in source trees where all the files are symbolic or
976 hard links and any changes should stay in the local source tree, not
977 be propagated back to the original source.
978 *crontab*
979 One situation where "no" and "auto" will cause problems: A program
980 that opens a file, invokes Vim to edit that file, and then tests if
981 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000982 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983 example.
984
985 When a copy is made, the original file is truncated and then filled
986 with the new text. This means that protection bits, owner and
987 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000988 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 group of the backup is set to the group of the original file. If this
990 fails, the protection bits for the group are made the same as for
991 others.
992
993 When the file is renamed this is the other way around: The backup has
994 the same attributes of the original file, and the newly written file
995 is owned by the current user. When the file was a (hard/symbolic)
996 link, the new file will not! That's why the "auto" value doesn't
997 rename when the file is a link. The owner and group of the newly
998 written file will be set to the same ones as the original file, but
999 the system may refuse to do this. In that case the "auto" value will
1000 again not rename the file.
1001
Bram Moolenaar036986f2017-03-16 17:41:02 +01001002 NOTE: This option is set to the Vi default value when 'compatible' is
1003 set and to the Vim default value when 'compatible' is reset.
1004
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 *'backupdir'* *'bdir'*
1006'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001007 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 for Unix: ".,~/tmp,~/")
1009 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 List of directories for the backup file, separated with commas.
1011 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001012 where this is possible. The directory must exist, Vim will not
1013 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001014 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015 impossible!). Writing may fail because of this.
1016 - A directory "." means to put the backup file in the same directory
1017 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001018 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019 put the backup file relative to where the edited file is. The
1020 leading "." is replaced with the path name of the edited file.
1021 ("." inside a directory name has no special meaning).
1022 - Spaces after the comma are ignored, other spaces are considered part
1023 of the directory name. To have a space at the start of a directory
1024 name, precede it with a backslash.
1025 - To include a comma in a directory name precede it with a backslash.
1026 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001027 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001028 the backup file name will be built from the complete path to the
1029 file with all path separators changed to percent '%' signs. This
1030 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001031 On Win32, it is also possible to end with "\\". However, When a
1032 separating comma is following, you must use "//", since "\\" will
1033 include the comma in the file name. Therefore it is recommended to
1034 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035 - Environment variables are expanded |:set_env|.
1036 - Careful with '\' characters, type one before a space, type two to
1037 get one in the option (see |option-backslash|), for example: >
1038 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1039< - For backwards compatibility with Vim version 3.0 a '>' at the start
1040 of the option is removed.
1041 See also 'backup' and 'writebackup' options.
1042 If you want to hide your backup files on Unix, consider this value: >
1043 :set backupdir=./.backup,~/.backup,.,/tmp
1044< You must create a ".backup" directory in each directory and in your
1045 home directory for this to work properly.
1046 The use of |:set+=| and |:set-=| is preferred when adding or removing
1047 directories from the list. This avoids problems when a future version
1048 uses another default.
1049 This option cannot be set from a |modeline| or in the |sandbox|, for
1050 security reasons.
1051
1052 *'backupext'* *'bex'* *E589*
1053'backupext' 'bex' string (default "~", for VMS: "_")
1054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001055 String which is appended to a file name to make the name of the
1056 backup file. The default is quite unusual, because this avoids
1057 accidentally overwriting existing files with a backup file. You might
1058 prefer using ".bak", but make sure that you don't have files with
1059 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001060 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001062 If you like to keep a lot of backups, you could use a BufWritePre
1063 autocommand to change 'backupext' just before writing the file to
1064 include a timestamp. >
1065 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1066< Use 'backupdir' to put the backup in a different directory.
1067
Bram Moolenaar071d4272004-06-13 20:20:40 +00001068 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001069'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1070 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1071 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 {not available when compiled without the |+wildignore|
1074 feature}
1075 A list of file patterns. When one of the patterns matches with the
1076 name of the file which is written, no backup file is created. Both
1077 the specified file name and the full path name of the file are used.
1078 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1079 Watch out for special characters, see |option-backslash|.
1080 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001081 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001082
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001083 WARNING: Not having a backup file means that when Vim fails to write
1084 your buffer correctly and then, for whatever reason, Vim exits, you
1085 lose both the original file and what you were writing. Only disable
1086 backups if you don't care about losing the file.
1087
Bram Moolenaar02467872007-05-06 13:22:01 +00001088 Note that environment variables are not expanded. If you want to use
1089 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001090 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001091
1092< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001093 backup would be made by renaming the original file crontab won't see
1094 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
1096 *'balloondelay'* *'bdlay'*
1097'balloondelay' 'bdlay' number (default: 600)
1098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 {only available when compiled with the |+balloon_eval|
1100 feature}
1101 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1102
1103 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1104'ballooneval' 'beval' boolean (default off)
1105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001107 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001108 Switch on the |balloon-eval| functionality for the GUI.
1109
1110 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1111 *'nobevalterm'*
1112'balloonevalterm' 'bevalterm' boolean (default off)
1113 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001114 {only available when compiled with the
1115 |+balloon_eval_term| feature}
1116 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001118 *'balloonexpr'* *'bexpr'*
1119'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001120 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001121 {only available when compiled with the |+balloon_eval|
1122 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001123 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001124 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1125 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001126
1127 v:beval_bufnr number of the buffer in which balloon is going to show
1128 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001129 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001130 v:beval_lnum line number
1131 v:beval_col column number (byte index)
1132 v:beval_text word under or after the mouse pointer
1133
Bram Moolenaar54775062019-07-31 21:07:14 +02001134 Instead of showing a balloon, which is limited to plain text, consider
1135 using a popup window, see |popup_beval_example|. A popup window can
1136 use highlighting and show a border.
1137
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001138 The evaluation of the expression must not have side effects!
1139 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001140 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001141 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001142 \', column ' . v:beval_col .
1143 \ ' of file ' . bufname(v:beval_bufnr) .
1144 \ ' on word "' . v:beval_text . '"'
1145 endfunction
1146 set bexpr=MyBalloonExpr()
1147 set ballooneval
1148<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001149 Also see |balloon_show()|, it can be used if the content of the balloon
1150 is to be fetched asynchronously. In that case evaluating
1151 'balloonexpr' should result in an empty string. If you get a balloon
1152 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001153
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001154 NOTE: The balloon is displayed only if the cursor is on a text
1155 character. If the result of evaluating 'balloonexpr' is not empty,
1156 Vim does not try to send a message to an external debugger (Netbeans
1157 or Sun Workshop).
1158
Bram Moolenaar30b65812012-07-12 22:01:11 +02001159 The expression will be evaluated in the |sandbox| when set from a
1160 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001161 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001162
1163 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001164 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001165
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001166 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001167 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001168< When they are supported "\n" characters will start a new line. If the
1169 expression evaluates to a |List| this is equal to using each List item
1170 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001171 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001172
Bram Moolenaar165bc692015-07-21 17:53:25 +02001173 *'belloff'* *'bo'*
1174'belloff' 'bo' string (default "")
1175 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001176 Specifies for which events the bell will not be rung. It is a comma
1177 separated list of items. For each item that is present, the bell
1178 will be silenced. This is most useful to specify specific events in
1179 insert mode to be silenced.
1180
1181 item meaning when present ~
1182 all All events.
1183 backspace When hitting <BS> or <Del> and deleting results in an
1184 error.
1185 cursor Fail to move around using the cursor keys or
1186 <PageUp>/<PageDown> in |Insert-mode|.
1187 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1188 |i_CTRL-X_CTRL-T|.
1189 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1190 |i_CTRL-E|.
1191 ctrlg Unknown Char after <C-G> in Insert mode.
1192 error Other Error occurred (e.g. try to join last line)
1193 (mostly used in |Normal-mode| or |Cmdline-mode|).
1194 esc hitting <Esc> in |Normal-mode|.
1195 ex In |Visual-mode|, hitting |Q| results in an error.
1196 hangul Error occurred when using hangul input.
1197 insertmode Pressing <Esc> in 'insertmode'.
1198 lang Calling the beep module for Lua/Mzscheme/TCL.
1199 mess No output available for |g<|.
1200 showmatch Error occurred for 'showmatch' function.
1201 operator Empty region error |cpo-E|.
1202 register Unknown register after <C-R> in |Insert-mode|.
1203 shell Bell from shell output |:!|.
1204 spell Error happened on spell suggest.
1205 wildmode More matches in |cmdline-completion| available
1206 (depends on the 'wildmode' setting).
1207
Bram Moolenaar036986f2017-03-16 17:41:02 +01001208 This is most useful to fine tune when in Insert mode the bell should
1209 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001210 indicate that an error occurred. It can be silenced by adding the
1211 "error" keyword.
1212
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1214'binary' 'bin' boolean (default off)
1215 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216 This option should be set before editing a binary file. You can also
1217 use the |-b| Vim argument. When this option is switched on a few
1218 options will be changed (also when it already was on):
1219 'textwidth' will be set to 0
1220 'wrapmargin' will be set to 0
1221 'modeline' will be off
1222 'expandtab' will be off
1223 Also, 'fileformat' and 'fileformats' options will not be used, the
1224 file is read and written like 'fileformat' was "unix" (a single <NL>
1225 separates lines).
1226 The 'fileencoding' and 'fileencodings' options will not be used, the
1227 file is read without conversion.
1228 NOTE: When you start editing a(nother) file while the 'bin' option is
1229 on, settings from autocommands may change the settings again (e.g.,
1230 'textwidth'), causing trouble when editing. You might want to set
1231 'bin' again when the file has been loaded.
1232 The previous values of these options are remembered and restored when
1233 'bin' is switched from on to off. Each buffer has its own set of
1234 saved option values.
1235 To edit a file with 'binary' set you can use the |++bin| argument.
1236 This avoids you have to do ":set bin", which would have effect for all
1237 files you edit.
1238 When writing a file the <EOL> for the last line is only written if
1239 there was one in the original file (normally Vim appends an <EOL> to
1240 the last line if there is none; this would make the file longer). See
1241 the 'endofline' option.
1242
1243 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1244'bioskey' 'biosk' boolean (default on)
1245 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001246 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001247 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248
1249 *'bomb'* *'nobomb'*
1250'bomb' boolean (default off)
1251 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252 When writing a file and the following conditions are met, a BOM (Byte
1253 Order Mark) is prepended to the file:
1254 - this option is on
1255 - the 'binary' option is off
1256 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1257 endian variants.
1258 Some applications use the BOM to recognize the encoding of the file.
1259 Often used for UCS-2 files on MS-Windows. For other applications it
1260 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001261 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1263 check for the presence of the BOM is done and 'bomb' set accordingly.
1264 Unless 'binary' is set, it is removed from the first line, so that you
1265 don't see it when editing. When you don't change the options, the BOM
1266 will be restored when writing the file.
1267
1268 *'breakat'* *'brk'*
1269'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1270 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001271 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272 feature}
1273 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001274 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1275 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001277 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001278'breakindent' 'bri' boolean (default off)
1279 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001280 {not available when compiled without the |+linebreak|
1281 feature}
1282 Every wrapped line will continue visually indented (same amount of
1283 space as the beginning of that line), thus preserving horizontal blocks
1284 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001285 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001286
1287 *'breakindentopt'* *'briopt'*
1288'breakindentopt' 'briopt' string (default empty)
1289 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001290 {not available when compiled without the |+linebreak|
1291 feature}
1292 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001293 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001294 min:{n} Minimum text width that will be kept after
1295 applying 'breakindent', even if the resulting
1296 text should normally be narrower. This prevents
1297 text indented almost to the right window border
1298 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001299 shift:{n} After applying 'breakindent', the wrapped line's
1300 beginning will be shifted by the given number of
1301 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001302 indentation (negative) or emphasizing the line
1303 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001304 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001305 additional indent.
1306 The default value for min is 20 and shift is 0.
1307
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001309'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001310 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001311 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001313 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001314 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315 buffer Use the directory of the related buffer.
1316 current Use the current directory.
1317 {path} Use the specified directory
1318
1319 *'bufhidden'* *'bh'*
1320'bufhidden' 'bh' string (default: "")
1321 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322 This option specifies what happens when a buffer is no longer
1323 displayed in a window:
1324 <empty> follow the global 'hidden' option
1325 hide hide the buffer (don't unload it), also when 'hidden'
1326 is not set
1327 unload unload the buffer, also when 'hidden' is set or using
1328 |:hide|
1329 delete delete the buffer from the buffer list, also when
1330 'hidden' is set or using |:hide|, like using
1331 |:bdelete|
1332 wipe wipe out the buffer from the buffer list, also when
1333 'hidden' is set or using |:hide|, like using
1334 |:bwipeout|
1335
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001336 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001337 are lost without a warning. Also, these values may break autocommands
1338 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 This option is used together with 'buftype' and 'swapfile' to specify
1340 special kinds of buffers. See |special-buffers|.
1341
1342 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1343'buflisted' 'bl' boolean (default: on)
1344 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345 When this option is set, the buffer shows up in the buffer list. If
1346 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1347 This option is reset by Vim for buffers that are only used to remember
1348 a file name or marks. Vim sets it when starting to edit a buffer.
1349 But not when moving to a buffer with ":buffer".
1350
1351 *'buftype'* *'bt'* *E382*
1352'buftype' 'bt' string (default: "")
1353 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 The value of this option specifies the type of a buffer:
1355 <empty> normal buffer
1356 nofile buffer which is not related to a file and will not be
1357 written
1358 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001359 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001360 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001361 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001362 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001363 help help buffer (you are not supposed to set this
1364 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001365 terminal buffer for a |terminal| (you are not supposed to set
1366 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001367 prompt buffer where only the last line can be edited, meant
1368 to be used by a plugin, see |prompt-buffer|
1369 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001370 popup buffer used in a popup window, see |popup|.
1371 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001372
1373 This option is used together with 'bufhidden' and 'swapfile' to
1374 specify special kinds of buffers. See |special-buffers|.
1375
1376 Be careful with changing this option, it can have many side effects!
1377
Bram Moolenaar280f1262006-01-30 00:14:18 +00001378 A "quickfix" buffer is only used for the error list and the location
1379 list. This value is set by the |:cwindow| and |:lwindow| commands and
1380 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381
1382 "nofile" and "nowrite" buffers are similar:
1383 both: The buffer is not to be written to disk, ":w" doesn't
1384 work (":w filename" does work though).
1385 both: The buffer is never considered to be |'modified'|.
1386 There is no warning when the changes will be lost, for
1387 example when you quit Vim.
1388 both: A swap file is only created when using too much memory
1389 (when 'swapfile' has been reset there is never a swap
1390 file).
1391 nofile only: The buffer name is fixed, it is not handled like a
1392 file name. It is not modified in response to a |:cd|
1393 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001394 both: When using ":e bufname" and already editing "bufname"
1395 the buffer is made empty and autocommands are
1396 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001397 *E676*
1398 "acwrite" implies that the buffer name is not related to a file, like
1399 "nofile", but it will be written. Thus, in contrast to "nofile" and
1400 "nowrite", ":w" does work and a modified buffer can't be abandoned
1401 without saving. For writing there must be matching |BufWriteCmd|,
1402 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403
1404 *'casemap'* *'cmp'*
1405'casemap' 'cmp' string (default: "internal,keepascii")
1406 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407 Specifies details about changing the case of letters. It may contain
1408 these words, separated by a comma:
1409 internal Use internal case mapping functions, the current
1410 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001411 matters when 'encoding' is a Unicode encoding,
1412 "latin1" or "iso-8859-15". When "internal" is
1413 omitted, the towupper() and towlower() system library
1414 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1416 case mapping, the current locale is not effective.
1417 This probably only matters for Turkish.
1418
1419 *'cdpath'* *'cd'* *E344* *E346*
1420'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1421 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001422 {not available when compiled without the
1423 |+file_in_path| feature}
1424 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001425 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1426 searched for has a relative path, not an absolute part starting with
1427 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428 The 'cdpath' option's value has the same form and semantics as
1429 |'path'|. Also see |file-searching|.
1430 The default value is taken from $CDPATH, with a "," prepended to look
1431 in the current directory first.
1432 If the default value taken from $CDPATH is not what you want, include
1433 a modified version of the following command in your vimrc file to
1434 override it: >
1435 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1436< This option cannot be set from a |modeline| or in the |sandbox|, for
1437 security reasons.
1438 (parts of 'cdpath' can be passed to the shell to expand file names).
1439
1440 *'cedit'*
1441'cedit' string (Vi default: "", Vim default: CTRL-F)
1442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 The key used in Command-line Mode to open the command-line window.
1444 The default is CTRL-F when 'compatible' is off.
1445 Only non-printable keys are allowed.
1446 The key can be specified as a single character, but it is difficult to
1447 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001448 :exe "set cedit=\<C-Y>"
1449 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450< |Nvi| also has this option, but it only uses the first character.
1451 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001452 NOTE: This option is set to the Vim default value when 'compatible'
1453 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454
1455 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1456'charconvert' 'ccv' string (default "")
1457 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001458 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459 An expression that is used for character encoding conversion. It is
1460 evaluated when a file that is to be read or has been written has a
1461 different encoding from what is desired.
1462 'charconvert' is not used when the internal iconv() function is
1463 supported and is able to do the conversion. Using iconv() is
1464 preferred, because it is much faster.
1465 'charconvert' is not used when reading stdin |--|, because there is no
1466 file to convert from. You will have to save the text in a file first.
1467 The expression must return zero or an empty string for success,
1468 non-zero for failure.
1469 The possible encoding names encountered are in 'encoding'.
1470 Additionally, names given in 'fileencodings' and 'fileencoding' are
1471 used.
1472 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1473 is done internally by Vim, 'charconvert' is not used for this.
1474 'charconvert' is also used to convert the viminfo file, if the 'c'
1475 flag is present in 'viminfo'. Also used for Unicode conversion.
1476 Example: >
1477 set charconvert=CharConvert()
1478 fun CharConvert()
1479 system("recode "
1480 \ . v:charconvert_from . ".." . v:charconvert_to
1481 \ . " <" . v:fname_in . " >" v:fname_out)
1482 return v:shell_error
1483 endfun
1484< The related Vim variables are:
1485 v:charconvert_from name of the current encoding
1486 v:charconvert_to name of the desired encoding
1487 v:fname_in name of the input file
1488 v:fname_out name of the output file
1489 Note that v:fname_in and v:fname_out will never be the same.
1490 Note that v:charconvert_from and v:charconvert_to may be different
1491 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1492 Encryption is not done by Vim when using 'charconvert'. If you want
1493 to encrypt the file after conversion, 'charconvert' should take care
1494 of this.
1495 This option cannot be set from a |modeline| or in the |sandbox|, for
1496 security reasons.
1497
1498 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1499'cindent' 'cin' boolean (default off)
1500 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 {not available when compiled without the |+cindent|
1502 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001503 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 that trigger reindenting in insert mode and 'cinoptions' to set your
1505 preferred indent style.
1506 If 'indentexpr' is not empty, it overrules 'cindent'.
1507 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1508 the "=" operator indents using this algorithm rather than calling an
1509 external program.
1510 See |C-indenting|.
1511 When you don't like the way 'cindent' works, try the 'smartindent'
1512 option or 'indentexpr'.
1513 This option is not used when 'paste' is set.
1514 NOTE: This option is reset when 'compatible' is set.
1515
1516 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001517'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001518 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 {not available when compiled without the |+cindent|
1520 feature}
1521 A list of keys that, when typed in Insert mode, cause reindenting of
1522 the current line. Only used if 'cindent' is on and 'indentexpr' is
1523 empty.
1524 For the format of this option see |cinkeys-format|.
1525 See |C-indenting|.
1526
1527 *'cinoptions'* *'cino'*
1528'cinoptions' 'cino' string (default "")
1529 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530 {not available when compiled without the |+cindent|
1531 feature}
1532 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1533 program. See |cinoptions-values| for the values of this option, and
1534 |C-indenting| for info on C indenting in general.
1535
1536
1537 *'cinwords'* *'cinw'*
1538'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1539 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540 {not available when compiled without both the
1541 |+cindent| and the |+smartindent| features}
1542 These keywords start an extra indent in the next line when
1543 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1544 an appropriate place (inside {}).
1545 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1546 matter, include the keyword both the uppercase and lowercase:
1547 "if,If,IF".
1548
1549 *'clipboard'* *'cb'*
1550'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1551 for X-windows, "" otherwise)
1552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553 {only in GUI versions or when the |+xterm_clipboard|
1554 feature is included}
1555 This option is a list of comma separated names.
1556 These names are recognized:
1557
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001558 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 unnamed When included, Vim will use the clipboard register '*'
1560 for all yank, delete, change and put operations which
1561 would normally go to the unnamed register. When a
1562 register is explicitly specified, it will always be
1563 used regardless of whether "unnamed" is in 'clipboard'
1564 or not. The clipboard register can always be
1565 explicitly accessed using the "* notation. Also see
1566 |gui-clipboard|.
1567
Bram Moolenaar30b65812012-07-12 22:01:11 +02001568 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001569 unnamedplus A variant of the "unnamed" flag which uses the
1570 clipboard register '+' (|quoteplus|) instead of
1571 register '*' for all yank, delete, change and put
1572 operations which would normally go to the unnamed
1573 register. When "unnamed" is also included to the
1574 option, yank operations (but not delete, change or
1575 put) will additionally copy the text into register
1576 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001577 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001578 Availability can be checked with: >
1579 if has('unnamedplus')
1580<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001581 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 autoselect Works like the 'a' flag in 'guioptions': If present,
1583 then whenever Visual mode is started, or the Visual
1584 area extended, Vim tries to become the owner of the
1585 windowing system's global selection or put the
1586 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001587 register "*. See |'go-a'| and |quotestar| for details.
1588 When the GUI is active, the 'a' flag in 'guioptions'
1589 is used, when the GUI is not active, this "autoselect"
1590 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591 Also applies to the modeless selection.
1592
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001593 *clipboard-autoselectplus*
1594 autoselectplus Like "autoselect" but using the + register instead of
1595 the * register. Compare to the 'P' flag in
1596 'guioptions'.
1597
1598 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 autoselectml Like "autoselect", but for the modeless selection
1600 only. Compare to the 'A' flag in 'guioptions'.
1601
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001602 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001603 html When the clipboard contains HTML, use this when
1604 pasting. When putting text on the clipboard, mark it
1605 as HTML. This works to copy rendered HTML from
1606 Firefox, paste it as raw HTML in Vim, select the HTML
1607 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001608 You probably want to add this only temporarily,
1609 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001610 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001611
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001612 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 exclude:{pattern}
1614 Defines a pattern that is matched against the name of
1615 the terminal 'term'. If there is a match, no
1616 connection will be made to the X server. This is
1617 useful in this situation:
1618 - Running Vim in a console.
1619 - $DISPLAY is set to start applications on another
1620 display.
1621 - You do not want to connect to the X server in the
1622 console, but do want this in a terminal emulator.
1623 To never connect to the X server use: >
1624 exclude:.*
1625< This has the same effect as using the |-X| argument.
1626 Note that when there is no connection to the X server
1627 the window title won't be restored and the clipboard
1628 cannot be accessed.
1629 The value of 'magic' is ignored, {pattern} is
1630 interpreted as if 'magic' was on.
1631 The rest of the option value will be used for
1632 {pattern}, this must be the last entry.
1633
1634 *'cmdheight'* *'ch'*
1635'cmdheight' 'ch' number (default 1)
1636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 Number of screen lines to use for the command-line. Helps avoiding
1638 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001639 The value of this option is stored with the tab page, so that each tab
1640 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641
1642 *'cmdwinheight'* *'cwh'*
1643'cmdwinheight' 'cwh' number (default 7)
1644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645 Number of screen lines to use for the command-line window. |cmdwin|
1646
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001647 *'colorcolumn'* *'cc'*
1648'colorcolumn' 'cc' string (default "")
1649 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001650 {not available when compiled without the |+syntax|
1651 feature}
1652 'colorcolumn' is a comma separated list of screen columns that are
1653 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1654 text. Will make screen redrawing slower.
1655 The screen column can be an absolute number, or a number preceded with
1656 '+' or '-', which is added to or subtracted from 'textwidth'. >
1657
1658 :set cc=+1 " highlight column after 'textwidth'
1659 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1660 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1661<
1662 When 'textwidth' is zero then the items with '-' and '+' are not used.
1663 A maximum of 256 columns are highlighted.
1664
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 *'columns'* *'co'* *E594*
1666'columns' 'co' number (default 80 or terminal width)
1667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001669 initialization and does not have to be set by hand. Also see
1670 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 When Vim is running in the GUI or in a resizable window, setting this
1672 option will cause the window size to be changed. When you only want
1673 to use the size for the GUI, put the command in your |gvimrc| file.
1674 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001675 number of columns of the display, the display may be messed up. For
1676 the GUI it is always possible and Vim limits the number of columns to
1677 what fits on the screen. You can use this command to get the widest
1678 window possible: >
1679 :set columns=9999
1680< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681
1682 *'comments'* *'com'* *E524* *E525*
1683'comments' 'com' string (default
1684 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1685 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 {not available when compiled without the |+comments|
1687 feature}
1688 A comma separated list of strings that can start a comment line. See
1689 |format-comments|. See |option-backslash| about using backslashes to
1690 insert a space.
1691
1692 *'commentstring'* *'cms'* *E537*
1693'commentstring' 'cms' string (default "/*%s*/")
1694 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695 {not available when compiled without the |+folding|
1696 feature}
1697 A template for a comment. The "%s" in the value is replaced with the
1698 comment text. Currently only used to add markers for folding, see
1699 |fold-marker|.
1700
1701 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001702'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001703 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 This option has the effect of making Vim either more Vi-compatible, or
1706 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001707
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001709 other options are also changed as a side effect.
1710 NOTE: Setting or resetting this option can have a lot of unexpected
1711 effects: Mappings are interpreted in another way, undo behaves
1712 differently, etc. If you set this option in your vimrc file, you
1713 should probably put it at the very start.
1714
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715 By default this option is on and the Vi defaults are used for the
1716 options. This default was chosen for those people who want to use Vim
1717 just like Vi, and don't even (want to) know about the 'compatible'
1718 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001719 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001720 this option is switched off, and all options that have not been
1721 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001722 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001723 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001724 happen for the system-wide vimrc or gvimrc file, nor for a file given
1725 with the |-u| argument). Also see |compatible-default| and
1726 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 You can also set this option with the "-C" argument, and reset it with
1728 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001729 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730
Bram Moolenaar214641f2017-03-05 17:04:09 +01001731 When this option is set, numerous other options are set to make Vim as
1732 Vi-compatible as possible. When this option is unset, various options
1733 are set to make Vim more useful. The table below lists all the
1734 options affected.
1735 The {?} column indicates when the options are affected:
1736 + Means that the option is set to the value given in {set value} when
1737 'compatible' is set.
1738 & Means that the option is set to the value given in {set value} when
1739 'compatible' is set AND is set to its Vim default value when
1740 'compatible' is unset.
1741 - Means the option is NOT changed when setting 'compatible' but IS
1742 set to its Vim default when 'compatible' is unset.
1743 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744
Bram Moolenaar036986f2017-03-16 17:41:02 +01001745 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001746
1747 'allowrevins' + off no CTRL-_ command
1748 'antialias' + off don't use antialiased fonts
1749 'arabic' + off reset arabic-related options
1750 'arabicshape' + on correct character shapes
1751 'backspace' + "" normal backspace
1752 'backup' + off no backup file
1753 'backupcopy' & Unix: "yes" backup file is a copy
1754 else: "auto" copy or rename backup file
1755 'balloonexpr' + "" text to show in evaluation balloon
1756 'breakindent' + off don't indent when wrapping lines
1757 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1758 'cindent' + off no C code indentation
1759 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1760 'copyindent' + off don't copy indent structure
1761 'cpoptions' & (all flags) Vi-compatible flags
1762 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001763 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001764 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001765 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001766 'cscopeverbose' + off see |cscopeverbose|
1767 'delcombine' + off unicode: delete whole char combination
1768 'digraph' + off no digraphs
1769 'esckeys' & off no <Esc>-keys in Insert mode
1770 'expandtab' + off tabs not expanded to spaces
1771 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001773 'formatexpr' + "" use 'formatprg' for auto-formatting
1774 'formatoptions' & "vt" Vi compatible formatting
1775 'gdefault' + off no default 'g' flag for ":s"
1776 'history' & 0 no commandline history
1777 'hkmap' + off no Hebrew keyboard mapping
1778 'hkmapp' + off no phonetic Hebrew keyboard mapping
1779 'hlsearch' + off no highlighting of search matches
1780 'incsearch' + off no incremental searching
1781 'indentexpr' + "" no indenting by expression
1782 'insertmode' + off do not start in Insert mode
1783 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001785 'joinspaces' + on insert 2 spaces after period
1786 'modeline' & off no modelines
1787 'more' & off no pauses in listings
1788 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1789 'numberwidth' & 8 min number of columns for line number
1790 'preserveindent'+ off don't preserve current indent structure
1791 when changing it
1792 'revins' + off no reverse insert
1793 'ruler' + off no ruler
1794 'scrolljump' + 1 no jump scroll
1795 'scrolloff' + 0 no scroll offset
1796 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1797 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001798 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001799 'showcmd' & off command characters not shown
1800 'showmode' & off current mode not shown
1801 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1802 'smartcase' + off no automatic ignore case switch
1803 'smartindent' + off no smart indentation
1804 'smarttab' + off no smart tab size
1805 'softtabstop' + 0 tabs are always 'tabstop' positions
1806 'startofline' + on goto startofline with some commands
1807 'tagcase' & "followic" 'ignorecase' when searching tags file
1808 'tagrelative' & off tag file names are not relative
1809 'termguicolors' + off don't use highlight-(guifg|guibg)
1810 'textauto' & off no automatic textmode detection
1811 'textwidth' + 0 no automatic line wrap
1812 'tildeop' + off tilde is not an operator
1813 'ttimeout' + off no terminal timeout
1814 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001815 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001816 'virtualedit' + "" cursor can only be placed on characters
1817 'whichwrap' & "" left-right movements don't wrap
1818 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001820 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821
1822 *'complete'* *'cpt'* *E535*
1823'complete' 'cpt' string (default: ".,w,b,u,t,i")
1824 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 This option specifies how keyword completion |ins-completion| works
1826 when CTRL-P or CTRL-N are used. It is also used for whole-line
1827 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1828 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001829 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 w scan buffers from other windows
1831 b scan other loaded buffers that are in the buffer list
1832 u scan the unloaded buffers that are in the buffer list
1833 U scan the buffers that are not in the buffer list
1834 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001835 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 k{dict} scan the file {dict}. Several "k" flags can be given,
1837 patterns are valid too. For example: >
1838 :set cpt=k/usr/dict/*,k~/spanish
1839< s scan the files given with the 'thesaurus' option
1840 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1841 are valid too.
1842 i scan current and included files
1843 d scan current and included files for defined name or macro
1844 |i_CTRL-X_CTRL-D|
1845 ] tag completion
1846 t same as "]"
1847
1848 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1849 not executed, this may lead to unexpected completions from some files
1850 (gzipped files for example). Unloaded buffers are not scanned for
1851 whole-line completion.
1852
1853 The default is ".,w,b,u,t,i", which means to scan:
1854 1. the current buffer
1855 2. buffers in other windows
1856 3. other loaded buffers
1857 4. unloaded buffers
1858 5. tags
1859 6. included files
1860
1861 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001862 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1863 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001865 *'completefunc'* *'cfu'*
1866'completefunc' 'cfu' string (default: empty)
1867 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001868 {not available when compiled without the |+eval|
1869 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001870 This option specifies a function to be used for Insert mode completion
1871 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001872 See |complete-functions| for an explanation of how the function is
1873 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001874 This option cannot be set from a |modeline| or in the |sandbox|, for
1875 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001876
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001877 *'completeslash'* *'csl'*
1878'completeslash' 'csl' string (default: "")
1879 local to buffer
1880 {not in Vi} {only for MS-Windows}
1881 When this option is set it overrules 'shellslash' for completion:
1882 - When this option is set to "slash", a forward slash is used for path
1883 completion in insert mode. This is useful when editing HTML tag, or
1884 Makefile with 'noshellslash' on Windows.
1885 - When this option is set to "backslash", backslash is used. This is
1886 useful when editing a batch file with 'shellslash' set on Windows.
1887 - When this option is empty, same character is used as for
1888 'shellslash'.
1889 For Insert mode completion the buffer-local value is used. For
1890 command line completion the global value is used.
1891
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001892 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001893'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001894 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001895 {not available when compiled without the
1896 |+insert_expand| feature}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001897 A comma separated list of options for Insert mode completion
1898 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001899
1900 menu Use a popup menu to show the possible completions. The
1901 menu is only shown when there is more than one match and
1902 sufficient colors are available. |ins-completion-menu|
1903
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001904 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001905 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001906 match, e.g., what file it comes from.
1907
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001908 longest Only insert the longest common text of the matches. If
1909 the menu is displayed you can use CTRL-L to add more
1910 characters. Whether case is ignored depends on the kind
1911 of completion. For buffer text the 'ignorecase' option is
1912 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001913
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001914 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001915 completion in the preview window. Only works in
1916 combination with "menu" or "menuone".
1917
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001918 popup Show extra information about the currently selected
1919 completion in a popup window. Only works in combination
1920 with "menu" or "menuone". Overrides "preview".
1921 {only works when compiled with the +textprop feature}
1922
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001923 noinsert Do not insert any text for a match until the user selects
1924 a match from the menu. Only works in combination with
1925 "menu" or "menuone". No effect if "longest" is present.
1926
1927 noselect Do not select a match in the menu, force the user to
1928 select one from the menu. Only works in combination with
1929 "menu" or "menuone".
1930
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001931
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001932 *'concealcursor'* *'cocu'*
1933'concealcursor' 'cocu' string (default: "")
1934 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001935 {not available when compiled without the |+conceal|
1936 feature}
1937 Sets the modes in which text in the cursor line can also be concealed.
1938 When the current mode is listed then concealing happens just like in
1939 other lines.
1940 n Normal mode
1941 v Visual mode
1942 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001943 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001944
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001945 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001946 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001947 are moving around text is concealed, but when starting to insert text
1948 or selecting a Visual area the concealed text is displayed, so that
1949 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001950 Keep in mind that the cursor position is not always where it's
1951 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001952
1953
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001954 *'conceallevel'* *'cole'*
1955'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001956 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001957 {not available when compiled without the |+conceal|
1958 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001959 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1960 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001961
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001962 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001963 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001964 1 Each block of concealed text is replaced with one
1965 character. If the syntax item does not have a custom
1966 replacement character defined (see |:syn-cchar|) the
1967 character defined in 'listchars' is used (default is a
1968 space).
1969 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001970 2 Concealed text is completely hidden unless it has a
1971 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001972 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001973 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001974
Bram Moolenaara7781e02010-07-19 20:13:22 +02001975 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001976 edit and copy the text. This can be changed with the 'concealcursor'
1977 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001978
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1980'confirm' 'cf' boolean (default off)
1981 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982 When 'confirm' is on, certain operations that would normally
1983 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1984 instead raise a |dialog| asking if you wish to save the current
1985 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1986 If 'confirm' is off you can still activate confirmation for one
1987 command only (this is most useful in mappings) with the |:confirm|
1988 command.
1989 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1990
1991 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1992'conskey' 'consk' boolean (default off)
1993 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01001994 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001995
1996 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1997'copyindent' 'ci' boolean (default off)
1998 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001999 Copy the structure of the existing lines indent when autoindenting a
2000 new line. Normally the new indent is reconstructed by a series of
2001 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2002 in which case only spaces are used). Enabling this option makes the
2003 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002004 existing line. 'expandtab' has no effect on these characters, a Tab
2005 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002007 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008 Also see 'preserveindent'.
2009
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002010 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011'cpoptions' 'cpo' string (Vim default: "aABceFs",
2012 Vi default: all flags)
2013 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002015 this indicates Vi-compatible behavior. This is used for things where
2016 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017 'cpoptions' stands for "compatible-options".
2018 Commas can be added for readability.
2019 To avoid problems with flags that are added in the future, use the
2020 "+=" and "-=" feature of ":set" |add-option-flags|.
2021 NOTE: This option is set to the Vi default value when 'compatible' is
2022 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002023 NOTE: This option is set to the POSIX default value at startup when
2024 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002025 variable exists |posix|. This means Vim tries to behave like the
2026 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027
2028 contains behavior ~
2029 *cpo-a*
2030 a When included, a ":read" command with a file name
2031 argument will set the alternate file name for the
2032 current window.
2033 *cpo-A*
2034 A When included, a ":write" command with a file name
2035 argument will set the alternate file name for the
2036 current window.
2037 *cpo-b*
2038 b "\|" in a ":map" command is recognized as the end of
2039 the map command. The '\' is included in the mapping,
2040 the text after the '|' is interpreted as the next
2041 command. Use a CTRL-V instead of a backslash to
2042 include the '|' in the mapping. Applies to all
2043 mapping, abbreviation, menu and autocmd commands.
2044 See also |map_bar|.
2045 *cpo-B*
2046 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002047 abbreviations, user commands and the "to" part of the
2048 menu commands. Remove this flag to be able to use a
2049 backslash like a CTRL-V. For example, the command
2050 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051 'B' included: "\^[" (^[ is a real <Esc>)
2052 'B' excluded: "<Esc>" (5 characters)
2053 ('<' excluded in both cases)
2054 *cpo-c*
2055 c Searching continues at the end of any match at the
2056 cursor position, but not further than the start of the
2057 next line. When not present searching continues
2058 one character from the cursor position. With 'c'
2059 "abababababab" only gets three matches when repeating
2060 "/abab", without 'c' there are five matches.
2061 *cpo-C*
2062 C Do not concatenate sourced lines that start with a
2063 backslash. See |line-continuation|.
2064 *cpo-d*
2065 d Using "./" in the 'tags' option doesn't mean to use
2066 the tags file relative to the current file, but the
2067 tags file in the current directory.
2068 *cpo-D*
2069 D Can't use CTRL-K to enter a digraph after Normal mode
2070 commands with a character argument, like |r|, |f| and
2071 |t|.
2072 *cpo-e*
2073 e When executing a register with ":@r", always add a
2074 <CR> to the last line, also when the register is not
2075 linewise. If this flag is not present, the register
2076 is not linewise and the last line does not end in a
2077 <CR>, then the last line is put on the command-line
2078 and can be edited before hitting <CR>.
2079 *cpo-E*
2080 E It is an error when using "y", "d", "c", "g~", "gu" or
2081 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002082 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083 This makes "y0" fail in the first column.
2084 *cpo-f*
2085 f When included, a ":read" command with a file name
2086 argument will set the file name for the current buffer,
2087 if the current buffer doesn't have a file name yet.
2088 *cpo-F*
2089 F When included, a ":write" command with a file name
2090 argument will set the file name for the current
2091 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002092 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093 *cpo-g*
2094 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002095 *cpo-H*
2096 H When using "I" on a line with only blanks, insert
2097 before the last blank. Without this flag insert after
2098 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099 *cpo-i*
2100 i When included, interrupting the reading of a file will
2101 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002102 *cpo-I*
2103 I When moving the cursor up or down just after inserting
2104 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 *cpo-j*
2106 j When joining lines, only add two spaces after a '.',
2107 not after '!' or '?'. Also see 'joinspaces'.
2108 *cpo-J*
2109 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002110 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111 white space.
2112 *cpo-k*
2113 k Disable the recognition of raw key codes in
2114 mappings, abbreviations, and the "to" part of menu
2115 commands. For example, if <Key> sends ^[OA (where ^[
2116 is <Esc>), the command ":map X ^[OA" results in X
2117 being mapped to:
2118 'k' included: "^[OA" (3 characters)
2119 'k' excluded: "<Key>" (one key code)
2120 Also see the '<' flag below.
2121 *cpo-K*
2122 K Don't wait for a key code to complete when it is
2123 halfway a mapping. This breaks mapping <F1><F1> when
2124 only part of the second <F1> has been read. It
2125 enables cancelling the mapping by typing <F1><Esc>.
2126 *cpo-l*
2127 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002128 literally, only "\]", "\^", "\-" and "\\" are special.
2129 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2131 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002132 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 *cpo-L*
2134 L When the 'list' option is set, 'wrapmargin',
2135 'textwidth', 'softtabstop' and Virtual Replace mode
2136 (see |gR|) count a <Tab> as two characters, instead of
2137 the normal behavior of a <Tab>.
2138 *cpo-m*
2139 m When included, a showmatch will always wait half a
2140 second. When not included, a showmatch will wait half
2141 a second or until a character is typed. |'showmatch'|
2142 *cpo-M*
2143 M When excluded, "%" matching will take backslashes into
2144 account. Thus in "( \( )" and "\( ( \)" the outer
2145 parenthesis match. When included "%" ignores
2146 backslashes, which is Vi compatible.
2147 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002148 n When included, the column used for 'number' and
2149 'relativenumber' will also be used for text of wrapped
2150 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151 *cpo-o*
2152 o Line offset to search command is not remembered for
2153 next search.
2154 *cpo-O*
2155 O Don't complain if a file is being overwritten, even
2156 when it didn't exist when editing it. This is a
2157 protection against a file unexpectedly created by
2158 someone else. Vi didn't complain about this.
2159 *cpo-p*
2160 p Vi compatible Lisp indenting. When not present, a
2161 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002162 *cpo-P*
2163 P When included, a ":write" command that appends to a
2164 file will set the file name for the current buffer, if
2165 the current buffer doesn't have a file name yet and
2166 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002167 *cpo-q*
2168 q When joining multiple lines leave the cursor at the
2169 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170 *cpo-r*
2171 r Redo ("." command) uses "/" to repeat a search
2172 command, instead of the actually used search string.
2173 *cpo-R*
2174 R Remove marks from filtered lines. Without this flag
2175 marks are kept like |:keepmarks| was used.
2176 *cpo-s*
2177 s Set buffer options when entering the buffer for the
2178 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002179 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180 set when the buffer is created.
2181 *cpo-S*
2182 S Set buffer options always when entering a buffer
2183 (except 'readonly', 'fileformat', 'filetype' and
2184 'syntax'). This is the (most) Vi compatible setting.
2185 The options are set to the values in the current
2186 buffer. When you change an option and go to another
2187 buffer, the value is copied. Effectively makes the
2188 buffer options global to all buffers.
2189
2190 's' 'S' copy buffer options
2191 no no when buffer created
2192 yes no when buffer first entered (default)
2193 X yes each time when buffer entered (vi comp.)
2194 *cpo-t*
2195 t Search pattern for the tag command is remembered for
2196 "n" command. Otherwise Vim only puts the pattern in
2197 the history for search pattern, but doesn't change the
2198 last used search pattern.
2199 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002200 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 *cpo-v*
2202 v Backspaced characters remain visible on the screen in
2203 Insert mode. Without this flag the characters are
2204 erased from the screen right away. With this flag the
2205 screen newly typed text overwrites backspaced
2206 characters.
2207 *cpo-w*
2208 w When using "cw" on a blank character, only change one
2209 character and not all blanks until the start of the
2210 next word.
2211 *cpo-W*
2212 W Don't overwrite a readonly file. When omitted, ":w!"
2213 overwrites a readonly file, if possible.
2214 *cpo-x*
2215 x <Esc> on the command-line executes the command-line.
2216 The default in Vim is to abandon the command-line,
2217 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002218 *cpo-X*
2219 X When using a count with "R" the replaced text is
2220 deleted only once. Also when repeating "R" with "."
2221 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002222 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002223 y A yank command can be redone with ".". Think twice if
2224 you really want to use this, it may break some
2225 plugins, since most people expect "." to only repeat a
2226 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002227 *cpo-Z*
2228 Z When using "w!" while the 'readonly' option is set,
2229 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 *cpo-!*
2231 ! When redoing a filter command, use the last used
2232 external command, whatever it was. Otherwise the last
2233 used -filter- command is used.
2234 *cpo-$*
2235 $ When making a change to one line, don't redisplay the
2236 line, but put a '$' at the end of the changed text.
2237 The changed text will be overwritten when you type the
2238 new text. The line is redisplayed if you type any
2239 command that moves the cursor from the insertion
2240 point.
2241 *cpo-%*
2242 % Vi-compatible matching is done for the "%" command.
2243 Does not recognize "#if", "#endif", etc.
2244 Does not recognize "/*" and "*/".
2245 Parens inside single and double quotes are also
2246 counted, causing a string that contains a paren to
2247 disturb the matching. For example, in a line like
2248 "if (strcmp("foo(", s))" the first paren does not
2249 match the last one. When this flag is not included,
2250 parens inside single and double quotes are treated
2251 specially. When matching a paren outside of quotes,
2252 everything inside quotes is ignored. When matching a
2253 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002254 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002255 This flag is also used for other features, such as
2256 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002257 *cpo--*
2258 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002259 it would go above the first line or below the last
2260 line. Without it the cursor moves to the first or
2261 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002262 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002263 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002264 *cpo-+*
2265 + When included, a ":write file" command will reset the
2266 'modified' flag of the buffer, even though the buffer
2267 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002268 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002269 * Use ":*" in the same way as ":@". When not included,
2270 ":*" is an alias for ":'<,'>", select the Visual area.
2271 *cpo-<*
2272 < Disable the recognition of special key codes in |<>|
2273 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002274 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 ":map X <Tab>" results in X being mapped to:
2276 '<' included: "<Tab>" (5 characters)
2277 '<' excluded: "^I" (^I is a real <Tab>)
2278 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002279 *cpo->*
2280 > When appending to a register, put a line break before
2281 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002282 *cpo-;*
2283 ; When using |,| or |;| to repeat the last |t| search
2284 and the cursor is right in front of the searched
2285 character, the cursor won't move. When not included,
2286 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002287 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002288
2289 POSIX flags. These are not included in the Vi default value, except
2290 when $VIM_POSIX was set on startup. |posix|
2291
2292 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002293 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002294 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002295 *cpo-&*
2296 & When ":preserve" was used keep the swap file when
2297 exiting normally while this buffer is still loaded.
2298 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002299 *cpo-\*
2300 \ Backslash in a [] range in a search pattern is taken
2301 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002302 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2303 '\' excluded: "/[ \-]" finds <Space> and '-'
2304 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002305 *cpo-/*
2306 / When "%" is used as the replacement string in a |:s|
2307 command, use the previous replacement string. |:s%|
2308 *cpo-{*
2309 { The |{| and |}| commands also stop at a "{" character
2310 at the start of a line.
2311 *cpo-.*
2312 . The ":chdir" and ":cd" commands fail if the current
2313 buffer is modified, unless ! is used. Vim doesn't
2314 need this, since it remembers the full path of an
2315 opened file.
2316 *cpo-bar*
2317 | The value of the $LINES and $COLUMNS environment
2318 variables overrule the terminal size values obtained
2319 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002320
Bram Moolenaar071d4272004-06-13 20:20:40 +00002321
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002322 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002323'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002324 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002325 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002326 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002327 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002328 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002329 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002330 blowfish Blowfish method. Medium strong encryption but it has
2331 an implementation flaw. Requires Vim 7.3 or later,
2332 files can NOT be read by Vim 7.2 and older. This adds
2333 a "seed" to the file, every time you write the file
2334 the encrypted bytes will be different.
2335 *blowfish2*
2336 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002337 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002338 and older. This adds a "seed" to the file, every time
2339 you write the file the encrypted bytes will be
2340 different. The whole undo file is encrypted, not just
2341 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002342
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002343 You should use "blowfish2", also to re-encrypt older files.
2344
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002345 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002346 to the detected method of the file being read. Thus if you write it
2347 without changing 'cryptmethod' the same method will be used.
2348 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002349 explicitly write it, you don't get a warning unless there are other
2350 modifications. Also see |:X|.
2351
2352 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002353 the value "blowfish2". When setting the local value to an empty
2354 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002355
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002356 When a new encryption method is added in a later version of Vim, and
2357 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002358 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002359
2360
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361 *'cscopepathcomp'* *'cspc'*
2362'cscopepathcomp' 'cspc' number (default 0)
2363 global
2364 {not available when compiled without the |+cscope|
2365 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366 Determines how many components of the path to show in a list of tags.
2367 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002368 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369
2370 *'cscopeprg'* *'csprg'*
2371'cscopeprg' 'csprg' string (default "cscope")
2372 global
2373 {not available when compiled without the |+cscope|
2374 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002375 Specifies the command to execute cscope. See |cscopeprg|.
2376 This option cannot be set from a |modeline| or in the |sandbox|, for
2377 security reasons.
2378
2379 *'cscopequickfix'* *'csqf'*
2380'cscopequickfix' 'csqf' string (default "")
2381 global
2382 {not available when compiled without the |+cscope|
2383 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384 Specifies whether to use quickfix window to show cscope results.
2385 See |cscopequickfix|.
2386
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002387 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002388'cscoperelative' 'csre' boolean (default off)
2389 global
2390 {not available when compiled without the |+cscope|
2391 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002392 In the absence of a prefix (-P) for cscope. setting this option enables
2393 to use the basename of cscope.out path as the prefix.
2394 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002395 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002396
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2398'cscopetag' 'cst' boolean (default off)
2399 global
2400 {not available when compiled without the |+cscope|
2401 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 Use cscope for tag commands. See |cscope-options|.
2403 NOTE: This option is reset when 'compatible' is set.
2404
2405 *'cscopetagorder'* *'csto'*
2406'cscopetagorder' 'csto' number (default 0)
2407 global
2408 {not available when compiled without the |+cscope|
2409 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 Determines the order in which ":cstag" performs a search. See
2411 |cscopetagorder|.
2412 NOTE: This option is set to 0 when 'compatible' is set.
2413
2414 *'cscopeverbose'* *'csverb'*
2415 *'nocscopeverbose'* *'nocsverb'*
2416'cscopeverbose' 'csverb' boolean (default off)
2417 global
2418 {not available when compiled without the |+cscope|
2419 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420 Give messages when adding a cscope database. See |cscopeverbose|.
2421 NOTE: This option is reset when 'compatible' is set.
2422
Bram Moolenaar860cae12010-06-05 23:22:07 +02002423 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2424'cursorbind' 'crb' boolean (default off)
2425 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002426 When this option is set, as the cursor in the current
2427 window moves other cursorbound windows (windows that also have
2428 this option set) move their cursors to the corresponding line and
2429 column. This option is useful for viewing the
2430 differences between two versions of a file (see 'diff'); in diff mode,
2431 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002432 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002433
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002434
2435 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2436'cursorcolumn' 'cuc' boolean (default off)
2437 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002438 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002439 feature}
2440 Highlight the screen column of the cursor with CursorColumn
2441 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2442 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002443 If you only want the highlighting in the current window you can use
2444 these autocommands: >
2445 au WinLeave * set nocursorline nocursorcolumn
2446 au WinEnter * set cursorline cursorcolumn
2447<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002448
2449 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2450'cursorline' 'cul' boolean (default off)
2451 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002452 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002453 feature}
2454 Highlight the screen line of the cursor with CursorLine
2455 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2456 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002457 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002458 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002459
2460
Bram Moolenaar071d4272004-06-13 20:20:40 +00002461 *'debug'*
2462'debug' string (default "")
2463 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002464 These values can be used:
2465 msg Error messages that would otherwise be omitted will be given
2466 anyway.
2467 throw Error messages that would otherwise be omitted will be given
2468 anyway and also throw an exception and set |v:errmsg|.
2469 beep A message will be given when otherwise only a beep would be
2470 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002471 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002472 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2473 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474
2475 *'define'* *'def'*
2476'define' 'def' string (default "^\s*#\s*define")
2477 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002478 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 pattern, just like for the "/" command. This option is used for the
2480 commands like "[i" and "[d" |include-search|. The 'isident' option is
2481 used to recognize the defined name after the match:
2482 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2483 See |option-backslash| about inserting backslashes to include a space
2484 or backslash.
2485 The default value is for C programs. For C++ this value would be
2486 useful, to include const type declarations: >
2487 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002488< You can also use "\ze" just before the name and continue the pattern
2489 to check what is following. E.g. for Javascript, if a function is
2490 defined with "func_name = function(args)": >
2491 ^\s*\ze\i\+\s*=\s*function(
2492< If the function is defined with "func_name : function() {...": >
2493 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002494< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002495 To avoid that use `:let` with a single quote string: >
2496 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002497<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498
2499 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2500'delcombine' 'deco' boolean (default off)
2501 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502 If editing Unicode and this option is set, backspace and Normal mode
2503 "x" delete each combining character on its own. When it is off (the
2504 default) the character along with its combining characters are
2505 deleted.
2506 Note: When 'delcombine' is set "xx" may work different from "2x"!
2507
2508 This is useful for Arabic, Hebrew and many other languages where one
2509 may have combining characters overtop of base characters, and want
2510 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002511 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002512
2513 *'dictionary'* *'dict'*
2514'dictionary' 'dict' string (default "")
2515 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 List of file names, separated by commas, that are used to lookup words
2517 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2518 contain a list of words. This can be one word per line, or several
2519 words per line, separated by non-keyword characters (white space is
2520 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002521
2522 When this option is empty or an entry "spell" is present, and spell
2523 checking is enabled, words in the word lists for the currently active
2524 'spelllang' are used. See |spell|.
2525
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002526 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527 after a comma are ignored, otherwise spaces are included in the file
2528 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002529 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530 Where to find a list of words?
2531 - On FreeBSD, there is the file "/usr/share/dict/words".
2532 - In the Simtel archive, look in the "msdos/linguist" directory.
2533 - In "miscfiles" of the GNU collection.
2534 The use of |:set+=| and |:set-=| is preferred when adding or removing
2535 directories from the list. This avoids problems when a future version
2536 uses another default.
2537 Backticks cannot be used in this option for security reasons.
2538
2539 *'diff'* *'nodiff'*
2540'diff' boolean (default off)
2541 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 {not available when compiled without the |+diff|
2543 feature}
2544 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002545 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002546
2547 *'dex'* *'diffexpr'*
2548'diffexpr' 'dex' string (default "")
2549 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 {not available when compiled without the |+diff|
2551 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002552 Expression which is evaluated to obtain a diff file (either ed-style
2553 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002554 This option cannot be set from a |modeline| or in the |sandbox|, for
2555 security reasons.
2556
2557 *'dip'* *'diffopt'*
Bram Moolenaarc93262b2018-09-10 21:15:40 +02002558'diffopt' 'dip' string (default "internal,filler")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002559 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560 {not available when compiled without the |+diff|
2561 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002562 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 All are optional. Items must be separated by a comma.
2564
2565 filler Show filler lines, to keep the text
2566 synchronized with a window that has inserted
2567 lines at the same position. Mostly useful
2568 when windows are side-by-side and 'scrollbind'
2569 is set.
2570
2571 context:{n} Use a context of {n} lines between a change
2572 and a fold that contains unchanged lines.
2573 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002574 When using zero the context is actually one,
2575 since folds require a line in between, also
2576 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 See |fold-diff|.
2578
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002579 iblank Ignore changes where lines are all blank. Adds
2580 the "-B" flag to the "diff" command if
2581 'diffexpr' is empty. Check the documentation
2582 of the "diff" command for what this does
2583 exactly.
2584 NOTE: the diff windows will get out of sync,
2585 because no differences between blank lines are
2586 taken into account.
2587
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 icase Ignore changes in case of text. "a" and "A"
2589 are considered the same. Adds the "-i" flag
2590 to the "diff" command if 'diffexpr' is empty.
2591
2592 iwhite Ignore changes in amount of white space. Adds
2593 the "-b" flag to the "diff" command if
2594 'diffexpr' is empty. Check the documentation
2595 of the "diff" command for what this does
2596 exactly. It should ignore adding trailing
2597 white space, but not leading white space.
2598
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002599 iwhiteall Ignore all white space changes. Adds
2600 the "-w" flag to the "diff" command if
2601 'diffexpr' is empty. Check the documentation
2602 of the "diff" command for what this does
2603 exactly.
2604
2605 iwhiteeol Ignore white space changes at end of line.
2606 Adds the "-Z" flag to the "diff" command if
2607 'diffexpr' is empty. Check the documentation
2608 of the "diff" command for what this does
2609 exactly.
2610
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002611 horizontal Start diff mode with horizontal splits (unless
2612 explicitly specified otherwise).
2613
2614 vertical Start diff mode with vertical splits (unless
2615 explicitly specified otherwise).
2616
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002617 hiddenoff Do not use diff mode for a buffer when it
2618 becomes hidden.
2619
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002620 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2621 starting diff mode. Without this 2 is used.
2622
Bram Moolenaare828b762018-09-10 17:51:58 +02002623 internal Use the internal diff library. This is
2624 ignored when 'diffexpr' is set. *E960*
2625 When running out of memory when writing a
2626 buffer this item will be ignored for diffs
2627 involving that buffer. Set the 'verbose'
2628 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629
Bram Moolenaare828b762018-09-10 17:51:58 +02002630 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002631 Use the indent heuristic for the internal
2632 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002633
2634 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002635 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002636 algorithms are:
2637 myers the default algorithm
2638 minimal spend extra time to generate the
2639 smallest possible diff
2640 patience patience diff algorithm
2641 histogram histogram diff algorithm
2642
2643 Examples: >
2644 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002646 :set diffopt=internal,filler,foldcolumn:3
2647 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648<
2649 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2650'digraph' 'dg' boolean (default off)
2651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 {not available when compiled without the |+digraphs|
2653 feature}
2654 Enable the entering of digraphs in Insert mode with {char1} <BS>
2655 {char2}. See |digraphs|.
2656 NOTE: This option is reset when 'compatible' is set.
2657
2658 *'directory'* *'dir'*
2659'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002660 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 for Unix: ".,~/tmp,/var/tmp,/tmp")
2662 global
2663 List of directory names for the swap file, separated with commas.
2664 - The swap file will be created in the first directory where this is
2665 possible.
2666 - Empty means that no swap file will be used (recovery is
2667 impossible!).
2668 - A directory "." means to put the swap file in the same directory as
2669 the edited file. On Unix, a dot is prepended to the file name, so
2670 it doesn't show in a directory listing. On MS-Windows the "hidden"
2671 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002672 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673 put the swap file relative to where the edited file is. The leading
2674 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002675 - For Unix and Win32, if a directory ends in two path separators "//",
2676 the swap file name will be built from the complete path to the file
2677 with all path separators substituted to percent '%' signs. This will
2678 ensure file name uniqueness in the preserve directory.
2679 On Win32, it is also possible to end with "\\". However, When a
2680 separating comma is following, you must use "//", since "\\" will
2681 include the comma in the file name. Therefore it is recommended to
2682 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 - Spaces after the comma are ignored, other spaces are considered part
2684 of the directory name. To have a space at the start of a directory
2685 name, precede it with a backslash.
2686 - To include a comma in a directory name precede it with a backslash.
2687 - A directory name may end in an ':' or '/'.
2688 - Environment variables are expanded |:set_env|.
2689 - Careful with '\' characters, type one before a space, type two to
2690 get one in the option (see |option-backslash|), for example: >
2691 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2692< - For backwards compatibility with Vim version 3.0 a '>' at the start
2693 of the option is removed.
2694 Using "." first in the list is recommended. This means that editing
2695 the same file twice will result in a warning. Using "/tmp" on Unix is
2696 discouraged: When the system crashes you lose the swap file.
2697 "/var/tmp" is often not cleared when rebooting, thus is a better
2698 choice than "/tmp". But it can contain a lot of files, your swap
2699 files get lost in the crowd. That is why a "tmp" directory in your
2700 home directory is tried first.
2701 The use of |:set+=| and |:set-=| is preferred when adding or removing
2702 directories from the list. This avoids problems when a future version
2703 uses another default.
2704 This option cannot be set from a |modeline| or in the |sandbox|, for
2705 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706
2707 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002708'display' 'dy' string (default "", set to "truncate" in
2709 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 Change the way text is displayed. This is comma separated list of
2712 flags:
2713 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002714 in a window will be displayed. "@@@" is put in the
2715 last columns of the last screen line to indicate the
2716 rest of the line is not displayed.
2717 truncate Like "lastline", but "@@@" is displayed in the first
2718 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002719 uhex Show unprintable characters hexadecimal as <xx>
2720 instead of using ^C and ~C.
2721
Bram Moolenaard0796902016-09-16 20:02:31 +02002722 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002723 doesn't fit is replaced with "@" lines.
2724
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 *'eadirection'* *'ead'*
2726'eadirection' 'ead' string (default "both")
2727 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728 Tells when the 'equalalways' option applies:
2729 ver vertically, width of windows is not affected
2730 hor horizontally, height of windows is not affected
2731 both width and height of windows is affected
2732
2733 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2734'edcompatible' 'ed' boolean (default off)
2735 global
2736 Makes the 'g' and 'c' flags of the ":substitute" command to be
2737 toggled each time the flag is given. See |complex-change|. See
2738 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002739 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740
Bram Moolenaar03413f42016-04-12 21:07:15 +02002741 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002742'emoji' 'emo' boolean (default: on)
2743 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002744 When on all Unicode emoji characters are considered to be full width.
2745
2746
Bram Moolenaar071d4272004-06-13 20:20:40 +00002747 *'encoding'* *'enc'* *E543*
2748'encoding' 'enc' string (default: "latin1" or value from $LANG)
2749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 Sets the character encoding used inside Vim. It applies to text in
2751 the buffers, registers, Strings in expressions, text stored in the
2752 viminfo file, etc. It sets the kind of characters which Vim can work
2753 with. See |encoding-names| for the possible values.
2754
2755 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002756 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002758 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759
Bram Moolenaar865242e2010-07-14 21:12:05 +02002760 This option cannot be set from a |modeline|. It would most likely
2761 corrupt the text.
2762
Bram Moolenaar3df01732017-02-17 22:47:16 +01002763 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2764 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 'encoding', "utf-8" is the natural choice for the environment and
2766 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002767 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 versions, and to avoid changing the encoding of newly created files
2769 without your knowledge (in case 'fileencodings' is empty).
2770
2771 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002772 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 iconv() or as specified with 'charconvert'.
2774
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002775 If you need to know whether 'encoding' is a multi-byte encoding, you
2776 can use: >
2777 if has("multi_byte_encoding")
2778<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779 Normally 'encoding' will be equal to your current locale. This will
2780 be the default if Vim recognizes your environment settings. If
2781 'encoding' is not set to the current locale, 'termencoding' must be
2782 set to convert typed and displayed text. See |encoding-table|.
2783
2784 When you set this option, it fires the |EncodingChanged| autocommand
2785 event so that you can set up fonts if necessary.
2786
2787 When the option is set, the value is converted to lowercase. Thus
2788 you can set it with uppercase values too. Underscores are translated
2789 to '-' signs.
2790 When the encoding is recognized, it is changed to the standard name.
2791 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2792 "iso-8859-2" and "utf8" becomes "utf-8".
2793
2794 Note: "latin1" is also used when the encoding could not be detected.
2795 This only works when editing files in the same encoding! When the
2796 actual character set is not latin1, make sure 'fileencoding' and
2797 'fileencodings' are empty. When conversion is needed, switch to using
2798 utf-8.
2799
2800 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2801 You don't notice this while editing, but it does matter for the
2802 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2803 setting 'encoding' to one of these values instead of utf-8 only has
2804 effect for encoding used for files when 'fileencoding' is empty.
2805
Bram Moolenaar661b1822005-07-28 22:36:45 +00002806 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2807 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808
2809 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2810'endofline' 'eol' boolean (default on)
2811 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002813 is on, or 'fixeol' option is off, no <EOL> will be written for the
2814 last line in the file. This option is automatically set or reset when
2815 starting to edit a new file, depending on whether file has an <EOL>
2816 for the last line in the file. Normally you don't have to set or
2817 reset this option.
2818 When 'binary' is off and 'fixeol' is on the value is not used when
2819 writing the file. When 'binary' is on or 'fixeol' is off it is used
2820 to remember the presence of a <EOL> for the last line in the file, so
2821 that when you write the file the situation from the original file can
2822 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823
2824 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2825'equalalways' 'ea' boolean (default on)
2826 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002828 splitting or closing a window. This also happens the moment the
2829 option is switched on. When off, splitting a window will reduce the
2830 size of the current window and leave the other windows the same. When
2831 closing a window the extra lines are given to the window next to it
2832 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 When mixing vertically and horizontally split windows, a minimal size
2834 is computed and some windows may be larger if there is room. The
2835 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002836 Changing the height and width of a window can be avoided by setting
2837 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002838 If a window size is specified when creating a new window sizes are
2839 currently not equalized (it's complicated, but may be implemented in
2840 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841
2842 *'equalprg'* *'ep'*
2843'equalprg' 'ep' string (default "")
2844 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002846 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002847 or 'indentexpr'. When Vim was compiled without internal formatting,
2848 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002849 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850 about including spaces and backslashes.
2851 This option cannot be set from a |modeline| or in the |sandbox|, for
2852 security reasons.
2853
2854 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2855'errorbells' 'eb' boolean (default off)
2856 global
2857 Ring the bell (beep or screen flash) for error messages. This only
2858 makes a difference for error messages, the bell will be used always
2859 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002860 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002861 screen flash or do nothing. See 'belloff' to finetune when to ring the
2862 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002863
2864 *'errorfile'* *'ef'*
2865'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2866 others: "errors.err")
2867 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 {not available when compiled without the |+quickfix|
2869 feature}
2870 Name of the errorfile for the QuickFix mode (see |:cf|).
2871 When the "-q" command-line argument is used, 'errorfile' is set to the
2872 following argument. See |-q|.
2873 NOT used for the ":make" command. See 'makeef' for that.
2874 Environment variables are expanded |:set_env|.
2875 See |option-backslash| about including spaces and backslashes.
2876 This option cannot be set from a |modeline| or in the |sandbox|, for
2877 security reasons.
2878
2879 *'errorformat'* *'efm'*
2880'errorformat' 'efm' string (default is very long)
2881 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 {not available when compiled without the |+quickfix|
2883 feature}
2884 Scanf-like description of the format for the lines in the error file
2885 (see |errorformat|).
2886
2887 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2888'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2889 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 Function keys that start with an <Esc> are recognized in Insert
2891 mode. When this option is off, the cursor and function keys cannot be
2892 used in Insert mode if they start with an <Esc>. The advantage of
2893 this is that the single <Esc> is recognized immediately, instead of
2894 after one second. Instead of resetting this option, you might want to
2895 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2896 when 'esckeys' is off, you can still map anything, but the cursor keys
2897 won't work by default.
2898 NOTE: This option is set to the Vi default value when 'compatible' is
2899 set and to the Vim default value when 'compatible' is reset.
2900
2901 *'eventignore'* *'ei'*
2902'eventignore' 'ei' string (default "")
2903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002905 When set to "all" or when "all" is one of the items, all autocommand
2906 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907 Otherwise this is a comma separated list of event names. Example: >
2908 :set ei=WinEnter,WinLeave
2909<
2910 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2911'expandtab' 'et' boolean (default off)
2912 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002914 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2916 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002917 This option is reset when the 'paste' option is set and restored when
2918 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 NOTE: This option is reset when 'compatible' is set.
2920
2921 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2922'exrc' 'ex' boolean (default off)
2923 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002925 directory.
2926
2927 Setting this option is a potential security leak. E.g., consider
2928 unpacking a package or fetching files from github, a .vimrc in there
2929 might be a trojan horse. BETTER NOT SET THIS OPTION!
2930 Instead, define an autocommand in your .vimrc to set options for a
2931 matching directory.
2932
2933 If you do switch this option on you should also consider setting the
2934 'secure' option (see |initialization|).
2935 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 This option cannot be set from a |modeline| or in the |sandbox|, for
2937 security reasons.
2938
2939 *'fileencoding'* *'fenc'* *E213*
2940'fileencoding' 'fenc' string (default: "")
2941 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002943
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002945 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 When 'fileencoding' is empty, the same value as 'encoding' will be
2947 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002948 No error will be given when the value is set, only when it is used,
2949 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002950 Conversion will also be done when 'encoding' and 'fileencoding' are
2951 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2952 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002954 'encoding' is "utf-8" or another Unicode encoding, conversion
2955 is most likely done in a way that the reverse conversion
2956 results in the same text. When 'encoding' is not "utf-8" some
2957 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002958
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 See 'encoding' for the possible values. Additionally, values may be
2960 specified that can be handled by the converter, see
2961 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002962
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 When reading a file 'fileencoding' will be set from 'fileencodings'.
2964 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002965 'fileencoding', use the |++enc| argument. One exception: when
2966 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002967 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002968
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2970 When the option is set, the value is converted to lowercase. Thus
2971 you can set it with uppercase values too. '_' characters are
2972 replaced with '-'. If a name is recognized from the list for
2973 'encoding', it is replaced by the standard name. For example
2974 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002975
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 When this option is set, after starting to edit a file, the 'modified'
2977 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002978
2979 Keep in mind that changing 'fenc' from a modeline happens
2980 AFTER the text has been read, thus it applies to when the file will be
2981 written. If you do set 'fenc' in a modeline, you might want to set
2982 'nomodified' to avoid not being able to ":q".
2983
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 This option can not be changed when 'modifiable' is off.
2985
2986 *'fe'*
2987 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002988 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 old short name was 'fe', which is no longer used.
2990
2991 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002992'fileencodings' 'fencs' string (default: "ucs-bom",
2993 "ucs-bom,utf-8,default,latin1" when
2994 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 This is a list of character encodings considered when starting to edit
2997 an existing file. When a file is read, Vim tries to use the first
2998 mentioned character encoding. If an error is detected, the next one
2999 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003000 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 an empty string, which means the value of 'encoding' is used.
3002 WARNING: Conversion can cause loss of information! When
3003 'encoding' is "utf-8" (or one of the other Unicode variants)
3004 conversion is most likely done in a way that the reverse
3005 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003006 "utf-8" some non-ASCII characters may be lost! You can use
3007 the |++bad| argument to specify what is done with characters
3008 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 For an empty file or a file with only ASCII characters most encodings
3010 will work and the first entry of 'fileencodings' will be used (except
3011 "ucs-bom", which requires the BOM to be present). If you prefer
3012 another encoding use an BufReadPost autocommand event to test if your
3013 preferred encoding is to be used. Example: >
3014 au BufReadPost * if search('\S', 'w') == 0 |
3015 \ set fenc=iso-2022-jp | endif
3016< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3017 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003018 When the |++enc| argument is used then the value of 'fileencodings' is
3019 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003020 Note that 'fileencodings' is not used for a new file, the global value
3021 of 'fileencoding' is used instead. You can set it with: >
3022 :setglobal fenc=iso-8859-2
3023< This means that a non-existing file may get a different encoding than
3024 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 The special value "ucs-bom" can be used to check for a Unicode BOM
3026 (Byte Order Mark) at the start of the file. It must not be preceded
3027 by "utf-8" or another Unicode encoding for this to work properly.
3028 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3029 because Vim cannot detect an error, thus the encoding is always
3030 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003031 The special value "default" can be used for the encoding from the
3032 environment. This is the default value for 'encoding'. It is useful
3033 when 'encoding' is set to "utf-8" and your environment uses a
3034 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003035 When 'encoding' is "utf-8" and a file contains an illegal byte
3036 sequence it won't be recognized as UTF-8. You can use the |8g8|
3037 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 WRONG VALUES: WHAT'S WRONG:
3039 latin1,utf-8 "latin1" will always be used
3040 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3041 file
3042 cp1250,latin1 "cp1250" will always be used
3043 If 'fileencodings' is empty, 'fileencoding' is not modified.
3044 See 'fileencoding' for the possible values.
3045 Setting this option does not have an effect until the next time a file
3046 is read.
3047
3048 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003049'fileformat' 'ff' string (MS-Windows default: "dos",
3050 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 This gives the <EOL> of the current buffer, which is used for
3053 reading/writing the buffer from/to a file:
3054 dos <CR> <NL>
3055 unix <NL>
3056 mac <CR>
3057 When "dos" is used, CTRL-Z at the end of a file is ignored.
3058 See |file-formats| and |file-read|.
3059 For the character encoding of the file see 'fileencoding'.
3060 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003061 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 This option is set automatically when starting to edit a file and
3063 'fileformats' is not empty and 'binary' is off.
3064 When this option is set, after starting to edit a file, the 'modified'
3065 option is set, because the file would be different when written.
3066 This option can not be changed when 'modifiable' is off.
3067 For backwards compatibility: When this option is set to "dos",
3068 'textmode' is set, otherwise 'textmode' is reset.
3069
3070 *'fileformats'* *'ffs'*
3071'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003072 Vim+Vi MS-Windows: "dos,unix",
3073 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 Vi Cygwin: "unix,dos",
3075 Vi others: "")
3076 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077 This gives the end-of-line (<EOL>) formats that will be tried when
3078 starting to edit a new buffer and when reading a file into an existing
3079 buffer:
3080 - When empty, the format defined with 'fileformat' will be used
3081 always. It is not set automatically.
3082 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003083 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 'fileformats' name will be used when a file is read into an existing
3085 buffer, no matter what 'fileformat' for that buffer is set to.
3086 - When more than one name is present, separated by commas, automatic
3087 <EOL> detection will be done when reading a file. When starting to
3088 edit a file, a check is done for the <EOL>:
3089 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3090 'fileformat' is set to "dos".
3091 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003092 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003094 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3095 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003096 This means that "mac" is only chosen when:
3097 "unix" is not present or no <NL> is found in the file, and
3098 "dos" is not present or no <CR><NL> is found in the file.
3099 Except: if "unix" was chosen, but there is a <CR> before
3100 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003101 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 4. If 'fileformat' is still not set, the first name from
3103 'fileformats' is used.
3104 When reading a file into an existing buffer, the same is done, but
3105 this happens like 'fileformat' has been set appropriately for that
3106 file only, the option is not changed.
3107 When 'binary' is set, the value of 'fileformats' is not used.
3108
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003109 When Vim starts up with an empty buffer the first item is used. You
3110 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003111
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3113 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3114 done:
3115 - When 'fileformats' is empty, there is no automatic detection. Dos
3116 format will be used.
3117 - When 'fileformats' is set to one or more names, automatic detection
3118 is done. This is based on the first <NL> in the file: If there is a
3119 <CR> in front of it, Dos format is used, otherwise Unix format is
3120 used.
3121 Also see |file-formats|.
3122 For backwards compatibility: When this option is set to an empty
3123 string or one format (no comma is included), 'textauto' is reset,
3124 otherwise 'textauto' is set.
3125 NOTE: This option is set to the Vi default value when 'compatible' is
3126 set and to the Vim default value when 'compatible' is reset.
3127
Bram Moolenaarbf884932013-04-05 22:26:15 +02003128 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3129'fileignorecase' 'fic' boolean (default on for systems where case in file
3130 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003131 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003132 When set case is ignored when using file names and directories.
3133 See 'wildignorecase' for only ignoring case when doing completion.
3134
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 *'filetype'* *'ft'*
3136'filetype' 'ft' string (default: "")
3137 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 When this option is set, the FileType autocommand event is triggered.
3139 All autocommands that match with the value of this option will be
3140 executed. Thus the value of 'filetype' is used in place of the file
3141 name.
3142 Otherwise this option does not always reflect the current file type.
3143 This option is normally set when the file type is detected. To enable
3144 this use the ":filetype on" command. |:filetype|
3145 Setting this option to a different value is most useful in a modeline,
3146 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003147 Example, for in an IDL file:
3148 /* vim: set filetype=idl : */ ~
3149 |FileType| |filetypes|
3150 When a dot appears in the value then this separates two filetype
3151 names. Example:
3152 /* vim: set filetype=c.doxygen : */ ~
3153 This will use the "c" filetype first, then the "doxygen" filetype.
3154 This works both for filetype plugins and for syntax files. More than
3155 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 This option is not copied to another buffer, independent of the 's' or
3157 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003158 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159
3160 *'fillchars'* *'fcs'*
3161'fillchars' 'fcs' string (default "vert:|,fold:-")
3162 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 {not available when compiled without the |+windows|
3164 and |+folding| features}
3165 Characters to fill the statuslines and vertical separators.
3166 It is a comma separated list of items:
3167
3168 item default Used for ~
3169 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003170 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171 vert:c '|' vertical separators |:vsplit|
3172 fold:c '-' filling 'foldtext'
3173 diff:c '-' deleted lines of the 'diff' option
3174
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003175 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003176 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 otherwise.
3178
3179 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003180 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181< This is similar to the default, except that these characters will also
3182 be used when there is highlighting.
3183
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003184 for "stl" and "stlnc" only single-byte values are supported.
3185
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 The highlighting used for these items:
3187 item highlight group ~
3188 stl:c StatusLine |hl-StatusLine|
3189 stlnc:c StatusLineNC |hl-StatusLineNC|
3190 vert:c VertSplit |hl-VertSplit|
3191 fold:c Folded |hl-Folded|
3192 diff:c DiffDelete |hl-DiffDelete|
3193
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003194 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3195'fixendofline' 'fixeol' boolean (default on)
3196 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003197 When writing a file and this option is on, <EOL> at the end of file
3198 will be restored if missing. Turn this option off if you want to
3199 preserve the situation from the original file.
3200 When the 'binary' option is set the value of this option doesn't
3201 matter.
3202 See the 'endofline' option.
3203
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3205'fkmap' 'fk' boolean (default off) *E198*
3206 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 {only available when compiled with the |+rightleft|
3208 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003209 This option was for using Farsi, which has been removed. See
3210 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211
3212 *'foldclose'* *'fcl'*
3213'foldclose' 'fcl' string (default "")
3214 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 {not available when compiled without the |+folding|
3216 feature}
3217 When set to "all", a fold is closed when the cursor isn't in it and
3218 its level is higher than 'foldlevel'. Useful if you want folds to
3219 automatically close when moving out of them.
3220
3221 *'foldcolumn'* *'fdc'*
3222'foldcolumn' 'fdc' number (default 0)
3223 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 {not available when compiled without the |+folding|
3225 feature}
3226 When non-zero, a column with the specified width is shown at the side
3227 of the window which indicates open and closed folds. The maximum
3228 value is 12.
3229 See |folding|.
3230
3231 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3232'foldenable' 'fen' boolean (default on)
3233 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 {not available when compiled without the |+folding|
3235 feature}
3236 When off, all folds are open. This option can be used to quickly
3237 switch between showing all text unfolded and viewing the text with
3238 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003239 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 'foldenable' is off.
3241 This option is set by commands that create a new fold or close a fold.
3242 See |folding|.
3243
3244 *'foldexpr'* *'fde'*
3245'foldexpr' 'fde' string (default: "0")
3246 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003248 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003250 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003251
Bram Moolenaar30b65812012-07-12 22:01:11 +02003252 The expression will be evaluated in the |sandbox| if set from a
3253 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003254 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003255 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003256
3257 It is not allowed to change text or jump to another window while
3258 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259
3260 *'foldignore'* *'fdi'*
3261'foldignore' 'fdi' string (default: "#")
3262 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 {not available when compiled without the |+folding|
3264 feature}
3265 Used only when 'foldmethod' is "indent". Lines starting with
3266 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003267 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 The default "#" works well for C programs. See |fold-indent|.
3269
3270 *'foldlevel'* *'fdl'*
3271'foldlevel' 'fdl' number (default: 0)
3272 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273 {not available when compiled without the |+folding|
3274 feature}
3275 Sets the fold level: Folds with a higher level will be closed.
3276 Setting this option to zero will close all folds. Higher numbers will
3277 close fewer folds.
3278 This option is set by commands like |zm|, |zM| and |zR|.
3279 See |fold-foldlevel|.
3280
3281 *'foldlevelstart'* *'fdls'*
3282'foldlevelstart' 'fdls' number (default: -1)
3283 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 {not available when compiled without the |+folding|
3285 feature}
3286 Sets 'foldlevel' when starting to edit another buffer in a window.
3287 Useful to always start editing with all folds closed (value zero),
3288 some folds closed (one) or no folds closed (99).
3289 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003290 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 ignores this option and closes all folds.
3292 It is also done before BufReadPre autocommands, to allow an autocmd to
3293 overrule the 'foldlevel' value for specific files.
3294 When the value is negative, it is not used.
3295
3296 *'foldmarker'* *'fmr'* *E536*
3297'foldmarker' 'fmr' string (default: "{{{,}}}")
3298 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 {not available when compiled without the |+folding|
3300 feature}
3301 The start and end marker used when 'foldmethod' is "marker". There
3302 must be one comma, which separates the start and end marker. The
3303 marker is a literal string (a regular expression would be too slow).
3304 See |fold-marker|.
3305
3306 *'foldmethod'* *'fdm'*
3307'foldmethod' 'fdm' string (default: "manual")
3308 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 {not available when compiled without the |+folding|
3310 feature}
3311 The kind of folding used for the current window. Possible values:
3312 |fold-manual| manual Folds are created manually.
3313 |fold-indent| indent Lines with equal indent form a fold.
3314 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3315 |fold-marker| marker Markers are used to specify folds.
3316 |fold-syntax| syntax Syntax highlighting items specify folds.
3317 |fold-diff| diff Fold text that is not changed.
3318
3319 *'foldminlines'* *'fml'*
3320'foldminlines' 'fml' number (default: 1)
3321 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 {not available when compiled without the |+folding|
3323 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003324 Sets the number of screen lines above which a fold can be displayed
3325 closed. Also for manually closed folds. With the default value of
3326 one a fold can only be closed if it takes up two or more screen lines.
3327 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003328 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 "zc" to close a fold, which is displayed open because it's smaller
3330 than 'foldminlines', a following "zc" may close a containing fold.
3331
3332 *'foldnestmax'* *'fdn'*
3333'foldnestmax' 'fdn' number (default: 20)
3334 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 {not available when compiled without the |+folding|
3336 feature}
3337 Sets the maximum nesting of folds for the "indent" and "syntax"
3338 methods. This avoids that too many folds will be created. Using more
3339 than 20 doesn't work, because the internal limit is 20.
3340
3341 *'foldopen'* *'fdo'*
3342'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3343 search,tag,undo")
3344 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 {not available when compiled without the |+folding|
3346 feature}
3347 Specifies for which type of commands folds will be opened, if the
3348 command moves the cursor into a closed fold. It is a comma separated
3349 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003350 NOTE: When the command is part of a mapping this option is not used.
3351 Add the |zv| command to the mapping to get the same effect.
3352 (rationale: the mapping may want to control opening folds itself)
3353
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 item commands ~
3355 all any
3356 block "(", "{", "[[", "[{", etc.
3357 hor horizontal movements: "l", "w", "fx", etc.
3358 insert any command in Insert mode
3359 jump far jumps: "G", "gg", etc.
3360 mark jumping to a mark: "'m", CTRL-O, etc.
3361 percent "%"
3362 quickfix ":cn", ":crew", ":make", etc.
3363 search search for a pattern: "/", "n", "*", "gd", etc.
3364 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003365 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 tag jumping to a tag: ":ta", CTRL-T, etc.
3367 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368 When a movement command is used for an operator (e.g., "dl" or "y%")
3369 this option is not used. This means the operator will include the
3370 whole closed fold.
3371 Note that vertical movements are not here, because it would make it
3372 very difficult to move onto a closed fold.
3373 In insert mode the folds containing the cursor will always be open
3374 when text is inserted.
3375 To close folds you can re-apply 'foldlevel' with the |zx| command or
3376 set the 'foldclose' option to "all".
3377
3378 *'foldtext'* *'fdt'*
3379'foldtext' 'fdt' string (default: "foldtext()")
3380 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 {not available when compiled without the |+folding|
3382 feature}
3383 An expression which is used to specify the text displayed for a closed
3384 fold. See |fold-foldtext|.
3385
Bram Moolenaar30b65812012-07-12 22:01:11 +02003386 The expression will be evaluated in the |sandbox| if set from a
3387 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003388 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003389
3390 It is not allowed to change text or jump to another window while
3391 evaluating 'foldtext' |textlock|.
3392
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003393 *'formatexpr'* *'fex'*
3394'formatexpr' 'fex' string (default "")
3395 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003396 {not available when compiled without the |+eval|
3397 feature}
3398 Expression which is evaluated to format a range of lines for the |gq|
3399 operator or automatic formatting (see 'formatoptions'). When this
3400 option is empty 'formatprg' is used.
3401
3402 The |v:lnum| variable holds the first line to be formatted.
3403 The |v:count| variable holds the number of lines to be formatted.
3404 The |v:char| variable holds the character that is going to be
3405 inserted if the expression is being evaluated due to
3406 automatic formatting. This can be empty. Don't insert
3407 it yet!
3408
3409 Example: >
3410 :set formatexpr=mylang#Format()
3411< This will invoke the mylang#Format() function in the
3412 autoload/mylang.vim file in 'runtimepath'. |autoload|
3413
3414 The expression is also evaluated when 'textwidth' is set and adding
3415 text beyond that limit. This happens under the same conditions as
3416 when internal formatting is used. Make sure the cursor is kept in the
3417 same spot relative to the text then! The |mode()| function will
3418 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003419
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003420 When the expression evaluates to non-zero Vim will fall back to using
3421 the internal format mechanism.
3422
3423 The expression will be evaluated in the |sandbox| when set from a
3424 modeline, see |sandbox-option|. That stops the option from working,
3425 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003426 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003427 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003428
Bram Moolenaar86b68352004-12-27 21:59:20 +00003429 *'formatlistpat'* *'flp'*
3430'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3431 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003432 A pattern that is used to recognize a list header. This is used for
3433 the "n" flag in 'formatoptions'.
3434 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003435 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003436 while still checking more characters. There must be a character
3437 following the pattern, when it matches the whole line it is handled
3438 like there is no match.
3439 The default recognizes a number, followed by an optional punctuation
3440 character and white space.
3441
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003442 *'formatoptions'* *'fo'*
3443'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3444 local to buffer
3445 This is a sequence of letters which describes how automatic
3446 formatting is to be done. See |fo-table|. When the 'paste' option is
3447 on, no formatting is done (like 'formatoptions' is empty). Commas can
3448 be inserted for readability.
3449 To avoid problems with flags that are added in the future, use the
3450 "+=" and "-=" feature of ":set" |add-option-flags|.
3451 NOTE: This option is set to the Vi default value when 'compatible' is
3452 set and to the Vim default value when 'compatible' is reset.
3453
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454 *'formatprg'* *'fp'*
3455'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003456 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003458 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003460 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003461 If the 'formatexpr' option is not empty it will be used instead.
3462 Otherwise, if 'formatprg' option is an empty string, the internal
3463 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003464 Environment variables are expanded |:set_env|. See |option-backslash|
3465 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003466 This option cannot be set from a |modeline| or in the |sandbox|, for
3467 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468
Bram Moolenaard94464e2015-11-02 15:28:18 +01003469 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003470'fsync' 'fs' boolean (default on)
3471 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003472 When on, the library function fsync() will be called after writing a
3473 file. This will flush a file to disk, ensuring that it is safely
3474 written even on filesystems which do metadata-only journaling. This
3475 will force the harddrive to spin up on Linux systems running in laptop
3476 mode, so it may be undesirable in some situations. Be warned that
3477 turning this off increases the chances of data loss after a crash. On
3478 systems without an fsync() implementation, this variable is always
3479 off.
3480 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003481 'fsync' also applies to |writefile()|, unless a flag is used to
3482 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003483 This option cannot be set from a |modeline| or in the |sandbox|, for
3484 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003485
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3487'gdefault' 'gd' boolean (default off)
3488 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 When on, the ":substitute" flag 'g' is default on. This means that
3490 all matches in a line are substituted instead of one. When a 'g' flag
3491 is given to a ":substitute" command, this will toggle the substitution
3492 of all or one match. See |complex-change|.
3493
3494 command 'gdefault' on 'gdefault' off ~
3495 :s/// subst. all subst. one
3496 :s///g subst. one subst. all
3497 :s///gg subst. all subst. one
3498
3499 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003500 DEPRECATED: Setting this option may break plugins that are not aware
3501 of this option. Also, many users get confused that adding the /g flag
3502 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503
3504 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003505'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507 Format to recognize for the ":grep" command output.
3508 This is a scanf-like string that uses the same format as the
3509 'errorformat' option: see |errorformat|.
3510
3511 *'grepprg'* *'gp'*
3512'grepprg' 'gp' string (default "grep -n ",
3513 Unix: "grep -n $* /dev/null",
3514 Win32: "findstr /n" or "grep -n",
3515 VMS: "SEARCH/NUMBERS ")
3516 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003517 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 and '#' characters, which are expanded like when used in a command-
3519 line. The placeholder "$*" is allowed to specify where the arguments
3520 will be included. Environment variables are expanded |:set_env|. See
3521 |option-backslash| about including spaces and backslashes.
3522 When your "grep" accepts the "-H" argument, use this to make ":grep"
3523 also work well with a single file: >
3524 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003525< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003526 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3527 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003528 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 apply equally to 'grepprg'.
3530 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3531 otherwise it's "grep -n".
3532 This option cannot be set from a |modeline| or in the |sandbox|, for
3533 security reasons.
3534
3535 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3536'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3537 ve:ver35-Cursor,
3538 o:hor50-Cursor,
3539 i-ci:ver25-Cursor/lCursor,
3540 r-cr:hor20-Cursor/lCursor,
3541 sm:block-Cursor
3542 -blinkwait175-blinkoff150-blinkon175",
3543 for MS-DOS and Win32 console:
3544 "n-v-c:block,o:hor50,i-ci:hor15,
3545 r-cr:hor30,sm:block")
3546 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 {only available when compiled with GUI enabled, and
3548 for MS-DOS and Win32 console}
3549 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003550 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 the height of the cursor can be changed. This can be done by
3552 specifying a block cursor, or a percentage for a vertical or
3553 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003554 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3555 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003557 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 mode-list and an argument-list:
3559 mode-list:argument-list,mode-list:argument-list,..
3560 The mode-list is a dash separated list of these modes:
3561 n Normal mode
3562 v Visual mode
3563 ve Visual mode with 'selection' "exclusive" (same as 'v',
3564 if not specified)
3565 o Operator-pending mode
3566 i Insert mode
3567 r Replace mode
3568 c Command-line Normal (append) mode
3569 ci Command-line Insert mode
3570 cr Command-line Replace mode
3571 sm showmatch in Insert mode
3572 a all modes
3573 The argument-list is a dash separated list of these arguments:
3574 hor{N} horizontal bar, {N} percent of the character height
3575 ver{N} vertical bar, {N} percent of the character width
3576 block block cursor, fills the whole character
3577 [only one of the above three should be present]
3578 blinkwait{N} *cursor-blinking*
3579 blinkon{N}
3580 blinkoff{N}
3581 blink times for cursor: blinkwait is the delay before
3582 the cursor starts blinking, blinkon is the time that
3583 the cursor is shown and blinkoff is the time that the
3584 cursor is not shown. The times are in msec. When one
3585 of the numbers is zero, there is no blinking. The
3586 default is: "blinkwait700-blinkon400-blinkoff250".
3587 These numbers are used for a missing entry. This
3588 means that blinking is enabled by default. To switch
3589 blinking off you can use "blinkon0". The cursor only
3590 blinks when Vim is waiting for input, not while
3591 executing a command.
3592 To make the cursor blink in an xterm, see
3593 |xterm-blink|.
3594 {group-name}
3595 a highlight group name, that sets the color and font
3596 for the cursor
3597 {group-name}/{group-name}
3598 Two highlight group names, the first is used when
3599 no language mappings are used, the other when they
3600 are. |language-mapping|
3601
3602 Examples of parts:
3603 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3604 block cursor with colors from the "nCursor"
3605 highlight group
3606 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3607 In Insert and Command-line Insert mode, use a
3608 30% vertical bar cursor with colors from the
3609 "iCursor" highlight group. Blink a bit
3610 faster.
3611
3612 The 'a' mode is different. It will set the given argument-list for
3613 all modes. It does not reset anything to defaults. This can be used
3614 to do a common setting for all modes. For example, to switch off
3615 blinking: "a:blinkon0"
3616
3617 Examples of cursor highlighting: >
3618 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3619 :highlight Cursor gui=NONE guifg=bg guibg=fg
3620<
3621 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003622 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003623'guifont' 'gfn' string (default "")
3624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 {only available when compiled with GUI enabled}
3626 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003627 In its simplest form the value is just one font name.
3628 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629
3630 *'guifontset'* *'gfs'*
3631 *E250* *E252* *E234* *E597* *E598*
3632'guifontset' 'gfs' string (default "")
3633 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 {only available when compiled with GUI enabled and
3635 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003636 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 When not empty, specifies two (or more) fonts to be used. The first
3638 one for normal English, the second one for your special language. See
3639 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003640
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3642'guifontwide' 'gfw' string (default "")
3643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 {only available when compiled with GUI enabled}
3645 When not empty, specifies a comma-separated list of fonts to be used
3646 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003647 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003648
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649 *'guiheadroom'* *'ghr'*
3650'guiheadroom' 'ghr' number (default 50)
3651 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003652 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653 The number of pixels subtracted from the screen height when fitting
3654 the GUI window on the screen. Set this before the GUI is started,
3655 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003656 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657 lines will be left for window decorations and other items on the
3658 screen. Set it to a negative value to allow windows taller than the
3659 screen.
3660
3661 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003662'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3663 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003664 "aegimrLtT" (GTK, Motif and Athena),
3665 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003668 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 sequence of letters which describes what components and options of the
3670 GUI should be used.
3671 To avoid problems with flags that are added in the future, use the
3672 "+=" and "-=" feature of ":set" |add-option-flags|.
3673
Bram Moolenaar13568252018-03-16 20:46:58 +01003674 Valid characters are as follows:
3675 *'go-!'*
3676 '!' External commands are executed in a terminal window. Without
3677 this flag the MS-Windows GUI will open a console window to
3678 execute the command. The Unix GUI will simulate a dumb
3679 terminal to list the command output.
3680 The terminal window will be positioned at the bottom, and grow
3681 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003682 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 'a' Autoselect: If present, then whenever VISUAL mode is started,
3684 or the Visual area extended, Vim tries to become the owner of
3685 the windowing system's global selection. This means that the
3686 Visually highlighted text is available for pasting into other
3687 applications as well as into Vim itself. When the Visual mode
3688 ends, possibly due to an operation on the text, or when an
3689 application wants to paste the selection, the highlighted text
3690 is automatically yanked into the "* selection register.
3691 Thus the selection is still available for pasting into other
3692 applications after the VISUAL mode has ended.
3693 If not present, then Vim won't become the owner of the
3694 windowing system's global selection unless explicitly told to
3695 by a yank or delete operation for the "* register.
3696 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003697 *'go-P'*
3698 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003699 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003700 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003701 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 applies to the modeless selection.
3703
3704 'guioptions' autoselect Visual autoselect modeless ~
3705 "" - -
3706 "a" yes yes
3707 "A" - yes
3708 "aA" yes yes
3709
Bram Moolenaar02467872007-05-06 13:22:01 +00003710 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 'c' Use console dialogs instead of popup dialogs for simple
3712 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003713 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003714 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003715 'guitablabel' can be used to change the text in the labels.
3716 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003717 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003718 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003719 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 'f' Foreground: Don't use fork() to detach the GUI from the shell
3721 where it was started. Use this for programs that wait for the
3722 editor to finish (e.g., an e-mail program). Alternatively you
3723 can use "gvim -f" or ":gui -f" to start the GUI in the
3724 foreground. |gui-fork|
3725 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003726 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003727 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3729 corner of the window. It's black&white on non-GTK, because of
3730 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003731 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003733 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003734 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003736 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003738 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003739 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 'g' Grey menu items: Make menu items that are not active grey. If
3741 'g' is not included inactive menu items are not shown at all.
3742 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003743 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 't' Include tearoff menu items. Currently only works for Win32,
3745 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003746 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003747 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003748 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003749 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003751 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 'R' Right-hand scrollbar is present when there is a vertically
3753 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003754 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003756 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 'L' Left-hand scrollbar is present when there is a vertically
3758 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003759 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3761 the longest visible line, or on the cursor line if the 'h'
3762 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003763 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 'h' Limit horizontal scrollbar size to the length of the cursor
3765 line. Reduces computations. |gui-horiz-scroll|
3766
3767 And yes, you may even have scrollbars on the left AND the right if
3768 you really want to :-). See |gui-scrollbars| for more information.
3769
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003770 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 'v' Use a vertical button layout for dialogs. When not included,
3772 a horizontal layout is preferred, but when it doesn't fit a
3773 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003774 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775 'p' Use Pointer callbacks for X11 GUI. This is required for some
3776 window managers. If the cursor is not blinking or hollow at
3777 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003778 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003780 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003781 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003782 *'go-k'*
3783 'k' Keep the GUI window size when adding/removing a scrollbar, or
3784 toolbar, tabline, etc. Instead, the behavior is similar to
3785 when the window is maximized and will adjust 'lines' and
3786 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003787 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003788 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003789
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 *'guipty'* *'noguipty'*
3791'guipty' boolean (default on)
3792 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003793 {only available when compiled with GUI enabled}
3794 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3795 I/O to/from shell commands. See |gui-pty|.
3796
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003797 *'guitablabel'* *'gtl'*
3798'guitablabel' 'gtl' string (default empty)
3799 global
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003800 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003801 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003802 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003803 pages line. When empty and when the result is empty Vim will use a
3804 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003805
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003806 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003807 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003808 The expression will be evaluated in the |sandbox| when set from a
3809 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003810 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003811
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003812 Only used when the GUI tab pages line is displayed. 'e' must be
3813 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3814 used.
3815
Bram Moolenaar57657d82006-04-21 22:12:41 +00003816 *'guitabtooltip'* *'gtt'*
3817'guitabtooltip' 'gtt' string (default empty)
3818 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00003819 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003820 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003821 When nonempty describes the text to use in a tooltip for the GUI tab
3822 pages line. When empty Vim will use a default tooltip.
3823 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003824 You can include a line break. Simplest method is to use |:let|: >
3825 :let &guitabtooltip = "line one\nline two"
3826<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003827
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 *'helpfile'* *'hf'*
3829'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3830 (others) "$VIMRUNTIME/doc/help.txt")
3831 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 Name of the main help file. All distributed help files should be
3833 placed together in one directory. Additionally, all "doc" directories
3834 in 'runtimepath' will be used.
3835 Environment variables are expanded |:set_env|. For example:
3836 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003837 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 spaces and backslashes.
3839 This option cannot be set from a |modeline| or in the |sandbox|, for
3840 security reasons.
3841
3842 *'helpheight'* *'hh'*
3843'helpheight' 'hh' number (default 20)
3844 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02003845 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 feature}
3847 Minimal initial height of the help window when it is opened with the
3848 ":help" command. The initial height of the help window is half of the
3849 current window, or (when the 'ea' option is on) the same as other
3850 windows. When the height is less than 'helpheight', the height is
3851 set to 'helpheight'. Set to zero to disable.
3852
3853 *'helplang'* *'hlg'*
3854'helplang' 'hlg' string (default: messages language or empty)
3855 global
3856 {only available when compiled with the |+multi_lang|
3857 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 Comma separated list of languages. Vim will use the first language
3859 for which the desired help can be found. The English help will always
3860 be used as a last resort. You can add "en" to prefer English over
3861 another language, but that will only find tags that exist in that
3862 language and not in the English help.
3863 Example: >
3864 :set helplang=de,it
3865< This will first search German, then Italian and finally English help
3866 files.
3867 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3868 try to find the tag in the current language before using this option.
3869 See |help-translated|.
3870
3871 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3872'hidden' 'hid' boolean (default off)
3873 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 When off a buffer is unloaded when it is |abandon|ed. When on a
3875 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3876 displayed in another window, it does not become hidden, of course.
3877 The commands that move through the buffer list sometimes make a buffer
3878 hidden although the 'hidden' option is off: When the buffer is
3879 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003880 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003881 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 This option is set for one command with ":hide {command}" |:hide|.
3883 WARNING: It's easy to forget that you have changes in hidden buffers.
3884 Think twice when using ":q!" or ":qa!".
3885
3886 *'highlight'* *'hl'*
3887'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003888 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3889 d:Directory,e:ErrorMsg,i:IncSearch,
3890 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
3891 N:CursorLineNr,r:Question,s:StatusLine,
3892 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003893 v:Visual,V:VisualNOS,w:WarningMsg,
3894 W:WildMenu,f:Folded,F:FoldColumn,
3895 A:DiffAdd,C:DiffChange,D:DiffDelete,
3896 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003897 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003898 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003899 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3900 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003901 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003902 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 This option can be used to set highlighting mode for various
3905 occasions. It is a comma separated list of character pairs. The
3906 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003907 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003909 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3910 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 characters from 'showbreak'
3912 |hl-Directory| d directories in CTRL-D listing and other special
3913 things in listings
3914 |hl-ErrorMsg| e error messages
3915 h (obsolete, ignored)
3916 |hl-IncSearch| i 'incsearch' highlighting
3917 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3918 |hl-MoreMsg| m |more-prompt|
3919 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003920 |hl-LineNr| n line number for ":number" and ":#" commands, and
3921 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003922 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3923 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 |hl-Question| r |hit-enter| prompt and yes/no questions
3925 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003926 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3928 |hl-VertSplit| c column used to separate vertically split windows
3929 |hl-Visual| v Visual mode
3930 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3931 Selection" Only X11 Gui's |gui-x11| and
3932 |xterm-clipboard|.
3933 |hl-WarningMsg| w warning messages
3934 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3935 |hl-Folded| f line used for closed folds
3936 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003937 |hl-DiffAdd| A added line in diff mode
3938 |hl-DiffChange| C changed line in diff mode
3939 |hl-DiffDelete| D deleted line in diff mode
3940 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003942 |hl-Conceal| - the placeholders used for concealed characters
3943 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003944 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003945 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003946 |hl-SpellRare| R rare word |spell|
3947 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003948 |hl-Pmenu| + popup menu normal line
3949 |hl-PmenuSel| = popup menu selected line
3950 |hl-PmenuSbar| x popup menu scrollbar
3951 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952
3953 The display modes are:
3954 r reverse (termcap entry "mr" and "me")
3955 i italic (termcap entry "ZH" and "ZR")
3956 b bold (termcap entry "md" and "me")
3957 s standout (termcap entry "so" and "se")
3958 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003959 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02003960 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 n no highlighting
3962 - no highlighting
3963 : use a highlight group
3964 The default is used for occasions that are not included.
3965 If you want to change what the display modes do, see |dos-colors|
3966 for an example.
3967 When using the ':' display mode, this must be followed by the name of
3968 a highlight group. A highlight group can be used to define any type
3969 of highlighting, including using color. See |:highlight| on how to
3970 define one. The default uses a different group for each occasion.
3971 See |highlight-default| for the default highlight groups.
3972
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003974'history' 'hi' number (Vim default: 50, Vi default: 0,
3975 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003978 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003980 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 NOTE: This option is set to the Vi default value when 'compatible' is
3982 set and to the Vim default value when 'compatible' is reset.
3983
3984 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3985'hkmap' 'hk' boolean (default off)
3986 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 {only available when compiled with the |+rightleft|
3988 feature}
3989 When on, the keyboard is mapped for the Hebrew character set.
3990 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3991 toggle this option. See |rileft.txt|.
3992 NOTE: This option is reset when 'compatible' is set.
3993
3994 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3995'hkmapp' 'hkp' boolean (default off)
3996 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 {only available when compiled with the |+rightleft|
3998 feature}
3999 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4000 This is useful if you have a non-Hebrew keyboard.
4001 See |rileft.txt|.
4002 NOTE: This option is reset when 'compatible' is set.
4003
Bram Moolenaar036986f2017-03-16 17:41:02 +01004004 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4005'hlsearch' 'hls' boolean (default off)
4006 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004007 {not available when compiled without the
4008 |+extra_search| feature}
4009 When there is a previous search pattern, highlight all its matches.
4010 The type of highlighting used can be set with the 'l' occasion in the
4011 'highlight' option. This uses the "Search" highlight group by
4012 default. Note that only the matching text is highlighted, any offsets
4013 are not applied.
4014 See also: 'incsearch' and |:match|.
4015 When you get bored looking at the highlighted matches, you can turn it
4016 off with |:nohlsearch|. This does not change the option value, as
4017 soon as you use a search command, the highlighting comes back.
4018 'redrawtime' specifies the maximum time spent on finding matches.
4019 When the search pattern can match an end-of-line, Vim will try to
4020 highlight all of the matched text. However, this depends on where the
4021 search starts. This will be the first line in the window or the first
4022 line below a closed fold. A match in a previous line which is not
4023 drawn may not continue in a newly drawn line.
4024 You can specify whether the highlight status is restored on startup
4025 with the 'h' flag in 'viminfo' |viminfo-h|.
4026 NOTE: This option is reset when 'compatible' is set.
4027
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 *'icon'* *'noicon'*
4029'icon' boolean (default off, on when title can be restored)
4030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 {not available when compiled without the |+title|
4032 feature}
4033 When on, the icon text of the window will be set to the value of
4034 'iconstring' (if it is not empty), or to the name of the file
4035 currently being edited. Only the last part of the name is used.
4036 Overridden by the 'iconstring' option.
4037 Only works if the terminal supports setting window icons (currently
4038 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4039 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4040 builtin termcap).
4041 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004042 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004044 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045
4046 *'iconstring'*
4047'iconstring' string (default "")
4048 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004049 {not available when compiled without the |+title|
4050 feature}
4051 When this option is not empty, it will be used for the icon text of
4052 the window. This happens only when the 'icon' option is on.
4053 Only works if the terminal supports setting window icon text
4054 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4055 Does not work for MS Windows.
4056 When Vim was compiled with HAVE_X11 defined, the original icon will be
4057 restored if possible |X11|.
4058 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004059 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004061 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 {not available when compiled without the |+statusline| feature}
4063
4064 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4065'ignorecase' 'ic' boolean (default off)
4066 global
4067 Ignore case in search patterns. Also used when searching in the tags
4068 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004069 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070 Can be overruled by using "\c" or "\C" in the pattern, see
4071 |/ignorecase|.
4072
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004073 *'imactivatefunc'* *'imaf'*
4074'imactivatefunc' 'imaf' string (default "")
4075 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004076 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004077 activate or deactivate the Input Method.
4078 It is not used in the GUI.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004079 The expression will be evaluated in the |sandbox| when set from a
4080 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004081
4082 Example: >
4083 function ImActivateFunc(active)
4084 if a:active
4085 ... do something
4086 else
4087 ... do something
4088 endif
4089 " return value is not used
4090 endfunction
4091 set imactivatefunc=ImActivateFunc
4092<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 *'imactivatekey'* *'imak'*
4094'imactivatekey' 'imak' string (default "")
4095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004097 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 Specifies the key that your Input Method in X-Windows uses for
4099 activation. When this is specified correctly, vim can fully control
4100 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4101 You can't use this option to change the activation key, the option
4102 tells Vim what the key is.
4103 Format:
4104 [MODIFIER_FLAG-]KEY_STRING
4105
4106 These characters can be used for MODIFIER_FLAG (case is ignored):
4107 S Shift key
4108 L Lock key
4109 C Control key
4110 1 Mod1 key
4111 2 Mod2 key
4112 3 Mod3 key
4113 4 Mod4 key
4114 5 Mod5 key
4115 Combinations are allowed, for example "S-C-space" or "SC-space" are
4116 both shift+ctrl+space.
4117 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4118
4119 Example: >
4120 :set imactivatekey=S-space
4121< "S-space" means shift+space. This is the activation key for kinput2 +
4122 canna (Japanese), and ami (Korean).
4123
4124 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4125'imcmdline' 'imc' boolean (default off)
4126 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 When set the Input Method is always on when starting to edit a command
4128 line, unless entering a search pattern (see 'imsearch' for that).
4129 Setting this option is useful when your input method allows entering
4130 English characters directly, e.g., when it's used to type accented
4131 characters with dead keys.
4132
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004133 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4135 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 When set the Input Method is never used. This is useful to disable
4137 the IM when it doesn't work properly.
4138 Currently this option is on by default for SGI/IRIX machines. This
4139 may change in later releases.
4140
4141 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004142'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144 Specifies whether :lmap or an Input Method (IM) is to be used in
4145 Insert mode. Valid values:
4146 0 :lmap is off and IM is off
4147 1 :lmap is ON and IM is off
4148 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 To always reset the option to zero when leaving Insert mode with <Esc>
4150 this can be used: >
4151 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4152< This makes :lmap and IM turn off automatically when leaving Insert
4153 mode.
4154 Note that this option changes when using CTRL-^ in Insert mode
4155 |i_CTRL-^|.
4156 The value is set to 1 when setting 'keymap' to a valid keymap name.
4157 It is also used for the argument of commands like "r" and "f".
4158 The value 0 may not work correctly with Athena and Motif with some XIM
4159 methods. Use 'imdisable' to disable XIM then.
4160
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004161 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004162 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004163 |+multi_byte_ime| or |global-ime|.
4164
Bram Moolenaar071d4272004-06-13 20:20:40 +00004165 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004166'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168 Specifies whether :lmap or an Input Method (IM) is to be used when
4169 entering a search pattern. Valid values:
4170 -1 the value of 'iminsert' is used, makes it look like
4171 'iminsert' is also used when typing a search pattern
4172 0 :lmap is off and IM is off
4173 1 :lmap is ON and IM is off
4174 2 :lmap is off and IM is ON
4175 Note that this option changes when using CTRL-^ in Command-line mode
4176 |c_CTRL-^|.
4177 The value is set to 1 when it is not -1 and setting the 'keymap'
4178 option to a valid keymap name.
4179 The value 0 may not work correctly with Athena and Motif with some XIM
4180 methods. Use 'imdisable' to disable XIM then.
4181
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004182 *'imstatusfunc'* *'imsf'*
4183'imstatusfunc' 'imsf' string (default "")
4184 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004185 This option specifies a function that is called to obtain the status
4186 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004187 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004188
4189 Example: >
4190 function ImStatusFunc()
4191 let is_active = ...do something
4192 return is_active ? 1 : 0
4193 endfunction
4194 set imstatusfunc=ImStatusFunc
4195<
4196 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004197 The expression will be evaluated in the |sandbox| when set from a
4198 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004199
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004200 *'imstyle'* *'imst'*
4201'imstyle' 'imst' number (default 1)
4202 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004203 {only available when compiled with |+xim| and
4204 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004205 This option specifies the input style of Input Method:
4206 0 use on-the-spot style
4207 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004208 See: |xim-input-style|
4209
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004210 For a long time on-the-spot style had been used in the GTK version of
4211 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004212 |single-repeat|, etc. Therefore over-the-spot style becomes the
4213 default now. This should work fine for most people, however if you
4214 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004215 The expression will be evaluated in the |sandbox| when set from a
4216 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004217
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 *'include'* *'inc'*
4219'include' 'inc' string (default "^\s*#\s*include")
4220 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 {not available when compiled without the
4222 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004223 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 pattern, just like for the "/" command (See |pattern|). The default
4225 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004226 "]I", "[d", etc.
4227 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004228 comes after the matched pattern. But if "\zs" appears in the pattern
4229 then the text matched from "\zs" to the end, or until "\ze" if it
4230 appears, is used as the file name. Use this to include characters
4231 that are not in 'isfname', such as a space. You can then use
4232 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004233 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234
4235 *'includeexpr'* *'inex'*
4236'includeexpr' 'inex' string (default "")
4237 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004239 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004241 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004242 :set includeexpr=substitute(v:fname,'\\.','/','g')
4243< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004244
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004246 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004247 Also used for |<cfile>|.
4248
Bram Moolenaar30b65812012-07-12 22:01:11 +02004249 The expression will be evaluated in the |sandbox| when set from a
4250 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004251 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004252
4253 It is not allowed to change text or jump to another window while
4254 evaluating 'includeexpr' |textlock|.
4255
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004257'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4258 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004261 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004262 While typing a search command, show where the pattern, as it was typed
4263 so far, matches. The matched string is highlighted. If the pattern
4264 is invalid or not found, nothing is shown. The screen will be updated
4265 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004266 Also applies to the pattern in commands: >
4267 :global
4268 :lvimgrep
4269 :lvimgrepadd
4270 :smagic
4271 :snomagic
4272 :sort
4273 :substitute
4274 :vglobal
4275 :vimgrep
4276 :vimgrepadd
4277< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004278 original position when no match is found and when pressing <Esc>. You
4279 still need to finish the search command with <Enter> to move the
4280 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004281 You can use the CTRL-G and CTRL-T keys to move to the next and
4282 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004283 When compiled with the |+reltime| feature Vim only searches for about
4284 half a second. With a complicated pattern and/or a lot of text the
4285 match may not be found. This is to avoid that Vim hangs while you
4286 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004287 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004288 When 'hlsearch' is on, all matched strings are highlighted too while
4289 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004290 If you don't want to turn 'hlsearch' on, but want to highlight all
4291 matches while searching, you can turn on and off 'hlsearch' with
4292 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004293 augroup vimrc-incsearch-highlight
4294 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004295 autocmd CmdlineEnter /,\? :set hlsearch
4296 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004297 augroup END
4298<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004299 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004300 to the command line. If 'ignorecase' and 'smartcase' are set and the
4301 command line has no uppercase characters, the added character is
4302 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004303 CTRL-R CTRL-W can be used to add the word at the end of the current
4304 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 NOTE: This option is reset when 'compatible' is set.
4306
4307 *'indentexpr'* *'inde'*
4308'indentexpr' 'inde' string (default "")
4309 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310 {not available when compiled without the |+cindent|
4311 or |+eval| features}
4312 Expression which is evaluated to obtain the proper indent for a line.
4313 It is used when a new line is created, for the |=| operator and
4314 in Insert mode as specified with the 'indentkeys' option.
4315 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004316 'smartindent' indenting. When 'lisp' is set, this option is
4317 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 When 'paste' is set this option is not used for indenting.
4319 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004320 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 when the expression is evaluated (but it may be moved around).
4322 The expression must return the number of spaces worth of indent. It
4323 can return "-1" to keep the current indent (this means 'autoindent' is
4324 used for the indent).
4325 Functions useful for computing the indent are |indent()|, |cindent()|
4326 and |lispindent()|.
4327 The evaluation of the expression must not have side effects! It must
4328 not change the text, jump to another window, etc. Afterwards the
4329 cursor position is always restored, thus the cursor may be moved.
4330 Normally this option would be set to call a function: >
4331 :set indentexpr=GetMyIndent()
4332< Error messages will be suppressed, unless the 'debug' option contains
4333 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004334 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004335 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336
Bram Moolenaar30b65812012-07-12 22:01:11 +02004337 The expression will be evaluated in the |sandbox| when set from a
4338 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004339 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004340
4341 It is not allowed to change text or jump to another window while
4342 evaluating 'indentexpr' |textlock|.
4343
4344
Bram Moolenaar071d4272004-06-13 20:20:40 +00004345 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004346'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004348 {not available when compiled without the |+cindent|
4349 feature}
4350 A list of keys that, when typed in Insert mode, cause reindenting of
4351 the current line. Only happens if 'indentexpr' isn't empty.
4352 The format is identical to 'cinkeys', see |indentkeys-format|.
4353 See |C-indenting| and |indent-expression|.
4354
4355 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4356'infercase' 'inf' boolean (default off)
4357 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004359 'ignorecase' is also on, the case of the match is adjusted depending
4360 on the typed text. If the typed text contains a lowercase letter
4361 where the match has an upper case letter, the completed part is made
4362 lowercase. If the typed text has no lowercase letters and the match
4363 has a lowercase letter where the typed text has an uppercase letter,
4364 and there is a letter before it, the completed part is made uppercase.
4365 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366
4367 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4368'insertmode' 'im' boolean (default off)
4369 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370 Makes Vim work in a way that Insert mode is the default mode. Useful
4371 if you want to use Vim as a modeless editor. Used for |evim|.
4372 These Insert mode commands will be useful:
4373 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004374 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375 this is a mapping, it is executed as if 'insertmode' was off.
4376 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004378 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4379 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380
4381 These items change when 'insertmode' is set:
4382 - when starting to edit of a file, Vim goes to Insert mode.
4383 - <Esc> in Insert mode is a no-op and beeps.
4384 - <Esc> in Normal mode makes Vim go to Insert mode.
4385 - CTRL-L in Insert mode is a command, it is not inserted.
4386 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4387 However, when <Esc> is used inside a mapping, it behaves like
4388 'insertmode' was not set. This was done to be able to use the same
4389 mappings with 'insertmode' set or not set.
4390 When executing commands with |:normal| 'insertmode' is not used.
4391
4392 NOTE: This option is reset when 'compatible' is set.
4393
4394 *'isfname'* *'isf'*
4395'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4396 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4397 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4398 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4399 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4400 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4401 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 The characters specified by this option are included in file names and
4403 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004404 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 Multi-byte characters 256 and above are always included, only the
4406 characters up to 255 are specified with this option.
4407 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004408 Think twice before adding white space to this option. Although a
4409 space may appear inside a file name, the effect will be that Vim
4410 doesn't know where a file name starts or ends when doing completion.
4411 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412
4413 Note that on systems using a backslash as path separator, Vim tries to
4414 do its best to make it work as you would expect. That is a bit
4415 tricky, since Vi originally used the backslash to escape special
4416 characters. Vim will not remove a backslash in front of a normal file
4417 name character on these systems, but it will on Unix and alikes. The
4418 '&' and '^' are not included by default, because these are special for
4419 cmd.exe.
4420
4421 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004422 Each part can be a single character number or a range. A range is two
4423 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 decimal number between 0 and 255 or the ASCII character itself (does
4425 not work for digits). Example:
4426 "_,-,128-140,#-43" (include '_' and '-' and the range
4427 128 to 140 and '#' to 43)
4428 If a part starts with '^', the following character number or range
4429 will be excluded from the option. The option is interpreted from left
4430 to right. Put the excluded character after the range where it is
4431 included. To include '^' itself use it as the last character of the
4432 option or the end of a range. Example:
4433 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4434 If the character is '@', all characters where isalpha() returns TRUE
4435 are included. Normally these are the characters a to z and A to Z,
4436 plus accented characters. To include '@' itself use "@-@". Examples:
4437 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004438 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 "a-z,A-Z,@-@" All letters plus the '@' character.
4440 A comma can be included by using it where a character number is
4441 expected. Example:
4442 "48-57,,,_" Digits, comma and underscore.
4443 A comma can be excluded by prepending a '^'. Example:
4444 " -~,^,,9" All characters from space to '~', excluding
4445 comma, plus <Tab>.
4446 See |option-backslash| about including spaces and backslashes.
4447
4448 *'isident'* *'isi'*
4449'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4450 "@,48-57,_,128-167,224-235"
4451 otherwise: "@,48-57,_,192-255")
4452 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453 The characters given by this option are included in identifiers.
4454 Identifiers are used in recognizing environment variables and after a
4455 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004456 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004457 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004459 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4461
4462 *'iskeyword'* *'isk'*
4463'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4464 "@,48-57,_,128-167,224-235"
4465 otherwise: "@,48-57,_,192-255"
4466 Vi default: "@,48-57,_")
4467 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004469 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004470 'isfname' for a description of the format of this option. For '@'
4471 characters above 255 check the "word" character class.
4472 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 For a help file it is set to all non-blank printable characters except
4474 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4475 command).
4476 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004477 This option also influences syntax highlighting, unless the syntax
4478 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 NOTE: This option is set to the Vi default value when 'compatible' is
4480 set and to the Vim default value when 'compatible' is reset.
4481
4482 *'isprint'* *'isp'*
4483'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4484 "@,~-255"; otherwise: "@,161-255")
4485 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 The characters given by this option are displayed directly on the
4487 screen. It is also used for "\p" in a |pattern|. The characters from
4488 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4489 even when they are not included in 'isprint' or excluded. See
4490 'isfname' for a description of the format of this option.
4491
4492 Non-printable characters are displayed with two characters:
4493 0 - 31 "^@" - "^_"
4494 32 - 126 always single characters
4495 127 "^?"
4496 128 - 159 "~@" - "~_"
4497 160 - 254 "| " - "|~"
4498 255 "~?"
4499 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4500 displayed as <xx>, with the hexadecimal value of the byte.
4501 When 'display' contains "uhex" all unprintable characters are
4502 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004503 The SpecialKey highlighting will be used for unprintable characters.
4504 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505
4506 Multi-byte characters 256 and above are always included, only the
4507 characters up to 255 are specified with this option. When a character
4508 is printable but it is not available in the current font, a
4509 replacement character will be shown.
4510 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4511 There is no option to specify these characters.
4512
4513 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4514'joinspaces' 'js' boolean (default on)
4515 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 Insert two spaces after a '.', '?' and '!' with a join command.
4517 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4518 Otherwise only one space is inserted.
4519 NOTE: This option is set when 'compatible' is set.
4520
4521 *'key'*
4522'key' string (default "")
4523 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004524 {only available when compiled with the |+cryptv|
4525 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004527 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 Careful: Do not set the key value by hand, someone might see the typed
4529 key. Use the |:X| command. But you can make 'key' empty: >
4530 :set key=
4531< It is not possible to get the value of this option with ":set key" or
4532 "echo &key". This is to avoid showing it to someone who shouldn't
4533 know. It also means you cannot see it yourself once you have set it,
4534 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004535 You can use "&key" in an expression to detect whether encryption is
4536 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537
4538 *'keymap'* *'kmp'* *E544*
4539'keymap' 'kmp' string (default "")
4540 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 {only available when compiled with the |+keymap|
4542 feature}
4543 Name of a keyboard mapping. See |mbyte-keymap|.
4544 Setting this option to a valid keymap name has the side effect of
4545 setting 'iminsert' to one, so that the keymap becomes effective.
4546 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004547 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548
4549 *'keymodel'* *'km'*
4550'keymodel' 'km' string (default "")
4551 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 List of comma separated words, which enable special things that keys
4553 can do. These values can be used:
4554 startsel Using a shifted special key starts selection (either
4555 Select mode or Visual mode, depending on "key" being
4556 present in 'selectmode').
4557 stopsel Using a not-shifted special key stops selection.
4558 Special keys in this context are the cursor keys, <End>, <Home>,
4559 <PageUp> and <PageDown>.
4560 The 'keymodel' option is set by the |:behave| command.
4561
4562 *'keywordprg'* *'kp'*
4563'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004564 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566 Program to use for the |K| command. Environment variables are
4567 expanded |:set_env|. ":help" may be used to access the Vim internal
4568 help. (Note that previously setting the global option to the empty
4569 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004570 When the first character is ":", the command is invoked as a Vim
4571 Ex command prefixed with [count].
4572 When "man", "man -s" or an Ex command is used, Vim will automatically
4573 translate a count for the "K" command and pass it as the first
4574 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 See |option-backslash| about including spaces and backslashes.
4576 Example: >
4577 :set keywordprg=man\ -s
4578< This option cannot be set from a |modeline| or in the |sandbox|, for
4579 security reasons.
4580
4581 *'langmap'* *'lmap'* *E357* *E358*
4582'langmap' 'lmap' string (default "")
4583 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 {only available when compiled with the |+langmap|
4585 feature}
4586 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004587 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004588 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 care of translating these special characters to the original meaning
4590 of the key. This means you don't have to change the keyboard mode to
4591 be able to execute Normal mode commands.
4592 This is the opposite of the 'keymap' option, where characters are
4593 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004594 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004595 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004596 This option cannot be set from a |modeline| or in the |sandbox|, for
4597 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004599 Example (for Greek, in UTF-8): *greek* >
4600 :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 +00004601< Example (exchanges meaning of z and y for commands): >
4602 :set langmap=zy,yz,ZY,YZ
4603<
4604 The 'langmap' option is a list of parts, separated with commas. Each
4605 part can be in one of two forms:
4606 1. A list of pairs. Each pair is a "from" character immediately
4607 followed by the "to" character. Examples: "aA", "aAbBcC".
4608 2. A list of "from" characters, a semi-colon and a list of "to"
4609 characters. Example: "abc;ABC"
4610 Example: "aA,fgh;FGH,cCdDeE"
4611 Special characters need to be preceded with a backslash. These are
4612 ";", ',' and backslash itself.
4613
4614 This will allow you to activate vim actions without having to switch
4615 back and forth between the languages. Your language characters will
4616 be understood as normal vim English characters (according to the
4617 langmap mappings) in the following cases:
4618 o Normal/Visual mode (commands, buffer/register names, user mappings)
4619 o Insert/Replace Mode: Register names after CTRL-R
4620 o Insert/Replace Mode: Mappings
4621 Characters entered in Command-line mode will NOT be affected by
4622 this option. Note that this option can be changed at any time
4623 allowing to switch between mappings for different languages/encodings.
4624 Use a mapping to avoid having to type it each time!
4625
4626 *'langmenu'* *'lm'*
4627'langmenu' 'lm' string (default "")
4628 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 {only available when compiled with the |+menu| and
4630 |+multi_lang| features}
4631 Language to use for menu translation. Tells which file is loaded
4632 from the "lang" directory in 'runtimepath': >
4633 "lang/menu_" . &langmenu . ".vim"
4634< (without the spaces). For example, to always use the Dutch menus, no
4635 matter what $LANG is set to: >
4636 :set langmenu=nl_NL.ISO_8859-1
4637< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004638 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639 If your $LANG is set to a non-English language but you do want to use
4640 the English menus: >
4641 :set langmenu=none
4642< This option must be set before loading menus, switching on filetype
4643 detection or syntax highlighting. Once the menus are defined setting
4644 this option has no effect. But you could do this: >
4645 :source $VIMRUNTIME/delmenu.vim
4646 :set langmenu=de_DE.ISO_8859-1
4647 :source $VIMRUNTIME/menu.vim
4648< Warning: This deletes all menus that you defined yourself!
4649
Bram Moolenaard94464e2015-11-02 15:28:18 +01004650 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004651'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004652 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004653 {only available when compiled with the |+langmap|
4654 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004655 This is just like 'langremap' but with the value inverted. It only
4656 exists for backwards compatibility. When setting 'langremap' then
4657 'langnoremap' is set to the inverted value, and the other way around.
4658
4659 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4660'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4661 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004662 {only available when compiled with the |+langmap|
4663 feature}
4664 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004665 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004666 'langmap' disables some of your mappings, try resetting this option.
4667 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004668 that works for you to avoid mappings to break.
4669
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 *'laststatus'* *'ls'*
4671'laststatus' 'ls' number (default 1)
4672 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 The value of this option influences when the last window will have a
4674 status line:
4675 0: never
4676 1: only if there are at least two windows
4677 2: always
4678 The screen looks nicer with a status line if you have several
4679 windows, but it takes another screen line. |status-line|
4680
4681 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4682'lazyredraw' 'lz' boolean (default off)
4683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 When this option is set, the screen will not be redrawn while
4685 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004686 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 update use |:redraw|.
4688
4689 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4690'linebreak' 'lbr' boolean (default off)
4691 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004692 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004694 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 than at the last character that fits on the screen. Unlike
4696 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004697 it only affects the way the file is displayed, not its contents.
4698 If 'breakindent' is set, line is visually indented. Then, the value
4699 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004700 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 Note that <Tab> characters after an <EOL> are mostly not displayed
4702 with the right amount of white space.
4703
4704 *'lines'* *E593*
4705'lines' number (default 24 or terminal height)
4706 global
4707 Number of lines of the Vim window.
4708 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004709 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 When Vim is running in the GUI or in a resizable window, setting this
4711 option will cause the window size to be changed. When you only want
4712 to use the size for the GUI, put the command in your |gvimrc| file.
4713 Vim limits the number of lines to what fits on the screen. You can
4714 use this command to get the tallest window possible: >
4715 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004716< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004717 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 When you set this option and Vim is unable to change the physical
4719 number of lines of the display, the display may be messed up.
4720
4721 *'linespace'* *'lsp'*
4722'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4723 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 {only in the GUI}
4725 Number of pixel lines inserted between characters. Useful if the font
4726 uses the full character cell height, making lines touch each other.
4727 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004728 With some fonts there can be too much room between lines (to have
4729 space for ascents and descents). Then it makes sense to set
4730 'linespace' to a negative value. This may cause display problems
4731 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732
4733 *'lisp'* *'nolisp'*
4734'lisp' boolean (default off)
4735 local to buffer
4736 {not available when compiled without the |+lispindent|
4737 feature}
4738 Lisp mode: When <Enter> is typed in insert mode set the indent for
4739 the next line to Lisp standards (well, sort of). Also happens with
4740 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4741 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4742 better. Also see 'lispwords'.
4743 The '-' character is included in keyword characters. Redefines the
4744 "=" operator to use this same indentation algorithm rather than
4745 calling an external program if 'equalprg' is empty.
4746 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747
4748 *'lispwords'* *'lw'*
4749'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004750 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 {not available when compiled without the |+lispindent|
4752 feature}
4753 Comma separated list of words that influence the Lisp indenting.
4754 |'lisp'|
4755
4756 *'list'* *'nolist'*
4757'list' boolean (default off)
4758 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004759 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4760 line. Useful to see the difference between tabs and spaces and for
4761 trailing blanks. Further changed by the 'listchars' option.
4762
4763 The cursor is displayed at the start of the space a Tab character
4764 occupies, not at the end as usual in Normal mode. To get this cursor
4765 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004766 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004767<
4768 Note that list mode will also affect formatting (set with 'textwidth'
4769 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770 changing the way tabs are displayed.
4771
4772 *'listchars'* *'lcs'*
4773'listchars' 'lcs' string (default "eol:$")
4774 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004775 Strings to use in 'list' mode and for the |:list| command. It is a
4776 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004777 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 eol:c Character to show at the end of each line. When
4779 omitted, there is no extra character at the end of the
4780 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004781 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004782 tab:xy[z] Two or three characters to be used to show a tab.
4783 The third character is optional.
4784
4785 tab:xy The 'x' is always used, then 'y' as many times as will
4786 fit. Thus "tab:>-" displays:
4787 >
4788 >-
4789 >--
4790 etc.
4791
4792 tab:xyz The 'z' is always used, then 'x' is prepended, and
4793 then 'y' is used as many times as will fit. Thus
4794 "tab:<->" displays:
4795 >
4796 <>
4797 <->
4798 <-->
4799 etc.
4800
4801 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004802 *lcs-space*
4803 space:c Character to show for a space. When omitted, spaces
4804 are left blank.
4805 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004806 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004807 trailing spaces are blank. Overrides the "space"
4808 setting for trailing spaces.
4809 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 extends:c Character to show in the last column, when 'wrap' is
4811 off and the line continues beyond the right of the
4812 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004813 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814 precedes:c Character to show in the first column, when 'wrap'
4815 is off and there is text preceding the character
4816 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004817 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004818 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004819 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004820 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004821 nbsp:c Character to show for a non-breakable space character
4822 (0xA0 (160 decimal) and U+202F). Left blank when
4823 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004825 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004827 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828
4829 Examples: >
4830 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004831 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 :set lcs=extends:>,precedes:<
4833< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004834 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004835 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836
4837 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4838'loadplugins' 'lpl' boolean (default on)
4839 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 When on the plugin scripts are loaded when starting up |load-plugins|.
4841 This option can be reset in your |vimrc| file to disable the loading
4842 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004843 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4844 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845
Bram Moolenaard94464e2015-11-02 15:28:18 +01004846 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004847'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004848 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004849 {only available when compiled with the |+lua/dyn|
4850 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004851 Specifies the name of the Lua shared library. The default is
4852 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004853 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004854 This option cannot be set from a |modeline| or in the |sandbox|, for
4855 security reasons.
4856
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004857 *'macatsui'* *'nomacatsui'*
4858'macatsui' boolean (default on)
4859 global
4860 {only available in Mac GUI version}
4861 This is a workaround for when drawing doesn't work properly. When set
4862 and compiled with multi-byte support ATSUI text drawing is used. When
4863 not set ATSUI text drawing is not used. Switch this option off when
4864 you experience drawing problems. In a future version the problems may
4865 be solved and this option becomes obsolete. Therefore use this method
4866 to unset it: >
4867 if exists('&macatsui')
4868 set nomacatsui
4869 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004870< Another option to check if you have drawing problems is
4871 'termencoding'.
4872
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873 *'magic'* *'nomagic'*
4874'magic' boolean (default on)
4875 global
4876 Changes the special characters that can be used in search patterns.
4877 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004878 WARNING: Switching this option off most likely breaks plugins! That
4879 is because many patterns assume it's on and will fail when it's off.
4880 Only switch it off when working with old Vi scripts. In any other
4881 situation write patterns that work when 'magic' is on. Include "\M"
4882 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883
4884 *'makeef'* *'mef'*
4885'makeef' 'mef' string (default: "")
4886 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004887 {not available when compiled without the |+quickfix|
4888 feature}
4889 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4890 and the |:grep| command.
4891 When it is empty, an internally generated temp file will be used.
4892 When "##" is included, it is replaced by a number to make the name
4893 unique. This makes sure that the ":make" command doesn't overwrite an
4894 existing file.
4895 NOT used for the ":cf" command. See 'errorfile' for that.
4896 Environment variables are expanded |:set_env|.
4897 See |option-backslash| about including spaces and backslashes.
4898 This option cannot be set from a |modeline| or in the |sandbox|, for
4899 security reasons.
4900
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004901 *'makeencoding'* *'menc'*
4902'makeencoding' 'menc' string (default "")
4903 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004904 Encoding used for reading the output of external commands. When empty,
4905 encoding is not converted.
4906 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4907 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4908 and `:laddfile`.
4909
4910 This would be mostly useful when you use MS-Windows and set 'encoding'
4911 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4912 'makeencoding' to "char" has the same effect as setting to the system
4913 locale encoding. Example: >
4914 :set encoding=utf-8
4915 :set makeencoding=char " system locale is used
4916<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917 *'makeprg'* *'mp'*
4918'makeprg' 'mp' string (default "make", VMS: "MMS")
4919 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004920 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004921 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4922 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004923 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004924 Environment variables are expanded |:set_env|. See |option-backslash|
4925 about including spaces and backslashes.
4926 Note that a '|' must be escaped twice: once for ":set" and once for
4927 the interpretation of a command. When you use a filter called
4928 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004929 :set makeprg=gmake\ \\\|\ myfilter
4930< The placeholder "$*" can be given (even multiple times) to specify
4931 where the arguments will be included, for example: >
4932 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4933< This option cannot be set from a |modeline| or in the |sandbox|, for
4934 security reasons.
4935
4936 *'matchpairs'* *'mps'*
4937'matchpairs' 'mps' string (default "(:),{:},[:]")
4938 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004940 other.
4941 Only character pairs are allowed that are different, thus you cannot
4942 jump between two double quotes.
4943 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004944 The pairs must be separated by a comma. Example for including '<' and
4945 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 :set mps+=<:>
4947
4948< A more exotic example, to jump between the '=' and ';' in an
4949 assignment, useful for languages like C and Java: >
4950 :au FileType c,cpp,java set mps+==:;
4951
4952< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01004953 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004954
4955 *'matchtime'* *'mat'*
4956'matchtime' 'mat' number (default 5)
4957 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 Tenths of a second to show the matching paren, when 'showmatch' is
4959 set. Note that this is not in milliseconds, like other options that
4960 set a time. This is to be compatible with Nvi.
4961
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004962 *'maxcombine'* *'mco'*
4963'maxcombine' 'mco' number (default 2)
4964 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004965 The maximum number of combining characters supported for displaying.
4966 Only used when 'encoding' is "utf-8".
4967 The default is OK for most languages. Hebrew may require 4.
4968 Maximum value is 6.
4969 Even when this option is set to 2 you can still edit text with more
4970 combining characters, you just can't see them. Use |g8| or |ga|.
4971 See |mbyte-combining|.
4972
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 *'maxfuncdepth'* *'mfd'*
4974'maxfuncdepth' 'mfd' number (default 100)
4975 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02004976 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004977 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 Maximum depth of function calls for user functions. This normally
4979 catches endless recursion. When using a recursive function with
4980 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4981 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01004982 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02004983 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 See also |:function|.
4985
4986 *'maxmapdepth'* *'mmd'* *E223*
4987'maxmapdepth' 'mmd' number (default 1000)
4988 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 Maximum number of times a mapping is done without resulting in a
4990 character to be used. This normally catches endless mappings, like
4991 ":map x y" with ":map y x". It still does not catch ":map g wg",
4992 because the 'w' is used before the next mapping is done. See also
4993 |key-mapping|.
4994
4995 *'maxmem'* *'mm'*
4996'maxmem' 'mm' number (default between 256 to 5120 (system
4997 dependent) or half the amount of memory
4998 available)
4999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5001 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005002 other memory to be freed.
5003 The maximum usable value is about 2000000. Use this to work without a
5004 limit.
5005 The value is ignored when 'swapfile' is off.
5006 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005008 *'maxmempattern'* *'mmp'*
5009'maxmempattern' 'mmp' number (default 1000)
5010 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005011 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005012 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005013 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005014 When Vim runs into the limit it gives an error message and mostly
5015 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005016 Running into the limit often means that the pattern is very
5017 inefficient or too complex. This may already happen with the pattern
5018 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005019 Might also happen on redraw, when syntax rules try to match a complex
5020 text structure.
5021 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5022 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005023
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024 *'maxmemtot'* *'mmt'*
5025'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5026 dependent) or half the amount of memory
5027 available)
5028 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005029 Maximum amount of memory in Kbyte to use for all buffers together.
5030 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005031 without a limit.
5032 On 64 bit machines higher values might work. But hey, do you really
5033 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005034 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005035 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005036 Buffers with 'swapfile' off still count to the total amount of memory
5037 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005038 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039
5040 *'menuitems'* *'mis'*
5041'menuitems' 'mis' number (default 25)
5042 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 {not available when compiled without the |+menu|
5044 feature}
5045 Maximum number of items to use in a menu. Used for menus that are
5046 generated from a list of items, e.g., the Buffers menu. Changing this
5047 option has no direct effect, the menu must be refreshed first.
5048
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005049 *'mkspellmem'* *'msm'*
5050'mkspellmem' 'msm' string (default "460000,2000,500")
5051 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005052 {not available when compiled without the |+syntax|
5053 feature}
5054 Parameters for |:mkspell|. This tunes when to start compressing the
5055 word tree. Compression can be slow when there are many words, but
5056 it's needed to avoid running out of memory. The amount of memory used
5057 per word depends very much on how similar the words are, that's why
5058 this tuning is complicated.
5059
5060 There are three numbers, separated by commas:
5061 {start},{inc},{added}
5062
5063 For most languages the uncompressed word tree fits in memory. {start}
5064 gives the amount of memory in Kbyte that can be used before any
5065 compression is done. It should be a bit smaller than the amount of
5066 memory that is available to Vim.
5067
5068 When going over the {start} limit the {inc} number specifies the
5069 amount of memory in Kbyte that can be allocated before another
5070 compression is done. A low number means compression is done after
5071 less words are added, which is slow. A high number means more memory
5072 will be allocated.
5073
5074 After doing compression, {added} times 1024 words can be added before
5075 the {inc} limit is ignored and compression is done when any extra
5076 amount of memory is needed. A low number means there is a smaller
5077 chance of hitting the {inc} limit, less memory is used but it's
5078 slower.
5079
5080 The languages for which these numbers are important are Italian and
5081 Hungarian. The default works for when you have about 512 Mbyte. If
5082 you have 1 Gbyte you could use: >
5083 :set mkspellmem=900000,3000,800
5084< If you have less than 512 Mbyte |:mkspell| may fail for some
5085 languages, no matter what you set 'mkspellmem' to.
5086
Bram Moolenaar07607392019-05-26 19:20:43 +02005087 This option cannot be set from a |modeline| or in the |sandbox|.
5088
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005090'modeline' 'ml' boolean (Vim default: on (off for root),
5091 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005093 If 'modeline' is on 'modelines' gives the number of lines that is
5094 checked for set commands. If 'modeline' is off or 'modelines' is zero
5095 no lines are checked. See |modeline|.
5096
5097 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5098'modelineexpr' 'mle' boolean (default: off)
5099 global
5100 When on allow some options that are an expression to be set in the
5101 modeline. Check the option for whether it is affected by
5102 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005103 This option cannot be set from a |modeline| or in the |sandbox|, for
5104 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005105
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 *'modelines'* *'mls'*
5107'modelines' 'mls' number (default 5)
5108 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109 If 'modeline' is on 'modelines' gives the number of lines that is
5110 checked for set commands. If 'modeline' is off or 'modelines' is zero
5111 no lines are checked. See |modeline|.
5112 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5113 set and to the Vim default value when 'compatible' is reset.
5114
5115 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005116 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117'modifiable' 'ma' boolean (default on)
5118 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 When off the buffer contents cannot be changed. The 'fileformat' and
5120 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005121 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122
5123 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5124'modified' 'mod' boolean (default off)
5125 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126 When on, the buffer is considered to be modified. This option is set
5127 when:
5128 1. A change was made to the text since it was last written. Using the
5129 |undo| command to go back to the original text will reset the
5130 option. But undoing changes that were made before writing the
5131 buffer will set the option again, since the text is different from
5132 when it was written.
5133 2. 'fileformat' or 'fileencoding' is different from its original
5134 value. The original value is set when the buffer is read or
5135 written. A ":set nomodified" command also resets the original
5136 values to the current values and the 'modified' option will be
5137 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005138 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005139 This option is not set when a change is made to the buffer as the
5140 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5141 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5142 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5144 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005145 Note that the text may actually be the same, e.g. 'modified' is set
5146 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147
5148 *'more'* *'nomore'*
5149'more' boolean (Vim default: on, Vi default: off)
5150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 When on, listings pause when the whole screen is filled. You will get
5152 the |more-prompt|. When this option is off there are no pauses, the
5153 listing continues until finished.
5154 NOTE: This option is set to the Vi default value when 'compatible' is
5155 set and to the Vim default value when 'compatible' is reset.
5156
5157 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005158'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5159 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005160 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005162 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5163 sysmouse and Linux console with gpm). For using the mouse in the
5164 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005166 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 v Visual mode
5168 i Insert mode
5169 c Command-line mode
5170 h all previous modes when editing a help file
5171 a all previous modes
5172 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005173 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174 :set mouse=a
5175< When the mouse is not enabled, the GUI will still use the mouse for
5176 modeless selection. This doesn't move the text cursor.
5177
5178 See |mouse-using|. Also see |'clipboard'|.
5179
5180 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005181 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 the mouse buttons can still be used by keeping the shift key pressed.
5183 Also see the 'clipboard' option.
5184
5185 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5186'mousefocus' 'mousef' boolean (default off)
5187 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 {only works in the GUI}
5189 The window that the mouse pointer is on is automatically activated.
5190 When changing the window layout or window focus in another way, the
5191 mouse pointer is moved to the window with keyboard focus. Off is the
5192 default because it makes using the pull down menus a little goofy, as
5193 a pointer transit may activate a window unintentionally.
5194
5195 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5196'mousehide' 'mh' boolean (default on)
5197 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 {only works in the GUI}
5199 When on, the mouse pointer is hidden when characters are typed.
5200 The mouse pointer is restored when the mouse is moved.
5201
5202 *'mousemodel'* *'mousem'*
5203'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5204 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205 Sets the model to use for the mouse. The name mostly specifies what
5206 the right mouse button is used for:
5207 extend Right mouse button extends a selection. This works
5208 like in an xterm.
5209 popup Right mouse button pops up a menu. The shifted left
5210 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005211 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212 popup_setpos Like "popup", but the cursor will be moved to the
5213 position where the mouse was clicked, and thus the
5214 selected operation will act upon the clicked object.
5215 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005216 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 course, that right clicking outside a selection will
5218 end Visual mode.
5219 Overview of what button does what for each model:
5220 mouse extend popup(_setpos) ~
5221 left click place cursor place cursor
5222 left drag start selection start selection
5223 shift-left search word extend selection
5224 right click extend selection popup menu (place cursor)
5225 right drag extend selection -
5226 middle click paste paste
5227
5228 In the "popup" model the right mouse button produces a pop-up menu.
5229 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005230 In a terminal the popup menu works if Vim is compiled with the
5231 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232
5233 Note that you can further refine the meaning of buttons with mappings.
5234 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5235 selection (because that's handled in the GUI code directly).
5236
5237 The 'mousemodel' option is set by the |:behave| command.
5238
5239 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005240'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5241 vs:leftright,vd:lrsizing,m:no,
5242 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244 {only available when compiled with the |+mouseshape|
5245 feature}
5246 This option tells Vim what the mouse pointer should look like in
5247 different modes. The option is a comma separated list of parts, much
5248 like used for 'guicursor'. Each part consist of a mode/location-list
5249 and an argument-list:
5250 mode-list:shape,mode-list:shape,..
5251 The mode-list is a dash separated list of these modes/locations:
5252 In a normal window: ~
5253 n Normal mode
5254 v Visual mode
5255 ve Visual mode with 'selection' "exclusive" (same as 'v',
5256 if not specified)
5257 o Operator-pending mode
5258 i Insert mode
5259 r Replace mode
5260
5261 Others: ~
5262 c appending to the command-line
5263 ci inserting in the command-line
5264 cr replacing in the command-line
5265 m at the 'Hit ENTER' or 'More' prompts
5266 ml idem, but cursor in the last line
5267 e any mode, pointer below last window
5268 s any mode, pointer on a status line
5269 sd any mode, while dragging a status line
5270 vs any mode, pointer on a vertical separator line
5271 vd any mode, while dragging a vertical separator line
5272 a everywhere
5273
5274 The shape is one of the following:
5275 avail name looks like ~
5276 w x arrow Normal mouse pointer
5277 w x blank no pointer at all (use with care!)
5278 w x beam I-beam
5279 w x updown up-down sizing arrows
5280 w x leftright left-right sizing arrows
5281 w x busy The system's usual busy pointer
5282 w x no The system's usual 'no input' pointer
5283 x udsizing indicates up-down resizing
5284 x lrsizing indicates left-right resizing
5285 x crosshair like a big thin +
5286 x hand1 black hand
5287 x hand2 white hand
5288 x pencil what you write with
5289 x question big ?
5290 x rightup-arrow arrow pointing right-up
5291 w x up-arrow arrow pointing up
5292 x <number> any X11 pointer number (see X11/cursorfont.h)
5293
5294 The "avail" column contains a 'w' if the shape is available for Win32,
5295 x for X11.
5296 Any modes not specified or shapes not available use the normal mouse
5297 pointer.
5298
5299 Example: >
5300 :set mouseshape=s:udsizing,m:no
5301< will make the mouse turn to a sizing arrow over the status lines and
5302 indicate no input when the hit-enter prompt is displayed (since
5303 clicking the mouse has no effect in this state.)
5304
5305 *'mousetime'* *'mouset'*
5306'mousetime' 'mouset' number (default 500)
5307 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5309 time in msec between two mouse clicks for the second click to be
5310 recognized as a multi click.
5311
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005312 *'mzschemedll'*
5313'mzschemedll' string (default depends on the build)
5314 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005315 {only available when compiled with the |+mzscheme/dyn|
5316 feature}
5317 Specifies the name of the MzScheme shared library. The default is
5318 DYNAMIC_MZSCH_DLL which was specified at compile time.
5319 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005320 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005321 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005322 This option cannot be set from a |modeline| or in the |sandbox|, for
5323 security reasons.
5324
5325 *'mzschemegcdll'*
5326'mzschemegcdll' string (default depends on the build)
5327 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005328 {only available when compiled with the |+mzscheme/dyn|
5329 feature}
5330 Specifies the name of the MzScheme GC shared library. The default is
5331 DYNAMIC_MZGC_DLL which was specified at compile time.
5332 The value can be equal to 'mzschemedll' if it includes the GC code.
5333 Environment variables are expanded |:set_env|.
5334 This option cannot be set from a |modeline| or in the |sandbox|, for
5335 security reasons.
5336
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005337 *'mzquantum'* *'mzq'*
5338'mzquantum' 'mzq' number (default 100)
5339 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005340 {not available when compiled without the |+mzscheme|
5341 feature}
5342 The number of milliseconds between polls for MzScheme threads.
5343 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005344 NOTE: This option is set to the Vim default value when 'compatible'
5345 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005346
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005348'nrformats' 'nf' string (default "bin,octal,hex",
5349 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351 This defines what bases Vim will consider for numbers when using the
5352 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5353 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005354 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005356 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005357 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005358 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005359 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360 considered to be hexadecimal. Example: Using CTRL-X on
5361 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005362 bin If included, numbers starting with "0b" or "0B" will be
5363 considered to be binary. Example: Using CTRL-X on
5364 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005365 Numbers which simply begin with a digit in the range 1-9 are always
5366 considered decimal. This also happens for numbers that are not
5367 recognized as octal or hex.
5368
5369 *'number'* *'nu'* *'nonumber'* *'nonu'*
5370'number' 'nu' boolean (default off)
5371 local to window
5372 Print the line number in front of each line. When the 'n' option is
5373 excluded from 'cpoptions' a wrapped line will not use the column of
5374 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005375 The 'numberwidth' option can be used to set the room used for the line
5376 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377 When a long, wrapped line doesn't start with the first character, '-'
5378 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005379 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5380 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005381 *number_relativenumber*
5382 The 'relativenumber' option changes the displayed number to be
5383 relative to the cursor. Together with 'number' there are these
5384 four combinations (cursor in line 3):
5385
Bram Moolenaar3848e002016-03-19 18:42:29 +01005386 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005387 'nornu' 'nornu' 'rnu' 'rnu'
5388
5389 |apple | 1 apple | 2 apple | 2 apple
5390 |pear | 2 pear | 1 pear | 1 pear
5391 |nobody | 3 nobody | 0 nobody |3 nobody
5392 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005394 *'numberwidth'* *'nuw'*
5395'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5396 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005397 {only available when compiled with the |+linebreak|
5398 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005399 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005400 when the 'number' or 'relativenumber' option is set or printing lines
5401 with a line number. Since one space is always between the number and
5402 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005403 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005404 fit the highest line number in the buffer respectively the number of
5405 rows in the window, depending on whether 'number' or 'relativenumber'
5406 is set. Thus with the Vim default of 4 there is room for a line number
5407 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005408 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005409 NOTE: This option is set to the Vi default value when 'compatible' is
5410 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005411
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005412 *'omnifunc'* *'ofu'*
5413'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005414 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005415 {not available when compiled without the |+eval|
5416 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005417 This option specifies a function to be used for Insert mode omni
5418 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005419 See |complete-functions| for an explanation of how the function is
5420 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005421 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005422 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005423 This option cannot be set from a |modeline| or in the |sandbox|, for
5424 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005425
5426
Bram Moolenaar02467872007-05-06 13:22:01 +00005427 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005428'opendevice' 'odev' boolean (default off)
5429 global
Bram Moolenaar043545e2006-10-10 16:44:07 +00005430 {only for MS-DOS, MS-Windows and OS/2}
5431 Enable reading and writing from devices. This may get Vim stuck on a
5432 device that can be opened but doesn't actually do the I/O. Therefore
5433 it is off by default.
5434 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5435 result in editing a device.
5436
5437
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005438 *'operatorfunc'* *'opfunc'*
5439'operatorfunc' 'opfunc' string (default: empty)
5440 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005441 This option specifies a function to be called by the |g@| operator.
5442 See |:map-operator| for more info and an example.
5443
5444 This option cannot be set from a |modeline| or in the |sandbox|, for
5445 security reasons.
5446
5447
Bram Moolenaar251e1912011-06-19 05:09:16 +02005448 *'osfiletype'* *'oft'*
5449'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005450 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005451 This option was supported on RISC OS, which has been removed.
5452
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005454 *'packpath'* *'pp'*
5455'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005456 Directories used to find packages. See |packages|.
5457
5458
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005460'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 global
5462 Specifies the nroff macros that separate paragraphs. These are pairs
5463 of two letters (see |object-motions|).
5464
5465 *'paste'* *'nopaste'*
5466'paste' boolean (default off)
5467 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005468 Put Vim in Paste mode. This is useful if you want to cut or copy
5469 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470 unexpected effects.
5471 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005472 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005473 knows about pasting and will mostly do the right thing without 'paste'
5474 being set. The same is true for a terminal where Vim handles the
5475 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005476 This option is reset when starting the GUI. Thus if you set it in
5477 your .vimrc it will work in a terminal, but not in the GUI. Setting
5478 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5479 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 When the 'paste' option is switched on (also when it was already on):
5481 - mapping in Insert mode and Command-line mode is disabled
5482 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005484 - 'expandtab' is reset
5485 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486 - 'revins' is reset
5487 - 'ruler' is reset
5488 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005489 - 'smartindent' is reset
5490 - 'smarttab' is reset
5491 - 'softtabstop' is set to 0
5492 - 'textwidth' is set to 0
5493 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005494 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005496 - 'indentexpr'
5497 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005498 NOTE: When you start editing another file while the 'paste' option is
5499 on, settings from the modelines or autocommands may change the
5500 settings again, causing trouble when pasting text. You might want to
5501 set the 'paste' option again.
5502 When the 'paste' option is reset the mentioned options are restored to
5503 the value before the moment 'paste' was switched from off to on.
5504 Resetting 'paste' before ever setting it does not have any effect.
5505 Since mapping doesn't work while 'paste' is active, you need to use
5506 the 'pastetoggle' option to toggle the 'paste' option with some key.
5507
5508 *'pastetoggle'* *'pt'*
5509'pastetoggle' 'pt' string (default "")
5510 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511 When non-empty, specifies the key sequence that toggles the 'paste'
5512 option. This is like specifying a mapping: >
5513 :map {keys} :set invpaste<CR>
5514< Where {keys} is the value of 'pastetoggle'.
5515 The difference is that it will work even when 'paste' is set.
5516 'pastetoggle' works in Insert mode and Normal mode, but not in
5517 Command-line mode.
5518 Mappings are checked first, thus overrule 'pastetoggle'. However,
5519 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5520 this: >
5521 :map <F10> :set paste<CR>
5522 :map <F11> :set nopaste<CR>
5523 :imap <F10> <C-O>:set paste<CR>
5524 :imap <F11> <nop>
5525 :set pastetoggle=<F11>
5526< This will make <F10> start paste mode and <F11> stop paste mode.
5527 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5528 mode everything is inserted literally, except the 'pastetoggle' key
5529 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005530 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531
5532 *'pex'* *'patchexpr'*
5533'patchexpr' 'pex' string (default "")
5534 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 {not available when compiled without the |+diff|
5536 feature}
5537 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005538 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005539
Bram Moolenaardbc28022014-07-26 13:40:44 +02005540 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541'patchmode' 'pm' string (default "")
5542 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 When non-empty the oldest version of a file is kept. This can be used
5544 to keep the original version of a file if you are changing files in a
5545 source distribution. Only the first time that a file is written a
5546 copy of the original file will be kept. The name of the copy is the
5547 name of the original file with the string in the 'patchmode' option
5548 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005549 ".orig" or ".org". 'backupdir' must not be empty for this to work
5550 (Detail: The backup file is renamed to the patchmode file after the
5551 new file has been successfully written, that's why it must be possible
5552 to write a backup file). If there was no file to be backed up, an
5553 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005554 When the 'backupskip' pattern matches, a patchmode file is not made.
5555 Using 'patchmode' for compressed files appends the extension at the
5556 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5557 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005558 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005560 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561'path' 'pa' string (default on Unix: ".,/usr/include,,"
5562 on OS/2: ".,/emx/include,,"
5563 other systems: ".,,")
5564 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005566 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5567 provided that the file being searched for has a relative path (not
5568 starting with "/", "./" or "../"). The directories in the 'path'
5569 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005570 - Use commas to separate directory names: >
5571 :set path=.,/usr/local/include,/usr/include
5572< - Spaces can also be used to separate directory names (for backwards
5573 compatibility with version 3.0). To have a space in a directory
5574 name, precede it with an extra backslash, and escape the space: >
5575 :set path=.,/dir/with\\\ space
5576< - To include a comma in a directory name precede it with an extra
5577 backslash: >
5578 :set path=.,/dir/with\\,comma
5579< - To search relative to the directory of the current file, use: >
5580 :set path=.
5581< - To search in the current directory use an empty string between two
5582 commas: >
5583 :set path=,,
5584< - A directory name may end in a ':' or '/'.
5585 - Environment variables are expanded |:set_env|.
5586 - When using |netrw.vim| URLs can be used. For example, adding
5587 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005588 - Search upwards and downwards in a directory tree using "*", "**" and
5589 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 {not available when compiled without the |+path_extra| feature}
5591 - Careful with '\' characters, type two to get one in the option: >
5592 :set path=.,c:\\include
5593< Or just use '/' instead: >
5594 :set path=.,c:/include
5595< Don't forget "." or files won't even be found in the same directory as
5596 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005597 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005598 it is something like 256 or 1024 characters.
5599 You can check if all the include files are found, using the value of
5600 'path', see |:checkpath|.
5601 The use of |:set+=| and |:set-=| is preferred when adding or removing
5602 directories from the list. This avoids problems when a future version
5603 uses another default. To remove the current directory use: >
5604 :set path-=
5605< To add the current directory use: >
5606 :set path+=
5607< To use an environment variable, you probably need to replace the
5608 separator. Here is an example to append $INCL, in which directory
5609 names are separated with a semi-colon: >
5610 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5611< Replace the ';' with a ':' or whatever separator is used. Note that
5612 this doesn't work when $INCL contains a comma or white space.
5613
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005614 *'perldll'*
5615'perldll' string (default depends on the build)
5616 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005617 {only available when compiled with the |+perl/dyn|
5618 feature}
5619 Specifies the name of the Perl shared library. The default is
5620 DYNAMIC_PERL_DLL, which was specified at compile time.
5621 Environment variables are expanded |:set_env|.
5622 This option cannot be set from a |modeline| or in the |sandbox|, for
5623 security reasons.
5624
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5626'preserveindent' 'pi' boolean (default off)
5627 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005628 When changing the indent of the current line, preserve as much of the
5629 indent structure as possible. Normally the indent is replaced by a
5630 series of tabs followed by spaces as required (unless |'expandtab'| is
5631 enabled, in which case only spaces are used). Enabling this option
5632 means the indent will preserve as many existing characters as possible
5633 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005634 'expandtab' does not apply to the preserved white space, a Tab remains
5635 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 NOTE: When using ">>" multiple times the resulting indent is a mix of
5637 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005638 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005639 Also see 'copyindent'.
5640 Use |:retab| to clean up white space.
5641
5642 *'previewheight'* *'pvh'*
5643'previewheight' 'pvh' number (default 12)
5644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005645 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005646 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005648 commands. Used for |CTRL-W_}| when no count is given. Not used when
5649 'previewpopup' is set.
5650
5651 *'previewpopup'* *'pvp'*
5652'previewpopup' 'pvp' string (default empty)
5653 global
5654 {not available when compiled without the |+windows|,
5655 |+textprop| or |+quickfix| feature}
5656 When not empty a popup window is used for commands that would open a
5657 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005658 Not used for the insert completion info, add "popup" to
5659 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005660
5661 *'previewwindow'* *'nopreviewwindow'*
5662 *'pvw'* *'nopvw'* *E590*
5663'previewwindow' 'pvw' boolean (default off)
5664 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005666 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005667 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668 set. It's normally not set directly, but by using one of the commands
5669 |:ptag|, |:pedit|, etc.
5670
5671 *'printdevice'* *'pdev'*
5672'printdevice' 'pdev' string (default empty)
5673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674 {only available when compiled with the |+printer|
5675 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005676 The name of the printer to be used for |:hardcopy|.
5677 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005678 This option cannot be set from a |modeline| or in the |sandbox|, for
5679 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680
Bram Moolenaar8299df92004-07-10 09:47:34 +00005681 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005682'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 {only available when compiled with the |+printer|
5685 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005686 Sets the character encoding used when printing.
5687 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688
5689 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005690'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 {only available when compiled with the |+printer|
5693 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005694 Expression used to print the PostScript produced with |:hardcopy|.
5695 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005696 This option cannot be set from a |modeline| or in the |sandbox|, for
5697 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698
Bram Moolenaar8299df92004-07-10 09:47:34 +00005699 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700'printfont' 'pfn' string (default "courier")
5701 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005702 {only available when compiled with the |+printer|
5703 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005704 The name of the font that will be used for |:hardcopy|.
5705 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706
5707 *'printheader'* *'pheader'*
5708'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 {only available when compiled with the |+printer|
5711 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005712 The format of the header produced in |:hardcopy| output.
5713 See |pheader-option|.
5714
5715 *'printmbcharset'* *'pmbcs'*
5716'printmbcharset' 'pmbcs' string (default "")
5717 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005718 {only available when compiled with the |+printer|
5719 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005720 The CJK character set to be used for CJK output from |:hardcopy|.
5721 See |pmbcs-option|.
5722
5723 *'printmbfont'* *'pmbfn'*
5724'printmbfont' 'pmbfn' string (default "")
5725 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005726 {only available when compiled with the |+printer|
5727 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005728 List of font names to be used for CJK output from |:hardcopy|.
5729 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730
5731 *'printoptions'* *'popt'*
5732'printoptions' 'popt' string (default "")
5733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005735 List of items that control the format of the output of |:hardcopy|.
5736 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005738 *'prompt'* *'noprompt'*
5739'prompt' boolean (default on)
5740 global
5741 When on a ":" prompt is used in Ex mode.
5742
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005743 *'pumheight'* *'ph'*
5744'pumheight' 'ph' number (default 0)
5745 global
5746 {not available when compiled without the
5747 |+insert_expand| feature}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005748 Determines the maximum number of items to show in the popup menu for
5749 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005750 |ins-completion-menu|.
5751
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005752 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005753'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005754 global
5755 {not available when compiled without the
5756 |+insert_expand| feature}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005757 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005758 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005759
Bram Moolenaard94464e2015-11-02 15:28:18 +01005760 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005761'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005762 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005763 {only available when compiled with the |+python/dyn|
5764 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005765 Specifies the name of the Python 2.x shared library. The default is
5766 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005767 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005768 This option cannot be set from a |modeline| or in the |sandbox|, for
5769 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005770
Bram Moolenaar94073162018-01-31 21:49:05 +01005771 *'pythonhome'*
5772'pythonhome' string (default "")
5773 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005774 {only available when compiled with the |+python/dyn|
5775 feature}
5776 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5777 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5778 which was specified at compile time, will be used for the Python 2.x
5779 home directory.
5780 Environment variables are expanded |:set_env|.
5781 This option cannot be set from a |modeline| or in the |sandbox|, for
5782 security reasons.
5783
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005784 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005785'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005786 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005787 {only available when compiled with the |+python3/dyn|
5788 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005789 Specifies the name of the Python 3 shared library. The default is
5790 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005791 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005792 This option cannot be set from a |modeline| or in the |sandbox|, for
5793 security reasons.
5794
Bram Moolenaar94073162018-01-31 21:49:05 +01005795 *'pythonthreehome'*
5796'pythonthreehome' string (default "")
5797 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005798 {only available when compiled with the |+python3/dyn|
5799 feature}
5800 Specifies the name of the Python 3 home directory. When
5801 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5802 PYTHON3_HOME, which was specified at compile time, will be used for
5803 the Python 3 home directory.
5804 Environment variables are expanded |:set_env|.
5805 This option cannot be set from a |modeline| or in the |sandbox|, for
5806 security reasons.
5807
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005808 *'pyxversion'* *'pyx'*
5809'pyxversion' 'pyx' number (default depends on the build)
5810 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005811 {only available when compiled with the |+python| or
5812 the |+python3| feature}
5813 Specifies the python version used for pyx* functions and commands
5814 |python_x|. The default value is as follows:
5815
5816 Compiled with Default ~
5817 |+python| and |+python3| 0
5818 only |+python| 2
5819 only |+python3| 3
5820
5821 Available values are 0, 2 and 3.
5822 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5823 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5824 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5825 to 2 if Python 2 is available.
5826 See also: |has-pythonx|
5827
5828 If Vim is compiled with only |+python| or |+python3| setting
5829 'pyxversion' has no effect. The pyx* functions and commands are
5830 always the same as the compiled version.
5831
5832 This option cannot be set from a |modeline| or in the |sandbox|, for
5833 security reasons.
5834
Bram Moolenaar677ee682005-01-27 14:41:15 +00005835 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005836'quoteescape' 'qe' string (default "\")
5837 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005838 The characters that are used to escape quotes in a string. Used for
5839 objects like a', a" and a` |a'|.
5840 When one of the characters in this option is found inside a string,
5841 the following character will be skipped. The default value makes the
5842 text "foo\"bar\\" considered to be one string.
5843
Bram Moolenaar071d4272004-06-13 20:20:40 +00005844 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5845'readonly' 'ro' boolean (default off)
5846 local to buffer
5847 If on, writes fail unless you use a '!'. Protects you from
5848 accidentally overwriting a file. Default on when Vim is started
5849 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005850 When using ":w!" the 'readonly' option is reset for the current
5851 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005852 When using the ":view" command the 'readonly' option is set for the
5853 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005854 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005856 *'redrawtime'* *'rdt'*
5857'redrawtime' 'rdt' number (default 2000)
5858 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005859 {only available when compiled with the |+reltime|
5860 feature}
5861 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005862 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005863 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005864 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005865 matches will be highlighted.
5866 For syntax highlighting the time applies per window. When over the
5867 limit syntax highlighting is disabled until |CTRL-L| is used.
5868 This is used to avoid that Vim hangs when using a very complicated
5869 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005870
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005871 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005872'regexpengine' 're' number (default 0)
5873 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005874 This selects the default regexp engine. |two-engines|
5875 The possible values are:
5876 0 automatic selection
5877 1 old engine
5878 2 NFA engine
5879 Note that when using the NFA engine and the pattern contains something
5880 that is not supported the pattern will not match. This is only useful
5881 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005882 Using automatic selection enables Vim to switch the engine, if the
5883 default engine becomes too costly. E.g., when the NFA engine uses too
5884 many states. This should prevent Vim from hanging on a combination of
5885 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005886
Bram Moolenaar64486672010-05-16 15:46:46 +02005887 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5888'relativenumber' 'rnu' boolean (default off)
5889 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005890 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005891 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005892 precede some vertical motion commands (e.g. j k + -) with, without
5893 having to calculate it yourself. Especially useful in combination with
5894 other commands (e.g. y d c < > gq gw =).
5895 When the 'n' option is excluded from 'cpoptions' a wrapped
5896 line will not use the column of line numbers (this is the default when
5897 'compatible' isn't set).
5898 The 'numberwidth' option can be used to set the room used for the line
5899 number.
5900 When a long, wrapped line doesn't start with the first character, '-'
5901 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005902 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5903 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005904
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005905 The number in front of the cursor line also depends on the value of
5906 'number', see |number_relativenumber| for all combinations of the two
5907 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005908
Bram Moolenaar071d4272004-06-13 20:20:40 +00005909 *'remap'* *'noremap'*
5910'remap' boolean (default on)
5911 global
5912 Allows for mappings to work recursively. If you do not want this for
5913 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005914 NOTE: To avoid portability problems with Vim scripts, always keep
5915 this option at the default "on". Only switch it off when working with
5916 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005918 *'renderoptions'* *'rop'*
5919'renderoptions' 'rop' string (default: empty)
5920 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005921 {only available when compiled with GUI and DIRECTX on
5922 MS-Windows}
5923 Select a text renderer and set its options. The options depend on the
5924 renderer.
5925
5926 Syntax: >
5927 set rop=type:{renderer}(,{name}:{value})*
5928<
5929 Currently, only one optional renderer is available.
5930
5931 render behavior ~
5932 directx Vim will draw text using DirectX (DirectWrite). It makes
5933 drawn glyphs more beautiful than default GDI.
5934 It requires 'encoding' is "utf-8", and only works on
5935 MS-Windows Vista or newer version.
5936
5937 Options:
5938 name meaning type value ~
5939 gamma gamma float 1.0 - 2.2 (maybe)
5940 contrast enhancedContrast float (unknown)
5941 level clearTypeLevel float (unknown)
5942 geom pixelGeometry int 0 - 2 (see below)
5943 renmode renderingMode int 0 - 6 (see below)
5944 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01005945 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005946
Bram Moolenaar92467d32017-12-05 13:22:16 +01005947 See this URL for detail (except for scrlines):
5948 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005949
5950 For geom: structure of a device pixel.
5951 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5952 1 - DWRITE_PIXEL_GEOMETRY_RGB
5953 2 - DWRITE_PIXEL_GEOMETRY_BGR
5954
5955 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005956 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005957
5958 For renmode: method of rendering glyphs.
5959 0 - DWRITE_RENDERING_MODE_DEFAULT
5960 1 - DWRITE_RENDERING_MODE_ALIASED
5961 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5962 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5963 4 - DWRITE_RENDERING_MODE_NATURAL
5964 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5965 6 - DWRITE_RENDERING_MODE_OUTLINE
5966
5967 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005968 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005969
5970 For taamode: antialiasing mode used for drawing text.
5971 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5972 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5973 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5974 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5975
5976 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005977 https://msdn.microsoft.com/en-us/library/dd368170.aspx
5978
Bram Moolenaara338adc2018-01-31 20:51:47 +01005979 For scrlines:
5980 This was used for optimizing scrolling behavior, however this
5981 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005982
5983 Example: >
5984 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005985 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005986 set rop=type:directx
5987<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005988 If select a raster font (Courier, Terminal or FixedSys which
5989 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01005990 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005991
5992 NOTE: It is known that some fonts and options combination
5993 causes trouble on drawing glyphs.
5994
Bram Moolenaar92467d32017-12-05 13:22:16 +01005995 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005996 special made fonts (True-Type fonts which includes only
5997 bitmap glyphs).
5998 - 'taamode:3' will not work with some vector fonts.
5999
6000 NOTE: With this option, you can display colored emoji
6001 (emoticon) in Windows 8.1 or later. To display colored emoji,
6002 there are some conditions which you should notice.
6003
6004 - If your font includes non-colored emoji already, it will
6005 be used.
6006 - If your font doesn't have emoji, the system chooses an
6007 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6008 will be used.
6009 - When this alternative font didn't have fixed width glyph,
6010 emoji might be rendered beyond the bounding box of drawing
6011 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006012
6013 Other render types are currently not supported.
6014
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 *'report'*
6016'report' number (default 2)
6017 global
6018 Threshold for reporting number of lines changed. When the number of
6019 changed lines is more than 'report' a message will be given for most
6020 ":" commands. If you want it always, set 'report' to 0.
6021 For the ":substitute" command the number of substitutions is used
6022 instead of the number of lines.
6023
6024 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6025'restorescreen' 'rs' boolean (default on)
6026 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006027 {only in Windows 95/NT console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 When set, the screen contents is restored when exiting Vim. This also
6029 happens when executing external commands.
6030
6031 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6032 options in your .vimrc. To disable restoring:
6033 set t_ti= t_te=
6034 To enable restoring (for an xterm):
6035 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6036 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6037
6038 *'revins'* *'ri'* *'norevins'* *'nori'*
6039'revins' 'ri' boolean (default off)
6040 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041 {only available when compiled with the |+rightleft|
6042 feature}
6043 Inserting characters in Insert mode will work backwards. See "typing
6044 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6045 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006046 NOTE: This option is reset when 'compatible' is set.
6047 This option is reset when 'paste' is set and restored when 'paste' is
6048 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006049
6050 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6051'rightleft' 'rl' boolean (default off)
6052 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006053 {only available when compiled with the |+rightleft|
6054 feature}
6055 When on, display orientation becomes right-to-left, i.e., characters
6056 that are stored in the file appear from the right to the left.
6057 Using this option, it is possible to edit files for languages that
6058 are written from the right to the left such as Hebrew and Arabic.
6059 This option is per window, so it is possible to edit mixed files
6060 simultaneously, or to view the same file in both ways (this is
6061 useful whenever you have a mixed text file with both right-to-left
6062 and left-to-right strings so that both sets are displayed properly
6063 in different windows). Also see |rileft.txt|.
6064
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006065 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066'rightleftcmd' 'rlc' string (default "search")
6067 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006068 {only available when compiled with the |+rightleft|
6069 feature}
6070 Each word in this option enables the command line editing to work in
6071 right-to-left mode for a group of commands:
6072
6073 search "/" and "?" commands
6074
6075 This is useful for languages such as Hebrew, Arabic and Farsi.
6076 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6077
Bram Moolenaard94464e2015-11-02 15:28:18 +01006078 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006079'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006080 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006081 {only available when compiled with the |+ruby/dyn|
6082 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006083 Specifies the name of the Ruby shared library. The default is
6084 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006085 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006086 This option cannot be set from a |modeline| or in the |sandbox|, for
6087 security reasons.
6088
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006090'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092 {not available when compiled without the
6093 |+cmdline_info| feature}
6094 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006095 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 text in the file is shown on the far right:
6097 Top first line is visible
6098 Bot last line is visible
6099 All first and last line are visible
6100 45% relative position in the file
6101 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006102 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006104 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105 this option takes precedence over 'ruler' and 'rulerformat'
6106 If the number of characters displayed is different from the number of
6107 bytes in the text (e.g., for a TAB or a multi-byte character), both
6108 the text column (byte number) and the screen column are shown,
6109 separated with a dash.
6110 For an empty line "0-1" is shown.
6111 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006112 This option is reset when 'paste' is set and restored when 'paste' is
6113 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 If you don't want to see the ruler all the time but want to know where
6115 you are, use "g CTRL-G" |g_CTRL-G|.
6116 NOTE: This option is reset when 'compatible' is set.
6117
6118 *'rulerformat'* *'ruf'*
6119'rulerformat' 'ruf' string (default empty)
6120 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 {not available when compiled without the |+statusline|
6122 feature}
6123 When this option is not empty, it determines the content of the ruler
6124 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006125 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006126 This option cannot be set in a modeline when 'modelineexpr' is off.
6127
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 The default ruler width is 17 characters. To make the ruler 15
6129 characters wide, put "%15(" at the start and "%)" at the end.
6130 Example: >
6131 :set rulerformat=%15(%c%V\ %p%%%)
6132<
6133 *'runtimepath'* *'rtp'* *vimfiles*
6134'runtimepath' 'rtp' string (default:
6135 Unix: "$HOME/.vim,
6136 $VIM/vimfiles,
6137 $VIMRUNTIME,
6138 $VIM/vimfiles/after,
6139 $HOME/.vim/after"
6140 Amiga: "home:vimfiles,
6141 $VIM/vimfiles,
6142 $VIMRUNTIME,
6143 $VIM/vimfiles/after,
6144 home:vimfiles/after"
6145 PC, OS/2: "$HOME/vimfiles,
6146 $VIM/vimfiles,
6147 $VIMRUNTIME,
6148 $VIM/vimfiles/after,
6149 $HOME/vimfiles/after"
6150 Macintosh: "$VIM:vimfiles,
6151 $VIMRUNTIME,
6152 $VIM:vimfiles:after"
6153 RISC-OS: "Choices:vimfiles,
6154 $VIMRUNTIME,
6155 Choices:vimfiles/after"
6156 VMS: "sys$login:vimfiles,
6157 $VIM/vimfiles,
6158 $VIMRUNTIME,
6159 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006160 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162 This is a list of directories which will be searched for runtime
6163 files:
6164 filetype.vim filetypes by file name |new-filetype|
6165 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006166 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 colors/ color scheme files |:colorscheme|
6168 compiler/ compiler files |:compiler|
6169 doc/ documentation |write-local-help|
6170 ftplugin/ filetype plugins |write-filetype-plugin|
6171 indent/ indent scripts |indent-expression|
6172 keymap/ key mapping files |mbyte-keymap|
6173 lang/ menu translations |:menutrans|
6174 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006175 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 plugin/ plugin scripts |write-plugin|
6177 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006178 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179 syntax/ syntax files |mysyntaxfile|
6180 tutor/ files for vimtutor |tutor|
6181
6182 And any other file searched for with the |:runtime| command.
6183
6184 The defaults for most systems are setup to search five locations:
6185 1. In your home directory, for your personal preferences.
6186 2. In a system-wide Vim directory, for preferences from the system
6187 administrator.
6188 3. In $VIMRUNTIME, for files distributed with Vim.
6189 *after-directory*
6190 4. In the "after" directory in the system-wide Vim directory. This is
6191 for the system administrator to overrule or add to the distributed
6192 defaults (rarely needed)
6193 5. In the "after" directory in your home directory. This is for
6194 personal preferences to overrule or add to the distributed defaults
6195 or system-wide settings (rarely needed).
6196
Bram Moolenaard0796902016-09-16 20:02:31 +02006197 More entries are added when using |packages|. If it gets very long
6198 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6199 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006200
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6202 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006203 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204 wildcards.
6205 See |:runtime|.
6206 Example: >
6207 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6208< This will use the directory "~/vimruntime" first (containing your
6209 personal Vim runtime files), then "/mygroup/vim" (shared between a
6210 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6211 files).
6212 You probably should always include $VIMRUNTIME somewhere, to use the
6213 distributed runtime files. You can put a directory before $VIMRUNTIME
6214 to find files which replace a distributed runtime files. You can put
6215 a directory after $VIMRUNTIME to find files which add to distributed
6216 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006217 When Vim is started with |--clean| the home directory entries are not
6218 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219 This option cannot be set from a |modeline| or in the |sandbox|, for
6220 security reasons.
6221
6222 *'scroll'* *'scr'*
6223'scroll' 'scr' number (default: half the window height)
6224 local to window
6225 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6226 set to half the number of lines in the window when the window size
6227 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006228 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006229 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006230
6231 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6232'scrollbind' 'scb' boolean (default off)
6233 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 See also |scroll-binding|. When this option is set, the current
6235 window scrolls as other scrollbind windows (windows that also have
6236 this option set) scroll. This option is useful for viewing the
6237 differences between two versions of a file, see 'diff'.
6238 See |'scrollopt'| for options that determine how this option should be
6239 interpreted.
6240 This option is mostly reset when splitting a window to edit another
6241 file. This means that ":split | edit file" results in two windows
6242 with scroll-binding, but ":split file" does not.
6243
6244 *'scrolljump'* *'sj'*
6245'scrolljump' 'sj' number (default 1)
6246 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 Minimal number of lines to scroll when the cursor gets off the
6248 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6249 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006250 When set to a negative number from -1 to -100 this is used as the
6251 percentage of the window height. Thus -50 scrolls half the window
6252 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 NOTE: This option is set to 1 when 'compatible' is set.
6254
6255 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006256'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006257 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 Minimal number of screen lines to keep above and below the cursor.
6259 This will make some context visible around where you are working. If
6260 you set it to a very large value (999) the cursor line will always be
6261 in the middle of the window (except at the start or end of the file or
6262 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006263 After using the local value, go back the global value with one of
6264 these two: >
6265 setlocal scrolloff<
6266 setlocal scrolloff=-1
6267< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268 NOTE: This option is set to 0 when 'compatible' is set.
6269
6270 *'scrollopt'* *'sbo'*
6271'scrollopt' 'sbo' string (default "ver,jump")
6272 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006273 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006274 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6275 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276 The following words are available:
6277 ver Bind vertical scrolling for 'scrollbind' windows
6278 hor Bind horizontal scrolling for 'scrollbind' windows
6279 jump Applies to the offset between two windows for vertical
6280 scrolling. This offset is the difference in the first
6281 displayed line of the bound windows. When moving
6282 around in a window, another 'scrollbind' window may
6283 reach a position before the start or after the end of
6284 the buffer. The offset is not changed though, when
6285 moving back the 'scrollbind' window will try to scroll
6286 to the desired position when possible.
6287 When now making that window the current one, two
6288 things can be done with the relative offset:
6289 1. When "jump" is not included, the relative offset is
6290 adjusted for the scroll position in the new current
6291 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006292 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293 2. When "jump" is included, the other windows are
6294 scrolled to keep the same relative offset. When
6295 going back to the other window, it still uses the
6296 same relative offset.
6297 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006298 When 'diff' mode is active there always is vertical scroll binding,
6299 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006300
6301 *'sections'* *'sect'*
6302'sections' 'sect' string (default "SHNHH HUnhsh")
6303 global
6304 Specifies the nroff macros that separate sections. These are pairs of
6305 two letters (See |object-motions|). The default makes a section start
6306 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6307
6308 *'secure'* *'nosecure'* *E523*
6309'secure' boolean (default off)
6310 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311 When on, ":autocmd", shell and write commands are not allowed in
6312 ".vimrc" and ".exrc" in the current directory and map commands are
6313 displayed. Switch it off only if you know that you will not run into
6314 problems, or when the 'exrc' option is off. On Unix this option is
6315 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006316 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 'secure' at the end of your ~/.vimrc then.
6318 This option cannot be set from a |modeline| or in the |sandbox|, for
6319 security reasons.
6320
6321 *'selection'* *'sel'*
6322'selection' 'sel' string (default "inclusive")
6323 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 This option defines the behavior of the selection. It is only used
6325 in Visual and Select mode.
6326 Possible values:
6327 value past line inclusive ~
6328 old no yes
6329 inclusive yes yes
6330 exclusive yes no
6331 "past line" means that the cursor is allowed to be positioned one
6332 character past the line.
6333 "inclusive" means that the last character of the selection is included
6334 in an operation. For example, when "x" is used to delete the
6335 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006336 When "old" is used and 'virtualedit' allows the cursor to move past
6337 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338 Note that when "exclusive" is used and selecting from the end
6339 backwards, you cannot include the last character of a line, when
6340 starting in Normal mode and 'virtualedit' empty.
6341
6342 The 'selection' option is set by the |:behave| command.
6343
6344 *'selectmode'* *'slm'*
6345'selectmode' 'slm' string (default "")
6346 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006347 This is a comma separated list of words, which specifies when to start
6348 Select mode instead of Visual mode, when a selection is started.
6349 Possible values:
6350 mouse when using the mouse
6351 key when using shifted special keys
6352 cmd when using "v", "V" or CTRL-V
6353 See |Select-mode|.
6354 The 'selectmode' option is set by the |:behave| command.
6355
6356 *'sessionoptions'* *'ssop'*
6357'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006358 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006360 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 feature}
6362 Changes the effect of the |:mksession| command. It is a comma
6363 separated list of words. Each word enables saving and restoring
6364 something:
6365 word save and restore ~
6366 blank empty windows
6367 buffers hidden and unloaded buffers, not just those in windows
6368 curdir the current directory
6369 folds manually created folds, opened/closed folds and local
6370 fold options
6371 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006372 and contain at least one lowercase letter. Only
6373 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 help the help window
6375 localoptions options and mappings local to a window or buffer (not
6376 global values for local options)
6377 options all options and mappings (also global values for local
6378 options)
6379 resize size of the Vim window: 'lines' and 'columns'
6380 sesdir the directory in which the session file is located
6381 will become the current directory (useful with
6382 projects accessed over a network from different
6383 systems)
6384 slash backslashes in file names replaced with forward
6385 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006386 tabpages all tab pages; without this only the current tab page
6387 is restored, so that you can make a session for each
6388 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006389 terminal include terminal windows where the command can be
6390 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 unix with Unix end-of-line format (single <NL>), even when
6392 on Windows or DOS
6393 winpos position of the whole Vim window
6394 winsize window sizes
6395
6396 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006397 When neither "curdir" nor "sesdir" is included, file names are stored
6398 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 "slash" and "unix" are useful on Windows when sharing session files
6400 with Unix. The Unix version of Vim cannot source dos format scripts,
6401 but the Windows version of Vim can source unix format scripts.
6402
6403 *'shell'* *'sh'* *E91*
6404'shell' 'sh' string (default $SHELL or "sh",
6405 MS-DOS and Win32: "command.com" or
6406 "cmd.exe", OS/2: "cmd")
6407 global
6408 Name of the shell to use for ! and :! commands. When changing the
6409 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6410 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006411 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 See |option-backslash| about including spaces and backslashes.
6413 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006414
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006416 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006417 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6418< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006419 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006421 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006423 Example with escaped space (Vim will do this when initializing the
6424 option from $SHELL): >
6425 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006426< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006427 backslashes are consumed by `:set`.
6428
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 Under MS-Windows, when the executable ends in ".com" it must be
6430 included. Thus setting the shell to "command.com" or "4dos.com"
6431 works, but "command" and "4dos" do not work for all commands (e.g.,
6432 filtering).
6433 For unknown reasons, when using "4dos.com" the current directory is
6434 changed to "C:\". To avoid this set 'shell' like this: >
6435 :set shell=command.com\ /c\ 4dos
6436< This option cannot be set from a |modeline| or in the |sandbox|, for
6437 security reasons.
6438
6439 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006440'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006441 MS-DOS and Win32, when 'shell' does not
6442 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6445 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6446 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006447 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006448 On Unix it can have more than one flag. Each white space separated
6449 part is passed as an argument to the shell command.
6450 See |option-backslash| about including spaces and backslashes.
6451 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452 This option cannot be set from a |modeline| or in the |sandbox|, for
6453 security reasons.
6454
6455 *'shellpipe'* *'sp'*
6456'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6457 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 {not available when compiled without the |+quickfix|
6459 feature}
6460 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006461 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462 including spaces and backslashes.
6463 The name of the temporary file can be represented by "%s" if necessary
6464 (the file name is appended automatically if no %s appears in the value
6465 of this option).
6466 For the Amiga and MS-DOS the default is ">". The output is directly
6467 saved in a file and not echoed to the screen.
6468 For Unix the default it "| tee". The stdout of the compiler is saved
6469 in a file and echoed to the screen. If the 'shell' option is "csh" or
6470 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006471 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6472 default becomes "2>&1| tee". This means that stderr is also included.
6473 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6474 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475 The initialization of this option is done after reading the ".vimrc"
6476 and the other initializations, so that when the 'shell' option is set
6477 there, the 'shellpipe' option changes automatically, unless it was
6478 explicitly set before.
6479 When 'shellpipe' is set to an empty string, no redirection of the
6480 ":make" output will be done. This is useful if you use a 'makeprg'
6481 that writes to 'makeef' by itself. If you want no piping, but do
6482 want to include the 'makeef', set 'shellpipe' to a single space.
6483 Don't forget to precede the space with a backslash: ":set sp=\ ".
6484 In the future pipes may be used for filtering and this option will
6485 become obsolete (at least for Unix).
6486 This option cannot be set from a |modeline| or in the |sandbox|, for
6487 security reasons.
6488
6489 *'shellquote'* *'shq'*
6490'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6491 contains "sh" somewhere: "\"")
6492 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493 Quoting character(s), put around the command passed to the shell, for
6494 the "!" and ":!" commands. The redirection is kept outside of the
6495 quoting. See 'shellxquote' to include the redirection. It's
6496 probably not useful to set both options.
6497 This is an empty string by default. Only known to be useful for
6498 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6499 or bash, where it should be "\"". The default is adjusted according
6500 the value of 'shell', to reduce the need to set this option by the
6501 user. See |dos-shell|.
6502 This option cannot be set from a |modeline| or in the |sandbox|, for
6503 security reasons.
6504
6505 *'shellredir'* *'srr'*
6506'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6507 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 String to be used to put the output of a filter command in a temporary
6509 file. See also |:!|. See |option-backslash| about including spaces
6510 and backslashes.
6511 The name of the temporary file can be represented by "%s" if necessary
6512 (the file name is appended automatically if no %s appears in the value
6513 of this option).
6514 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6515 or "zsh" during initializations, the default becomes ">&". If the
6516 'shell' option is "sh", "ksh" or "bash" the default becomes
6517 ">%s 2>&1". This means that stderr is also included.
6518 For Win32, the Unix checks are done and additionally "cmd" is checked
6519 for, which makes the default ">%s 2>&1". Also, the same names with
6520 ".exe" appended are checked for.
6521 The initialization of this option is done after reading the ".vimrc"
6522 and the other initializations, so that when the 'shell' option is set
6523 there, the 'shellredir' option changes automatically unless it was
6524 explicitly set before.
6525 In the future pipes may be used for filtering and this option will
6526 become obsolete (at least for Unix).
6527 This option cannot be set from a |modeline| or in the |sandbox|, for
6528 security reasons.
6529
6530 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6531'shellslash' 'ssl' boolean (default off)
6532 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006533 {only for MSDOS, MS-Windows and OS/2}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006534 When set, a forward slash is used when expanding file names. This is
6535 useful when a Unix-like shell is used instead of command.com or
6536 cmd.exe. Backward slashes can still be typed, but they are changed to
6537 forward slashes by Vim.
6538 Note that setting or resetting this option has no effect for some
6539 existing file names, thus this option needs to be set before opening
6540 any file for best results. This might change in the future.
6541 'shellslash' only works when a backslash can be used as a path
6542 separator. To test if this is so use: >
6543 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006544< Also see 'completeslash'.
6545
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006546 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6547'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6548 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006549 When on, use temp files for shell commands. When off use a pipe.
6550 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006551 Currently a pipe is only supported on Unix and MS-Windows 2K and
6552 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006553 :if has("filterpipe")
6554< The advantage of using a pipe is that nobody can read the temp file
6555 and the 'shell' command does not need to support redirection.
6556 The advantage of using a temp file is that the file type and encoding
6557 can be detected.
6558 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6559 |FilterWritePost| autocommands event are not triggered when
6560 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006561 The `system()` function does not respect this option and always uses
6562 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006563 NOTE: This option is set to the Vim default value when 'compatible'
6564 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006565
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 *'shelltype'* *'st'*
6567'shelltype' 'st' number (default 0)
6568 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006569 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 On the Amiga this option influences the way how the commands work
6571 which use a shell.
6572 0 and 1: always use the shell
6573 2 and 3: use the shell only to filter lines
6574 4 and 5: use shell only for ':sh' command
6575 When not using the shell, the command is executed directly.
6576
6577 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6578 1 and 3: use "shell cmd" to start external commands
6579
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006580 *'shellxescape'* *'sxe'*
6581'shellxescape' 'sxe' string (default: "";
6582 for MS-DOS and MS-Windows: "\"&|<>()@^")
6583 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006584 When 'shellxquote' is set to "(" then the characters listed in this
6585 option will be escaped with a '^' character. This makes it possible
6586 to execute most external commands with cmd.exe.
6587
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 *'shellxquote'* *'sxq'*
6589'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006590 for Win32, when 'shell' is cmd.exe: "("
6591 for Win32, when 'shell' contains "sh"
6592 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006593 for Unix, when using system(): "\"")
6594 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 Quoting character(s), put around the command passed to the shell, for
6596 the "!" and ":!" commands. Includes the redirection. See
6597 'shellquote' to exclude the redirection. It's probably not useful
6598 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006599 When the value is '(' then ')' is appended. When the value is '"('
6600 then ')"' is appended.
6601 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006602 This is an empty string by default on most systems, but is known to be
6603 useful for on Win32 version, either for cmd.exe which automatically
6604 strips off the first and last quote on a command, or 3rd-party shells
6605 such as the MKS Korn Shell or bash, where it should be "\"". The
6606 default is adjusted according the value of 'shell', to reduce the need
6607 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608 This option cannot be set from a |modeline| or in the |sandbox|, for
6609 security reasons.
6610
6611 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6612'shiftround' 'sr' boolean (default off)
6613 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 Round indent to multiple of 'shiftwidth'. Applies to > and <
6615 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6616 a multiple of 'shiftwidth' (this is Vi compatible).
6617 NOTE: This option is reset when 'compatible' is set.
6618
6619 *'shiftwidth'* *'sw'*
6620'shiftwidth' 'sw' number (default 8)
6621 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006622 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006624 When zero the 'ts' value will be used. Use the |shiftwidth()|
6625 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626
6627 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006628'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6629 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006630 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 This option helps to avoid all the |hit-enter| prompts caused by file
6632 messages, for example with CTRL-G, and to avoid some other messages.
6633 It is a list of flags:
6634 flag meaning when present ~
6635 f use "(3 of 5)" instead of "(file 3 of 5)"
6636 i use "[noeol]" instead of "[Incomplete last line]"
6637 l use "999L, 888C" instead of "999 lines, 888 characters"
6638 m use "[+]" instead of "[Modified]"
6639 n use "[New]" instead of "[New File]"
6640 r use "[RO]" instead of "[readonly]"
6641 w use "[w]" instead of "written" for file write message
6642 and "[a]" instead of "appended" for ':w >> file' command
6643 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6644 "[unix format]" and "[mac]" instead of "[mac format]".
6645 a all of the above abbreviations
6646
6647 o overwrite message for writing a file with subsequent message
6648 for reading a file (useful for ":wn" or when 'autowrite' on)
6649 O message for reading a file overwrites any previous message.
6650 Also for quickfix message (e.g., ":cn").
6651 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006652 hit TOP, continuing at BOTTOM" messages; when using the search
6653 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 t truncate file message at the start if it is too long to fit
6655 on the command-line, "<" will appear in the left most column.
6656 Ignored in Ex mode.
6657 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006658 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659 Ignored in Ex mode.
6660 W don't give "written" or "[w]" when writing a file
6661 A don't give the "ATTENTION" message when an existing swap file
6662 is found.
6663 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006664 c don't give |ins-completion-menu| messages. For example,
6665 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6666 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006667 q use "recording" instead of "recording @a"
6668 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006669 was used for the command; note that this also affects messages
6670 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006671 S do not show search count message when searching, e.g.
6672 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673
6674 This gives you the opportunity to avoid that a change between buffers
6675 requires you to hit <Enter>, but still gives as useful a message as
6676 possible for the space available. To get the whole message that you
6677 would have got with 'shm' empty, use ":file!"
6678 Useful values:
6679 shm= No abbreviation of message.
6680 shm=a Abbreviation, but no loss of information.
6681 shm=at Abbreviation, and truncate message when necessary.
6682
6683 NOTE: This option is set to the Vi default value when 'compatible' is
6684 set and to the Vim default value when 'compatible' is reset.
6685
6686 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6687'shortname' 'sn' boolean (default off)
6688 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 Filenames are assumed to be 8 characters plus one extension of 3
6690 characters. Multiple dots in file names are not allowed. When this
6691 option is on, dots in file names are replaced with underscores when
6692 adding an extension (".~" or ".swp"). This option is not available
6693 for MS-DOS, because then it would always be on. This option is useful
6694 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6695 or crossdos. When running the Win32 GUI version under Win32s, this
6696 option is always on by default.
6697
6698 *'showbreak'* *'sbr'* *E595*
6699'showbreak' 'sbr' string (default "")
6700 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006701 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 feature}
6703 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006704 values are "> " or "+++ ": >
6705 :set showbreak=>\
6706< Note the backslash to escape the trailing space. It's easier like
6707 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006708 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006709< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710 comma (in a future version the comma might be used to separate the
6711 part that is shown at the end and at the start of a line).
6712 The characters are highlighted according to the '@' flag in
6713 'highlight'.
6714 Note that tabs after the showbreak will be displayed differently.
6715 If you want the 'showbreak' to appear in between line numbers, add the
6716 "n" flag to 'cpoptions'.
6717
6718 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006719'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6720 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 {not available when compiled without the
6723 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006724 Show (partial) command in the last line of the screen. Set this
6725 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726 In Visual mode the size of the selected area is shown:
6727 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006728 If the number of bytes is different it is also displayed: "2-6"
6729 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006731 - When selecting a block, the size in screen characters:
6732 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733 NOTE: This option is set to the Vi default value when 'compatible' is
6734 set and to the Vim default value when 'compatible' is reset.
6735
6736 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6737'showfulltag' 'sft' boolean (default off)
6738 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739 When completing a word in insert mode (see |ins-completion|) from the
6740 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006741 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 matched a C function, you can see a template for what arguments are
6743 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006744 Note that this doesn't work well together with having "longest" in
6745 'completeopt', because the completion from the search pattern may not
6746 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747
6748 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6749'showmatch' 'sm' boolean (default off)
6750 global
6751 When a bracket is inserted, briefly jump to the matching one. The
6752 jump is only done if the match can be seen on the screen. The time to
6753 show the match can be set with 'matchtime'.
6754 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006755 seen or not).
6756 This option is reset when 'paste' is set and restored when 'paste' is
6757 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 When the 'm' flag is not included in 'cpoptions', typing a character
6759 will immediately move the cursor back to where it belongs.
6760 See the "sm" field in 'guicursor' for setting the cursor shape and
6761 blinking when showing the match.
6762 The 'matchpairs' option can be used to specify the characters to show
6763 matches for. 'rightleft' and 'revins' are used to look for opposite
6764 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006765 Also see the matchparen plugin for highlighting the match when moving
6766 around |pi_paren.txt|.
6767 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768
6769 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6770'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6771 global
6772 If in Insert, Replace or Visual mode put a message on the last line.
6773 Use the 'M' flag in 'highlight' to set the type of highlighting for
6774 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006775 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776 doesn't mean XIM is really active, especially when 'imactivatekey' is
6777 not set.
6778 NOTE: This option is set to the Vi default value when 'compatible' is
6779 set and to the Vim default value when 'compatible' is reset.
6780
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006781 *'showtabline'* *'stal'*
6782'showtabline' 'stal' number (default 1)
6783 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006784 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006785 feature}
6786 The value of this option specifies when the line with tab page labels
6787 will be displayed:
6788 0: never
6789 1: only if there are at least two tab pages
6790 2: always
6791 This is both for the GUI and non-GUI implementation of the tab pages
6792 line.
6793 See |tab-page| for more information about tab pages.
6794
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795 *'sidescroll'* *'ss'*
6796'sidescroll' 'ss' number (default 0)
6797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798 The minimal number of columns to scroll horizontally. Used only when
6799 the 'wrap' option is off and the cursor is moved off of the screen.
6800 When it is zero the cursor will be put in the middle of the screen.
6801 When using a slow terminal set it to a large number or 0. When using
6802 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6803 commands.
6804
6805 *'sidescrolloff'* *'siso'*
6806'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006807 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006809 right of the cursor if 'nowrap' is set. Setting this option to a
6810 value greater than 0 while having |'sidescroll'| also at a non-zero
6811 value makes some context visible in the line you are scrolling in
6812 horizontally (except at beginning of the line). Setting this option
6813 to a large value (like 999) has the effect of keeping the cursor
6814 horizontally centered in the window, as long as one does not come too
6815 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006816 After using the local value, go back the global value with one of
6817 these two: >
6818 setlocal sidescrolloff<
6819 setlocal sidescrolloff=-1
6820< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821
6822 Example: Try this together with 'sidescroll' and 'listchars' as
6823 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006824 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825
6826 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6827 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006828<
6829 *'signcolumn'* *'scl'*
6830'signcolumn' 'scl' string (default "auto")
6831 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006832 {not available when compiled without the |+signs|
6833 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006834 Whether or not to draw the signcolumn. Valid values are:
6835 "auto" only when there is a sign to display
6836 "no" never
6837 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006838 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006839 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840
6841
6842 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6843'smartcase' 'scs' boolean (default off)
6844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845 Override the 'ignorecase' option if the search pattern contains upper
6846 case characters. Only used when the search pattern is typed and
6847 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006848 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006849 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6850 recalling the search pattern from history and hitting <Enter>.
6851 NOTE: This option is reset when 'compatible' is set.
6852
6853 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6854'smartindent' 'si' boolean (default off)
6855 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856 {not available when compiled without the
6857 |+smartindent| feature}
6858 Do smart autoindenting when starting a new line. Works for C-like
6859 programs, but can also be used for other languages. 'cindent' does
6860 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006861 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006862 setting 'si' has no effect. 'indentexpr' is a more advanced
6863 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864 Normally 'autoindent' should also be on when using 'smartindent'.
6865 An indent is automatically inserted:
6866 - After a line ending in '{'.
6867 - After a line starting with a keyword from 'cinwords'.
6868 - Before a line starting with '}' (only with the "O" command).
6869 When typing '}' as the first character in a new line, that line is
6870 given the same indent as the matching '{'.
6871 When typing '#' as the first character in a new line, the indent for
6872 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006873 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6875 When using the ">>" command, lines starting with '#' are not shifted
6876 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006877 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006878 This option is reset when 'paste' is set and restored when 'paste' is
6879 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880
6881 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6882'smarttab' 'sta' boolean (default off)
6883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006885 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6886 <BS> will delete a 'shiftwidth' worth of space at the start of the
6887 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006888 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006889 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6890 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006891 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006893 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006894 This option is reset when 'paste' is set and restored when 'paste' is
6895 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896 NOTE: This option is reset when 'compatible' is set.
6897
6898 *'softtabstop'* *'sts'*
6899'softtabstop' 'sts' number (default 0)
6900 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 Number of spaces that a <Tab> counts for while performing editing
6902 operations, like inserting a <Tab> or using <BS>. It "feels" like
6903 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6904 used. This is useful to keep the 'ts' setting at its standard value
6905 of 8, while being able to edit like it is set to 'sts'. However,
6906 commands like "x" still work on the actual characters.
6907 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006908 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006909 'softtabstop' is set to 0 when the 'paste' option is set and restored
6910 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6912 spaces is minimized by using <Tab>s.
6913 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6914 set.
6915 NOTE: This option is set to 0 when 'compatible' is set.
6916
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006917 If Vim is compiled with the |+vartabs| feature then the value of
6918 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6919 anything other than an empty string.
6920
Bram Moolenaar217ad922005-03-20 22:37:15 +00006921 *'spell'* *'nospell'*
6922'spell' boolean (default off)
6923 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006924 {not available when compiled without the |+syntax|
6925 feature}
6926 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006927 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006928
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006929 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006930'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006931 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006932 {not available when compiled without the |+syntax|
6933 feature}
6934 Pattern to locate the end of a sentence. The following word will be
6935 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006936 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006937 When this check is not wanted make this option empty.
6938 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006939 Be careful with special characters, see |option-backslash| about
6940 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006941 To set this option automatically depending on the language, see
6942 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006943
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006944 *'spellfile'* *'spf'*
6945'spellfile' 'spf' string (default empty)
6946 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006947 {not available when compiled without the |+syntax|
6948 feature}
6949 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006950 commands. It must end in ".{encoding}.add". You need to include the
6951 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006952 *E765*
6953 It may also be a comma separated list of names. A count before the
6954 |zg| and |zw| commands can be used to access each. This allows using
6955 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006956 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006957 you: Using the first directory in 'runtimepath' that is writable. If
6958 there is no "spell" directory yet it will be created. For the file
6959 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006960 ignoring the region.
6961 The resulting ".spl" file will be used for spell checking, it does not
6962 have to appear in 'spelllang'.
6963 Normally one file is used for all regions, but you can add the region
6964 name if you want to. However, it will then only be used when
6965 'spellfile' is set to it, for entries in 'spelllang' only files
6966 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006967 This option cannot be set from a |modeline| or in the |sandbox|, for
6968 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006969
Bram Moolenaar217ad922005-03-20 22:37:15 +00006970 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006971'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006972 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00006973 {not available when compiled without the |+syntax|
6974 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006975 A comma separated list of word list names. When the 'spell' option is
6976 on spellchecking will be done for these languages. Example: >
6977 set spelllang=en_us,nl,medical
6978< This means US English, Dutch and medical words are recognized. Words
6979 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02006980 The word list name must consist of alphanumeric characters, a dash or
6981 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00006982 recommended to separate the two letter language name from a
6983 specification. Thus "en-rare" is used for rare English words.
6984 A region name must come last and have the form "_xx", where "xx" is
6985 the two-letter, lower case region name. You can use more than one
6986 region by listing them: "en_us,en_ca" supports both US and Canadian
6987 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01006988 Britain. (Note: currently en_au and en_nz dictionaries are older than
6989 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006990 If the name "cjk" is included East Asian characters are excluded from
6991 spell checking. This is useful when editing text that also has Asian
6992 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006993 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006994 As a special case the name of a .spl file can be given as-is. The
6995 first "_xx" in the name is removed and used as the region name
6996 (_xx is an underscore, two letters and followed by a non-letter).
6997 This is mainly for testing purposes. You must make sure the correct
6998 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006999 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007000 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7001 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007002 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007003
Bram Moolenaar98692072006-02-04 00:57:42 +00007004 If the |spellfile.vim| plugin is active and you use a language name
7005 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7006 will ask you if you want to download the file.
7007
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007008 After this option has been set successfully, Vim will source the files
7009 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007010 up to the first character that is not an ASCII letter or number and
7011 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007012
7013
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007014 *'spellsuggest'* *'sps'*
7015'spellsuggest' 'sps' string (default "best")
7016 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007017 {not available when compiled without the |+syntax|
7018 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007019 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007020 the |spellsuggest()| function. This is a comma-separated list of
7021 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007022
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007023 best Internal method that works best for English. Finds
7024 changes like "fast" and uses a bit of sound-a-like
7025 scoring to improve the ordering.
7026
7027 double Internal method that uses two methods and mixes the
7028 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007029 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007030 word. That only works when the language specifies
7031 sound folding. Can be slow and doesn't always give
7032 better results.
7033
7034 fast Internal method that only checks for simple changes:
7035 character inserts/deletes/swaps. Works well for
7036 simple typing mistakes.
7037
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007038 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007039 Not used for |spellsuggest()|. The number of
7040 suggestions is never more than the value of 'lines'
7041 minus two.
7042
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007043 file:{filename} Read file {filename}, which must have two columns,
7044 separated by a slash. The first column contains the
7045 bad word, the second column the suggested good word.
7046 Example:
7047 theribal/terrible ~
7048 Use this for common mistakes that do not appear at the
7049 top of the suggestion list with the internal methods.
7050 Lines without a slash are ignored, use this for
7051 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007052 The word in the second column must be correct,
7053 otherwise it will not be used. Add the word to an
7054 ".add" file if it is currently flagged as a spelling
7055 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007056 The file is used for all languages.
7057
7058 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7059 trouble with spaces. |v:val| holds the badly spelled
7060 word. The expression must evaluate to a List of
7061 Lists, each with a suggestion and a score.
7062 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007063 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007064 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007065 internal methods use. A lower score is better.
7066 This may invoke |spellsuggest()| if you temporarily
7067 set 'spellsuggest' to exclude the "expr:" part.
7068 Errors are silently ignored, unless you set the
7069 'verbose' option to a non-zero value.
7070
7071 Only one of "best", "double" or "fast" may be used. The others may
7072 appear several times in any order. Example: >
7073 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7074<
7075 This option cannot be set from a |modeline| or in the |sandbox|, for
7076 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007077
7078
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7080'splitbelow' 'sb' boolean (default off)
7081 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007082 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007083 feature}
7084 When on, splitting a window will put the new window below the current
7085 one. |:split|
7086
7087 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7088'splitright' 'spr' boolean (default off)
7089 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 When on, splitting a window will put the new window right of the
7091 current one. |:vsplit|
7092
7093 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7094'startofline' 'sol' boolean (default on)
7095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007097 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007098 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007099 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 with a linewise operator, with "%" with a count and to buffer changing
7101 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7102 only has a line number, e.g., ":25" or ":+".
7103 In case of buffer changing commands the cursor is placed at the column
7104 where it was the last time the buffer was edited.
7105 NOTE: This option is set when 'compatible' is set.
7106
Bram Moolenaar00654022011-02-25 14:42:19 +01007107 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007109 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 {not available when compiled without the |+statusline|
7111 feature}
7112 When nonempty, this option determines the content of the status line.
7113 Also see |status-line|.
7114
7115 The option consists of printf style '%' items interspersed with
7116 normal text. Each status line item is of the form:
7117 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007118 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007119 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120
Bram Moolenaar238a5642006-02-21 22:12:05 +00007121 When the option starts with "%!" then it is used as an expression,
7122 evaluated and the result is used as the option value. Example: >
7123 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007124< The *g:statusline_winid* variable will be set to the |window-ID| of the
7125 window that the status line belongs to.
7126 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007127 Note that the "%!" expression is evaluated in the context of the
7128 current window and buffer, while %{} items are evaluated in the
7129 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007130
7131 When there is error while evaluating the option then it will be made
7132 empty to avoid further errors. Otherwise screen updating would loop.
7133
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 Note that the only effect of 'ruler' when this option is set (and
7135 'laststatus' is 2) is controlling the output of |CTRL-G|.
7136
7137 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007138 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007140 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 minwid Minimum width of the item, padding as set by '-' & '0'.
7142 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007143 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007144 on the left for text items. Numeric items will be
7145 shifted down to maxwid-2 digits followed by '>'number
7146 where number is the amount of missing digits, much like
7147 an exponential notation.
7148 item A one letter code as described below.
7149
7150 Following is a description of the possible statusline items. The
7151 second character in "item" is the type:
7152 N for number
7153 S for string
7154 F for flags as described below
7155 - not applicable
7156
7157 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007158 f S Path to the file in the buffer, as typed or relative to current
7159 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 F S Full path to the file in the buffer.
7161 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007162 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007164 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007166 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007167 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007168 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007170 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007171 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007172 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007173 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7174 being used: "<keymap>"
7175 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007176 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 B N As above, in hexadecimal.
7178 o N Byte number in file of byte under cursor, first byte is 1.
7179 Mnemonic: Offset from start of file (with one added)
7180 {not available when compiled without |+byte_offset| feature}
7181 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007182 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007183 l N Line number.
7184 L N Number of lines in buffer.
7185 c N Column number.
7186 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007187 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 p N Percentage through file in lines as in |CTRL-G|.
7189 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007190 percentage described for 'ruler'. Always 3 in length, unless
7191 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007192 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007194 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007195 Note that there is no '%' before the closing '}'. The
7196 expression cannot contain a '}' character, call a function to
7197 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 ( - Start of item group. Can be used for setting the width and
7199 alignment of a section. Must be followed by %) somewhere.
7200 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007201 T N For 'tabline': start of tab page N label. Use %T after the last
7202 label. This information is used for mouse clicks.
7203 X N For 'tabline': start of close tab N label. Use %X after the
7204 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7205 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 < - Where to truncate line if too long. Default is at the start.
7207 No width fields allowed.
7208 = - Separation point between left and right aligned items.
7209 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007210 # - Set highlight group. The name must follow and then a # again.
7211 Thus use %#HLname# for highlight group HLname. The same
7212 highlighting is used, also for the statusline of non-current
7213 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007214 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007215 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216 The difference between User{N} and StatusLine will be applied
7217 to StatusLineNC for the statusline of non-current windows.
7218 The number N must be between 1 and 9. See |hl-User1..9|
7219
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007220 When displaying a flag, Vim removes the leading comma, if any, when
7221 that flag comes right after plaintext. This will make a nice display
7222 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007223
Bram Moolenaar582fd852005-03-28 20:58:01 +00007224 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 not set) and a minwid is not set for the group, the whole group will
7226 become empty. This will make a group like the following disappear
7227 completely from the statusline when none of the flags are set. >
7228 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007229< Beware that an expression is evaluated each and every time the status
7230 line is displayed.
7231 *g:actual_curbuf* *g:actual_curwin*
7232 The current buffer and current window will be set temporarily to that
7233 of the window (and buffer) whose statusline is currently being drawn.
7234 The expression will evaluate in this context. The variable
7235 "g:actual_curbuf" is set to the `bufnr()` number of the real current
7236 buffer and "g:actual_curwin" to the |window-ID| of the real current
7237 window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007238
Bram Moolenaar30b65812012-07-12 22:01:11 +02007239 The 'statusline' option will be evaluated in the |sandbox| if set from
7240 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007241 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007242
7243 It is not allowed to change text or jump to another window while
7244 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007245
7246 If the statusline is not updated when you want it (e.g., after setting
7247 a variable that's used in an expression), you can force an update by
7248 setting an option without changing its value. Example: >
7249 :let &ro = &ro
7250
7251< A result of all digits is regarded a number for display purposes.
7252 Otherwise the result is taken as flag text and applied to the rules
7253 described above.
7254
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007255 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007256 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007257 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007258
7259 Examples:
7260 Emulate standard status line with 'ruler' set >
7261 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7262< Similar, but add ASCII value of char under the cursor (like "ga") >
7263 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7264< Display byte count and byte value, modified flag in red. >
7265 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7266 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7267< Display a ,GZ flag if a compressed file is loaded >
7268 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7269< In the |:autocmd|'s: >
7270 :let b:gzflag = 1
7271< And: >
7272 :unlet b:gzflag
7273< And define this function: >
7274 :function VarExists(var, val)
7275 : if exists(a:var) | return a:val | else | return '' | endif
7276 :endfunction
7277<
7278 *'suffixes'* *'su'*
7279'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 Files with these suffixes get a lower priority when multiple files
7282 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007283 suffixes. Spaces after the comma are ignored. A dot is also seen as
7284 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285 separator, precede it with a backslash (see |option-backslash| about
7286 including spaces and backslashes).
7287 See 'wildignore' for completely ignoring files.
7288 The use of |:set+=| and |:set-=| is preferred when adding or removing
7289 suffixes from the list. This avoids problems when a future version
7290 uses another default.
7291
7292 *'suffixesadd'* *'sua'*
7293'suffixesadd' 'sua' string (default "")
7294 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007295 {not available when compiled without the
7296 |+file_in_path| feature}
7297 Comma separated list of suffixes, which are used when searching for a
7298 file for the "gf", "[I", etc. commands. Example: >
7299 :set suffixesadd=.java
7300<
7301 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7302'swapfile' 'swf' boolean (default on)
7303 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007304 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007305 swapfile is not wanted for a specific buffer. For example, with
7306 confidential information that even root must not be able to access.
7307 Careful: All text will be in memory:
7308 - Don't use this for big files.
7309 - Recovery will be impossible!
7310 A swapfile will only be present when |'updatecount'| is non-zero and
7311 'swapfile' is set.
7312 When 'swapfile' is reset, the swap file for the current buffer is
7313 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7314 non-zero, a swap file is immediately created.
7315 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007316 If you want to open a new buffer without creating a swap file for it,
7317 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007318 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319
7320 This option is used together with 'bufhidden' and 'buftype' to
7321 specify special kinds of buffers. See |special-buffers|.
7322
7323 *'swapsync'* *'sws'*
7324'swapsync' 'sws' string (default "fsync")
7325 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007327 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007328 When this option is empty parts of the swap file may be in memory and
7329 not written to disk. When the system crashes you may lose more work.
7330 On Unix the system does a sync now and then without Vim asking for it,
7331 so the disadvantage of setting this option off is small. On some
7332 systems the swap file will not be written at all. For a unix system
7333 setting it to "sync" will use the sync() call instead of the default
7334 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007335 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336
7337 *'switchbuf'* *'swb'*
7338'switchbuf' 'swb' string (default "")
7339 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007340 This option controls the behavior when switching between buffers.
7341 Possible values (comma separated list):
7342 useopen If included, jump to the first open window that
7343 contains the specified buffer (if there is one).
7344 Otherwise: Do not examine other windows.
7345 This setting is checked with |quickfix| commands, when
7346 jumping to errors (":cc", ":cn", "cp", etc.). It is
7347 also used in all buffer related split commands, for
7348 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007349 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007350 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007352 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007353 Otherwise: do not split, use current window (when used
7354 in the quickfix window: the previously used window or
7355 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007356 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007357 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007358 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007360 *'synmaxcol'* *'smc'*
7361'synmaxcol' 'smc' number (default 3000)
7362 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007363 {not available when compiled without the |+syntax|
7364 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007365 Maximum column in which to search for syntax items. In long lines the
7366 text after this column is not highlighted and following lines may not
7367 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007368 This helps to avoid very slow redrawing for an XML file that is one
7369 long line.
7370 Set to zero to remove the limit.
7371
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372 *'syntax'* *'syn'*
7373'syntax' 'syn' string (default empty)
7374 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 {not available when compiled without the |+syntax|
7376 feature}
7377 When this option is set, the syntax with this name is loaded, unless
7378 syntax highlighting has been switched off with ":syntax off".
7379 Otherwise this option does not always reflect the current syntax (the
7380 b:current_syntax variable does).
7381 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007382 not automatically recognized. Example, in an IDL file:
7383 /* vim: set syntax=idl : */ ~
7384 When a dot appears in the value then this separates two filetype
7385 names. Example:
7386 /* vim: set syntax=c.doxygen : */ ~
7387 This will use the "c" syntax first, then the "doxygen" syntax.
7388 Note that the second one must be prepared to be loaded as an addition,
7389 otherwise it will be skipped. More than one dot may appear.
7390 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007391 :set syntax=OFF
7392< To switch syntax highlighting on according to the current value of the
7393 'filetype' option: >
7394 :set syntax=ON
7395< What actually happens when setting the 'syntax' option is that the
7396 Syntax autocommand event is triggered with the value as argument.
7397 This option is not copied to another buffer, independent of the 's' or
7398 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007399 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007400
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007401 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007402'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007403 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007404 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007405 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007406 When nonempty, this option determines the content of the tab pages
7407 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007408 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007409
7410 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007411 option and only when there is no GUI tab line. When 'e' is in
7412 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007413 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007414
7415 The value is evaluated like with 'statusline'. You can use
7416 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007417 the text to be displayed. Use "%1T" for the first label, "%2T" for
7418 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007419
Bram Moolenaare12bab32019-01-08 22:02:56 +01007420 When changing something that is used in 'tabline' that does not
7421 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007422 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007423
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007424 Keep in mind that only one of the tab pages is the current one, others
7425 are invisible and you can't jump to their windows.
7426
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007427
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007428 *'tabpagemax'* *'tpm'*
7429'tabpagemax' 'tpm' number (default 10)
7430 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007431 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007432 feature}
7433 Maximum number of tab pages to be opened by the |-p| command line
7434 argument or the ":tab all" command. |tabpage|
7435
7436
7437 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007438'tabstop' 'ts' number (default 8)
7439 local to buffer
7440 Number of spaces that a <Tab> in the file counts for. Also see
7441 |:retab| command, and 'softtabstop' option.
7442
7443 Note: Setting 'tabstop' to any other value than 8 can make your file
7444 appear wrong in many places (e.g., when printing it).
7445
7446 There are four main ways to use tabs in Vim:
7447 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7448 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007449 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007450 behave like a tab appears every 4 (or 3) characters.
7451 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7452 'expandtab'. This way you will always insert spaces. The
7453 formatting will never be messed up when 'tabstop' is changed.
7454 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007455 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007456 works when using Vim to edit the file.
7457 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7458 'noexpandtab'. This should then work (for initial indents only)
7459 for any tabstop setting that people use. It might be nice to have
7460 tabs after the first non-blank inserted as spaces if you do this
7461 though. Otherwise aligned comments will be wrong when 'tabstop' is
7462 changed.
7463
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007464 If Vim is compiled with the |+vartabs| feature then the value of
7465 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7466 than an empty string.
7467
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7469'tagbsearch' 'tbs' boolean (default on)
7470 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007472 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473 searching makes searching for a tag a LOT faster, but a linear search
7474 will find more tags if the tags file wasn't properly sorted.
7475 Vim normally assumes that your tags files are sorted, or indicate that
7476 they are not sorted. Only when this is not the case does the
7477 'tagbsearch' option need to be switched off.
7478
7479 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007480 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 certain files, or retry all files with a linear search. When
7482 'tagbsearch' is off, only a linear search is done.
7483
7484 Linear searching is done anyway, for one file, when Vim finds a line
7485 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007486 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487< [The whitespace before and after the '0' must be a single <Tab>]
7488
7489 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007490 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007491 instead of a normal tag name, a retry is done with a linear search.
7492 Tags in unsorted tags files, and matches with different case will only
7493 be found in the retry.
7494
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007495 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007496 linear search can be avoided when case is ignored. Use a value of '2'
7497 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7498 sorted with the -f switch to "sort" in most unices, as in the command:
7499 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7500 (at least 5.5) the --sort=foldcase switch can be used for this as
7501 well. Note that case must be folded to uppercase for this to work.
7502
7503 By default, tag searches are case-sensitive. Case is ignored when
7504 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7505 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007506 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7507 'tagcase' is "smart", and the pattern contains only lowercase
7508 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509
7510 When 'tagbsearch' is off, tags searching is slower when a full match
7511 exists, but faster when no full match exists. Tags in unsorted tags
7512 files may only be found with 'tagbsearch' off.
7513 When the tags file is not sorted, or sorted in a wrong way (not on
7514 ASCII byte value), 'tagbsearch' should be off, or the line given above
7515 must be included in the tags file.
7516 This option doesn't affect commands that find all matching tags (e.g.,
7517 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007519 *'tagcase'* *'tc'*
7520'tagcase' 'tc' string (default "followic")
7521 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007522 This option specifies how case is handled when searching the tags
7523 file:
7524 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007525 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007526 ignore Ignore case
7527 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007528 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007529 NOTE: This option is set to the Vi default value when 'compatible' is
7530 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007531
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007532 *'tagfunc'* *'tfu'*
7533'tagfunc' 'tfu' string (default: empty)
7534 local to buffer
7535 {not available when compiled without the |+eval|
7536 feature}
7537 This option specifies a function to be used to perform tag searches.
7538 The function gets the tag pattern and should return a List of matching
7539 tags. See |tag-function| for an explanation of how to write the
7540 function and an example.
7541
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542 *'taglength'* *'tl'*
7543'taglength' 'tl' number (default 0)
7544 global
7545 If non-zero, tags are significant up to this number of characters.
7546
7547 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7548'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7549 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007550 If on and using a tags file in another directory, file names in that
7551 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 NOTE: This option is set to the Vi default value when 'compatible' is
7553 set and to the Vim default value when 'compatible' is reset.
7554
7555 *'tags'* *'tag'* *E433*
7556'tags' 'tag' string (default "./tags,tags", when compiled with
7557 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7558 global or local to buffer |global-local|
7559 Filenames for the tag command, separated by spaces or commas. To
7560 include a space or comma in a file name, precede it with a backslash
7561 (see |option-backslash| about including spaces and backslashes).
7562 When a file name starts with "./", the '.' is replaced with the path
7563 of the current file. But only when the 'd' flag is not included in
7564 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7565 |tags-option|.
7566 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007567 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7568 find all files named "tags" below "/lib". The filename itself cannot
7569 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7570 files called "tags?". {not available when compiled without the
7571 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007572 The |tagfiles()| function can be used to get a list of the file names
7573 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007574 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7575 files are also supported. They are automatically recognized. The
7576 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7577 differences are ignored (MS-Windows). |emacs-tags|
7578 The use of |:set+=| and |:set-=| is preferred when adding or removing
7579 file names from the list. This avoids problems when a future version
7580 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581
7582 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7583'tagstack' 'tgst' boolean (default on)
7584 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585 When on, the |tagstack| is used normally. When off, a ":tag" or
7586 ":tselect" command with an argument will not push the tag onto the
7587 tagstack. A following ":tag" without an argument, a ":pop" command or
7588 any other command that uses the tagstack will use the unmodified
7589 tagstack, but does change the pointer to the active entry.
7590 Resetting this option is useful when using a ":tag" command in a
7591 mapping which should not change the tagstack.
7592
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007593 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007594'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007595 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007596 {only available when compiled with the |+tcl/dyn|
7597 feature}
7598 Specifies the name of the Tcl shared library. The default is
7599 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007600 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007601 This option cannot be set from a |modeline| or in the |sandbox|, for
7602 security reasons.
7603
Bram Moolenaar071d4272004-06-13 20:20:40 +00007604 *'term'* *E529* *E530* *E531*
7605'term' string (default is $TERM, if that fails:
7606 in the GUI: "builtin_gui"
7607 on Amiga: "amiga"
7608 on BeOS: "beos-ansi"
7609 on Mac: "mac-ansi"
7610 on MiNT: "vt52"
7611 on MS-DOS: "pcterm"
7612 on OS/2: "os2ansi"
7613 on Unix: "ansi"
7614 on VMS: "ansi"
7615 on Win 32: "win32")
7616 global
7617 Name of the terminal. Used for choosing the terminal control
7618 characters. Environment variables are expanded |:set_env|.
7619 For example: >
7620 :set term=$TERM
7621< See |termcap|.
7622
7623 *'termbidi'* *'tbidi'*
7624 *'notermbidi'* *'notbidi'*
7625'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7626 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007627 {only available when compiled with the |+arabic|
7628 feature}
7629 The terminal is in charge of Bi-directionality of text (as specified
7630 by Unicode). The terminal is also expected to do the required shaping
7631 that some languages (such as Arabic) require.
7632 Setting this option implies that 'rightleft' will not be set when
7633 'arabic' is set and the value of 'arabicshape' will be ignored.
7634 Note that setting 'termbidi' has the immediate effect that
7635 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7636 This option is reset when the GUI is started.
7637 For further details see |arabic.txt|.
7638
7639 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007640'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007641 Macintosh GUI: "macroman")
7642 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643 Encoding used for the terminal. This specifies what character
7644 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007645 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007646 display). Except for the Mac when 'macatsui' is off, then
7647 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007649 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7651 Any attempts to set a different value will be rejected, and an error
7652 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007653 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007654 because the Win32 system always passes Unicode characters.
7655 When empty, the same encoding is used as for the 'encoding' option.
7656 This is the normal value.
7657 Not all combinations for 'termencoding' and 'encoding' are valid. See
7658 |encoding-table|.
7659 The value for this option must be supported by internal conversions or
7660 iconv(). When this is not possible no conversion will be done and you
7661 will probably experience problems with non-ASCII characters.
7662 Example: You are working with the locale set to euc-jp (Japanese) and
7663 want to edit a UTF-8 file: >
7664 :let &termencoding = &encoding
7665 :set encoding=utf-8
7666< You need to do this when your system has no locale support for UTF-8.
7667
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007668 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007669'termguicolors' 'tgc' boolean (default off)
7670 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007671 {not available when compiled without the
7672 |+termguicolors| feature}
7673 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007674 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007675
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007676 Requires a ISO-8613-3 compatible terminal. If setting this option
7677 does not work (produces a colorless UI) reading |xterm-true-color|
7678 might help.
7679
7680 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7681 is required. Use this check to find out: >
7682 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007683< This requires Vim to be built with the |+vtp| feature.
7684
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007685 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007686 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007687
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007688 *'termwinkey'* *'twk'*
7689'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007690 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007691 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007692 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007693 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007694 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007695< The string must be one key stroke but can be multiple bytes.
7696 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007697 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007698 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007699
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007700 *'termwinscroll'* *'twsl'*
7701'termwinscroll' 'twsl' number (default 10000)
7702 local to buffer
7703 {not available when compiled without the
7704 |+terminal| feature}
7705 Number of scrollback lines to keep. When going over this limit the
7706 first 10% of the scrollback lines are deleted. This is just to reduce
7707 the memory usage. See |Terminal-Normal|.
7708
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007709 *'termwinsize'* *'tws'*
7710'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007711 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007712 Size of the |terminal| window. Format: {rows}x{columns} or
7713 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007714 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007715 - When set with a "x" (e.g., "24x80") the terminal size is not
7716 adjusted to the window size. If the window is smaller only the
7717 top-left part is displayed.
7718 - When set with a "*" (e.g., "10*50") the terminal size follows the
7719 window size, but will not be smaller than the specified rows and/or
7720 columns.
7721 - When rows is zero then use the height of the window.
7722 - When columns is zero then use the width of the window.
7723 - Using "0x0" or "0*0" is the same as empty.
7724
7725 Examples:
7726 "30x0" uses 30 rows and the current window width.
7727 "20*0" uses at least 20 rows and the current window width.
7728 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007729 Note that the command running in the terminal window may still change
7730 the size of the terminal. In that case the Vim window will be
7731 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007732
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007733 *'termwintype'* *'twt'*
7734'termwintype' 'twt' string (default "")
7735 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007736 {only available when compiled with the |terminal|
7737 feature on MS-Windows}
7738 Specify the virtual console (pty) used when opening the terminal
7739 window.
7740
7741 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007742 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007743 "winpty" use winpty, fail if not supported
7744 "conpty" use |ConPTY|, fail if not supported
7745
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007746 |ConPTY| support depends on the platform. Windows 10 October 2018
7747 Update is the first version that supports ConPTY, however it is still
7748 considered unstable. ConPTY might become stable in the next release
7749 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007750 supported then you cannot open a terminal window.
7751
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752 *'terse'* *'noterse'*
7753'terse' boolean (default off)
7754 global
7755 When set: Add 's' flag to 'shortmess' option (this makes the message
7756 for a search that hits the start or end of the file not being
7757 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7758 shortens a lot of messages}
7759
7760 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7761'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763 This option is obsolete. Use 'fileformats'.
7764 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7765 set to the default value for the current system. When 'textauto' is
7766 reset, 'fileformats' is made empty.
7767 NOTE: This option is set to the Vi default value when 'compatible' is
7768 set and to the Vim default value when 'compatible' is reset.
7769
7770 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7771'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7772 others: default off)
7773 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007774 This option is obsolete. Use 'fileformat'.
7775 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7776 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7777 "unix".
7778
7779 *'textwidth'* *'tw'*
7780'textwidth' 'tw' number (default 0)
7781 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007782 Maximum width of text that is being inserted. A longer line will be
7783 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007784 this.
7785 'textwidth' is set to 0 when the 'paste' option is set and restored
7786 when 'paste' is reset.
7787 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007789 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007790 NOTE: This option is set to 0 when 'compatible' is set.
7791
7792 *'thesaurus'* *'tsr'*
7793'thesaurus' 'tsr' string (default "")
7794 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007795 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007796 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7797
7798 Each line in the file should contain words with similar meaning,
7799 separated by non-keyword characters (white space is preferred).
7800 Maximum line length is 510 bytes.
7801
Bram Moolenaard47d5222018-12-09 20:43:55 +01007802 An English word list was added to this github issue:
7803 https://github.com/vim/vim/issues/629#issuecomment-443293282
7804 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7805 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7806 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007807
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007808 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 after a comma are ignored, otherwise spaces are included in the file
7810 name. See |option-backslash| about using backslashes.
7811 The use of |:set+=| and |:set-=| is preferred when adding or removing
7812 directories from the list. This avoids problems when a future version
7813 uses another default.
7814 Backticks cannot be used in this option for security reasons.
7815
7816 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7817'tildeop' 'top' boolean (default off)
7818 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 When on: The tilde command "~" behaves like an operator.
7820 NOTE: This option is reset when 'compatible' is set.
7821
7822 *'timeout'* *'to'* *'notimeout'* *'noto'*
7823'timeout' 'to' boolean (default on)
7824 global
7825 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007826'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007828 These two options together determine the behavior when part of a
7829 mapped key sequence or keyboard code has been received:
7830
7831 'timeout' 'ttimeout' action ~
7832 off off do not time out
7833 on on or off time out on :mappings and key codes
7834 off on time out on key codes
7835
7836 If both options are off, Vim will wait until either the complete
7837 mapping or key sequence has been received, or it is clear that there
7838 is no mapping or key sequence for the received characters. For
7839 example: if you have mapped "vl" and Vim has received 'v', the next
7840 character is needed to see if the 'v' is followed by an 'l'.
7841 When one of the options is on, Vim will wait for about 1 second for
7842 the next character to arrive. After that the already received
7843 characters are interpreted as single characters. The waiting time can
7844 be changed with the 'timeoutlen' option.
7845 On slow terminals or very busy systems timing out may cause
7846 malfunctioning cursor keys. If both options are off, Vim waits
7847 forever after an entered <Esc> if there are key codes that start
7848 with <Esc>. You will have to type <Esc> twice. If you do not have
7849 problems with key codes, but would like to have :mapped key
7850 sequences not timing out in 1 second, set the 'ttimeout' option and
7851 reset the 'timeout' option.
7852
7853 NOTE: 'ttimeout' is reset when 'compatible' is set.
7854
7855 *'timeoutlen'* *'tm'*
7856'timeoutlen' 'tm' number (default 1000)
7857 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007858
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007860'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007861 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 The time in milliseconds that is waited for a key code or mapped key
7863 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7864 when part of a command has been typed.
7865 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7866 different timeout value for key codes is desired set 'ttimeoutlen' to
7867 a non-negative number.
7868
7869 ttimeoutlen mapping delay key code delay ~
7870 < 0 'timeoutlen' 'timeoutlen'
7871 >= 0 'timeoutlen' 'ttimeoutlen'
7872
7873 The timeout only happens when the 'timeout' and 'ttimeout' options
7874 tell so. A useful setting would be >
7875 :set timeout timeoutlen=3000 ttimeoutlen=100
7876< (time out on mapping after three seconds, time out on key codes after
7877 a tenth of a second).
7878
7879 *'title'* *'notitle'*
7880'title' boolean (default off, on when title can be restored)
7881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007882 {not available when compiled without the |+title|
7883 feature}
7884 When on, the title of the window will be set to the value of
7885 'titlestring' (if it is not empty), or to:
7886 filename [+=-] (path) - VIM
7887 Where:
7888 filename the name of the file being edited
7889 - indicates the file cannot be modified, 'ma' off
7890 + indicates the file was modified
7891 = indicates the file is read-only
7892 =+ indicates the file is read-only and modified
7893 (path) is the path of the file being edited
7894 - VIM the server name |v:servername| or "VIM"
7895 Only works if the terminal supports setting window titles
7896 (currently Amiga console, Win32 console, all GUI versions and
7897 terminals with a non- empty 't_ts' option - these are Unix xterm and
7898 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7899 *X11*
7900 When Vim was compiled with HAVE_X11 defined, the original title will
7901 be restored if possible. The output of ":version" will include "+X11"
7902 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7903 works for the icon name |'icon'|.
7904 But: When Vim was started with the |-X| argument, restoring the title
7905 will not work (except in the GUI).
7906 If the title cannot be restored, it is set to the value of 'titleold'.
7907 You might want to restore the title outside of Vim then.
7908 When using an xterm from a remote machine you can use this command:
7909 rsh machine_name xterm -display $DISPLAY &
7910 then the WINDOWID environment variable should be inherited and the
7911 title of the window should change back to what it should be after
7912 exiting Vim.
7913
7914 *'titlelen'*
7915'titlelen' number (default 85)
7916 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007917 {not available when compiled without the |+title|
7918 feature}
7919 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007920 title. When the title is longer, only the end of the path name is
7921 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922 Using a percentage makes this adapt to the width of the window. But
7923 it won't work perfectly, because the actual number of characters
7924 available also depends on the font used and other things in the title
7925 bar. When 'titlelen' is zero the full path is used. Otherwise,
7926 values from 1 to 30000 percent can be used.
7927 'titlelen' is also used for the 'titlestring' option.
7928
7929 *'titleold'*
7930'titleold' string (default "Thanks for flying Vim")
7931 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007932 {only available when compiled with the |+title|
7933 feature}
7934 This option will be used for the window title when exiting Vim if the
7935 original title cannot be restored. Only happens if 'title' is on or
7936 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007937 This option cannot be set from a |modeline| or in the |sandbox|, for
7938 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939 *'titlestring'*
7940'titlestring' string (default "")
7941 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007942 {not available when compiled without the |+title|
7943 feature}
7944 When this option is not empty, it will be used for the title of the
7945 window. This happens only when the 'title' option is on.
7946 Only works if the terminal supports setting window titles (currently
7947 Amiga console, Win32 console, all GUI versions and terminals with a
7948 non-empty 't_ts' option).
7949 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007950 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007951
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952 When this option contains printf-style '%' items, they will be
7953 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007954 This option cannot be set in a modeline when 'modelineexpr' is off.
7955
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 Example: >
7957 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7958 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7959< The value of 'titlelen' is used to align items in the middle or right
7960 of the available space.
7961 Some people prefer to have the file name first: >
7962 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7963< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007964 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007965 separating space only when needed.
7966 NOTE: Use of special characters in 'titlestring' may cause the display
7967 to be garbled (e.g., when it contains a CR or NL character).
7968 {not available when compiled without the |+statusline| feature}
7969
7970 *'toolbar'* *'tb'*
7971'toolbar' 'tb' string (default "icons,tooltips")
7972 global
7973 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7974 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007975 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007976 possible values are:
7977 icons Toolbar buttons are shown with icons.
7978 text Toolbar buttons shown with text.
7979 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007980 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981 tooltips Tooltips are active for toolbar buttons.
7982 Tooltips refer to the popup help text which appears after the mouse
7983 cursor is placed over a toolbar button for a brief moment.
7984
7985 If you want the toolbar to be shown with icons as well as text, do the
7986 following: >
7987 :set tb=icons,text
7988< Motif and Athena cannot display icons and text at the same time. They
7989 will show icons if both are requested.
7990
7991 If none of the strings specified in 'toolbar' are valid or if
7992 'toolbar' is empty, this option is ignored. If you want to disable
7993 the toolbar, you need to set the 'guioptions' option. For example: >
7994 :set guioptions-=T
7995< Also see |gui-toolbar|.
7996
7997 *'toolbariconsize'* *'tbis'*
7998'toolbariconsize' 'tbis' string (default "small")
7999 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008000 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008002 tiny Use tiny icons.
8003 small Use small icons (default).
8004 medium Use medium-sized icons.
8005 large Use large icons.
8006 huge Use even larger icons.
8007 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008009 the current theme. Common dimensions are giant=48x48, huge=32x32,
8010 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011
8012 If 'toolbariconsize' is empty, the global default size as determined
8013 by user preferences or the current theme is used.
8014
8015 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8016'ttybuiltin' 'tbi' boolean (default on)
8017 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008018 When on, the builtin termcaps are searched before the external ones.
8019 When off the builtin termcaps are searched after the external ones.
8020 When this option is changed, you should set the 'term' option next for
8021 the change to take effect, for example: >
8022 :set notbi term=$TERM
8023< See also |termcap|.
8024 Rationale: The default for this option is "on", because the builtin
8025 termcap entries are generally better (many systems contain faulty
8026 xterm entries...).
8027
8028 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8029'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8030 sun-cmd, screen, rxvt, dtterm or
8031 iris-ansi; also on when running Vim in
8032 a DOS console)
8033 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008034 Indicates a fast terminal connection. More characters will be sent to
8035 the screen for redrawing, instead of using insert/delete line
8036 commands. Improves smoothness of redrawing when there are multiple
8037 windows and the terminal does not support a scrolling region.
8038 Also enables the extra writing of characters at the end of each screen
8039 line for lines that wrap. This helps when using copy/paste with the
8040 mouse in an xterm and other terminals.
8041
8042 *'ttymouse'* *'ttym'*
8043'ttymouse' 'ttym' string (default depends on 'term')
8044 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008045 {only in Unix and VMS, doesn't work in the GUI; not
8046 available when compiled without |+mouse|}
8047 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008048 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049 *xterm-mouse*
8050 xterm xterm-like mouse handling. The mouse generates
8051 "<Esc>[Mscr", where "scr" is three bytes:
8052 "s" = button state
8053 "c" = column plus 33
8054 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008055 This only works up to 223 columns! See "dec",
8056 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008057 xterm2 Works like "xterm", but with the xterm reporting the
8058 mouse position while the mouse is dragged. This works
8059 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008060 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008061 work. See below for how Vim detects this
8062 automatically.
8063 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008064 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008065 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008066 for the row and column. No other mouse events are
8067 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008068 *dec-mouse*
8069 dec DEC terminal mouse handling. The mouse generates a
8070 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008071 This is also available for an Xterm, if it was
8072 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008073 *jsbterm-mouse*
8074 jsbterm JSB term mouse handling.
8075 *pterm-mouse*
8076 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008077 *urxvt-mouse*
8078 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008079 The mouse works only if the terminal supports this
8080 encoding style, but it does not have 223 columns limit
8081 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008082 *sgr-mouse*
8083 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008084 mouse reporting. The mouse works even in columns
8085 beyond 223. This option is backward compatible with
8086 "xterm2" because it can also decode "xterm2" style
8087 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008088
8089 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008090 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8091 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008092 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8093 recognized, if enabled at compile time. DEC terminal mouse codes
8094 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008095 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8096 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008098 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8099 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8100 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008101 Additionally, if vim is compiled with the |+termresponse| feature and
8102 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008103 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008104 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008105 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8106 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8107 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008108 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8109 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008110 :set t_RV=
8111<
8112 *'ttyscroll'* *'tsl'*
8113'ttyscroll' 'tsl' number (default 999)
8114 global
8115 Maximum number of lines to scroll the screen. If there are more lines
8116 to scroll the window is redrawn. For terminals where scrolling is
8117 very slow and redrawing is not slow this can be set to a small number,
8118 e.g., 3, to speed up displaying.
8119
8120 *'ttytype'* *'tty'*
8121'ttytype' 'tty' string (default from $TERM)
8122 global
8123 Alias for 'term', see above.
8124
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008125 *'undodir'* *'udir'*
8126'undodir' 'udir' string (default ".")
8127 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008128 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008129 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008130 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008131 "." means using the directory of the file. The undo file name for
8132 "file.txt" is ".file.txt.un~".
8133 For other directories the file name is the full path of the edited
8134 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008135 When writing: The first directory that exists is used. "." always
8136 works, no directories after "." will be used for writing.
8137 When reading all entries are tried to find an undo file. The first
8138 undo file that exists is used. When it cannot be read an error is
8139 given, no further entry is used.
8140 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008141 This option cannot be set from a |modeline| or in the |sandbox|, for
8142 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008143
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008144 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008145'undofile' 'udf' boolean (default off)
8146 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008147 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008148 When on, Vim automatically saves undo history to an undo file when
8149 writing a buffer to a file, and restores undo history from the same
8150 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008151 The directory where the undo file is stored is specified by 'undodir'.
8152 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008153 The undo file is not read when 'undoreload' causes the buffer from
8154 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008155 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008156 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008157
Bram Moolenaar071d4272004-06-13 20:20:40 +00008158 *'undolevels'* *'ul'*
8159'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8160 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008161 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008162 Maximum number of changes that can be undone. Since undo information
8163 is kept in memory, higher numbers will cause more memory to be used
8164 (nevertheless, a single change can use an unlimited amount of memory).
8165 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8166 itself: >
8167 set ul=0
8168< But you can also get Vi compatibility by including the 'u' flag in
8169 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008170 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008171 Set to -1 for no undo at all. You might want to do this only for the
8172 current buffer: >
8173 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008174< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008175
8176 The local value is set to -123456 when the global value is to be used.
8177
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008178 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008180 *'undoreload'* *'ur'*
8181'undoreload' 'ur' number (default 10000)
8182 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008183 Save the whole buffer for undo when reloading it. This applies to the
8184 ":e!" command and reloading for when the buffer changed outside of
8185 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008186 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008187 of lines is smaller than the value of this option.
8188 Set this option to zero to disable undo for a reload.
8189
8190 When saving undo for a reload, any undo file is not read.
8191
8192 Note that this causes the whole buffer to be stored in memory. Set
8193 this option to a lower value if you run out of memory.
8194
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195 *'updatecount'* *'uc'*
8196'updatecount' 'uc' number (default: 200)
8197 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008198 After typing this many characters the swap file will be written to
8199 disk. When zero, no swap file will be created at all (see chapter on
8200 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8201 Vim with the "-n" option, see |startup|. When editing in readonly
8202 mode this option will be initialized to 10000.
8203 The swapfile can be disabled per buffer with |'swapfile'|.
8204 When 'updatecount' is set from zero to non-zero, swap files are
8205 created for all buffers that have 'swapfile' set. When 'updatecount'
8206 is set to zero, existing swap files are not deleted.
8207 Also see |'swapsync'|.
8208 This option has no meaning in buffers where |'buftype'| is "nofile"
8209 or "nowrite".
8210
8211 *'updatetime'* *'ut'*
8212'updatetime' 'ut' number (default 4000)
8213 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 If this many milliseconds nothing is typed the swap file will be
8215 written to disk (see |crash-recovery|). Also used for the
8216 |CursorHold| autocommand event.
8217
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008218 *'varsofttabstop'* *'vsts'*
8219'varsofttabstop' 'vsts' string (default "")
8220 local to buffer
8221 {only available when compiled with the |+vartabs|
8222 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008223 A list of the number of spaces that a <Tab> counts for while editing,
8224 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8225 width <Tab>s are being inserted, while in fact a mixture of spaces
8226 and <Tab>s is used. Tab widths are separated with commas, with the
8227 final value applying to all subsequent tabs.
8228
8229 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008230 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008231 to use the following: >
8232 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008233< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8234 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008235
8236 Note that the value of |'softtabstop'| will be ignored while
8237 'varsofttabstop' is set.
8238
8239 *'vartabstop'* *'vts'*
8240'vartabstop' 'vts' string (default "")
8241 local to buffer
8242 {only available when compiled with the |+vartabs|
8243 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008244 A list of the number of spaces that a <Tab> in the file counts for,
8245 separated by commas. Each value corresponds to one tab, with the
8246 final value applying to all subsequent tabs. For example: >
8247 :set vartabstop=4,20,10,8
8248< This will make the first tab 4 spaces wide, the second 20 spaces,
8249 the third 10 spaces, and all following tabs 8 spaces.
8250
8251 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8252 is set.
8253
Bram Moolenaar071d4272004-06-13 20:20:40 +00008254 *'verbose'* *'vbs'*
8255'verbose' 'vbs' number (default 0)
8256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008257 When bigger than zero, Vim will give messages about what it is doing.
8258 Currently, these messages are given:
8259 >= 1 When the viminfo file is read or written.
8260 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008261 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008262 >= 8 Files for which a group of autocommands is executed.
8263 >= 9 Every executed autocommand.
8264 >= 12 Every executed function.
8265 >= 13 When an exception is thrown, caught, finished, or discarded.
8266 >= 14 Anything pending in a ":finally" clause.
8267 >= 15 Every executed Ex command (truncated at 200 characters).
8268
8269 This option can also be set with the "-V" argument. See |-V|.
8270 This option is also set by the |:verbose| command.
8271
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008272 When the 'verbosefile' option is set then the verbose messages are not
8273 displayed.
8274
8275 *'verbosefile'* *'vfile'*
8276'verbosefile' 'vfile' string (default empty)
8277 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008278 When not empty all messages are written in a file with this name.
8279 When the file exists messages are appended.
8280 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008281 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008282 Setting 'verbosefile' to a new value is like making it empty first.
8283 The difference with |:redir| is that verbose messages are not
8284 displayed when 'verbosefile' is set.
8285
Bram Moolenaar071d4272004-06-13 20:20:40 +00008286 *'viewdir'* *'vdir'*
8287'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8288 "$VIM/vimfiles/view",
8289 for Unix: "~/.vim/view",
8290 for Macintosh: "$VIM:vimfiles:view"
8291 for VMS: "sys$login:vimfiles/view"
8292 for RiscOS: "Choices:vimfiles/view")
8293 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008294 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295 feature}
8296 Name of the directory where to store files for |:mkview|.
8297 This option cannot be set from a |modeline| or in the |sandbox|, for
8298 security reasons.
8299
8300 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008301'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008303 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008304 feature}
8305 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008306 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307 word save and restore ~
8308 cursor cursor position in file and in window
8309 folds manually created folds, opened/closed folds and local
8310 fold options
8311 options options and mappings local to a window or buffer (not
8312 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008313 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008314 slash backslashes in file names replaced with forward
8315 slashes
8316 unix with Unix end-of-line format (single <NL>), even when
8317 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008318 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319
8320 "slash" and "unix" are useful on Windows when sharing view files
8321 with Unix. The Unix version of Vim cannot source dos format scripts,
8322 but the Windows version of Vim can source unix format scripts.
8323
8324 *'viminfo'* *'vi'* *E526* *E527* *E528*
8325'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008326 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8327 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8328 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008329 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008330 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008331 feature}
8332 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008333 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8334 "NONE".
8335 The string should be a comma separated list of parameters, each
8336 consisting of a single character identifying the particular parameter,
8337 followed by a number or string which specifies the value of that
8338 parameter. If a particular character is left out, then the default
8339 value is used for that parameter. The following is a list of the
8340 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008342 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343 ! When included, save and restore global variables that start
8344 with an uppercase letter, and don't contain a lowercase
8345 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008346 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008347 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008348 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008349 " Maximum number of lines saved for each register. Old name of
8350 the '<' item, with the disadvantage that you need to put a
8351 backslash before the ", otherwise it will be recognized as the
8352 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008353 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 % When included, save and restore the buffer list. If Vim is
8355 started with a file name argument, the buffer list is not
8356 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008357 buffer list is restored from the viminfo file. Quickfix
8358 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8359 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008360 When followed by a number, the number specifies the maximum
8361 number of buffers that are stored. Without a number all
8362 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008363 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008364 ' Maximum number of previously edited files for which the marks
8365 are remembered. This parameter must always be included when
8366 'viminfo' is non-empty.
8367 Including this item also means that the |jumplist| and the
8368 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008369 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008370 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008371 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 patterns are also saved. When not included, the value of
8373 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008374 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008376 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008377 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378 < Maximum number of lines saved for each register. If zero then
8379 registers are not saved. When not included, all lines are
8380 saved. '"' is the old name for this item.
8381 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008382 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008384 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008385 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 c When included, convert the text in the viminfo file from the
8387 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008388 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008389 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008390 f Whether file marks need to be stored. If zero, file marks ('0
8391 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008392 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008393 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008394 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008395 h Disable the effect of 'hlsearch' when loading the viminfo
8396 file. When not included, it depends on whether ":nohlsearch"
8397 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008398 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008399 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008400 the 'n'. Must be at the end of the option! If the
8401 'viminfofile' option is set, that file name overrides the one
8402 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008403 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008404 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008405 r Removable media. The argument is a string (up to the next
8406 ','). This parameter can be given several times. Each
8407 specifies the start of a path for which no marks will be
8408 stored. This is to avoid removable media. For MS-DOS you
8409 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8410 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8411 ignored. Maximum length of each 'r' argument is 50
8412 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008413 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008414 s Maximum size of an item in Kbyte. If zero then registers are
8415 not saved. Currently only applies to registers. The default
8416 "s10" will exclude registers with more than 10 Kbyte of text.
8417 Also see the '<' item above: line count limit.
8418
8419 Example: >
8420 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8421<
8422 '50 Marks will be remembered for the last 50 files you
8423 edited.
8424 <1000 Contents of registers (up to 1000 lines each) will be
8425 remembered.
8426 s100 Registers with more than 100 Kbyte text are skipped.
8427 :0 Command-line history will not be saved.
8428 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8429 no / Since '/' is not specified, the default will be used,
8430 that is, save all of the search history, and also the
8431 previous search and substitute patterns.
8432 no % The buffer list will not be saved nor read back.
8433 no h 'hlsearch' highlighting will be restored.
8434
8435 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8436 load the contents of the file, this is not done automatically.
8437
8438 This option cannot be set from a |modeline| or in the |sandbox|, for
8439 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008440 NOTE: This option is set to the Vim default value when 'compatible'
8441 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008443 *'viminfofile'* *'vif'*
8444'viminfofile' 'vif' string (default: "")
8445 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008446 {not available when compiled without the |+viminfo|
8447 feature}
8448 When non-empty, overrides the file name used for viminfo.
8449 When equal to "NONE" no viminfo file will be read or written.
8450 This option can be set with the |-i| command line flag. The |--clean|
8451 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008452 This option cannot be set from a |modeline| or in the |sandbox|, for
8453 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008454
Bram Moolenaar071d4272004-06-13 20:20:40 +00008455 *'virtualedit'* *'ve'*
8456'virtualedit' 've' string (default "")
8457 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 {not available when compiled without the
8459 |+virtualedit| feature}
8460 A comma separated list of these words:
8461 block Allow virtual editing in Visual block mode.
8462 insert Allow virtual editing in Insert mode.
8463 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008464 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008465
Bram Moolenaar071d4272004-06-13 20:20:40 +00008466 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008467 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008468 of the line. Useful for selecting a rectangle in Visual mode and
8469 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008470 "onemore" is not the same, it will only allow moving the cursor just
8471 after the last character of the line. This makes some commands more
8472 consistent. Previously the cursor was always past the end of the line
8473 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008474 break some plugins or Vim scripts. For example because |l| can move
8475 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008476 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008477 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008478 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008479 It doesn't make sense to combine "all" with "onemore", but you will
8480 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008481 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008482
8483 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8484'visualbell' 'vb' boolean (default off)
8485 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008486 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008488 use: >
8489 :set vb t_vb=
8490< If you want a short flash, you can use this on many terminals: >
8491 :set vb t_vb=[?5h$<100>[?5l
8492< Here $<100> specifies the time, you can use a smaller or bigger value
8493 to get a shorter or longer flash.
8494
8495 Note: Vim will limit the bell to once per half a second. This avoids
8496 having to wait for the flashing to finish when there are lots of
8497 bells, e.g. on key repeat. This also happens without 'visualbell'
8498 set.
8499
Bram Moolenaar071d4272004-06-13 20:20:40 +00008500 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8501 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8502 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008503
8504 Note: When the GUI starts, 't_vb' is reset to its default value. You
8505 might want to set it again in your |gvimrc|.
8506
Bram Moolenaar071d4272004-06-13 20:20:40 +00008507 Does not work on the Amiga, you always get a screen flash.
8508 Also see 'errorbells'.
8509
8510 *'warn'* *'nowarn'*
8511'warn' boolean (default on)
8512 global
8513 Give a warning message when a shell command is used while the buffer
8514 has been changed.
8515
8516 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8517'weirdinvert' 'wiv' boolean (default off)
8518 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008519 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008520 It is provided for backwards compatibility with version 4.x.
8521 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8522 vice versa. Has no effect when the GUI is running.
8523
8524 *'whichwrap'* *'ww'*
8525'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8526 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008527 Allow specified keys that move the cursor left/right to move to the
8528 previous/next line when the cursor is on the first/last character in
8529 the line. Concatenate characters to allow this for these keys:
8530 char key mode ~
8531 b <BS> Normal and Visual
8532 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008533 h "h" Normal and Visual (not recommended)
8534 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008535 < <Left> Normal and Visual
8536 > <Right> Normal and Visual
8537 ~ "~" Normal
8538 [ <Left> Insert and Replace
8539 ] <Right> Insert and Replace
8540 For example: >
8541 :set ww=<,>,[,]
8542< allows wrap only when cursor keys are used.
8543 When the movement keys are used in combination with a delete or change
8544 operator, the <EOL> also counts for a character. This makes "3h"
8545 different from "3dh" when the cursor crosses the end of a line. This
8546 is also true for "x" and "X", because they do the same as "dl" and
8547 "dh". If you use this, you may also want to use the mapping
8548 ":map <BS> X" to make backspace delete the character in front of the
8549 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008550 When 'l' is included and it is used after an operator at the end of a
8551 line then it will not move to the next line. This makes "dl", "cl",
8552 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008553 NOTE: This option is set to the Vi default value when 'compatible' is
8554 set and to the Vim default value when 'compatible' is reset.
8555
8556 *'wildchar'* *'wc'*
8557'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8558 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559 Character you have to type to start wildcard expansion in the
8560 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008561 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008562 The character is not recognized when used inside a macro. See
8563 'wildcharm' for that.
8564 Although 'wc' is a number option, you can set it to a special key: >
8565 :set wc=<Esc>
8566< NOTE: This option is set to the Vi default value when 'compatible' is
8567 set and to the Vim default value when 'compatible' is reset.
8568
8569 *'wildcharm'* *'wcm'*
8570'wildcharm' 'wcm' number (default: none (0))
8571 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008572 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008573 recognized when used inside a macro. You can find "spare" command-line
8574 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008575 you'll never actually type 'wildcharm', just use it in mappings that
8576 automatically invoke completion mode, e.g.: >
8577 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008578 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579< Then after typing :ss you can use CTRL-P & CTRL-N.
8580
8581 *'wildignore'* *'wig'*
8582'wildignore' 'wig' string (default "")
8583 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008584 {not available when compiled without the |+wildignore|
8585 feature}
8586 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008587 patterns is ignored when expanding |wildcards|, completing file or
8588 directory names, and influences the result of |expand()|, |glob()| and
8589 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008590 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8591 Also see 'suffixes'.
8592 Example: >
8593 :set wildignore=*.o,*.obj
8594< The use of |:set+=| and |:set-=| is preferred when adding or removing
8595 a pattern from the list. This avoids problems when a future version
8596 uses another default.
8597
Bram Moolenaar94950a92010-12-02 16:01:29 +01008598
Bram Moolenaar81af9252010-12-10 20:35:50 +01008599 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008600'wildignorecase' 'wic' boolean (default off)
8601 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008602 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008603 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008604 Does not apply when the shell is used to expand wildcards, which
8605 happens when there are special characters.
8606
8607
Bram Moolenaar071d4272004-06-13 20:20:40 +00008608 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008609'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008610 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008611 {not available if compiled without the |+wildmenu|
8612 feature}
8613 When 'wildmenu' is on, command-line completion operates in an enhanced
8614 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8615 the possible matches are shown just above the command line, with the
8616 first match highlighted (overwriting the status line, if there is
8617 one). Keys that show the previous/next match, such as <Tab> or
8618 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8619 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8620 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008621 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008622 If there are more matches than can fit in the line, a ">" is shown on
8623 the right and/or a "<" is shown on the left. The status line scrolls
8624 as needed.
8625 The "wildmenu" mode is abandoned when a key is hit that is not used
8626 for selecting a completion.
8627 While the "wildmenu" is active the following keys have special
8628 meanings:
8629
8630 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8631 <Down> - in filename/menu name completion: move into a
8632 subdirectory or submenu.
8633 <CR> - in menu completion, when the cursor is just after a
8634 dot: move into a submenu.
8635 <Up> - in filename/menu name completion: move up into
8636 parent directory or parent menu.
8637
8638 This makes the menus accessible from the console |console-menus|.
8639
8640 If you prefer the <Left> and <Right> keys to move the cursor instead
8641 of selecting a different match, use this: >
8642 :cnoremap <Left> <Space><BS><Left>
8643 :cnoremap <Right> <Space><BS><Right>
8644<
8645 The "WildMenu" highlighting is used for displaying the current match
8646 |hl-WildMenu|.
8647
8648 *'wildmode'* *'wim'*
8649'wildmode' 'wim' string (Vim default: "full")
8650 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008651 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008652 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008653 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654 first part specifies the behavior for the first use of 'wildchar',
8655 The second part for the second use, etc.
8656 These are the possible values for each part:
8657 "" Complete only the first match.
8658 "full" Complete the next full match. After the last match,
8659 the original string is used and then the first match
8660 again.
8661 "longest" Complete till longest common string. If this doesn't
8662 result in a longer string, use the next part.
8663 "longest:full" Like "longest", but also start 'wildmenu' if it is
8664 enabled.
8665 "list" When more than one match, list all matches.
8666 "list:full" When more than one match, list all matches and
8667 complete first match.
8668 "list:longest" When more than one match, list all matches and
8669 complete till longest common string.
8670 When there is only a single match, it is fully completed in all cases.
8671
8672 Examples: >
8673 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008674< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008675 :set wildmode=longest,full
8676< Complete longest common string, then each full match >
8677 :set wildmode=list:full
8678< List all matches and complete each full match >
8679 :set wildmode=list,full
8680< List all matches without completing, then each full match >
8681 :set wildmode=longest,list
8682< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008683 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008684
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008685 *'wildoptions'* *'wop'*
8686'wildoptions' 'wop' string (default "")
8687 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008688 {not available when compiled without the |+wildignore|
8689 feature}
8690 A list of words that change how command line completion is done.
8691 Currently only one word is allowed:
8692 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008693 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008694 is displayed per line. Often used tag kinds are:
8695 d #define
8696 f function
8697 Also see |cmdline-completion|.
8698
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699 *'winaltkeys'* *'wak'*
8700'winaltkeys' 'wak' string (default "menu")
8701 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008702 {only used in Win32, Motif, GTK and Photon GUI}
8703 Some GUI versions allow the access to menu entries by using the ALT
8704 key in combination with a character that appears underlined in the
8705 menu. This conflicts with the use of the ALT key for mappings and
8706 entering special characters. This option tells what to do:
8707 no Don't use ALT keys for menus. ALT key combinations can be
8708 mapped, but there is no automatic handling. This can then be
8709 done with the |:simalt| command.
8710 yes ALT key handling is done by the windowing system. ALT key
8711 combinations cannot be mapped.
8712 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008713 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008714 keys can be mapped.
8715 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8716 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008717 This option is not used for <F10>; on Win32 and with GTK <F10> will
8718 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008720 *'wincolor'* *'wcr'*
8721'wincolor' 'wcr' string (default empty)
8722 local to window
8723 Highlight group name to use for this window instead of the Normal
8724 color |hl-Normal|.
8725
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008726 *'window'* *'wi'*
8727'window' 'wi' number (default screen height - 1)
8728 global
8729 Window height. Do not confuse this with the height of the Vim window,
8730 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008731 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8732 value is smaller than 'lines' minus one. The screen will scroll
8733 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008734 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8735 in a much smarter way, taking care of wrapping lines.
8736 When resizing the Vim window, the value is smaller than 1 or more than
8737 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008738
Bram Moolenaar071d4272004-06-13 20:20:40 +00008739 *'winheight'* *'wh'* *E591*
8740'winheight' 'wh' number (default 1)
8741 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008742 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008743 feature}
8744 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008745 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008746 focus goes to a window that is smaller, its size is increased, at the
8747 cost of the height of other windows.
8748 Set 'winheight' to a small number for normal editing.
8749 Set it to 999 to make the current window fill most of the screen.
8750 Other windows will be only 'winminheight' high. This has the drawback
8751 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8752 to create only two windows, set the option after startup is done,
8753 using the |VimEnter| event: >
8754 au VimEnter * set winheight=999
8755< Minimum value is 1.
8756 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008757 height of the current window.
8758 'winheight' applies to the current window. Use 'winminheight' to set
8759 the minimal height for other windows.
8760
8761 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8762'winfixheight' 'wfh' boolean (default off)
8763 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02008764 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008765 feature}
8766 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008767 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8768 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008769 The height may be changed anyway when running out of room.
8770
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008771 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8772'winfixwidth' 'wfw' boolean (default off)
8773 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02008774 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008775 feature}
8776 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008777 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008778 The width may be changed anyway when running out of room.
8779
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780 *'winminheight'* *'wmh'*
8781'winminheight' 'wmh' number (default 1)
8782 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008783 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784 feature}
8785 The minimal height of a window, when it's not the current window.
8786 This is a hard minimum, windows will never become smaller.
8787 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8788 status bar) if necessary. They will return to at least one line when
8789 they become active (since the cursor has to have somewhere to go.)
8790 Use 'winheight' to set the minimal height of the current window.
8791 This option is only checked when making a window smaller. Don't use a
8792 large number, it will cause errors when opening more than a few
8793 windows. A value of 0 to 3 is reasonable.
8794
8795 *'winminwidth'* *'wmw'*
8796'winminwidth' 'wmw' number (default 1)
8797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798 The minimal width of a window, when it's not the current window.
8799 This is a hard minimum, windows will never become smaller.
8800 When set to zero, windows may be "squashed" to zero columns (i.e. just
8801 a vertical separator) if necessary. They will return to at least one
8802 line when they become active (since the cursor has to have somewhere
8803 to go.)
8804 Use 'winwidth' to set the minimal width of the current window.
8805 This option is only checked when making a window smaller. Don't use a
8806 large number, it will cause errors when opening more than a few
8807 windows. A value of 0 to 12 is reasonable.
8808
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008809 *'winptydll'*
8810'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8811 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008812 {only available when compiled with the |terminal|
8813 feature on MS-Windows}
8814 Specifies the name of the winpty shared library, used for the
8815 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008816 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008817 a fallback.
8818 Environment variables are expanded |:set_env|.
8819 This option cannot be set from a |modeline| or in the |sandbox|, for
8820 security reasons.
8821
Bram Moolenaar071d4272004-06-13 20:20:40 +00008822 *'winwidth'* *'wiw'* *E592*
8823'winwidth' 'wiw' number (default 20)
8824 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008825 Minimal number of columns for the current window. This is not a hard
8826 minimum, Vim will use fewer columns if there is not enough room. If
8827 the current window is smaller, its size is increased, at the cost of
8828 the width of other windows. Set it to 999 to make the current window
8829 always fill the screen. Set it to a small number for normal editing.
8830 The width is not adjusted after one of the commands to change the
8831 width of the current window.
8832 'winwidth' applies to the current window. Use 'winminwidth' to set
8833 the minimal width for other windows.
8834
8835 *'wrap'* *'nowrap'*
8836'wrap' boolean (default on)
8837 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 This option changes how text is displayed. It doesn't change the text
8839 in the buffer, see 'textwidth' for that.
8840 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008841 displaying continues on the next line. When off lines will not wrap
8842 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008843 moved to a part that is not shown, the screen will scroll
8844 horizontally.
8845 The line will be broken in the middle of a word if necessary. See
8846 'linebreak' to get the break at a word boundary.
8847 To make scrolling horizontally a bit more useful, try this: >
8848 :set sidescroll=5
8849 :set listchars+=precedes:<,extends:>
8850< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008851 This option can't be set from a |modeline| when the 'diff' option is
8852 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008853
8854 *'wrapmargin'* *'wm'*
8855'wrapmargin' 'wm' number (default 0)
8856 local to buffer
8857 Number of characters from the right window border where wrapping
8858 starts. When typing text beyond this limit, an <EOL> will be inserted
8859 and inserting continues on the next line.
8860 Options that add a margin, such as 'number' and 'foldcolumn', cause
8861 the text width to be further reduced. This is Vi compatible.
8862 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008863 This option is set to 0 when 'paste' is set and restored when 'paste'
8864 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008865 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008866
8867 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8868'wrapscan' 'ws' boolean (default on) *E384* *E385*
8869 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008870 Searches wrap around the end of the file. Also applies to |]s| and
8871 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008872
8873 *'write'* *'nowrite'*
8874'write' boolean (default on)
8875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008876 Allows writing files. When not set, writing a file is not allowed.
8877 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008878 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008879 argument. Filtering text is still possible, even though this requires
8880 writing a temporary file.
8881
8882 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8883'writeany' 'wa' boolean (default off)
8884 global
8885 Allows writing to any file with no need for "!" override.
8886
8887 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8888'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8889 otherwise)
8890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008891 Make a backup before overwriting a file. The backup is removed after
8892 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008893 also on.
8894 WARNING: Switching this option off means that when Vim fails to write
8895 your buffer correctly and then, for whatever reason, Vim exits, you
8896 lose both the original file and what you were writing. Only reset
8897 this option if your file system is almost full and it makes the write
8898 fail (and make sure not to exit Vim until the write was successful).
8899 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008900 When the 'backupskip' pattern matches, a backup is not made anyway.
8901 NOTE: This option is set to the default value when 'compatible' is
8902 set.
8903
8904 *'writedelay'* *'wd'*
8905'writedelay' 'wd' number (default 0)
8906 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008907 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008908 screen. When non-zero, characters are sent to the terminal one by
8909 one. For MS-DOS pcterm this does not work. For debugging purposes.
8910
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008911 vim:tw=78:ts=8:noet:ft=help:norl: